Client interface to execute Cypress-related commands. More...

#include <cypress.h>

Inheritance diagram for NYT::ICypressClient:

Public Member Functions
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.

Detailed Description

Client interface to execute Cypress-related commands.

Member Function Documentation

◆ CanonizeYPath()

virtual TRichYPath NYT::ICypressClient::CanonizeYPath ( const TRichYPath & path )

pure virtual

Canonize YPath, moving all the complex YPath features to attributes.

See also: YT doc

◆ Concatenate() [1/2]

virtual void NYT::ICypressClient::Concatenate	(	const TVector< TRichYPath > &	sourcePaths,
		const TRichYPath &	destinationPath,
		const TConcatenateOptions &	options = TConcatenateOptions() )

pure virtual

Concatenate several tables into one.

See also: YT doc

◆ Concatenate() [2/2]

virtual void NYT::ICypressClient::Concatenate	(	const TVector< TYPath > &	sourcePaths,
		const TYPath &	destinationPath,
		const TConcatenateOptions &	options = TConcatenateOptions() )

virtual

Concatenate several tables into one.

See also: YT doc

◆ Copy()

virtual TNodeId NYT::ICypressClient::Copy	(	const TYPath &	sourcePath,
		const TYPath &	destinationPath,
		const TCopyOptions &	options = TCopyOptions() )

pure virtual

Copy Cypress node.

See also: YT doc

◆ Create()

virtual TNodeId NYT::ICypressClient::Create	(	const TYPath &	path,
		ENodeType	type,
		const TCreateOptions &	options = TCreateOptions() )

pure virtual

Create Cypress node of given type.

Parameters

path	Path in Cypress to the new object.
type	New node type.
options	Optional parameters.

Returns: Id of the created node.

Note: All but the last components must exist unless NYT::TCreateOptions::Recursive is true.; The node itself must not exist unless NYT::TCreateOptions::IgnoreExisting or NYT::TCreateOptions::Force are true.

See also: YT doc

◆ CreateTable()

template<typename TRowType>

TNodeId NYT::ICypressClient::CreateTable	(	const TYPath &	path,
		const TSortColumns &	sortColumns = TSortColumns(),
		const TCreateOptions &	options = TCreateOptions() )

Create table with schema inferred from the template argument.

Template Parameters

TRowType type of C++ representation of the row to be stored in the table.

Parameters

path	Path in Cypress to the new table.
sortColumns	List of columns to mark as sorted in schema.
options	Optional parameters.

Returns: Id of the created node.

Note: If "schema" is passed in options.Attributes it has priority over the deduced schema (the latter is ignored).

◆ Exists()

virtual bool NYT::ICypressClient::Exists	(	const TYPath &	path,
		const TExistsOptions &	options = TExistsOptions() )

pure virtual

Check if Cypress node exists.

See also: YT doc

◆ Get()

virtual TNode NYT::ICypressClient::Get	(	const TYPath &	path,
		const TGetOptions &	options = TGetOptions() )

pure virtual

Get Cypress node contents.

See also: YT doc

◆ GetFileFromCache()

virtual TMaybe< TYPath > NYT::ICypressClient::GetFileFromCache	(	const TString &	md5Signature,
		const TYPath &	cachePath,
		const TGetFileFromCacheOptions &	options = TGetFileFromCacheOptions() )

pure virtual

Get file from file cache.

Parameters

md5Signature	MD5 digest of the file.
cachePath	Path to the file cache.
options	Optional parameters.

See also: YT doc

◆ GetFilePartitions()

virtual TFilePartitions NYT::ICypressClient::GetFilePartitions	(	const TYPath &	path,
		const TVector< TFileReadRange > &	ranges,
		const TGetFilePartitionsOptions &	options = {} )

pure virtual

Split a file into partitions according to the given byte ranges.

One partition is produced per range, preserving range order. Each partition can be given to a separate worker for further independent processing.

