Hyper API for C++ 0.0.18161
Hyper client library for C++ applications
Loading...
Searching...
No Matches
hyperapi::TableName Class Reference

Represents an escaped SQL table name. More...

#include <TableName.hpp>

Public Member Functions

 TableName (Name name)
 Constructor for a non-qualified table name.
 
 TableName (std::string name)
 Constructor for a non-qualified table name.
 
 TableName (const char *name)
 Constructor for a non-qualified table name.
 
 TableName (SchemaName schemaName, Name name)
 Constructor for a partly qualified table name.
 
 TableName (DatabaseName databaseName, Name schemaName, Name name)
 Constructor for a fully qualified table name.
 
std::string toString () const
 
const NamegetName () const noexcept
 
const optional< SchemaName > & getSchemaName () const noexcept
 
const optional< DatabaseName > & getDatabaseName () const noexcept
 
bool isFullyQualified () const noexcept
 

Detailed Description

Represents an escaped SQL table name.

Examples
read_and_print_data_from_existing_hyper_file.cpp.

Definition at line 15 of file TableName.hpp.

Constructor & Destructor Documentation

◆ TableName() [1/5]

hyperapi::TableName::TableName ( Name  name)
inline

Constructor for a non-qualified table name.

Definition at line 18 of file TableName.hpp.

◆ TableName() [2/5]

hyperapi::TableName::TableName ( std::string  name)
inline

Constructor for a non-qualified table name.

Definition at line 21 of file TableName.hpp.

◆ TableName() [3/5]

hyperapi::TableName::TableName ( const char *  name)
inline

Constructor for a non-qualified table name.

Precondition
name != nullptr

Definition at line 27 of file TableName.hpp.

◆ TableName() [4/5]

hyperapi::TableName::TableName ( SchemaName  schemaName,
Name  name 
)
inline

Constructor for a partly qualified table name.

Definition at line 30 of file TableName.hpp.

◆ TableName() [5/5]

hyperapi::TableName::TableName ( DatabaseName  databaseName,
Name  schemaName,
Name  name 
)
inline

Constructor for a fully qualified table name.

Definition at line 33 of file TableName.hpp.

Member Function Documentation

◆ getDatabaseName()

const optional< DatabaseName > & hyperapi::TableName::getDatabaseName ( ) const
noexcept
Returns
the optional database name prefix of the optional schema name prefix

◆ getName()

const Name & hyperapi::TableName::getName ( ) const
inlinenoexcept
Returns
The simple schema name without the optional database name prefix
Examples
read_and_print_data_from_existing_hyper_file.cpp.

Definition at line 39 of file TableName.hpp.

◆ getSchemaName()

const optional< SchemaName > & hyperapi::TableName::getSchemaName ( ) const
inlinenoexcept
Returns
the optional schema name prefix

Definition at line 42 of file TableName.hpp.

◆ isFullyQualified()

bool hyperapi::TableName::isFullyQualified ( ) const
inlinenoexcept
Returns
whether this name is fully qualified, i.e., whether it has a schema name and a database name

Definition at line 48 of file TableName.hpp.

◆ toString()

std::string hyperapi::TableName::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: