mirror of
https://github.com/boostorg/mysql.git
synced 2025-05-12 14:11:41 +00:00
Added any_connection and any_address Added connection_pool and pooled_connection Added thread_safety tests Added defaults.hpp header close 19
1607 lines
54 KiB
C++
1607 lines
54 KiB
C++
//
|
|
// Copyright (c) 2019-2023 Ruben Perez Hidalgo (rubenperez038 at gmail dot com)
|
|
//
|
|
// Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
//
|
|
|
|
// This file contains all the snippets that are used in the docs.
|
|
// They're here so they are built and run, to ensure correctness
|
|
|
|
#include <boost/mysql/any_connection.hpp>
|
|
#include <boost/mysql/connect_params.hpp>
|
|
#include <boost/mysql/connection.hpp>
|
|
#include <boost/mysql/connection_pool.hpp>
|
|
#include <boost/mysql/date.hpp>
|
|
#include <boost/mysql/datetime.hpp>
|
|
#include <boost/mysql/diagnostics.hpp>
|
|
#include <boost/mysql/error_code.hpp>
|
|
#include <boost/mysql/error_with_diagnostics.hpp>
|
|
#include <boost/mysql/execution_state.hpp>
|
|
#include <boost/mysql/field.hpp>
|
|
#include <boost/mysql/field_view.hpp>
|
|
#include <boost/mysql/metadata_mode.hpp>
|
|
#include <boost/mysql/pool_params.hpp>
|
|
#include <boost/mysql/results.hpp>
|
|
#include <boost/mysql/resultset.hpp>
|
|
#include <boost/mysql/resultset_view.hpp>
|
|
#include <boost/mysql/row.hpp>
|
|
#include <boost/mysql/row_view.hpp>
|
|
#include <boost/mysql/rows.hpp>
|
|
#include <boost/mysql/rows_view.hpp>
|
|
#include <boost/mysql/ssl_mode.hpp>
|
|
#include <boost/mysql/statement.hpp>
|
|
#include <boost/mysql/static_execution_state.hpp>
|
|
#include <boost/mysql/static_results.hpp>
|
|
#include <boost/mysql/string_view.hpp>
|
|
#include <boost/mysql/tcp_ssl.hpp>
|
|
#include <boost/mysql/throw_on_error.hpp>
|
|
|
|
#include <boost/asio/any_io_executor.hpp>
|
|
#include <boost/asio/as_tuple.hpp>
|
|
#include <boost/asio/awaitable.hpp>
|
|
#include <boost/asio/co_spawn.hpp>
|
|
#include <boost/asio/detached.hpp>
|
|
#include <boost/asio/io_context.hpp>
|
|
#include <boost/asio/ssl/context.hpp>
|
|
#include <boost/asio/ssl/error.hpp>
|
|
#include <boost/asio/ssl/host_name_verification.hpp>
|
|
#include <boost/asio/ssl/verify_mode.hpp>
|
|
#include <boost/asio/this_coro.hpp>
|
|
#include <boost/asio/thread_pool.hpp>
|
|
#include <boost/asio/use_future.hpp>
|
|
#include <boost/config.hpp>
|
|
#include <boost/core/ignore_unused.hpp>
|
|
#include <boost/describe/class.hpp>
|
|
#include <boost/optional/optional.hpp>
|
|
#include <boost/system/system_error.hpp>
|
|
|
|
#include <array>
|
|
#include <chrono>
|
|
#include <cstddef>
|
|
#include <functional>
|
|
#include <iostream>
|
|
#include <string>
|
|
#include <thread>
|
|
#include <tuple>
|
|
|
|
#ifndef BOOST_NO_CXX17_HDR_OPTIONAL
|
|
#include <optional>
|
|
#endif
|
|
#ifdef BOOST_ASIO_HAS_CO_AWAIT
|
|
#include <boost/asio/experimental/awaitable_operators.hpp>
|
|
#endif
|
|
|
|
using boost::mysql::date;
|
|
using boost::mysql::datetime;
|
|
using boost::mysql::diagnostics;
|
|
using boost::mysql::error_code;
|
|
using boost::mysql::error_with_diagnostics;
|
|
using boost::mysql::execution_state;
|
|
using boost::mysql::field;
|
|
using boost::mysql::field_view;
|
|
using boost::mysql::metadata_mode;
|
|
using boost::mysql::results;
|
|
using boost::mysql::row;
|
|
using boost::mysql::row_view;
|
|
using boost::mysql::rows;
|
|
using boost::mysql::rows_view;
|
|
using boost::mysql::statement;
|
|
using boost::mysql::string_view;
|
|
using boost::mysql::tcp_ssl_connection;
|
|
#ifdef BOOST_MYSQL_CXX14
|
|
using boost::mysql::static_execution_state;
|
|
using boost::mysql::static_results;
|
|
#endif
|
|
|
|
#define ASSERT(expr) \
|
|
if (!(expr)) \
|
|
{ \
|
|
std::cerr << "Assertion failed: " #expr << std::endl; \
|
|
exit(1); \
|
|
}
|
|
|
|
#ifdef BOOST_ASIO_HAS_CO_AWAIT
|
|
void run_coro(boost::asio::any_io_executor ex, std::function<boost::asio::awaitable<void>(void)> fn)
|
|
{
|
|
boost::asio::co_spawn(ex, fn, [](std::exception_ptr ptr) {
|
|
if (ptr)
|
|
{
|
|
std::rethrow_exception(ptr);
|
|
}
|
|
});
|
|
static_cast<boost::asio::io_context&>(ex.context()).run();
|
|
}
|
|
#endif
|
|
|
|
const char* get_value_from_user() { return ""; }
|
|
int get_int_value_from_user() { return 42; }
|
|
std::int64_t get_employee_id() { return 42; }
|
|
std::string get_company_id() { return "HGS"; }
|
|
|
|
// Describe types
|
|
|
|
//[describe_post
|
|
// We can use a plain struct with ints and strings to describe our rows.
|
|
// This must be placed at the namespace level
|
|
struct post
|
|
{
|
|
int id;
|
|
std::string title;
|
|
std::string body;
|
|
};
|
|
|
|
// We must use Boost.Describe to add reflection capabilities to post.
|
|
// We must list all the fields that should be populated by Boost.MySQL
|
|
BOOST_DESCRIBE_STRUCT(post, (), (id, title, body))
|
|
//]
|
|
|
|
#ifndef BOOST_NO_CXX17_HDR_OPTIONAL
|
|
//[describe_post_v2
|
|
struct post_v2
|
|
{
|
|
int id;
|
|
std::string title;
|
|
std::optional<std::string> body; // body may be NULL
|
|
};
|
|
BOOST_DESCRIBE_STRUCT(post_v2, (), (id, title, body))
|
|
//]
|
|
#endif
|
|
|
|
//[describe_statistics
|
|
struct statistics
|
|
{
|
|
std::string company;
|
|
double average;
|
|
double max_value;
|
|
};
|
|
BOOST_DESCRIBE_STRUCT(statistics, (), (company, average, max_value))
|
|
//]
|
|
|
|
//[describe_stored_procedures
|
|
// Describes the first resultset
|
|
struct company
|
|
{
|
|
std::string id;
|
|
std::string name;
|
|
std::string tax_id;
|
|
};
|
|
BOOST_DESCRIBE_STRUCT(company, (), (id, name, tax_id))
|
|
|
|
// Describes the second resultset
|
|
struct employee
|
|
{
|
|
std::string first_name;
|
|
std::string last_name;
|
|
boost::optional<double> salary;
|
|
};
|
|
BOOST_DESCRIBE_STRUCT(employee, (), (first_name, last_name, salary))
|
|
|
|
// The last resultset will always be empty.
|
|
// We can use an empty tuple to represent it.
|
|
using empty = std::tuple<>;
|
|
//]
|
|
|
|
//[prepared_statements_execute
|
|
// description, price and show_in_store are not trusted, since they may
|
|
// have been read from a file or an HTTP endpoint
|
|
void insert_product(
|
|
tcp_ssl_connection& conn,
|
|
const statement& stmt,
|
|
string_view description,
|
|
int price,
|
|
bool show_in_store
|
|
)
|
|
{
|
|
results result;
|
|
conn.execute(stmt.bind(description, price, show_in_store), result);
|
|
}
|
|
//]
|
|
|
|
#ifndef BOOST_NO_CXX17_HDR_OPTIONAL
|
|
//[prepared_statements_execute_null
|
|
// description, price and show_in_store are not trusted, since they may
|
|
// have been read from a file or an HTTP endpoint
|
|
void insert_product(
|
|
tcp_ssl_connection& conn,
|
|
const statement& stmt,
|
|
std::optional<string_view> description,
|
|
int price,
|
|
bool show_in_store
|
|
)
|
|
{
|
|
// If description has a value, a string will be sent to the server; otherwise, a NULL will
|
|
results result;
|
|
conn.execute(stmt.bind(description, price, show_in_store), result);
|
|
}
|
|
//]
|
|
void run_insert_product_optional(tcp_ssl_connection& conn, const statement& stmt)
|
|
{
|
|
insert_product(conn, stmt, std::optional<string_view>(), 2000, true);
|
|
}
|
|
#else
|
|
void run_insert_product_optional(tcp_ssl_connection&, const statement&) {}
|
|
#endif
|
|
|
|
//[prepared_statements_execute_iterator_range
|
|
void exec_statement(tcp_ssl_connection& conn, const statement& stmt, const std::vector<field>& params)
|
|
{
|
|
results result;
|
|
conn.execute(stmt.bind(params.begin(), params.end()), result);
|
|
}
|
|
//]
|
|
|
|
#ifdef BOOST_ASIO_HAS_CO_AWAIT
|
|
boost::asio::awaitable<void> overview_coro(tcp_ssl_connection& conn)
|
|
{
|
|
//[overview_async_coroutinescpp20
|
|
// Using this CompletionToken, you get C++20 coroutines that communicate
|
|
// errors with error_codes. This way, you can access the diagnostics object.
|
|
constexpr auto token = boost::asio::as_tuple(boost::asio::use_awaitable);
|
|
|
|
// Run our query as a coroutine
|
|
diagnostics diag;
|
|
results result;
|
|
auto [ec] = co_await conn.async_execute("SELECT 'Hello world!'", result, diag, token);
|
|
|
|
// This will throw an error_with_diagnostics in case of failure
|
|
boost::mysql::throw_on_error(ec, diag);
|
|
//]
|
|
}
|
|
|
|
boost::asio::awaitable<void> dont_run()
|
|
{
|
|
using namespace boost::asio::experimental::awaitable_operators;
|
|
|
|
// Setup
|
|
boost::asio::ssl::context ssl_ctx(boost::asio::ssl::context::tls_client);
|
|
boost::mysql::tcp_ssl_connection conn(co_await boost::asio::this_coro::executor, ssl_ctx);
|
|
|
|
//[overview_async_dont
|
|
// Coroutine body
|
|
// DO NOT DO THIS!!!!
|
|
results result1, result2;
|
|
co_await (
|
|
conn.async_execute("SELECT 1", result1, boost::asio::use_awaitable) &&
|
|
conn.async_execute("SELECT 2", result2, boost::asio::use_awaitable)
|
|
);
|
|
//]
|
|
}
|
|
#else
|
|
void run_overview_coro(tcp_ssl_connection&) {}
|
|
#endif
|
|
|
|
void section_overview(tcp_ssl_connection& conn)
|
|
{
|
|
{
|
|
//[overview_query_use_case
|
|
results result;
|
|
conn.execute("START TRANSACTION", result);
|
|
//]
|
|
}
|
|
{
|
|
//[overview_statement_use_case
|
|
statement stmt = conn.prepare_statement(
|
|
"SELECT first_name FROM employee WHERE company_id = ? AND salary > ?"
|
|
);
|
|
|
|
results result;
|
|
conn.execute(stmt.bind("HGS", 30000), result);
|
|
//]
|
|
}
|
|
{
|
|
//[overview_ifaces_table
|
|
const char* table_definition = R"%(
|
|
CREATE TEMPORARY TABLE posts (
|
|
id INT PRIMARY KEY AUTO_INCREMENT,
|
|
title VARCHAR (256) NOT NULL,
|
|
body TEXT NOT NULL
|
|
)
|
|
)%";
|
|
//]
|
|
|
|
results result;
|
|
conn.execute(table_definition, result);
|
|
}
|
|
{
|
|
//[overview_ifaces_dynamic
|
|
// Passing a results object to connection::execute selects the dynamic interface
|
|
results result;
|
|
conn.execute("SELECT id, title, body FROM posts", result);
|
|
|
|
// Every row is a collection of fields, which are variant-like objects
|
|
// that represent data. We use as_string() to cast them to the appropriate type
|
|
for (row_view post : result.rows())
|
|
{
|
|
std::cout << "Title: " << post.at(1).as_string() << "Body: " << post.at(2).as_string()
|
|
<< std::endl;
|
|
}
|
|
//]
|
|
}
|
|
#ifdef BOOST_MYSQL_CXX14
|
|
{
|
|
// The struct definition is included above this
|
|
//[overview_ifaces_static
|
|
//
|
|
// This must be placed inside your function or method:
|
|
//
|
|
|
|
// Passing a static_results to execute() selects the static interface
|
|
static_results<post> result;
|
|
conn.execute("SELECT id, title, body FROM posts", result);
|
|
|
|
// Query results are parsed directly into your own type
|
|
for (const post& p : result.rows())
|
|
{
|
|
std::cout << "Title: " << p.title << "Body: " << p.body << std::endl;
|
|
}
|
|
//]
|
|
}
|
|
#endif
|
|
|
|
{
|
|
//[overview_statements_setup
|
|
results result;
|
|
conn.execute(
|
|
R"%(
|
|
CREATE TEMPORARY TABLE products (
|
|
id VARCHAR(50) PRIMARY KEY,
|
|
description VARCHAR(256)
|
|
)
|
|
)%",
|
|
result
|
|
);
|
|
conn.execute("INSERT INTO products VALUES ('PTT', 'Potatoes'), ('CAR', 'Carrots')", result);
|
|
//]
|
|
}
|
|
{
|
|
//[overview_statements_prepare
|
|
statement stmt = conn.prepare_statement("SELECT description FROM products WHERE id = ?");
|
|
//]
|
|
|
|
//[overview_statements_execute
|
|
// Obtain the product_id from the user. product_id is untrusted input
|
|
const char* product_id = get_value_from_user();
|
|
|
|
// Execute the statement
|
|
results result;
|
|
conn.execute(stmt.bind(product_id), result);
|
|
|
|
// Use result as required
|
|
//]
|
|
|
|
conn.execute("DROP TABLE products", result);
|
|
}
|
|
{
|
|
//[overview_errors_sync_errc
|
|
error_code ec;
|
|
diagnostics diag;
|
|
results result;
|
|
|
|
// The provided SQL is invalid. The server will return an error.
|
|
// ec will be set to a non-zero value
|
|
conn.execute("this is not SQL!", result, ec, diag);
|
|
|
|
if (ec)
|
|
{
|
|
// The error code will likely report a syntax error
|
|
std::cout << "Operation failed with error code: " << ec << '\n';
|
|
|
|
// diag.server_message() will contain the classic phrase
|
|
// "You have an error in your SQL syntax; check the manual..."
|
|
// Bear in mind that server_message() may contain user input, so treat it with caution
|
|
std::cout << "Server diagnostics: " << diag.server_message() << std::endl;
|
|
}
|
|
//]
|
|
}
|
|
{
|
|
//[overview_errors_sync_exc
|
|
try
|
|
{
|
|
// The provided SQL is invalid. This function will throw an exception.
|
|
results result;
|
|
conn.execute("this is not SQL!", result);
|
|
}
|
|
catch (const error_with_diagnostics& err)
|
|
{
|
|
// error_with_diagnostics contains an error_code and a diagnostics object.
|
|
// It inherits from boost::system::system_error.
|
|
std::cout << "Operation failed with error code: " << err.code() << '\n'
|
|
<< "Server diagnostics: " << err.get_diagnostics().server_message() << std::endl;
|
|
}
|
|
//]
|
|
}
|
|
{
|
|
#ifdef BOOST_ASIO_HAS_CO_AWAIT
|
|
run_coro(conn.get_executor(), [&conn] { return overview_coro(conn); });
|
|
#endif
|
|
}
|
|
{
|
|
results r;
|
|
conn.execute("DROP TABLE IF EXISTS posts", r);
|
|
}
|
|
{
|
|
//[overview_multifn
|
|
// Create the table and some sample data
|
|
// In a real system, body may be megabaytes long.
|
|
results result;
|
|
conn.execute(
|
|
R"%(
|
|
CREATE TEMPORARY TABLE posts (
|
|
id INT PRIMARY KEY AUTO_INCREMENT,
|
|
title VARCHAR (256),
|
|
body TEXT
|
|
)
|
|
)%",
|
|
result
|
|
);
|
|
conn.execute(
|
|
R"%(
|
|
INSERT INTO posts (title, body) VALUES
|
|
('Post 1', 'A very long post body'),
|
|
('Post 2', 'An even longer post body')
|
|
)%",
|
|
result
|
|
);
|
|
|
|
// execution_state stores state about our operation, and must be passed to all functions
|
|
execution_state st;
|
|
|
|
// Writes the query request and reads the server response, but not the rows
|
|
conn.start_execution("SELECT title, body FROM posts", st);
|
|
|
|
// Reads all the returned rows, in batches.
|
|
// st.complete() returns true once there are no more rows to read
|
|
while (!st.complete())
|
|
{
|
|
// row_batch will be valid until conn performs the next network operation
|
|
rows_view row_batch = conn.read_some_rows(st);
|
|
|
|
for (row_view post : row_batch)
|
|
{
|
|
// Process post as required
|
|
std::cout << "Title:" << post.at(0) << std::endl;
|
|
}
|
|
}
|
|
//]
|
|
|
|
conn.execute("DROP TABLE posts", result);
|
|
}
|
|
}
|
|
|
|
void section_dynamic(tcp_ssl_connection& conn)
|
|
{
|
|
{
|
|
//[dynamic_views
|
|
// Populate a results object
|
|
results result;
|
|
conn.execute("SELECT 'Hello world'", result);
|
|
|
|
// results::rows() returns a rows_view. The underlying memory is owned by the results object
|
|
rows_view all_rows = result.rows();
|
|
|
|
// Indexing a rows_view yields a row_view. The underlying memory is owned by the results object
|
|
row_view first_row = all_rows.at(0);
|
|
|
|
// Indexing a row_view yields a field_view. The underlying memory is owned by the results object
|
|
field_view first_field = first_row.at(0); // Contains the string "Hello world"
|
|
|
|
//]
|
|
ASSERT(first_field.as_string() == "Hello world");
|
|
|
|
//[dynamic_taking_ownership
|
|
// You may use all_rows_owning after result has gone out of scope
|
|
rows all_rows_owning{all_rows};
|
|
|
|
// You may use first_row_owning after result has gone out of scope
|
|
row first_row_owning{first_row};
|
|
|
|
// You may use first_field_owning after result has gone out of scope
|
|
field first_field_owning{first_field};
|
|
//]
|
|
}
|
|
{
|
|
//[dynamic_using_fields
|
|
results result;
|
|
conn.execute("SELECT 'abc', 42", result);
|
|
|
|
// Obtain a field's underlying value using the is_xxx and get_xxx accessors
|
|
field_view f = result.rows().at(0).at(0); // f points to the string "abc"
|
|
if (f.is_string())
|
|
{
|
|
// we know it's a string, unchecked access
|
|
string_view s = f.get_string();
|
|
std::cout << s << std::endl; // Use the string as required
|
|
}
|
|
else
|
|
{
|
|
// Oops, something went wrong - schema msimatch?
|
|
}
|
|
|
|
// Alternative: use the as_xxx accessor
|
|
f = result.rows().at(0).at(1);
|
|
std::int64_t value = f.as_int64(); // Checked access. Throws if f doesn't contain an int
|
|
std::cout << value << std::endl; // Use the int as required
|
|
|
|
//]
|
|
}
|
|
{
|
|
//[dynamic_handling_nulls
|
|
results result;
|
|
|
|
// Create some test data
|
|
conn.execute(
|
|
R"%(
|
|
CREATE TEMPORARY TABLE products (
|
|
id VARCHAR(50) PRIMARY KEY,
|
|
description VARCHAR(256)
|
|
)
|
|
)%",
|
|
result
|
|
);
|
|
conn.execute("INSERT INTO products VALUES ('PTT', 'Potatoes'), ('CAR', NULL)", result);
|
|
|
|
// Retrieve the data. Note that some fields are NULL
|
|
conn.execute("SELECT id, description FROM products", result);
|
|
|
|
for (row_view r : result.rows())
|
|
{
|
|
field_view description_fv = r.at(1);
|
|
if (description_fv.is_null())
|
|
{
|
|
// Handle the NULL value
|
|
// Note: description_fv.is_string() will return false here; NULL is represented as a separate
|
|
// type
|
|
std::cout << "No description for product_id " << r.at(0) << std::endl;
|
|
}
|
|
else
|
|
{
|
|
// Handle the non-NULL case. Get the underlying value and use it as you want
|
|
// If there is any schema mismatch (and description was not defined as VARCHAR), this will
|
|
// throw
|
|
string_view description = description_fv.as_string();
|
|
|
|
// Use description as required
|
|
std::cout << "product_id " << r.at(0) << ": " << description << std::endl;
|
|
}
|
|
}
|
|
//]
|
|
|
|
conn.execute("DROP TABLE products", result);
|
|
}
|
|
{
|
|
//[dynamic_field_accessor_references
|
|
field f("my_string"); // constructs a field that owns the string "my_string"
|
|
std::string& s = f.as_string(); // s points into f's storage
|
|
s.push_back('2'); // f now holds "my_string2"
|
|
|
|
//]
|
|
|
|
ASSERT(s == "my_string2");
|
|
}
|
|
{
|
|
//[dynamic_field_assignment
|
|
field f("my_string"); // constructs a field that owns the string "my_string"
|
|
f = 42; // destroys "my_string" and stores the value 42 as an int64
|
|
|
|
//]
|
|
|
|
ASSERT(f.as_int64() == 42);
|
|
}
|
|
}
|
|
|
|
void section_static(tcp_ssl_connection& conn)
|
|
{
|
|
boost::ignore_unused(conn);
|
|
#ifdef BOOST_MYSQL_CXX14
|
|
{
|
|
//[static_setup
|
|
const char* table_definition = R"%(
|
|
CREATE TEMPORARY TABLE posts (
|
|
id INT PRIMARY KEY AUTO_INCREMENT,
|
|
title VARCHAR (256) NOT NULL,
|
|
body TEXT NOT NULL
|
|
)
|
|
)%";
|
|
const char* query = "SELECT id, title, body FROM posts";
|
|
//]
|
|
|
|
results r;
|
|
conn.execute(table_definition, r);
|
|
|
|
//[static_query
|
|
static_results<post> result;
|
|
conn.execute(query, result);
|
|
|
|
for (const post& p : result.rows())
|
|
{
|
|
// Process the post as required
|
|
std::cout << "Title: " << p.title << "\n" << p.body << "\n";
|
|
}
|
|
//]
|
|
|
|
conn.execute("DROP TABLE posts", r);
|
|
}
|
|
{
|
|
//[static_field_order
|
|
const char* sql = R"%(
|
|
SELECT
|
|
IFNULL(AVG(salary), 0.0) AS average,
|
|
IFNULL(MAX(salary), 0.0) AS max_value,
|
|
company_id AS company
|
|
FROM employee
|
|
GROUP BY company_id
|
|
)%";
|
|
|
|
static_results<statistics> result;
|
|
conn.execute(sql, result);
|
|
//]
|
|
}
|
|
{
|
|
//[static_tuples
|
|
static_results<std::tuple<std::int64_t>> result;
|
|
conn.execute("SELECT COUNT(*) FROM employee", result);
|
|
std::cout << "Number of employees: " << std::get<0>(result.rows()[0]) << "\n";
|
|
//]
|
|
}
|
|
#ifndef BOOST_NO_CXX17_HDR_OPTIONAL
|
|
{
|
|
//[static_nulls_table
|
|
const char* table_definition = R"%(
|
|
CREATE TEMPORARY TABLE posts_v2 (
|
|
id INT PRIMARY KEY AUTO_INCREMENT,
|
|
title VARCHAR (256) NOT NULL,
|
|
body TEXT
|
|
)
|
|
)%";
|
|
//]
|
|
|
|
// Verify that post_v2's definition is correct
|
|
results r;
|
|
conn.execute(table_definition, r);
|
|
static_results<post_v2> result;
|
|
conn.execute("SELECT * FROM posts_v2", result);
|
|
conn.execute("DROP TABLE posts_v2", r);
|
|
}
|
|
#endif // BOOST_NO_CXX17_HDR_OPTIONAL
|
|
#endif // BOOST_MYSQL_CXX14
|
|
}
|
|
|
|
void section_prepared_statements(tcp_ssl_connection& conn)
|
|
{
|
|
{
|
|
//[prepared_statements_prepare
|
|
// Table setup
|
|
const char* table_definition = R"%(
|
|
CREATE TEMPORARY TABLE products (
|
|
id INT PRIMARY KEY AUTO_INCREMENT,
|
|
description VARCHAR(256),
|
|
price INT NOT NULL,
|
|
show_in_store TINYINT
|
|
)
|
|
)%";
|
|
results result;
|
|
conn.execute(table_definition, result);
|
|
|
|
// Prepare a statement to insert into this table
|
|
statement stmt = conn.prepare_statement(
|
|
"INSERT INTO products (description, price, show_in_store) VALUES (?, ?, ?)"
|
|
);
|
|
//]
|
|
|
|
// Run the functions to verify that evth works
|
|
insert_product(conn, stmt, string_view("This is a product"), 2000, true);
|
|
run_insert_product_optional(conn, stmt);
|
|
exec_statement(conn, stmt, {field_view("abc"), field_view(2000), field_view(1)});
|
|
conn.execute("DROP TABLE products", result);
|
|
}
|
|
{
|
|
//[prepared_statements_casting_table
|
|
const char* table_definition = "CREATE TEMPORARY TABLE my_table(my_field TINYINT)";
|
|
//]
|
|
|
|
results r;
|
|
conn.execute(table_definition, r);
|
|
|
|
//[prepared_statements_casting_execute
|
|
int value = get_int_value_from_user();
|
|
auto stmt = conn.prepare_statement("INSERT INTO my_table VALUES (?)");
|
|
|
|
results result;
|
|
conn.execute(stmt.bind(value), result);
|
|
//]
|
|
}
|
|
}
|
|
|
|
void section_multi_resultset(tcp_ssl_connection& conn)
|
|
{
|
|
{
|
|
//[multi_resultset_call_dynamic
|
|
|
|
// We're using the dynamic interface. results can stored multiple resultsets
|
|
results result;
|
|
|
|
// The procedure parameter, employe_id, will likely be obtained from an untrusted source,
|
|
// so we will use a prepared statement
|
|
statement get_employee_stmt = conn.prepare_statement("CALL get_employees(?)");
|
|
|
|
// Obtain the parameters required to call the statement, e.g. from a file or HTTP message
|
|
std::int64_t employee_id = get_employee_id();
|
|
|
|
// Call the statement
|
|
conn.execute(get_employee_stmt.bind(employee_id), result);
|
|
|
|
// results can be used as a random-access collection of resultsets.
|
|
// result.at(0).rows() returns the matched companies, if any
|
|
rows_view matched_company = result.at(0).rows();
|
|
|
|
// We can do the same to access the matched employees
|
|
rows_view matched_employees = result.at(1).rows();
|
|
|
|
// Use matched_company and matched_employees as required
|
|
//]
|
|
|
|
boost::ignore_unused(matched_company);
|
|
boost::ignore_unused(matched_employees);
|
|
}
|
|
#ifdef BOOST_MYSQL_CXX14
|
|
{
|
|
//[multi_resultset_call_static
|
|
// We must list all the resultset types the operation returns as template arguments
|
|
static_results<company, employee, empty> result;
|
|
conn.execute("CALL get_employees('HGS')", result);
|
|
|
|
// We can use rows<0>() to access the rows for the first resultset
|
|
if (result.rows<0>().empty())
|
|
{
|
|
std::cout << "Company not found" << std::endl;
|
|
}
|
|
else
|
|
{
|
|
const company& comp = result.rows<0>()[0];
|
|
std::cout << "Company name: " << comp.name << ", tax_id: " << comp.tax_id << std::endl;
|
|
}
|
|
|
|
// rows<1>() will return the rows for the second resultset
|
|
for (const employee& emp : result.rows<1>())
|
|
{
|
|
std::cout << "Employee " << emp.first_name << " " << emp.last_name << std::endl;
|
|
}
|
|
//]
|
|
}
|
|
#endif
|
|
{
|
|
//[multi_resultset_out_params
|
|
// To retrieve output parameters, you must use prepared statements. Text queries don't support this
|
|
// We specify placeholders for both IN and OUT parameters
|
|
statement stmt = conn.prepare_statement("CALL create_employee(?, ?, ?, ?)");
|
|
|
|
// When executing the statement, we provide an actual value for the IN parameters,
|
|
// and a dummy value for the OUT parameter. This value will be ignored, but it's required by the
|
|
// protocol
|
|
results result;
|
|
conn.execute(stmt.bind("HGS", "John", "Doe", nullptr), result);
|
|
|
|
// Retrieve output parameters. This row_view has an element per
|
|
// OUT or INOUT parameter that used a ? placeholder
|
|
row_view output_params = result.out_params();
|
|
std::int64_t new_employee_id = output_params.at(0).as_int64();
|
|
//]
|
|
|
|
boost::ignore_unused(new_employee_id);
|
|
}
|
|
}
|
|
|
|
void section_multi_resultset_multi_queries(char** argv)
|
|
{
|
|
boost::asio::io_context ctx;
|
|
boost::asio::ssl::context ssl_ctx(boost::asio::ssl::context::tls_client);
|
|
boost::asio::ip::tcp::resolver resolver(ctx.get_executor());
|
|
boost::mysql::tcp_ssl_connection conn(ctx.get_executor(), ssl_ctx);
|
|
|
|
auto endpoint = *resolver.resolve(argv[3], boost::mysql::default_port_string).begin();
|
|
|
|
//[multi_resultset_multi_queries
|
|
// The username and password to use
|
|
boost::mysql::handshake_params params(
|
|
argv[1], // username
|
|
argv[2], // password
|
|
"boost_mysql_examples" // database
|
|
);
|
|
|
|
// Allows running multiple semicolon-separated in a single call.
|
|
// We must set this before calling connect
|
|
params.set_multi_queries(true);
|
|
|
|
// Connect to the server specifying that we want support for multi-queries
|
|
conn.connect(endpoint, params);
|
|
|
|
// We can now use the multi-query feature.
|
|
// This will result in three resultsets, one per query.
|
|
results result;
|
|
conn.execute(
|
|
R"(
|
|
CREATE TEMPORARY TABLE posts (
|
|
id INT PRIMARY KEY AUTO_INCREMENT,
|
|
title VARCHAR (256),
|
|
body TEXT
|
|
);
|
|
INSERT INTO posts (title, body) VALUES ('Breaking news', 'Something happened!');
|
|
SELECT COUNT(*) FROM posts;
|
|
)",
|
|
result
|
|
);
|
|
//]
|
|
|
|
//[multi_resultset_results_as_collection
|
|
// result is actually a random-access collection of resultsets.
|
|
// The INSERT is the 2nd query, so we can access its resultset like this:
|
|
boost::mysql::resultset_view insert_result = result.at(1);
|
|
|
|
// A resultset has metadata, rows, and additional data, like the last insert ID:
|
|
std::int64_t post_id = insert_result.last_insert_id();
|
|
|
|
// The SELECT result is the third one, so we can access it like this:
|
|
boost::mysql::resultset_view select_result = result.at(2);
|
|
|
|
// select_result is a view that points into result.
|
|
// We can take ownership of it using the resultse class:
|
|
boost::mysql::resultset owning_select_result(select_result); // valid even after result is destroyed
|
|
|
|
// We can access rows of resultset objects as usual:
|
|
std::int64_t num_posts = owning_select_result.rows().at(0).at(0).as_int64();
|
|
//]
|
|
|
|
boost::ignore_unused(post_id);
|
|
boost::ignore_unused(num_posts);
|
|
}
|
|
|
|
void section_multi_function(tcp_ssl_connection& conn)
|
|
{
|
|
{
|
|
//[multi_function_setup
|
|
const char* table_definition = R"%(
|
|
CREATE TEMPORARY TABLE posts (
|
|
id INT PRIMARY KEY AUTO_INCREMENT,
|
|
title VARCHAR (256) NOT NULL,
|
|
body TEXT NOT NULL
|
|
)
|
|
)%";
|
|
//]
|
|
|
|
results result;
|
|
conn.execute(table_definition, result);
|
|
conn.execute(
|
|
R"%(
|
|
INSERT INTO posts (title, body) VALUES
|
|
('Post 1', 'A very long post body'),
|
|
('Post 2', 'An even longer post body')
|
|
)%",
|
|
result
|
|
);
|
|
|
|
//[multi_function_dynamic_start
|
|
// st will hold information about the operation being executed.
|
|
// It must be passed to any successive operations for this execution
|
|
execution_state st;
|
|
|
|
// Sends the query and reads response and meta, but not the rows
|
|
conn.start_execution("SELECT title, body FROM posts", st);
|
|
//]
|
|
|
|
//[multi_function_dynamic_read
|
|
// st.complete() returns true once the OK packet is received
|
|
while (!st.complete())
|
|
{
|
|
// row_batch will be valid until conn performs the next network operation
|
|
rows_view row_batch = conn.read_some_rows(st);
|
|
|
|
for (row_view post : row_batch)
|
|
{
|
|
// Process post as required
|
|
std::cout << "Title:" << post.at(0) << std::endl;
|
|
}
|
|
}
|
|
//]
|
|
}
|
|
#ifdef BOOST_MYSQL_CXX14
|
|
{
|
|
//[multi_function_static_start
|
|
// st will hold information about the operation being executed.
|
|
// It must be passed to any successive operations for this execution
|
|
static_execution_state<post> st;
|
|
|
|
// Sends the query and reads response and meta, but not the rows.
|
|
// If there is any schema mismatch between the declared row type and
|
|
// what the server returned, start_execution will detect it and fail
|
|
conn.start_execution("SELECT id, title, body FROM posts", st);
|
|
//]
|
|
|
|
//[multi_function_static_read
|
|
// storage will be filled with the read rows. You can use any other contiguous range.
|
|
std::array<post, 20> posts;
|
|
|
|
// st.complete() returns true once the OK packet is received
|
|
while (!st.complete())
|
|
{
|
|
std::size_t read_rows = conn.read_some_rows(st, boost::span<post>(posts));
|
|
for (const post& p : boost::span<post>(posts.data(), read_rows))
|
|
{
|
|
// Process post as required
|
|
std::cout << "Title " << p.title << std::endl;
|
|
}
|
|
}
|
|
//]
|
|
|
|
results result;
|
|
conn.execute("DROP TABLE posts", result);
|
|
}
|
|
#endif
|
|
{
|
|
//[multi_function_stored_procedure_dynamic
|
|
// Get the company ID to retrieve, possibly from the user
|
|
std::string company_id = get_company_id();
|
|
|
|
// Call the procedure
|
|
execution_state st;
|
|
statement stmt = conn.prepare_statement("CALL get_employees(?)");
|
|
conn.start_execution(stmt.bind(company_id), st);
|
|
|
|
// The above code will generate 3 resultsets
|
|
// Read the 1st one, which contains the matched companies
|
|
while (st.should_read_rows())
|
|
{
|
|
rows_view company_batch = conn.read_some_rows(st);
|
|
|
|
// Use the retrieved companies as required
|
|
for (row_view company : company_batch)
|
|
{
|
|
std::cout << "Company: " << company.at(1).as_string() << "\n";
|
|
}
|
|
}
|
|
|
|
// Move on to the 2nd one, containing the employees for these companies
|
|
conn.read_resultset_head(st);
|
|
while (st.should_read_rows())
|
|
{
|
|
rows_view employee_batch = conn.read_some_rows(st);
|
|
|
|
// Use the retrieved employees as required
|
|
for (row_view employee : employee_batch)
|
|
{
|
|
std::cout << "Employee " << employee.at(0).as_string() << " " << employee.at(1).as_string()
|
|
<< "\n";
|
|
}
|
|
}
|
|
|
|
// The last one is an empty resultset containing information about the
|
|
// CALL statement itself. We're not interested in this
|
|
conn.read_resultset_head(st);
|
|
assert(st.complete());
|
|
//]
|
|
}
|
|
#ifdef BOOST_MYSQL_CXX14
|
|
{
|
|
//[multi_function_stored_procedure_static
|
|
// Get the company ID to retrieve, possibly from the user
|
|
std::string company_id = get_company_id();
|
|
|
|
// Our procedure generates three resultsets. We must pass each row type
|
|
// to static_execution_state as template parameters
|
|
using empty = std::tuple<>;
|
|
static_execution_state<company, employee, empty> st;
|
|
|
|
// Call the procedure
|
|
statement stmt = conn.prepare_statement("CALL get_employees(?)");
|
|
conn.start_execution(stmt.bind(company_id), st);
|
|
|
|
// Read the 1st one, which contains the matched companies
|
|
std::array<company, 5> companies;
|
|
while (st.should_read_rows())
|
|
{
|
|
std::size_t read_rows = conn.read_some_rows(st, boost::span<company>(companies));
|
|
|
|
// Use the retrieved companies as required
|
|
for (const company& c : boost::span<company>(companies.data(), read_rows))
|
|
{
|
|
std::cout << "Company: " << c.name << "\n";
|
|
}
|
|
}
|
|
|
|
// Move on to the 2nd one, containing the employees for these companies
|
|
conn.read_resultset_head(st);
|
|
std::array<employee, 20> employees;
|
|
while (st.should_read_rows())
|
|
{
|
|
std::size_t read_rows = conn.read_some_rows(st, boost::span<employee>(employees));
|
|
|
|
// Use the retrieved companies as required
|
|
for (const employee& emp : boost::span<employee>(employees.data(), read_rows))
|
|
{
|
|
std::cout << "Employee " << emp.first_name << " " << emp.last_name << "\n";
|
|
}
|
|
}
|
|
|
|
// The last one is an empty resultset containing information about the
|
|
// CALL statement itself. We're not interested in this
|
|
conn.read_resultset_head(st);
|
|
assert(st.complete());
|
|
//]
|
|
}
|
|
#endif
|
|
}
|
|
|
|
void section_metadata(tcp_ssl_connection& conn)
|
|
{
|
|
//[metadata
|
|
// By default, a connection has metadata_mode::minimal
|
|
results result;
|
|
conn.execute("SELECT 1 AS my_field", result);
|
|
string_view colname = result.meta()[0].column_name();
|
|
|
|
// colname will be empty because conn.meta_mode() == metadata_mode::minimal
|
|
ASSERT(colname == "");
|
|
|
|
// If you are using metadata names, set the connection's metadata_mode
|
|
conn.set_meta_mode(metadata_mode::full);
|
|
conn.execute("SELECT 1 AS my_field", result);
|
|
colname = result.meta()[0].column_name();
|
|
ASSERT(colname == "my_field");
|
|
//]
|
|
}
|
|
|
|
void section_charsets(tcp_ssl_connection& conn)
|
|
{
|
|
//[charsets_set_names
|
|
results result;
|
|
conn.execute("SET NAMES utf8mb4", result);
|
|
// Further operations can assume utf8mb4 as conn's charset
|
|
//]
|
|
}
|
|
|
|
void section_time_types(tcp_ssl_connection& conn)
|
|
{
|
|
{
|
|
//[time_types_date_as_time_point
|
|
date d(2020, 2, 19); // d holds "2020-02-19"
|
|
date::time_point tp = d.as_time_point(); // now use tp normally
|
|
|
|
//]
|
|
ASSERT(date(tp) == d);
|
|
}
|
|
{
|
|
//[time_types_date_valid
|
|
date d1(2020, 2, 19); // regular date
|
|
bool v1 = d1.valid(); // true
|
|
date d2(2020, 0, 19); // invalid date
|
|
bool v2 = d2.valid(); // false
|
|
|
|
//]
|
|
ASSERT(v1);
|
|
ASSERT(!v2);
|
|
}
|
|
{
|
|
//[time_types_date_get_time_point
|
|
date d = /* obtain a date somehow */ date(2020, 2, 29);
|
|
if (d.valid())
|
|
{
|
|
// Same as as_time_point, but doesn't check for validity
|
|
// Caution: be sure to check for validity.
|
|
// If d is not valid, get_time_point results in undefined behavior
|
|
date::time_point tp = d.get_time_point();
|
|
|
|
// Use tp as required
|
|
std::cout << tp.time_since_epoch().count() << std::endl;
|
|
}
|
|
else
|
|
{
|
|
// the date is invalid
|
|
std::cout << "Invalid date" << std::endl;
|
|
}
|
|
//]
|
|
}
|
|
{
|
|
//[time_types_datetime
|
|
datetime dt1(2020, 10, 11, 10, 20, 59, 123456); // regular datetime 2020-10-11 10:20:59.123456
|
|
bool v1 = dt1.valid(); // true
|
|
datetime dt2(2020, 0, 11, 10, 20, 59); // invalid datetime 2020-00-10 10:20:59.000000
|
|
bool v2 = dt2.valid(); // false
|
|
|
|
datetime::time_point tp = dt1.as_time_point(); // convert to time_point
|
|
|
|
//]
|
|
ASSERT(v1);
|
|
ASSERT(!v2);
|
|
ASSERT(datetime(tp) == dt1);
|
|
}
|
|
{
|
|
//[time_types_timestamp_setup
|
|
results result;
|
|
conn.execute(
|
|
R"%(
|
|
CREATE TEMPORARY TABLE events (
|
|
id INT PRIMARY KEY AUTO_INCREMENT,
|
|
t TIMESTAMP,
|
|
contents VARCHAR(256)
|
|
)
|
|
)%",
|
|
result
|
|
);
|
|
//]
|
|
|
|
//[time_types_timestamp_stmts
|
|
auto insert_stmt = conn.prepare_statement("INSERT INTO events (t, contents) VALUES (?, ?)");
|
|
auto select_stmt = conn.prepare_statement("SELECT id, t, contents FROM events WHERE t > ?");
|
|
//]
|
|
|
|
//[time_types_timestamp_set_time_zone
|
|
// This change has session scope. All operations after this query
|
|
// will now use UTC for TIMESTAMPs. Other sessions will not see the change.
|
|
// If you need to reconnect the connection, you need to run this again.
|
|
// If your MySQL server supports named time zones, you can also use
|
|
// "SET time_zone = 'UTC'"
|
|
conn.execute("SET time_zone = '+00:00'", result);
|
|
//]
|
|
|
|
//[time_types_timestamp_insert
|
|
// Get the timestamp of the event. This may have been provided by an external system
|
|
// For the sake of example, we will use the current timestamp
|
|
datetime event_timestamp = datetime::now();
|
|
|
|
// event_timestamp will be interpreted as UTC if you have run SET time_zone
|
|
conn.execute(insert_stmt.bind(event_timestamp, "Something happened"), result);
|
|
//]
|
|
|
|
//[time_types_timestamp_select
|
|
// Get the timestamp threshold from the user. We will use a constant for the sake of example
|
|
datetime threshold = datetime(2022, 1, 1); // get events that happened after 2022-01-01
|
|
|
|
// threshold will be interpreted as UTC. The retrieved events will have their
|
|
// `t` column in UTC
|
|
conn.execute(select_stmt.bind(threshold), result);
|
|
//]
|
|
}
|
|
}
|
|
|
|
//[any_connection_tcp
|
|
void create_and_connect(
|
|
string_view server_hostname,
|
|
string_view username,
|
|
string_view password,
|
|
string_view database
|
|
)
|
|
{
|
|
// connect_params contains all the info required to establish a session
|
|
boost::mysql::connect_params params;
|
|
params.server_address.emplace_host_and_port(server_hostname); // server host
|
|
params.username = username; // username to log in as
|
|
params.password = password; // password to use
|
|
params.database = database; // database to use
|
|
|
|
// The execution context, required to run I/O operations.
|
|
boost::asio::io_context ctx;
|
|
|
|
// A connection to the server. Note how the type doesn't depend
|
|
// on the transport being used.
|
|
boost::mysql::any_connection conn(ctx);
|
|
|
|
// Connect to the server. This will perform hostname resolution,
|
|
// TCP-level connect, and the MySQL handshake. After this function
|
|
// succeeds, your connection is ready to run queries
|
|
conn.connect(params);
|
|
}
|
|
//]
|
|
|
|
// Intentionally not run, since it creates problems in Windows CIs
|
|
//[any_connection_unix
|
|
void create_and_connect_unix(string_view username, string_view password, string_view database)
|
|
{
|
|
// server_address may contain a UNIX socket path, too
|
|
boost::mysql::connect_params params;
|
|
params.server_address.emplace_unix_path("/var/run/mysqld/mysqld.sock");
|
|
params.username = username; // username to log in as
|
|
params.password = password; // password to use
|
|
params.database = database; // database to use
|
|
|
|
// The execution context, required to run I/O operations.
|
|
boost::asio::io_context ctx;
|
|
|
|
// A connection to the server. Note how the type doesn't depend
|
|
// on the transport being used.
|
|
boost::mysql::any_connection conn(ctx);
|
|
|
|
// Connect to the server. This will perform the
|
|
// UNIX socket connect and the MySQL handshake. After this function
|
|
// succeeds, your connection is ready to run queries
|
|
conn.connect(params);
|
|
}
|
|
//]
|
|
|
|
//[any_connection_reconnect
|
|
error_code connect_with_retries(
|
|
boost::mysql::any_connection& conn,
|
|
const boost::mysql::connect_params& params
|
|
)
|
|
{
|
|
// We will be using the non-throwing overloads
|
|
error_code ec;
|
|
diagnostics diag;
|
|
|
|
// Try to connect at most 10 times
|
|
for (int i = 0; i < 10; ++i)
|
|
{
|
|
// Try to connect
|
|
conn.connect(params, ec, diag);
|
|
|
|
// If we succeeded, we're done
|
|
if (!ec)
|
|
return error_code();
|
|
|
|
// Whoops, connect failed. We can sleep and try again
|
|
std::cerr << "Failed connecting to MySQL: " << ec << ": " << diag.server_message() << std::endl;
|
|
std::this_thread::sleep_for(std::chrono::seconds(1));
|
|
}
|
|
|
|
// No luck, retries expired
|
|
return ec;
|
|
}
|
|
//]
|
|
|
|
void section_any_connection(string_view server_hostname, string_view username, string_view password)
|
|
{
|
|
create_and_connect(server_hostname, username, password, "boost_mysql_examples");
|
|
|
|
{
|
|
boost::mysql::connect_params params;
|
|
params.server_address.emplace_host_and_port(server_hostname); // server host
|
|
params.username = username; // username to log in as
|
|
params.password = password; // password to use
|
|
|
|
boost::asio::io_context ctx;
|
|
boost::mysql::any_connection conn(ctx);
|
|
auto ec = connect_with_retries(conn, params);
|
|
ASSERT(ec == error_code());
|
|
}
|
|
|
|
{
|
|
boost::mysql::connect_params params;
|
|
|
|
//[any_connection_ssl_mode
|
|
// Don't ever use TLS, even if the server supports it
|
|
params.ssl = boost::mysql::ssl_mode::disable;
|
|
|
|
// ...
|
|
|
|
// Force using TLS. If the server doesn't support it, reject the connection
|
|
params.ssl = boost::mysql::ssl_mode::require;
|
|
//]
|
|
}
|
|
|
|
{
|
|
//[any_connection_ssl_ctx
|
|
// The I/O context requied to run network operations
|
|
boost::asio::io_context ctx;
|
|
|
|
// Create a SSL context
|
|
boost::asio::ssl::context ssl_ctx(boost::asio::ssl::context::tlsv12_client);
|
|
|
|
// Set options on the SSL context. Load the default certificate authorities
|
|
// and enable certificate verification. connect will fail if the server certificate
|
|
// isn't signed by a trusted entity or its hostname isn't "mysql"
|
|
ssl_ctx.set_default_verify_paths();
|
|
ssl_ctx.set_verify_mode(boost::asio::ssl::verify_peer);
|
|
ssl_ctx.set_verify_callback(boost::asio::ssl::host_name_verification("mysql"));
|
|
|
|
// Construct an any_connection object passing the SSL context.
|
|
// You must keep ssl_ctx alive while using the connection.
|
|
boost::mysql::any_connection_params ctor_params;
|
|
ctor_params.ssl_context = &ssl_ctx;
|
|
boost::mysql::any_connection conn(ctx, ctor_params);
|
|
|
|
// Connect params
|
|
boost::mysql::connect_params params;
|
|
params.server_address.emplace_host_and_port(server_hostname); // server host
|
|
params.username = username; // username to log in as
|
|
params.password = password; // password to use
|
|
params.ssl = boost::mysql::ssl_mode::require; // fail if TLS is not available
|
|
|
|
// Connect
|
|
error_code ec;
|
|
diagnostics diag;
|
|
conn.connect(params, ec, diag);
|
|
if (ec)
|
|
{
|
|
// Handle error
|
|
}
|
|
//]
|
|
ASSERT(ec != error_code());
|
|
ASSERT(ec.category() == boost::asio::error::get_ssl_category());
|
|
}
|
|
}
|
|
|
|
#ifdef BOOST_ASIO_HAS_CO_AWAIT
|
|
//[connection_pool_get_connection
|
|
// Use connection pools for functions that will be called
|
|
// repeatedly during the application lifetime.
|
|
// An HTTP server handler function is a good candidate.
|
|
boost::asio::awaitable<std::int64_t> get_num_employees(boost::mysql::connection_pool& pool)
|
|
{
|
|
// Get a fresh connection from the pool.
|
|
// pooled_connection is a proxy to an any_connection object.
|
|
boost::mysql::pooled_connection conn = co_await pool.async_get_connection(boost::asio::use_awaitable);
|
|
|
|
// Use pooled_connection::operator-> to access the underlying any_connection.
|
|
// Let's use the connection
|
|
results result;
|
|
co_await conn->async_execute("SELECT COUNT(*) FROM employee", result, boost::asio::use_awaitable);
|
|
co_return result.rows().at(0).at(0).as_int64();
|
|
|
|
// When conn is destroyed, the connection is returned to the pool
|
|
}
|
|
//]
|
|
|
|
boost::asio::awaitable<void> return_without_reset(boost::mysql::connection_pool& pool)
|
|
{
|
|
//[connection_pool_return_without_reset
|
|
// Get a connection from the pool
|
|
boost::mysql::pooled_connection conn = co_await pool.async_get_connection(boost::asio::use_awaitable);
|
|
|
|
// Use the connection in a way that doesn't mutate session state.
|
|
// We're not setting variables, preparing statements or starting transactions,
|
|
// so it's safe to skip reset
|
|
boost::mysql::results result;
|
|
co_await conn->async_execute("SELECT COUNT(*) FROM employee", result, boost::asio::use_awaitable);
|
|
|
|
// Explicitly return the connection to the pool, skipping reset
|
|
conn.return_without_reset();
|
|
//]
|
|
}
|
|
#endif
|
|
|
|
//[connection_pool_sync
|
|
// Wraps a connection_pool and offers a sync interface.
|
|
// sync_pool is thread-safe
|
|
class sync_pool
|
|
{
|
|
// A thread pool with a single thread. This is used to
|
|
// run the connection pool. The thread is automatically
|
|
// joined when sync_pool is destroyed.
|
|
boost::asio::thread_pool thread_pool_{1};
|
|
|
|
// The async connection pool
|
|
boost::mysql::connection_pool conn_pool_;
|
|
|
|
public:
|
|
// Constructor: constructs the connection_pool object from
|
|
// the single-thread pool and calls async_run.
|
|
// The pool has a single thread, which creates an implicit strand.
|
|
// There is no need to use pool_executor_params::thread_safe
|
|
sync_pool(boost::mysql::pool_params params) : conn_pool_(thread_pool_, std::move(params))
|
|
{
|
|
// Run the pool in the background (this is performed by the thread_pool thread).
|
|
// When sync_pool is destroyed, this task will be stopped and joined automatically.
|
|
conn_pool_.async_run(boost::asio::detached);
|
|
}
|
|
|
|
// Retrieves a connection from the pool (error code version)
|
|
boost::mysql::pooled_connection get_connection(
|
|
boost::mysql::error_code& ec,
|
|
boost::mysql::diagnostics& diag,
|
|
std::chrono::steady_clock::duration timeout = std::chrono::seconds(30)
|
|
)
|
|
{
|
|
// The completion token to use for the async initiation function.
|
|
// use_future will make the async function return a std::future object, which will
|
|
// become ready when the operation completes.
|
|
// as_tuple prevents the future from throwing on error, and packages the result as a tuple.
|
|
// The returned future will be std::future<std::tuple<error_code, pooled_connection>>.
|
|
constexpr auto completion_token = boost::asio::as_tuple(boost::asio::use_future);
|
|
|
|
// We will use std::tie to decompose the tuple into its components.
|
|
// We need to declare the connection before using std::tie
|
|
boost::mysql::pooled_connection res;
|
|
|
|
// async_get_connection returns a future. Calling std::future::get will
|
|
// wait for the future to become ready
|
|
std::tie(ec, res) = conn_pool_.async_get_connection(timeout, diag, completion_token).get();
|
|
|
|
// Done!
|
|
return res;
|
|
}
|
|
|
|
// Retrieves a connection from the pool (exception version)
|
|
boost::mysql::pooled_connection get_connection(
|
|
std::chrono::steady_clock::duration timeout = std::chrono::seconds(30)
|
|
)
|
|
{
|
|
// Call the error code version
|
|
boost::mysql::error_code ec;
|
|
boost::mysql::diagnostics diag;
|
|
auto res = get_connection(ec, diag, timeout);
|
|
|
|
// This will throw boost::mysql::error_with_diagnostics on error
|
|
boost::mysql::throw_on_error(ec, diag);
|
|
|
|
// Done
|
|
return res;
|
|
}
|
|
};
|
|
//]
|
|
|
|
void section_connection_pool(string_view server_hostname, string_view username, string_view password)
|
|
{
|
|
{
|
|
//[connection_pool_create
|
|
// pool_params contains configuration for the pool.
|
|
// You must specify enough information to establish a connection,
|
|
// including the server address and credentials.
|
|
// You can configure a lot of other things, like pool limits
|
|
boost::mysql::pool_params params;
|
|
params.server_address.emplace_host_and_port(server_hostname);
|
|
params.username = username;
|
|
params.password = password;
|
|
params.database = "boost_mysql_examples";
|
|
|
|
// The I/O context, required by all I/O operations
|
|
boost::asio::io_context ctx;
|
|
|
|
// Construct a pool of connections. The context will be used internally
|
|
// to create the connections and other I/O objects
|
|
boost::mysql::connection_pool pool(ctx, std::move(params));
|
|
|
|
// You need to call async_run on the pool before doing anything useful with it.
|
|
// async_run creates connections and keeps them healthy. It must be called
|
|
// only once per pool.
|
|
// The detached completion token means that we don't want to be notified when
|
|
// the operation ends. It's similar to a no-op callback.
|
|
pool.async_run(boost::asio::detached);
|
|
//]
|
|
|
|
#ifdef BOOST_ASIO_HAS_CO_AWAIT
|
|
run_coro(ctx.get_executor(), [&pool]() -> boost::asio::awaitable<void> {
|
|
co_await get_num_employees(pool);
|
|
pool.cancel();
|
|
});
|
|
#endif
|
|
}
|
|
{
|
|
boost::asio::io_context ctx;
|
|
|
|
//[connection_pool_configure_size
|
|
boost::mysql::pool_params params;
|
|
|
|
// Set the usual params
|
|
params.server_address.emplace_host_and_port(server_hostname);
|
|
params.username = username;
|
|
params.password = password;
|
|
params.database = "boost_mysql_examples";
|
|
|
|
// Create 10 connections at startup, and allow up to 1000 connections
|
|
params.initial_size = 10;
|
|
params.max_size = 1000;
|
|
|
|
boost::mysql::connection_pool pool(ctx, std::move(params));
|
|
//]
|
|
|
|
#ifdef BOOST_ASIO_HAS_CO_AWAIT
|
|
pool.async_run(boost::asio::detached);
|
|
run_coro(ctx.get_executor(), [&pool]() -> boost::asio::awaitable<void> {
|
|
co_await return_without_reset(pool);
|
|
pool.cancel();
|
|
});
|
|
#endif
|
|
}
|
|
{
|
|
//[connection_pool_thread_safe
|
|
// The I/O context, required by all I/O operations
|
|
boost::asio::io_context ctx;
|
|
|
|
// The usual pool configuration params
|
|
boost::mysql::pool_params params;
|
|
params.server_address.emplace_host_and_port(server_hostname);
|
|
params.username = username;
|
|
params.password = password;
|
|
params.database = "boost_mysql_examples";
|
|
|
|
// By passing pool_executor_params::thread_safe to connection_pool,
|
|
// we make all its member functions thread-safe.
|
|
// This works by creating a strand.
|
|
boost::mysql::connection_pool pool(
|
|
boost::mysql::pool_executor_params::thread_safe(ctx.get_executor()),
|
|
std::move(params)
|
|
);
|
|
|
|
// We can now pass a reference to pool to other threads,
|
|
// and call async_get_connection concurrently without problem.
|
|
// Inidivudal connections are still not thread-safe.
|
|
//]
|
|
}
|
|
{
|
|
boost::mysql::pool_params params;
|
|
params.server_address.emplace_host_and_port(server_hostname);
|
|
params.username = username;
|
|
params.password = password;
|
|
params.database = "boost_mysql_examples";
|
|
|
|
sync_pool spool(std::move(params));
|
|
|
|
auto conn1 = spool.get_connection();
|
|
ASSERT(conn1.valid());
|
|
}
|
|
}
|
|
|
|
void main_impl(int argc, char** argv)
|
|
{
|
|
if (argc != 4)
|
|
{
|
|
std::cerr << "Usage: " << argv[0] << " <username> <password> <server-hostname>\n";
|
|
exit(1);
|
|
}
|
|
|
|
//
|
|
// setup and connect - this is included in overview, too
|
|
//
|
|
|
|
//[overview_connection
|
|
// The execution context, required to run I/O operations.
|
|
boost::asio::io_context ctx;
|
|
|
|
// The SSL context, required to establish TLS connections.
|
|
// The default SSL options are good enough for us at this point.
|
|
boost::asio::ssl::context ssl_ctx(boost::asio::ssl::context::tls_client);
|
|
|
|
// Represents a connection to the MySQL server.
|
|
boost::mysql::tcp_ssl_connection conn(ctx.get_executor(), ssl_ctx);
|
|
//]
|
|
|
|
//[overview_connect
|
|
// Resolve the hostname to get a collection of endpoints
|
|
boost::asio::ip::tcp::resolver resolver(ctx.get_executor());
|
|
auto endpoints = resolver.resolve(argv[3], boost::mysql::default_port_string);
|
|
|
|
// The username and password to use
|
|
boost::mysql::handshake_params params(
|
|
argv[1], // username
|
|
argv[2], // password
|
|
"boost_mysql_examples" // database
|
|
);
|
|
|
|
// Connect to the server using the first endpoint returned by the resolver
|
|
conn.connect(*endpoints.begin(), params);
|
|
//]
|
|
|
|
section_overview(conn);
|
|
section_dynamic(conn);
|
|
section_static(conn);
|
|
section_prepared_statements(conn);
|
|
section_multi_resultset(conn);
|
|
section_multi_resultset_multi_queries(argv);
|
|
section_multi_function(conn);
|
|
section_metadata(conn);
|
|
section_charsets(conn);
|
|
section_time_types(conn);
|
|
section_any_connection(argv[3], argv[1], argv[2]);
|
|
section_connection_pool(argv[3], argv[1], argv[2]);
|
|
|
|
conn.close();
|
|
}
|
|
|
|
int main(int argc, char** argv)
|
|
{
|
|
try
|
|
{
|
|
main_impl(argc, argv);
|
|
}
|
|
catch (const boost::mysql::error_with_diagnostics& err)
|
|
{
|
|
std::cerr << "Error: " << err.what() << '\n'
|
|
<< "Server diagnostics: " << err.get_diagnostics().server_message() << std::endl;
|
|
return 1;
|
|
}
|
|
catch (const std::exception& err)
|
|
{
|
|
std::cerr << "Error: " << err.what() << std::endl;
|
|
return 1;
|
|
}
|
|
}
|