1 of 100

Connectors

MariaDB Connectors

Complete MariaDB Connectors guide. Complete reference for client libraries in Python, Java, Node.js, C, C++, ODBC, and R languages for production use.

Quickstart Guides

Dive into MariaDB Connectors with quickstart guides. Learn how to swiftly set up and use official client libraries (C, Java, Python, Node.js, ODBC) for seamless application connectivity.

MariaDB Connector/C++ Guide

Quickstart Guide for Connector/C++

MariaDB Connector/C++ allows your C++ applications to connect to MariaDB databases, including support for TLS encryption. It provides an object-oriented design and leverages smart pointers for efficient memory management.

While you can use MariaDB Connector/C for C++ applications, Connector/C++ offers specific advantages for C++ development:

Erlang Guide

Quickstart Guide for MySQL/OTP (Erlang/OTP Client)

MySQL/OTP is the native Erlang/OTP client for connecting Erlang applications to MariaDB and MySQL databases, offering a direct implementation of the MySQL protocol.

1. Installation

Add MySQL/OTP as a dependency in your rebar.config file (for rebar3 projects):

Erlang

{deps, [
    {mysql, ".*", {git, "https://github.com/mysql-otp/mysql-otp.git", {tag, "2.0.0"}}} % Use the latest stable tag
]}.

Then, run rebar3 compile.

2. Basic Usage

Here are essential steps for connecting and interacting with your database:

a. Connect:

Erlang

{ok, Pid} = mysql:start_link([{host, "localhost"}, {user, "myuser"}, {password, "mypass"}, {database, "mydb"}]).

Replace placeholder values with your actual database credentials.

b. Execute Query:

Erlang

c. Close Connection:

Erlang

Connector/C

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.

MariaDB Connector/C is the C client library for connecting C/C++ applications to MariaDB and MySQL databases. It is LGPLv2.1 licensed.

MariaDB Connector/C Overview

Complete Connector/C reference: Windows MSI install, Linux packages (yum/apt/zypper), MariaDB-shared/devel libraries, and option file configuration.

Install MariaDB Connector/C

Install MariaDB Connector/C on Linux, Windows, and macOS, with configuration and verification steps for production use.

MariaDB Connector/C reads connection settings from option files such as my.cnf, supporting default and custom file locations, option groups, and a full set of client options.

MariaDB Connector/C binlog and replication API reference, documenting the functions used to consume binary log events from a MariaDB server as a replication client.

Reference for the public data structures in MariaDB Connector/C, including MYSQL, MYSQL_RES, MYSQL_STMT, MYSQL_FIELD, MYSQL_BIND, and MYSQL_TIME with all member definitions.

MariaDB Connector/C supports loadable and built-in plugins across four categories: connection, pvio, I/O, and authentication, including remote_io and multiple auth methods.

Reference for MariaDB Connector/C types and definitions, including enumeration constants for field types, statement options, cursor types, indicator types, field flags, and server status.

Build MariaDB Connector/C from source: download the package from MariaDB downloads or get the latest development version from the Connector/C GitHub repository.

Detailed documentation on the MariaDB Connector/C API functions for connecting, querying, and managing data in C applications.

MariaDB Binlog/Replication API reference

MariaDB Connector/C binlog and replication API reference, documenting the functions used to consume binary log events from a MariaDB server as a replication client.

The Binlog/Replication API enables client applications to connect to a MariaDB server and stream its binary log as replication events. When binary logging is enabled, the log records all data manipulation and definition changes.

This API is particularly useful for building change‑data capture (CDC) pipelines, custom replication consumers, and auditing tools.

Binlog/API Data Structures

All structures and type definitions for the Binlog/Replication API, defined in include/mariadb_rpl.h.

Replication API Types and Definitions

All enumerations and preprocessor definitions for the Binlog/Replication API, defined in include/mariadb_rpl.h.

All functions in the Binlog/Replication API, defined in include/mariadb_rpl.h.

mariadb_rpl_init()

Allocates and initializes a replication handle associated with an existing database connection.

Parameter

Description

A pointer to a newly allocated MARIADB_RPL handle on success, or NULL

mariadb_rpl_open()

Opens a binary log stream. Registers the client as a replica with the connected server and begins streaming binary log events.

Parameter

Description

Returns zero on success, non-zero on failure. Call mariadb_rpl_error() to retrieve the error message.

mariadb_rpl_fetch()

Fetches the next event from an open binary log stream.

Parameter

Description

mariadb_free_rpl_event()

Frees the memory allocated for a MARIADB_RPL_EVENT structure returned by .

Parameter

Description

None

mariadb_rpl_extract_rows()

Extracts row data from a replication event and returns a linked list of individual row change records for further processing.

Parameter

Description

mariadb_rpl_errno()

Returns the error number for the most recent Binlog API function call that can succeed or fail.

Syntax

#include <mariadb_rpl.h>

uint32_t mariadb_rpl_errno(MARIADB_RPL *rpl);

Parameters

Parameter

Description

rpl

A replication handle, previously allocated by .

Return Value

Returns the error number on failure, or 0 if no error has occurred.

Notes

Client error codes are defined in errmsg.h. Server error codes are defined in mysqld_error.h in the MariaDB server source distribution.

Use mariadb_rpl_errno() to distinguish between a true error and a normal end-of-stream condition when mariadb_rpl_fetch() returns NULL.

Added in MariaDB Connector/C 3.3.5.

mariadb_rpl_error()

Returns the error message for the most recent Binlog API function call that can succeed or fail.

Parameter

Description

Returns a null-terminated string containing the error message on failure, or an empty string ("") if no error has occurred.

mariadb_rpl_close()

Closes a binary log stream and releases all resources associated with the replication handle.

Parameter

Description

This function closes the replication stream and frees the MARIADB_RPL handle, but does not close the underlying database connection. To close the connection, call

Example

The following example illustrates the complete workflow of the Binlog API. It configures the connection by setting the required session variables, initializes and prepares the replication handle, retrieves all available events, processes each event type appropriately, and performs proper cleanup at the end.


#include <mysql.h>
#include <mariadb_rpl.h>

static int read_events(MYSQL *mysql)
{
  MARIADB_RPL_EVENT *event= NULL;
  MARIADB_RPL *rpl= mariadb_rpl_init(mysql);

  mysql_query(mysql, "SET @mariadb_slave_capability=4");
  mysql_query(mysql, "SET @slave_gtid_strict_mode=1");
  mysql_query(mysql, "SET @slave_gtid_ignore_duplicates=1");
  mysql_query(mysql, "SET NAMES utf8");
  mysql_query(mysql, "SET @master_binlog_checksum= @@global.binlog_checksum");

  mariadb_rpl_optionsv(rpl, MARIADB_RPL_SERVER_ID, 12);
  mariadb_rpl_optionsv(rpl, MARIADB_RPL_START, 4);
  mariadb_rpl_optionsv(rpl, MARIADB_RPL_FLAGS, MARIADB_RPL_BINLOG_SEND_ANNOTATE_ROWS)

  if (mariadb_rpl_open(rpl))
    return FAIL;

  while((event= mariadb_rpl_fetch(rpl, event)))
  {
    /* process events */
    switch(event->event_type) {
      case BINLOG_CHECKPOINT_EVENT:
        ....
        break;
      case FORMAT_DESCRIPTION_EVENT:
        ...
        break;
      ....
      default:
        printf("Unknown event: %d", event->event_type);
        break;
    }
  }
  mariadb_free_rpl_event(event);
  mariadb_rpl_close(rpl);
  return OK;
}

Building Connector/C From Source

Build MariaDB Connector/C from source. Download the package from MariaDB downloads or get the latest development version from the Connector/C GitHub repository.

Prerequisites For Building Connector/C From Source

Building MariaDB Connector/C from source requires CMake, a C compiler, and TLS/SSL libraries. Windows needs Visual Studio; Linux and macOS need gcc, with optional Curl or Kerberos.

Configuration Settings for Building Connector/C

Configure the MariaDB Connector/C build via CMake options including build type, TLS/SSL backend, install prefix, and client plugins such as authentication and connection handlers.

Compile MariaDB Connector/C after configuration using CMake on Windows or Unix. Supports Visual Studio builds and GNU make, with both IDE and command-line build options.

Prerequisites For Building Connector/C From Source

Building MariaDB Connector/C from source requires CMake, a C compiler, and TLS/SSL libraries. Windows needs Visual Studio; Linux and macOS need gcc with optional Curl or Kerberos.

Windows

Visual Studio 2013 or newer (older versions of Visual Studio may also work but have not been tested).
cmake 3.12.0 or newer, available from the CMake website.
for Connector/C 2.x: OpenSSL libraries and include files.
for Connector/C 3.0 remote-io plugin: 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.2 or newer

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 or .

Compiling Connector/C

Compile MariaDB Connector/C after configuration using CMake on Windows or Unix. Supports Visual Studio builds and GNU make, with both IDE and command-line build options.

After successful configuration, Connector/C can now be compiled.

Compiling on Windows

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.sln

or via command line

cmake --build . --config RelWithDebInfo

Compiling on Unix

By default CMake creates build files for GNU make. On some system GNU make is renamed to gmake. You can now build Connector/C with

make

cmake --build . --config Release

mariadb_cancel

mariadb_cancel immediately aborts a connection by making all subsequent read/write operations fail, without freeing the MYSQL structure or closing communication channels.

Syntax

int mariadb_cancel(MYSQL * mysql);

Parameter

mysql - mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().

Description

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, mysql_close() must be called.mariadb_cancel() is useful to break long queries in situations where sending KILL is not possible.

Return Value

Returns zero on success or a non-zero value on error.

History

mariadb_cancel() was added in Connector/C 3.0

mariadb_connect

Connect to a database server using a connection string

mysql - mysql handle, which was previously allocated by and connected by .
conn_str- Connection string, containing connection parameters. A connection string contains key/value pairs, separated by a semicolon as used in ODBC. Supported keys are all configuration options which can be used in MariaDB configuration files. For a complete list check the chapter configuration files.

Returns a MYSQL * handle or NULL on error.

mariadb_connection

Syntax

Parameter

mysql - mysql handle, which was previously allocated by mysql_init() and connected by mysql_real_connect().

Description

Checks if the client is connected to a MariaDB or MySQL database server.

Return Value

Returns a non zero value if connected to a MariaDB database server, otherwise zero.

mariadb_convert_string

Syntax

#include <mysql.h>

size_t mariadb_convert_string(const char *from __attribute__((unused)),
                              size_t *from_len __attribute__((unused)),
                              MARIADB_CHARSET_INFO *from_cs __attribute__((unused)),
                              char *to __attribute__((unused)),
                              size_t *to_len __attribute__((unused)),
                              MARIADB_CHARSET_INFO *to_cs __attribute__((unused)), int *errorcode)

Description

Converts a string in to a different character set

This function is deprecated.

mariadb_get_info

Syntax

#include <mysql.h>

my_bool mariadb_get_info(MYSQL *mysql, enum mariadb_value value, void *arg)

Description

Retrieves generic or connection related information.

This function is deprecated. Please use instead.

mariadb_reconnect

mariadb_reconnect attempts to re-establish a dropped MariaDB Connector/C connection using the original credentials, and requires the MYSQL_OPT_RECONNECT option to be set.

Syntax

my_bool  mariadb_reconnect(MYSQL * mysql)

Parameter

mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().

Description

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 mysql_real_connect().

Return Value

The function will return 0 on success. The function will return an error, if the option MYSQL_OPT_RECONNECT wasn't specified before.

History

This function was added in Connector/C 3.0.

mysql_character_set_name

mysql_character_set_name returns the name of the default client character set for a specified MariaDB Connector/C connection.

Syntax

const char * mysql_character_set_name(MYSQL * mysql);

Parameter

mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().

Description

Returns the default client for the specified connection.

Return value

The character set name used for the specified connection.

This function is deprecated. Instead, use with option MARIADB_CONNECTION_CHARSET_INFO.

mysql_client_find_plugin

mysql is a connection identifier, which was previously initialized by and optional connected by .
name The name of the plugin.
type

mysql_close

mysql_close terminates an open database connection and releases the memory allocated for the MYSQL handle.

Syntax

void mysql_close(MYSQL * mysql);

Parameter

mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().

Description

Closes a previously opened connection and deallocates all memory.

To reuse a connection handle after mysql_close() the handle must be initialized again by .

mysql_commit

mysql_commit commits the current transaction on a MariaDB Connector/C connection, returning zero on success without affecting autocommit mode.

mysql - a mysql handle, which was previously allocated by or .

Commits the current transaction for the specified database connection.

Returns zero on success, nonzero if an error occurred.

mysql_data_seek

mysql_data_seek moves the result set pointer to an arbitrary row offset in a buffered result set obtained via mysql_store_result, enabling random row access.

Syntax

void mysql_data_seek(MYSQL_RES * result,
                     my_ulonglong offset);

Parameters

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).

Description

The mysql_data_seek() function seeks to an arbitrary function result pointer specified by the offset in the result set.

mysql_dump_debug_info

mysql_dump_debug_info instructs a MariaDB server to write connection status information to the error log, and requires the SUPER privilege for the current user.

mysql - a mysql handle, which was previously allocated by or .

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_eof

Parameter

Description

mysql_eof determines whether the final row in a result set has already been retrieved.

Returns non-zero (true) if the entire result set has been read, or zero (false) if rows are still available.

mysql_errno

mysql_errno returns the numeric error code from the most recent MariaDB Connector/C function call, or zero if no error occurred.

mysql - a mysql handle, which was previously allocated by or .

Returns the last for the most recent function call that can succeed or fail. Zero means no error occurred.

mysql_escape_string

mysql_escape_string encodes a string using the default character set for safe use in SQL statements. Deprecated — use mysql_real_escape_string instead.

Escapes a string using the default character set.

mysql_fetch_field

mysql_fetch_field returns the definition of one result set column as a MYSQL_FIELD pointer; call it repeatedly to iterate over all columns in the result set.

result - a result set identifier returned by or .

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.

A pointer of a MYSQL_FIELD structure, or NULL if there are no more fields.

mysql_fetch_field_direct

mysql_fetch_field_direct returns a MYSQL_FIELD pointer for a specific column in a result set, identified by its zero-based field number.

res - a result set identifier returned by or .
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.

mysql_fetch_fields

mysql_fetch_fields returns all column definitions for a MariaDB result set as an array of MYSQL_FIELD structures, one entry per column.

res - a result set identifier returned by or .

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.

An array of type MYSQL_FIELD.

mysql_fetch_lengths

mysql_fetch_lengths returns an array of byte lengths for each column in the current row of a MariaDB result set, valid only after mysql_fetch_row is called.

result - a result set identifier returned by or .

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.

An array of unsigned long values . The size of the array can be determined by the number of fields in current result set.

mysql_fetch_row

mysql_fetch_row retrieves the next row from a MariaDB result set as an array of char pointers, returning NULL when no more rows are available.

Syntax

MYSQL_ROW mysql_fetch_row(MYSQL_RES * result);

Parameter

result - a result set identifier returned by mysql_store_result() or mysql_use_result().

Description

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.

If a column contains a NULL value the corresponding char pointer will be set to NULL.

Memory associated to MYSQL_ROW will be freed when calling function.

mysql_field_count

mysql_field_count returns the number of columns in the most recent query result for a MariaDB connection, useful for checking whether a result set is available.

mysql - a mysql handle, which was previously allocated by or .

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 function to determine if the query should have produced a non-empty result set or not without knowing the nature of the query.

The number of columns for the most recent statement. The value is zero, if the statement didn't produce a result set.

mysql_field_seek

mysql_field_seek sets the field cursor to a given column offset in a MariaDB result set, controlling which field mysql_fetch_field returns next.

result - a result set identifier returned by or .
offset - the field number. This number must be in the range from 0..number of fields - 1.

mysql_field_tell

mysql_field_tell retrieves the current field cursor position in a result set, which can be passed to mysql_field_seek to restore that position.

Syntax

MYSQL_FIELD_OFFSET mysql_field_tell(MYSQL_RES * result);

Parameter

result - a result set identifier returned by mysql_store_result() or mysql_use_result().

Description

Return the offset of the field cursor used for the last mysql_fetch_field() call. This value can be used as a parameter for the function mysql_field_seek().

Return Value

Returns the current offset of the field cursor

mysql_free_result

mysql_free_result releases the memory allocated for a MariaDB result set; row values obtained from prior mysql_fetch_row calls become invalid after this call.

result - a result set identifier returned by or .

Frees the memory associated with a result set.

Returns void.

mysql_get_character_set_info

mysql_get_character_set_info populates a MY_CHARSET_INFO structure with details about the current default character set for a MariaDB Connector/C connection.

mysql - a mysql handle, which was previously allocated by or .
charset - a pointer to a MY_CHARSET_INFO structure, in which the information will be copied.

mysql_get_client_info

mysql_get_client_info retrieves the client library version as a string; use mysql_get_client_version for the equivalent numeric value.

Syntax

const char * mysql_get_client_info(void );

Description

Returns a string representing the client library version

To obtain the numeric value of the client library version use .

mysql_get_client_version

mysql_get_client_version retrieves the client library version as an unsigned long; use mysql_get_client_info for the string representation.

Syntax

unsigned long mysql_get_client_version(void);

Description

Returns a number representing the client library version. The value has the format XXYYZZ: major version * 10000 + minor version * 100 + patch version.

Return Value

A long integer representing the client version

To obtain a string containing the client library version use the function.
Since MariaDB Server 10.2.6 and MariaDB Connector/C 3.0.1 the client library is bundled with server package and returns the server package version. To obtain the client version of the connector, please use the constant MARIADB_PACKAGE_VERSION_ID

mysql_get_host_info

mysql_get_host_info returns a string describing the connection type and server hostname for a MariaDB Connector/C connection, or NULL if invalid.

Syntax

char * mysql_get_host_info(MYSQL * mysql);

Parameter

mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().

Description

Describes the type of connection in use for the connection, including the server host name.

Return Value

Returns a string, describing host information or NULL if the connection is not valid.

mysql_get_proto_info

mysql_get_proto_info returns the protocol version number used for a MariaDB Connector/C connection; versions 9 and below are not supported.

mysql - a mysql handle, which was previously allocated by or .

Returns the protocol version number for the specified connection.

The protocol version number in use.

mysql_get_server_info

mysql_get_server_info retrieves the connected server version string; use mysql_get_server_version for the equivalent numeric representation.

mysql - a mysql handle, which was previously allocated by or .

Returns the server version or NULL on failure.

Returns the server version as zero terminated string or NULLon failure.

mysql_get_server_version

mysql_get_server_version retrieves the server version as an unsigned long; use mysql_get_server_info for the equivalent string representation.

Syntax

unsigned long mysql_get_server_version(MYSQL * mysql);

Parameter

mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().

Description

Returns an integer representing the version of connected server.

Return Value

The version number of the connected server.

The form of the version number is VERSION_MAJOR * 10000 + VERSION_MINOR * 100 + VERSION_PATCH

mysql_get_timeout_value

Parameter

Description

mysql_get_timeout_value retrieves the current timeout value configured for asynchronous operations on the given connection, expressed in seconds.

The timeout value in seconds as an unsigned int

mysql_hex_string

mysql_hex_string converts a binary buffer to a hex-encoded string for safe embedding in SQL; the output buffer must be at least 2*length+1 bytes.

to - result buffer
from - the string which will be encoded
len

mysql_init

mysql_init allocates and initializes a MYSQL structure for use with mysql_real_connect, and also initializes the thread subsystem if not already done.

mysql - a pointer to MYSQL or NULL. In case of passing a NULL pointer mysql_init() will allocate memory and return a pointer to a MYSQL structure.

Prepares and initializes a MYSQL structure to be used with .

mysql_init() also ensures the client library is initialized, via a one-time internal initialization; it does not depend on mysql_thread_init()

mysql_kill

mysql_kill requests the MariaDB server to terminate the thread with the given process ID; use mysql_thread_id to obtain the ID of the current connection.

mysql - a mysql handle, which was previously allocated by or .
unsigned long - process id

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 should be used.

Returns 0 on success, otherwise error on nonzero.

mysql_library_end

mysql_library_end finalizes the MariaDB Connector/C library after use, performing memory cleanup and shutting down the embedded server if applicable.

Call when finished using the library, such as after disconnecting from the server. In an embedded server application, the embedded server is shut down and cleaned up. For a client program, only cleans up by performing memory management tasks.

mysql_library_init

mysql_library_init initializes the MariaDB Connector/C library before any other functions are called, starting the embedded server if used in that configuration.

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.

mysql_num_rows

mysql_num_rows returns the number of rows in a MariaDB result set; for unbuffered results the count is only accurate after all rows have been fetched.

Syntax

my_ulonglong mysql_num_rows(MYSQL_RES * );

Parameter

MYSQL_RES - a result set identifier returned by mysql_store_result() or mysql_use_result().

Description

Returns number of rows in a result set.

The behavior of mysql_num_rows() depends on whether buffered or unbuffered result sets are being used. For unbuffered result sets, mysql_num_rows() will not return the correct number of rows until all the rows in the result have been retrieved.

mysql_options4

Parameter

Description

mysql_query

mysql_query sends a null-terminated SQL string to the MariaDB server for execution, returning zero on success; use mysql_real_query for binary-safe operation.

mysql - a mysql handle, which was previously allocated by or .
query -a null terminated string containing the statement to be performed.

Performs a statement pointed to by the null terminate string query against the database. Contrary to , mysql_query() is not binary safe.

Returns zero on success, non zero on failure

Binlog/API Data Structures

All structures and type definitions for the Binglog/Replication API are defined in include/mariadb_rpl.h.

The following structures are used by the Binlog/Replication API:

Structure

Description

MARIADB_STRING

Stores a string together with its length.

MARIADB_TIMESTAMP

MARIADB_STRING is a simple structure that stores a string together with its length. It is equivalent to MYSQL_STRING and MYSQL_LEX_STRING.

str → Pointer to the character data.
length → Length of the string in bytes.

MARIADB_TIMESTAMP stores timestamp values for MYSQL_TYPE_TIMESTAMP and MYSQL_TYPE_TIMESTAMP2 column data. It was introduced in MariaDB Connector/C 3.3.19 and 3.4.9 versions.

second → Represents the whole seconds portion of the timestamp.
second_part → Represents the fractional seconds (microseconds).

MARIADB_GTID represents a Global Transaction ID (GTID).. A GTID uniquely specifies a transaction across a replication topology and is defined by three components: domain ID, server ID, and sequence number.

domain_id → The replication domain identifier.
server_id → The ID of the server that originally committed the transaction.
sequence_nr → The transaction’s sequence number within the domain.

MARIADB_RPL is the generic replication handle. It represents a replication connection and is passed to all Binlog/Replication API calls.

The MARIADB_RPL structure is opaque. Its internal members should not be accessed directly.
To configure replication options, use mariadb_rpl_optionsv().
To retrieve replication options, use mariadb_rpl_get_optionsv().

MARIADB_RPL_EVENT is the structure returned by mariadb_rpl_fetch() API function. It contains a common event header followed by a union of event-specific structures. The active union member is determined by the value of event_type.

Field Validation

memroot → Internal memory pool used to allocate event data.
checksum → CRC32 checksum of the event (if binlog checksums are enabled).
ok → Non-zero if the event was received without error.

The event union defines one member for each supported replication event type. Only the member that corresponds to the current event_type value contains valid data. The following sections describe each event type and its associated structure:

ANNOTATE_ROWS_EVENT

event_type value= 160 (0xA0)

This event contains the statement that produced the subsequent row‑change event in the binary log stream. It is only generated if the client connects with the MARIADB_RPL_BINLOG_SEND_ANNOTATE_ROWS flag enabled.

statement → The SQL statement that triggered the row‑change event.

Notes

ANNOTATE_ROWS_EVENT is sent only when the replication handle was opened with the MARIADB_RPL_BINLOG_SEND_ANNOTATE_ROWS flag, set through mariadb_rpl_optionsv().
If the flag is not set, this event will not be included in the binary log stream.

BINLOG_CHECKPOINT_EVENT

event_type value= 161 (0xA1)

Written to the binary log to record the oldest binary log file that is still required for recovery. This event ensures that replication and recovery processes know which binary log files must be retained to guarantee consistency.

filename → The name of the oldest binary log file needed for crash recovery and replication consistency.

START_ENCRYPTION_EVENT

event_type value= 164 (0xA4)

Written to the binary log when encryption is enabled on the source server. This event records the encryption scheme and key version used for subsequent event

scheme → Encryption scheme identifier.
key_version → Version of the encryption key used for encrypted log data.
nonce → Nonce (number used once) used in the encryption process.

FORMAT_DESCRIPTION_EVENT

event_type value= 15 (0x0F)

Written at the beginning of every binary log file, at position 4. This event describes the format of all subsequent events in the file. For MariaDB 10.0 and later, the format field is always set to 4.

format → Binary log format version. Always 4 for MariaDB 10.0 and later.
server_version → Version string of the server that created the binary log.
timestamp → Unix timestamp of when the binary log file was created.

GTID_EVENT

event_type value= 162 (0xA2)

Marks the start of a new global transaction event group. This event is written to the binary log before the events belonging to the transaction.

sequence_nr → Sequence number of the transaction within the replication domain.
domain_id → Identifier of the replication domain.
flags → Bitmask of event flags.

Notes:

The GTID_EVENT ensures that each transaction is uniquely identified across the replication topology.
It captures all events belonging to the transaction, ensuring replication consumers can group and track them consistently.

GTID_LIST_EVENT

event_type value= 163 (0xA3)

Written at the start of every binary log file to record the current replication state. This event contains the last GTID seen for each replication domain, allowing replicas to determine where to resume replication after a reconnect.

gtid_cnt → Number of GTID entries in the gtid array.
gtid → Array of MARIADB_GTID structures, one per replication domain.

HEARTBEAT_LOG_EVENT

event_type value= 27 (0x1B)

Sent over the network by the source server to replicas when there are no binary log events to transmit. This event confirms that the source server is still alive. It is never written to the binary log file itself.

filename → Name of the current binary log file on the source server.

INTVAR_EVENT

event_type value=5 (0x05)

Written to the binary log immediately before a QUERY_EVENT whenever the statement uses an AUTO_INCREMENT value or the LAST_INSERT_ID() function.

value → The integer value, either the next auto‑increment value or the result of LAST_INSERT_ID().
type → Indicates the variable type.

Valid values for type are:

Value

Constant

Description

QUERY_EVENT

event_type value=2 (0x02)

Contains a SQL statement. This event is written to the binary log when:

The server binlog_format is set to STATEMENT (statement‑based replication).
A DDL statement is executed.
A COMMIT is issued for a non‑transactional storage engine.

thread_id → ID of the client thread that executed the statement on the source server.
seconds → Time in seconds that the statement took to execute.
database → Name of the default database at the time the statement was executed.

RAND_EVENT

event_type value=13 (0x0D)

Written to the binary log immediately before a QUERY_EVENT that uses the RAND() function. This event records the seed values so that replicas can reproduce the same pseudo‑random sequence.

first_seed → First seed value for the RAND() function.
second_seed → Second seed value for the RAND() function.

ROTATE_EVENT

event_type value=4 (0x04)

Written at the end of a binary log file to indicate that the next event will appear in a new binary log file.

position → Starting position in the new binary log file.
filename → Name of the new binary log file.

Notes:

The ROTATE_EVENT signals the transition between binary log files, ensuring replication clients know where to continue reading.
It is always written at the end of a binary log file and points to the beginning of the next file.

WRITE_ROWS_EVENT_V1, UPDATE_ROWS_EVENT_V1, DELETE_ROWS_EVENT_V1

Event Types with values:

WRITE_ROWS_EVENT_V1 → 23 (0x17)
UPDATE_ROWS_EVENT_V1 → 24 (0x18)
DELETE_ROWS_EVENT_V1 →

Row events are written to the binary log when the server binlog_format is set to ROW. All three event types share the same structure; the type field distinguishes the specific row operation (insert, update, or delete).

type → Row operation type: write (insert), update, or delete. See Replication API Types and Definitions.
table_id → References the table mapped by the preceding TABLE_MAP_EVENT.
flags → Row event flags bitmask.

TABLE_MAP_EVENT

event_type value=19 (0x13)

Written before each row event (in row‑based replication) to map a table ID to a fully qualified table name and provide column metadata for the rows that follow.

table_id → Numeric table ID used in subsequent row events to reference this table.
database → Name of the database containing the table.
table → Name of the table.

USERVAR_EVENT

event_type value=14 (0x0E)

Written to the binary log before a QUERY_EVENT that references a user variable. This event records the variable’s name, type, and value so the replica can set it before executing the statement.

name → Name of the user variable.
is_null → Non‑zero if the variable’s value is NULL.
type → Data type of the variable value.

XID_EVENT

event_type value=16 (0x10)

Written to the binary log when a transactional storage engine commits a transaction. This event records the XA transaction number and signals the end of the transaction’s event group.

transaction_nr → The XA transaction number for this commit.

Notes:

The XID_EVENT marks the successful commit of a transaction in engines that support XA transactions.
It serves as the boundary marker for the transaction’s event group, ensuring replicas apply the transaction atomically.

mysql_optionsv

mysql_optionsv sets connection, TLS, plugin, and option-file options on a MariaDB Connector/C handle before mysql_real_connect, supporting a variable argument list.

Syntax

int mysql_optionsv(MYSQL * mysql,
                   enum mysql_option,
                   const void * arg,
                   ...);

mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().
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 .

Some of these options can also be set in , such as my.cnf.

Returns zero on success, non-zero if an error occurred (invalid option or value).

The following table shows the C variable type required for the arg parameter of each option:

Variable type

Options

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.
Note: When multiple option files are used, init_command

Some of these options can also be set as arguments to the 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.

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

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

MARIADB_OPT_STATUS_CALLBACK: Specifies a callback function that is invoked whenever the server sends a status change or session tracking information to the client. This can be used to monitor server status flags and session variable changes without polling.
The callback function must match the following signature:

Parameters

Parameter

Type

Description

Variadic Parameters (vary by type)

When type is STATUS_TYPE:

Position

Type

Description

When type is SESSION_TRACK_TYPE:

Position

Type

Description

An example implementation can be found in the Connector/C source tree at unittest/libmariadb/connection.c (function test_status_callback). Added in MariaDB Connector/C 3.3.2 version.

MARIADB_OPT_RPL_REGISTER_REPLICA: Specifies the host name and port that the Binlog API will report when registering this client as a replica with the connected server. When this option is set, mariadb_rpl_open() will register the client using the provided host, port, and the server ID configured via mariadb_rpl_optionsv(). The registration is visible in the output of SHOW SLAVE STATUS on the server.
Added in MariaDB Connector/C 3.3.1 version. See .

MYSQL_READ_DEFAULT_FILE: Read options from an .
MYSQL_READ_DEFAULT_GROUP: Read options from the named from an .

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 are read.
if MYSQL_READ_DEFAULT_FILE

As defined by the , a client may prefix its first packet with a proxy protocol header. The server will parse this header and treat the IP address it contains as the client's actual IP address, rather than the address of the connecting process.

MARIADB_OPT_PROXY_HEADER: Specifies the proxy protocol header to prefix to the first packet sent to the server. The option requires two additional arguments:
- a void * pointer to the header buffer, and
- a size_t value for the buffer length.

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

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.

Configuring MariaDB Connector/C with Option Files

MariaDB Connector/C reads connection settings from option files such as my.cnf, supporting default and custom file locations, option groups, and a full set of client options.

Just like MariaDB Server and libmysqlclient, MariaDB Connector/C can also read configuration options from client in .

Default Option File Locations

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:

mysql_optionsv(mysql, MYSQL_READ_DEFAULT_FILE, NULL);

MYSQL_READ_DEFAULT_FILE is exclusive: if the application calls it more than once, the second call replaces the value set by the first. To read both a custom option file and the default option files, pass the custom file path in a single call; reading default files is controlled separately via MYSQL_READ_DEFAULT_GROUP.

Default Option File Locations on Linux, Unix, Mac

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:

Location

When the DEFAULT_SYSCONFDIR option was defined, MariaDB Connector/C looks for the MariaDB option file in the following locations in the following order:

Location

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:

Location

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.

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:

Option

Description

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.

MariaDB Connector/C reads client options from the following in :

Group

Description

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:

Option

Description

The command-line option does not yet have an equivalent option in MariaDB Connector/C. See for more information.

It is possible to include additional option files from another option file. For example, to include /etc/mysql/dbserver1.cnf, an option file could contain:

It is also possible to include the default option files in a directory from another option file. For example, to include the default option files in /etc/my.cnf.d/, an option file could contain:

Unlike with MariaDB server, this directive does not configure MariaDB Connector/C to include all option files ending in .cnf on Unix-like operating systems or all option files ending in .cnf and .ini files on Windows. Instead, it just configures MariaDB Connector/C to include the my.cnf in the given directory, and also the my.ini in the given directory if it's Windows. See for more information.

For many MariaDB clients, you can check which options a given program is going to use by using the command-line argument:

Option

Description

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. For example:

If it is installed on your system, then you can also check which options a given program is going to use by using the utility and providing the names of the option groups that the program reads.

For example:

See for more information.

MySQL 5.6 and above support an obfuscated authentication credential option file called .mylogin.cnf that is created with .

MariaDB Connector/C does not support this. The passwords in MySQL's .mylogin.cnf are only obfuscated, rather than encrypted, so the feature does not really add much from a security perspective. It is more likely to give users a false sense of security, rather than to seriously protect them.

MariaDB Connector/C options can be set in client .

Underscores (_) in option names are treated the same as dashes (-) for MariaDB Connector/C. See for more information.

Unlike with the server, the loose prefix has no meaning for MariaDB Connector/C. Unknown options will simply be ignored.

MariaDB Connector/C allows application developers to implement custom options in option files by defining a function that matches this signature:

And then assigning the function pointer to mysql->options.extension->set_option.

These are the options supported in option files by MariaDB Connector/C by default.

These options can also be set inside your application with the function.

bind-address

Description: Specify the network interface from which to connect to MariaDB Server.
mysql_optionsv: MYSQL_OPT_BIND
Data Type: string

character-sets-dir

Description: Directory for files.
mysql_optionsv: MYSQL_SET_CHARSET_DIR
Data Type: string

compress

Description: Compress all information sent between the client and the server if both support compression.
mysql_optionsv: MYSQL_OPT_COMPRESS
Data Type: boolean

connect-timeout, timeout

Description: Connect timeout in seconds. This value will be passed as an unsigned int parameter.
mysql_optionsv: MYSQL_OPT_CONNECT_TIMEOUT
Data Type: int

database

Description: Database to use.
mysql_optionsv: MARIADB_OPT_SCHEMA
Data Type: string
Default Value:

debug

Description:
mysql_optionsv: MARIADB_OPT_DEBUG
Data Type: string
Default Value:

default-auth

Description: Default authentication client-side plugin to use.
mysql_optionsv: MYSQL_DEFAULT_AUTH
Data Type: string

default-character-set

Description: Specify the default for the connection.
mysql_optionsv: MYSQL_SET_CHARSET_NAME
Data Type: string

disable-local-infile

Description: Disable the use of .
mysql_optionsv: N/A
Data Type: string
Default Value:

host

Description: Hostname or IP address of the server to connect to.
mysql_optionsv: MARIADB_OPT_HOST
Data Type: string

interactive-timeout

Description:
mysql_optionsv: MARIADB_OPT_INTERACTIVE
Data Type: none
Default Value:

init-command

Description: Command(s) which will be executed when connecting and reconnecting to the server.
mysql_optionsv: MYSQL_INIT_COMMAND
Data Type: string

local-infile

Description: Enable or disable the use of .
mysql_optionsv: MYSQL_OPT_LOCAL_INFILE
Data Type: boolean

max-allowed-packet

Description: The maximum packet length to send to or receive from server. The default is 16MB, the maximum 1GB.
mysql_optionsv: MYSQL_OPT_MAX_ALLOWED_PACKET
Data Type: size_t

multi-results

Description: Indicates that the client is able to handle multiple result sets from stored procedures or multi statements. This option will be automatically set if multi-statements is set.
mysql_optionsv: MARIADB_OPT_MULTI_RESULTS
Data Type: boolean

multi-statements, multi-queries

Description: Allows the client to send multiple statements in one command. Statements will be divided by a semicolon.
mysql_optionsv: MARIADB_OPT_MULTI_STATEMENTS
Data Type: boolean

net-buffer-length

Description: The buffer size for TCP/IP and socket communication. Default is 16KB.
mysql_optionsv: MYSQL_OPT_NET_BUFFER_LENGTH
Data Type: size_t

password

Description: Password of the user to login to the server.
mysql_optionsv: MARIADB_OPT_PASSWORD
Data Type: string

pipe

Description: For Windows operating systems only: Use named pipes for client/server communication.
mysql_optionsv: MYSQL_OPT_NAMED_PIPE
Data Type: boolean

