Below is an overall list of SOCI core:

and backend-specific dependencies:


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.

If you intend to hack SOCI, you can clone the Git repository:

git clone git:// 

Building using CMake

SOCI is configured to build using CMake system in version 2.6+.

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.

The following tables 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
CMAKE_BUILD_TYPE string Specifies the build type for make based generators (see CMake help).
CMAKE_INSTALL_PREFIX path Install directory used by install command (see CMake help).
CMAKE_VERBOSE_MAKEFILE boolean If ON, create verbose makefile (see CMake help).
List of variables to control common SOCI features and dependencies
WITH_BOOST boolean Should CMake try to detect Boost C++ Libraries. If ON, CMake will try to find Boost headers and binaries of Boost.Date_Time library.
SOCI_TESTS boolean Request to build regression tests for SOCI core and all successfully configured backends.


SOCI MySQL backend configuration
WITH_MYSQL boolean Should CMake try to detect mysqlclient libraries providing MySQL C API. Note, currently the mysql_config program is not being used.
MYSQL_DIR string Path to MySQL installation root directory. CMake will scan subdirectories MYSQL_DIR/include and MYSQL_DIR/lib respectively for MySQL headers and libraries.
MYSQL_INCLUDE_DIR string Path to MySQL include directory where CMake should look for mysql.h header.
MYSQL_LIBRARIES string Full paths to libraries to link SOCI against to enable the backend support.
SOCI_MYSQL boolean Requests to build MySQL backend. Automatically switched on, if WITH_MYSQL is set to ON.
SOCI_MYSQL_TEST_CONNSTR string Connection string to MySQL test database. Format of the string is explained MySQL backend refernece. Example: -DSOCI_MYSQL_TEST_CONNSTR:STRING="db=mydb user=mloskot password=secret"


SOCI ODBC backend configuration
WITH_ODBC boolean Should CMake try to detect ODBC libraries. On Unix systems, CMake tries to find unixODBC or iODBC implementations.
ODBC_INCLUDE_DIRECTORIES string Path to ODBC implementation include directories where CMake should look for sql.h header.
ODBC_LIBRARIES string Full paths to libraries to link SOCI against to enable the backend support.
SOCI_ODBC boolean Requests to build ODBC backend. Automatically switched on, if WITH_ODBC is set to ON.
SOCI_ODBC_TEST_{database}_CONNSTR string ODBC Data Source Name (DSN) or ODBC File Data Source Name (FILEDSN) to test database: Microsoft Access (.mdb), Microsoft SQL Server, MySQL, PostgreSQL or any other ODBC SQL data source. {database} is placeholder for name of database driver ACCESS, MYSQL, POSTGRESQL, etc. See ODBC backend refernece for details. Example: -DSOCI_ODBC_TEST_POSTGRESQL_CONNSTR="FILEDSN=/home/mloskot/dev/soci/_git/build/test-postgresql.dsn"


SOCI Oracle backend configuration
WITH_ORACLE boolean Should CMake try to detect Oracle Call Interface (OCI) libraries.
ORACLE_INCLUDE_DIR string Path to Oracle include directory where CMake should look for oci.h header.
ORACLE_LIBRARIES string Full paths to libraries to link SOCI against to enable the backend support.
SOCI_ORACLE boolean Requests to build Oracle backend. Automatically switched on, if WITH_ORACLE is set to ON.
SOCI_ORACLE_TEST_CONNSTR string Connection string to Oracle test database. Format of the string is explained Oracle backend refernece. Example: -DSOCI_ORACLE_TEST_CONNSTR:STRING="service=orcl user=scott password=tiger"


SOCI PostgreSQL backend configuration
WITH_POSTGRESQL boolean Should CMake try to detect PostgreSQL client interface libraries. SOCI relies on libpq C library.
POSTGRESQL_INCLUDE_DIR string Path to PostgreSQL include directory where CMake should look for libpq-fe.h header.
POSTGRESQL_LIBRARIES string Full paths to libraries to link SOCI against to enable the backend support.
SOCI_POSTGRESQL boolean Requests to build PostgreSQL backend. Automatically switched on, if WITH_POSTGRESQL is set to ON.
SOCI_POSTGRESQL_TEST_CONNSTR boolean Connection string to PostgreSQL test database. Format of the string is explained PostgreSQL backend refernece. Example: -DSOCI_POSTGRESQL_TEST_CONNSTR:STRING="dbname=mydb user=mloskot"

