mirror of
https://github.com/boostorg/mysql.git
synced 2025-05-11 21:53:59 +00:00
Revert "Added a warning on the API being experimental"
This reverts commit 06357f17d153d2578c61ef507825c431097b03b5.
This commit is contained in:
Ruben Perez
parent
06357f17d1
commit
b63eaf761e
30
README.md
30
README.md
@ -1,21 +1,14 @@
|
||||
# Boost.MySQL (to be released in Boost 1.82)
|
||||
|
||||
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)
|
||||
Branch | Windows/Linux Build | OSX build | Coverage
|
||||
-------|---------------------|-----------|---------
|
||||
[`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)
|
||||
[`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)
|
||||
|
||||
Boost.MySQL is a C++11 client for the MySQL database server, based on Boost.Asio.
|
||||
Boost.Mysql is a C++11 client for the MySQL database server, based on Boost.Asio.
|
||||
This library is in the process of being proposed for Boost.
|
||||
|
||||
## Preview release in 1.82
|
||||
|
||||
Boost.MySQL will get a preview release with Boost 1.82. Some of the API is still experimental,
|
||||
and is likely to change in 1.83. We will keep any replaced APIs as deprecated in 1.83 and will
|
||||
remove them in subsequent releases. Define `BOOST_MYSQL_EXPERIMENTAL_API` to suppress
|
||||
warnings about this.
|
||||
|
||||
Boost 1.82 is scheduled for 2023-04-12.
|
||||
Documentation and examples are [here](https://anarthal.github.io/mysql/index.html).
|
||||
|
||||
## Why another MySQL C++ client?
|
||||
|
||||
@ -53,7 +46,16 @@ And with the following databases:
|
||||
- MySQL v8.0.20
|
||||
- MariaDB v10.3
|
||||
|
||||
## Upgrading from 0.0.x to 0.2.x
|
||||
## Versioning and upgrading
|
||||
|
||||
The current latest version is 0.2.0. Boost.Mysql has officially passed its formal review
|
||||
and is now in the process of being integrated into Boost. As part of this process, the library
|
||||
will get breaking changes that were deemed required by the formal review. The library will get
|
||||
its first stable release when Boost 1.82 is released (scheduled for early 2023).
|
||||
Any breaking change from v0.2.0 will be listed here, together with a rationale and
|
||||
an upgrade guide. If you encounter any trouble, please open an issue in the repository.
|
||||
|
||||
### Breaking changes from 0.0.x to 0.2.x
|
||||
|
||||
This version has changed the way SSL is handled by the library to
|
||||
a more standard approach, similar to what Boost.Beast and Boost.Asio use.
|
||||
|
||||
@ -55,9 +55,6 @@ function(common_target_settings TARGET_NAME)
|
||||
target_compile_options(${TARGET_NAME} PRIVATE --coverage)
|
||||
target_link_options(${TARGET_NAME} PRIVATE --coverage)
|
||||
endif()
|
||||
|
||||
# Don't get hit by our own experimental warnings
|
||||
target_compile_definitions(${TARGET_NAME} PRIVATE BOOST_MYSQL_EXPERIMENTAL_API)
|
||||
endfunction()
|
||||
|
||||
# Valgrind stuff
|
||||
|
||||
@ -37,7 +37,6 @@ docca.reference reference.qbk
|
||||
<doxygen:param>EXPAND_ONLY_PREDEF=YES
|
||||
<doxygen:param>SEARCH_INCLUDES=NO
|
||||
<doxygen:param>"PREDEFINED=\\
|
||||
BOOST_MYSQL_EXPERIMENTAL_API \\
|
||||
BOOST_MYSQL_DOXYGEN \\
|
||||
\"BOOST_ASIO_INITFN_RESULT_TYPE(t,a)=auto\" \\
|
||||
\"BOOST_ASIO_COMPLETION_TOKEN_FOR(sig)=class\" \\
|
||||
|
||||
@ -10,13 +10,6 @@
|
||||
|
||||
__Self__ is a C++11 client for the __Mysql__ database server, based on __Asio__.
|
||||
|
||||
[note
|
||||
As of Boost 1.82, the Boost.MySQL API is still experimental, and might change
|
||||
in Boost 1.83. We will keep any replaced APIs as deprecated in Boost 1.83 and will
|
||||
remove them in subsequent releases. Define `BOOST_MYSQL_EXPERIMENTAL_API` to suppress
|
||||
warnings about this.
|
||||
]
|
||||
|
||||
[section Motivation]
|
||||
|
||||
__Mysql__ is one of the most widespread SQL database servers. MySQL
|
||||
|
||||
@ -28,19 +28,9 @@
|
||||
#include <boost/mysql/detail/channel/channel.hpp>
|
||||
#include <boost/mysql/detail/protocol/protocol_types.hpp>
|
||||
|
||||
#include <boost/config/pragma_message.hpp>
|
||||
|
||||
#include <type_traits>
|
||||
#include <utility>
|
||||
|
||||
#ifndef BOOST_MYSQL_EXPERIMENTAL_API
|
||||
BOOST_PRAGMA_MESSAGE(
|
||||
"Boost.MySQL API is still experimental. The functions connection::query() and "
|
||||
"connection::execute_statement() might change in subsequent releases. Define "
|
||||
"BOOST_MYSQL_EXPERIMENTAL_API to suppress this warning"
|
||||
)
|
||||
#endif
|
||||
|
||||
/// The Boost libraries namespace.
|
||||
namespace boost {
|
||||
/// Boost.Mysql library namespace.
|
||||
|
||||
@ -108,7 +108,7 @@ lib asio_separate_build
|
||||
<define>BOOST_ASIO_SEPARATE_COMPILATION
|
||||
;
|
||||
|
||||
alias mysql : asio_separate_build : : : <define>BOOST_MYSQL_EXPERIMENTAL_API ;
|
||||
alias mysql : asio_separate_build ;
|
||||
|
||||
# Unit test library generates some internal warnings we're not interested in
|
||||
local unit_test_lib = /boost/test//boost_unit_test_framework/<warnings-as-errors>off ;
|
||||
|
||||
@ -8,8 +8,8 @@
|
||||
|
||||
set -e
|
||||
|
||||
BK=docs
|
||||
IMAGE=build-docs
|
||||
BK=b2
|
||||
IMAGE=build-gcc11
|
||||
CONTAINER=builder-$IMAGE-$BK
|
||||
FULL_IMAGE=ghcr.io/anarthal-containers/$IMAGE
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user