hyperapi::TableDefinition Class Reference

A table definition. More...

#include <TableDefinition.hpp>

Classes
class	Column
	A Column of a table definition. More...

Public Types
using	column_index_type = hyper_field_index_t
	Type of a column index.

Public Member Functions
	TableDefinition (TableName name, Persistence persistence=Persistence::Permanent)
	Creates a table definition with the given name and no columns.
	TableDefinition (TableName name, std::vector< Column > columns, Persistence persistence=Persistence::Permanent)
	Creates a table definition with the given name and columns.
const std::vector< Column > &	getColumns () const noexcept
	Returns all columns.
const Column &	getColumn (hyper_field_index_t columnIndex) const
	Returns the column at the given position.
const Column *	getColumnByName (const Name &s) const noexcept
	Returns the column with the given name.
optional< hyper_field_index_t >	getColumnPositionByName (const Name &s) const noexcept
	Returns the position of the column with the given name.
size_t	getColumnCount () const noexcept
	Returns the numbers of columns.
Persistence	getPersistence () const noexcept
	Returns the table persistence.
const TableName &	getTableName () const noexcept
	Returns the name of the table.
TableDefinition &	addColumn (Column &&c) noexcept
	Adds a column to the definition.
TableDefinition &	addColumn (const Column &c) noexcept
	Adds a column to the definition.
TableDefinition &	setTableName (TableName n) noexcept
	Sets the table's name.
TableDefinition &	setPersistence (Persistence p) noexcept
	Sets the table's persistence.

Detailed Description

A table definition.

Contains a table name as well as possibly multiple descriptions of columns.

Examples

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

Definition at line 44 of file TableDefinition.hpp.

Member Typedef Documentation

column_index_type

using hyperapi::TableDefinition::column_index_type = hyper_field_index_t

Type of a column index.

Definition at line 47 of file TableDefinition.hpp.

Constructor & Destructor Documentation

TableDefinition() [1/2]

hyperapi::TableDefinition::TableDefinition ( TableName  name, Persistence  persistence = Persistence::Permanent  )

explicit

Creates a table definition with the given name and no columns.

Parameters

name	The name of the table.
persistence	The persistence of the table.

TableDefinition() [2/2]

hyperapi::TableDefinition::TableDefinition ( TableName  name, std::vector< Column >  columns, Persistence  persistence = Persistence::Permanent  )

explicit

Creates a table definition with the given name and columns.

Parameters

name	The name of the table.
columns	The columns of the table.
persistence	The persistence of the table.

Member Function Documentation

addColumn() [1/2]

TableDefinition & hyperapi::TableDefinition::addColumn ( Column &&  c )

noexcept

Adds a column to the definition.

Parameters

c	The column to add.

Returns

*this, to allow call chaining.

addColumn() [2/2]

TableDefinition & hyperapi::TableDefinition::addColumn ( const Column &  c )

noexcept

Adds a column to the definition.

Parameters

c	The column to add.

Returns

*this, to allow call chaining.

getColumn()

const Column & hyperapi::TableDefinition::getColumn

(

hyper_field_index_t

columnIndex

)

const

Returns the column at the given position.

Parameters

columnIndex

The index of the column

Returns

The column at the given position (staring with 0).

Precondition

0 <= columnIndex < getColumnCount()

getColumnByName()

const Column * hyperapi::TableDefinition::getColumnByName ( const Name &  s ) const

noexcept

Returns the column with the given name.

Parameters

s	The name of the column

Returns

The column with the given name or nullptr if no such column exists.

getColumnCount()

size_t hyperapi::TableDefinition::getColumnCount ( ) const

inlinenoexcept

Returns the numbers of columns.

Definition at line 151 of file TableDefinition.hpp.

getColumnPositionByName()

optional< hyper_field_index_t > hyperapi::TableDefinition::getColumnPositionByName ( const Name &  s ) const

noexcept

Returns the position of the column with the given name.

Parameters

s	The name of the column

Returns

The position of the column with the given name if such column exists.

getColumns()

const std::vector< Column > & hyperapi::TableDefinition::getColumns ( ) const

inlinenoexcept

Returns all columns.

Definition at line 124 of file TableDefinition.hpp.

getPersistence()

Persistence hyperapi::TableDefinition::getPersistence ( ) const

inlinenoexcept

Returns the table persistence.

Definition at line 156 of file TableDefinition.hpp.

getTableName()

const TableName & hyperapi::TableDefinition::getTableName ( ) const

inlinenoexcept

Returns the name of the table.

Examples

read_and_print_data_from_existing_hyper_file.cpp.

Definition at line 161 of file TableDefinition.hpp.

setPersistence()

TableDefinition & hyperapi::TableDefinition::setPersistence ( Persistence  p )

noexcept

Sets the table's persistence.

Parameters

p	The new persistence

Returns

*this, to allow call chaining.

setTableName()

TableDefinition & hyperapi::TableDefinition::setTableName ( TableName  n )

noexcept

Sets the table's name.

Parameters

n	The new name.

Returns

*this, to allow call chaining.

---

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

• hyperapi/TableDefinition.hpp