ignite::column_metadata Class Reference

#include <column_metadata.h>

Public Member Functions
	column_metadata (std::string name, ignite_type type, std::int32_t precision, std::int32_t scale, bool nullable, column_origin origin)
const std::string &	name () const
ignite_type	type () const
std::int32_t	precision () const
std::int32_t	scale () const
bool	nullable () const
const column_origin &	origin () const

Detailed Description

Column metadata.

Constructor & Destructor Documentation

column_metadata()

ignite::column_metadata::column_metadata ( std::string name, ignite_type type, std::int32_t precision, std::int32_t scale, bool nullable, column_origin origin )

inline

Constructor.

Parameters

name	Column name.
type	Column type.
precision	Precision.
scale	Scale.
nullable	Column nullability.
origin	Column origin.

Member Function Documentation

name()

const std::string & ignite::column_metadata::name ( ) const

inlinenodiscard

Gets the column name.

Returns

Column name.

nullable()

bool ignite::column_metadata::nullable ( ) const

inlinenodiscard

Gets a value indicating whether the column is nullable.

Returns

A value indicating whether the column is nullable.

origin()

const column_origin & ignite::column_metadata::origin ( ) const

inlinenodiscard

Gets the column origin.

For example, for "select foo as bar" query, column name will be "bar", but origin name will be "foo".

Returns

The column origin.

precision()

std::int32_t ignite::column_metadata::precision ( ) const

inlinenodiscard

Gets the column precision, or -1 when not applicable to the current column type.

Returns

Number of decimal digits for exact numeric types; number of decimal digits in mantissa for approximate numeric types; number of decimal digits for fractional seconds of datetime types; length in characters for character types; length in bytes for binary types; length in bits for bit types; 1 for BOOLEAN; -1 if precision is not valid for the type.

scale()

std::int32_t ignite::column_metadata::scale ( ) const

inlinenodiscard

Gets the column scale.

Returns

Number of digits of scale.

type()

ignite_type ignite::column_metadata::type ( ) const

inlinenodiscard

Gets the column type.

Returns

Column type.

---

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

• ignite/client/sql/column_metadata.h