odbx_set_option(3)

NAME
odbx_set_option - Change behaviour of the database backend

SYNOPSIS
\FC#include <opendbx/api.h>\F[]

\FCint odbx_set_option\F[]
\FC(odbx_t* handle, unsigned int option, void* value);\F[]

DESCRIPTION
Changes the value of the specified option in the backend module or the native database library associated to handle by \FCodbx_init\F[](). Before trying to set an option, it should be tested with \FCodbx_get_option\F[]() first to ensure that it is supported by the backend. Almost all options need to be set before connecting to the database server using \FCodbx_bind\F[]() to take any effect.

The first parameter \FChandle\F[] is the connection object created and returned by \FCodbx_init\F[]() which becomes invalid as soon as it was supplied to \FCodbx_finish\F[]().

There are several \FCoption\F[] values defined as named constants in the odbx.h header file. The available options whose values can be changed are:

\FCODBX_OPT_TLS\F[]
    Use encryption to transmit all data securely over the network via SSL or TLS. This option can be set to \FCODBX_TLS_NEVER\F[] (the default value) to prevent encrpytion, \FCODBX_TLS_ALWAYS\F[] to enforce encryption and to fail if it can't be used between the client library and the server or \FCODBX_TLS_TRY\F[] to use encryption if possible with the option to fall back to a connection which isn't encrypted.

\FCODBX_OPT_MULTI_STATEMENTS\F[]
    Enables the database server to accept multiple statements in one query string sent via \FCodbx_query\F[]() if the value of value is set to \FCODBX_ENABLE\F[]. Although, it might be possible to disable it by setting it to \FCODBX_DISABLE\F[].

\FCODBX_OPT_PAGED_RESULTS\F[]
    All database servers and client libraries are able to transfer the records row by row. Some of them can also transfer multiple rows or even all at once to minimize server load, network traffic and latency. The downside of this is an increased memory consumption. If paged results are supported by the backend, passing positive values will fetch the specified number of records at once from the database server. The value of zero ("0") is special in this case because it asks the backend module to retrieve all records at once

\FCODBX_OPT_COMPRESS\F[]
    Enable compressed network traffic between database client and server. This can maximize the throughput if the network is the bottleneck. Pass an integer variable with \FCODBX_ENABLE\F[] to enable compression or with \FCODBX_DISABLE\F[] to disable it for this connection

\FCODBX_OPT_MODE\F[]
    Some database servers support different modes of operation, e.g. modes for compliance to other SQL implementations or completely different query languages. This option is available since OpenDBX 1.1.4. \FCvalue\F[] must point to a zero terminated string and for a detailed description of the MySQL modes look at their

If not stated otherwise, the type of the variable passed to the third parameter \FCvalue\F[] must be an integer pointer. Its values should be in the range specified by the option being changed.

RETURN VALUE
\FCodbx_set_option\F[]() returns \FCODBX_ERR_SUCCESS\F[], or an error code whose value is less than zero if one of the operations couldn't be completed successfully. Possible error codes are listed in the error section and they can be feed to \FCodbx_error\F[]() and \FCodbx_error_type\F[]() to get further details.

ERRORS

-\FCODBX_ERR_PARAM\F[]
    One of the supplied parameters is invalid or is NULL and this isn't allowed in the used backend module or in the native database client library

-\FCODBX_ERR_OPTION\F[]
    The value passed to the \FCoption\F[] parameter isn't one of the values listed in this manual. The content of \FCvalue\F[] remains unchanged if this error occurs

-\FCODBX_ERR_OPTRO\F[]
    The option isn't intended for being changed and could only be read via \FCodbx_get_option\F[]()

-\FCODBX_ERR_OPTWR\F[]
    Setting the option failed for various reasons. It's most likely that the value passed via \FCvalue\F[] didn't match the range of values expected by the backend or the native database library

SEE ALSO
\FCodbx_bind\F[](), \FCodbx_error\F[](), \FCodbx_get_option\F[]()