Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The MariaDB Connector/C is used to connect applications developed in C/C++ to MariaDB and MySQL databases. MariaDB Connector/C is LGPLv2.1 licensed.
Build MariaDB Connector/C from source. Download the package from MariaDB downloads or get the latest development version from the Connector/C GitHub repository.
Quickstart Guide for Connector/C
MariaDB Connector/C is used to connect applications developed in C/C++ to MariaDB and MySQL databases.The client library is LGPL licensed.
MariaDB Connector/C is distributed with MariaDB Server packages. Eventually, it will completely replace the functionality that has traditionally been performed by libmysqlclient in those packages. Currently, MariaDB Connector/C has replaced libmysqlclient as the client library for client utilities that are distributed with MariaDB Server. See MDEV-9055 for more information.
MariaDB Connector/C packages can be downloaded by selecting your desired version from the following page:
MariaDB Connector/C packages can also be downloaded by selecting C/C++ connector as the Product on the following page:
See the instructions below for information on how to install the MariaDB Connector/C package for your operating system.
To install MariaDB Connector/C on Windows, we distribute . The MSI installation process is fairly straightforward. Both 32-bit and 64-bit MSI packages are available.
MariaDB Connector/C is distributed in on Linux.
Since MariaDB Connector/C is now integrated with MariaDB Server, it can also be installed via a package manager on Linux. In order to do so, your system needs to be configured to install from one of the MariaDB repositories. The repository needs to be configured for or later.
You can configure your package manager to install it from MariaDB Corporation's MariaDB Package Repository by using the .
You can also configure your package manager to install it from MariaDB Foundation's MariaDB Repository by using the .
Installing with yum/dnf
On RHEL, CentOS, Fedora, and other similar Linux distributions, it is highly recommended to install the relevant from MariaDB's
repository using or . Starting with RHEL 8 and Fedora 22, yum has been replaced by dnf, which is the next major version of yum. However, yum commands still work on many systems that use dnf. For example:
If you want to build applications with MariaDB Connector/C, then you will also need to install the development package. For example:
Installing with apt-get
On Debian, Ubuntu, and other similar Linux distributions, it is highly recommended to install the relevant from MariaDB's repository using . For example:
If you want to build applications with MariaDB Connector/C, then you will also need to install the development package. For example:
Installing with zypper
On SLES, OpenSUSE, and other similar Linux distributions, it is highly recommended to install the relevant from MariaDB's repository using .
For example:
If you want to build applications with MariaDB Connector/C, then you will also need to install the development package. For example:
See for information on how to build MariaDB Connector/C from source.
MariaDB Connector/C has exactly the same API as the MySQL Connector/C for MySQL 5.5
The function reference is available at:
It is also downloadable in html format from
Just like MariaDB Server and libmysqlclient, MariaDB Connector/C can also read configuration options from client in .
See for more information.
double to string conversion for prepared statements doesn't work correctly
Connector 3.0.7 and below doesn't support the MySQL 8.0 default authentication protocol, . This protocol should be supported in Connector/C 3.0.8 and above.
If you find a bug, please report it via the on .
The source code is available at the on GitHub.
GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
For licensing questions, see the .
Explore API functions for MariaDB Connector/C. This section provides detailed documentation on functions for connecting, querying, and managing data, enabling robust C applications for MariaDB.
const char * mysql_character_set_name(MYSQL * mysql);The mysql_fetch_lengths() function returns an array containing the lengths of every column of the current row within the result set (not including terminating zero character) or NULL if an error occurred.
unsigned long * mysql_fetch_lengths(MYSQL_RES * result);Returns information about the current default for the specified connection.
void mysql_get_character_set_info(MYSQL * mysql,
MY_CHARSET_INFO * charset);To obtain a string containing the client library version use the mysql_get_client_info() function.
unsigned long mysql_get_client_version(void);my_bool mariadb_reconnect(MYSQL * mysql)mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
mariadb_reconnect() tries to reconnect to a server in case the connection died due to timeout or other errors. It uses the same credentials which were specified in .
The function will return 0 on sucess.
The function will return an error, if the option MYSQL_OPT_RECONNECT wasn't specified before.
This function was added in Connector/C 3.0.
my_ulonglong mysql_affected_rows(MYSQL * mysql);mysql is a connection identifier, which was previously allocated by mysql_init() or mysql_real_connect().
Returns the number of affected rows by the last operation associated with MySQL, if the operation was an "upsert" (, , or ) statement, or UINT64_MAX (0xffffffffffffffff) if the last query failed.
my_bool mysql_autocommit(MYSQL * mysql, my_bool auto_mode);mysql - a mysql handle, identifier, which was previously allocated by mysql_init() or mysql_real_connect().
auto_mode - whether to turn on or not.
Toggles autocommit mode on or off for the current database connection. Autocommit mode will be set if mode=1 or unset if mode=0. Returns zero on success, or nonzero if an error occurred. Parameters
void mysql_close(MYSQL * mysql);mysql - mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
Closes a previously opened connection.
result - a result set identifier returned by mysql_store_result() or mysql_use_result().
offset - the field number. This number must be in the range from 0..number of fields - 1.
Sets the field cursor to the given offset. The next call to will retrieve the field definition of the column associated with that offset.
Returns the previous value of the field cursor.
MYSQL_FIELD_OFFSET mysql_field_tell(MYSQL_RES * result);result - a result set identifier returned by mysql_store_result() or mysql_use_result().
Return the offset of the field cursor used for the last call. This value can be used as a parameter for the function .
Returns the current offset of the field cursor
These are currently documented on the github wiki.
my_bool mysql_commit(MYSQL * mysql);mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
Commits the current transaction for the specified database connection. Returns zero on success, nonzero if an error occurred.
unsigned int mysql_get_proto_info(MYSQL * mysql);mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
Returns the protocol version number for the specified connection
int mysql_library_init(int argc, char **argv, char **groups)Call to initialize the library before calling other functions, both for embedded servers and regular clients. If used on an embedded server, the server is started and subsystems initialized. Returns zero for success, or nonzero if an error occurred.
Call to clean up after completion.
unsigned int mysql_num_fields(MYSQL_RES * );MYSQL RES * - A result set identifier returned by mysql_store_result() or mysql_use_result().
Returns number of fields in a specified result set.
const char * mysql_get_host_info(MYSQL * mysql);mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
Describes the type of connection in use for the connection, including the server host name. Returns a string, or NULL if the connection is not valid.
const char * mysql_get_server_info(MYSQL * mysql);mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
Returns the server version or NULL on failure.
int mysql_select_db(MYSQL * mysql,
const char * db);mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
db - the default database name
Selects a database as default. Returns zero on success, non-zero on failure
MYSQL_RES - a result set identifier returned by mysql_store_result() or mysql_use_result().
Returns number of rows in a result set.
res - a result set identifier returned by mysql_store_result() or mysql_use_result().
fieldnr - the field number. This value must be within the range from 0 to number of fields - 1
Returns a pointer to a MYSQL_FIELD structure which contains field information from the specified result set.
int mysql_send_query(MYSQL * mysql,
const char * query,
unsigned long length);mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
query - the query to execute.
length - length of query.
Returns zero on success, otherwise non-zero.
mysql_send_query() executes a SQL statement without waiting for the result. The main purpose of this function is to perform batch execution of DML statements.
Each successful call tomysql_send_query() must be followed by a call to . Multiple calls to mysql_send_query() can be made before the calls to are done.
Explore API functions for prepared statements in Connector/C. This section provides detailed documentation on using prepared statements for efficient and secure query execution in C applications.
sudo yum install MariaDB-sharedsudo yum install MariaDB-develsudo apt-get install libmariadb3sudo apt-get install libmariadb-devsudo zypper install MariaDB-sharedsudo zypper install MariaDB-develMYSQL_FIELD_OFFSET mysql_field_seek(MYSQL_RES * result,
MYSQL_FIELD_OFFSET offset);my_ulonglong mysql_num_rows(MYSQL_RES * );MYSQL_FIELD * mysql_fetch_field_direct(MYSQL_RES * res,
unsigned int fieldnr);Sets local infile callback functions to MariaDB Connector/C internal default callback functions.
mysql - mysql handle, which was previously allocated by mysql_init()
#include <mysql.h>
void mysql_set_local_infile_default(MYSQL *conn);passwd - the password for server authentication
db - the default database. If desired, the NULL value may be passed resulting in only changing the user and not selecting a database. To select a database in this case use the mysql_select_db() function.
Changes the user and default database of the current connection.
In order to successfully change users a valid username and password parameters must be provided and that user must have sufficient permissions to access the desired database. If for any reason authorization fails, the current user authentication will remain.
Returns zero on success, nonzero if an error occured.
Returns an integer representing the version of connected server.
unsigned long mysql_get_server_version(MYSQL * mysql);Frees the memory associated with a result set. Returns void.
Returns the definition of one column of a result set as a pointer to a MYSQL_FIELD structure. Call this function repeatedly to retrieve information about all columns in the result set.
Returns the last for the most recent function call that can succeed or fail. Zero means no error occurred.
This function is designed to be executed by an user with the SUPER privilege and is used to dump server status information into the log for the MariaDB Server relating to the connection.
Returns zero on success, nonzero if an error occurred.
mysql_debug_end()
int mysql_dump_debug_info(MYSQL * mysql);Returns the number of columns for the most recent query on the connection represented by the link parameter as an unsigned integer. This function can be useful when using the mysql_store_result() function to determine if the query should have produced a non-empty result set or not without knowing the nature of the query.
Returns the name of the currently used cipher of the , or NULL for non TLS connections.
const char *mysql_get_ssl_cipher(MYSQL *mysql)If mysql_thread_init() was not called before, mysql_init() will also initialize the thread subsystem for the current thread.
This function is used to ask the server to kill a MariaDB thread specified by the processid parameter. This value must be retrieved by . If trying to kill the own connection mysql_thread_id() should be used.
Returns 0 on success, otherwise nonzero.
Returns the row offset of a result cursor. The returned offset value can be used to reposition the result cursor by calling mysql_row_seek().
Returns the last error message for the most recent function call that can succeed or fail. If no error occurred an empty string is returned.
const char * mysql_error(MYSQL * mysql);long - length of the string.
mysql_real_query() is a binary-safe function for executing a statement on the database server. Returns zero on success, otherwise non-zero.
for Connector/C 2.x: OpenSSL libraries and include files.
for Connector/C 3.0 remote-io plugin: Curl libraries and include files
The following is a list of tools that are required for building MariaDB Connector/C on Linux and Mac OS X. Most, if not all, of these will exist as packages in your distribution's package repositories, so check there first.
gcc 3.4.6 or newer C compiler
TLS/SSL libraries and include files
OpenSSL 1.0.1 or newer or
GnuTLS 3.4 or newer
cmake 2.8.12 or newer, available from the .
for Connector/C 3.0 remote-io plugin: libraries and include files
For GSSAPI plugin: libraries
On Linux you can get those programs with your package manager. On Mac OS X you will need Xcode and to install the remaining programs with Fink or MacPorts.
Checks whether the connection to the server is working. If it has gone down, and global option reconnect is enabled an automatic reconnection is attempted.
Returns zero on success, nonzero if an error occured.
This function can be used by clients that remain idle for a long while, to check whether the server has closed the connection and reconnect if necessary.
Prepares next result set from a previous call to mysql_real_query() which can be retrieved by mysql_store_result() or mysql_use_result(). Returns zero on success, nonzero if an error occurred.
mysql_row_seek()Positions the row cursor to an aribtrary row in a result set which was obtained by mysql_store_result(). Returns the previous row offset.
SHUTDOWN_DEFAULTSends a shutdown message to the server. To shut down the database server, the user for the current connection must have SHUTDOWN privileges.
Returns zero on success, non-zero on failure.
int mysql_shutdown(MYSQL * mysql,
enum mysql_enum_shutdown_level);By default the mariadb client library is compiled as thread safe.
unsigned int mysql_thread_safe(void );mysql_stat() returns a string with the current server status for uptime, threads, queries, open tables, flush tables and queries per second.
const char * mysql_stat(MYSQL * mysql);mysql_server_end() is an alias.
void mysql_library_end(void)Closes a prepared statement and deallocates the statement handle. If the current statement has pending or unread results, this function cancels them so that the next query can be executed.
Returns zero on success, nonzero on error (when communicating with the server). The statement is deallocated, regardless of the error.
This function has been deprecated since MariaDB Connector/C 3.0.0.
mysql_read_query_result() reads the result of a SQL statement executed with mysql_send_query(). If the SQL statement returned a resultset, it must be freed before the next call to mysql_read_query_result() is made. This is similar to how results from mysql_query() must be processed before another call can be made.
int mysql_read_query_result(MYSQL * mysql);To obtain the numeric value of the client library version use mysql_get_client_version().
const char * mysql_get_client_info(void );SET AUTOCOMMIT=0;mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
The mysql_info() function returns a string providing information about the last query executed. The nature of this string is provided below:
Table 1. Possible mysql_info return values
unsigned long mysql_hex_string(char * to,
const char * from,
unsigned long len);to - result buffer
from - the string which will be encoded
len - length of the string (from)
This function is used to create a hexadecimal string which can be used in SQL statements. e.g. INSERT INTO my_blob VALUES(X'A0E1CD').
Returns the length of the encoded string without the trailing null character.
mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
Indicates if one or more result sets are available from a previous call to . Returns 1 if more result sets are available, otherwise zero. .
mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
options - a bit masked composed integer. See below.
Flushes different types of information stored on the server. The bit-masked parameter options specify which kind of information will be flushed. options can be any combination of the following:
Returns zero on success, otherwise nonzero.
mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
key - path to the key file.
cert - path to the certificate file.
ca - path to the certificate authority file.
capath - path to the directory containing the trusted TLS CA certificates in PEM format.
cipher list of permitted ciphers to use for TLS encryption.
Used for establishing a . It must be called before attempting to use . TLS support must be enabled in the client library in order for the function to have any effect.
NULL can be used for an unused parameter. Always returns zero.
unsigned long mysql_real_escape_string(MYSQL * mysql,
char * to,
const char * from,
unsigned long);mysql - a MySQL handle, which was previously allocated by mysql_init() or mysql_real_connect().
to - buffer for the encoded string. The size of this buffer must be length * 2 + 1 bytes: in the worst case every character of the from string needs to be escaped. Additionally, a trailing 0 character will be appended.
from - a string which will be encoded by mysql_real_escape_string().
long - the length of the from string.
This function is used to create a legal SQL string that you can use in an SQL statement. The given string is encoded to an escaped SQL string, taking into account the current character set of the connection.
Returns the length of the encoded (to) string.
void mysql_server_end(void );mysql_server_end() is an alias for mysql_library_end().
my_bool mysql_thread_init(void );Thread initialization for multi-threaded clients. Multi-threaded clients should call mysql_thread_init() at the beginning of the thread initialization to initialize thread specific client library variables. If mysql_thread_init() was not called explicitly, it will be called automatically by or .
Returns zero if successful or 1 if an error occurred.
This function has been deprecated since MariaDB Connector/C 3.0.0.
void mysql_data_seek(MYSQL_RES * result,
my_ulonglong offset);result - a result set identifier returned by mysql_store_result().
offset - the field offset. Must be between zero and the total number of rows minus one (0..mysql_num_rows - 1).
The mysql_data_seek() function seeks to an arbitrary function result pointer specified by the offset in the result set. Returns zero on success, nonzero if an error occurred.
mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
mysql_option - the option you want to set. See description below.
arg - the value for the option.
Used to set extra connect options and affect behavior for a connection. This function may be called multiple times to set several options. mysql_options() should be called after and before .
Returns zero on success, non zero if an error occurred (invalid option or value).
This function is deprecated as of MariaDB Connector/C 3.0 and will be removed in future releases. It's preferable to use .
See .
mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
Returns a buffered result set from the last executed query.
MYSQL_ROW mysql_fetch_row(MYSQL_RES * result);result - a result set identifier returned by mysql_store_result() or mysql_use_result().
Fetches one row of data from the result set and returns it as an array of char pointers (MYSQL_ROW), where each column is stored in an offset starting from 0 (zero). Each subsequent call to this function will return the next row within the result set, or NULL if there are no more rows.
mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
The mysql_thread_id() function returns the thread id for the current connection.
const char * mysql_sqlstate(MYSQL * mysql);mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
Returns a string containing the error code for the most recently invoked function that can succeed or fail. The error code consists of five characters. '00000' means no error. The values are specified by ANSI SQL and ODBC
stmt - a statement handle, which was previously allocated by mysql_stmt_init().
bind - an array of structures. The size of this array must be equal to the number of columns in result set.
Binds columns in the result set to variables. Returns zero on success, non-zero on failure.
my_ulonglong mysql_stmt_affected_rows(MYSQL_STMT * stmt);stmt - a statement handle, which was previously allocated by mysql_stmt_init().
Returns the number of affected rows by the last prepared statement associated with mysql, if the operation was an "upsert" (, , or ) statement, or -1 if the last prepared statement failed.
mysql - mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
type - type of information. Valid values are
SESSION_TRACK_SYSTEM_VARIABLES
SESSION_TRACK_SCHEMA
SESSION_TRACK_STATE_CHANGE
data - pointer to data, which must be declared as const char *
length - pointer to a size_t variable, which will contain the length of data
mysql_session_track_get_first() retrieves the first session status change information received from the server.
Depending on the specified type the read only data pointer will contain the following information:
SESSION_TRACK_SCHEMA: The name of the default schema (database)
SESSION_TRACK_SYSTEM_VARIABLES: If a session system variable is changed, the first call contains the name of the changed system variable, the second call contains the new value. Both name and value are represented as strings.
SESSION_TRACK_STATE_CHANGE: shows whether the session status has changed. The value is changed as string "1" (changed) or "0" (unchanged).
Further data needs to be obtained by calling .
mysql_session_track_get_first() was added in Connector/C 3.0 and MariaDB Server 10.2.
Zero for success, nonzero if an error occurred.
my_bool mysql_rollback(MYSQL * mysql);mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
Rolls back the current transaction for the database. Returns zero on success, nonzero if an error occurred.
mysql - a MySQL handle, which was previously allocated by mysql_init() or mysql_real_connect().
Resets the current connection and clears session state. Similar to or , mysql_reset_connection() resets session status, but without disconnecting, opening, or reauthenticating.
On client side mysql_reset_connection()
clears pending or unprocessed result sets
clears status like affected_rows, info or last_insert_id
invalidates active prepared statements
On server side mysql_reset_connection()
drops temporary table(s)
rollbacks active transaction
resets auto commit mode
releases table locks
Returns zero on success, non-zero if an error occurred.
This function was added in MariaDB Connector/C 3.0.0.
int mysql_set_server_option(MYSQL * mysql,
enum enum_mysql_set_option);mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
enum_mysql_set_option - server option (see below)
Server option, which can be one of the following values:
Returns zero on success, non-zero on failure.
my_bool mysql_change_user(MYSQL * mysql,
const char * user,
const char * passwd,
const char * db);void mysql_free_result(MYSQL_RES * result);MYSQL_FIELD * mysql_fetch_field(MYSQL_RES * result);unsigned int mysql_errno(MYSQL * mysql);unsigned int mysql_field_count(MYSQL * mysql);MYSQL * mysql_init(MYSQL * mysql);int mysql_kill(MYSQL * mysql,
unsigned long);MYSQL_ROW_OFFSET mysql_row_tell(MYSQL_RES * res);int mysql_real_query(MYSQL * mysql,
const char * q,
unsigned long);int mysql_ping(MYSQL * mysql);int mysql_next_result(MYSQL * mysql);MYSQL_ROW_OFFSET mysql_row_seek(MYSQL_RES * result,
MYSQL_ROW_OFFSET offset);my_bool mysql_stmt_close(MYSQL_STMT * stmt);void mysql_thread_end(void );const char * mysql_info(MYSQL * mysql);my_bool mysql_more_results(MYSQL * mysql);int mysql_refresh(MYSQL * mysql,
unsigned int options);my_bool mysql_ssl_set(MYSQL *mysql, const char *key, const char *cert,
const char *ca, const char *capath, const char *cipher)int mysql_options(MYSQL * mysql,
enum mysql_option,
const void * arg);MYSQL_RES * mysql_store_result(MYSQL * mysql);unsigned long mysql_thread_id(MYSQL * mysql);my_bool mysql_stmt_bind_result(MYSQL_STMT * stmt,
MYSQL_BIND * bind);int mysql_session_track_get_first(MYSQL * mysql,enum enum_session_state_type type, const char **data, size_t *length );int mysql_reset_connection(MYSQL * mysql);Registers four callback functions which will be called if a LOAD DATA LOCAL INFILE command will be executed.
The initialization function accepts 3 parameters and returns zero on success, nonzero on error. It allocates an handle, which will be passed to read, end and error functions:
int init(void **handle, const char *filename, void *userdata)
The read function is called repeatly to read data chunks from file into buffer. The amount of bytes is limited by parameer buffer_len. The function returns the number of bytes which were read from the file:
int mysql_local_infile_read(void *handle, char * buffer, unsigned int buffer_len)
The end function will be called after the read function returned zero (no more bytes to read). To prevent leaking of resources, the file must be closed and handle must be freed inside this function:
void end(void *handle);
The error function is called to get an error message in case init, read or end functions returned an error.
error(void *handler, char *error_buf, unsigned int error_buf_len);
mysql - mysql handle, which was previously allocated by mysql_init()
local_infile_init - initialization function, e.g. for opening the file
local_infile_read - read function
local_infile_end - terminating function, e.g. for closing the file
local_infile_error - error function
userdata - a buffer which will be passed to all callback function
#include <mysql.h>
void STDCALL mysql_set_local_infile_handler(MYSQL *conn,
int (*local_infile_init)(void **, const char *, void *),
int (*local_infile_read)(void *, char *, uint),
void (*local_infile_end)(void *),
int (*local_infile_error)(void *, char *, uint),
void *userdata);REFRESH_SLAVE
Reset master server information and restart slaves.
REFRESH_MASTER
Remove binary log files.
REFRESH_READ_LOCK
REFRESH_FAST
REFRESH_GRANT
Refresh grant tables.
REFRESH_LOG
Flush logs.
REFRESH_TABLES
Flush table cache.
REFRESH_HOSTS
Flush host cache.
REFRESH_STATUS
Reset status variables.
REFRESH_THREADS
Flush thread cache.
SESSION_TRACK_GTIDS (unsupported)closes active prepared statements
clears user variables
Performs a statement pointed to by the null terminate string query against the database. Contrary to mysql_real_query(), mysql_query() is not binary safe.
Returns zero on success, non zero on failure
Returns the number of warnings from the last executed query, or zero if there are no warnings.
SESSION_TRACK_SYSTEM_VARIABLES
SESSION_TRACK_SCHEMA
SESSION_TRACK_STATE_CHANGE
SESSION_TRACK_GTIDS (unsupported)
data - pointer to data, which must be declared as const char *
length - pointer to a size_t variable, which will contain the length of data
mysql_session_track_get_next() retrieves the session status change information received from the server after a successful call to mysql_session_track_get_first().
mysql_session_track_get_next() needs to be called repeatedly until a non-zero return value indicates the end of data.
mysql_session_track_get_next() was added in Connector/C 3.0 and MariaDB Server 10.2.
Zero for success, nonzero if an error occurred.
These plugins are used by the Connector/C to communicate with the MariaDB server.
These are plugins that are used whenever Connector/C needs to read a file.
For example, for LOAD DATA LOCAL INFILE statement, when a server requests the Connector/C to send a specific file.
This plugin uses libcurl to access remote files, it allows the client to execute statements like
LOAD DATA LOCAL INFILE 'http://mariadb.com/example.csv' INTO t1
Note that here, like with any LOAD DATA LOCAL, it'll be the client that fetches the file, not the server.
This plugin supports the following url schemes: http://, https://, ftp://, sftp://, ldap://, smb://.
These are authentication plugins. They are loaded automatically by the Connector/C when the server requests a specific authentication method.
This is a generic dialog plugin that asks the user a question (as instructed by the server) and sends the answer to the server. Everything is sent in plain text, one should enable SSL if secrets are sent via this plugin. Graphical clients can customize the plugin to provide graphical dialog form. See
Used to initiate the retrieval of a result set from the last query executed using the mysql_real_query() function on the database connection. Either this or the mysql_store_result() function must be called before the results of a query can be retrieved, and one or the other must be called to prevent the next query on that database connection from failing.
Returns an unbuffered result set or NULL if an error occurred.
Returns an array of fields. Each field contains the definition for a column of the result set. If the statement doesn't have a result set a NULL pointer will be returned.
This function was added in Connector/C 3.1.0
MYSQL_FIELD *mariadb_stmt_fetch_fields(MYSQL_STMT * stmt);attr - pointer to a variable, which will contain the attribute value.
Gets the current value of a statement attribute. Returns zero on success, non zero on failure.
The enum_stmt_attr_type parameter has the following possible values:
STMT_ATTR_UPDATE_MAX_LENGTH: Indicates if mysql_stmt_store_result() will update the max_length value of MYSQL_FIELD structures.
STMT_ATTR_CURSOR_TYPE: Cursor type. Possible values are CURSOR_TYPE_READ_ONLY or default value CURSOR_TYPE_NO_CURSOR.
STMT_ATTR_PREFETCH_ROWS: Number of rows which will be prefetched. The default value is 1.
STMT_ATTR_PREBIND_PARAMS: Number of parameters used for
Records: 100 Duplicates: 0 Warnings: 0
Records: 3 Duplicates: 0 Warnings: 0
Records: 1 Deleted: 0 Skipped: 0 Warnings: 0
Records: 3 Duplicates: 0 Warnings: 0
Rows matched: 40 Changed: 40 Warnings: 0
MYSQL_OPTION_MULTI_STATEMENTS_OFF
Disables multi statement support
MYSQL_OPTION_MULTI_STATEMENTS_ON
Enable multi statement support
MariaDB Connector/C supports several Linux distributions and Microsoft Windows.
To install MariaDB Connector/C on Linux using APT, YUM, or ZYpp, you must configure your system to use either the ES Package Repository or the CS Package Repository.
If your system is already configured to use one of these package repositories, you can skip to install MariaDB Connector/C.
Choose a package repository to configure:
MariaDB Connector/C is available from the same package repository as MariaDB Enterprise Server.
To configure the ES package repository:
Install curl.
Install via APT on Debian, Ubuntu:
Install via YUM on CentOS, RHEL, Rocky Linux:
Install via ZYpp on SLES:
Download the utility, validate its checksum, and ensure that its permissions allow it to be executed:
MariaDB Connector/C is available from the same package repository as MariaDB Community Server.
To configure the CS package repository:
Install curl.
Install via APT on Debian, Ubuntu:
Install via YUM on CentOS, RHEL, Rocky Linux:
Install via ZYpp on SLES:
Download the utility, validate its checksum, and ensure that its permissions allow it to be executed:
On supported Linux distributions, MariaDB Connector/C can be installed using APT, YUM, or ZYpp if the system is configured to use the or the .
To install MariaDB Connector/C on CentOS, RHEL, and Rocky Linux, you can use YUM if you have the or configured.
Install MariaDB Connector/C and package dependencies:
To install MariaDB Connector/C on Debian and Ubuntu, you can use APT if you have the or configured.
Install MariaDB Connector/C and package dependencies:
To install MariaDB Connector/C on SLES, you can use ZYpp if you have the or configured.
Install MariaDB Connector/C and package dependencies:
MariaDB Connector/C can be installed on supported Linux distributions via a binary tarball package:
Go to the
Ensure the "Product" dropdown reads "C connector."
In the "Version" dropdown, select the version you want to download.
In the "OS" dropdown, select your Linux distribution.
MariaDB Connector/C can be installed on Microsoft Windows via an MSI package:
Go to the
Ensure the "Product" dropdown reads "C connector."
In the "Version" dropdown, select the version you want to download.
In the "OS" dropdown, select either "MS Windows (64-bit)" or "MS Windows (32-bit)", depending on whether you need a 64-bit or 32-bit connector.
Connector/C specifies its build process with platform-independent CMake listfiles included in each directory of a source tree with the name CMakeLists.txt.
Configuration settings may be specified by passing the -D option to CMake command line interpreter.
Do not build Connector/C from the root of the source tree: Either create a subdirectory "build" inside the source tree or create a subdirectory outside of the source tree.
Example:
In case Connector/C was already configured, the CMakeCache.txt file needs to be removed first. In several cases, e.g. when cross compiling CMakeFiles subfolders need to be removed too.
If you want to use a different generator, e.g. for nmake on Windows, you need to specify the generator with the -G option. cmake --help lists the available generators for the used platform.
Client plugins can be configured as dynamic plugins (DYNAMIC) or built-in plugins (STATIC) by specifying the plugin name followed by suffix _PLUGIN_TYPE as key, and "DYNAMIC" or "STATIC" as value.
E.g. for building dialog plugin as a built-in plugin, for versions < Connector/C 3.0.4
Beginning with C/C 3.0.4
Connector/C 3.0 supports the following plugins:
stmt - a statement handle, which was previously allocated by mysql_stmt_init().
bind - an array of MYSQL_BIND structures. The size of this array must be equal to the number of parameters.
Binds variables for parameter markers in the prepared statement that was passed to . Returns zero on success, non-zero on failure.
The number of parameters can be obtained by .
If the number of parameters is unknown, for example when using , the number of parameters have to be specified with the function.
stmt - A statement handle, which was previously allocated by mysql_stmt_init().
query SQL statement
length Length of SQL statement
Prepares and executes a statement which was previously allocated by , using the current values of the parameter variables if any parameters exist in the statement.
Returns zero on success, non-zero on failure.
This function was added in Connector/C 3.0 and requires or later versions.
int mysql_query(MYSQL * mysql,
const char * query);unsigned int mysql_warning_count(MYSQL * mysql);int mysql_session_track_get_next(MYSQL * mysql,enum enum_session_state_type type, const char **data, size_t *length );MYSQL_RES * mysql_use_result(MYSQL * mysql);my_bool is_update;
rc= mysql_stmt_attr_get(stmt, STMT_ATTR_UPDATE_MAX_LENGTH, &is_update);unsigned long cursor_type;
rc= mysql_stmt_attr_get(stmt, STMT_ATTR_CURSOR_TYPE, &cursor_type);my_bool mysql_stmt_attr_get(MYSQL_STMT * stmt,
enum enum_stmt_attr_type,
void * attr);my_bool mysql_stmt_bind_param(MYSQL_STMT * stmt,
MYSQL_BIND * bnd);int mariadb_stmt_execute_direct(MYSQL_STMT * stmt, const char *query, size_t length);mariadb_es_repo_setup script can be found in the section at the bottom of the page. Subsitute ${checksum} in the example above with the latest checksum.Retrieve your Customer Download Token at Customer Download Token at the MariaDB Customer Portal and substitute your token for CUSTOMER_DOWNLOAD_TOKEN in the following step.
Configure the ES package repository using the mariadb_es_repo_setup utility:
All major releases of ES contain the same version of MariaDB Connector/C.
By default, the utility will configure your system to use the package repository for ES 10.6.
To configure your system to use the ES package repository for a specific major release, use the option.
Install MariaDB Connector/C using the package repository.
mariadb_repo_setup script can be found in the section at the bottom of the page. Subsitute ${checksum} in the example above with the latest checksum.Configure the CS package repository using the mariadb_repo_setup utility:
All major releases of CS contain the same version of MariaDB Connector/C.
By default, the utility will configure your system to use the package repository for CS 10.6.
To configure your system to use the CS package repository for a specific major release, use the option.
Install MariaDB Connector/C using the package repository.
Click on the "Download" button to download the MSI package.
When the MSI package finishes downloading, run it and follow the on-screen instructions.
Package Repository
Description
MariaDB Enterprise Server package repository
Available to customers of MariaDB Corporation
Available for APT, YUM, and ZYpp on supported Linux distributions
Configured with the utility
MariaDB Community Server package repository
Publicly available
Available for APT, YUM, and ZYpp on supported Linux distributions
Configured with the utility
DIALOG
Authentication
dynamic
Authentication for user input, e.g. for PAM authentication
OLDPASSWORD
Authentication
static
Pre. 4.1 authentication (deprecated)
NATIVE
Authentication
static
Default authentication
CLEARTEXT
Authentication
dynamic
Sends password without hashing or encryption
AUTH_GSSAPI
Authentication
dynamic
Kerberos/GSSAPI authentication plugin
SHA256_PASSWORD
Authentication
dynamic
SHA256 password authentication plugin
AURORA
Connection
OFF
Fail over plugin for Aurora (experimental)
REPLICATION
Connection
OFF
Replication/fail over plugin (experimental)
CMAKE_BUILD_TYPE
Build type: Release, RelWithDebInfo or Debug
CMAKE_INSTALL_PREFIX
Installation base directory
CMAKE_C_FLAGS
Flags for C-Compiler
Option
Default
Description
WITH_OPENSSL
ON
Possible values are ON or OFF. Not supported anymore since Connector/C 3.0
WITH_SSL
SCHANNEL (windows), otherwise OPENSSL
Specifies type of TLS/SSL library. E.g. GNUTLS, OPENSSL or SCHANNEL (Windows only). OFF disables TLS/SSL functionality
Plugin
Type
Default
Description
SOCKET
IO
static
plugin for client server communication via socket
SHMEM
IO
static
plugin for client server communication via shared memory
NPIPE
IO
static
plugin for client server communication via named pipe
value - the type of value you want to retrieve. See description below.arg - pointer to a variable for storing value of the specified option.
... - variable argument list
Retrieves generic or connection specific information. Returns zero on success, non-zero if an error occurred (invalid option), This function was added in MariaDB Connector/C 3.0,
For these information types of parameters mysql needs to be set to NULL.
MARIADB_CHARSET_NAME: Retrieves the charset information for a character set by its literal representation.Parameter type: const MARIADB_CHARSET_INFO*.
MARIADB_CLIENT_ERRORS: Retrieve array of client errors. This can be used in plugins to set global error messages (which are not exported by MariaDB Connector/C).Parameter type: const char **.
MARIADB_CLIENT_VERSION: The client version in literal representation.Parameter type: const char *.
MARIADB_CLIENT_VERSION_ID: The client version in numeric format.Parameter type: unsigned int.
MARIADB_MAX_ALLOWED_PACKET: Retrieves value of maximum allowed packet size.Parameter type: size_t
MARIADB_NET_BUFFER_LENGTH: Retrieves the length of net buffer.Parameter type: size_t
MARIADB_TLS_LIBRARY: The TLS library MariaDB Connector/C is compiled against.Parameter type: const char *.
MARIADB_CONNECTION_ASYNC_TIMEOUT: Retrieves the timeout for non-blocking calls in seconds.Parameter type: unsigned int.
MARIADB_CONNECTION_ASYNC_TIMEOUT_MS: Retrieves the timeout for non-blocking calls in milliseconds.Parameter type: unsigned int.
MARIADB_CONNECTION_MARIADB_CHARSET_INFO: Retrieves character set information for given connection. Parameter type: const MY_CHARSET_INFO *.
MARIADB_CONNECTION_CLIENT_CAPABILITIES: Returns the capability flags of the client.Parameter type: unsigned long.
MARIADB_CONNECTION_ERROR: Retrieves error message for last used command. Parameter type: const char *.
MARIADB_CONNECTION_ERROR_ID: Retrieves error number for last used command. Parameter type: unsigned int.
MARIADB_CONNECTION_EXTENDED_SERVER_CAPABILITIES: Returns the extended of the connected MariaDB server.Parameter type: unsigned long.
MARIADB_CONNECTION_HOST: Retrieves connection's host name. Parameter type: const char *.
MARIADB_CONNECTION_INFO: Retrieves generic info for last used command.Parameter type: const char *.
MARIADB_CONNECTION_PORT: Retrieves the port number of server host.Parameter type: unsigned int.
MARIADB_CONNECTION_PROTOCOL_VERSION_ID: Retrieves the protocol version number.Parameter type: unsigned int.
MARIADB_CONNECTION_PVIO_TYPE: Retrives the pvio plugin used for specified connection.Parameter type: unsigned int.
MARIADB_CONNECTION_SCHEMA: Retrieves the current schema.Parameter type: const char*.
MARIADB_CONNECTION_SERVER_CAPABILITIES: Returns the of the connected server.Parameter type: unsigned long.
MARIADB_CONNECTION_SERVER_STATUS: Returns server status after last operation. A list of possible flags can be found in the description OK packet.Parameter type: unsigned int.
MARIADB_CONNECTION_SERVER_TYPE: Retrieves the type of the server.Parameter type: const char*.
MARIADB_CONNECTION_SERVER_VERSION: Retrieves the server version in literal format.Parameter type: const char *.
MARIADB_CONNECTION_SERVER_VERSION_ID: Retrieves the server version in numeric format.Parameter type: unsigned int.
MARIADB_CONNECTION_SOCKET: Retrieves the handle (socket) for given connection.Parameter type: my_socket.
MARIADB_CONNECTION_SQLSTATE: Retrieves current sqlstate information for last used command. Parameter type: const char *.
MARIADB_CONNECTION_SSL_CIPHER: Retrieves the TLS cipher in use.Parameter type: const char *.
MARIADB_CONNECTION_TLS_VERSION: Retrieves the TLS protocol version used in literal format.Parameter type: char *.
MARIADB_CONNECTION_TLS_VERSION_ID: Retrieves the TLS protocol version used in numeric format.Parameter type: unsigned int.
MARIADB_CONNECTION_UNIX_SOCKET: Retrieves the file name of the unix socketParameter type: const char *.
MARIADB_CONNECTION_USER: Retrieves connection's user name.Parameter type: const char *.
arg - pointer to a variable for storing value of the specified option.
... - variable argument list
Retrieves the value for a given option which was previously set by mysql_optionsv.
Returns zero on success, non zero if an error occurred (invalid option).
This function was added in MariaDB Connector/C 3.0.0.
MYSQL_OPT_COMPRESS
MYSQL_OPT_NAMED_PIPE
MYSQL_OPT_RECONNECT
MYSQL_REPORT_DATA_TRUNCATION
MYSQL_OPT_NONBLOCK
MYSQL_OPT_SSL_VERIFY_SERVER_CERT
MARIADB_OPT_CONNECTION_READ_ONLY
MYSQL_SECURE_AUTH
MYSQL_OPT_CONNECT_TIMEOUT
MYSQL_OPT_READ_TIMEOUT
MYSQL_OPT_WRITE_TIMEOUT
MYSQL_OPT_LOCAL_INFILE
MYSQL_OPT_PROTOCOL
MYSQL_INIT_COMMAND
MYSQL_READ_DEFAULT_FILE
MYSQL_READ_DEFAULT_GROUP
MYSQL_SET_CHARSET_NAME
MYSQL_PLUGIN_DIR
MYSQL_OPT_SSL_KEY
MYSQL_OPT_SSL_CERT
MYSQL_OPT_SSL_CA
MYSQL_OPT_SSL_CAPATH
MYSQL_OPT_SSL_CRL
MYSQL_OPT_SSL_CRLPATH
MYSQL_OPT_SSL_CIPHER
MARIADB_OPT_SSL_FP
MARIADB_OPT_SSL_FP_LIST
MARIADB_OPT_SSL_PASSPHRASE
MYSQL_DEFAULT_AUTH
MYSQL_OPT_BIND
MARIADB_OPT_CONNECTION_HANDLER
MYSQL_PROGRESS_CALLBACK: requires a function pointer *(const MYSQL *, uint, uint, double, const char *, uint))arg)
MYSQL_CONNECT_ATTRS: this option requires 5 parameters:
MARIADB_OPT_USERDATA: retrieves userdata for a given key.
attr - the value to assign to the attribute
Used to modify the behavior of a prepared statement. This function may be called multiple times to set several attributes. Returns zero on success, non-zero on failure.
The enum_stmt_attr_type attribute can have one of the following values:
STMT_ATTR_UPDATE_MAX_LENGTH If set to 1, mysql_stmt_store_result() will update the max_length value of MYSQL_FIELD structures.
STMT_ATTR_CURSOR_TYPE: cursor type when mysql_stmt_execute() is invoked. Possible values are CURSOR_TYPE_READ_ONLY or default value CURSOR_TYPE_NO_CURSOR.
STMT_ATTR_PREFETCH_ROWS: number of rows which will be prefetched. The default value is 1.
STMT_ATTR_PREBIND_PARAMS: number of parameter markers when using mariadb_stmt_execute_direct(). If the statement handle is reused it will be reset automatically to the state after mysql_stmt_init(). This option was added in Connector/C 3.0
STMT_ATTR_ARRAY_SIZE: number of array elements. This option was added in Connector/C 3.0 and requires or later
STMT_ATTR_ROW_SIZE: specifies size of a structure for row wise binding. This length must include space for all of the bound parameters and any padding of the structure or buffer to ensure that when the address of a bound parameter is incremented with the specified length, the result will point to the beginning of the same parameter in the next set of parameters. When using the sizeof operator in ANSI C, this behavior is guaranteed.
If the value is zero column-wise binding will be used (default).
This option was added in Connector/C 3.0 and requires or later
void mysql_server_init(void );MYSQL_FIELD * mysql_fetch_fields(MYSQL_RES * res);res - a result set identifier returned by mysql_store_result() or mysql_use_result().
This function serves an identical purpose to the function with the single difference that instead of returning one field at a time for each field, the fields are returned as an array. Each field contains the definition for a column of the result set.
sudo ./mariadb_es_repo_setup --token="CUSTOMER_DOWNLOAD_TOKEN" --apply \
--mariadb-server-version="10.6"sudo ./mariadb_repo_setup \
--mariadb-server-version="mariadb-10.6"sudo apt install curlsudo yum install curlsudo zypper install curl$ curl -LsSO https://dlm.mariadb.com/enterprise-release-helpers/mariadb_es_repo_setup$ echo "${checksum} mariadb_es_repo_setup" \
| sha256sum -c -$ chmod +x mariadb_es_repo_setup$ sudo apt install curl$ sudo yum install curl$ sudo zypper install curlcurl -LsSO https://r.mariadb.com/downloads/mariadb_repo_setupecho "${checksum} mariadb_repo_setup" \
| sha256sum -c -chmod +x mariadb_repo_setupsudo yum install MariaDB-shared MariaDB-develsudo apt install libmariadb3 libmariadb-devsudo zypper install MariaDB-shared MariaDB-develcmake ../connector_c -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/localcmake .. -D{PLUGIN_NAME}_PLUGIN_TYPE=[STATIC|DYNAMIC|OFF]cmake .. -DCLIENT_PLUGIN_{PLUGIN_NAME}=[STATIC|DYNAMIC|OFF]int mariadb_get_infov(MYSQL * mysql,
enum mariadb_value value,
void * arg,
...);/* get server port for current connection */
unsigned int port;
mariadb_get_infov(mysql, MARIADB_CONNECTION_PORT, void *)&port);/* get user name for current connection */
const char *user;
mariadb_get_infov(mysql, MARIADB_CONNECTION_USER, (void *)&user);char **commands;
int elements;
rc = mysql_get_optionv(mysql, MYSQL_INIT_COMMAND, &commands, &elements);/* get number of connection attributes */
int i, elements= 0;
char **key, **value;
mysql_get_optionv(mysql, MYSQL_CONNECT_ATTRS, NULL, NULL, (void *)&elements);
key= (char **)malloc(sizeof(char *) * elements);
val= (char **)malloc(sizeof(char *) * elements);
mysql_get_optionv(mysql, MYSQL_OPT_CONNECT_ATTRS, &key, &val, &elements);
for (i=0; i < elements; i++)
printf("key: %s value: %s", key[i], val[i]);const char *ssh_user;
mysql_get_optionv(mysql, MARIADB_OPT_USERDATA, "ssh_user", (void *)ssh_user);int mysql_get_optionv(MYSQL * mysql,
enum mysql_option,
void * arg,
...);my_bool mysql_stmt_attr_set(MYSQL_STMT * stmt,
enum enum_stmt_attr_type,
const void * attr);my_bool update= 1;
rc= mysql_stmt_attr_set(stmt, STMT_ATTR_UPDATE_MAX_LENGTH, &update);unsigned long cursor_type= CURSOR_TYPE_READ_ONLY;
rc= mysql_stmt_attr_set(stmt, STMT_ATTR_CURSOR_TYPE, &cursor_type);unsigned long rows=4;
rc= mysql_stmt_attr_set(stmt, STMT_ATTR_PREFETCH_ROWS, &rows);unsigned int params= 5;
rc= mysql_stmt_attr_set(stmt, STMT_ATTR_PREBIND_PARAMS, ¶ms);unsigned int array_size= 5;
rc= mysql_stmt_attr_set(stmt, STMT_ATTR_ARRAY_SIZE, &array_size);size_t row_size= sizeof(struct st_customer);
rc= mysql_stmt_attr_set(stmt, STMT_ATTR_ROW_SIZE, &array_size);unsigned long prefetch_rows;
rc= mysql_stmt_attr_get(stmt, STMT_ATTR_PREFETCH_ROWS, &prefetch_rows);unsigned int param_count;
rc= mysql_stmt_attr_get(stmt, STMT_ATTR_PREBIND_PARAMS, ¶m_count);static int execute_direct_example(MYSQL *mysql)
{
MYSQL_STMT *stmt= mysql_stmt_init(mysql);
MYSQL_BIND bind[2];
int intval= 1;
int param_count= 2;
char *strval= "execute_direct_example";
/* Direct execution without parameters */
if (mariadb_stmt_execute_direct(stmt, "CREATE TABLE execute_direct (a int, b varchar(30))", -1))
goto error;
memset(&bind, 0, sizeof(MYSQL_BIND) * 2);
bind[0].buffer_type= MYSQL_TYPE_SHORT;
bind[0].buffer= &intval;
bind[1].buffer_type= MYSQL_TYPE_STRING;
bind[1].buffer= strval;
bind[1].buffer_length= strlen(strval);
/* set number of parameters */
if (mysql_stmt_attr_set(stmt, STMT_ATTR_PREBIND_PARAMS, ¶m_count))
goto error;
/* bind parameters */
if (mysql_stmt_bind_param(stmt, bind))
goto error;
if (mariadb_stmt_execute_direct(stmt, "INSERT INTO execute_direct VALUES (?,?)", -1))
goto error;
mysql_stmt_close(stmt);
return 0;
error:
printf("Error: %s\n", mysql_stmt_error(stmt));
mysql_stmt_close(stmt);
return 1;
}uint8_t reconnect;
rc = mysql_get_optionv(mysql, MYSQL_OPT_RECONNECT, &reconnect);uint32_t timeout;
rc = mysql_get_optionv(mysql, MYSQL_OPT_CONNECT_TIMEOUT, &timeout);char *plugin_dir;
rc = mysql_get_optionv(mysql, MYSQL_PLUGIN_DIR, &plugin_dir);int mariadb_cancel(MYSQL * mysql);mysql - mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
Immediately aborts a connection by making all subsequent read/write operations fail.mariadb_cancel() does not invalidate memory used for mysql structure, nor close any communication channels. To free the memory, must be called.mariadb_cancel() is useful to break long queries in situations where sending KILL is not possible.
mariadb_cancel() was added in Connector/C 3.0
After successful configuration, Connector/C can now be compiled.
If no CMake generator was specified, CMake creates by default build files for Visual Studio. You can now either build Connector/C inside Visual Studio
devenv mariadb_connector_c.slnor via command line
cmake --build . --config RelWithDebInfoBy default CMake creates build files for GNU make. On some system GNU make is renamed to gmake. You can now build Connector/C with
or
makecmake --build . --config ReleaseSets the default for the current connection. Returns zero on success, non-zero on failure.
The client library supports the following character sets:
armscii8
8-bit character set for Armenian
ascii
US ASCII character set
big5
2-byte character set for traditional Chinese, Hongkong, Macau and Taiwan
binary
8-bit binary character set
cp1250
Windows code page 1250-character set
cp1251
Windows code page 1251-character set
mysql - a mysql handle, which was previously allocated by mysql_init().
host - can be either a host name or an IP address. Passing the NULL value or the string "localhost" to this parameter, the local host is assumed. When possible, pipes will be used instead of the TCP/IP protocol.
user - the user name.
passwd - If provided or NULL, the server will attempt to authenticate the user against those user records which have no password only. This allows one username to be used with different permissions (depending on if a password as provided or not).
db - if provided will specify the default database to be used when performing queries.
port - specifies the port number to attempt to connect to the server.
unix_socket - specifies the socket or named pipe that should be used.
flags - the flags allows various connection options to be set:
CLIENT_FOUND_ROWS: Return the number of matched rows instead of number of changed rows.
CLIENT_NO_SCHEMA: Forbids the use of database.tablename.column syntax and forces the SQL parser to generate an error.
Establishes a connection to a database server. Returns a MYSQL * handle or NULL if an error occurred.
This page describes the public data structures used by MariaDB Connector/C.
The MYSQL structure represents one database connection and is used by most of MariaDB Connector/C's API functions. The MYSQL structure needs to be allocated and initialized by the API function. It will be released by the function.
int mysql_set_character_set(MYSQL * mysql,
const char * csname);MYSQL * mysql_real_connect(MYSQL * mysql,
const char * host,
const char * user,
const char * passwd,
const char * db,
unsigned int port,
const char * unix_socket,
unsigned long flags);CLIENT_COMPRESS: Use compression protocol
CLIENT_IGNORE_SPACE: Allows spaces after function names. All function names will become reserved words.
CLIENT_LOCAL_FILES: Allows LOAD DATA LOCAL statements
CLIENT_MULTI_STATEMENTS: Allows the client to send multiple statements in one command. Statements will be divided by a semicolon.
CLIENT_MULTI_RESULTS: Indicates that the client is able to handle multiple result sets from stored procedures or multi statements. This option will be automatically set if CLIENT_MULTI_STATEMENTS is set.
And others per .
MYSQL structure should be considered as opaque; copying or changing values of its members might produce unexpected results, errors or program crashes.The MYSQL_RES structure represents a result set which contains data and metadata information. It will be returned by the mysql_use_result(), mysql_store_result() and mysql_stmt_result_metadata() API functions and needs to be released by mysql_free_result().
MYSQL_ROW represents an array of character pointers, pointing to the columns of the actual data row.
Data will be received by the mysql_fetch_row() function. The size of the array is the number of columns for the current row.
The MYSQL_STMT structure represents a prepared statement handle and is used by MariaDB Connector/C's prepared statement API functions. The MYSQL_STMT structure needs to be allocated and initialized by the mysql_stmt_init() function and needs to be released by the mysql_stmt_close() function.
The MYSQL_FIELD structure describes the metadata of a column. It can be obtained by the mysql_fetch_field() function.
It has the following members:
char *
name
The name of the column
unsigned int
name_length
The length of column name
char *
org_name
The original name of the column
unsigned int
org_name_length
The length of original column name
char *
table
The name of the table
The MYSQL_BIND structure is used to provide parameters for prepared statements or to receive output column value from prepared statements.
unsigned long *
length
Pointer for the length of the buffer (not used for parameters). The length is ignored for numeric and fixed size data types, as the buffer_type value determines the size of the data.
my_bool *
is_nulll
Pointer which indicates if column is NULL (not used for parameters)
my_bool *
error
Pointer which indicates if an error occured
void *
buffer
Data buffer which contains or receives data
char *
u.indicator
Array of indicator variables for bulk operation parameter
The MYSQL_TIME structure is used for date and time values in prepared statements. It has the following members:
unsigned int
year
Year
unsigned int
month
Month
unsigned int
day
Day
unsigned int
hour
Hour
unsigned int
minute
Minute
cp1256
Windows code page 1256-character set
cp1257
Windows code page 1257-character set
cp850
MS-DOS Codepage 850 (Western Europe)
cp852
MS-DOS Codepage 852 (Middle Europe)
cp866
MS-DOS Codepage 866 (Russian)
cp932
Microsoft Codepage 932 (Extension to sjis)
dec8
DEC West European
eucjpms
UJIS for Windows Japanese
euckr
EUC KR-Korean
gb2312
GB-2312 simplified Chinese
gbk
GBK simplified Chinese
geostd8
GEOSTD8 Georgian
greek
ISO 8859-7 Greek
hebrew
ISO 8859-8 Hebrew
hp8
HP West European
keybcs2
DOS Kamenicky Czech-Slovak
koi8r
KOI8-R Relcom Russian
koi8u
KOI8-U Ukrainian
latin1
CP1252 Western European
latin2
ISO 8859-2 Central Europe
latin5
ISO 8859-9 Turkish
latin7
ISO 8859-13 Baltic
macce
MAC Central European
macroman
MAC Western European
sjis
SJIS for Windows Japanese
swe7
7-bit Swedish
tis620
TIS620 Thai
ucs2
UCS-2 Unicode
ujis
EUC-JP Japanese
utf8
UTF-8 Unicode
utf16
UTF-16 Unicode
utf32
UTF-32 Unicode
utf8mb4
UTF 4-byte Unicode
unsigned int
table_length
The length of table name
char *
org_table
The original name of the table
unsigned int
org_table_length
The length of original table name
char *
db
The name of the database (schema)
unsigned int
db_length
The length of database name
char *
catalog
The catalog name (always 'def')
unsigned int
catalog_length
The length of catalog name
char *
def
default value
unsigned int
def_length
The length of default value
unsigned int
length
The length (width) of the column definition
unsigned int
max_length
The maximum length of the column value
unsigned int
flags
Flags
unsigned int
decimals
Number of decimals
enum enum_field_types
type
Field type
unsigned long
buffer_length
Length of buffer
enum enum_field_types
buffer_type
unsigned long
length_value
Used if length pointer is NULL
my_bool
error_value
Used if error pointer is NULL
my_bool
is_null_value
Used if is_null pointer is NULL
my_bool
is_unsigned
Set if integer type is unsigned
my_bool
is_null_value
Used if value is NULL
unsigned int
second
Second
unsigned long
second_part
Fractional seconds (max. 6 digits)
my_bool
neg
Negative value
enum enum_mysql_timestamp_type
time_type
Type
enum enum_mysql_timestamp_type is used in the MYSQL_TIME structure and indicates the type. It has the following constants:
MYSQL_TIMESTAMP_NONE
MYSQL_TIMESTAMP_ERROR
MYSQL_TIMESTAMP_DATE
MYSQL_TIMESTAMP_DATETIME
MYSQL_TIMESTAMP_TIME
enum mysql_set_option is used as a parameter in mysql_set_server_option() and has the following constants:
MYSQL_OPTIONS_MULTI_STATEMENTS_ON
MYSQL_OPTIONS_MULTI_STATEMENTS_OFF
enum field_types describes the different field types used by MariaDB and has the following constants:
MYSQL_TYPE_DECIMAL
MYSQL_TYPE_TINY
MYSQL_TYPE_SHORT
MYSQL_TYPE_LONG
MYSQL_TYPE_FLOAT
MYSQL_TYPE_DOUBLE
MYSQL_TYPE_NULL
MYSQL_TYPE_TIMESTAMP
MYSQL_TYPE_LONGLONG
MYSQL_TYPE_INT24
MYSQL_TYPE_DATE
MYSQL_TYPE_TIME
MYSQL_TYPE_DATETIME
MYSQL_TYPE_YEAR
MYSQL_TYPE_NEWDATE
MYSQL_TYPE_VARCHAR
MYSQL_TYPE_BIT
MYSQL_TYPE_TIMESTAMP2
MYSQL_TYPE_DATETIME2
MYSQL_TYPE_TIME2
MYSQL_TYPE_JSON
MYSQL_TYPE_NEWDECIMAL
MYSQL_TYPE_ENUM
MYSQL_TYPE_SET
MYSQL_TYPE_TINY_BLOB
MYSQL_TYPE_MEDIUM_BLOB
MYSQL_TYPE_LONG_BLOB
MYSQL_TYPE_BLOB
MYSQL_TYPE_VAR_STRING
MYSQL_TYPE_STRING
MYSQL_TYPE_GEOMETRY
enum mysql_enum_shutdown_level is used as a parameter in mysql_server_shutdown() and has the following constants:
SHUTDOWN_DEFAULT
KILL_QUERY
KILL_CONNECTION
enum_stmt_attr_type is used to set different statement options. For a detailed description please check mysql_stmt_attr_set() function.
enum_cursor_type specifies the cursor type and is used in mysql_stmt_attr_set() function. Currently the following constants are supported:
CURSOR_TYPE_READ_ONLY
CURSOR_TYPE_NO_CURSOR
enum_indicator_type describes the type of indicator used for prepared statements bulk operations.
STMT_INDICATOR_NTS
String is zero terminated
STMT_INDICATOR_NONE
No indicator in use
STMT_INDICATOR_NULL
Value is NULL
STMT_INDICATOR_DEFAULT
Use default value
STMT_INDICATOR_IGNORE
Ignore the specified value
STMT_INDICATOR_IGNORE_ROW
Skip the current row
The following field flags are used in MYSQL_FIELD structure.
Flag
Value
Description
NOT_NULL_FLAG
1
Field can't be NULL
PRI_KEY_FLAG
2
Field is part of primary key
UNIQUE_KEY_FLAG
4
Field is part of unique key
MULTIPLE_KEY_FLAG
8
Field is part of a key
The server_status can be obtained by the mariadb_get_infov() function using the MARIADB_CONNECTION_SERVER_STATUS option.
SERVER_STATUS_IN_TRANS
1
A transaction is currently active
SERVER_STATUS_AUTOCOMMIT
2
Autocommit mode is set
SERVER_MORE_RESULTS_EXISTS
8
more results exists (more packet follow)
SERVER_QUERY_NO_GOOD_INDEX_USED
16
SERVER_QUERY_NO_INDEX_USED
32
IS_PRI_KEY(flag)
True if the field is part of a primary key
IS_NOT_NULL(flags)
True if the field is defined as not NULL
IS_BLOB(flags)
True if the field is a text or blob field
IS_NUM(column_type)
True if the column type is numeric
IS_LONGDATA(column_type)
True if the column is a blob or text field
mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
The mysql_insert_id() function returns the ID generated by a query on a table with a column having the attribute or the value for the last usage of . If the last query wasn't an or statement or if the modified table does not have a column with the attribute and was not used, this function will return zero.
my_ulonglong mysql_insert_id(MYSQL * mysql);BLOB_FLAG
16
Field is a blob
UNSIGNED_FLAG
32
Field is unsigned integer
ZEROFILL_FLAG
64
Field is zero filled
BINARY_FLAG
128
Field is binary
ENUM_FLAG
256
Field is enum
AUTO_INCREMENT_FLAG
512
Field is an autoincrement field
TIMESTAMP_FLAG
1024
Field is a timestamp
SET_FLAG
2048
Field is a set
NO_DEFAULT_VALUE_FLAG
4096
Field has no default value
ON_UPDATE_NOW_FLAG
8192
If a field is updated it will get the current time value (NOW())
NUM_FLAG
32768
Field is numeric
SERVER_STATUS_CURSOR_EXISTS
64
when using COM_STMT_FETCH, indicate that current cursor still has result
SERVER_STATUS_LAST_ROW_SENT
128
when using COM_STMT_FETCH, indicate that current cursor has finished to send results
SERVER_STATUS_DB_DROPPED
1<<8
database has been dropped
SERVER_STATUS_NO_BACKSLASH_ESCAPES
1<<9
current escape mode is "no backslash escape"
SERVER_STATUS_METADATA_CHANGED
1<<10
A DDL change did have an impact on an existing PREPARE (an automatic reprepare has been executed)
SERVER_QUERY_WAS_SLOW
1<<11
Last statement took more than the time value specified in server variable long_query_time.
SERVER_PS_OUT_PARAMS
1<<12
this resultset contain stored procedure output parameter
SERVER_STATUS_IN_TRANS_READONLY
1<<13
current transaction is a read-only transaction
SERVER_SESSION_STATE_CHANGED
1<<14
session state change. see Session change type for more information
Enables debug output for development and debug purposes by using Fred Fish's DBUG library. For using this function the mariadb-client library must be compiled with debug support.
Almost all MariaDB binaries use the DBUG library and one can get a trace of the program execution by using the command line option with the binary. This will only work if the binary is compiled for debugging (compiler option -DDBUG_ON).
Returns void.
The debug control string is a sequence of colon separated fields as follows:
Each field consists of a mandatory flag character followed by an optional "," and comma separated list of modifiers:
The currently recognized flag characters are:
d
Enable output from DBUG_ macros for the current state. May be followed by a list of keywords which selects output only for the DBUG macros with that keyword. A null list of keywords implies output for all macros.
D
Delay after each debugger output line. The argument is the number of tenths of seconds to delay, subject to machine capabilities. I.E. -#D,20 is delay two seconds.
f
Limit debugging and/or tracing, and profiling to the list of named functions. Note that a null list will disable all functions. The appropriate "d" or "t" flags must still be given, this flag only limits their actions if they are enabled.
F
Identify the source file name for each line of debug or trace output.
i
Identify the process with the pid for each line of debug or trace output.
g
Enable profiling. Create a file called 'dbugmon.out' containing information that can be used to profile the program. May be followed by a list of keywords that select profiling only for the functions in that list. A null list implies that all functions are considered.
mysql_debug_end()
void mysql_debug(const char * debug);field_1:field_2:field_nflag[,modifier,modifier,...,modifier]mysql_option - the option to set. See description below.arg - the value for the option.
... - variable argument list.
Used to set extra connect options and affect behavior for a connection. This function may be called multiple times to set several options. All calls pass numeric literal values for a const void *. mysql_optionsv() should be called after mysql_init().
Some of these options can also be set in option files, such as my.cnf.
Returns zero on success, non-zero if an error occurred (invalid option or value).
MYSQL_INIT_COMMAND: lets you specify a command to execute immediately after connecting (and also after a reconnect if enabled).
Each call adds one SQL statement to an internal list; all stored commands are executed in order.
You cannot concatenate multiple statements with semicolons; each statement must be added with a separate call.
MYSQL_OPT_CONNECT_TIMEOUT: Connect timeout in seconds. This value will be passed as an unsigned int parameter.
MARIADB_OPT_VERIFY_LOCAL_INFILE_CALLBACK: Specifies a callback function for filename and/or directory verification.
This option was added in Connector/C 2.3.0
MYSQL_PROGRESS_CALLBACK: Specifies a callback function which will be able to visualize the progress of certain long running statements (i.e. or ).
MYSQL_OPT_RECONNECT: Enable or disable automatic reconnect.
MYSQL_OPT_READ_TIMEOUT: Specifies the timeout in seconds for reading packets from the server.
MYSQL_OPT_WRITE_TIMEOUT:
Specifies the timeout in seconds for sending packets to the server.
MYSQL_REPORT_DATA_TRUNCATION: Enable or disable reporting data truncation errors for prepared statements.
MYSQL_SET_CHARSET_DIR: files.
MYSQL_SET_CHARSET_NAME: Specify the default for the connection.
MYSQL_OPT_BIND: Specify the network interface from which to connect to MariaDB Server.
MYSQL_OPT_NONBLOCK: Specify stack size for non-blocking operations.
The argument for MYSQL_OPT_NONBLOCK is the size of the stack used to save the state of a non-blocking operation while it is waiting for I/O and the application is doing other processing. Normally, applications will not have to change this, and it can be passed as zero to use the default value.
MYSQL_OPT_CAN_HANDLE_EXPIRED_PASSWORDS: If this option is set, the client indicates that it will be able to handle expired passwords by setting the CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS capability flag.
If the password has expired and CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS is set, the server will not return an error when connecting, but put the connection in sandbox mode, where all commands will return error 1820 (ER_MUST_CHANGE_PASSWORD) unless a new password was set. This option was added in MariaDB Connector/C 3.0.4
MYSQL_OPT_MAX_ALLOWED_PACKET: The maximum packet length to send to or receive from server. The default is 16MB, the maximum 1GB.
MYSQL_OPT_NET_BUFFER_LENGTH: The buffer size for TCP/IP and socket communication. Default is 16KB.
Some of these options can also be set as arguments to the mysql_real_connect function.
MARIADB_OPT_HOST: Hostname or IP address of the server to connect to.
MARIADB_OPT_USER: User to login to the server.
MARIADB_OPT_PASSWORD: Password of the user to login to the server.
MARIADB_OPT_SCHEMA: Database to use.
MARIADB_OPT_PORT: Port number to use for connection.
MARIADB_OPT_UNIXSOCKET: For connections to localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use.
MYSQL_OPT_NAMED_PIPE: For Windows operating systems only: Use named pipes for client/server communication.
MYSQL_OPT_PROTOCOL: Specify the type of client/server protocol. Possible values are:
MYSQL_PROTOCOL_TCP
MYSQL_PROTOCOL_SOCKET
MYSQL_PROTOCOL_PIPE
MARIADB_OPT_FOUND_ROWS: Return the number of matched rows instead of number of changed rows.
MYSQL_OPT_COMPRESS: Use the compressed protocol for client server communication. If the server doesn't support compressed protocol, the default protocol will be used.
MYSQL_OPT_LOCAL_INFILE: Enable or disable the use of
MARIADB_OPT_MULTI_STATEMENTS: Allows the client to send multiple statements in one command. Statements will be divided by a semicolon.
MARIADB_OPT_MULTI_RESULTS: Indicates that the client is able to handle multiple result sets from stored procedures or multi statements. This option will be automatically set if MARIADB_OPT_MULTI_STATEMENTS is set.
MYSQL_SHARED_MEMORY_BASE_NAME: Shared-memory name to use for Windows connections using shared memory to a local server (started with the --shared-memory option). Case-sensitive.
MYSQL_OPT_SSL_KEY: Defines a path to a private key file to use for . This option requires that you use the absolute path, not a relative path. If the key is protected with a passphrase, the passphrase needs to be specified with MARIADB_OPT_TLS_PASSPHRASE option.
MYSQL_OPT_SSL_CERT: Defines a path to the X509 certificate file to use for . This option requires that you use the absolute path, not a relative path.
MYSQL_OPT_SSL_CA: Defines a path to a PEM file that should contain one or more X509 certificates for trusted Certificate Authorities (CAs) to use for . This option requires that you use the absolute path, not a relative path. See for more information.
MYSQL_OPT_SSL_CAPATH: Defines a path to a directory that contains one or more PEM files that should each contain one X509 certificate for a trusted Certificate Authority (CA) to use for . This option requires that you use the absolute path, not a relative path. The directory specified by this option needs to be run through the command. See for more information. This option is only supported if the connector was built with OpenSSL. If the connector was built with GnuTLS or Schannel, then this option is not supported. See for more information about which libraries are used on which platforms.
MYSQL_OPT_SSL_CIPHER: Defines a list of permitted ciphers or cipher suites to use for .
MYSQL_OPT_SSL_CRL: Defines a path to a PEM file that should contain one or more revoked X509 certificates to use for . This option requires that you use the absolute path, not a relative path. See for more information. This option is only supported if the connector was built with OpenSSL or Schannel. If the connector was built with GnuTLS, then this option is not supported. See for more information about which libraries are used on which platforms.
MYSQL_OPT_SSL_CRLPATH: Defines a path to a directory that contains one or more PEM files that should each contain one revoked X509 certificate to use for . This option requires that you use the absolute path, not a relative path. The directory specified by this option needs to be run through the command. See for more information. This option is only supported if the connector was built with OpenSSL. If the connector was built with GnuTLS or Schannel, then this option is not supported. See for more information about which libraries are used on which platforms.
MARIADB_OPT_SSL_FP: Specify the SHA1 fingerprint of a server certificate for validation during the handshake. This is deprecated. Use MARIADB_OPT_TLS_PEER_FP instead.
MARIADB_OPT_TLS_PEER_FP: Specify the SHA1 fingerprint of a server certificate for validation during the handshake.
MARIADB_OPT_SSL_FP_LIST: Specify a file which contains one or more SHA1 fingerprints of server certificates for validation during the handshake. This is deprecated. Use MARIADB_OPT_TLS_PEER_FP_LIST instead.
MARIADB_OPT_TLS_PEER_FP_LIST: Specify a file which contains one or more SHA1 fingerprints of server certificates for validation during the handshake.
MARIADB_OPT_TLS_PASSPHRASE: Specify a passphrase for a passphrase-protected private key, as configured by the MYSQL_OPT_SSL_KEY option. This option is only supported if the connector was built with OpenSSL or GnuTLS. If the connector was built with Schannel, then this option is not supported. See for more information about which libraries are used on which platforms.
MARIADB_OPT_TLS_VERSION: Defines which protocol versions are allowed. This should be a comma-separated list of TLS protocol versions to allow. Valid TLS protocol versions are TLSv1.0, TLSv1.1, TLSv1.2, and TLSv1.3. Both the client and server should support the allowed TLS protocol versions. See for information on which TLS libraries support which TLS protocol versions. See for more information about which TLS libraries are used on which platforms.
MYSQL_OPT_SSL_VERIFY_SERVER_CERT: Enables (or disables) .
MYSQL_OPT_SSL_ENFORCE: Whether to force . This enables TLS with the default system settings. It does not prevent the connection from being created if the server does not support TLS.
MARIADB_OPT_TLS_CIPHER_STRENGTH: Cipher strength. This value will be passed as an unsigned int parameter.
MYSQL_DEFAULT_AUTH: Default authentication client-side plugin to use.
MYSQL_ENABLE_CLEARTEXT_PLUGIN: This option is supported to be compatible with MySQL client libraries. MySQL client libraries use this option to determine whether the authentication plugin can be used. However, MariaDB clients and client libraries do not need to set any options in order to use this authentication plugin. Therefore, this option does not actually do anything in MariaDB Connector/C.
MARIADB_OPT_CONNECTION_HANDLER: Specify the name of a connection handler plugin.
MARIADB_OPT_USERDATA: Bundle user data to the current connection, e.g. for use in connection handler plugins. This option requires 4 parameters: connection, option, key and value.
MARIADB_OPT_CONNECTION_READ_ONLY: This option is used by connection handler plugins and indicates that the current connection will be used for read operations only.
MYSQL_PLUGIN_DIR: Specify the location of client plugins. The plugin directory can also be specified with the MARIADB_PLUGIN_DIR environment variable.
MYSQL_SECURE_AUTH: Refuse to connect to the server if the server uses the authentication plugin. This mode is off by default, which is a difference in behavior compared to MySQL 5.6 and later, where it is on by default.
MYSQL_SERVER_PUBLIC_KEY: Specifies the name of the file which contains the RSA public key of the database server. The format of this file must be in PEM format. This option is used by the client authentication plugin. It was introduced in Connector/C 3.1.0.
MYSQL_READ_DEFAULT_FILE: Read options from an option file.
MYSQL_READ_DEFAULT_GROUP: Read options from the named option group from an option file.
These options work together, according to the following rules:
if both are set to NULL, then no option files are read.
if MYSQL_READ_DEFAULT_FILE is set to an empty string (or NULL and MYSQL_READ_DEFAULT_GROUP is set) then all default option files are read.
if MYSQL_READ_DEFAULT_FILE is set to a non-empty string, then it is interpreted as a path to a , and only that option file is read.
if MYSQL_READ_DEFAULT_GROUP is an empty string (or NULL and MYSQL_READ_DEFAULT_FILE is set) then only default groups — [client], [client-server], [client-mariadb] are read.
if MYSQL_READ_DEFAULT_GROUP is a non-empty string, then it is interpreted as a custom option group, and that custom option group is read in addition to default groups from above.
Connection attributes are stored in the and Performance Schema tables. By default, MariaDB Connector/C sends the following connection attributes to the server:
_client_name: always "libmariadb"
_client_version: version of MariaDB Connector/C
_os: operation system
_pid: process id
_platform: e.g. x86 or x64
_server_host: the hostname (as specified in mysql_real_connect). This attribute was added in Connector/C 3.0.5
MYSQL_OPT_CONNECT_ATTR_DELETE: Deletes a connection attribute for the given key.
MYSQL_OPT_CONNECT_ATTR_ADD: Adds a key/value pair to connection attributes.
MYSQL_OPT_CONNECT_ATTR_RESET: Clears the current list of connection attributes.
L
Identify the source file line number for each line of debug or trace output.
n
Print the current function nesting depth for each line of debug or trace output.
N
Number each line of dbug output.
o
Redirect the debugger output stream to the specified file. The default output is stderr.
O
As o but the file is really flushed between each write. When needed the file is closed and reopened between each write.
a
Like o, but opens for append.
A
Like O, but opens for append.
p
Limit debugger actions to specified processes. A process must be identified with the DBUG_PROCESS macro and match one in the list for debugger actions to occur.
P
Print the current process name for each line of debug or trace output.
r
When pushing a new state, do not inherit the previous state's function nesting level. Useful when the output is to start at the left margin.
S
Do function _sanity(file,line) at each debugged function until _sanity() returns something that differs from 0. (Mostly used with safemalloc)
t
Enable function call/exit trace lines. May be followed by a list (containing only one modifier) giving a numeric maximum trace level, beyond which no output will occur for either debugging or tracing macros. The default is a compile time option.
mysql_optionsv(mysql, MYSQL_INIT_COMMAND, (void *)"CREATE TABLE test.t1(a int)");
mysql_optionsv(mysql, MYSQL_INIT_COMMAND, (void *)"SET @value := 1");mysql_optionsv(mysql, MARIADB_OPT_HOST, (void *)"dbserver.example.com");mysql_optionsv(mysql, MARIADB_OPT_USER, (void *)"myuser");mysql_optionsv(mysql, MARIADB_OPT_PASSWORD, (void *)"horsebattery");mysql_optionsv(mysql, MYSQL_OPT_SSL_KEY, (void *)"certs/client-key.pem");mysql_optionsv(mysql, MYSQL_OPT_SSL_CERT, (void *)"certs/client-cert.pem");mysql_optionsv(mysql, MYSQL_DEFAULT_AUTH, (void *)"ed25519");mysql_optionsv(mysql, MYSQL_ENABLE_CLEARTEXT_PLUGIN, 1);mysql_optionsv(mysql, MARIADB_OPT_CONNECTION_HANDLER, (void *)"aurora");mysql_optionsv(mysql, MYSQL_OPT_CONNECT_ATTR_DELETE, (void *)"app_version");mysql_optionsv(mysql, MYSQL_OPT_CONNECT_ATTR_ADD, (void *)"app_version", (void *)"2.0.1");mysql_optionsv(mysql, MYSQL_OPT_CONNECT_ATTR_RESET, 0);int mysql_optionsv(MYSQL * mysql,
enum mysql_option,
const void * arg,
...);MYSQL_PROTOCOL_MEMORY.
enum mysql_protocol_type prot_type= MYSQL_PROTOCOL_SOCKET;
mysql_optionsv(mysql, MYSQL_OPT_PROTOCOL, (void *)&prot_type);unsigned int timeout= 5;
mysql_optionsv(mysql, MYSQL_OPT_CONNECT_TIMEOUT, (void *)&timeout);int my_verify_filename(void *data, const char *filename)
{
return strcmp((char *)data, filename);
}
...
char *filename= "mydata.csv";
mysql_optionsv(mysql, MARIADB_OPT_VERIFY_LOCAL_INFILE_CALLBACK, my_verify_filename, (void *)filename);static void report_progress(const MYSQL *mysql __attribute__((unused)),
uint stage, uint max_stage,
double progress __attribute__((unused)),
const char *proc_info __attribute__((unused)),
uint proc_info_length __attribute__((unused)))
{
...
}
mysql_optionsv(mysql, MYSQL_PROGRESS_CALLBACK, (void *)report_progress);my_bool reconnect= 1; /* enable reconnect */
mysql_optionsv(mysql, MYSQL_OPT_RECONNECT, (void *)&reconnect);unsigned int timeout= 5;
mysql_optionsv(mysql, MYSQL_OPT_READ_TIMEOUT, (void *)&timeout);unsigned int timeout= 5;
mysql_optionsv(mysql, MYSQL_OPT_WRITE_TIMEOUT, (void *)&timeout);mysql_optionsv(mysql, MYSQL_REPORT_DATA_TRUNCATION, NULL); /* disable */
mysql_optionsv(mysql, MYSQL_REPORT_DATA_TRUNCATION, (void *)"1"); /* enable */mysql_optionsv(mysql, MYSQL_SET_CHARSET_DIR, (void *)"/usr/local/mysql/share/mysql/charsets");mysql_optionsv(mysql, MYSQL_SET_CHARSET_NAME, (void *)"utf8");mysql_optionsv(mysql, MYSQL_OPT_BIND, (void *)"192.168.8.3");mysql_optionsv(mysql, MYSQL_OPT_NONBLOCK, 0);mysql_optionsv(mysql, MYSQL_OPT_CAN_HANDLE_EXPIRED_PASSWORDS, 1);mysql_optionsv(mysql, MYSQL_OPT_MAX_ALLOWED_PACKET, 0x40000000);mysql_optionsv(mysql, MYSQL_OPT_NET_BUFFER_LENGTH, 0x40000000);mysql_optionsv(mysql, MARIADB_OPT_SCHEMA, (void *)"mydb");mysql_optionsv(mysql, MARIADB_OPT_PORT, 3307);mysql_optionsv(mysql, MARIADB_OPT_UNIXSOCKET, (void *)"/var/lib/mysql/mysql.sock");mysql_optionsv(mysql, MYSQL_OPT_NAMED_PIPE, NULL);mysql_optionsv(mysql, MARIADB_OPT_FOUND_ROWS, 1);mysql_optionsv(mysql, MYSQL_OPT_COMPRESS, NULL);unsigned int enable= 1, disable= 0;
mysql_optionsv(mysql, MYSQL_OPT_LOCAL_INFILE, (void *)&disable);/* disable */
mysql_optionsv(mysql, MYSQL_OPT_LOCAL_INFILE, (void *)NULL); /* enable */
mysql_optionsv(mysql, MYSQL_OPT_LOCAL_INFILE, (void *)&enable); /* enable */mysql_optionsv(mysql, MARIADB_OPT_MULTI_STATEMENTS, (void *)"");mysql_optionsv(mysql, MARIADB_OPT_MULTI_RESULTS, 1);mysql_optionsv(mysql, MYSQL_SHARED_MEMORY_BASE_NAME, (void *)"mariadb");mysql_optionsv(mysql, MYSQL_OPT_SSL_CA, (void *)"certs/ca-cert.pem");mysql_optionsv(mysql, MYSQL_OPT_SSL_CAPATH, (void *)"certs/ca-cert.pem");mysql_optionsv(mysql, MYSQL_OPT_SSL_CIPHER, (void *)"DHE-RSA-AES256-SHA");mysql_optionsv(mysql, MYSQL_OPT_SSL_CAPATH, (void *)"certs/ca-cert.pem");\\\\<<code>>mysql_optionsv(mysql, MYSQL_OPT_SSL_CRL, (void *)"certs/crl.pem");mysql_optionsv(mysql, MYSQL_OPT_SSL_CAPATH, (void *)"certs/ca-cert.pem");\\\\<<code>>mysql_optionsv(mysql, MYSQL_OPT_SSL_CRLPATH, (void *)"certs/crls");mysql_optionsv(mysql, MARIADB_OPT_SSL_FP, (void *)"3a079e1a14ad326953a5d280f996b93d772a5bea");mysql_optionsv(mysql, MARIADB_OPT_TLS_PEER_FP, (void *)"3a079e1a14ad326953a5d280f996b93d772a5bea");mysql_optionsv(mysql, MARIADB_OPT_SSL_FP_LIST, (void *)"certs/fingerprints.txt");mysql_optionsv(mysql, MARIADB_OPT_TLS_PEER_FP_LIST, (void *)"certs/fingerprints.txt");mysql_optionsv(mysql, MARIADB_OPT_SSL_PASSPHRASE, (void *)"thisisashortpassphrase");mysql_optionsv(mysql, MARIADB_OPT_TLS_VERSION, (void *)"TLSv1.2,TLSv1.3");my_bool verify= 1;
mysql_optionsv(mysql, MYSQL_OPT_SSL_VERIFY_SERVER_CERT, (void *)&verify);my_bool enforce_tls= 1;
mysql_optionsv(mysql, MYSQL_OPT_SSL_ENFORCE, (void *)&enforce_tls);unsigned int cipher_strength= 128;
mysql_optionsv(mysql, MARIADB_OPT_TLS_CIPHER_STRENGTH, (void*)&cipher_strength);mysql_optionsv(mysql, MARIADB_OPT_USERDATA, (void *)"ssh_user", (void *)ssh_user);my_bool read_only= 1;
mysql_optionsv(mysql, MARIADB_OPT_CONNECTION_READ_ONLY, (void *)&read_only);mysql_optionsv(mysql, MYSQL_PLUGIN_DIR, (void *)"/opt/mariadb/lib/plugins");mysql_optionsv(mysql, MYSQL_SECURE_AUTH, 1);mysql_optionsv(mysql, MYSQL_SERVER_PUBLIC_KEY, (void *)(void *)"certs/server-cert.pem);Just like MariaDB Server and libmysqlclient, MariaDB Connector/C can also read configuration options from client in .
MariaDB Connector/C reads option files from many different directories by default. See the sections below to find out which directories are checked for which system.
MariaDB Connector/C allows application developers to read options from the default option files by calling the mysql_optionsv function and providing the MYSQL_READ_DEFAULT_FILE option name and a NULL pointer as arguments. For example:
On Linux, Unix, or Mac OS X, the default option file is called my.cnf. MariaDB Connector/C looks for the MariaDB option file in the locations and orders listed below.
The locations are dependent on whether the DEFAULT_SYSCONFDIR option was defined when MariaDB Connector/C was built. This option is usually defined as /etc when building , but it is usually not defined when building or .
When the DEFAULT_SYSCONFDIR option was not defined, MariaDB Connector/C looks for the MariaDB option file in the following locations in the following order:
When the DEFAULT_SYSCONFDIR option was defined, MariaDB Connector/C looks for the MariaDB option file in the following locations in the following order:
On Windows, the default option file can be called either my.ini or my.cnf. MariaDB Connector/C looks for the MariaDB option file in the following locations in the following order:
The System Windows Directory is the directory returned by the function. The value is usually C:\Windows. To find its specific value on your system, open and execute:
The Windows Directory is the directory returned by the function. The value may be a private Windows Directory for the application, or it may be the same as the System Windows Directory returned by the function.
EXEDIR is the parent directory of the executable program that MariaDB Connector/C is linked with.
MYSQL_HOME
MariaDB Connector/C will look in all of the above locations, in order, even if has already found an option file, and it's possible for more than one option file to exist. For example, you could have an option file in /etc/my.cnf with global settings for all servers, and then you could another option file in ~/.my.cnf (i.e.your user account's home directory) which will specify additional settings (or override previously specified setting) that are specific only to that user.
MariaDB Connector/C allows application developers to read option files from a custom option file by calling the function and providing the option name and an option file path as arguments. For example:
Many MariaDB clients can be configured to read options from custom options files with the following command-line arguments. They must be given as the first argument on the command-line. Application developers who use MariaDB Connector/C in their application and rely on option files may also want to consider implementing these command-line arguments:
The command-line option is roughly equivalent to setting the option with a non-NULL argument.
The command-line option does not yet have an equivalent option in MariaDB Connector/C. See for more information.
The syntax of the MariaDB option files are:
Lines starting with
Empty lines are ignored.
Option groups use the syntax [group-name]. See the section below for more information on available option groups.
The same option group can appear multiple times.
The !include
MariaDB Connector/C reads client options from the following in :
MariaDB Connector/C allows application developers to read options from these option groups by calling the function and providing the option name and a NULL pointer as arguments.
For example:
MariaDB Connector/C allows application developers to read options from a custom option group by calling the function and providing the option name and the name of the custom option group as arguments.
For example:
The custom option group will be read in addition to the default option groups listed above.
Many MariaDB clients can be configured to read options from option groups with a custom suffix by providing the following command-line argument. It must be given as the first argument on the command-line. Application developers who use MariaDB Connector/C in their application and rely on option files may also want to consider implementing this command-line argument: