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

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

Syntax

Parameters

Return Value

Returns a pointer to a linked list of MARIADB_RPL_ROW structures on success, or NULL on failure. Each node in the list represents one row in the event.

History

Added in MariaDB Connector/C 3.3.5.

See also

• mariadb_rpl_fetch()

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

Syntax

Parameters

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.

History

Added in MariaDB Connector/C 3.3.5.

See also

• mariadb_rpl_error()

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

Syntax

Parameters

Returns

Returns a null-terminated string containing the error message on failure, or an empty string ("") 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.

History

Added in MariaDB Connector/C 3.3.5.

See also

mariadb_rpl_errno()

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;
}

Syntax

Parameter

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

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

Return Value

Returns a MYSQL * handle or NULL on error.

Note

• The connection string must contain at least one semicolon, otherwise it will be interpreted as hostname.

• Unknown or invalid keys will be ignored

• mariadb_connect is not a function, but a macro which maps to mysql_real_connect: #define mariadb_connect(mysql, conn_str) mysql_real_connect((mysql),(conn_str), NULL, NULL, NULL, 0, NULL, 0)

Example

History

mariadb_connect() was added in Connector/C 3.3.0.

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.

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

Syntax

Description

Retrieves generic or connection related information.

See Also

• mariadb_get_infov()

Syntax

Parameters

• mysql is a connection identifier, which was previously initialized by mysql_init() and optional connected by mysql_real_connect().

• name The name of the plugin.

• type The plugin type.

Valid Plugin Types

• MYSQL_CLIENT_AUTHENTICATION_PLUGIN

• MARIADB_CLIENT_PVIO_PLUGIN

• MARIADB_CLIENT_REMOTEIO_PLUGIN

• MARIADB_CLIENT_CONNECTION_PLUGIN or MARIADB_CLIENT_COMPRESSION_PLUGIN.

Return Value

A pointer to the plugin handle, or NULL if an error occurred.

See Also

• mysql_load_plugin()

Syntax

Parameter

Description

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

Return Value

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

See Also

• mysql_fetch_row()

• mysql_store_result()

Syntax

Parameter

Description

Returns the length of a length encoded field and increments the pointer to the beginning of the field.

Return Value

Returns the length of the field.

See Also

• mysql_net_read_packet()

Syntax

Parameter

Description

mysql_net_read_packet reads the next protocol packet from the server into the connection's internal network buffer.

Return Value

Returns the length of the received packet.

See also

• mysql_net_field_length()

MariaDB Connector/C++ Quickstart Guide

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.

Why Choose Connector/C++?

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

Next Steps

To get started with MariaDB Connector/C++, you'll typically need to:

1. Download the Connector/C++ library. Look for the appropriate package for your operating system and development environment.

2. Integrate the library into your C++ project. This usually involves including header files and linking against the library during compilation.

3. Write C++ code to establish a connection, execute SQL queries, and process results using the object-oriented API.

_{This page is: Copyright © 2025 MariaDB. All rights reserved.}

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

% Select data
{ok, ColumnNames, Rows} = mysql:query(Pid, <<"SELECT id, name FROM mytable WHERE status = ?">>, [<<"active">>]).

% Insert data
ok = mysql:query(Pid, "INSERT INTO mytable (col1, col2) VALUES (?, ?)", [<<"value1">>, 123]).

c. Close Connection:

Erlang

mysql:stop(Pid).

Further Resources:

• MySQL/OTP GitHub Repository

• Erlang/OTP Documentation

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.

The Binlog/Replication API provides a low‑level interface for consuming and processing binary log events from a MariaDB server. It allows applications to configure replication handles, open streams, fetch and decode events, and manage errors.

Together, these functions enable developers to build custom replication clients and event processing tools.

Function Overview

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

Syntax

#include <mysql.h>
#include <mariadb.h>

MARIADB_RPL *mariadb_rpl_init(MYSQL *mysql)

Parameters

Return Value

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

Notes

The replication handle must be released by calling mariadb_rpl_close() when no longer needed.

History

Added in .

See also

• mariadb_rpl_close()

Sets options on a replication handle. All required options must be set before calling .

Retrieves the current value of a replication handle option previously set with mariadb_rpl_optionsv().

Syntax

