Interface of client capable of managing operations. More...

#include <operation.h>

Inheritance diagram for NYT::IOperationClient:

Public Member Functions
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 of client capable of managing operations.

Member Function Documentation

◆ AbortOperation()

virtual void NYT::IOperationClient::AbortOperation ( const TOperationId & operationId )

pure virtual

Abort operation.

See also: https://ytsaurus.tech/docs/en/api/commands#abort_operation

◆ AttachOperation()

virtual IOperationPtr NYT::IOperationClient::AttachOperation ( const TOperationId & operationId )

pure virtual

Create an operation object given operation id.

Exceptions

ref NYT::TErrorResponse if the operation doesn't exist.

◆ CheckOperation()

virtual EOperationBriefState NYT::IOperationClient::CheckOperation ( const TOperationId & operationId )

pure virtual

Check and return operation status.

Note: this function will never return NYT::EOperationBriefState::Failed or NYT::EOperationBriefState::Aborted status, it will throw NYT::TOperationFailedError instead.

◆ CompleteOperation()

virtual void NYT::IOperationClient::CompleteOperation ( const TOperationId & operationId )

pure virtual

Complete operation.

See also: https://ytsaurus.tech/docs/en/api/commands#complete_operation

◆ Erase()

virtual IOperationPtr NYT::IOperationClient::Erase	(	const TEraseOperationSpec &	spec,
		const TOperationOptions &	options = TOperationOptions() )

pure virtual

Run Erase operation.

Parameters

spec	Operation spec.
options	Optional parameters.

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

◆ Map() [1/2]

IOperationPtr NYT::IOperationClient::Map	(	::TIntrusivePtr< IMapperBase >	mapper,
		const TOneOrMany< TStructuredTablePath > &	input,
		const TOneOrMany< TStructuredTablePath > &	output,
		const TMapOperationSpec &	spec = TMapOperationSpec(),
		const TOperationOptions &	options = TOperationOptions() )

Run Map operation.

Parameters

mapper	Instance of a job to run.
input	Input table(s)
output	Output table(s)
spec	Operation spec.
options	Optional parameters.

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

◆ Map() [2/2]

IOperationPtr NYT::IOperationClient::Map	(	const TMapOperationSpec &	spec,
		::TIntrusivePtr< IMapperBase >	mapper,
		const TOperationOptions &	options = TOperationOptions() )

Run Map operation.

Parameters

spec	Operation spec.
mapper	Instance of a job to run.
options	Optional parameters.

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

◆ MapReduce() [1/4]

IOperationPtr NYT::IOperationClient::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.

Parameters

mapper	Instance of mapper to run (identity mapper if nullptr).
reduceCombiner	Instance of reduceCombiner to run (identity reduce combiner if nullptr).
reducer	Instance of reducer to run.
input	Input table(s)
output	Output table(s)
reduceBy	Columns to group rows by.
spec	Operation spec.
options	Optional parameters.

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

◆ MapReduce() [2/4]

IOperationPtr NYT::IOperationClient::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.

Parameters

mapper	Instance of mapper to run (identity mapper if nullptr).
reducer	Instance of reducer to run.
input	Input table(s)
output	Output table(s)
reduceBy	Columns to group rows by.
spec	Operation spec.
options	Optional parameters.

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

◆ MapReduce() [3/4]

IOperationPtr NYT::IOperationClient::MapReduce	(	const TMapReduceOperationSpec &	spec,
		::TIntrusivePtr< IMapperBase >	mapper,
		::TIntrusivePtr< IReducerBase >	reduceCombiner,
		::TIntrusivePtr< IReducerBase >	reducer,
		const TOperationOptions &	options = TOperationOptions() )

Run MapReduce operation.

Parameters

spec	Operation spec.
mapper	Instance of a map job to run (identity mapper if nullptr).
reducerCombiner	Instance of a reduce combiner to run (identity reduce combiner if nullptr).
reducer	Instance of a reduce job to run.
options	Optional parameters.

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

◆ MapReduce() [4/4]

IOperationPtr NYT::IOperationClient::MapReduce	(	const TMapReduceOperationSpec &	spec,
		::TIntrusivePtr< IMapperBase >	mapper,
		::TIntrusivePtr< IReducerBase >	reducer,
		const TOperationOptions &	options = TOperationOptions() )

Run JoinReduce operation.

Parameters

spec	Operation spec.
reducer	Instance of a job to run.
options	Optional parameters.

Deprecated: Use NYT::IOperationClient::Reduce with NYT::TReduceOperationSpec::EnableKeyGuarantee set to `false. */ IOperationPtr JoinReduce( const TJoinReduceOperationSpec& spec, ::TIntrusivePtr<IReducerBase> reducer, const TOperationOptions& options = TOperationOptions());

/**

Run raw JoinReduce operation.

Parameters

spec	Operation spec.
rawJob	Instance of a raw reducer to run.
options	Optional parameters.

Deprecated: Use NYT::IOperationClient::RawReduce with NYT::TReduceOperationSpec::EnableKeyGuarantee set to `false. */ virtual IOperationPtr RawJoinReduce( const TRawJoinReduceOperationSpec& spec, ::TIntrusivePtr<IRawJob> rawJob, const TOperationOptions& options = TOperationOptions()) = 0;

