MySQL client library built on top of Boost.Asio.
|Branch||Windows/Linux Build||OSX build||Coverage||Documentation|
||Docs for master|
||Docs for develop|
Boost.MySQL is a C++11 client for MySQL and MariaDB database servers, based on Boost.Asio. Boost.MySQL is part of Boost.
Do you have any suggestion? Would you like to share a bad or good experience while using the library? Please comment on this issue.
Why another MySQL C++ client?
- It is fully compatible with Boost.Asio and integrates well with any other library in the Boost.Asio ecosystem (like Boost.Beast).
- It supports Boost.Asio's universal asynchronous model, which means you can go asynchronous using callbacks, futures or coroutines (including C++20 coroutines).
- It is written in C++11 and takes advantage of it.
- It is header only.
Using the library
To use this library, you need:
- Boost 1.82 or higher (Boost.MySQL doesn't work with standalone Asio).
- A C++11 capable compiler.
The library is header-only, but it depends on other Boost header-only libraries and on OpenSSL.
To use the library, install Boost the way you would normally do (e.g. via
b2 install), and create
CMakeLists.txt like this (replace
main by your executable name and
main.cpp by your list of source files):
project(boost_mysql_example LANGUAGES CXX) find_package(Boost REQUIRED COMPONENTS headers) find_package(Threads REQUIRED) find_package(OpenSSL REQUIRED) add_executable(main main.cpp) target_link_libraries(main PRIVATE Boost::headers Threads::Threads OpenSSL::Crypto OpenSSL::SSL)
Boost.MySQL has been tested with the following compilers:
- gcc 5 to 13.
- clang 3.6 to 16.
- msvc 14.1, 14.2 and 14.3.
And with the following databases:
- MySQL v5.7.41.
- MySQL v8.0.33.
- MariaDB v11.0.
- Text queries (execution of text SQL queries and data retrieval). MySQL refers to this as the "text protocol", as all information is passed using text (as opposed to prepared statements, see below).
- Prepared statements. MySQL refers to this as the "binary protocol", as the result of executing a prepared statement is sent in binary format rather than in text.
- Stored procedures.
- Authentication methods (authentication plugins): mysql_native_password and caching_sha2_password. These are the default methods in MySQL 5 and MySQL 8, respectively.
- Encrypted connections (TLS).
- TCP and UNIX socket connections. The implementation is based on Boost.Asio SyncStream and AsyncStream concepts, so it is generic and can be used with any stream that fulfills these concept's requirements. There are user-friendly typedefs and regression tests for TCP and UNIX socket streams.