Builds settings to use for read_json(). More...

#include <json.hpp>

Public Member Functions
	json_reader_options_builder ()=default
	Default constructor. More...

	json_reader_options_builder (source_info src)
	Constructor from source info. More...

json_reader_options_builder &	dtypes (std::vector< data_type > types)
	Set data types for columns to be read. More...

json_reader_options_builder &	dtypes (std::map< std::string, data_type > types)
	Set data types for columns to be read. More...

json_reader_options_builder &	dtypes (std::map< std::string, schema_element > types)
	Set data types for columns to be read. More...

json_reader_options_builder &	compression (compression_type comp_type)
	Set the compression type. More...

json_reader_options_builder &	byte_range_offset (size_type offset)
	Set number of bytes to skip from source start. More...

json_reader_options_builder &	byte_range_size (size_type size)
	Set number of bytes to read. More...

json_reader_options_builder &	lines (bool val)
	Set whether to read the file as a json object per line. More...

json_reader_options_builder &	mixed_types_as_string (bool val)
	Set whether to parse mixed types as a string column. Also enables forcing to read a struct as string column using schema. More...

json_reader_options_builder &	dayfirst (bool val)
	Set whether to parse dates as DD/MM versus MM/DD. More...

json_reader_options_builder &	legacy (bool val)
	Set whether to use the legacy reader. More...

json_reader_options_builder &	keep_quotes (bool val)
	Set whether the reader should keep quotes of string values. More...

json_reader_options_builder &	normalize_single_quotes (bool val)
	Set whether the reader should normalize single quotes around strings. More...

json_reader_options_builder &	normalize_whitespace (bool val)
	Set whether the reader should normalize unquoted whitespace. More...

json_reader_options_builder &	recovery_mode (json_recovery_mode_t val)
	Specifies the JSON reader's behavior on invalid JSON lines. More...

	operator json_reader_options && ()
	move json_reader_options member once it's built.

json_reader_options &&	build ()
	move json_reader_options member once it's built. More...

Detailed Description

Builds settings to use for read_json().

Definition at line 391 of file io/json.hpp.

Constructor & Destructor Documentation

◆ json_reader_options_builder() [1/2]

cudf::io::json_reader_options_builder::json_reader_options_builder ( )

explicitdefault

Default constructor.

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

◆ json_reader_options_builder() [2/2]

cudf::io::json_reader_options_builder::json_reader_options_builder ( source_info src )

inlineexplicit

Constructor from source info.

Parameters

src	The source information used to read avro file

Definition at line 407 of file io/json.hpp.

Member Function Documentation

◆ build()

json_reader_options&& cudf::io::json_reader_options_builder::build ( )

inline

move json_reader_options member once it's built.

This has been added since Cython does not support overloading of conversion operators.

Returns: Built json_reader_options object r-value reference

Definition at line 593 of file io/json.hpp.

◆ byte_range_offset()

json_reader_options_builder& cudf::io::json_reader_options_builder::byte_range_offset ( size_type offset )

inline

Set number of bytes to skip from source start.

Parameters

offset Number of bytes of offset

Returns: this for chaining

Definition at line 463 of file io/json.hpp.

◆ byte_range_size()

json_reader_options_builder& cudf::io::json_reader_options_builder::byte_range_size ( size_type size )

inline

Set number of bytes to read.

Parameters

size	Number of bytes to read

Returns: this for chaining

Definition at line 475 of file io/json.hpp.

◆ compression()

json_reader_options_builder& cudf::io::json_reader_options_builder::compression ( compression_type comp_type )

inline

Set the compression type.

Parameters

comp_type The compression type used

Returns: this for chaining

Definition at line 451 of file io/json.hpp.

◆ dayfirst()

json_reader_options_builder& cudf::io::json_reader_options_builder::dayfirst ( bool val )

inline

Set whether to parse dates as DD/MM versus MM/DD.

Parameters

val	Boolean value to enable/disable day first parsing format

