odbx_bind(3)

NAME
odbx_bind, odbx_bind_simple - User authentication for a database connection

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

\FCint odbx_bind\F[]
\FC(odbx_t* handle, const char* database, const char* who, const char* cred, int method);\F[]

\FCint odbx_bind_simple\F[]
\FC(odbx_t* handle, const char* database, const char* who, const char* cred);\F[]

DESCRIPTION
\FCodbx_bind\F[]() associates a connection created by \FCodbx_init\F[]() to a specific database after the server verified and accepted the user credentials. All further operations will (normally) only affect the tables and records within this database. The operations may be limited to certain subset depending on the privileges granted to the given user account. If binding to the database instance succeeded, \FCodbx_bind\F[]() also enables compatibility to the ANSI SQL standard if this is possible for the database server implementation.

\FCodbx_bind_simple\F[]() performs the same tasks as \FCodbx_bind\F[]() but can't do anything else than simple user name / password authentication. It shouldn't be used in applications linking to the OpenDBX library version 1.1.1 or later and it will be removed from the library at a later stage.

Both functions accept almost the same parameters. The \FChandle\F[] parameter always has to be a pointer to a valid connection object allocated by \FCodbx_init\F[](). The availability of certain options or the behavior of the connection associated to the given odbx_t pointer can be queried by calling \FCodbx_get_option\F[]() respectively changed by \FCodbx_set_option\F[](). Changes must be done before calling \FCodbx_bind\F[]() to take any effect. Examples of options are the thread-safetiness of the native database client library or the support for sending multiple statements at once.

\FCdatabase\F[] is necessary to let the database server know which database should be used for executing all further requests. In combination with the authentication parameters \FCwho\F[] and \FCcred\F[], it usually allows or denies operations on tables and records within this database. Contrary to that, SQLite doesn't use \FCwho\F[] and \FCcred\F[] but relies on the file system permissions instead to grant access to the whole database file. If they are used, the supplied values for all three parameters must be zero-terminated strings and should be in exactly the same character case as stored by the database manager. Otherwise, if they are unused they can also be NULL. Some database libraries also support default values provided by a configuration file if a parameter is NULL.

\FCmethod\F[] specifies the mechanism for authenticating a user account before it can perform operations on tables and records. Currently, all database backend modules only support the \FCODBX_BIND_SIMPLE\F[] method which provides basic user name / password authentication. In this case, the parameter \FCwho\F[] must be the name of an user account while \FCcred\F[] has to be the password that belongs to the given account.

An already associated connection object can be detached from the database and rebound to the same database server. It is possible to bind it to another database, with another user account and other options set by detaching the connection object with \FCodbx_unbind\F[]() first before invoking \FCodbx_bind\F[]() with the same or with different parameters again.

RETURN VALUE
\FCodbx_init\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_BACKEND\F[]
    The backend module returned an error because it couldn't connect to the database or the authentication using the supplied parameters failed

-\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_NOMEM\F[]
    Allocating additionally required memory failed

-\FCODBX_ERR_SIZE\F[]
    The length of a string exceeded the available buffer size

-\FCODBX_ERR_NOTSUP\F[]
    The supplied authentication method is not supported by the backend module

SEE ALSO
\FCodbx_error\F[](), \FCodbx_error_type\F[](), \FCodbx_init\F[](), \FCodbx_query\F[](), \FCodbx_unbind\F[]()