Rename mysql_database to mysql_connection and raw_sql to sql_raw

Author: Pierre-Luc Gagné

README.md

@@ -67,7 +67,7 @@ struct product {
 // preventing accidental cross-table column mixing.
 
 // 2. Connect and query
-auto db = mysql_database::connect(mysql_config{
+auto db = mysql_connection::connect(mysql_config{
     host_name{"127.0.0.1"},
     database_name{"my_db"},
     auth_credentials{user_name{"root"}, user_password{"secret"}},
@@ -180,7 +180,7 @@ stable wrapper/fallback. In CMake builds, a generated
 
 ```cpp
 // Explicit parameters
-auto db = mysql_database::connect(
+auto db = mysql_connection::connect(
     host_name{"127.0.0.1"},
     database_name{"my_db"},
     auth_credentials{user_name{"root"}, user_password{"secret"}},
@@ -191,7 +191,7 @@ auto db = mysql_database::connect(
 mysql_config cfg{host_name{"127.0.0.1"}, database_name{"my_db"},
                  auth_credentials{user_name{"root"}, user_password{""}},
                  port_number{3306}};
-auto db = mysql_database::connect(cfg).value();
+auto db = mysql_connection::connect(cfg).value();
 ```
 
 ### DDL (CREATE, DROP)

docs/DEVELOPMENT.md

@@ -27,7 +27,7 @@ DSMySQL is a header-only library. All functionality lives in `lib/include/ds_mys
 1. Create a new header under `lib/include/ds_mysql/`
 2. Use `#pragma once`
 3. Put all code in the `ds_mysql` namespace
-4. Include it transitively through `ds_mysql/database.hpp`, `ds_mysql/metadata.hpp`, `ds_mysql/sql_ddl.hpp`, `ds_mysql/sql_dml.hpp`, or `ds_mysql/sql_dql.hpp` if appropriate (these are pulled in by the `ds_mysql/ds_mysql.hpp` umbrella header)
+4. Include it transitively through `ds_mysql/mysql_connection.hpp`, `ds_mysql/metadata.hpp`, `ds_mysql/sql_ddl.hpp`, `ds_mysql/sql_dml.hpp`, or `ds_mysql/sql_dql.hpp` if appropriate (these are pulled in by the `ds_mysql/ds_mysql.hpp` umbrella header)
 
 ## Adding Unit Tests
 

docs/QUICKREF.md

@@ -49,7 +49,7 @@ DSMySQL/
 | Header | Purpose |
 | ------ | ------- |
 | `ds_mysql.hpp` | **Umbrella header** — include this to get everything |
-| `ds_mysql/database.hpp` | MySQL connection & queries |
+| `ds_mysql/mysql_connection.hpp` | MySQL connection & queries |
 | `ds_mysql/sql_ddl.hpp` | DDL query builder (CREATE / DROP / ALTER / ...) |
 | `ds_mysql/sql_dml.hpp` | DML query builder (INSERT / UPDATE / DELETE / DESCRIBE / ...) |
 | `ds_mysql/sql_dql.hpp` | DQL query builder (SELECT / projections / expressions / ...) |

examples/basic_query.cpp

@@ -57,7 +57,7 @@ struct product {
 
 int main() {
     // --- Connect ---
-    auto db_result = ds_mysql::mysql_database::connect(ds_mysql::mysql_config{
+    auto db_result = ds_mysql::mysql_connection::connect(ds_mysql::mysql_config{
         ds_mysql::host_name{host},
         ds_mysql::database_name{database},
         ds_mysql::auth_credentials{ds_mysql::user_name{user}, ds_mysql::user_password{password}},

lib/include/ds_mysql/database.hpp

@@ -24,26 +24,26 @@
 namespace ds_mysql {
 
 // ===================================================================
-// raw_sql — explicit escape hatch for raw SQL strings.
+// sql_raw — explicit escape hatch for raw SQL strings.
 //
 // Use this only when none of the typed builders in sql_ddl.hpp, sql_dml.hpp,
 // or sql_dql.hpp cover your
 // case. Always returns std::expected<std::vector<std::vector<std::optional<std::string>>>, std::string>.
 // Each inner vector is a row; each element is a nullable cell value.
 // DDL / DML statements that produce no result set return an empty outer vector.
 //
-//   db.query(raw_sql{"SELECT @@version"})
-//   db.query(raw_sql{"DROP TABLE foo"})
+//   db.query(sql_raw{"SELECT @@version"})
+//   db.query(sql_raw{"DROP TABLE foo"})
 // ===================================================================
 
-class raw_sql {
+class sql_raw {
 public:
-    explicit raw_sql(std::string s) : sql(std::move(s)) {
+    explicit sql_raw(std::string s) : sql(std::move(s)) {
     }
-    explicit raw_sql(std::string_view s) : sql(s) {
+    explicit sql_raw(std::string_view s) : sql(s) {
     }
     // NOLINTNEXTLINE(google-explicit-constructor)
-    explicit raw_sql(char const* s) : sql(s) {
+    explicit sql_raw(char const* s) : sql(s) {
     }
 
     [[nodiscard]] std::string const& build_sql() const noexcept {
@@ -121,15 +121,15 @@ void validate_table_fields(std::vector<describe_row_type> const& rows, std::stri
 }  // namespace detail
 
 // ===================================================================
-// mysql_database — thin wrapper around the MySQL C API.
+// mysql_connection — thin wrapper around the MySQL C API.
 //
 // Provides type-safe query() and execute() methods that accept any builder
-// from sql_ddl.hpp, sql_dml.hpp, and sql_dql.hpp, plus a raw_sql overload
+// from sql_ddl.hpp, sql_dml.hpp, and sql_dql.hpp, plus a sql_raw overload
 // for unhandled cases.
 //
 // Factory methods:
-//   mysql_database::connect(host, database, credentials, port)
-//   mysql_database::connect(mysql_config)
+//   mysql_connection::connect(host, database, credentials, port)
+//   mysql_connection::connect(mysql_config)
 //
 // Typed query — SELECT, DESCRIBE, COUNT, aggregate queries:
 //   db.query(select<symbol::id, symbol::ticker>().from<symbol>())
@@ -143,24 +143,24 @@ void validate_table_fields(std::vector<describe_row_type> const& rows, std::stri
 //   → returns std::expected<void, std::string>
 //
 // Raw SQL (not type-safe — use only as a last resort):
-//   db.query(raw_sql{"DROP TABLE foo"})     → empty vector (DDL / DML)
-//   db.query(raw_sql{"SELECT @@version"})  → vector<vector<optional<string>>>
+//   db.query(sql_raw{"DROP TABLE foo"})     → empty vector (DDL / DML)
+//   db.query(sql_raw{"SELECT @@version"})  → vector<vector<optional<string>>>
 // ===================================================================
 
-class mysql_database {
+class mysql_connection {
 public:
-    mysql_database(mysql_database const&) = delete;
-    mysql_database& operator=(mysql_database const&) = delete;
+    mysql_connection(mysql_connection const&) = delete;
+    mysql_connection& operator=(mysql_connection const&) = delete;
 
-    mysql_database(mysql_database&&) noexcept = default;
-    mysql_database& operator=(mysql_database&&) noexcept = default;
-    ~mysql_database() = default;
+    mysql_connection(mysql_connection&&) noexcept = default;
+    mysql_connection& operator=(mysql_connection&&) noexcept = default;
+    ~mysql_connection() = default;
 
     // Factory: connect with explicit parameters.
-    [[nodiscard]] static std::expected<mysql_database, std::string> connect(host_name const& host,
-                                                                            database_name const& database,
-                                                                            auth_credentials const& credentials,
-                                                                            port_number port = default_mysql_port) {
+    [[nodiscard]] static std::expected<mysql_connection, std::string> connect(host_name const& host,
+                                                                              database_name const& database,
+                                                                              auth_credentials const& credentials,
+                                                                              port_number port = default_mysql_port) {
         auto conn = std::unique_ptr<MYSQL, decltype(&mysql_close)>(mysql_init(nullptr), mysql_close);
         if (!conn) {
             return std::unexpected(std::string("mysql_init failed"));
@@ -172,11 +172,11 @@ class mysql_database {
             return std::unexpected(std::string(mysql_error(conn.get())));
         }
 
-        return mysql_database{std::move(conn)};
+        return mysql_connection{std::move(conn)};
     }
 
     // Factory: connect with a mysql_config object.
-    [[nodiscard]] static std::expected<mysql_database, std::string> connect(mysql_config const& config) {
+    [[nodiscard]] static std::expected<mysql_connection, std::string> connect(mysql_config const& config) {
         return connect(config.host(), config.database(), config.credentials(), config.port());
     }
 
@@ -206,7 +206,7 @@ class mysql_database {
     // Raw SQL — not type-safe, use only when no typed builder covers the case.
     // Each inner vector is a row; each element is a nullable cell value.
     // DDL / DML statements that produce no result set return as an empty outer vector.
-    [[nodiscard]] std::expected<std::vector<raw_result_row_type>, std::string> query(raw_sql const& stmt) const {
+    [[nodiscard]] std::expected<std::vector<raw_result_row_type>, std::string> query(sql_raw const& stmt) const {
         return query(stmt.build_sql())
             .and_then([this]() {
                 return store_result();
@@ -403,7 +403,7 @@ class mysql_database {
             ...);
     }
 
-    explicit mysql_database(std::unique_ptr<MYSQL, decltype(&mysql_close)> connection)
+    explicit mysql_connection(std::unique_ptr<MYSQL, decltype(&mysql_close)> connection)
         : connection_(std::move(connection)) {
     }
 
@@ -414,4 +414,6 @@ class mysql_database {
     std::unique_ptr<MYSQL, decltype(&mysql_close)> connection_;
 };
 
+using mysql_database = mysql_connection;
+
 }  // namespace ds_mysql

lib/include/ds_mysql/ds_mysql.hpp

@@ -3,7 +3,7 @@
 // Convenience header — include everything needed to work with DSMySQL.
 //
 // Transitively provides:
-//   database.hpp        — database connection, query execution, result sets
+//   mysql_connection.hpp — database connection, query execution, result sets
 //   sql_ddl.hpp         — DDL query builder (CREATE / DROP / ALTER / ...)
 //   sql_dml.hpp         — DML query builder (INSERT / UPDATE / DELETE / DESCRIBE / ...)
 //   sql_dql.hpp         — DQL query builder (SELECT / projections / expressions / ...)
@@ -13,8 +13,8 @@
 // sql_temporal, sql_varchar, sql_text, config, credentials, …) are
 // pulled in transitively by the headers above.
 
-#include "ds_mysql/database.hpp"
 #include "ds_mysql/metadata.hpp"
+#include "ds_mysql/mysql_connection.hpp"
 #include "ds_mysql/sql_ddl.hpp"
 #include "ds_mysql/sql_dml.hpp"
 #include "ds_mysql/sql_dql.hpp"