Returns: this for chaining

Definition at line 512 of file io/json.hpp.

◆ dtypes() [1/3]

json_reader_options_builder& cudf::io::json_reader_options_builder::dtypes ( std::map< std::string, data_type > types )

inline

Set data types for columns to be read.

Parameters

types Column name -> dtype map

Returns: this for chaining

Definition at line 427 of file io/json.hpp.

◆ dtypes() [2/3]

json_reader_options_builder& cudf::io::json_reader_options_builder::dtypes ( std::map< std::string, schema_element > types )

inline

Set data types for columns to be read.

Parameters

types Column name -> schema_element map

Returns: this for chaining

Definition at line 439 of file io/json.hpp.

◆ dtypes() [3/3]

json_reader_options_builder& cudf::io::json_reader_options_builder::dtypes ( std::vector< data_type > types )

inline

Set data types for columns to be read.

Parameters

types Vector of dtypes

Returns: this for chaining

Definition at line 415 of file io/json.hpp.

◆ keep_quotes()

json_reader_options_builder& cudf::io::json_reader_options_builder::keep_quotes ( bool val )

inline

Set whether the reader should keep quotes of string values.

Parameters

val	Boolean value to indicate whether the reader should keep quotes of string values

Returns: this for chaining

Definition at line 537 of file io/json.hpp.

◆ legacy()

json_reader_options_builder& cudf::io::json_reader_options_builder::legacy ( bool val )

inline

Set whether to use the legacy reader.

Parameters

val	Boolean value to enable/disable legacy parsing

Returns: this for chaining

Definition at line 524 of file io/json.hpp.

◆ lines()

json_reader_options_builder& cudf::io::json_reader_options_builder::lines ( bool val )

inline

Set whether to read the file as a json object per line.

Parameters

val	Boolean value to enable/disable the option to read each line as a json object

Returns: this for chaining

Definition at line 487 of file io/json.hpp.

◆ mixed_types_as_string()

json_reader_options_builder& cudf::io::json_reader_options_builder::mixed_types_as_string ( bool val )

inline

Set whether to parse mixed types as a string column. Also enables forcing to read a struct as string column using schema.

Parameters

val	Boolean value to enable/disable parsing mixed types as a string column

Returns: this for chaining

Definition at line 500 of file io/json.hpp.

◆ normalize_single_quotes()

json_reader_options_builder& cudf::io::json_reader_options_builder::normalize_single_quotes ( bool val )

inline

Set whether the reader should normalize single quotes around strings.

Parameters

val	Boolean value to indicate whether the reader should normalize single quotes of strings

Returns: this for chaining

Definition at line 550 of file io/json.hpp.

◆ normalize_whitespace()

json_reader_options_builder& cudf::io::json_reader_options_builder::normalize_whitespace ( bool val )

inline

Set whether the reader should normalize unquoted whitespace.

Parameters

val	Boolean value to indicate whether the reader should normalize unquoted whitespace

Returns: this for chaining

Definition at line 563 of file io/json.hpp.

◆ recovery_mode()

json_reader_options_builder& cudf::io::json_reader_options_builder::recovery_mode ( json_recovery_mode_t val )

inline

Specifies the JSON reader's behavior on invalid JSON lines.

Parameters

val	An enum value to indicate the JSON reader's behavior on invalid JSON lines.

Returns: this for chaining

Definition at line 575 of file io/json.hpp.

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

io/json.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ json_reader_options_builder() [1/2]

◆ json_reader_options_builder() [2/2]

Member Function Documentation

◆ build()

◆ byte_range_offset()

◆ byte_range_size()

◆ compression()

◆ dayfirst()

◆ dtypes() [1/3]

◆ dtypes() [2/3]

◆ dtypes() [3/3]

◆ keep_quotes()

◆ legacy()

◆ lines()

◆ mixed_types_as_string()

◆ normalize_single_quotes()

◆ normalize_whitespace()

◆ recovery_mode()