Public Member Functions | Public Attributes | List of all members
cudf::io::orc_chunked_writer Class Reference

Chunked orc writer class writes an ORC file in a chunked/stream form. More...

#include <orc.hpp>

Public Member Functions

 orc_chunked_writer ()
 Default constructor, this should never be used. This is added just to satisfy cython.
 
 ~orc_chunked_writer ()
 virtual destructor, Added so we don't leak detail types.
 
 orc_chunked_writer (chunked_orc_writer_options const &options, rmm::cuda_stream_view stream=cudf::get_default_stream())
 Constructor with chunked writer options. More...
 
orc_chunked_writerwrite (table_view const &table)
 Writes table to output. More...
 
void close ()
 Finishes the chunked/streamed write process.
 

Public Attributes

std::unique_ptr< orc::detail::writer > writer
 Unique pointer to impl writer class.
 

Detailed Description

Chunked orc writer class writes an ORC file in a chunked/stream form.

The intent of the write_orc_chunked_ path is to allow writing of an arbitrarily large / arbitrary number of rows to an ORC file in multiple passes.

The following code snippet demonstrates how to write a single ORC file containing one logical table by writing a series of individual cudf::tables.

...
std::string filepath = "dataset.orc";
options::builder(cudf::sink_info(filepath));
...
writer.write(table0)
writer.write(table1)
...
writer.close();
Settings to use for write_orc_chunked().
Definition: orc.hpp:1074
orc_chunked_writer()
Default constructor, this should never be used. This is added just to satisfy cython.
std::unique_ptr< orc::detail::writer > writer
Unique pointer to impl writer class.
Definition: orc.hpp:1517

Definition at line 1478 of file orc.hpp.

Constructor & Destructor Documentation

◆ orc_chunked_writer()

cudf::io::orc_chunked_writer::orc_chunked_writer ( chunked_orc_writer_options const &  options,
rmm::cuda_stream_view  stream = cudf::get_default_stream() 
)

Constructor with chunked writer options.

Parameters
[in]optionsoptions used to write table
[in]streamCUDA stream used for device memory operations and kernel launches

Member Function Documentation

◆ write()

orc_chunked_writer& cudf::io::orc_chunked_writer::write ( table_view const &  table)

Writes table to output.

Note
If an exception is thrown during encoding or compression, the data from the failing call is not written to the sink. Data from previous successful calls is unaffected.
Parameters
[in]tableTable that needs to be written
Returns
returns reference of the class object

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