SQLite 3

SOCI SQLite 3 backend configuration
WITH_SQLITE3 boolean Should CMak try to detect SQLite C/C++ library. As bonus, the configuration tries OSGeo4W distribution if OSGEO4W_ROOT environment variable is set.
SQLITE_INCLUDE_DIR string Path to SQLite 3 include directory where CMake should look for sqlite3.h header.
SQLITE_LIBRARIES string Full paths to libraries to link SOCI against to enable the backend support.
SOCI_SQLITE3 boolean Requests to build SQLite3 backend. Automatically switched on, if WITH_SQLITE3 is set to ON.
SOCI_SQLITE3_TEST_CONNSTR string Connection string is simply a file path where SQLite3 test database will be created (e.g. /home/john/soci_test.db). Check SQLite3 backend refernece for details. Example: -DSOCI_SQLITE3_TEST_CONNSTR="my.db"

Empty (sample backend)

SOCI empty sample backend configuration
SOCI_EMPTY boolean Builds the sample backend called Empty. Always ON by default.
SOCI_EMPTY_TEST_CONNSTR string Connection string used to run regression tests of the Empty backend. It is a dummy value. Example: -DSOCI_EMPTY_TEST_CONNSTR="dummy connection"

By default, CMake will try to determine availability of all depdendencies automatically. If you are lucky, you will not need to specify any of the CMake variables explained above. 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.

CMake configures SOCI build performing sequence of steps. Each subsequent step is dependant on result of previous steps corresponding with particular feature. First, CMake checks system platform and compilation toolset. Next, CMake tries to find all external dependencies. Then, depending on the results of the dependency check, CMake determines SOCI backends which are possible to build. The SOCI-specific variables described above provide users with basic control of this behaviour.

Building using CMake on Unix

Short version using GNU Make makefiles:

$ mkdir build
$ cd build
$ cmake -G "Unix Makefiles" -DWITH_BOOST=OFF -DWITH_ORACLE=OFF (...) ../soci-X.Y.Z
$ make
$ make install

Building using CMake on Windows

Short version using Visual Studio 2010 and MSBuild:

C:\>MKDIR build
C:\>cd build
C:\build>cmake -G "Visual Studio 10" -DWITH_BOOST=OFF -DWITH_ORACLE=OFF (...) ..\soci-X.Y.Z
C:\build>msbuild.exe SOCI.sln

Building using classic Makefiles on Unix

The classic set of Makefiles for Unix/Linux systems is provided for those users who need complete control over the whole process and who can benefit from the basic scaffolding that they can extend on their own. In this sense, the basic Makefiles are supposed to provide a minimal starting point for custom experimentation and are not intended to be a complete build/installation solution.
At the same time, they are complete in the sense that they can compile the library with all test programs and for some users this level of support will be just fine.

The core directory of the library distribution contains the Makefile.basic that can be used to compile the core part of the library. Run make -f Makefile.basic or make -f Makefile.basic shared to get the static and shared versions, respectively. Similarly, the backends/name directory contains the backend part for each supported backend with the appropriate Makefile.basic and the backends/name/test directory contains the test program for the given backend.

For example, the simplest way to compile the static version of the library and the test program for PostgreSQL is:

$ cd src/core
$ make -f Makefile.basic
$ cd ../backends/postgresql
$ make -f Makefile.basic
$ cd test
$ make -f Makefile.basic

Note: For each backend and its test program, the Makefile.basics contain the variables that can have values specific to the given environment - they usually name the include and library paths. These variables are placed at the beginning of the Makefile.basics. Please review their values in case of any compilation problems.

The Makefiles for test programs can be a good starting point to find out correct compiler and linker options.

Running regression 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 tables 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_EMPTY_TEST_CONNSTR="dummy connection" \
$ 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.

Libraries usage

CMake build produces set of shared and static libraries for SOCI core and backends separately. On Unix, for example, build/lib directory will consist of the static libraries named like libsoci_core.a, libsoci_sqlite3.a and shared libraries with names like,, and so on.

In order to use SOCI in your program, you need to specify your project build configuration with paths to SOCI headers and libraries, and specify linker to link against the libraries you want to use in your program.