Main namespace of YT client. More...

Classes
class	IAbortableInputStream
	Input stream that supports aborting the read operation. More...
class	IBatchRequestBase
	Helper base of NYT::IBatchRequest holding most of useful methods. More...
class	IBatchRequest
	Batch request object. More...
struct	TAuthorizationInfo
	OAuth info (returned by NYT::IClient::WhoAmI). More...
struct	TCheckPermissionResult
	Part of NYT::TCheckPermissionResponse. More...
struct	TCheckPermissionResponse
	Result of NYT::IClient::CheckPermission command. More...
class	ILock
	Interface representing a lock obtained from NYT::ITransaction::Lock. More...
class	IClientBase
	Base class for NYT::IClient and NYT::ITransaction. More...
class	ITransaction
	Interface representing a master transaction. More...
class	IClient
	Interface containing non-transactional commands. More...
struct	TSuppressableAccessTrackingOptions
	Base class for options dealing with access tracking suppression. More...
struct	TPrerequisiteRevision
	Expected revision of a Cypress node, used as a precondition. More...
struct	TPrerequisiteTransactionsOptions
	Base class for options dealing with prerequisite transactions. More...
struct	TPrerequisiteRevisionsOptions
	Base class for options dealing with prerequisite revisions. More...
struct	TPrerequisiteOptions
	Server-side preconditions checked before the request is processed. More...
struct	TCreateOptions
	Options for NYT::ICypressClient::Create. More...
struct	TRemoveOptions
	Options for NYT::ICypressClient::Remove. More...
struct	TMasterReadOptions
	Base class for options for operations that read from master. More...
struct	TExistsOptions
	Options for NYT::ICypressClient::Exists. More...
struct	TGetOptions
	Options for NYT::ICypressClient::Get. More...
struct	TSetOptions
	Options for NYT::ICypressClient::Set. More...
struct	TMultisetAttributesOptions
	Options for NYT::ICypressClient::MultisetAttributes. More...
struct	TListOptions
	Options for NYT::ICypressClient::List. More...
struct	TCopyOptions
	Options for NYT::ICypressClient::Copy. More...
struct	TMoveOptions
	Options for NYT::ICypressClient::Move. More...
struct	TLinkOptions
	Options for NYT::ICypressClient::Link. More...
struct	TConcatenateOptions
	Options for NYT::ICypressClient::Concatenate. More...
struct	TBlobTableReaderOptions
	Options for NYT::IIOClient::CreateBlobTableReader. More...
struct	TResourceLimits
	Resource limits for operation (or pool). More...
struct	TSchedulingOptions
	Scheduling options for single pool tree. More...
struct	TSchedulingOptionsPerPoolTree
	Collection of scheduling options for multiple pool trees. More...
struct	TSuspendOperationOptions
	Options for NYT::IOperation::SuspendOperation. More...
struct	TResumeOperationOptions
	Options for NYT::IOperation::ResumeOperation. More...
struct	TUpdateOperationParametersOptions
	Options for NYT::IOperation::UpdateParameters. More...
struct	TIOOptions
	Base class for many options related to IO. More...
struct	TFileReaderOptions
	Options for reading file from YT. More...
struct	TFilePartitionReaderOptions
	Options for NYT::IClient::CreateFilePartitionReader. More...
struct	TWriterOptions
	Options that control how server side of YT stores data. More...
struct	TFileWriterOptions
	Options for writing file. More...
struct	TFileFragmentWriterOptions
	Options for writing file fragment in distributed session. More...
class	TSkiffRowHints
class	TFormatHints
	Options that control how C++ objects represent table rows when reading or writing a table. More...
class	TControlAttributes
	Options that control which control attributes (like row_index) are added to rows during read. More...
struct	TTableReaderOptions
	Options for NYT::IClient::CreateTableReader. More...
struct	TTablePartitionReaderOptions
	Options for NYT::IClient::CreatePartitionTableReader. More...
struct	TTableWriterOptions
	Options for NYT::IClient::CreateTableWriter. More...
struct	TTableFragmentWriterOptions
	Options for writing table fragment in distributed session. More...
struct	TStartTransactionOptions
	Options for NYT::IClient::StartTransaction. More...
struct	TAttachTransactionOptions
	Options for attaching transaction. More...
struct	TLockOptions
	Options for locking cypress node. More...
struct	TUnlockOptions
	Options for NYT::ITransaction::Unlock. More...
struct	TCommitTransactionOptions
	Options for NYT::ITransaction::Commit. More...
struct	TTabletOptions
	Base class for options that deal with tablets. More...
struct	TMountTableOptions
	Options for NYT::IClient::MountTable. More...
struct	TUnmountTableOptions
	Options for NYT::IClient::UnmountTable. More...
struct	TRemountTableOptions
	Options for NYT::IClient::RemountTable. More...
struct	TReshardTableOptions
	Options for NYT::IClient::ReshardTable. More...
struct	TFreezeTableOptions
	Options for NYT::IClient::FreezeTable. More...
struct	TUnfreezeTableOptions
	Options for NYT::IClient::UnfreezeTable. More...
struct	TAlterTableOptions
	Options for NYT::IClient::AlterTable. More...
struct	TLookupRowsOptions
	Options for NYT::IClient::LookupRows. More...
struct	TSelectRowsOptions
	Options for NYT::IClient::SelectRows. More...
struct	TCreateClientOptions
	Options for NYT::CreateClient;. More...
struct	TExecuteBatchOptions
	Options for NYT::IBatchRequest::ExecuteBatch. More...
struct	TTabletTransactionOptions
	Base class for options dealing with io to dynamic tables. More...
struct	TInsertRowsOptions
	Options for NYT::IClient::InsertRows. More...
struct	TDeleteRowsOptions
	Options for NYT::IClient::DeleteRows. More...
struct	TTrimRowsOptions
	Options for NYT::IClient::TrimRows. More...
struct	TAlterTableReplicaOptions
	Options for NYT::IClient::AlterTableReplica. More...
struct	TGetFileFromCacheOptions
	Options for NYT::IClient::GetFileFromCache. More...
struct	TPutFileToCacheOptions
	Options for NYT::IClient::GetTableColumnarStatistics. More...
struct	TCheckPermissionOptions
	Options for NYT::IClient::CheckPermission. More...
struct	TGetTableColumnarStatisticsOptions
	Options for NYT::IClient::GetTableColumnarStatistics. More...
struct	TGetTablePartitionsOptions
	Options for NYT::IClient::GetTablePartitions. More...
struct	TGetFilePartitionsOptions
	Options for NYT::IClient::GetFilePartitions. More...
struct	TGetTabletInfosOptions
	Options for NYT::IClient::GetTabletInfos. More...
struct	TSkyShareTableOptions
	Options for NYT::IClient::SkyShareTable. More...
struct	TCheckClusterLivenessOptions
	Options for NYT::IClient::CheckClusterLiveness. More...
struct	TOneOrMany
	Convenience class that keeps sequence of items. More...
class	TSortColumn
	Table key column description. More...
class	TSortColumns
	List of TSortColumn. More...
class	TColumnSchema
	Single column description. More...
class	TDeletedColumnSchema
	Single deleted description. More...
class	TTableSchema
	Description of table schema. More...
struct	TKeyBound
	Key with relation specifying interval of keys in lower or upper limit of NYT::TReadRange. More...
struct	TReadLimit
	Description of the read limit. More...
struct	TReadRange
	Range of a table or a file. More...
