C++ YT Wrapper
C++ library for working with YT clusters
Loading...
Searching...
No Matches
NYT::IClient Class Referenceabstract

Interface containing non-transactional commands. More...

#include <client.h>

Inheritance diagram for NYT::IClient:
NYT::IClientBase NYT::ICypressClient NYT::IIOClient NYT::IOperationClient

Public Member Functions

virtual ITransactionPtr AttachTransaction (const TTransactionId &transactionId, const TAttachTransactionOptions &options=TAttachTransactionOptions())=0
 Attach to existing master transaction.
virtual void MountTable (const TYPath &path, const TMountTableOptions &options=TMountTableOptions())=0
 Mount dynamic table.
virtual void UnmountTable (const TYPath &path, const TUnmountTableOptions &options=TUnmountTableOptions())=0
 Unmount dynamic table.
virtual void RemountTable (const TYPath &path, const TRemountTableOptions &options=TRemountTableOptions())=0
 Remount dynamic table.
virtual void FreezeTable (const TYPath &path, const TFreezeTableOptions &options=TFreezeTableOptions())=0
 Switch dynamic table from mounted' into frozen' state.
virtual void UnfreezeTable (const TYPath &path, const TUnfreezeTableOptions &options=TUnfreezeTableOptions())=0
 Switch dynamic table from frozen into mounted state.
virtual void ReshardTable (const TYPath &path, const TVector< TKey > &pivotKeys, const TReshardTableOptions &options=TReshardTableOptions())=0
 Reshard dynamic table (break it into tablets) by given pivot keys.
virtual void ReshardTable (const TYPath &path, i64 tabletCount, const TReshardTableOptions &options=TReshardTableOptions())=0
 Reshard dynamic table, breaking it into given number of tablets.
virtual void InsertRows (const TYPath &path, const TNode::TListType &rows, const TInsertRowsOptions &options=TInsertRowsOptions())=0
 Insert rows into dynamic table.
virtual void DeleteRows (const TYPath &path, const TNode::TListType &keys, const TDeleteRowsOptions &options=TDeleteRowsOptions())=0
 Delete rows from dynamic table.
virtual void TrimRows (const TYPath &path, i64 tabletIndex, i64 rowCount, const TTrimRowsOptions &options=TTrimRowsOptions())=0
 Trim rows from the beginning of ordered dynamic table.
virtual TNode::TListType LookupRows (const TYPath &path, const TNode::TListType &keys, const TLookupRowsOptions &options=TLookupRowsOptions())=0
 Lookup rows with given keys from dynamic table.
virtual TNode::TListType SelectRows (const TString &query, const TSelectRowsOptions &options=TSelectRowsOptions())=0
 Select rows from dynamic table, using SQL dialect.
virtual void AlterTableReplica (const TReplicaId &replicaId, const TAlterTableReplicaOptions &alterTableReplicaOptions)=0
 Change properties of table replica.
virtual ui64 GenerateTimestamp ()=0
 Generate a monotonously increasing master timestamp.
virtual TAuthorizationInfo WhoAmI ()=0
 Return YT username of current client.
virtual TOperationAttributes GetOperation (const TOperationId &operationId, const TGetOperationOptions &options=TGetOperationOptions())=0
 Get operation attributes.
virtual TOperationAttributes GetOperation (const TString &alias, const TGetOperationOptions &options=TGetOperationOptions())=0
 Get operation attributes.
virtual TListOperationsResult ListOperations (const TListOperationsOptions &options=TListOperationsOptions())=0
 List operations satisfying given filters.
virtual void UpdateOperationParameters (const TOperationId &operationId, const TUpdateOperationParametersOptions &options)=0
 Update operation runtime parameters.
virtual TJobAttributes GetJob (const TOperationId &operationId, const TJobId &jobId, const TGetJobOptions &options=TGetJobOptions())=0
 Get job attributes.
