NYT::IIOClient Class Reference

Interface for creating table and file readers and writer. More...

#include <io.h>

Inheritance diagram for NYT::IIOClient:

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

Detailed Description

Interface for creating table and file readers and writer.

Member Function Documentation

CreateBlobTableReader()

virtual IFileReaderPtr NYT::IIOClient::CreateBlobTableReader ( const TYPath & path, const TKey & blobId, const TBlobTableReaderOptions & options = TBlobTableReaderOptions() )

pure virtual

Create a reader for blob table at path.

Parameters

path	Blob table path.
blobId	Key identifying the blob.
options	Optional parameters

Blob table is a table that stores a number of blobs. Blobs are sliced into parts of the same size (maybe except of last part). Those parts are stored in the separate rows.

Blob table have constraints on its schema.

• There must be columns that identify blob (blob id columns). That columns might be of any type.
• There must be a column of int64 type that identify part inside the blob (this column is called part index).
• There must be a column of string type that stores actual data (this column is called data column).

CreateFileFragmentWriter()

virtual IFileFragmentWriterPtr NYT::IIOClient::CreateFileFragmentWriter ( const TDistributedWriteFileCookie & cookie, const TFileFragmentWriterOptions & options = TFileFragmentWriterOptions() )

pure virtual

Create a fragment writer for given distributed file session cookie.

See also

YT doc

CreateFilePartitionReader()

virtual IFileReaderPtr NYT::IIOClient::CreateFilePartitionReader ( const TString & cookie, const TFilePartitionReaderOptions & options = {} )

pure virtual

Create a reader of file partition.

Parameters

cookie	Partition cookie received from NYT::IClientBase::GetFilePartitions.
options	Additional options.

CreateRawTablePartitionReader()

virtual TRawTableReaderPtr NYT::IIOClient::CreateRawTablePartitionReader ( const TString & cookie, const TFormat & format, const TTablePartitionReaderOptions & options = {} )

pure virtual

Create raw reader of table partition.

Reader returns unparsed data in specified format.

Parameters

cookie	Partition cookie received from NYT::IClientBase::GetTablesPartitions.
format	Format description.
options	Additional options.

CreateTableFragmentWriter()

template<class T>

ITableFragmentWriterPtr< T > NYT::IIOClient::CreateTableFragmentWriter	(	const TDistributedWriteTableCookie &	cookie,
		const TTableFragmentWriterOptions &	options = {} )

Create a fragment table writer for given distributed table session cookie.

See also

YT doc

CreateTablePartitionReader()

template<class T>

TTableReaderPtr< T > NYT::IIOClient::CreateTablePartitionReader	(	const TString &	cookie,
		const TTablePartitionReaderOptions &	options = {} )

Create reader of table partition.

Parameters

cookie	Partition cookie received from NYT::IClientBase::GetTablesPartitions.
format	Format description.
options	Additional options.

---

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

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