#include <mariadb_rpl.h>

int mariadb_rpl_get_optionsv(MARIADB_RPL *rpl,
                               enum mariadb_rpl_option option,
                               ...);

Parameters

Returns zero on success, non-zero if the option is not recognized.

Added in .

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

Syntax

#include <mariadb_rpl.h>

int mariadb_rpl_open(MARIADB_RPL *rpl);

Parameters

Return Value

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

History

Added in .

See Also

• mariadb_rpl_init()

Fetches the next event from an open binary log stream.

Syntax

#include <mariadb_rpl.h>

MARIADB_RPL_EVENT *mariadb_rpl_fetch(MARIADB_RPL *rpl,
                                      MARIADB_RPL_EVENT *event);

Parameters

Return Value

Returns a pointer to a MARIADB_RPL_EVENT structure containing the next event on success, or NULL when the EOF packet is received or an error occurs.

Note

Event memory must be freed by calling mariadb_free_rpl_event() when the event is no longer needed.

History

Added in .

See also

• mariadb_free_rpl_event()

• mariadb_rpl_extract_rows()

Frees the memory allocated for a MARIADB_RPL_EVENT structure returned by mariadb_rpl_fetch().

Syntax

#include <mariadb_rpl.h>

void mariadb_free_rpl_event(MARIADB_RPL_EVENT *event);

Parameters

Return Value

None

Notes

Avoid calling this function on an event pointer that will be passed back to mariadb_rpl_fetch() for reuse. Only call it when you are done processing the event and will not reuse the pointer.

History

Added in .

See Also

• mariadb_rpl_fetch()

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

Syntax

#include <mariadb_rpl.h>

void mariadb_rpl_close(MARIADB_RPL *rpl);

Parameters

Notes

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 mysql_close() separately after mariadb_rpl_close().

History

Added in .

See Also

• mariadb_rpl_init()

• mariadb_rpl_open()

MariaDB Connector/C functionality can be extended via loadable (or statically compiled in) plugins. As of the version 3.1.11 Connector/C comes with the following plugins

connection plugins

replication

pvio plugins

These plugins are used by the Connector/C to communicate with the MariaDB server.

socket

npipe

shmem

io plugins

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.

remote_io

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

auth plugins

These are authentication plugins. They are loaded automatically by the Connector/C when the server requests a specific authentication method.

mysql_native_password

dialog

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

client_ed25519

caching_sha2_password

sha256_password

auth_gssapi_client

mysql_old_password

mysql_clear_password

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: Curl libraries and include files

Linux / Mac OS X

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

• cmake 3.12.0 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.

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

or

cmake --build . --config Release

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

Syntax

#include <mysql.h>

int mariadb_field_attr(MARIADB_CONST_STRING *attr,
                        const MYSQL_FIELD *field,
                        enum mariadb_field_attr_t type)

Parameter

• attr: A pointer which returns extended metadata information

• field: Specifies the field which contains extended metadata information

• type: Specifies type of metadata information. Supported types are MARIADB_FIELD_ATTR_DATA_TYPE_NAME and MARIADB_FIELD_ATTR_FORMAT_NAME.

Returns extended metadata information for pluggable field types like JSON and GEOMETRY.

Returns zero on success or non zero if the field doesn't provide extended metadata information.

• Pluggable field type support is available in MariaDB server version 10.5.2 and later.

• To check if the server supports pluggable field types, check the extended server capabilities which can be obtained by api function .

mariadb_field_attr was added in MariaDB Connector/C 3.1.8.

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.

See Also

• mysql_real_connect()

• mysql_options()

Syntax

my_ulonglong mysql_affected_rows(MYSQL * mysql);

Parameter

• mysql is a connection identifier, which was previously allocated by mysql_init() or mysql_real_connect().

Description

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.

Return Value

Returns the number of affected rows or -1 on error.

See Also

• mysql_num_rows()

Syntax

my_bool mysql_autocommit(MYSQL * mysql, my_bool auto_mode);

Parameters

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

• auto_mode - whether to turn on or not.

Description

Toggles autocommit mode on or off for the current database connection. Autocommit mode will be set if mode=1 or unset if mode=0.

Return Value

Returns zero on success, or nonzero if an error occurred.

Syntax

my_bool mysql_change_user(MYSQL * mysql,
                          const char * user,
                          const char * passwd,
                          const char * db);

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

• user - the user name for server authentication

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

Description

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.

Return Value

Returns zero on success, nonzero if an error occurred.

See Also

• mysql_real_connect()

• mysql_select_db()

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.

See Also

• mysql_set_character_set()

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.

See Also

• mysql_init()

• mysql_real_connect()

Syntax

my_bool mysql_commit(MYSQL * mysql);

Parameter

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

Description

Commits the current transaction for the specified database connection.

Return Value

Returns zero on success, nonzero if an error occurred.

See Also

• mysql_rollback()

• mysql_autocommit()

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.

See Also

• mysql_num_rows()

• mysql_store_result()

Syntax

int mysql_dump_debug_info(MYSQL * mysql);

Parameter

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

Description

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.

Return Value

Returns zero on success, nonzero if an error occurred.

See Also

• mysql_debug()

• mysql_debug_end()

Syntax

unsigned int mysql_errno(MYSQL * mysql);

Parameter

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

Description

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

See Also

• mysql_error()

• mysql_sqlstate()

Syntax

const char * mysql_error(MYSQL * mysql);

Parameter

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

Description

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.

See Also

• mysql_errno()

• mysql_sqlstate().

Syntax

unsigned long mysql_escape_string(char * to,
                                  const char * from,
                                  unsigned long);

Description

Escapes a string using the default character set.

See Also

• mysql_real_escape_string()

Syntax

MYSQL_FIELD * mysql_fetch_field(MYSQL_RES * result);

Parameter

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

Description

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.

Return Value

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

See Also

• mysql_field_seek()

• mysql_field_tell()

• mysql_fetch_field_direct()

• mysql_store_result()

• mysql_use_result()

Syntax

MYSQL_FIELD * mysql_fetch_field_direct(MYSQL_RES * res,
                                       unsigned int fieldnr);

Parameters

• 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

Description

Returns a pointer to a MYSQL_FIELD structure which contains field information from the specified result set.

Return Value

Pointer to a MYSQL_FIELD structure. The caller must ensure that fieldnr is less than mysql_field_count(); specifying an out-of-range value results in undefined behavior, not a NULL return.

See Also

• mysql_fetch_field()

• mysql_field_count()

Syntax

MYSQL_FIELD * mysql_fetch_fields(MYSQL_RES * res);

Parameter

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

Description

This function serves an identical purpose to the mysql_fetch_field() 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.

Return Value

An array of type MYSQL_FIELD.

See Also

• mysql_fetch_field()

• mysql_fetch_field_direct()

• mysql_field_count()

Syntax

unsigned long * mysql_fetch_lengths(MYSQL_RES * result);

Parameter

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

Description

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.

Return Value

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

See Also

• mysql_fetch_row()

• mysql_field_count()

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.

See Also

• mysql_use_result()

• mysql_store_result()

Syntax

unsigned int mysql_field_count(MYSQL * mysql);

Parameter

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

Description

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.

Return Value

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

See Also

• mysql_store_result()

• mysql_use_result()

Syntax

MYSQL_FIELD_OFFSET mysql_field_seek(MYSQL_RES * result,
                                    MYSQL_FIELD_OFFSET offset);

Parameters

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

Description

Sets the field cursor to the given offset. The next call to mysql_fetch_field() will retrieve the field definition of the column associated with that offset.

Return Value

Returns the previous value of the field cursor.

See Also

• mysql_field_tell()

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

See Also

• mysql_field_seek()

Syntax

void mysql_free_result(MYSQL_RES * result);

Parameter

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

Description

Frees the memory associated with a result set.

Return Value

Returns void.

See Also

• mysql_store_result()

• mysql_use_result()

Syntax

void mysql_get_character_set_info(MYSQL * mysql,
                                  MY_CHARSET_INFO * charset);

Parameters

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

• charset - a pointer to a MY_CHARSET_INFO structure, in which the information will be copied.

Returns information about the current default for the specified connection.

Syntax

const char * mysql_get_client_info(void );

Description

Returns a string representing the client library version

See Also

• mysql_get_client_version()

• mysql_get_host_info()

• mysql_get_proto_info()

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

See Also

