NYT::TRichYPath Struct Reference

Path with additional attributes. More...

#include <common.h>

Public Types
using	TRenameColumnsDescriptor = THashMap<TString, TString>

Public Member Functions
TSelf &	Path (TYPath)
	Path itself.
TSelf &	Append (bool)
	Specifies that path should be appended not overwritten.
TSelf &	PartiallySorted (bool)
TSelf &	SortedBy (TSortColumns)
	Specifies that path is expected to be sorted by these columns.
TRichYPath &	AddRange (TReadRange range)
	Add range to read.
TRichYPath &	ResetRanges ()
TSelf &	Columns (TColumnNames)
	Specifies columns that should be read.
TSelf &	Teleport (bool)
TSelf &	Primary (bool)
TSelf &	Foreign (bool)
TSelf &	RowCountLimit (i64)
TSelf &	FileName (TString)
TSelf &	OriginalPath (TYPath)
	Specifies original path to be shown in Web UI.
TSelf &	Executable (bool)
	Specifies that this path points to executable file.
TSelf &	Format (TNode)
	Specify format to use when loading table.
TSelf &	Schema (TTableSchema)
	Specifies table schema that will be set on the path.
TSelf &	CompressionCodec (TString)
	Specifies compression codec that will be set on the path.
TSelf &	ErasureCodec (EErasureCodecAttr)
	Specifies erasure codec that will be set on the path.
TSelf &	SchemaModification (ESchemaModificationAttr)
	Specifies schema modification that will be set on the path.
TSelf &	OptimizeFor (EOptimizeForAttr)
	Specifies optimize_for attribute that will be set on the path.
TSelf &	BypassArtifactCache (bool)
	Do not put file used in operation into node cache.
TSelf &	Timestamp (i64)
	Timestamp of dynamic table.
TSelf &	TransactionId (TTransactionId)
	Specify transaction that should be used to access this path.
TSelf &	Create (bool)
	Wether to create operation output path.
TSelf &	RenameColumns (TRenameColumnsDescriptor)
	Specifies columnar mapping which will be applied to columns before transfer to job.
TSelf &	Cluster (TString)
	Specifies cluster for the YPath.
TSelf &	InputQuery (TString)
	Specifies input_query for the path.
	TRichYPath ()
	Create empty path with no attributes.
const TMaybe< TVector< TReadRange > > &	GetRanges () const
TMaybe< TVector< TReadRange > > &	MutableRanges ()
TArrayRef< TReadRange >	MutableRangesView ()
TArrayRef< const TReadRange >	GetRangesView () const
const TReadRange &	GetRange (ssize_t i) const
TReadRange &	MutableRange (ssize_t i)
	TRichYPath (const char *path)
	Create path from string.
	TRichYPath (const TYPath &path)

Detailed Description

Path with additional attributes.

Allows to specify additional attributes for path used in some operations.

See also

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

Member Function Documentation

BypassArtifactCache()

TSelf & NYT::TRichYPath::BypassArtifactCache

(

bool

)

Do not put file used in operation into node cache.

If BypassArtifactCache == true, file will be loaded into the job's sandbox bypassing the cache on the YT node. It helps jobs that use tmpfs to start faster, because files will be loaded into tmpfs directly bypassing disk cache

Columns()

TSelf & NYT::TRichYPath::Columns

(

TColumnNames

)

Specifies columns that should be read.

If it's set to Nothing then all columns will be read. If empty TColumnNames is specified then each read row will be empty.

Create()

TSelf & NYT::TRichYPath::Create

(

bool

)

Wether to create operation output path.

If set to true output path is created by YT server. If set to false output path is not created explicitly (and operation will fail if it doesn't exist) If attribute is not set output path is created by this library using explicit master call.

Executable()

TSelf & NYT::TRichYPath::Executable

(

bool

)

Specifies that this path points to executable file.

Used in operation specs.

Format()

TSelf & NYT::TRichYPath::Format

(

TNode

)

Specify format to use when loading table.

Used in operation specs.

GetRange()

const TReadRange & NYT::TRichYPath::GetRange ( ssize_t i ) const

inline

Get range by index.

GetRanges()

const TMaybe< TVector< TReadRange > > & NYT::TRichYPath::GetRanges ( ) const

inline

Return ranges to read.

NOTE: Nothing (in TMaybe) and empty TVector are different ranges. Nothing represents universal range (reader reads all table rows). Empty TVector represents empty range (reader returns empty set of rows).

MutableRangesView()

TArrayRef< TReadRange > NYT::TRichYPath::MutableRangesView ( )

inline

Get range view, that is a convenient way to iterate through all ranges.

PartiallySorted()

TSelf & NYT::TRichYPath::PartiallySorted

(

bool

)

Deprecated

Deprecated attribute.

Timestamp()

TSelf & NYT::TRichYPath::Timestamp

(

i64

)

Timestamp of dynamic table.

NOTE: it is not unix timestamp (instead it's transaction timestamp, that is more complex structure).

TransactionId()

TSelf & NYT::TRichYPath::TransactionId

(

TTransactionId

)

Specify transaction that should be used to access this path.

Allows to start cross-transactional operations.

---

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

• yt/cpp/mapreduce/interface/common.h