common.h File Reference

Go to the source code of this file.

Classes
struct	NYT::TOneOrMany< T, TDerived >
	Convenience class that keeps sequence of items. More...
class	NYT::TSortColumn
	Table key column description. More...
class	NYT::TSortColumns
	List of TSortColumn. More...
class	NYT::TColumnSchema
	Single column description. More...
class	NYT::TDeletedColumnSchema
	Single deleted description. More...
class	NYT::TTableSchema
	Description of table schema. More...
struct	NYT::TKeyBound
	Key with relation specifying interval of keys in lower or upper limit of NYT::TReadRange. More...
struct	NYT::TReadLimit
	Description of the read limit. More...
struct	NYT::TReadRange
	Range of a table or a file. More...
struct	NYT::TRichYPath
	Path with additional attributes. More...
struct	NYT::TTableColumnarStatistics
	Statistics about table columns. More...
struct	NYT::TMultiTablePartition
	Description of a partition. More...
struct	NYT::TMultiTablePartition::TStatistics
struct	NYT::TMultiTablePartitions
	Table partitions from GetTablePartitions command. More...
struct	NYT::TFileReadRange
	Byte range of a file, offsets are uncompressed bytes. More...
struct	NYT::TFilePartition
	Description of a file partition. More...
struct	NYT::TFilePartitions
	File partitions from GetFilePartitions command. More...
struct	NYT::TTabletInfo
	Contains information about tablet. More...
struct	NYT::TAttributeFilter
	List of attributes to retrieve in operations like NYT::ICypressClient::Get. More...

Namespaces
namespace	NYT
	Main namespace of YT client.

Enumerations
enum	NYT::EValueType : int {   NYT::VT_INT64 , NYT::VT_UINT64 , NYT::VT_DOUBLE , NYT::VT_BOOLEAN ,   NYT::VT_STRING , NYT::VT_ANY , NYT::VT_INT8 , NYT::VT_INT16 ,   NYT::VT_INT32 , NYT::VT_UINT8 , NYT::VT_UINT16 , NYT::VT_UINT32 ,   NYT::VT_UTF8 , NYT::VT_NULL , NYT::VT_VOID , NYT::VT_DATE ,   NYT::VT_DATETIME , NYT::VT_TIMESTAMP , NYT::VT_INTERVAL , NYT::VT_FLOAT ,   NYT::VT_JSON , VT_DATE32 , VT_DATETIME64 , VT_TIMESTAMP64 ,   VT_INTERVAL64 , VT_UUID , VT_TZ_DATE , VT_TZ_DATETIME ,   VT_TZ_TIMESTAMP , VT_TZ_DATE32 , VT_TZ_DATETIME64 , VT_TZ_TIMESTAMP64 }
	Type of the value that can occur in YT table. More...
enum	NYT::ESortOrder : int { NYT::SO_ASCENDING , NYT::SO_DESCENDING }
	Sort order. More...
enum	NYT::EOptimizeForAttr : i8 { NYT::OF_SCAN_ATTR , NYT::OF_LOOKUP_ATTR }
	Value of "optimize_for" attribute. More...
enum	NYT::EErasureCodecAttr : i8
	Value of "erasure_codec" attribute. More...
enum	NYT::ESchemaModificationAttr : i8 { SM_NONE_ATTR , SM_UNVERSIONED_UPDATE }
	Value of "schema_modification" attribute. More...
enum class	NYT::ERelation { NYT::Less , NYT::LessOrEqual , NYT::Greater , NYT::GreaterOrEqual }
	Enumeration describing comparison operation used in key bound. More...
enum class	NYT::EMasterReadKind : int { NYT::Leader , NYT::Follower , Cache , MasterCache }
	Enumeration for specifying how reading from master is performed. More...

Functions
NTi::TTypePtr	NYT::ToTypeV3 (EValueType type, bool required)
	Helper function to create new style type from old style one.
bool	NYT::operator== (const TColumnSchema &lhs, const TColumnSchema &rhs)
	Equality check checks all fields of column schema.
bool	NYT::operator== (const TDeletedColumnSchema &lhs, const TDeletedColumnSchema &rhs)
	Equality check checks all fields of column schema.
bool	NYT::operator== (const TTableSchema &lhs, const TTableSchema &rhs)
	Check for equality of all columns and all schema attributes.
void	NYT::PrintTo (const TTableSchema &schema, std::ostream *out)
TTableSchema	NYT::CreateTableSchema (const ::google::protobuf::Descriptor &messageDescriptor, const TSortColumns &sortColumns=TSortColumns(), bool keepFieldsWithoutExtension=true)
	Create table schema by protobuf message descriptor.
template<class TProtoType, typename = std::enable_if_t<std::is_base_of_v<::google::protobuf::Message, TProtoType>>>
TTableSchema	NYT::CreateTableSchema (const TSortColumns &sortColumns=TSortColumns(), bool keepFieldsWithoutExtension=true)
	Create table schema by protobuf message type.
TTableSchema	NYT::CreateTableSchema (NTi::TTypePtr type)
	Create strict table schema from struct type.
bool	NYT::operator== (const TKeyBound &lhs, const TKeyBound &rhs) noexcept
	Equality check checks all fields of TKeyBound.
bool	NYT::operator== (const TReadLimit &lhs, const TReadLimit &rhs) noexcept
	Equality check checks all fields of TReadLimit.
bool	NYT::operator== (const TReadRange &lhs, const TReadRange &rhs) noexcept
	Equality check checks all fields of TReadRange.
template<typename TProtoType>
TRichYPath	NYT::WithSchema (const TRichYPath &path, const TSortColumns &sortBy=TSortColumns())
template<typename TRowType>
TRichYPath	NYT::MaybeWithSchema (const TRichYPath &path, const TSortColumns &sortBy=TSortColumns())
	Create copy of NYT::TRichYPath with schema derived from TRowType if possible.
const TVector< TReadRange > &	NYT::GetRangesCompat (const TRichYPath &path)
	Get the list of ranges related to path in compatibility mode.
bool	NYT::IsTrivial (const TReadLimit &readLimit)
	Check if none of the fields of NYT::TReadLimit is set.
EValueType	NYT::NodeTypeToValueType (TNode::EType nodeType)
	Convert yson node type to table schema type.

Detailed Description

Header containing miscellaneous structs and classes used in library.