Installation

Requirements

Below is an overall list of SOCI core:

and backend-specific dependencies:

Downloads

Download package with latest release of the SOCI source code: soci-X.Y.Z, where X.Y.Z is the version number. Unpack the archive.

You can always clone SOCI from the Git repository:

git clone git://github.com/SOCI/soci.git

Building with CMake

For building SOCI, CMake version 3.23 or later is required.

The build configuration allows to control various aspects of compilation and installation by setting common CMake variables that change behaviour, describe system or control build (see CMake help) as well as SOCI-specific variables described below. All these variables are available regardless of platform or compilation toolset used.

Running CMake from the command line allows to set variables in the CMake cache with the following syntax: -DVARIABLE:TYPE=VALUE. If you are new to CMake, you may find the tutorial Running CMake helpful.

TL;DR

Steps outline using GNU Make Makefile-s:

cmake -DSOCI_ORACLE=OFF (...) -B build -S /path/to/soci-X.Y.Z
cmake --build build

Optionally, SOCI defines an install target that can be executed (on Unix systems) via make install.

CMake configuration

By default, CMake will try to determine availability of all dependencies automatically. If you are lucky, you will not need to specify any of the CMake variables explained below. However, if CMake reports some of the core or backend-specific dependencies as missing, you will need specify relevant variables to tell CMake where to look for the required components.

The following sections provide summary of variables accepted by CMake scripts configuring SOCI build. The lists consist of common variables for SOCI core and all backends as well as variables specific to SOCI backends and their direct dependencies.

List of a few essential CMake variables:

List of variables to control common SOCI features and dependencies:

Some other build options:

When it comes to enabling specific backends, SOCI supports three distinct options that can be used as Enabler type as used below:

Empty (sample backend)

IBM DB2

Firebird

MySQL

Furthermore, the MYSQL_DIR environment variable can be set to the MySQL installation root. CMake will scan subdirectories MYSQL_DIR/include and MYSQL_DIR/lib respectively for MySQL headers and libraries.

ODBC

Oracle

PostgreSQL

SQLite 3

Building with Conan

SOCI is available as a Conan package since February 2021 for the version 4.0.1 for the following backends: sqlite3, odbc, mysql, and postgresql.

This section lists the steps required to use SOCI in a CMake project with Conan:

Install Conan

Install Conan if it is not installed yet:

pip3 install conan

Create conanfile.txt

Create a conanfile.txt in the same directory of the CMakeLists.txt, with a reference to a recipe (which is a string with the library name and the version to use), the build options, and the CMake generator:

# conanfile.txt
[requires]
soci/4.0.1

[options]
soci:shared       = True
soci:with_sqlite3 = True

[generators]
cmake

The option soci:with_sqlite3 = True indicates that the sqlite3 backend will be downloaded and used.

Update CMakeLists.txt

Add the following Conan-specific lines to the CMakeLists.txt of your project:

include(${CMAKE_BINARY_DIR}/conanbuildinfo.cmake)
conan_basic_setup(TARGETS)
conan_target_link_libraries(${PROJECT_NAME} ${CONAN_LIBS})

The command conan_target_link_libraries replaces target_link_libraries.

Run Conan

Run conan install to install SOCI, and then build your project as usual:

mkdir build
cd build
conan install .. --build=soci
cmake ..
cmake . --build

Running tests

The process of running regression tests highly depends on user's environment and build configuration, so it may be quite involving process. The CMake configuration provides variables to allow users willing to run the tests to configure build and specify database connection parameters (see the lists above for variable names).

In order to run regression tests, configure and build desired SOCI backends and prepare working database instances for them.

While configuring build with CMake, specify SOCI_TESTS=ON to enable building regression tests. Also, specify SOCI_{backend name}_TEST_CONNSTR variables to tell the tests runner how to connect with your test databases.

Dedicated make test target can be used to execute regression tests on build completion:

mkdir build
cd build
cmake -G "Unix Makefiles" \
        -DWITH_BOOST=OFF \
        -DSOCI_TESTS=ON \
        -DSOCI_EMPTY_TEST_CONNSTR="dummy connection" \
        -DSOCI_SQLITE3_TEST_CONNSTR="test.db" \
        (...)
        ../soci-X.Y.Z
make
make test
make install

In the example above, regression tests for the sample Empty backend and SQLite 3 backend are configured for execution by make test target.

Using the library

CMake build produces set separate libraries for SOCI's core and all enabled backends.

If your project also uses CMake, you can simply use find_package(SOCI) to check for SOCI availability and target_link_libraries() to link with the SOCI::soci target. An example of a very simple CMake-based project using SOCI is provided in the examples/connect directory.

Alternatively, you can add SOCI as a subdirectory to your project and include it via add_subdirectory(). As before, target_link_libraries() is used to link with the SOCI::soci target. An example of this can be found in the directory examples/subdir-include.

If you don't use CMake but want to use SOCI in your program, you need to specify the paths to the SOCI headers and libraries in your build configuration and to tell the linker to link against the libraries you want to use in your program.