hyperapi::TableDefinition::Column Class Reference

A Column of a table definition. More...

#include <TableDefinition.hpp>

Public Member Functions
const Name &	getName () const noexcept
	Returns the name of the column.
const SqlType &	getType () const noexcept
	Returns the type of the column.
Nullability	getNullability () const noexcept
	Returns the Nullability of the column.
const std::string &	getCollation () const noexcept
	Returns the collation of the column.
	Column (Name name, SqlType type, Nullability nullability=Nullability::Nullable)
	Creates a column.
	Column (Name name, SqlType type, std::string collation, Nullability nullability=Nullability::Nullable)
	Creates a column.

Detailed Description

A Column of a table definition.

Examples

create_hyper_file_from_csv.cpp, insert_data_into_multiple_tables.cpp, insert_data_into_single_table.cpp, insert_data_with_expressions.cpp, and insert_geospatial_data_to_a_hyper_file.cpp.

Definition at line 49 of file TableDefinition.hpp.

Constructor & Destructor Documentation

Column() [1/2]

hyperapi::TableDefinition::Column::Column	(	Name	name,
		SqlType	type,
		Nullability	nullability = Nullability::Nullable
	)

Creates a column.

Parameters

name	The name
type	The type
nullability	The nullability

Column() [2/2]

hyperapi::TableDefinition::Column::Column	(	Name	name,
		SqlType	type,
		std::string	collation,
		Nullability	nullability = Nullability::Nullable
	)

Creates a column.

Parameters

name	The name
type	The type
collation	The collation
nullability	The nullability

Precondition

The type supports collations.

Member Function Documentation

getCollation()

const std::string & hyperapi::TableDefinition::Column::getCollation ( ) const

inlinenoexcept

Returns the collation of the column.

Definition at line 69 of file TableDefinition.hpp.

getName()

const Name & hyperapi::TableDefinition::Column::getName ( ) const

inlinenoexcept

Returns the name of the column.

Definition at line 54 of file TableDefinition.hpp.

getNullability()

Nullability hyperapi::TableDefinition::Column::getNullability ( ) const

inlinenoexcept

Returns the Nullability of the column.

Definition at line 64 of file TableDefinition.hpp.

getType()

const SqlType & hyperapi::TableDefinition::Column::getType ( ) const

inlinenoexcept

Returns the type of the column.

Definition at line 59 of file TableDefinition.hpp.

---

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

• hyperapi/TableDefinition.hpp