• mysql_get_client_info()

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.

See Also

• mysql_get_server_version()

Syntax

unsigned int mysql_get_proto_info(MYSQL * mysql);

Parameter

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

Description

Returns the protocol version number for the specified connection.

Return Value

The protocol version number in use.

See Also

• mysql_get_host_info()

Syntax

char * mysql_get_server_info(MYSQL * mysql);

Parameter

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

Description

Returns the server version or NULL on failure.

Return Value

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

See Also

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.

See Also

• mysql_get_server_info()

Syntax

const char *mysql_get_ssl_cipher(MYSQL *mysql)

Parameter

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

Description

Returns the name of the currently used cipher of the , or NULL for non TLS connections.

Return Value

Returns a zero terminated string containing the cipher suite used for a secure connection, or NULL if connection doesn't use TLS/SSL.

Notes

• For using mysql_get_ssl_cipher() MariaDB Connector/C must be built with TLS/SSL support, otherwise the function will return NULL.

• `mysql_get_ssl_cipher()' can be used to determine if the client server connection is secure.

• Depending on the TLS library in use (OpenSSL, GnuTLS or Windows Schannel) the name of the cipher suites may differ. For example the cipher suite 0x002F (TLS_RSA_WITH_AES_128_CBC_SHA) has different names: AES128-SHA for OpenSSL and Schannel and TLS_RSA_AES_128_CBC_SHA1 for GnuTLS.

See Also

• mysql_ssl_set()

Syntax

#include <mysql.h>

unsigned int mysql_get_timeout_value(const MYSQL *mysql);

Parameter

Description

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

Return Value

The timeout value in seconds as an unsigned int.

See Also

• mysql_get_timeout_value_ms()

• mariadb_get_infov()

Syntax

#include <mysql.h>

unsigned int mysql_get_timeout_value_ms(const MYSQL *mysql);

Parameter

Description

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

Return Value

The timeout value in milliseconds as an unsigned int.

See Also

• mysql_get_timeout_value()

• mariadb_get_infov()

Syntax

unsigned long mysql_hex_string(char * to,
                               const char * from,
                               unsigned long len);

Parameters

• to - result buffer

• from - the string which will be encoded

• len - length of the string (from)

Description

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

Return Value

Returns the length of the encoded string without the trailing null character.

See Also

• mysql_real_escape_string()

Syntax

const char * mysql_info(MYSQL * mysql);

Parameter

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

Description

The mysql_info() function returns a string providing information about the last query executed.

Return Value

Possible mysql_info return values. The nature of this string is provided below:

Syntax

MYSQL * mysql_init(MYSQL * mysql);

Parameter

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

Description

Prepares and initializes a MYSQL structure to be used with mysql_real_connect().

mysql_init() also ensures the client library is initialized, via a one-time internal initialization; it does not depend on mysql_thread_init(), which is a no-op retained for compatibility.

Return Value

The mysql_init() function returns an address of a MYSQL structure, or NULL in case of memory allocation error.

See Also

• mysql_real_connect()

• mysql_options()

• mysql_thread_init()

• mysql_close()

Syntax

my_ulonglong mysql_insert_id(MYSQL * mysql);

Parameter

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

Description

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.

Return Value

Returns the value of the modified column with AUTO_INCREMENT attribute. If the table doesn't contain an auto_increment column or no INSERT/UPDATE statement was executed, this function will return zero.

See Also

• mysql_stmt_insert_id()

Syntax

int mysql_kill(MYSQL * mysql,
               unsigned long pid);

Parameters

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

• unsigned long - process id

Description

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.

Return Value

Returns 0 on success, otherwise error on nonzero.

See Also

• mysql_thread_id()

• mysql_close()

• mariadb_cancel()

Syntax

#include <mysql.h>

struct st_mysql_client_plugin *
mysql_load_plugin(struct st_mysql *mysql, const char *name, int type,
                  int argc, ...);

Parameters

mysql_load_plugin searches the client plugin directory for a plugin matching the given name and type, loads it, and calls its initialization function with any supplied arguments. If a plugin with that name is already loaded, the call fails and returns NULL (error "it is already loaded").

• MYSQL_CLIENT_AUTHENTICATION_PLUGIN

• MARIADB_CLIENT_PVIO_PLUGIN

• MARIADB_CLIENT_REMOTEIO_PLUGIN

A pointer to the plugin handle, or NULL if an error occurred.

Syntax

void mysql_library_end(void)

Description

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.

See Also

• mysql_library_init()

Syntax

int mysql_library_init(int argc, char **argv, char **groups)

Description

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 mysql_library_end() to clean up after completion.

See Also

• mysql_library_end()

Syntax

my_bool mysql_more_results(MYSQL * mysql);

Parameter

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

Description

Indicates if one or more result sets are available from a previous call to mysql_real_query().

Return Value

Returns 1 if more result sets are available, otherwise zero..

See Also

• mysql_real_query()

• mysql_use_result()

• mysql_store_result()

• mysql_next_result()

Syntax

int mysql_next_result(MYSQL * mysql);

Parameter

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

Description

Prepares next result set from a previous call to mysql_real_query() which can be retrieved by mysql_store_result() or mysql_use_result().

Return Value

Returns zero on success, nonzero if an error occurred.

See Also

Syntax

unsigned int mysql_num_fields(MYSQL_RES * );

Parameter

• MYSQL RES * - A result set identifier returned by mysql_store_result() or mysql_use_result().

Description

Returns number of fields in a specified result set.

Return Value

Returns number of fields.

See Also

• mysql_fetch_field()

• mysql_field_count()

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.

See Also

• mysql_affected_rows()

• mysql_use_result()

• mysql_store_result()

Syntax

#include <mysql.h>

int mysql_options4(MYSQL *mysql,
                   enum mysql_option option,
                   const void *arg1,
                   const void *arg2);

Parameters

Description

mysql_options4 is used to set extra connect options and affect behavior for a connection. This function may be called multiple times to set several options. It must be called after mysql_init() and before mysql_real_connect().

Return Value

Returns zero on success, non-zero if the option is unknown or the value is invalid.

Options

An overview of the possible options can be found in the description of the mysql_optionsv() API function.

See Also

• mysql_optionsv()

• mysql_options()

• mysql_real_connect()

Syntax

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

Parameters

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

See .

Syntax

int mysql_ping(MYSQL * mysql);

Parameter

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

Description

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.

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.

Return Value

Returns zero on success, nonzero if an error occurred.

See Also

Syntax

int mysql_query(MYSQL * mysql,
                const char * query);

Parameters

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

• query -a null terminated string containing the statement to be performed.

Description

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

Quickstart Guide: MariaDB Connector/Node.js

MariaDB Connector/Node.js is a client library that enables Node.js applications to connect and interact with MariaDB and MySQL databases. It's built natively in JavaScript and supports both Promise and Callback APIs, with the Promise API being the default and recommended approach. It is licensed under the LGPL.

1. Installation

The easiest way to install MariaDB Connector/Node.js is using npm (Node Package Manager):

npm install mariadb

2. Basic Usage (Promise API - Recommended)

The Promise API simplifies asynchronous operations with async/await. For optimal performance and resource management, it's recommended to use a connection pool.

a. Create a Connection Pool:

const mariadb = require('mariadb');
const pool = mariadb.createPool({
    host: 'localhost',
    port: 3306,
    user: 'your_username',
    password: 'your_password',
    database: 'your_database_name',
    connectionLimit: 5 // Adjust as needed
});

console.log("Connection pool created.");

Replace localhost, 3306, your_username, your_password, and your_database_name with your actual database details.

b. Perform Database Operations:

Here's an async function example to get a connection, execute queries, and release the connection back to the pool.

If you need compatibility with older Node.js database drivers (mysql, mysql2), you can use the Callback API.

• Error Handling: Always include robust error handling (try...catch for Promises, if (err) for Callbacks) in your database interactions.

• Parameterized Queries: Always use parameterized queries (e.g., WHERE status = ?, VALUES (?, ?)) to prevent SQL injection attacks.

Quickstart Guide: MariaDB Connector/NET (MySqlConnector)

MariaDB Connector/NET, also known as MySqlConnector, is an ADO.NET data provider that enables .NET applications to connect and interact with MariaDB and MySQL databases. It's written entirely in C# and offers high performance and features specific to MariaDB Server.

1. Overview and Features