hyperapi::DatabaseName Class Reference

Represents an escaped SQL database name. More...

#include <DatabaseName.hpp>

Public Member Functions
	DatabaseName (Name name)
	Constructs a properly quoted and escaped SQL Database name.
	DatabaseName (std::string name)
	Constructs a properly quoted and escaped SQL Database name.
	DatabaseName (const char *name)
	Constructs a properly quoted and escaped SQL Database name.
const std::string &	toString () const noexcept
	Returns the properly quoted and escaped string representation of this name.
const Name &	getName () const noexcept

Detailed Description

Represents an escaped SQL database name.

Definition at line 12 of file DatabaseName.hpp.

Constructor & Destructor Documentation

DatabaseName() [1/3]

hyperapi::DatabaseName::DatabaseName ( Name  name )

inline

Constructs a properly quoted and escaped SQL Database name.

The name will be equal to the return value of calling hyperapi::escapeName(name).

Parameters

name

The name

Precondition

!name.isEmpty()

Definition at line 20 of file DatabaseName.hpp.

DatabaseName() [2/3]

hyperapi::DatabaseName::DatabaseName ( std::string  name )

inline

Constructs a properly quoted and escaped SQL Database name.

The name will be equal to the return value of calling hyperapi::escapeName(name).

Parameters

name

The name

Precondition

!name.isEmpty()

Definition at line 23 of file DatabaseName.hpp.

DatabaseName() [3/3]

hyperapi::DatabaseName::DatabaseName ( const char *  name )

inline

Constructs a properly quoted and escaped SQL Database name.

The name will be equal to the return value of calling hyperapi::escapeName(name).

Parameters

name

The name

Precondition

!name.isEmpty()

name != nullptr

Definition at line 29 of file DatabaseName.hpp.

Member Function Documentation

getName()

const Name & hyperapi::DatabaseName::getName ( ) const

inlinenoexcept

Returns

The contained name.

Definition at line 40 of file DatabaseName.hpp.

toString()

const std::string & hyperapi::DatabaseName::toString ( ) const

inlinenoexcept

Returns the properly quoted and escaped string representation of this name.

Returns

The string representation.

Definition at line 35 of file DatabaseName.hpp.

---

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

• hyperapi/DatabaseName.hpp