/**

Run MapReduce operation.

Parameters

spec	Operation spec.
mapper	Instance of a map job to run (identity mapper if nullptr).
reducer	Instance of a reduce job to run.
options	Optional parameters.

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

◆ Merge()

virtual IOperationPtr NYT::IOperationClient::Merge	(	const TMergeOperationSpec &	spec,
		const TOperationOptions &	options = TOperationOptions() )

pure virtual

Run Merge operation.

Parameters

spec	Operation spec.
options	Optional parameters.

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

◆ RawMap()

virtual IOperationPtr NYT::IOperationClient::RawMap	(	const TRawMapOperationSpec &	spec,
		::TIntrusivePtr< IRawJob >	rawJob,
		const TOperationOptions &	options = TOperationOptions() )

pure virtual

Run raw Map operation.

Parameters

spec	Operation spec.
rawJob	Instance of a raw mapper to run.
options	Optional parameters.

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

◆ RawMapReduce()

virtual IOperationPtr NYT::IOperationClient::RawMapReduce	(	const TRawMapReduceOperationSpec &	spec,
		::TIntrusivePtr< IRawJob >	mapper,
		::TIntrusivePtr< IRawJob >	reduceCombiner,
		::TIntrusivePtr< IRawJob >	reducer,
		const TOperationOptions &	options = TOperationOptions() )

pure virtual

Run raw MapReduce operation.

Parameters

spec	Operation spec.
mapper	Instance of a raw mapper to run (identity mapper if nullptr).
mapper	Instance of a raw reduce combiner to run (identity reduce combiner if nullptr).
mapper	Instance of a raw reducer to run.
options	Optional parameters.

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

◆ RawReduce()

virtual IOperationPtr NYT::IOperationClient::RawReduce	(	const TRawReduceOperationSpec &	spec,
		::TIntrusivePtr< IRawJob >	rawJob,
		const TOperationOptions &	options = TOperationOptions() )

pure virtual

Run raw Reduce operation.

Parameters

spec	Operation spec.
rawJob	Instance of a raw reducer to run.
options	Optional parameters.

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

◆ Reduce() [1/2]

IOperationPtr NYT::IOperationClient::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.

Parameters

reducer	Instance of a job to run.
input	Input table(s)
output	Output table(s)
reduceBy	Columns to group rows by.
spec	Operation spec.
options	Optional parameters.

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

◆ Reduce() [2/2]

IOperationPtr NYT::IOperationClient::Reduce	(	const TReduceOperationSpec &	spec,
		::TIntrusivePtr< IReducerBase >	reducer,
		const TOperationOptions &	options = TOperationOptions() )

Run Reduce operation.

Parameters

spec	Operation spec.
reducer	Instance of a job to run.
options	Optional parameters.

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

◆ RemoteCopy()

virtual IOperationPtr NYT::IOperationClient::RemoteCopy	(	const TRemoteCopyOperationSpec &	spec,
		const TOperationOptions &	options = TOperationOptions() )

pure virtual

Run RemoteCopy operation.

Parameters

spec	Operation spec.
options	Optional parameters.

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

◆ RunVanilla()

virtual IOperationPtr NYT::IOperationClient::RunVanilla	(	const TVanillaOperationSpec &	spec,
		const TOperationOptions &	options = TOperationOptions() )

pure virtual

Run Vanilla operation.

Parameters

spec	Operation spec.
options	Optional parameters.

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

◆ Sort() [1/2]

IOperationPtr NYT::IOperationClient::Sort	(	const TOneOrMany< TRichYPath > &	input,
		const TRichYPath &	output,
		const TSortColumns &	sortBy,
		const TSortOperationSpec &	spec = TSortOperationSpec(),
		const TOperationOptions &	options = TOperationOptions() )

Run Sort operation.

Parameters

input	Input table(s).
output	Output table.
sortBy	Columns to sort input rows by.
spec	Operation spec.
options	Optional parameters.

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

◆ Sort() [2/2]

virtual IOperationPtr NYT::IOperationClient::Sort	(	const TSortOperationSpec &	spec,
		const TOperationOptions &	options = TOperationOptions() )

pure virtual

Run Sort operation.

Parameters

spec	Operation spec.
options	Optional parameters.

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

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

yt/cpp/mapreduce/interface/operation.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ AbortOperation()

◆ AttachOperation()

◆ CheckOperation()

◆ CompleteOperation()

◆ Erase()

◆ Map() [1/2]

◆ Map() [2/2]

◆ MapReduce() [1/4]

◆ MapReduce() [2/4]

◆ MapReduce() [3/4]

◆ MapReduce() [4/4]

◆ Merge()

◆ RawMap()

◆ RawMapReduce()

◆ RawReduce()

◆ Reduce() [1/2]

◆ Reduce() [2/2]

◆ RemoteCopy()

◆ RunVanilla()

◆ Sort() [1/2]

◆ Sort() [2/2]