plugin-dir

Description: Specify the location of client plugins.
- The plugin directory can also be specified with the MARIADB_PLUGIN_DIR environment variable.
mysql_optionsv: MYSQL_PLUGIN_DIR

port

Description: Port number to use for connection.
mysql_optionsv: MARIADB_OPT_PORT
Data Type: int
Default Value: 3306

protocol

Description: Specify the type of client/server protocol. Possible values are:
- 0 - Refers to MYSQL_PROTOCOL_DEFAULT
- 1 - Refers to MYSQL_PROTOCOL_TCP

reconnect

Description: Enable or disable automatic reconnect.
mysql_optionsv: MYSQL_OPT_RECONNECT
Data Type: boolean
Default Value:

report-data-truncation

Description: Enable or disable reporting data truncation errors for prepared statements.
mysql_optionsv: MYSQL_REPORT_DATA_TRUNCATION
Data Type: boolean

return-found-rows

Description: Return the number of matched rows instead of number of changed rows.
mysql_optionsv: MARIADB_OPT_FOUND_ROWS
Data Type: none

secure-auth

Description: Refuse client connecting to server if it uses old (pre-MySQL4.1.1) protocol. Defaults to false (unlike MySQL since 5,6, which defaults to true).
mysql_optionsv: MYSQL_SECURE_AUTH
Data Type: boolean

server_public_key

Description: 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.
mysql_optionsv: MYSQL_SERVER_PUBLIC_KEY
Data Type: string

shared-memory-base-name

Description: Shared-memory name to use for Windows connections using shared memory to a local server (started with the --shared-memory option). Case-sensitive.
mysql_optionsv: MYSQL_SHARED_MEMORY_BASE_NAME
Data Type: string

socket

Description: For connections to localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use.
mysql_optionsv: MARIADB_OPT_UNIXSOCKET
Data Type: string

ssl-ca

Description: 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_optionsv: MYSQL_OPT_SSL_CA

ssl-capath

Description: 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.

ssl-cert

Description: 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_optionsv: MYSQL_OPT_SSL_CERT
Data Type: string

ssl-cipher

Description: List of permitted ciphers or cipher suites to use for .
mysql_optionsv: MYSQL_OPT_SSL_CIPHER
Data Type: string

ssl-crl

Description: 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.

ssl-crlpath

Description: 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.

ssl-enforce

Description: Whether to force .
mysql_optionsv: MYSQL_OPT_SSL_ENFORCE
Data Type: boolean

ssl-fp

Description: Description: Specify the fingerprint hash of a server certificate for validation during the handshake. handshake. In Connector/C versions prior to 3.4.0, only SHA1 hashes are accepted. From version 3.4.0 onward, SHA256, SHA384, and SHA512 hashes are also supported.
mysql_optionsv: MARIADB_OPT_SSL_FP

ssl-fp-list, ssl-fplist

Description: Description: Specify a file which contains one or more fingerprint hashes of server certificates for validation during the handshake. In Connector/C versions prior to 3.4.0, only SHA1 hashes are accepted. From version 3.4.0 onward, SHA256, SHA384, and SHA512 hashes are also supported.
mysql_optionsv: MARIADB_OPT_SSL_FP_LIST

ssl-key

Description: 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 ssl-passphrase option.
mysql_optionsv: MYSQL_OPT_SSL_KEY
Data Type: string

ssl-passphrase

Description: Specify a passphrase for a passphrase-protected private key, as configured by the 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.
mysql_optionsv: MARIADB_OPT_TLS_PASSPHRASE

ssl-verify-server-cert

Description: Enables (or disables) .
mysql_optionsv: MYSQL_OPT_SSL_VERIFY_SERVER_CERT
Data Type: boolean

tls_version

Description: 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_optionsv: MARIADB_OPT_TLS_VERSION

user

Description: User to login to the server.
mysql_optionsv: MARIADB_OPT_USER
Data Type: string
Default Value:

Connectors

MariaDB Connectors

Quickstart Guides

MariaDB Connector/C++ Guide

Erlang Guide

1. Installation

2. Basic Usage

Connector/C

MariaDB Binlog/Replication API reference

mariadb_rpl_init()

mariadb_rpl_open()

mariadb_rpl_fetch()

mariadb_free_rpl_event()

mariadb_rpl_extract_rows()

mariadb_rpl_errno()

Syntax

Parameters

Return Value

Notes

mariadb_rpl_error()

mariadb_rpl_close()

Example

Building Connector/C From Source

Prerequisites For Building Connector/C From Source

Windows

Compiling Connector/C

Compiling on Windows

Compiling on Unix

mariadb_cancel

Syntax

Parameter

Description

Return Value

History

mariadb_connect

mariadb_connection

Syntax

Parameter

Description

Return Value

mariadb_convert_string

Syntax

Description

mariadb_get_info

Syntax

Description

See Also

mariadb_reconnect

Syntax

Parameter

Description

Return Value

History

See Also

mysql_character_set_name

Syntax

Parameter

Description

Return value

See Also

mysql_client_find_plugin

mysql_close

Syntax

Parameter

Description

See Also

mysql_commit

mysql_data_seek

Syntax

Parameters

Description

mysql_dump_debug_info

mysql_eof

mysql_errno

mysql_escape_string

mysql_fetch_field

mysql_fetch_field_direct

mysql_fetch_fields

mysql_fetch_lengths

mysql_fetch_row