hyperapi::SchemaName Class Reference

Represents an escaped SQL schema name. More...

#include <SchemaName.hpp>

Public Member Functions
	SchemaName (Name name)
	Constructor for a non-qualified schema name.
	SchemaName (std::string name)
	Constructor for a non-qualified schema name.
	SchemaName (const char *name)
	Constructor for a non-qualified schema name.
	SchemaName (DatabaseName databaseName, Name name)
	Constructor for a qualified schema name.
std::string	toString () const
const Name &	getName () const noexcept
const optional< DatabaseName > &	getDatabaseName () const noexcept
bool	isFullyQualified () const noexcept

Detailed Description

Represents an escaped SQL schema name.

Definition at line 13 of file SchemaName.hpp.

Constructor & Destructor Documentation

SchemaName() [1/4]

hyperapi::SchemaName::SchemaName ( Name  name )

inline

Constructor for a non-qualified schema name.

Precondition

!name.isEmpty()

Definition at line 18 of file SchemaName.hpp.

SchemaName() [2/4]

hyperapi::SchemaName::SchemaName ( std::string  name )

inline

Constructor for a non-qualified schema name.

Precondition

!name.isEmpty()

Definition at line 21 of file SchemaName.hpp.

SchemaName() [3/4]

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

inline

Constructor for a non-qualified schema name.

Precondition

!name.isEmpty()

name != nullptr

Definition at line 27 of file SchemaName.hpp.

SchemaName() [4/4]

hyperapi::SchemaName::SchemaName ( DatabaseName  databaseName, Name  name  )

inline

Constructor for a qualified schema name.

Precondition

!name.isEmpty()

Definition at line 32 of file SchemaName.hpp.

Member Function Documentation

getDatabaseName()

const optional< DatabaseName > & hyperapi::SchemaName::getDatabaseName ( ) const

inlinenoexcept

Returns

The optional database name prefix

Definition at line 41 of file SchemaName.hpp.

getName()

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

inlinenoexcept

Returns

The simple schema name without the optional database name prefix

Definition at line 38 of file SchemaName.hpp.

isFullyQualified()

bool hyperapi::SchemaName::isFullyQualified ( ) const

inlinenoexcept

Returns

Whether this name is fully qualified, i.e., whether it has a database name

Definition at line 44 of file SchemaName.hpp.

toString()

std::string hyperapi::SchemaName::toString

(

)

const

Returns

The properly quoted, escaped, and dot-separated string representation of the entire name

---

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

• hyperapi/SchemaName.hpp