◆ GetTableColumnarStatistics()

virtual TVector< TTableColumnarStatistics > NYT::ICypressClient::GetTableColumnarStatistics	(	const TVector< TRichYPath > &	paths,
		const TGetTableColumnarStatisticsOptions &	options = {} )

pure virtual

Get statistics for given sets of columns in given table ranges.

Note: Paths must contain column selectors.

See also: YT doc

◆ GetTablePartitions()

virtual TMultiTablePartitions NYT::ICypressClient::GetTablePartitions	(	const TVector< TRichYPath > &	paths,
		const TGetTablePartitionsOptions &	options )

pure virtual

Divide input tables into disjoint partitions.

Resulted partitions are vectors of rich YPaths. Each partition can be given to a separate worker for further independent processing.

◆ Link()

virtual TNodeId NYT::ICypressClient::Link	(	const TYPath &	targetPath,
		const TYPath &	linkPath,
		const TLinkOptions &	options = TLinkOptions() )

pure virtual

Create link to Cypress node.

See also: YT doc

◆ List()

virtual TNode::TListType NYT::ICypressClient::List	(	const TYPath &	path,
		const TListOptions &	options = TListOptions() )

pure virtual

List Cypress map or attribute node keys.

Parameters

path	Path in the tree to the node in question.
options	Optional parameters.

Returns: List of keys with attributes (if they were required in NYT::TListOptions::AttributeFilter).

See also: YT doc

◆ Move()

virtual TNodeId NYT::ICypressClient::Move	(	const TYPath &	sourcePath,
		const TYPath &	destinationPath,
		const TMoveOptions &	options = TMoveOptions() )

pure virtual

Move Cypress node (equivalent to copy-then-remove).

See also: YT doc

◆ MultisetAttributes()

virtual void NYT::ICypressClient::MultisetAttributes	(	const TYPath &	path,
		const TNode::TMapType &	attributes,
		const TMultisetAttributesOptions &	options = TMultisetAttributesOptions() )

pure virtual

Set multiple attributes for cypress path.

Parameters

path	Path to root of the attributes to be set e.g. "//path/to/table/@"; it is important to make sure that path ends with "/@".
attributes	Map with attributes
options	Optional parameters.

See also: YT doc

◆ PutFileToCache()

virtual TYPath NYT::ICypressClient::PutFileToCache	(	const TYPath &	filePath,
		const TString &	md5Signature,
		const TYPath &	cachePath,
		const TPutFileToCacheOptions &	options = TPutFileToCacheOptions() )

pure virtual

Put file to file cache.

Parameters

filePath	Path in Cypress to the file to cache.
md5Signature	Expected MD5 digest of the file.
cachePath	Path to the file cache.
options	Optional parameters.

Note: The file in filePath must have been written with NYT::TFileWriterOptions::ComputeMD5 set to true.

See also: YT doc

◆ Remove()

virtual void NYT::ICypressClient::Remove	(	const TYPath &	path,
		const TRemoveOptions &	options = TRemoveOptions() )

pure virtual

Remove Cypress node.

See also: YT doc

◆ Set()

virtual void NYT::ICypressClient::Set	(	const TYPath &	path,
		const TNode &	value,
		const TSetOptions &	options = TSetOptions() )

pure virtual

Set Cypress node contents.

See also: YT doc

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

yt/cpp/mapreduce/interface/cypress.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ CanonizeYPath()

◆ Concatenate() [1/2]

◆ Concatenate() [2/2]

◆ Copy()

◆ Create()

◆ CreateTable()

◆ Exists()

◆ Get()

◆ GetFileFromCache()

◆ GetFilePartitions()

◆ GetTableColumnarStatistics()

◆ GetTablePartitions()

◆ Link()

◆ List()

◆ Move()

◆ MultisetAttributes()

◆ PutFileToCache()

◆ Remove()

◆ Set()