mirror of
https://github.com/boostorg/mysql.git
synced 2026-01-19 16:32:12 +00:00
d66156ab61
* Added coverage to fill the gaps between compiler versions for clang and gcc under Linux * Added clang-19 and clang-20 builds * Added a gcc-15 build * Replaced the old clang 3.6 build by clang 3.8 close #478 close #477 close #476
84 lines
3.9 KiB
Markdown
84 lines
3.9 KiB
Markdown
# Boost.MySQL
|
|
|
|
Branch | Windows/Linux Build | OSX build | Coverage | Documentation
|
|
-------|---------------------|-----------|--------- | -------------
|
|
[`master`](https://github.com/boostorg/mysql/tree/master) | [](https://drone.cpp.al/boostorg/mysql) | [](https://github.com/boostorg/mysql) | [](https://codecov.io/gh/boostorg/mysql/branch/master) | [Docs for master](https://www.boost.org/doc/libs/master/libs/mysql/doc/html/index.html)
|
|
[`develop`](https://github.com/boostorg/mysql/tree/develop) | [](https://drone.cpp.al/boostorg/mysql) | [](https://github.com/boostorg/mysql) | [](https://codecov.io/gh/boostorg/mysql/branch/develop) | [Docs for develop](https://www.boost.org/doc/libs/develop/libs/mysql/doc/html/index.html)
|
|
|
|
Boost.MySQL is a C++11 client for MySQL and MariaDB database servers, based on Boost.Asio.
|
|
Boost.MySQL is part of Boost.
|
|
|
|
## Breaking changes in Boost 1.85
|
|
|
|
Boost.MySQL now requires linking with Boost.Charconv, which is a compiled library.
|
|
If you're getting link errors, link your executable to the `Boost::charconv` CMake target.
|
|
No C++ code changes are required.
|
|
|
|
## Feedback
|
|
|
|
Do you have any suggestion? Would you like to share a bad or good experience while using the library?
|
|
Please comment [on this issue](https://github.com/boostorg/mysql/issues/140).
|
|
|
|
## 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.
|
|
- OpenSSL.
|
|
|
|
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
|
|
a `CMakeLists.txt` like this (replace `main` by your executable name and `main.cpp` by your list of source files):
|
|
|
|
```cmake
|
|
project(boost_mysql_example LANGUAGES CXX)
|
|
|
|
find_package(Boost REQUIRED COMPONENTS charconv)
|
|
find_package(Threads REQUIRED)
|
|
find_package(OpenSSL REQUIRED)
|
|
|
|
add_executable(main main.cpp)
|
|
target_link_libraries(main PRIVATE Boost::charconv Threads::Threads OpenSSL::Crypto OpenSSL::SSL)
|
|
```
|
|
|
|
## Tested with
|
|
|
|
Boost.MySQL has been tested with the following compilers:
|
|
|
|
- gcc 5 to 15.
|
|
- clang 4 to 20.
|
|
- msvc 14.1, 14.2 and 14.3.
|
|
|
|
And with the following databases:
|
|
|
|
- MySQL v5.7.41.
|
|
- MySQL v8.4.1.
|
|
- MariaDB v11.4.2.
|
|
|
|
## Features
|
|
|
|
- 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/MariaDB and MySQL 8,
|
|
respectively.
|
|
- Encrypted connections (TLS).
|
|
- TCP and UNIX socket transports.
|
|
- Connection pools.
|
|
- Friendly client-side generated SQL.
|
|
- (Experimental) pipelines.
|