virtual TListJobsResult ListJobs (const TOperationId &operationId, const TListJobsOptions &options=TListJobsOptions())=0
virtual IFileReaderPtr GetJobInput (const TJobId &jobId, const TGetJobInputOptions &options=TGetJobInputOptions())=0
 Get the input of a running or failed job.
virtual IFileReaderPtr GetJobFailContext (const TOperationId &operationId, const TJobId &jobId, const TGetJobFailContextOptions &options=TGetJobFailContextOptions())=0
 Get fail context of a failed job.
virtual IFileReaderPtr GetJobStderr (const TOperationId &operationId, const TJobId &jobId, const TGetJobStderrOptions &options=TGetJobStderrOptions())=0
 Get stderr of a running or failed job.
virtual IFileReaderPtr GetJobTrace (const TOperationId &operationId, const TJobId &jobId, const TGetJobTraceOptions &options=TGetJobTraceOptions())=0
 Get trace of a job.
virtual TNode::TListType SkyShareTable (const std::vector< TYPath > &tablePaths, const TSkyShareTableOptions &options)=0
 Create one or several rbtorrents for files in a blob table.
virtual TCheckPermissionResponse CheckPermission (const TString &user, EPermission permission, const TYPath &path, const TCheckPermissionOptions &options=TCheckPermissionOptions())=0
 Check if user has permission to access a Cypress node at path.
virtual TVector< TTabletInfo > GetTabletInfos (const TYPath &path, const TVector< int > &tabletIndexes, const TGetTabletInfosOptions &options=TGetTabletInfosOptions())=0
 Get information about tablet.
virtual const TNode::TMapType & GetDynamicConfiguration (const TString &configProfile)
 Get cluster configuration stored in Cypress by profile name (e.g. "default").
virtual void CheckClusterLiveness (const TCheckClusterLivenessOptions &options=TCheckClusterLivenessOptions())=0
 Check cluster liveness.
virtual void SuspendOperation (const TOperationId &operationId, const TSuspendOperationOptions &options=TSuspendOperationOptions())=0
 Suspend operation.
virtual void ResumeOperation (const TOperationId &operationId, const TResumeOperationOptions &options=TResumeOperationOptions())=0
 Resume previously suspended operation.
virtual void Shutdown ()=0
 Synchronously terminates all client's background activities.
virtual void PingDistributedWriteTableSession (const TDistributedWriteTableSession &session, const TPingDistributedWriteTableOptions &options={})=0
 Ping distributed session to prolong its main transaction lifetime.
virtual void FinishDistributedWriteTableSession (const TDistributedWriteTableSession &session, const TVector< TWriteTableFragmentResult > &results, const TFinishDistributedWriteTableOptions &options={})=0
 Merge all write fragments results into table and close distributed session.
virtual void PingDistributedWriteFileSession (const TDistributedWriteFileSession &session, const TPingDistributedWriteFileOptions &options={})=0
 Ping distributed session to prolong its main transaction lifetime.
virtual void FinishDistributedWriteFileSession (const TDistributedWriteFileSession &session, const TVector< TWriteFileFragmentResult > &results, const TFinishDistributedWriteFileOptions &options={})=0
 Merge all write fragments results into file and close distributed session.
