annadb::AnnaDB Class Reference

Public Member Functions
	AnnaDB (std::string_view username, std::string_view password, std::string_view host, u_short port) noexcept
void	connect () noexcept
void	close () noexcept
std::optional< Journal >	send (std::string_view query) noexcept
std::optional< Journal >	send (annadb::Query::Query &query) noexcept

Constructor & Destructor Documentation

AnnaDB()

annadb::AnnaDB::AnnaDB ( std::string_view  username, std::string_view  password, std::string_view  host, u_short  port  )

inlinenoexcept

Create a new AnnaDB object with settings to enable a connection.

Parameters

username	string
password	string
host	string
port	number

Member Function Documentation

close()

void annadb::AnnaDB::close ( )

inlinenoexcept

close the connection to the AnnaDB

connect()

void annadb::AnnaDB::connect ( )

inlinenoexcept

open a connection with the AnnaDB

send() [1/2]

std::optional< Journal > annadb::AnnaDB::send ( annadb::Query::Query &  query )

inlinenoexcept

Send a TySON formatted query to AnnaDB

Parameters

query

See also

query.annadb::Query::Query

Returns

a Journal object representing the result of the query if successful

send() [2/2]

std::optional< Journal > annadb::AnnaDB::send ( std::string_view  query )

inlinenoexcept

Send a TySON formatted query to AnnaDB

Parameters

query

string in TySON format

Returns

a Journal object representing the result of the query if successful

---

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

• src/connection.hpp