Table key column description. More...

#include <common.h>

Public Member Functions
	FLUENT_FIELD_ENCAPSULATED (TString, Name)
	Column name.
	FLUENT_FIELD_DEFAULT_ENCAPSULATED (ESortOrder, SortOrder, ESortOrder::SO_ASCENDING)
	Sort order.
const TSortColumn &	EnsureAscending () const
	Check that sort order is ascending, throw exception otherwise.
TNode	ToNode () const
	Convert sort to yson representation as YT API expects it.
bool	operator== (const TSortColumn &rhs) const =default
	Comparison is default and checks both name and sort order.
bool	operator== (const TStringBuf rhsName) const
bool	operator== (const TString &rhsName) const
bool	operator== (const char *rhsName) const
	operator TString () const
	operator TStringBuf () const
	operator std::string () const
	Y_SAVELOAD_DEFINE (Name_, SortOrder_)

	TSortColumn (TStringBuf name={}, ESortOrder sortOrder=ESortOrder::SO_ASCENDING)
	Construct object from name and sort order.
	TSortColumn (const TString &name, ESortOrder sortOrder=ESortOrder::SO_ASCENDING)
	TSortColumn (const char *name, ESortOrder sortOrder=ESortOrder::SO_ASCENDING)

TSortColumn &	operator= (TStringBuf name)
	Assign object from column name, and set sort order to ascending.
TSortColumn &	operator= (const TString &name)
TSortColumn &	operator= (const char *name)

Detailed Description

Table key column description.

The description includes column name and sort order.

Note: Many functions that use TSortOrder as argument used to take TString (the only allowed sort order was "ascending" and user didn't have to specify it).; This class is designed to provide backward compatibility for such code and therefore objects of this class can be constructed and assigned from TString-like objects only.

Constructor & Destructor Documentation

NYT::TSortColumn::TSortColumn	(	TStringBuf	name = {},
		ESortOrder	sortOrder = ESortOrder::SO_ASCENDING )

Construct object from name and sort order.

Constructors are intentionally implicit so TSortColumn can be compatible with old code. TSortOrder_backward_compatibility

TSortColumn & NYT::TSortColumn::operator= ( TStringBuf name )

Assign object from column name, and set sort order to ascending.

This is backward compatibility methods.

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