Public Member Functions inherited from NYT::IClientBase
virtual ITransactionPtr StartTransaction (const TStartTransactionOptions &options=TStartTransactionOptions())=0
 Start a [transaction] (https://ytsaurus.tech/docs/en/user-guide/storage/transactions.html#master_transactions).
virtual TDistributedWriteFileSessionWithCookies StartDistributedWriteFileSession (const TRichYPath &richPath, i64 cookieCount, const TStartDistributedWriteFileOptions &options={})=0
 Initialize distributed file session and request cookies for participants.
virtual TDistributedWriteTableSessionWithCookies StartDistributedWriteTableSession (const TRichYPath &richPath, i64 cookieCount, const TStartDistributedWriteTableOptions &options={})=0
 Initialize distributed table session and request cookies for participants.
virtual void AlterTable (const TYPath &path, const TAlterTableOptions &options=TAlterTableOptions())=0
 Change properties of table.
virtual TBatchRequestPtr CreateBatchRequest ()=0
 Create batch request object that allows to execute several light requests in parallel.
virtual IClientPtr GetParentClient (bool ignoreGlobalTx=false)=0
 Get root client.
Public Member Functions inherited from NYT::ICypressClient
virtual TNodeId Create (const TYPath &path, ENodeType type, const TCreateOptions &options=TCreateOptions())=0
 Create Cypress node of given type.
template<typename TRowType>
TNodeId CreateTable (const TYPath &path, const TSortColumns &sortColumns=TSortColumns(), const TCreateOptions &options=TCreateOptions())
 Create table with schema inferred from the template argument.
virtual void Remove (const TYPath &path, const TRemoveOptions &options=TRemoveOptions())=0
 Remove Cypress node.
virtual bool Exists (const TYPath &path, const TExistsOptions &options=TExistsOptions())=0
 Check if Cypress node exists.
virtual TNode Get (const TYPath &path, const TGetOptions &options=TGetOptions())=0
 Get Cypress node contents.
virtual void Set (const TYPath &path, const TNode &value, const TSetOptions &options=TSetOptions())=0
 Set Cypress node contents.
virtual void MultisetAttributes (const TYPath &path, const TNode::TMapType &attributes, const TMultisetAttributesOptions &options=TMultisetAttributesOptions())=0
 Set multiple attributes for cypress path.
virtual TNode::TListType List (const TYPath &path, const TListOptions &options=TListOptions())=0
 List Cypress map or attribute node keys.
virtual TNodeId Copy (const TYPath &sourcePath, const TYPath &destinationPath, const TCopyOptions &options=TCopyOptions())=0
 Copy Cypress node.
virtual TNodeId Move (const TYPath &sourcePath, const TYPath &destinationPath, const TMoveOptions &options=TMoveOptions())=0
 Move Cypress node (equivalent to copy-then-remove).
virtual TNodeId Link (const TYPath &targetPath, const TYPath &linkPath, const TLinkOptions &options=TLinkOptions())=0
 Create link to Cypress node.
virtual void Concatenate (const TVector< TRichYPath > &sourcePaths, const TRichYPath &destinationPath, const TConcatenateOptions &options=TConcatenateOptions())=0
 Concatenate several tables into one.
virtual void Concatenate (const TVector< TYPath > &sourcePaths, const TYPath &destinationPath, const TConcatenateOptions &options=TConcatenateOptions())
 Concatenate several tables into one.
virtual TRichYPath CanonizeYPath (const TRichYPath &path)=0
 Canonize YPath, moving all the complex YPath features to attributes.
virtual TVector< TTableColumnarStatistics > GetTableColumnarStatistics (const TVector< TRichYPath > &paths, const TGetTableColumnarStatisticsOptions &options={})=0
 Get statistics for given sets of columns in given table ranges.
virtual TMultiTablePartitions GetTablePartitions (const TVector< TRichYPath > &paths, const TGetTablePartitionsOptions &options)=0
 Divide input tables into disjoint partitions.
virtual TFilePartitions GetFilePartitions (const TYPath &path, const TVector< TFileReadRange > &ranges, const TGetFilePartitionsOptions &options={})=0
 Split a file into partitions according to the given byte ranges.
virtual TMaybe< TYPath > GetFileFromCache (const TString &md5Signature, const TYPath &cachePath, const TGetFileFromCacheOptions &options=TGetFileFromCacheOptions())=0
 Get file from file cache.
virtual TYPath PutFileToCache (const TYPath &filePath, const TString &md5Signature, const TYPath &cachePath, const TPutFileToCacheOptions &options=TPutFileToCacheOptions())=0
 Put file to file cache.
Public Member Functions inherited from NYT::IIOClient
virtual IFileReaderPtr CreateFileReader (const TRichYPath &path, const TFileReaderOptions &options=TFileReaderOptions())=0
 Create a reader for file at path.
virtual IFileReaderPtr CreateFilePartitionReader (const TString &cookie, const TFilePartitionReaderOptions &options={})=0
 Create a reader of file partition.
virtual IFileWriterPtr CreateFileWriter (const TRichYPath &path, const TFileWriterOptions &options=TFileWriterOptions())=0
 Create a writer for file at path.
virtual IFileFragmentWriterPtr CreateFileFragmentWriter (const TDistributedWriteFileCookie &cookie, const TFileFragmentWriterOptions &options=TFileFragmentWriterOptions())=0
 Create a fragment writer for given distributed file session cookie.
template<class T>
TTableReaderPtr< T > CreateTableReader (const TRichYPath &path, const TTableReaderOptions &options=TTableReaderOptions())
 Create a typed reader for table at path.
template<class T>
TTableWriterPtr< T > CreateTableWriter (const TRichYPath &path, const TTableWriterOptions &options=TTableWriterOptions())
 Create a typed writer for table at path.
virtual TTableWriterPtr<::google::protobuf::Message > CreateTableWriter (const TRichYPath &path, const ::google::protobuf::Descriptor &descriptor, const TTableWriterOptions &options=TTableWriterOptions())=0
 Create a writer to write protobuf messages with specified descriptor.
template<class T>
ITableFragmentWriterPtr< T > CreateTableFragmentWriter (const TDistributedWriteTableCookie &cookie, const TTableFragmentWriterOptions &options={})
 Create a fragment table writer for given distributed table session cookie.
virtual TRawTableReaderPtr CreateRawReader (const TRichYPath &path, const TFormat &format, const TTableReaderOptions &options=TTableReaderOptions())=0
 Create a reader to read a table using specified format.
virtual TRawTableWriterPtr CreateRawWriter (const TRichYPath &path, const TFormat &format, const TTableWriterOptions &options=TTableWriterOptions())=0
 Create a reader to write a table using specified format.
virtual TRawTableReaderPtr CreateRawTablePartitionReader (const TString &cookie, const TFormat &format, const TTablePartitionReaderOptions &options={})=0
 Create raw reader of table partition.
template<class T>
TTableReaderPtr< T > CreateTablePartitionReader (const TString &cookie, const TTablePartitionReaderOptions &options={})
 Create reader of table partition.
virtual IFileReaderPtr CreateBlobTableReader (const TYPath &path, const TKey &blobId, const TBlobTableReaderOptions &options=TBlobTableReaderOptions())=0
 Create a reader for blob table at path.
Public Member Functions inherited from NYT::IOperationClient
IOperationPtr Map (const TMapOperationSpec &spec, ::TIntrusivePtr< IMapperBase > mapper, const TOperationOptions &options=TOperationOptions())
 Run Map operation.
IOperationPtr Map (::TIntrusivePtr< IMapperBase > mapper, const TOneOrMany< TStructuredTablePath > &input, const TOneOrMany< TStructuredTablePath > &output, const TMapOperationSpec &spec=TMapOperationSpec(), const TOperationOptions &options=TOperationOptions())
 Run Map operation.
virtual IOperationPtr RawMap (const TRawMapOperationSpec &spec, ::TIntrusivePtr< IRawJob > rawJob, const TOperationOptions &options=TOperationOptions())=0
 Run raw Map operation.
IOperationPtr Reduce (const TReduceOperationSpec &spec, ::TIntrusivePtr< IReducerBase > reducer, const TOperationOptions &options=TOperationOptions())
 Run Reduce operation.
IOperationPtr Reduce (::TIntrusivePtr< IReducerBase > reducer, const TOneOrMany< TStructuredTablePath > &input, const TOneOrMany< TStructuredTablePath > &output, const TSortColumns &reduceBy, const TReduceOperationSpec &spec=TReduceOperationSpec(), const TOperationOptions &options=TOperationOptions())
 Run Reduce operation.
virtual IOperationPtr RawReduce (const TRawReduceOperationSpec &spec, ::TIntrusivePtr< IRawJob > rawJob, const TOperationOptions &options=TOperationOptions())=0
 Run raw Reduce operation.
IOperationPtr MapReduce (const TMapReduceOperationSpec &spec, ::TIntrusivePtr< IMapperBase > mapper, ::TIntrusivePtr< IReducerBase > reducer, const TOperationOptions &options=TOperationOptions())
 Run JoinReduce operation.
IOperationPtr MapReduce (const TMapReduceOperationSpec &spec, ::TIntrusivePtr< IMapperBase > mapper, ::TIntrusivePtr< IReducerBase > reduceCombiner, ::TIntrusivePtr< IReducerBase > reducer, const TOperationOptions &options=TOperationOptions())
 Run MapReduce operation.
IOperationPtr MapReduce (::TIntrusivePtr< IMapperBase > mapper, ::TIntrusivePtr< IReducerBase > reducer, const TOneOrMany< TStructuredTablePath > &input, const TOneOrMany< TStructuredTablePath > &output, const TSortColumns &reduceBy, TMapReduceOperationSpec spec=TMapReduceOperationSpec(), const TOperationOptions &options=TOperationOptions())
 Run MapReduce operation.
IOperationPtr MapReduce (::TIntrusivePtr< IMapperBase > mapper, ::TIntrusivePtr< IReducerBase > reduceCombiner, ::TIntrusivePtr< IReducerBase > reducer, const TOneOrMany< TStructuredTablePath > &input, const TOneOrMany< TStructuredTablePath > &output, const TSortColumns &reduceBy, TMapReduceOperationSpec spec=TMapReduceOperationSpec(), const TOperationOptions &options=TOperationOptions())
 Run MapReduce operation.
virtual IOperationPtr RawMapReduce (const TRawMapReduceOperationSpec &spec, ::TIntrusivePtr< IRawJob > mapper, ::TIntrusivePtr< IRawJob > reduceCombiner, ::TIntrusivePtr< IRawJob > reducer, const TOperationOptions &options=TOperationOptions())=0
 Run raw MapReduce operation.
virtual IOperationPtr Sort (const TSortOperationSpec &spec, const TOperationOptions &options=TOperationOptions())=0
 Run Sort operation.
IOperationPtr Sort (const TOneOrMany< TRichYPath > &input, const TRichYPath &output, const TSortColumns &sortBy, const TSortOperationSpec &spec=TSortOperationSpec(), const TOperationOptions &options=TOperationOptions())
 Run Sort operation.
virtual IOperationPtr Merge (const TMergeOperationSpec &spec, const TOperationOptions &options=TOperationOptions())=0
 Run Merge operation.
virtual IOperationPtr Erase (const TEraseOperationSpec &spec, const TOperationOptions &options=TOperationOptions())=0
 Run Erase operation.
virtual IOperationPtr RemoteCopy (const TRemoteCopyOperationSpec &spec, const TOperationOptions &options=TOperationOptions())=0
 Run RemoteCopy operation.
virtual IOperationPtr RunVanilla (const TVanillaOperationSpec &spec, const TOperationOptions &options=TOperationOptions())=0
 Run Vanilla operation.
virtual void AbortOperation (const TOperationId &operationId)=0
 Abort operation.
virtual void CompleteOperation (const TOperationId &operationId)=0
 Complete operation.
virtual void WaitForOperation (const TOperationId &operationId)=0
 Wait for operation to finish.
virtual EOperationBriefState CheckOperation (const TOperationId &operationId)=0
 Check and return operation status.
virtual IOperationPtr AttachOperation (const TOperationId &operationId)=0
 Create an operation object given operation id.

Detailed Description

Interface containing non-transactional commands.

Member Function Documentation

◆ AlterTableReplica()

virtual void NYT::IClient::AlterTableReplica ( const TReplicaId & replicaId,
const TAlterTableReplicaOptions & alterTableReplicaOptions )
pure virtual

Change properties of table replica.

Allows to enable/disable replica and/or change its mode.

See also
YT doc

◆ AttachTransaction()

virtual ITransactionPtr NYT::IClient::AttachTransaction ( const TTransactionId & transactionId,
const TAttachTransactionOptions & options = TAttachTransactionOptions() )
nodiscardpure virtual

Attach to existing master transaction.

Returned object WILL NOT:

◆ CheckClusterLiveness()

virtual void NYT::IClient::CheckClusterLiveness ( const TCheckClusterLivenessOptions & options = TCheckClusterLivenessOptions())
pure virtual

Check cluster liveness.

Throws if any requested liveness check fails. At least one check must be requested.

See also
YT doc

◆ CheckPermission()

virtual TCheckPermissionResponse NYT::IClient::CheckPermission ( const TString & user,
EPermission permission,
const TYPath & path,
const TCheckPermissionOptions & options = TCheckPermissionOptions() )
pure virtual

Check if user has permission to access a Cypress node at path.

For tables access to columns specified in options.Columns_ can be checked (

See also
the doc).

If access is denied (the returned result has .Action == ESecurityAction::Deny) because of a deny rule, the "denying" object name and id and "denied" subject name an id may be returned.

See also
YT doc

◆ DeleteRows()

virtual void NYT::IClient::DeleteRows ( const TYPath & path,
const TNode::TListType & keys,
const TDeleteRowsOptions & options = TDeleteRowsOptions() )
pure virtual

Delete rows from dynamic table.

See also
YT doc

◆ FinishDistributedWriteFileSession()

virtual void NYT::IClient::FinishDistributedWriteFileSession ( const TDistributedWriteFileSession & session,
const TVector< TWriteFileFragmentResult > & results,
const TFinishDistributedWriteFileOptions & options = {} )
pure virtual

Merge all write fragments results into file and close distributed session.

See also
YT doc

◆ FinishDistributedWriteTableSession()

virtual void NYT::IClient::FinishDistributedWriteTableSession ( const TDistributedWriteTableSession & session,
const TVector< TWriteTableFragmentResult > & results,
const TFinishDistributedWriteTableOptions & options = {} )
pure virtual

Merge all write fragments results into table and close distributed session.

See also
YT doc

◆ FreezeTable()

virtual void NYT::IClient::FreezeTable ( const TYPath & path,
const TFreezeTableOptions & options = TFreezeTableOptions() )
pure virtual

Switch dynamic table from mounted' into frozen' state.

When table is in frozen state all its data is flushed to disk and writes are disabled.

Note
this function launches the process of switching, but doesn't wait until switching is accomplished. Waiting has to be performed by user.
See also
YT doc

◆ GenerateTimestamp()

virtual ui64 NYT::IClient::GenerateTimestamp ( )
pure virtual

Generate a monotonously increasing master timestamp.

See also
YT doc

◆ GetDynamicConfiguration()

virtual const TNode::TMapType & NYT::IClient::GetDynamicConfiguration ( const TString & configProfile)
virtual

Get cluster configuration stored in Cypress by profile name (e.g. "default").

Cluster configs location is defined in |TConfig::ConfigRemotePatchPath|.

◆ GetJob()

virtual TJobAttributes NYT::IClient::GetJob ( const TOperationId & operationId,
const TJobId & jobId,
const TGetJobOptions & options = TGetJobOptions() )
pure virtual

Get job attributes.

See also
YT doc

◆ GetJobFailContext()

virtual IFileReaderPtr NYT::IClient::GetJobFailContext ( const TOperationId & operationId,
const TJobId & jobId,
const TGetJobFailContextOptions & options = TGetJobFailContextOptions() )
pure virtual

Get fail context of a failed job.

NYT::TErrorResponse exception is thrown if it is missing.

See also
YT doc

◆ GetJobInput()

virtual IFileReaderPtr NYT::IClient::GetJobInput ( const TJobId & jobId,
const TGetJobInputOptions & options = TGetJobInputOptions() )
pure virtual

Get the input of a running or failed job.

NYT::TErrorResponse exception is thrown if job is missing.

See also
YT doc

◆ GetJobStderr()

virtual IFileReaderPtr NYT::IClient::GetJobStderr ( const TOperationId & operationId,
const TJobId & jobId,
const TGetJobStderrOptions & options = TGetJobStderrOptions() )
pure virtual

Get stderr of a running or failed job.

NYT::TErrorResponse exception is thrown if it is missing.

Note
YT doesn't store all job stderrs
If job stderr exceeds few megabytes YT will store only head and tail of stderr.
See also
Description of max_stderr_size spec option here.
YT doc

◆ GetJobTrace()

virtual IFileReaderPtr NYT::IClient::GetJobTrace ( const TOperationId & operationId,
const TJobId & jobId,
const TGetJobTraceOptions & options = TGetJobTraceOptions() )
pure virtual

Get trace of a job.

NYT::TErrorResponse exception is thrown if it is missing.

Note
YT doesn't store all job traces.
See also
YT doc

◆ GetOperation() [1/2]

virtual TOperationAttributes NYT::IClient::GetOperation ( const TOperationId & operationId,
const TGetOperationOptions & options = TGetOperationOptions() )
pure virtual

Get operation attributes.

See also
YT doc

◆ GetOperation() [2/2]

virtual TOperationAttributes NYT::IClient::GetOperation ( const TString & alias,
const TGetOperationOptions & options = TGetOperationOptions() )
pure virtual

Get operation attributes.

See also
YT doc

◆ GetTabletInfos()

virtual TVector< TTabletInfo > NYT::IClient::GetTabletInfos ( const TYPath & path,
const TVector< int > & tabletIndexes,
const TGetTabletInfosOptions & options = TGetTabletInfosOptions() )
pure virtual

Get information about tablet.

See also
NYT::TTabletInfo

◆ InsertRows()

virtual void NYT::IClient::InsertRows ( const TYPath & path,
const TNode::TListType & rows,
const TInsertRowsOptions & options = TInsertRowsOptions() )
pure virtual

Insert rows into dynamic table.

See also
YT doc

◆ ListJobs()

virtual TListJobsResult NYT::IClient::ListJobs ( const TOperationId & operationId,
const TListJobsOptions & options = TListJobsOptions() )
pure virtual

List attributes of jobs satisfying given filters.

See also
YT doc

◆ ListOperations()

virtual TListOperationsResult NYT::IClient::ListOperations ( const TListOperationsOptions & options = TListOperationsOptions())
pure virtual

List operations satisfying given filters.

See also
YT doc

◆ LookupRows()

virtual TNode::TListType NYT::IClient::LookupRows ( const TYPath & path,
const TNode::TListType & keys,
const TLookupRowsOptions & options = TLookupRowsOptions() )
pure virtual

Lookup rows with given keys from dynamic table.

See also
YT doc

◆ MountTable()

virtual void NYT::IClient::MountTable ( const TYPath & path,
const TMountTableOptions & options = TMountTableOptions() )
pure virtual

Mount dynamic table.

See also
YT doc

◆ PingDistributedWriteFileSession()

virtual void NYT::IClient::PingDistributedWriteFileSession ( const TDistributedWriteFileSession & session,
const TPingDistributedWriteFileOptions & options = {} )
pure virtual

Ping distributed session to prolong its main transaction lifetime.

Distributed file write API

See also
YT doc

◆ PingDistributedWriteTableSession()

virtual void NYT::IClient::PingDistributedWriteTableSession ( const TDistributedWriteTableSession & session,
const TPingDistributedWriteTableOptions & options = {} )
pure virtual

Ping distributed session to prolong its main transaction lifetime.

Distributed table write API

See also
YT doc

◆ RemountTable()

virtual void NYT::IClient::RemountTable ( const TYPath & path,
const TRemountTableOptions & options = TRemountTableOptions() )
pure virtual

Remount dynamic table.

See also
YT doc

◆ ReshardTable() [1/2]

virtual void NYT::IClient::ReshardTable ( const TYPath & path,
const TVector< TKey > & pivotKeys,
const TReshardTableOptions & options = TReshardTableOptions() )
pure virtual

Reshard dynamic table (break it into tablets) by given pivot keys.

See also
YT doc

◆ ReshardTable() [2/2]

virtual void NYT::IClient::ReshardTable ( const TYPath & path,
i64 tabletCount,
const TReshardTableOptions & options = TReshardTableOptions() )
pure virtual

Reshard dynamic table, breaking it into given number of tablets.

See also
YT doc

◆ ResumeOperation()

virtual void NYT::IClient::ResumeOperation ( const TOperationId & operationId,
const TResumeOperationOptions & options = TResumeOperationOptions() )
pure virtual

Resume previously suspended operation.

See also
YT doc

◆ SelectRows()

virtual TNode::TListType NYT::IClient::SelectRows ( const TString & query,
const TSelectRowsOptions & options = TSelectRowsOptions() )
pure virtual

Select rows from dynamic table, using SQL dialect.

See also
YT doc

◆ Shutdown()

virtual void NYT::IClient::Shutdown ( )
pure virtual

Synchronously terminates all client's background activities.

e.g. no callbacks will be executed after the function is completed

Note
It is safe to call Shutdown multiple times
NYT::TApiUsageError will be thrown if any client's method is called after shutdown

◆ SkyShareTable()

virtual TNode::TListType NYT::IClient::SkyShareTable ( const std::vector< TYPath > & tablePaths,
const TSkyShareTableOptions & options )
pure virtual

Create one or several rbtorrents for files in a blob table.

If specified, one torrent is created for each value of KeyColumns option. Otherwise, a single torrent with all files of a table is created.

Returns
list of nodes, each node has two fields
  • key: list of key columns values. Empty if KeyColumns is not specified.
  • rbtorrent: rbtorrent string (with rbtorrent: prefix)
See also
More info.

◆ SuspendOperation()

virtual void NYT::IClient::SuspendOperation ( const TOperationId & operationId,
const TSuspendOperationOptions & options = TSuspendOperationOptions() )
pure virtual

Suspend operation.

Jobs will be aborted.

See also
YT doc

◆ TrimRows()

virtual void NYT::IClient::TrimRows ( const TYPath & path,
i64 tabletIndex,
i64 rowCount,
const TTrimRowsOptions & options = TTrimRowsOptions() )
pure virtual

Trim rows from the beginning of ordered dynamic table.

Asynchronously removes rowCount rows from the beginning of ordered dynamic table. Numeration of remaining rows does not change, e.g. after trim(10) and trim(20) you get in total 20 deleted rows.

Parameters
pathPath to ordered dynamic table.
tabletIndexWhich tablet to trim.
rowCountHow many trimmed rows will be in the table after command.
optionsOptional parameters.
See also
YT doc

◆ UnfreezeTable()

virtual void NYT::IClient::UnfreezeTable ( const TYPath & path,
const TUnfreezeTableOptions & options = TUnfreezeTableOptions() )
pure virtual

Switch dynamic table from frozen into mounted state.

Note
this function launches the process of switching, but doesn't wait until switching is accomplished. Waiting has to be performed by user.
See also
YT doc

◆ UnmountTable()

virtual void NYT::IClient::UnmountTable ( const TYPath & path,
const TUnmountTableOptions & options = TUnmountTableOptions() )
pure virtual

Unmount dynamic table.

See also
YT doc

◆ UpdateOperationParameters()

virtual void NYT::IClient::UpdateOperationParameters ( const TOperationId & operationId,
const TUpdateOperationParametersOptions & options )
pure virtual

Update operation runtime parameters.

See also
YT doc

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