Public Member Functions | Static Public Member Functions | List of all members
cudf::io::avro_reader_options Class Reference

Settings to use for read_avro(). More...

#include <avro.hpp>

Public Member Functions

 avro_reader_options ()=default
 Default constructor. More...
 
source_info const & get_source () const
 Returns source info. More...
 
std::vector< std::string > get_columns () const
 Returns names of the columns to be read. More...
 
size_type get_skip_rows () const
 Returns number of rows to skip from the start. More...
 
size_type get_num_rows () const
 Returns number of rows to read. More...
 
void set_source (source_info src)
 Sets source info. More...
 
void set_columns (std::vector< std::string > col_names)
 Set names of the column to be read. More...
 
void set_skip_rows (size_type val)
 Sets number of rows to skip. More...
 
void set_num_rows (size_type val)
 Sets number of rows to read. More...
 

Static Public Member Functions

static avro_reader_options_builder builder (source_info src)
 create avro_reader_options_builder which will build avro_reader_options. More...
 

Detailed Description

Settings to use for read_avro().

Definition at line 31 of file avro.hpp.

Constructor & Destructor Documentation

◆ avro_reader_options()

cudf::io::avro_reader_options::avro_reader_options ( )
default

Default constructor.

This has been added since Cython requires a default constructor to create objects on stack.

Member Function Documentation

◆ builder()

static avro_reader_options_builder cudf::io::avro_reader_options::builder ( source_info  src)
static

create avro_reader_options_builder which will build avro_reader_options.

Parameters
srcsource information used to read avro file
Returns
builder to build reader options

◆ get_columns()

std::vector<std::string> cudf::io::avro_reader_options::get_columns ( ) const
inline

Returns names of the columns to be read.

Returns
Names of the columns to be read

Definition at line 71 of file avro.hpp.

◆ get_num_rows()

size_type cudf::io::avro_reader_options::get_num_rows ( ) const
inline

Returns number of rows to read.

Returns
Number of rows to read

Definition at line 85 of file avro.hpp.

◆ get_skip_rows()

size_type cudf::io::avro_reader_options::get_skip_rows ( ) const
inline

Returns number of rows to skip from the start.

Returns
Number of rows to skip from the start

Definition at line 78 of file avro.hpp.

◆ get_source()

source_info const& cudf::io::avro_reader_options::get_source ( ) const
inline

Returns source info.

Returns
Source info

Definition at line 64 of file avro.hpp.

◆ set_columns()

void cudf::io::avro_reader_options::set_columns ( std::vector< std::string >  col_names)
inline

Set names of the column to be read.

Parameters
col_namesVector of column names

Definition at line 99 of file avro.hpp.

◆ set_num_rows()

void cudf::io::avro_reader_options::set_num_rows ( size_type  val)
inline

Sets number of rows to read.

Parameters
valNumber of rows to read after skip

Definition at line 113 of file avro.hpp.

◆ set_skip_rows()

void cudf::io::avro_reader_options::set_skip_rows ( size_type  val)
inline

Sets number of rows to skip.

Parameters
valNumber of rows to skip from start

Definition at line 106 of file avro.hpp.

◆ set_source()

void cudf::io::avro_reader_options::set_source ( source_info  src)
inline

Sets source info.

Parameters
srcThe source info.

Definition at line 92 of file avro.hpp.


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