struct	TRichYPath
	Path with additional attributes. More...
struct	TTableColumnarStatistics
	Statistics about table columns. More...
struct	TMultiTablePartition
	Description of a partition. More...
struct	TMultiTablePartitions
	Table partitions from GetTablePartitions command. More...
struct	TFileReadRange
	Byte range of a file, offsets are uncompressed bytes. More...
struct	TFilePartition
	Description of a file partition. More...
struct	TFilePartitions
	File partitions from GetFilePartitions command. More...
struct	TTabletInfo
	Contains information about tablet. More...
struct	TAttributeFilter
	List of attributes to retrieve in operations like NYT::ICypressClient::Get. More...
struct	TConfig
struct	TProcessState
class	ICypressClient
	Client interface to execute Cypress-related commands. More...
struct	TDistributedWriteTableSessionWithCookies
struct	TStartDistributedWriteTableOptions
struct	TPingDistributedWriteTableOptions
struct	TFinishDistributedWriteTableOptions
struct	TDistributedWriteFileSessionWithCookies
struct	TStartDistributedWriteFileOptions
struct	TPingDistributedWriteFileOptions
struct	TFinishDistributedWriteFileOptions
class	TApiUsageError
	Error that is thrown when library detects invalid usage of API. More...
class	TRequestRetriesTimeout
	Error that is thrown when request retries continues for too long. More...
class	TYtError
	Error returned by YT cluster. More...
class	TErrorResponse
	Generic error response returned by server. More...
struct	TFailedJobInfo
class	TOperationFailedError
	Error that is thrown when operation watched by library fails. More...
class	TInputStreamAbortedError
	Error that is thrown when trying to read from aborted reader. More...
struct	TFluentYsonUnwrapper
struct	TFluentYsonVoid
struct	TFluentYsonUnwrapper< TFluentYsonVoid >
class	TFluentYsonBuilder
	This class is actually a namespace for specific fluent adapter classes. More...
class	TFluentYsonWriterState
class	TFluentYsonBuilderState
class	TFluentYsonHolder
struct	TFluentYsonUnwrapper< TFluentYsonHolder< TState > >
struct	TYamredDsvAttributes
struct	TFormat
	Class representing YT data format. More...
struct	TInitializeOptions
	Options for NYT::Initialize() and NYT::JoblessInitialize() functions. More...
class	TProtoOneOf
	"Marker" type to use for several protobuf types in NYT::TTableReader. More...
class	TSkiffRowOneOf
	"Marker" type to use for several skiff row types in NYT::TTableReader. More...
class	TIOException
	Class of exceptions connected to reading or writing tables or files. More...
class	IFileReader
	Interface representing YT file reader. More...
class	IFileWriter
	Interface representing YT file writer. More...
class	IFileFragmentWriter
class	TRawTableReader
	Low-level interface to read YT table with retries. More...
class	TRawTableWriter
	Low-level interface to write YT table. More...
class	IProxyOutput
	Interface to deal with multiple raw output streams. More...
class	TTableReader
	Class template to read typed rows from YT tables. More...
class	TTableReaderIterator
	Iterator for use in range-based-for. More...
class	TTableRangesReader
	Class to facilitate reading table rows sorted by key. More...
class	TTableWriter
	Class template to write typed rows to YT tables. More...
class	ITableFragmentWriter
	Class template for distributed table API fragment writer. More...
struct	TYaMRRow
	Type representing YaMR table row. More...
class	IIOClient
	Interface for creating table and file readers and writer. More...
class	TJobCounter
class	TJobCounters
	Class representing a collection of job counters. More...
class	TJobStatistics
	Class representing a collection of job statistics. More...
class	TJobStatisticsEntry
	Class representing single statistic. More...
struct	TUnspecifiedTableStructure
	Tag class marking that the row type for table is not specified. More...
struct	TProtobufTableStructure
	Tag class marking that table rows have protobuf type. More...
struct	TStructuredTablePath
	Table path marked with NYT::TTableStructure tag. More...
struct	TVoidStructuredRowStream
	Tag class marking that row stream is empty. More...
struct	TTNodeStructuredRowStream
	Tag class marking that row stream consists of NYT::TNode. More...
struct	TTYaMRRowStructuredRowStream
	Tag class marking that row stream consists of NYT::TYaMRRow. More...
struct	TProtobufStructuredRowStream
	Tag class marking that row stream consists of protobuf rows of given type. More...
struct	TJobBinaryDefault
	Tag class marking that current binary should be used in operation. More...
struct	TJobBinaryLocalPath
	Tag class marking that binary from specified local path should be used in operation. More...
struct	TJobBinaryCypressPath
	Tag class marking that binary from specified Cypress path should be used in operation. More...
class	TAutoMergeSpec
	Options for auto merge operation stage. More...
class	TWithAutoMergeSpec
	Base for operations with auto merge options. More...
class	TSchedulerResources
	Resources controlled by scheduler and used by running operations. More...
class	TUserJobInputFormatHintsBase
	Base for input format hints of a user job. More...
class	TUserJobOutputFormatHintsBase
	Base for output format hints of a user job. More...
class	TUserJobFormatHintsBase
	Base for format hints of a user job. More...
class	TUserJobFormatHints
	User job format hints. More...
class	TRawOperationIoTableSpec
	Spec of input and output tables of a raw operation. More...
struct	TSimpleRawOperationIoSpec
	Base spec for IO in "simple" raw operations (Map, Reduce etc.). More...
class	TRawMapReduceOperationIoSpec
	Spec for IO in MapReduce operation. More...
class	TOperationInputSpecBase
	Base spec of operations with input tables. More...
class	TOperationOutputSpecBase
	Base spec of operations with output tables. More...
struct	TOperationIOSpecBase
	Base spec for operations with inputs and outputs. More...
struct	TOperationIOSpec
	Base spec for operations with inputs and outputs. More...
struct	TOperationSpecBase
	Base spec for all operations. More...
struct	TUserOperationSpecBase
	Base spec for all operations with user jobs. More...
struct	TIntermediateTablesHintSpec
	Class to provide information on intermediate mapreduce stream protobuf types. More...
struct	TAddLocalFileOptions
struct	TJobProfilerSpec
	Specifies a job profiler. More...
struct	TDiskRequest
	Specification of a disk that will be available in job. More...
struct	TUserJobSpec
	Spec of user job. More...
struct	TMapOperationSpecBase
	Spec of Map operation. More...
struct	TMapOperationSpec
	Spec of Map operation. More...
struct	TRawMapOperationSpec
	Spec of raw Map operation. More...
struct	TReduceOperationSpecBase
	Spec of Reduce operation. More...
struct	TReduceOperationSpec
	Spec of Reduce operation. More...
struct	TRawReduceOperationSpec
	Spec of raw Reduce operation. More...
struct	TJoinReduceOperationSpecBase
	Spec of JoinReduce operation. More...
struct	TJoinReduceOperationSpec
	Spec of JoinReduce operation. More...
struct	TRawJoinReduceOperationSpec
	Spec of raw JoinReduce operation. More...
struct	TMapReduceOperationSpecBase
	Spec of MapReduce operation. More...
struct	TMapReduceOperationSpec
	Spec of MapReduce operation. More...
struct	TRawMapReduceOperationSpec
	Spec of raw MapReduce operation. More...
struct	TSortOperationSpec
	Spec of Sort operation. More...
struct	TMergeOperationSpec
	Spec of Merge operation. More...
struct	TEraseOperationSpec
	Spec of Erase operation. More...
struct	TRemoteCopyOperationSpec
	Spec of RemoteCopy operation. More...
struct	TVanillaTask
	Task of Vanilla operation. More...
struct	TVanillaOperationSpec
	Spec of Vanilla operation. More...
struct	TOperationOptions
	Options for NYT::IOperationClient::Map and other operation start commands. More...
class	TRawJobContext
	Context passed to NYT::IRawJob::Do. More...
class	ISerializableForJob
	Interface for classes that can be Saved/Loaded (to be used with Y_SAVELOAD_JOB). More...
class	IOperationPreparationContext
	Provider of information about operation inputs/outputs during NYT::IJob::PrepareOperation. More...
class	TJobOperationPreparer
	Fluent builder class for NYT::IJob::PrepareOperation. More...
class	IJob
	Interface for all user jobs. More...
class	IStructuredJob
	Interface for jobs with typed inputs and outputs. More...
class	IMapperBase
	Base interface for structured (typed) map jobs. More...
class	IMapper
	Base interface for structured (typed) map jobs with given reader and writer. More...
class	IReducerBase
	Base interface for structured (typed) reduce jobs. More...
class	IReducer
	Base interface for structured (typed) reduce jobs with given reader and writer. More...
class	IRawJob
	This method is called before feeding input rows to reducer (before Do method). virtual void Start(TWriter* writer) { Y_UNUSED(writer); }. More...
class	ICommandJob
	Interface of jobs that run the given bash command. More...
class	TCommandRawJob
	Raw job executing given bash command. More...
class	IVanillaJobBase
	Base interface for vanilla jobs. More...
class	IVanillaJob
	Interface for vanilla jobs with output tables. More...
class	IVanillaJob< void >
	Interface of vanilla job without outputs. More...
class	TCommandVanillaJob
	Vanilla job executing given bash command. More...
struct	TOperationAttributeFilter
	Class describing which attributes to request in NYT::IClient::GetOperation or NYT::IClient::ListOperations. More...
struct	TGetOperationOptions
	Options for NYT::IClient::GetOperation call. More...
struct	TOperationProgress
	Operation progress. More...
struct	TOperationBriefProgress
	Brief operation progress (numbers of jobs in these states). More...
struct	TOperationResult
	Operation result. More...
struct	TOperationEvent
	Operation event (change of state). More...
struct	TOperationAttributes
	Operation info. More...
struct	TListOperationsOptions
	Options of NYT::IClient::ListOperations command. More...
struct	TListOperationsResult
	Response for NYT::IClient::ListOperations command. More...
class	TTaskName
	Task name (can either well-known or just a string). More...
struct	TJobAttributeFilter
	A class that specifies which attributes to request when using NYT::IClient::GetJob or NYT::IClient::ListJobs. More...
struct	TListJobsOptions
	Options for NYT::IClient::ListJobs. More...
struct	TCoreInfo
	Description of a core dump that happened in the job. More...
struct	TJobAttributes
	Job attributes. More...
struct	TListJobsResult
	Response for NYT::IOperation::ListJobs. More...
struct	TGetJobOptions
	Options for NYT::IClient::GetJob. More...
struct	TGetJobInputOptions
	Options for NYT::IClient::GetJobInput. More...
struct	TGetJobFailContextOptions
	Options for NYT::IClient::GetJobFailContext. More...
struct	TGetJobStderrOptions
	Options for NYT::IClient::GetJobStderr. More...
struct	TGetFailedJobInfoOptions
	Options for NYT::IOperation::GetFailedJobInfo. More...
struct	TGetJobTraceOptions
	Options for NYT::IClient::GetJobTrace. More...
struct	TJobTraceEvent
	Response for NYT::IOperation::GetJobTrace. More...
struct	IOperation
	Interface representing an operation. More...
struct	IOperationClient
	Interface of client capable of managing operations. More...
class	TPatchableField
class	IRawBatchRequest
class	IOutputStreamWithResponse
	Interface for HTTP/RPC output streams that provide a response after the stream is closed. More...
class	IRawClient
struct	TRetryConfig
	A configuration that controls retries of a single request. More...
class	IRetryConfigProvider
	The library uses this class to understand how to retry individual requests. More...
struct	TIsSkiffRow
class	ISkiffRowParser
class	ISkiffRowSkipper
class	TSkiffRowSkipper
	Default ISkiffRowSkipper implementation. More...
class	TTempTable
	RAII class for working with temporary tables. Constructor of this class creates temporary table and destructor removes it. More...
class	IWaitProxy
	Interface to facilitate customizable waiting. More...

Typedefs
using	TFluentAny = TFluentYsonBuilder::TAny<TFluentYsonVoid>
	Builder representing any value.
using	TFluentList = TFluentYsonBuilder::TListType<TFluentYsonVoid>
	Builder representing the inside of a list (list fragment).
using	TFluentMap = TFluentYsonBuilder::TMapType<TFluentYsonVoid>
	Builder representing the inside of a map (map fragment).
using	TFluentAttributes = TFluentYsonBuilder::TAttributes<TFluentYsonVoid>
	Builder representing the inside of attributes.
using	TTableStructure
	Tag class to specify table row type.
using	TStructuredRowStreamDescription
	Tag class to specify type of rows in an operation row stream.

Enumerations
enum	ENodeType : int { NT_STRING = 0 , NT_INT64 = 1 , NT_UINT64 = 2 , NT_DOUBLE = 3 , NT_BOOLEAN = 4 , NT_MAP = 5 , NT_LIST = 6 , NT_FILE = 7 , NT_TABLE = 8 , NT_DOCUMENT = 9 , NT_REPLICATED_TABLE = 10 , NT_TABLE_REPLICA = 11 , NT_USER = 12 , NT_SCHEDULER_POOL = 13 , NT_LINK = 14 , NT_GROUP = 15 , NT_PORTAL = 16 , NT_CHAOS_TABLE_REPLICA = 17 , NT_TABLE_COLLOCATION = 18 }
	Type of the cypress node.
enum class	EComplexTypeMode : int { Named , Positional }
	Mode of composite type representation in yson. More...
enum	ELockMode : int { LM_EXCLUSIVE , LM_SHARED , LM_SNAPSHOT }
	Type of the lock. More...
enum class	EDurability { Sync , Async }
	Durability mode. More...
enum class	EAtomicity { None , Full }
	Atomicity mode. More...
enum class	ETableReplicaMode { Sync , Async }
	Table replica mode. More...
enum class	ELockType { Exclusive , SharedWrite }
	Row lock type used by modify-rows commands. More...
enum class	EPermission : int { Read , Write , Use , Administer , Create , Remove , Mount , Manage , FullRead }
enum class	ESecurityAction : int { Allow , Deny }
	Whether permission is granted or denied. More...
enum class	EColumnarStatisticsFetcherMode { FromNodes , FromMaster , Fallback }
	Columnar statistics fetching mode. More...
enum class	ETablePartitionMode { Unordered , Ordered }
	Table partitioning mode. More...
