Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oatpp/oatpp-sqlite
SQLite adapter for oatpp ORM.
https://github.com/oatpp/oatpp-sqlite
cpp oatpp orm sqlite sqlite3
Last synced: 4 days ago
JSON representation
SQLite adapter for oatpp ORM.
- Host: GitHub
- URL: https://github.com/oatpp/oatpp-sqlite
- Owner: oatpp
- License: apache-2.0
- Created: 2020-07-03T00:58:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-19T23:11:25.000Z (6 months ago)
- Last Synced: 2024-10-29T23:41:14.512Z (16 days ago)
- Topics: cpp, oatpp, orm, sqlite, sqlite3
- Language: C
- Homepage: https://oatpp.io/
- Size: 2.67 MB
- Stars: 24
- Watchers: 3
- Forks: 19
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# oatpp-sqlite [](https://dev.azure.com/lganzzzo/lganzzzo/_build/latest?definitionId=30&branchName=master)
SQLite adapter for Oat++ ORM.
More about Oat++:
- [Oat++ Website](https://oatpp.io/)
- [Oat++ GitHub Repository](https://github.com/oatpp/oatpp)
- [Oat++ ORM](https://oatpp.io/docs/components/orm/)
## Build And Install
### Pre Requirements
- Install the main [oatpp](https://github.com/oatpp/oatpp) module.
- Install SQLite.
*Note: You can also use `-DOATPP_SQLITE_AMALGAMATION=ON` to install oatpp-sqlite together with [SQLite amalgamation](https://www.sqlite.org/amalgamation.html)
in which case you don't need to install SQLite*
(Current version `3.45.3`)
### Install module
- Clone this repository.
- In the root of the repository run:
```bash
mkdir build && cd build
cmake ..
make install
```
## API
Detailed documentation on Oat++ ORM you can find [here](https://oatpp.io/docs/components/orm/).
### Connect to Database
All you need to start using oatpp ORM with SQLite is to create `oatpp::sqlite::Executor` and provide it to your `DbClient`.
```cpp
#include "db/MyClient.hpp"
#include "oatpp-sqlite/orm.hpp"
class AppComponent {
public:
/**
* Create DbClient component.
* SQLite is used as an example here. For other databases declaration is similar.
*/
OATPP_CREATE_COMPONENT(std::shared_ptr, myDatabaseClient)([] {
/* Create database-specific ConnectionProvider */
auto connectionProvider = std::make_shared("/path/to/database.sqlite");
/* Create database-specific ConnectionPool */
auto connectionPool = oatpp::sqlite::ConnectionPool::createShared(connectionProvider,
10 /* max-connections */,
std::chrono::seconds(5) /* connection TTL */);
/* Create database-specific Executor */
auto executor = std::make_shared(connectionPool);
/* Create MyClient database client */
return std::make_shared(executor);
}());
};
```
## License
- [Apache License 2.0](https://github.com/oatpp/oatpp-sqlite/blob/master/LICENSE) applies to all files of this module except [SQLite amalgamation](https://www.sqlite.org/amalgamation.html).
- [SQLite License](https://www.sqlite.org/copyright.html) applies to [SQLite amalgamation](https://www.sqlite.org/amalgamation.html) files:
- [/src/sqlite/sqlite3.c](https://github.com/oatpp/oatpp-sqlite/blob/master/src/sqlite/sqlite3.c)
- [/src/sqlite/sqlite3.h](https://github.com/oatpp/oatpp-sqlite/blob/master/src/sqlite/sqlite3.h)