Welcome to EXTRAS-SOCI!

MySQL Backend Reference

Prerequisites

Supported Versions

The SOCI MySQL backend should in principle work with every version of MySQL 3.x or newer. Some of the features (transactions, stored functions) are not available when MySQL server doesn't support them.

Tested Platforms

MySQL version	Operating System	Compiler
5.0.45	Linux i686 2.6.23 (Fedora release 7)	g++ 4.1.2

Required Client Libraries

The SOCI MySQL backend requires MySQL's libmysqlclient client library.

Note that the SOCI library itself depends also on libdl, so the minimum set of libraries needed to compile a basic client program is:

-lsoci_core -lsoci_mysql -ldl -lmysqlclient

Connecting to the Database

To establish a connection to a MySQL server, create a session object using the mysql backend factory together with a connection string:

session sql(mysql, "db=test user=root password='Ala ma kota'");

// or:
session sql("mysql", "db=test user=root password='Ala ma kota'");

// or:
session sql("mysql://db=test user=root password='Ala ma kota'");

The set of parameters used in the connection string for MySQL is:

dbname or db (required)
user
password or pass
host
port
unix_socket

Once you have created a session object as shown above, you can use it to access the database, for example:

int count;
sql << "select count(*) from invoices", into(count);

(See the SOCI basics and exchanging data documentation for general information on using the session class.)

SOCI Feature Support

Dynamic Binding

The MySQL backend supports the use of the SOCI row class, which facilitates retrieval of data which type is not known at compile time.

When calling row::get<T>(), the type you should pass as T depends upon the underlying database type.
For the MySQL backend, this type mapping is:

MySQL Data Type	SOCI Data Type	`row::get<T>` specializations
FLOAT, DOUBLE, DECIMAL and synonyms	`dt_double`	`double`
TINYINT, SMALLINT, INT, BIGINT (provided it's in the range)	`dt_integer`	`int`
STRING/BINARY, VARCHAR/VARBINARY	`dt_string`	`std::string`
TIMESTAMP (works only with MySQL >= 5.0), DATE, TIME, DATETIME	`dt_date`	`std::tm`

(See the dynamic resultset binding documentation for general information on using the Row class.)

Binding by Name

In addition to binding by position, the MySQL backend supports binding by name, via an overload of the use() function:

int id = 7;
sql << "select name from person where id = :id", use(id, "id")

It should be noted that parameter binding of any kind is supported only by means of emulation, since the underlying API used by the backend doesn't provide this feature.

Bulk Operations

The MySQL backend has full support for SOCI's bulk operations interface. This feature is also supported by emulation.

Transactions

Transactions are also supported by the MySQL backend. Please note, however, that transactions can only be used when the MySQL server supports them (it depends on options used during the compilation of the server; typically, but not always, servers >=4.0 support transactions and earlier versions do not) and only with appropriate table types.

BLOB Data Type

SOCI blob interface is not supported by the MySQL backend.

RowID Data Type

The rowid functionality is not supported by the MySQL backend.

Nested Statements

Nested statements are not supported by the MySQL backend.

Stored Procedures

MySQL version 5.0 and later supports two kinds of stored routines: stored procedures and stored functions (for details, please consult the MySQL documentation). Stored functions can be executed by using SOCI's procedure class. There is currently no support for stored procedures.

Acessing the native database API

SOCI provides access to underlying datbabase APIs via several get_backend() functions, as described in the Beyond SOCI documentation.

The MySQL backend provides the following concrete classes for native API access:

Accessor Function	Concrete Class
`session_backend * session::get_backend()`	`mysql_session_backend`
`statement_backend * statement::get_backend()`	`mysql_statement_backend`

Backend-specific extensions

None.

Configuration options

None.