oatpp-postgresql/README.md

oatpp-postgresql

Oat++ ORM adapter for PostgreSQL.
Note: this alpha version, which means that not all PostgreSQL data-types are supported. See the list of Supported Data Types.

More about Oat++:

• Oat++ Website
• Oat++ Github Repository
• Oat++ ORM

Build And Install

Note: you need to install the main oatpp module and PostgreSQL dev package first.

• Clone this repository.
• In the root of the repository run:

  mkdir build && cd build
  cmake ..
  make install
  

API

Detailed documentation on Oat++ ORM you can find here.

Connect to Database

All you need to start using oatpp ORM with PostgreSQL is to create oatpp::postgresql::Executor and provide it to your DbClient.

#include "db/MyClient.hpp"
#include "oatpp-postgresql/orm.hpp"

class AppComponent {
public:
  
  /**
   * Create DbClient component.
   */
  OATPP_CREATE_COMPONENT(std::shared_ptr<db::MyClient>, myDatabaseClient)([] {
    /* Create database-specific ConnectionProvider */
    auto connectionProvider = std::make_shared<oatpp::postgresql::ConnectionProvider>("<connection-string>");    
  
    /* Create database-specific ConnectionPool */
    auto connectionPool = oatpp::postgresql::ConnectionPool::createShared(connectionProvider, 
                                                                          10 /* max-connections */, 
                                                                          std::chrono::seconds(5) /* connection TTL */);
    
    /* Create database-specific Executor */
    auto executor = std::make_shared<oatpp::postgresql::Executor>(connectionPool);
  
    /* Create MyClient database client */
    return std::make_shared<MyClient>(executor);
  }());

};

Supported Data Types

• INT2
• INT4
• INT8
• TIMESTAMP
• TEXT
• VARCHAR
• FLOAT4
• FLOAT8
• BOOL
• UUID