cudf::io::json_writer_options_builder Class Reference

Builder to build options for writer_json() More...

#include <cudf/io/json.hpp>

Public Member Functions
	json_writer_options_builder ()=default
	Default constructor. More...
	json_writer_options_builder (sink_info const &sink, table_view const &table)
	Constructor from sink and table. More...
json_writer_options_builder &	table (table_view tbl)
	Sets table to be written to output. More...
json_writer_options_builder &	compression (compression_type comptype)
	Sets compression type of output sink. More...
json_writer_options_builder &	metadata (table_metadata metadata)
	Sets optional metadata (with column names). More...
json_writer_options_builder &	na_rep (std::string val)
	Sets string to used for null entries. More...
json_writer_options_builder &	include_nulls (bool val)
	Enables/Disables output of nulls as 'null'. More...
json_writer_options_builder &	utf8_escaped (bool val)
	Enables/Disable UTF-8 escaped output for string fields. More...
json_writer_options_builder &	lines (bool val)
	Enables/Disables JSON lines for records format. More...
json_writer_options_builder &	rows_per_chunk (int val)
	Sets maximum number of rows to process for each file write. More...
json_writer_options_builder &	true_value (std::string val)
	Sets string used for values != 0 in INT8 types. More...
json_writer_options_builder &	false_value (std::string val)
	Sets string used for values == 0 in INT8 types. More...
	operator json_writer_options && ()
	move json_writer_options member once it's built.
json_writer_options &&	build ()
	move json_writer_options member once it's built. More...

Detailed Description

Builder to build options for writer_json()

Definition at line 1275 of file json.hpp.

Constructor & Destructor Documentation

json_writer_options_builder() [1/2]

cudf::io::json_writer_options_builder::json_writer_options_builder ( )

explicitdefault

Default constructor.

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

json_writer_options_builder() [2/2]

cudf::io::json_writer_options_builder::json_writer_options_builder ( sink_info const &  sink, table_view const &  table  )

inlineexplicit

Constructor from sink and table.

Parameters

sink	The sink used for writer output
table	Table to be written to output

Definition at line 1292 of file json.hpp.

Member Function Documentation

build()

json_writer_options&& cudf::io::json_writer_options_builder::build ( )

inline

move json_writer_options member once it's built.

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

Returns

Built json_writer_options object's r-value reference

Definition at line 1431 of file json.hpp.

compression()

json_writer_options_builder& cudf::io::json_writer_options_builder::compression ( compression_type  comptype )

inline

Sets compression type of output sink.

Parameters

comptype

Compression type used

Returns

this for chaining

Definition at line 1315 of file json.hpp.

false_value()

json_writer_options_builder& cudf::io::json_writer_options_builder::false_value ( std::string  val )

inline

Sets string used for values == 0 in INT8 types.

Parameters

val	String to represent values == 0 in INT8 types

Returns

this for chaining

Definition at line 1413 of file json.hpp.

include_nulls()

json_writer_options_builder& cudf::io::json_writer_options_builder::include_nulls ( bool  val )

inline

Enables/Disables output of nulls as 'null'.

Parameters

val	Boolean value to enable/disable

Returns

this for chaining

Definition at line 1351 of file json.hpp.

lines()

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

inline

Enables/Disables JSON lines for records format.

Parameters

val	Boolean value to enable/disable

Returns

this for chaining

Definition at line 1377 of file json.hpp.

metadata()

json_writer_options_builder& cudf::io::json_writer_options_builder::metadata ( table_metadata  metadata )

inline

Sets optional metadata (with column names).

Parameters

metadata

metadata (with column names)

Returns

this for chaining

Definition at line 1327 of file json.hpp.

na_rep()

json_writer_options_builder& cudf::io::json_writer_options_builder::na_rep ( std::string  val )

inline

Sets string to used for null entries.

Parameters

val	String to represent null value

Returns

this for chaining

Definition at line 1339 of file json.hpp.

rows_per_chunk()

json_writer_options_builder& cudf::io::json_writer_options_builder::rows_per_chunk ( int  val )

inline

Sets maximum number of rows to process for each file write.

Parameters

val	Number of rows per chunk

Returns

this for chaining

Definition at line 1389 of file json.hpp.

table()

json_writer_options_builder& cudf::io::json_writer_options_builder::table ( table_view  tbl )

inline

Sets table to be written to output.

Parameters

tbl	Table for the output

Returns

this for chaining

Definition at line 1303 of file json.hpp.

true_value()

json_writer_options_builder& cudf::io::json_writer_options_builder::true_value ( std::string  val )

inline

Sets string used for values != 0 in INT8 types.

Parameters

val	String to represent values != 0 in INT8 types

Returns

this for chaining

Definition at line 1401 of file json.hpp.

utf8_escaped()

json_writer_options_builder& cudf::io::json_writer_options_builder::utf8_escaped ( bool  val )

inline

Enables/Disable UTF-8 escaped output for string fields.

Default is false, which escapes all non-ASCII characters.

Parameters

val	Boolean value to enable/disable escaped UTF-8 output

Returns

this for chaining

Definition at line 1365 of file json.hpp.

---

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

• cudf/io/json.hpp