Vertica documentation is moving! Use our new documentation site at https://docs.rocketsoftware.com/bundle/vertica_24.1/page/index.html

Vertica::ServerInterface::RelationDescription Struct Reference

Collaboration diagram for Vertica::ServerInterface::RelationDescription:

Public Types
enum RelDerivationType { RDT_NONE, RDT_PROJECTION, RDT_AGGREGATE, RDT_TOPK, RDT_UDT, RDT_INDEX, RDT_FLEX_KEYS }
Public Attributes
std::string additionalDerivationInfo
std::vector< int > baseAttrIdx
Oid baseRelation
std::vector< std::string > colNames
std::vector< bool > colRLE
std::vector< VerticaType > colTypes
std::string databaseName
std::vector< Oid > derivationFunctions
bool isExternal
bool isFlex
bool isSystem
bool isTemp
bool isUpToDate
int nSortedCols
std::vector< int > partitionCols
std::vector< int > pkCols
std::set< std::string > presentOnNodeNames
std::set< Oid > presentOnNodes
std::string relationName
Oid relationOid
enum Vertica::ServerInterface::RelationDescription::RelDerivationType relDerivationType
std::string schemaName
std::vector< int > segCols
int segOffset
std::vector< int > tabColMapping

Detailed Description

Structure to describe the name and properties of a table or projection, It is to be used in the methods below.

Member Enumeration Documentation

◆RelDerivationType

enum Vertica::ServerInterface::RelationDescription::RelDerivationType

Is aggregate, index, etc

Member Data Documentation

◆additionalDerivationInfo

std::string Vertica::ServerInterface::RelationDescription::additionalDerivationInfo

Further description of derivation

◆baseAttrIdx

std::vector Vertica::ServerInterface::RelationDescription::baseAttrIdx

Columns in base that participate in derivation

◆baseRelation

Oid Vertica::ServerInterface::RelationDescription::baseRelation

Derivation from a base object (table/projection)

◆colNames

std::vectorstd::string Vertica::ServerInterface::RelationDescription::colNames

Column names

◆colRLE

std::vector Vertica::ServerInterface::RelationDescription::colRLE

For projections, indictor if encoding is run-optimized

◆colTypes

std::vector Vertica::ServerInterface::RelationDescription::colTypes

Column types

◆databaseName

std::string Vertica::ServerInterface::RelationDescription::databaseName

Database name

◆derivationFunctions

std::vector Vertica::ServerInterface::RelationDescription::derivationFunctions

Derivation function, for UDT proj, etc.

◆isExternal

bool Vertica::ServerInterface::RelationDescription::isExternal

Is for external table?

◆isFlex

bool Vertica::ServerInterface::RelationDescription::isFlex

Is this a flex object

◆isSystem

bool Vertica::ServerInterface::RelationDescription::isSystem

Is this a system object

◆isTemp

bool Vertica::ServerInterface::RelationDescription::isTemp

Is for a temp table?

◆isUpToDate

bool Vertica::ServerInterface::RelationDescription::isUpToDate

Is this up to date / active

◆nSortedCols

int Vertica::ServerInterface::RelationDescription::nSortedCols

For projections, number of columns in sort order, as a prefix

◆partitionCols

std::vector Vertica::ServerInterface::RelationDescription::partitionCols

For tables / projections, columns involved in partitioning

◆pkCols

std::vector Vertica::ServerInterface::RelationDescription::pkCols

For tables / projections, columns involved in a primary key

◆presentOnNodeNames

std::setstd::string Vertica::ServerInterface::RelationDescription::presentOnNodeNames

For projections, hosting node names

◆presentOnNodes

std::set Vertica::ServerInterface::RelationDescription::presentOnNodes

For projections, hosting nodes

◆relationName

std::string Vertica::ServerInterface::RelationDescription::relationName

Table name, projection basename, or projection name

◆relationOid

Oid Vertica::ServerInterface::RelationDescription::relationOid

Relation OID, for lookups if this is nonzero it takes precedence

◆schemaName

std::string Vertica::ServerInterface::RelationDescription::schemaName

Schema name; on lookup if empty the search path will be consulted

◆segCols

std::vector Vertica::ServerInterface::RelationDescription::segCols

For projections, columns involved in segmentation

◆segOffset

int Vertica::ServerInterface::RelationDescription::segOffset

For buddies, segmentation offset

◆tabColMapping

std::vector Vertica::ServerInterface::RelationDescription::tabColMapping

For projections, mapping to table column number (0-based); negative numbers would indicate things that are not present in the table