StormByte-Database 3.0.0
C++26 database module of the StormByte suite
Loading...
Searching...
No Matches
postgres.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-Database.
5 *
6 * StormByte-Database original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte-Database source in this
20 * repository. They do not cover other StormByte modules or any third-party
21 * material shipped with this repository (including everything under
22 * thirdparty/, and in particular the bundled StormByte-Logger tree and
23 * the PostgreSQL, MariaDB and SQLite trees), which remain under their own
24 * licenses.
25 *
26 * Neither license grants any patent rights. Any patent licenses required
27 * to use this software or third-party components must be obtained separately
28 * from the patent holders.
29 *
30 * StormByte-Database is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU Lesser General Public License for more details.
34 *
35 * You should have received a copy of the GNU Lesser General Public License
36 * version 3 along with StormByte-Database. If not, see
37 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
38 *
39 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
40 */
41
42#pragma once
43
47
48#include <string_view>
49
54namespace StormByte {
59 namespace Database {
64 namespace Postgres {
69 struct ConnectionHandle;
70
79 public:
83 Postgres(const Postgres &db) = delete;
84
89 Postgres(Postgres &&db) noexcept;
90
94 Postgres &operator=(const Postgres &db) = delete;
95
101 Postgres &operator=(Postgres &&db) noexcept;
102
106 ~Postgres() noexcept override;
107
113 ExpectedRows Query(std::string_view query) noexcept override;
114
120 bool SilentQuery(std::string_view query) noexcept override;
121
122 protected:
132 Postgres(std::string_view host, std::string_view user, std::string_view password,
133 std::string_view db_name, const StormByte::Safe::Shared<Logger::Log>& logger,
134 int port = 5432);
135
141 bool DoSilentQuery(std::string_view query) noexcept override;
142
143 private:
144 StormByte::Safe::String m_host;
145 StormByte::Safe::String m_user;
146 StormByte::Safe::String m_password;
147 StormByte::Safe::String m_dbname;
148 int m_port;
149 StormByte::Safe::Unique<ConnectionHandle> m_connection_handle;
150
155 bool DoConnect() noexcept override;
156
160 void DoPreDisconnect() noexcept override;
161
165 void DoDisconnect() noexcept override;
166
173 StormByte::Safe::Unique<StormByte::Database::PreparedSTMT> CreatePreparedSTMT(std::string_view name, std::string_view query) noexcept override;
174
179 void DoBeginTransaction(IsolationLevel level) override;
180 };
181 } }}
182
Database(const StormByte::Safe::Shared< Logger::Log > &logger)
Construct with an optional logger.
PostgreSQL backend.
Definition postgres.hxx:78
bool SilentQuery(std::string_view query) noexcept override
Execute a query that does not return rows.
Postgres(Postgres &&db) noexcept
Move constructor that transfers the database connection.
Postgres & operator=(Postgres &&db) noexcept
Move assignment that transfers the database connection.
ExpectedRows Query(std::string_view query) noexcept override
Execute a query that returns rows.
Postgres & operator=(const Postgres &db)=delete
Copy assignment (deleted).
~Postgres() noexcept override
Destructor.
Postgres(const Postgres &db)=delete
Copy constructor (deleted).
bool DoSilentQuery(std::string_view query) noexcept override
Internal silent query.
PostgreSQL prepared statement (PQexecPrepared).
Definition prepared_stmt.hxx:76
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Logger::Exception)
Database module of the StormByte suite.
Expected< Rows, QueryException > ExpectedRows
Query result: Rows or QueryException.
Definition typedefs.hxx:81
IsolationLevel
Isolation for BeginTransaction().
Definition typedefs.hxx:98
Root namespace of the StormByte C++ suite.
STL namespace.
Private opaque holder for the native MariaDB connection.
#define STORMBYTE_DATABASE_PUBLIC
Definition visibility.h:54