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.

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

or via command line

Syntax

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

Syntax

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

Description

Syntax

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

MariaDB Connector/C Quickstart Guide

This guide will help you quickly get started with MariaDB Connector/C, the client library used to connect C/C++ applications to MariaDB and MySQL databases. It's LGPL licensed and is being integrated directly into MariaDB Server distributions.

Installation

MariaDB Connector/C is often distributed with MariaDB Server packages, but you can also install it separately.

Download Packages

You can download MariaDB Connector/C packages directly:

• From the downloads page: Select your desired version from the main MariaDB Connector/C download page.

• By product selection: Choose "C/C++ connector" as the Product on the MariaDB downloads page.

Install with a Package Manager (Recommended for Linux)

If you're using Linux, the simplest way to install MariaDB Connector/C is via your system's package manager. Your system needs to be configured to install from a MariaDB repository (version 10.2 or later).

You can set up your repository using:

• MariaDB Corporation's .

• MariaDB Foundation's .

Install with yum/dnf (RHEL, CentOS, Fedora)

For RHEL, CentOS, Fedora, and similar distributions, use yum or dnf:

To install the shared library:

To install the development package (if you're building applications):

Install with apt-get (Debian, Ubuntu)

For Debian, Ubuntu, and similar distributions, use apt-get:

To install the shared library:

To install the development package (if you're building applications):

Install with zypper (SLES, OpenSUSE)

For SLES, OpenSUSE, and similar distributions, use zypper:

To install the shared library:

To install the development package (if you're building applications):

Install on Windows

MariaDB Connector/C for Windows is distributed as MSI packages. The installation process is straightforward, with both 32-bit and 64-bit MSI packages available.

Install from Source

If you prefer to build from source, refer to the documentation.

API Reference

MariaDB Connector/C provides an API that is compatible with MySQL Connector/C for MySQL 5.5.

You can find the function reference at:

An HTML version is also available for download in mariadb-client-doc.zip.

Configuration with Option Files

Similar to MariaDB Server, MariaDB Connector/C can read configuration options from client option groups in option files.

For detailed information, see .

Known Issues

Be aware of these potential limitations:

• Double-to-string conversion for prepared statements may not work correctly.

• Connector versions 3.0.7 and below do not support MySQL 8.0's default authentication protocol, caching_sha2_password. This should be supported in Connector/C 3.0.8 and above.

Need Help or Want to Contribute?

• Report Bugs: If you encounter a bug, please report it via the .

• Source Code: The source code is available on GitHub in the .

License

GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

For licensing questions, see the .

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

aurora

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 2.8.12 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

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

Syntax

my_ulonglong mysql_affected_rows(MYSQL * mysql);

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.

See also

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

Returns zero on success, nonzero if an error occured.

Syntax

unsigned int mysql_errno(MYSQL * mysql);

• 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

Syntax

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

See also

Syntax

MYSQL_FIELD_OFFSET mysql_field_seek(MYSQL_RES * result,
                                    MYSQL_FIELD_OFFSET offset);

• 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 will retrieve the field definition of the column associated with that offset.

Returns the previous value of the field cursor.

See also

Syntax

const char * mysql_get_client_info(void );

Description

Returns a string representing the client library version

See also

Syntax

const char *mysql_get_ssl_cipher(MYSQL *mysql)

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

See also

Syntax

my_bool mysql_more_results(MYSQL * mysql);

• 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 . Returns 1 if more result sets are available, otherwise zero. .

See also

Syntax

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

• to - result buffer

• from - the string which will be encoded

• len - length of the string (from)

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

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

See also

Syntax

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

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

See also

Syntax

void mysql_server_init(void );

Description

mysql_server_init() is an alias for mysql_library_init().

See also

Syntax

void mysql_free_result(MYSQL_RES * result);

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

Description

Frees the memory associated with a result set. Returns void.

See also

Syntax

int mysql_read_query_result(MYSQL * mysql);

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

Returns zero on success, otherwise non-zero.

Description

mysql_read_query_result() reads the result of a SQL statement executed with . If the SQL statement returned a resultset, it must be freed before the next call to mysql_read_query_result() is made. This is similar to how results from must be processed before another call can be made.

Syntax

void mysql_close(MYSQL * mysql);

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

Description

Closes a previously opened connection.

Syntax

void mysql_server_end(void );

Description

mysql_server_end() is an alias for mysql_library_end().

See also

Syntax

void mysql_data_seek(MYSQL_RES * result,
                     my_ulonglong offset);

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

• offset - the field offset. Must be between zero and the total number of rows minus one (0..mysql_num_rows - 1).

Description

The mysql_data_seek() function seeks to an arbitrary function result pointer specified by the offset in the result set. Returns zero on success, nonzero if an error occurred.

Syntax

my_bool mysql_commit(MYSQL * mysql);

• 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. Returns zero on success, nonzero if an error occurred.

See also

Syntax

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

Description

Escapes a string using the default character set.

See also

Syntax

unsigned long mysql_get_server_version(MYSQL * mysql);

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

See also

Syntax

MYSQL_FIELD_OFFSET mysql_field_tell(MYSQL_RES * result);

• 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 call. This value can be used as a parameter for the function .

Returns the current offset of the field cursor

See also

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

See also

Syntax

int mariadb_cancel(MYSQL * mysql);

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

mariadb_cancel() was added in Connector/C 3.0

Syntax

unsigned long mysql_get_client_version(void);

Description

Returns a number representing the client library version.

See also

Syntax

const char * mysql_stat(MYSQL * mysql);

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

Description

mysql_stat() returns a string with the current server status for uptime, threads, queries, open tables, flush tables and queries per second.

See also

Syntax

int mysql_shutdown(MYSQL * mysql,
  enum mysql_enum_shutdown_level);

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

• mysql_enum_shutdown_level - currently only one shutdown level, SHUTDOWN_DEFAULT is supported.

Description

Sends a shutdown message to the server. To shut down the database server, the user for the current connection must have SHUTDOWN privileges.

Returns zero on success, non-zero on failure.

See also

Syntax

MYSQL_ROW_OFFSET mysql_row_tell(MYSQL_RES * res);

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

Description

Returns the row offset of a result cursor. The returned offset value can be used to reposition the result cursor by calling .

See also

Syntax

const char * mysql_get_host_info(MYSQL * mysql);

• 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. Returns a string, or NULL if the connection is not valid.

See also

Name

mysql_set_local_infile_default - Sets local infile callback functions to default

Synopsis

#include <mysql.h>

void mysql_set_local_infile_default(MYSQL *conn);

Description

Sets local infile callback functions to MariaDB Connector/C internal default callback functions.

Parameter

• mysql - mysql handle, which was previously allocated by

See also

Syntax

const char * mysql_get_server_info(MYSQL * mysql);

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

Description

Returns the server version or NULL on failure.

See also

Syntax

unsigned int mysql_get_proto_info(MYSQL * mysql);

• 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

See also

These are currently documented on the github wiki.

Syntax

int mysql_send_query(MYSQL * mysql,
                     const char * query,
                     unsigned long length);

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

• query - the query to execute.

• length - length of query.

Returns zero on success, otherwise non-zero.

Description

mysql_send_query() executes a SQL statement without waiting for the result. The main purpose of this function is to perform batch execution of DML statements.

Each successful call tomysql_send_query() must be followed by a call to . Multiple calls to mysql_send_query() can be made before the calls to are done.

Syntax

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

Syntax

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

Syntax

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

Syntax

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

• enum_mysql_set_option

Syntax

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

Syntax

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

Syntax

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

Syntax

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

Syntax

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

• key

Syntax

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

• db

Syntax

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

• long

Syntax

• result - a result set identifier returned by or .

Syntax

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

• to

Syntax

• result - a result set identifier returned by .

• offset

Syntax

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

Syntax

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.

Syntax

• MYSQL RES * - A result set identifier returned by or .

Syntax

• res - a result set identifier returned by or .

Syntax

Description

The mysql_thread_end() function needs to be called before a client thread ends. It will release thread-specific memory, which was allocated by a previous

Syntax

int mysql_dump_debug_info(MYSQL * mysql);

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

Returns zero on success, nonzero if an error occurred.

See also

• mysql_debug_end()

Syntax

• 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. The nature of this string is provided below:

Table 1. Possible mysql_info return values

See also

Syntax

my_ulonglong mysql_insert_id(MYSQL * mysql);

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

See also

Syntax

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

• options - a bit masked composed integer. See below.

Description

Flushes different types of information stored on the server. The bit-masked parameter options specify which kind of information will be flushed. options can be any combination of the following:

Returns zero on success, otherwise nonzero.

Syntax

• 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_query() is not binary safe.

Returns zero on success, non zero on failure

See also

Syntax

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

Description

Resets the current connection and clears session state. Similar to or , mysql_reset_connection() resets session status, but without disconnecting, opening, or reauthenticating.

On client side mysql_reset_connection()

• clears pending or unprocessed result sets

• clears status like affected_rows, info or last_insert_id

• invalidates active prepared statements

On server side mysql_reset_connection()

• drops temporary table(s)

• rollbacks active transaction

• resets auto commit mode

• releases table locks

Returns zero on success, non-zero if an error occurred.

This function was added in MariaDB Connector/C 3.0.0.

Syntax

int mysql_ping(MYSQL * mysql);

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

Returns zero on success, nonzero if an error occured.

This function can be used by clients that remain idle for a long while, to check whether the server has closed the connection and reconnect if necessary.

See also

Syntax

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

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

• long - length of the string.

Description

mysql_real_query() is a binary-safe function for executing a statement on the database server. Returns zero on success, otherwise non-zero.

See also

Syntax

MYSQL_ROW mysql_fetch_row(MYSQL_RES * result);

• 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

Syntax

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

• type - type of information. Valid values are

  • SESSION_TRACK_SYSTEM_VARIABLES

  • SESSION_TRACK_SCHEMA

  • SESSION_TRACK_STATE_CHANGE

• data - pointer to data, which must be declared as const char *

• length - pointer to a size_t variable, which will contain the length of data

Description

mysql_session_track_get_next() retrieves the session status change information received from the server after a successful call to .

mysql_session_track_get_next() needs to be called repeatedly until a non-zero return value indicates the end of data.

mysql_session_track_get_next() was added in Connector/C 3.0 and MariaDB Server 10.2.

Returns

Zero for success, nonzero if an error occurred.

See also

Syntax

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

• host - can be either a host name or an IP address. Passing the NULL value or the string "localhost" to this parameter, the local host is assumed. When possible, pipes will be used instead of the TCP/IP protocol.

• user - the user name.

• passwd - If provided or NULL, the server will attempt to authenticate the user against those user records which have no password only. This allows one username to be used with different permissions (depending on if a password as provided or not).

• db - if provided will specify the default database to be used when performing queries.

• port - specifies the port number to attempt to connect to the server.

• unix_socket - specifies the socket or named pipe that should be used.

• flags - the flags allows various connection options to be set:

  • CLIENT_FOUND_ROWS: Return the number of matched rows instead of number of changed rows.

  • CLIENT_NO_SCHEMA: Forbids the use of database.tablename.column syntax and forces the SQL parser to generate an error.

Description

Establishes a connection to a database server. Returns a MYSQL * handle or NULL if an error occurred.

See also

Syntax

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

Description

The mysql_thread_id() function returns the thread id for the current connection.

See also

Syntax

my_bool mysql_thread_init(void );

Description

Thread initialization for multi-threaded clients. Multi-threaded clients should call mysql_thread_init() at the beginning of the thread initialization to initialize thread specific client library variables. If _{mysql_thread_init()} was not called explicitly, it will be called automatically by or .

Returns zero if successful or 1 if an error occurred.

See also

Syntax

const char * mysql_sqlstate(MYSQL * mysql);

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

Description

Returns a string containing the error code for the most recently invoked function that can succeed or fail. The error code consists of five characters. '00000' means no error. The values are specified by ANSI SQL and ODBC

See also

Name

mysql_set_local_infile_handler - Registers callback functions for LOAD DATA LOCAL INFILE

Synopsis

Description

Registers four callback functions which will be called if a LOAD DATA LOCAL INFILE command will be executed.

The initialization function accepts 3 parameters and returns zero on success, nonzero on error. It allocates an handle, which will be passed to read, end and error functions:

int init(void **handle, const char *filename, void *userdata)

The read function is called repeatly to read data chunks from file into buffer. The amount of bytes is limited by parameer buffer_len. The function returns the number of bytes which were read from the file:

int mysql_local_infile_read(void *handle, char * buffer, unsigned int buffer_len)

The end function will be called after the read function returned zero (no more bytes to read). To prevent leaking of resources, the file must be closed and handle must be freed inside this function:

void end(void *handle);

The error function is called to get an error message in case init, read or end functions returned an error.

error(void *handler, char *error_buf, unsigned int error_buf_len);

Parameter

• mysql - mysql handle, which was previously allocated by

• local_infile_init - initialization function, e.g. for opening the file

• local_infile_read - read function

See also

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.

Quickstart Guide: MariaDB Connector/J

MariaDB Connector/J is the official Java Database Connectivity (JDBC) driver for connecting Java applications to MariaDB and MySQL databases. It allows Java programs to interact with databases using the standard JDBC API.

See About MariaDB Connector/J for full content.

1. Installation

You can include MariaDB Connector/J in your project using build tools like Maven or Gradle, or by manually adding the JAR file to your project's classpath.

a. Using Maven:

Add the following dependency to your pom.xml file:

b. Using Gradle:

Add the following dependency to your build.gradle file:

c. Manual Installation:

1. Download the latest stable .jar file from the .

2. Add the downloaded .jar file to your project's classpath.

2. Basic Usage (Connecting to MariaDB)

Here's a simple Java example demonstrating how to establish a connection and execute a basic query using DriverManager.

Before Running:

1. Replace your_database_name, your_username, your_password, and your_table_name with your actual database details.

2. Ensure you have a MariaDB server running and a database/table set up.

3. Connection Strings

MariaDB Connector/J supports various connection string formats, including options for failover and load balancing. The basic format is:

jdbc:mariadb://<hostDescription>[,<hostDescription>...]/[database][?<key1>=<value1>[&<key2>=<value2>]]

For example:

• jdbc:mariadb://localhost:3306/mydb

• jdbc:mariadb://server1:3306,server2:3306/mydb?failover=true

4. Connection Pooling (for Production)

For production applications, it's highly recommended to use a connection pool to manage database connections efficiently. MariaDB Connector/J can be used with external connection pooling libraries like HikariCP or Apache Commons DBCP, or its own MariaDbPoolDataSource.

• MariaDbDataSource: Creates a new connection each time.

• MariaDbPoolDataSource: Maintains a pool of connections for reuse.

When using an external pool, configure it to use org.mariadb.jdbc.Driver as the JDBC driver class.

MariaDB Connector/R2DBC allows Java developers to connect to MariaDB and MySQL databases using the Reactive Relational Database Connectivity (R2DBC) API. This enables non-blocking, asynchronous database operations, which are beneficial for building scalable and responsive applications.

1. Installation

Add the necessary dependency to your project's pom.xml (Maven) or build.gradle (Gradle) file. Choose the dependency based on the R2DBC Specification you are targeting.

a. For R2DBC 1.0.0 Specification (Recommended for new projects):

XML

Gradle

b. For R2DBC 0.9.1 Specification (for compatibility):

XML

Gradle

2. Basic Usage (Native R2DBC)

This example demonstrates how to establish a connection, execute a query, and process results using the reactive API.

Code snippet

Before Running:

1. Replace your_username, your_password, your_database_name, and your_table_name with your actual MariaDB server details.

2. Ensure you have a MariaDB server running and a database/table set up.

3. Add reactor-core dependency if not already present, as R2DBC heavily relies on Project Reactor.

3. Connection Strings

MariaDB Connector/R2DBC supports a standard R2DBC URL format for connection:

r2dbc:mariadb://[username[:password]@]host[:port][/database][?option=value]

Example:

r2dbc:mariadb://user:pass@localhost:3306/mydb?useBatchMultiSend=true

4. Spring Data R2DBC

MariaDB Connector/R2DBC also integrates seamlessly with the Spring Data R2DBC framework, providing a higher-level abstraction for reactive database access, including repositories and entity mapping.

Further Resources:

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

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

MySqlConnector is licensed under the MIT License. It provides robust connectivity with features like:

• Zero-configuration SSL: For MariaDB Server 11.4+.

• Server Redirection Logic: Based on the latest MariaDB specification for MariaDB Server 11.3+.

• Optimized SET NAMES handling: Avoids unnecessary commands for MariaDB Server 11.5+.

2. Installation

The recommended way to install MySqlConnector is via NuGet.

a. Using NuGet Package Manager Console (in Visual Studio):

b. Using PackageReference (in your .csproj file):

3. Basic Usage

This section provides C# examples for connecting to MariaDB and performing common database operations.

a. Connection String:

A connection string defines how your application connects to the database. Replace placeholder values with your actual database details.

b. Opening and Closing a Connection:

Always ensure connections are properly opened and closed. The using statement is recommended as it ensures the connection is disposed of correctly, even if errors occur.

c. Executing a SELECT Query:

Use MySqlCommand to define your SQL query and ExecuteReaderAsync to retrieve data.

d. Executing INSERT/UPDATE/DELETE Queries:

Use ExecuteNonQueryAsync for operations that do not return a result set (like INSERT, UPDATE, DELETE). Always use parameterized queries to prevent SQL injection vulnerabilities.

Quickstart Guide: MariaDB Connector/ODBC

MariaDB Connector/ODBC is a database driver that allows applications to connect to MariaDB and MySQL databases using the Open Database Connectivity (ODBC) API. It's fully compliant with the ODBC 3.5 standard, open-source (LGPL), and can serve as a drop-in replacement for MySQL Connector/ODBC. It supports both Unicode and ANSI modes and communicates primarily using the MariaDB/MySQL binary protocol.

1. What is ODBC?

ODBC (Open Database Connectivity) is a standard API for accessing database management systems (DBMS). It provides a common way for applications to communicate with different databases, abstracting away the specifics of each database's native communication protocol. MariaDB Connector/ODBC acts as the specific bridge for MariaDB.

2. Installation

Installation typically involves downloading the appropriate driver package for your operating system and configuring a Data Source Name (DSN).

a. Windows:

1. Download: Go to the and download the appropriate .msi installer for your Windows version (32-bit or 64-bit).

2. Run Installer: Execute the downloaded .msi file and follow the on-screen instructions. This will install the necessary driver files.

3. Configure DSN:

b. Linux / macOS:

1. Download: Download the appropriate .deb, .rpm, or .pkg package from the .

2. Install Package:

   • Debian/Ubuntu: sudo dpkg -i mariadb-connector-odbc_X.Y.Z.deb

3. Basic Usage (Connecting from Applications)

Once the MariaDB ODBC driver is installed and a DSN is configured, applications can connect to your MariaDB database using the standard ODBC API. The exact code will vary depending on the programming language and framework you are using (e.g., C++, Java with JDBC-ODBC Bridge, Python with pyodbc, PHP with odbc extension).

a. Connecting via DSN (Common for many applications):

Many applications and tools (like Microsoft Excel, reporting tools, or C++ applications using ODBC) will allow you to select a configured DSN directly.

b. Connecting via DSN-less Connection String:

You can also provide a full connection string directly in your application without pre-configuring a DSN. This is often used in scripting languages or when you need more dynamic control.

Replace {MariaDB ODBC Driver} with the exact driver name from your odbcinst.ini if different.

Further Resources:

Quickstart Guide: MariaDB Connector/Ruby (using mysql2 gem)

While there isn't a separate "MariaDB Connector/Ruby" gem, the widely used mysql2 gem serves as the primary and highly compatible Ruby client for connecting to both MariaDB and MySQL databases. It provides a robust API for database interactions in Ruby applications.

1. Overview

The mysql2 gem provides a Ruby interface to the MariaDB/MySQL C client library (either libmysqlclient or MariaDB Connector/C). It allows Ruby applications to execute SQL queries, fetch results, and manage database connections efficiently. It's available on .

2. Installation

Before installing the mysql2 gem, you might need to install development libraries for MariaDB Connector/C or MySQL Client on your system.

a. Install System Dependencies (e.g., on Debian/Ubuntu):

On other systems (Fedora, CentOS, macOS), the package names might differ (e.g., mariadb-devel, mysql-devel).

b. Install the mysql2 gem:

Once the system dependencies are in place, install the gem using Bundler (recommended for Rails/Gemfile projects) or directly via gem install:

3. Basic Usage

Here's how to connect to MariaDB and perform common database operations using the mysql2 gem:

a. Connect to the Database:

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

b. Execute a SELECT Query:

The results object behaves like an enumerable, allowing you to iterate over rows. Column names are accessible as hash keys.

c. Execute INSERT/UPDATE/DELETE Queries:

For data manipulation, use query. For safety, always use prepared statements or proper escaping for user-provided input.

d. Prepared Statements (Recommended for security and performance):

Prepared statements allow you to separate the SQL query structure from the data, preventing SQL injection and improving performance for repeated queries.

Before Running:

1. Ensure you have a MariaDB server running and a database/table set up.

2. Replace placeholder values with your actual database credentials and table/column names.

Important Notes:

• Error Handling: Always wrap your database operations in begin...rescue...end blocks to catch Mysql2::Error exceptions.

• Connection Closing: Ensure your Mysql2::Client connection is closed using client.close in a ensure block to release database resources.

Further Resources:

Syntax

• mysql - a mysql handle, which was previously allocated by mysql_init() or mysql_real_connect(). For general information which is not bound to connection this parameter might be null.

• value - the type of value you want to retrieve. See description below.

• arg - pointer to a variable for storing value of the specified option.

• ... - variable argument list

Description

Retrieves generic or connection specific information. Returns zero on success, non-zero if an error occurred (invalid option), This function was added in MariaDB Connector/C 3.0,

Value types

Generic information

For these information types of parameters mysql needs to be set to NULL.

• MARIADB_CHARSET_NAME: Retrieves the charset information for a character set by its literal representation.Parameter type: const MARIADB_CHARSET_INFO*.

• MARIADB_CLIENT_ERRORS: Retrieve array of client errors. This can be used in plugins to set global error messages (which are not exported by MariaDB Connector/C).Parameter type: const char **.

• MARIADB_CLIENT_VERSION

Connection related information

• MARIADB_CONNECTION_ASYNC_TIMEOUT: Retrieves the timeout for non-blocking calls in seconds.Parameter type: unsigned int.

• MARIADB_CONNECTION_ASYNC_TIMEOUT_MS: Retrieves the timeout for non-blocking calls in milliseconds.Parameter type: unsigned int.

• MARIADB_CONNECTION_MARIADB_CHARSET_INFO

Examples

See also

Syntax

• debug - a string representing the debug operation to perform. See description below.

Description

Enables debug output for development and debug purposes by using Fred Fish's DBUG library. For using this function the mariadb-client library must be compiled with debug support.

Almost all MariaDB binaries use the DBUG library and one can get a trace of the program execution by using the command line option with the binary. This will only work if the binary is compiled for debugging (compiler option -DDBUG_ON).

Returns void.

The debug control string is a sequence of colon separated fields as follows:

Each field consists of a mandatory flag character followed by an optional "," and comma separated list of modifiers:

The currently recognized flag characters are:

See also

• mysql_debug_end()

Syntax

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

• mysql_option - the option you want to retrieve. See description below.

• arg - pointer to a variable for storing value of the specified option.

• ... - variable argument list

Description

Retrieves the value for a given option which was previously set by .

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

This function was added in MariaDB Connector/C 3.0.0.

Options

Boolean values (my_bool)

• MYSQL_OPT_COMPRESS

• MYSQL_OPT_NAMED_PIPE

• MYSQL_OPT_RECONNECT

• MYSQL_REPORT_DATA_TRUNCATION

Integer values

• MYSQL_OPT_CONNECT_TIMEOUT

• MYSQL_OPT_READ_TIMEOUT

• MYSQL_OPT_WRITE_TIMEOUT

• MYSQL_OPT_LOCAL_INFILE

Character arrays

• MYSQL_INIT_COMMAND

Character values

• MYSQL_READ_DEFAULT_FILE

• MYSQL_READ_DEFAULT_GROUP

• MYSQL_SET_CHARSET_NAME

• MYSQL_PLUGIN_DIR

Misc

• MYSQL_PROGRESS_CALLBACK: requires a function pointer *(const MYSQL *, uint, uint, double, const char *, uint))arg)

• MYSQL_CONNECT_ATTRS: this option requires 5 parameters:

• MARIADB_OPT_USERDATA: retrieves userdata for a given key.

See also

Syntax

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

Description

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

Options

See .

See also

MariaDB Connector/C is used to connect applications developed in C/C++ to MariaDB and MySQL databases.The client library is LGPL licensed.

Integration with MariaDB Server

MariaDB Connector/C is distributed with MariaDB Server packages. Eventually, it will completely replace the functionality that has traditionally been performed by libmysqlclient in those packages. Currently, MariaDB Connector/C has replaced libmysqlclient as the client library for client utilities that are distributed with MariaDB Server. See for more information.

Configuration settings

Connector/C specifies its build process with platform-independent CMake listfiles included in each directory of a source tree with the name CMakeLists.txt. Configuration settings may be specified by passing the -D option to CMake command line interpreter.

Do not build Connector/C from the root of the source tree: Either create a subdirectory "build" inside the source tree or create a subdirectory outside of the source tree.

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

Then, run rebar3 compile