enum	EValueType : int { VT_INT64 , VT_UINT64 , VT_DOUBLE , VT_BOOLEAN , VT_STRING , VT_ANY , VT_INT8 , VT_INT16 , VT_INT32 , VT_UINT8 , VT_UINT16 , VT_UINT32 , VT_UTF8 , VT_NULL , VT_VOID , VT_DATE , VT_DATETIME , VT_TIMESTAMP , VT_INTERVAL , VT_FLOAT , 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	ESortOrder : int { SO_ASCENDING , SO_DESCENDING }
	Sort order. More...
enum	EOptimizeForAttr : i8 { OF_SCAN_ATTR , OF_LOOKUP_ATTR }
	Value of "optimize_for" attribute. More...
enum	EErasureCodecAttr : i8
	Value of "erasure_codec" attribute. More...
enum	ESchemaModificationAttr : i8 { SM_NONE_ATTR , SM_UNVERSIONED_UPDATE }
	Value of "schema_modification" attribute. More...
enum class	ERelation { Less , LessOrEqual , Greater , GreaterOrEqual }
	Enumeration describing comparison operation used in key bound. More...
enum class	EMasterReadKind : int { Leader , Follower , Cache , MasterCache }
	Enumeration for specifying how reading from master is performed. More...
enum	EEncoding : int { E_IDENTITY , E_GZIP , E_BROTLI , E_Z_LZ4 }
enum class	ENodeReaderFormat : int { Yson , Skiff , Auto }
enum class	ETraceHttpRequestsMode { Never , Error , Always }
enum class	ETableWriterVersion { Auto , V1 , V2 }
	Enum describing possible versions of table writer implemetation. More...
enum class	EAutoMergeMode { Disabled , Relaxed , Economy , Manual }
	Auto merge mode. More...
enum class	EProfilingBinary { JobProxy , UserJob }
	Binary to run job profiler on. More...
enum class	EProfilerType { Cpu , Memory , PeakMemory }
	Type of job profiler. More...
enum class	ESchemaInferenceMode : int { FromInput , FromOutput , Auto }
	Schema inference mode. More...
enum	EMergeMode : int { MM_UNORDERED , MM_ORDERED , MM_SORTED }
	Merge mode.
enum class	EOperationAttribute : int { Id , Type , State , AuthenticatedUser , StartTime , FinishTime , BriefProgress , BriefSpec , Suspended , Result , Progress , Events , Spec , FullSpec , UnrecognizedSpec , Alerts }
	Attributes to request for an operation.
enum class	EOperationBriefState : int { InProgress , Completed , Aborted , Failed }
	"Coarse-grained" state of an operation. More...
enum class	EOperationState : int { None , Starting , Orphaned , WaitingForAgent , Initializing , Preparing , Materializing , ReviveInitializing , Reviving , RevivingJobs , Pending , Running , Completing , Completed , Aborting , Aborted , Failing , Failed }
	Operation state.
enum class	EOperationType : int { Map , Merge , Erase , Sort , Reduce , MapReduce , RemoteCopy , JoinReduce , Vanilla }
	Operation type.
enum class	ECursorDirection { Past , Future }
	Direction of cursor for paging, see NYT::TListOperationsOptions::CursorDirection.
enum class	EListJobsDataSource : int { Runtime , Archive , Auto , Manual }
	Data source for NYT::IClient::ListJobs command.
enum class	EJobType : int { Map , PartitionMap , SortedMerge , OrderedMerge , UnorderedMerge , Partition , SimpleSort , FinalSort , SortedReduce , PartitionReduce , ReduceCombiner , RemoteCopy , IntermediateSort , OrderedMap , JoinReduce , Vanilla , SchedulerUnknown , ReplicateChunk , RemoveChunk , RepairChunk , SealChunk , ShallowMerge , MergeChunks , AutotomizeChunk , ReincarnateChunk }
	Job type.
enum class	ETaskName : int { Map , PartitionMap0 , SortedMerge , OrderedMerge , UnorderedMerge , Partition0 , Partition1 , Partition2 , SimpleSort , FinalSort , SortedReduce , PartitionReduce , ReduceCombiner , RemoteCopy , IntermediateSort , OrderedMap , JoinReduce }
	Well-known task names.
enum class	EJobState : int { None , Waiting , Running , Aborting , Completed , Failed , Aborted , Lost }
	Job state.
enum class	EJobSortField : int { Type , State , StartTime , FinishTime , Address , Duration , Progress , Id , TaskName }
	Job sort field. More...
enum class	EJobSortDirection : int { Ascending , Descending }
	Job sort direction. More...
enum class	EJobAttribute : int { Id , Type , State , Address , TaskName , StartTime , FinishTime , Progress , StderrSize , Error , Result , BriefStatistics , InputPaths , CoreInfos }
	Attributes to request for a job.

Functions
IClientPtr	CreateRpcClient (const TString &serverName, const TCreateClientOptions &options={})
	Create a rpc client for particular cluster.
IClientPtr	CreateClient (const TString &serverName, const TCreateClientOptions &options={})
	Create a client for particular MapReduce cluster.
IClientPtr	CreateClientFromEnv (const TCreateClientOptions &options={})
	Create a client for mapreduce cluster specified in YT_PROXY environment variable.
NTi::TTypePtr	ToTypeV3 (EValueType type, bool required)
	Helper function to create new style type from old style one.
bool	operator== (const TColumnSchema &lhs, const TColumnSchema &rhs)
	Equality check checks all fields of column schema.
bool	operator== (const TDeletedColumnSchema &lhs, const TDeletedColumnSchema &rhs)
	Equality check checks all fields of column schema.
bool	operator== (const TTableSchema &lhs, const TTableSchema &rhs)
	Check for equality of all columns and all schema attributes.
void	PrintTo (const TTableSchema &schema, std::ostream *out)
TTableSchema	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	CreateTableSchema (const TSortColumns &sortColumns=TSortColumns(), bool keepFieldsWithoutExtension=true)
	Create table schema by protobuf message type.
TTableSchema	CreateTableSchema (NTi::TTypePtr type)
	Create strict table schema from struct type.
bool	operator== (const TKeyBound &lhs, const TKeyBound &rhs) noexcept
	Equality check checks all fields of TKeyBound.
bool	operator== (const TReadLimit &lhs, const TReadLimit &rhs) noexcept
	Equality check checks all fields of TReadLimit.
bool	operator== (const TReadRange &lhs, const TReadRange &rhs) noexcept
	Equality check checks all fields of TReadRange.
template<typename TProtoType>
TRichYPath	WithSchema (const TRichYPath &path, const TSortColumns &sortBy=TSortColumns())
template<typename TRowType>
TRichYPath	MaybeWithSchema (const TRichYPath &path, const TSortColumns &sortBy=TSortColumns())
	Create copy of NYT::TRichYPath with schema derived from TRowType if possible.
const TVector< TReadRange > &	GetRangesCompat (const TRichYPath &path)
	Get the list of ranges related to path in compatibility mode.
bool	IsTrivial (const TReadLimit &readLimit)
	Check if none of the fields of NYT::TReadLimit is set.
EValueType	NodeTypeToValueType (TNode::EType nodeType)
	Convert yson node type to table schema type.
	DEFINE_ENUM (EUploadDeduplicationMode,((Global)(0))((Host)(1))((Disabled)(2)))
void	Serialize (const TConfig &config, NYson::IYsonConsumer *consumer)
void	Deserialize (TConfig &config, const TNode &node)
TString	ConfigToYsonString (const TConfig &config, NYson::EYsonFormat format=NYson::EYsonFormat::Pretty)
TConfig	ConfigFromYsonString (TString serializedConfig)
	YT_DEFINE_STRONG_TYPEDEF (TDistributedWriteTableSession, TNode)
	Distributed write table session object.
	YT_DEFINE_STRONG_TYPEDEF (TDistributedWriteTableCookie, TNode)
	Cookie object for participant of distributed write table session.
	YT_DEFINE_STRONG_TYPEDEF (TWriteTableFragmentResult, TNode)
	Fragment write result produced by NYT::ITableFragmentWriter.
	YT_DEFINE_STRONG_TYPEDEF (TDistributedWriteFileSession, TNode)
	Distributed write file session object.
	YT_DEFINE_STRONG_TYPEDEF (TDistributedWriteFileCookie, TNode)
	Cookie object for participant of distributed write file session.
	YT_DEFINE_STRONG_TYPEDEF (TWriteFileFragmentResult, TNode)
	Fragment write result produced by NYT::IFileFragmentWriter.
template<class TState>
TFluentYsonBuilder::TAny< TFluentYsonHolder< TState > >	BuildYsonFluentlyWithState (::TIntrusivePtr< TState > state)
TFluentYsonBuilder::TAny< TFluentYsonHolder< TFluentYsonWriterState > >	BuildYsonStringFluently (::NYson::EYsonFormat format=::NYson::EYsonFormat::Text)
	Create a fluent adapter returning a TString with corresponding YSON when construction is finished.
TFluentYsonBuilder::TAny< TFluentYsonHolder< TFluentYsonBuilderState > >	BuildYsonNodeFluently ()
	Create a fluent adapter returning a NYT::TNode when construction is finished.
TTableSchema	CreateTableSchema (const ::google::protobuf::Descriptor &messageDescriptor, bool keepFieldsWithoutExtension)
	Create table schema from protobuf message descriptor.
int	GetJobFirstOutputTableFD ()
void	JoblessInitialize (const TInitializeOptions &options=TInitializeOptions())
	Performs basic initialization (logging, termination handlers, etc).
void	Initialize (int argc, const char **argv, const TInitializeOptions &options=TInitializeOptions())
	Performs basic initialization and switches to a job mode if required.
void	Initialize (int argc, char **argv, const TInitializeOptions &options=TInitializeOptions())
	Similar to NYT::Initialize(int, const char**, const TInitializeOptions&).
void	Initialize (const TInitializeOptions &options=TInitializeOptions())
	Similar to NYT::Initialize(int, const char**, const TInitializeOptions&).
template<class T>
TTableReaderIterator< T >	begin (TTableReader< T > &reader)
	Function to facilitate range-based-for for NYT::TTableReader.
template<class T>
TTableReaderIterator< T >	end (TTableReader< T > &)
	Function to facilitate range-based-for for NYT::TTableReader.
template<typename T>
TTableReaderPtr< T >	CreateTableReader (IInputStream *stream, const TTableReaderOptions &options={})
	Create a protobuf table reader from a stream.
template<class... Ts>
TTableReaderPtr< typename NDetail::TProtoOneOfUnique< Ts... >::TType >	CreateProtoMultiTableReader (IInputStream *stream, const TTableReaderOptions &options={})
	Create a protobuf multi table reader from a stream.
template<class T>
TTableReaderPtr< T >	CreateProtoMultiTableReader (IInputStream *stream, int tableCount, const TTableReaderOptions &options={})
	Create a homogeneous protobuf multi table reader from a stream.
template<>
TTableReaderPtr< TNode >	CreateTableReader< TNode > (IInputStream *stream, const TTableReaderOptions &options)
	Create a NYT::TNode table reader from a stream.
template<>
TTableReaderPtr< TYaMRRow >	CreateTableReader< TYaMRRow > (IInputStream *stream, const TTableReaderOptions &options)
	Create a NYT::TYaMRRow table reader from a stream.
template<typename T>
TTableReaderPtr< T >	CreateConcreteProtobufReader (TTableReader< Message > *reader)
	Convert generic protobuf table reader to a concrete one (for certain type T).
template<typename T>
TTableReaderPtr< T >	CreateConcreteProtobufReader (const TTableReaderPtr< Message > &reader)
	Convert generic protobuf table reader to a concrete one (for certain type T).
template<typename T>
TTableReaderPtr< Message >	CreateGenericProtobufReader (TTableReader< T > *reader)
	Convert a concrete (for certain type T) protobuf table reader to a generic one.
template<typename T>
TTableReaderPtr< Message >	CreateGenericProtobufReader (const TTableReaderPtr< T > &reader)
	Convert a concrete (for certain type T) protobuf table reader to a generic one.
template<typename T>
T	ConvertJobStatisticsEntry (i64 value)
	Convert i64 representation of statistics to other type.
void	WriteCustomStatistics (TStringBuf path, i64 value)
	Write custom statistics.
void	WriteCustomStatistics (const TNode &statistics)
	Write several custom statistics at once.
void	FlushCustomStatisticsStream ()
	Flush custom statistics stream.
bool	operator== (const TUnspecifiedTableStructure &, const TUnspecifiedTableStructure &)
bool	operator== (const TProtobufTableStructure &lhs, const TProtobufTableStructure &rhs)
template<typename TRow>
TStructuredTablePath	Structured (TRichYPath richYPath)
	Create marked table path from row type.
template<typename TRow>
TTableStructure	StructuredTableDescription ()
	Create tag class from row type.
const TNode &	GetJobSecureVault ()
	Get operation secure vault (specified in NYT::TOperationOptions::SecureVault) inside a job.
TRawTableReaderPtr	CreateRawJobReader (int fd=0)
	Create default raw job reader.
THolder< IProxyOutput >	CreateRawJobWriter (size_t outputTableCount)
	Create default raw job writer.
template<class T>
void	Deserialize (TMaybe< T > &value, const TNode &node)
template<class T>
void	Deserialize (TVector< T > &value, const TNode &node)
template<class T>
void	Deserialize (THashMap< TString, T > &value, const TNode &node)
void	Serialize (const TKey &key, NYson::IYsonConsumer *consumer)
void	Deserialize (TKey &key, const TNode &node)
void	Serialize (const TSortColumns &sortColumns, NYson::IYsonConsumer *consumer)
void	Deserialize (TSortColumns &sortColumns, const TNode &node)
void	Serialize (const TColumnNames &columnNames, NYson::IYsonConsumer *consumer)
void	Deserialize (TColumnNames &columnNames, const TNode &node)
void	Serialize (const TSortColumn &sortColumn, NYson::IYsonConsumer *consumer)
void	Deserialize (TSortColumn &sortColumn, const TNode &node)
void	Serialize (const TKeyBound &keyBound, NYson::IYsonConsumer *consumer)
void	Deserialize (TKeyBound &keyBound, const TNode &node)
void	Serialize (const TReadLimit &readLimit, NYson::IYsonConsumer *consumer)
void	Deserialize (TReadLimit &readLimit, const TNode &node)
void	Serialize (const TReadRange &readRange, NYson::IYsonConsumer *consumer)
void	Serialize (const TRichYPath &path, NYson::IYsonConsumer *consumer)
void	Deserialize (TRichYPath &path, const TNode &node)
void	Serialize (const TAttributeFilter &filter, NYson::IYsonConsumer *consumer)
void	Serialize (const TColumnSchema &columnSchema, NYson::IYsonConsumer *consumer)
void	Serialize (const TDeletedColumnSchema &columnSchema, NYson::IYsonConsumer *consumer)
void	Serialize (const TTableSchema &tableSchema, NYson::IYsonConsumer *consumer)
void	Deserialize (EValueType &valueType, const TNode &node)
void	Deserialize (TTableSchema &tableSchema, const TNode &node)
void	Deserialize (TColumnSchema &columnSchema, const TNode &node)
void	Deserialize (TDeletedColumnSchema &columnSchema, const TNode &node)
void	Deserialize (TTableColumnarStatistics &statistics, const TNode &node)
void	Deserialize (TMultiTablePartition &partition, const TNode &node)
void	Deserialize (TMultiTablePartitions &partitions, const TNode &node)
void	Deserialize (TFilePartition &partition, const TNode &node)
void	Deserialize (TFilePartitions &partitions, const TNode &node)
void	Deserialize (TTabletInfo &tabletInfos, const TNode &node)
void	Serialize (const TGUID &path, NYson::IYsonConsumer *consumer)
void	Deserialize (TGUID &value, const TNode &node)
void	Serialize (const NTi::TTypePtr &type, NYson::IYsonConsumer *consumer)
void	Deserialize (NTi::TTypePtr &type, const TNode &node)
template<typename T>
TString	ToYsonText (const T &value)
template<typename T>
NSkiff::TSkiffSchemaPtr	GetSkiffSchema (const TMaybe< TSkiffRowHints > &)
template<typename T>
NSkiff::TSkiffSchemaPtr	GetParserSkiffSchema (const TMaybe< TSkiffRowHints > &hints)
template<typename T>
ISkiffRowParserPtr	CreateSkiffParser (T *, const TMaybe< TSkiffRowHints > &)
	Creates a parser for row type T.
template<typename T>
ISkiffRowSkipperPtr	CreateSkiffSkipper (const TMaybe< TSkiffRowHints > &hints)
TYPath	CreateTempTable (const IClientBasePtr &client, const TString &prefix, const TYPath &directory, const TCreateOptions &options)
	Create empty table with unique name in given directory and return its path.

Variables
const TString	DefaultHosts
const TString	DefaultRemoteTempTablesDirectory
const TString	DefaultRemoteTempFilesDirectory
constexpr size_t	MaxInputTableCount = 1000

Detailed Description

Main namespace of YT client.

Typedef Documentation

◆ TStructuredRowStreamDescription

using NYT::TStructuredRowStreamDescription

Initial value:

