SqlConnection Class Reference

Represents a connection to a SQL database. More...

#include <SqlConnection.hpp>

Public Member Functions
	SqlConnection ()
	Constructs a new SQL connection to the default connection.
	SqlConnection (std::optional< SqlConnectionString > connectInfo)
	Constructs a new SQL connection to the given connect informaton.
	SqlConnection (SqlConnection &&) noexcept
SqlConnection &	operator= (SqlConnection &&) noexcept
	SqlConnection (SqlConnection const &)=delete
SqlConnection &	operator= (SqlConnection const &)=delete
	~SqlConnection () noexcept
	Destructs this SQL connection object,.
uint64_t	ConnectionId () const noexcept
	Retrieves the connection ID.
void	Close () noexcept
	Closes the connection (attempting to put it back into the connect[[ion pool).
bool	Connect (SqlConnectionDataSource const &info) noexcept
bool	Connect (SqlConnectionString sqlConnectionString) noexcept
SqlErrorInfo	LastError () const
	Retrieves the last error information with respect to this SQL connection handle.
std::string	DatabaseName () const
	Retrieves the name of the database in use.
std::string	UserName () const
	Retrieves the name of the user.
std::string	ServerName () const
	Retrieves the name of the server.
std::string	ServerVersion () const
	Retrieves the reported server version.
SqlServerType	ServerType () const noexcept
	Retrieves the type of the server.
SqlQueryFormatter const &	QueryFormatter () const noexcept
	Retrieves a query formatter suitable for the SQL server being connected.
SqlQueryBuilder	Query (std::string_view const &table={}) const
SqlQueryBuilder	QueryAs (std::string_view const &table, std::string_view const &tableAlias) const
SqlMigrationQueryBuilder	Migration () const
	Creates a new migration query builder, compatible the current connection.
bool	TransactionActive () const noexcept
	Tests if a transaction is active.
bool	TransactionsAllowed () const noexcept
	Tests if transactions are allowed.
bool	IsAlive () const noexcept
	Tests if the connection is still active.
SqlConnectionString const &	ConnectionString () const noexcept
	Retrieves the connection information.
SQLHDBC	NativeHandle () const noexcept
	Retrieves the native handle.
std::chrono::steady_clock::time_point	LastUsed () const noexcept
	Retrieves the last time the connection was used.
void	SetLastUsed (std::chrono::steady_clock::time_point lastUsed) noexcept
	Sets the last time the connection was used.
void	RequireSuccess (SQLRETURN sqlResult, std::source_location sourceLocation=std::source_location::current()) const
	Checks the result of an SQL operation, and throws an exception if it is not successful.

Static Public Member Functions
static SqlConnectionString const &	DefaultConnectionString () noexcept
	Retrieves the default connection information.
static void	SetDefaultConnectionString (SqlConnectionString const &connectionString) noexcept
static void	SetDefaultDataSource (SqlConnectionDataSource const &dataSource) noexcept
	Sets the default connection information as SqlConnectionDataSource.
static void	SetPostConnectedHook (std::function< void(SqlConnection &)> hook)
	Sets a callback to be called after each connection being established.
static void	ResetPostConnectedHook ()
	Resets the post connected hook.

Detailed Description

Represents a connection to a SQL database.

Definition at line 36 of file SqlConnection.hpp.

Constructor & Destructor Documentation

SqlConnection() [1/2]

SqlConnection::SqlConnection

(

)

Constructs a new SQL connection to the default connection.

The default connection is set via SetDefaultConnectInfo. In case the default connection is not set, the connection will fail. And in case the connection fails, the last error will be set.

SqlConnection() [2/2]

SqlConnection::SqlConnection ( std::optional< SqlConnectionString >  connectInfo )

explicit

Constructs a new SQL connection to the given connect informaton.

Parameters

connectInfo

The connection information to use. If not provided, no connection will be established.

Member Function Documentation

SetDefaultConnectionString()

static void SqlConnection::SetDefaultConnectionString ( SqlConnectionString const &  connectionString )

staticnoexcept

Sets the default connection information.

Parameters

connectionString

The connection information to use.

ConnectionId()

uint64_t SqlConnection::ConnectionId ( ) const

inlinenoexcept

Retrieves the connection ID.

This is a unique identifier for the connection, which is useful for debugging purposes. Note, this ID will not change if the connection is moved nor when it is reused via the connection pool.

Definition at line 81 of file SqlConnection.hpp.

Connect() [1/2]

bool SqlConnection::Connect ( SqlConnectionDataSource const &  info )

noexcept

Connects to the given database with the given username and password.

Return values

true	if the connection was successful.
false	if the connection failed. Use LastError() to retrieve the error information.

Connect() [2/2]

bool SqlConnection::Connect ( SqlConnectionString  sqlConnectionString )

noexcept

Connects to the given database with the given username and password.

Return values

true	if the connection was successful.
false	if the connection failed. Use LastError() to retrieve the error information.

ServerType()

SqlServerType SqlConnection::ServerType ( ) const

inlinenoexcept

Retrieves the type of the server.

Definition at line 179 of file SqlConnection.hpp.

Referenced by DataMapper::CreateTable(), and SqlQuerySingleBuilder< Record >::Get().

QueryFormatter()

SqlQueryFormatter const & SqlConnection::QueryFormatter ( ) const

inlinenoexcept

Retrieves a query formatter suitable for the SQL server being connected.

Definition at line 184 of file SqlConnection.hpp.

Referenced by SqlStatement::MigrateDirect().

Query()

SqlQueryBuilder SqlConnection::Query

(

std::string_view const &

table = {}

)

const

Creates a new query builder for the given table, compatible with the current connection.

Parameters

table

The table to query. If not provided, the query will be a generic query builder.

Referenced by DataMapper::All(), DataMapper::BuildQuery(), DataMapper::CreateExplicit(), DataMapper::Delete(), DataMapper::FromTable(), DataMapper::QuerySingle(), and DataMapper::Update().

QueryAs()

SqlQueryBuilder SqlConnection::QueryAs	(	std::string_view const &	table,
		std::string_view const &	tableAlias
	)		const

Creates a new query builder for the given table with an alias, compatible with the current connection.

Parameters

table	The table to query.
tableAlias	The alias to use for the table.

NativeHandle()

SQLHDBC SqlConnection::NativeHandle ( ) const

inlinenoexcept

Retrieves the native handle.

Definition at line 150 of file SqlConnection.hpp.

Referenced by SqlTransaction::TryCommit().

---

The documentation for this class was generated from the following file:

• Lightweight/SqlConnection.hpp