 std::variant<
    TVoidStructuredRowStream,
    TTNodeStructuredRowStream,
    TTYaMRRowStructuredRowStream,
    TProtobufStructuredRowStream
>

Tag class to specify type of rows in an operation row stream.

◆ TTableStructure

using NYT::TTableStructure

Initial value:

 std::variant<
    TUnspecifiedTableStructure,
    TProtobufTableStructure
>

Tag class to specify table row type.

Enumeration Type Documentation

◆ EAtomicity

enum class NYT::EAtomicity

strong

Atomicity mode.

See also: NYT::TTabletTransactionOptions::TDurability; https://ytsaurus.tech/docs/en/user-guide/dynamic-tables/sorted-dynamic-tables

Enumerator
None	Transactions are non atomic (might reduce latency of write requests).
Full	Transactions are atomic (default).

◆ EAutoMergeMode

enum class NYT::EAutoMergeMode

strong

Auto merge mode.

See also: https://ytsaurus.tech/docs/en/user-guide/data-processing/operations/automerge

Enumerator
Disabled	Auto merge is disabled.
Relaxed	Mode that tries to achieve good chunk sizes and doesn't limit usage of chunk quota for intermediate chunks.
Economy	Mode that tries to optimize usage of chunk quota for intermediate chunks, operation might run slower.
Manual	Manual configuration of automerge parameters. TAutoMergeSpec

◆ EColumnarStatisticsFetcherMode

enum class NYT::EColumnarStatisticsFetcherMode

strong

Columnar statistics fetching mode.

NYT::TGetTableColumnarStatisticsOptions::FetcherMode

Enumerator

FromNodes

Slow mode for fetching precise columnar statistics.

FromMaster

Fast mode for fetching lightweight columnar statistics.

Relative precision is 1 / 256.

Note: Might be unavailable for old tables in that case some upper bound is returned.

Fallback

Use lightweight columnar statistics (FromMaster) if available otherwise switch to slow but precise mode (FromNodes).

◆ EComplexTypeMode

enum class NYT::EComplexTypeMode : int

strong

Mode of composite type representation in yson.

See also: https://ytsaurus.tech/docs/en/user-guide/storage/data-types#yson

◆ EDurability

enum class NYT::EDurability

strong

Durability mode.

See also: NYT::TTabletTransactionOptions::TDurability; https://ytsaurus.tech/docs/en/user-guide/dynamic-tables/sorted-dynamic-tables

Enumerator
Sync	Sync mode (default).
Async	Async mode (might reduce latency of write requests, but less reliable).

◆ EErasureCodecAttr

enum NYT::EErasureCodecAttr : i8

Value of "erasure_codec" attribute.

NYT::TRichYPath

◆ EJobSortDirection

enum class NYT::EJobSortDirection : int

strong

Job sort direction.

See also: NYT::TListJobsOptions.

◆ EJobSortField

enum class NYT::EJobSortField : int

strong

Job sort field.

See also: NYT::TListJobsOptions.

◆ ELockMode

enum NYT::ELockMode : int

Type of the lock.

See also: https://ytsaurus.tech/docs/en/user-guide/storage/transactions#locking_mode; NYT::ITransaction::Lock

Enumerator
LM_EXCLUSIVE	Exclusive lock.
LM_SHARED	Shared lock.
LM_SNAPSHOT	Snapshot lock.

◆ ELockType

enum class NYT::ELockType

strong

Row lock type used by modify-rows commands.

Controls the lock acquired on each touched row at the dynamic table tablet level. Mirrors a subset of NYT::NTableClient::ELockType.

See also: https://ytsaurus.tech/docs/en/user-guide/dynamic-tables/sorted-dynamic-tables#conflicts

Enumerator
Exclusive	Exclusive write lock on the row (default for modify-rows commands).
SharedWrite	Shared-write lock. Multiple concurrent shared-write writers to the same aggregate column coexist without conflict; their aggregate values fold commutatively. Conflicts with Exclusive.

◆ EMasterReadKind

enum class NYT::EMasterReadKind : int

strong

Enumeration for specifying how reading from master is performed.

Used in operations like NYT::ICypressClient::Get

Enumerator

Leader

Reading from leader.

Should almost never be used since it's expensive and for regular uses has no difference from "follower" read.

Follower

Reading from master follower (default).

◆ EOperationBriefState

enum class NYT::EOperationBriefState : int

strong

"Coarse-grained" state of an operation.

Enumerator
Failed	Failed.

◆ EOptimizeForAttr

enum NYT::EOptimizeForAttr : i8

Value of "optimize_for" attribute.

NYT::TRichYPath

Enumerator
OF_SCAN_ATTR	Optimize for scan.
OF_LOOKUP_ATTR	Optimize for lookup.

◆ EPermission

enum class NYT::EPermission : int

strong

Type of permission used in ACL.

See also: https://ytsaurus.tech/docs/en/user-guide/storage/access-control

Enumerator
Read	Applies to: all objects.
Write	Applies to: all objects.
Use	Applies to: accounts / pools.
Administer	Applies to: all objects.
Create	Applies to: schemas.
Remove	Applies to: all objects.
Mount	Applies to: tables.
Manage	Applies to: operations.
FullRead	Applies to: tables.

◆ EProfilerType

enum class NYT::EProfilerType

strong

Type of job profiler.

Enumerator
Cpu	Profile CPU usage.
Memory	Profile memory usage.
PeakMemory	Profiler peak memory usage.

◆ EProfilingBinary

enum class NYT::EProfilingBinary

strong

Binary to run job profiler on.

Enumerator
JobProxy	Profile job proxy.
UserJob	Profile user job.

◆ ERelation

enum class NYT::ERelation

strong

Enumeration describing comparison operation used in key bound.

ERelation is a part of NYT::TKeyBound that can be used as lower or upper key limit in TReadLimit.

Relations Less and LessOrEqual are for upper limit and relations Greater and GreaterOrEqual are for lower limit.

It is a error to use relation in the limit of wrong kind.

See also: https://ytsaurus.tech/docs/en/user-guide/storage/ypath#rich_ypath

Enumerator
Less	Relation "less". Specifies range of keys that are before specified key. Can only be used in upper limit.
LessOrEqual	Relation "less or equal". Specifies range of keys that are before or equal specified key. Can only be used in upper limit.
Greater	Relation "greater". Specifies range of keys that are after specified key. Can only be used in lower limit.
GreaterOrEqual	Relation "greater or equal". Specifies range of keys that are after or equal than specified key. Can only be used in lower limit.

◆ ESchemaInferenceMode

enum class NYT::ESchemaInferenceMode : int

strong

Schema inference mode.

See also: https://ytsaurus.tech/docs/en/user-guide/storage/static-schema.html#schema_inference

◆ ESchemaModificationAttr

enum NYT::ESchemaModificationAttr : i8

Value of "schema_modification" attribute.

NYT::TRichYPath

◆ ESecurityAction

enum class NYT::ESecurityAction : int

strong

Whether permission is granted or denied.

Enumerator
Allow	Permission is granted.
Deny	Permission is denied.

◆ ESortOrder

enum NYT::ESortOrder : int

Sort order.

NYT::TTableSchema

Enumerator
SO_ASCENDING	Ascending sort order.
SO_DESCENDING	Descending sort order.

◆ ETablePartitionMode

enum class NYT::ETablePartitionMode

strong

Table partitioning mode.

NYT::TGetTablePartitionsOptions::PartitionMode

Enumerator
Unordered	Ignores the order of input tables and their chunk and sorting orders.
Ordered	The order of table ranges inside each partition obey the order of input tables and their chunk orders.

◆ ETableReplicaMode

enum class NYT::ETableReplicaMode

strong

Table replica mode.

See also: https://ytsaurus.tech/docs/en/user-guide/dynamic-tables/replicated-dynamic-tables#attributes

◆ ETableWriterVersion

enum class NYT::ETableWriterVersion

strong

Enum describing possible versions of table writer implemetation.

Enumerator
Auto	Allow library to choose version of writer.
V1	Stable but slower version of writer.
V2	Unstable but faster version of writer (going to be default in the future).

◆ EValueType

enum NYT::EValueType : int

Type of the value that can occur in YT table.

NYT::TTableSchema https://ytsaurus.tech/docs/en/user-guide/storage/data-types

Enumerator
VT_INT64	Int64, signed integer of 64 bits.
VT_UINT64	Uint64, unsigned integer of 64 bits.
VT_DOUBLE	Double, floating point number of double precision (64 bits).
VT_BOOLEAN	Boolean, true or false.
VT_STRING	String, arbitrary byte sequence.
VT_ANY	Any, arbitrary yson document.
VT_INT8	Int8, signed integer of 8 bits.
VT_INT16	Int16, signed integer of 16 bits.
VT_INT32	Int32, signed integer of 32 bits.
VT_UINT8	Uint8, unsigned integer of 8 bits.
VT_UINT16	Uint16, unsigned integer of 16 bits.
VT_UINT32	Uint32, unsigned integer of 32 bits.
VT_UTF8	Utf8, byte sequence that is valid utf8.
VT_NULL	Null, absence of value (almost never used in schemas).
VT_VOID	Void, absence of value (almost never used in schemas) the difference between null, and void is yql-specific.
VT_DATE	Date, number of days since Unix epoch (unsigned).
VT_DATETIME	Datetime, number of seconds since Unix epoch (unsigned).
VT_TIMESTAMP	Timestamp, number of milliseconds since Unix epoch (unsigned).
VT_INTERVAL	Interval, difference between two timestamps (signed).
VT_FLOAT	Float, floating point number (32 bits).
VT_JSON	Json, sequence of bytes that is valid json.

Function Documentation

◆ begin()

template<class T>

TTableReaderIterator< T > NYT::begin ( TTableReader< T > & reader )

Function to facilitate range-based-for for NYT::TTableReader.

See also: NYT::TTableReaderIterator

◆ ConvertJobStatisticsEntry()

template<typename T>

T NYT::ConvertJobStatisticsEntry ( i64 value )

Convert i64 representation of statistics to other type.

Library defines this template for types TDuration and i64. Users may define it for their types.

See also: NYT::TJobStatistics::GetStatisticsAs method.

◆ CreateProtoMultiTableReader() [1/2]

template<class... Ts>

TTableReaderPtr< typename NDetail::TProtoOneOfUnique< Ts... >::TType > NYT::CreateProtoMultiTableReader	(	IInputStream *	stream,
		const TTableReaderOptions &	options = {} )

Create a protobuf multi table reader from a stream.

Template Parameters

Ts	Protobuf message types to read (must be inherited from Message).

Parameters

stream Input stream in YT protobuf format.

◆ CreateProtoMultiTableReader() [2/2]

template<class T>

TTableReaderPtr< T > NYT::CreateProtoMultiTableReader	(	IInputStream *	stream,
		int	tableCount,
		const TTableReaderOptions &	options = {} )

Create a homogeneous protobuf multi table reader from a stream.

Template Parameters

T	Protobuf message type to read (must be inherited from Message).

Parameters

stream	Input stream in YT protobuf format.
tableCount	Number of tables in input stream.

◆ CreateSkiffSkipper()

template<typename T>

ISkiffRowSkipperPtr NYT::CreateSkiffSkipper ( const TMaybe< TSkiffRowHints > & hints )

Creates a skipper for row type 'T'. You don't need to write its specialization.

◆ CreateTableReader()

template<typename T>

TTableReaderPtr< T > NYT::CreateTableReader	(	IInputStream *	stream,
		const TTableReaderOptions &	options = {} )

Create a protobuf table reader from a stream.

Template Parameters

T	Protobuf message type to read (must be inherited from Message).

Parameters

stream Input stream in YT protobuf format.

◆ CreateTableSchema() [1/2]

TTableSchema NYT::CreateTableSchema	(	const ::google::protobuf::Descriptor &	messageDescriptor,
		bool	keepFieldsWithoutExtension )

Create table schema from protobuf message descriptor.

Parameters

messageDescriptor	Message descriptor
keepFieldsWithoutExtension	Add to schema fields without "column_name" or "key_column_name" extensions.

◆ CreateTableSchema() [2/2]

TTableSchema NYT::CreateTableSchema ( NTi::TTypePtr type )

Create strict table schema from struct type.

Names and types of columns are taken from struct member names and types. Strict flag is set to true, all other attribute of schema and columns are left with default values

◆ CreateTempTable()

TYPath NYT::CreateTempTable	(	const IClientBasePtr &	client,
		const TString &	prefix,
		const TYPath &	directory,
		const TCreateOptions &	options )

Create empty table with unique name in given directory and return its path.

Parameters

client	– YT client or transaction object.
prefix	– table name prefix
directory	– path to directory where temporary table will be created.
options	– options to be passed for table creation (might be useful if we want to set table attributes)

◆ end()

template<class T>

TTableReaderIterator< T > NYT::end ( TTableReader< T > & )

Function to facilitate range-based-for for NYT::TTableReader.

See also: NYT::TTableReaderIterator

◆ GetParserSkiffSchema()

template<typename T>

NSkiff::TSkiffSchemaPtr NYT::GetParserSkiffSchema ( const TMaybe< TSkiffRowHints > & hints )

Return skiff schema for row type T which will be used for skiff parser. By default, it is equal to the requested schema.

◆ GetRangesCompat()

const TVector< TReadRange > & NYT::GetRangesCompat ( const TRichYPath & path )

Get the list of ranges related to path in compatibility mode.

If path is missing ranges, empty list is returned.
If path has associated range list and the list is not empty, function returns this list.
If path has associated range list and this list is empty, exception is thrown.

Before YT-17683 RichYPath didn't support empty range list and empty range actually meant universal range. This function emulates this old behavior.

See also: https://st.yandex-team.ru/YT-17683

◆ GetSkiffSchema()

template<typename T>

NSkiff::TSkiffSchemaPtr NYT::GetSkiffSchema ( const TMaybe< TSkiffRowHints > & )

Return skiff schema for row type T which will be requested. Need to write its specialization.

◆ Initialize()

void NYT::Initialize	(	int	argc,
		const char **	argv,
		const TInitializeOptions &	options = TInitializeOptions() )

Performs basic initialization and switches to a job mode if required.

This function performs basic initialization (it sets up logging reads the config, etc) and checks if binary is launched on YT machine inside a job. If latter is true this function launches proper job and after job is done it calls exit().

This function must be called if application starts any operation. This function must be called immediately after entering main() function before any argument parsing is done.

◆ IsTrivial()

bool NYT::IsTrivial ( const TReadLimit & readLimit )

Check if none of the fields of NYT::TReadLimit is set.

Returns: true if any field of readLimit is set and false otherwise.

◆ JoblessInitialize()

void NYT::JoblessInitialize ( const TInitializeOptions & options = TInitializeOptions() )

Performs basic initialization (logging, termination handlers, etc).

This function never switches to job mode.

◆ MaybeWithSchema()

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.

If TRowType is protobuf message schema is derived from it and set to returned path. Otherwise schema of original path is left unchanged (and probably unset).

◆ WithSchema()

template<typename TProtoType>

TRichYPath NYT::WithSchema	(	const TRichYPath &	path,
		const TSortColumns &	sortBy = TSortColumns() )

Create copy of NYT::TRichYPath with schema derived from proto message.

◆ WriteCustomStatistics() [1/2]

void NYT::WriteCustomStatistics ( const TNode & statistics )

Write several custom statistics at once.

Parameters

statistics A tree of map nodes with leaves of type i64.

Note: The call is equivalent to calling NYT::WriteCustomStatistics(TStringBuf, i64) for every path in the given map.

◆ WriteCustomStatistics() [2/2]

void NYT::WriteCustomStatistics	(	TStringBuf	path,
		i64	value )

Write custom statistics.

Parameters

path	Slash-separated path (length must not exceed 512 bytes).
value	Value of the statistic.

Note: The function must be called in job. Total number of statistics (with different paths) must not exceed 128.

◆ YT_DEFINE_STRONG_TYPEDEF() [1/6]

NYT::YT_DEFINE_STRONG_TYPEDEF	(	TDistributedWriteFileCookie	,
		TNode	)

Cookie object for participant of distributed write file session.

Holds server representation of distributed write file cookie. Created by NYT::IClient::StartDistributedWriteFileSession.

◆ YT_DEFINE_STRONG_TYPEDEF() [2/6]

NYT::YT_DEFINE_STRONG_TYPEDEF	(	TDistributedWriteFileSession	,
		TNode	)

Distributed write file session object.

Holds server representation of distributed session. Created by NYT::IClient::StartDistributedWriteFileSession.

◆ YT_DEFINE_STRONG_TYPEDEF() [3/6]

NYT::YT_DEFINE_STRONG_TYPEDEF	(	TDistributedWriteTableCookie	,
		TNode	)

Cookie object for participant of distributed write table session.

Holds server representation of distributed write table cookie. Created by NYT::IClient::StartDistributedWriteTableSession.

◆ YT_DEFINE_STRONG_TYPEDEF() [4/6]

NYT::YT_DEFINE_STRONG_TYPEDEF	(	TDistributedWriteTableSession	,
		TNode	)

Distributed write table session object.

Holds server representation of distributed session. Created by NYT::IClient::StartDistributedWriteTableSession.

◆ YT_DEFINE_STRONG_TYPEDEF() [5/6]

NYT::YT_DEFINE_STRONG_TYPEDEF	(	TWriteFileFragmentResult	,
		TNode	)

Fragment write result produced by NYT::IFileFragmentWriter.

Holds server representation of distributed file write fragment result.

◆ YT_DEFINE_STRONG_TYPEDEF() [6/6]

NYT::YT_DEFINE_STRONG_TYPEDEF	(	TWriteTableFragmentResult	,
		TNode	)

Fragment write result produced by NYT::ITableFragmentWriter.

Holds server representation of distributed table write fragment result.

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ TStructuredRowStreamDescription

◆ TTableStructure

Enumeration Type Documentation

◆ EAtomicity

◆ EAutoMergeMode

◆ EColumnarStatisticsFetcherMode

◆ EComplexTypeMode

◆ EDurability

◆ EErasureCodecAttr

◆ EJobSortDirection

◆ EJobSortField

◆ ELockMode

◆ ELockType

◆ EMasterReadKind

◆ EOperationBriefState

◆ EOptimizeForAttr

◆ EPermission

◆ EProfilerType

◆ EProfilingBinary

◆ ERelation

◆ ESchemaInferenceMode

◆ ESchemaModificationAttr

◆ ESecurityAction

◆ ESortOrder

◆ ETablePartitionMode

◆ ETableReplicaMode

◆ ETableWriterVersion

◆ EValueType

Function Documentation

◆ begin()

◆ ConvertJobStatisticsEntry()

◆ CreateProtoMultiTableReader() [1/2]

◆ CreateProtoMultiTableReader() [2/2]

◆ CreateSkiffSkipper()

◆ CreateTableReader()

◆ CreateTableSchema() [1/2]

◆ CreateTableSchema() [2/2]

◆ CreateTempTable()

◆ end()

◆ GetParserSkiffSchema()

◆ GetRangesCompat()

◆ GetSkiffSchema()

◆ Initialize()

◆ IsTrivial()

◆ JoblessInitialize()

◆ MaybeWithSchema()

◆ WithSchema()

◆ WriteCustomStatistics() [1/2]

◆ WriteCustomStatistics() [2/2]

◆ YT_DEFINE_STRONG_TYPEDEF() [1/6]

◆ YT_DEFINE_STRONG_TYPEDEF() [2/6]

◆ YT_DEFINE_STRONG_TYPEDEF() [3/6]

◆ YT_DEFINE_STRONG_TYPEDEF() [4/6]

◆ YT_DEFINE_STRONG_TYPEDEF() [5/6]

◆ YT_DEFINE_STRONG_TYPEDEF() [6/6]