公共成员函数 | 静态公共成员函数 | 所有成员列表
cudf::io::json_writer_options 类参考

用于 write_json() 的设置。 更多...

#include <json.hpp>

公共成员函数

 json_writer_options ()=default
 默认构造函数。 更多...
 
sink_info const & get_sink () const
 返回用于写入器输出的 sink。 更多...
 
table_view const & get_table () const
 返回将写入输出的表。 更多...
 
std::optional< table_metadata > const & get_metadata () const
 返回元数据信息。 更多...
 
std::string const & get_na_rep () const
 返回用于空条目的字符串。 更多...
 
compression_type get_compression () const
 返回用于 sink 的压缩类型。 更多...
 
bool is_enabled_include_nulls () const
 是否将 null 输出为 'null'。 更多...
 
bool is_enabled_lines () const
 是否将记录格式使用 JSON Lines。 更多...
 
size_type get_rows_per_chunk () const
 返回每次文件写入要处理的最大行数。 更多...
 
std::string const & get_true_value () const
 返回用于 INT8 类型中值 != 0 的字符串。 更多...
 
std::string const & get_false_value () const
 返回用于 INT8 类型中值 == 0 的字符串。 更多...
 
void set_table (table_view tbl)
 设置要写入输出的表。 更多...
 
void set_compression (compression_type comptype)
 设置要使用的压缩类型。 更多...
 
void set_metadata (table_metadata metadata)
 设置元数据。 更多...
 
void set_na_rep (std::string val)
 设置用于空条目的字符串。 更多...
 
void enable_include_nulls (bool val)
 启用/禁用将 null 输出为 'null'。 更多...
 
void enable_lines (bool val)
 启用/禁用记录格式的 JSON Lines。 更多...
 
void size_type 
 set_rows_per_chunk (size_type val)
 
void 设置每次文件写入要处理的最大行数。 更多...
 set_true_value (std::string val)
 
void 设置用于 INT8 类型中值 != 0 的字符串。 更多...
 set_false_value (std::string val)
 

设置用于 INT8 类型中值 == 0 的字符串。 更多...

静态公共成员函数static json_writer_options_builder 
 builder (sink_info const &sink, table_view const &table)
 

创建用于构建 json_writer_options 的 builder。 更多...

详细描述

用于 write_json() 的设置。

定义于文件 io/json.hpp946 行。

构造函数与析构函数文档

◆ json_writer_options() ( )
cudf::io::json_writer_options::json_writer_options

explicitdefault

默认构造函数。

添加此构造函数是因为 Cython 需要默认构造函数才能在栈上创建对象。

成员函数文档

◆ builder() ( sink_info const &  static json_writer_options_builder cudf::io::json_writer_options::builder,
table_view const &  sink
)
table 

static

创建用于构建 json_writer_options 的 builder。
static json_writer_options_builder cudf::io::json_writer_options::builder参数
用于写入器输出的 sinktable
要写入输出的表
返回值

用于构建 json_writer_options 的 builder

◆ enable_include_nulls() ( bool  void cudf::io::json_writer_options::enable_include_nulls)
val

inline

创建用于构建 json_writer_options 的 builder。
void cudf::io::json_writer_options::enable_include_nulls启用/禁用将 null 输出为 'null'。

用于启用/禁用的布尔值

定义于文件 io/json.hpp1104 行。

◆ enable_lines() ( bool  void cudf::io::json_writer_options::enable_include_nulls)
val

void cudf::io::json_writer_options::enable_lines

创建用于构建 json_writer_options 的 builder。
void cudf::io::json_writer_options::enable_include_nulls启用/禁用记录格式的 JSON Lines。

用于启用/禁用 JSON Lines 的布尔值

定义于文件 io/json.hpp1111 行。

◆ get_compression() ( ) compression_type cudf::io::json_writer_options::get_compression
val

const

要写入输出的表
返回用于 sink 的压缩类型。

sink 的压缩类型

定义于文件 io/json.hpp1032 行。

◆ get_false_value() ( ) compression_type cudf::io::json_writer_options::get_compression
val

std::string const& cudf::io::json_writer_options::get_false_value

要写入输出的表
返回用于 INT8 类型中值 == 0 的字符串。

用于 INT8 类型中值 == 0 的字符串

定义于文件 io/json.hpp1067 行。

◆ get_metadata() ( ) compression_type cudf::io::json_writer_options::get_compression
val

std::optional<table_metadata> const& cudf::io::json_writer_options::get_metadata

要写入输出的表
返回元数据信息。

元数据信息

定义于文件 io/json.hpp1018 行。

◆ get_na_rep() ( ) compression_type cudf::io::json_writer_options::get_compression
val

std::string const& cudf::io::json_writer_options::get_na_rep

要写入输出的表
返回用于空条目的字符串。

用于空条目的字符串

定义于文件 io/json.hpp1025 行。

◆ get_rows_per_chunk() ( ) compression_type cudf::io::json_writer_options::get_compression
val

size_type cudf::io::json_writer_options::get_rows_per_chunk

要写入输出的表
返回每次文件写入要处理的最大行数。

每次文件写入要处理的最大行数

定义于文件 io/json.hpp1053 行。

◆ get_sink() ( ) compression_type cudf::io::json_writer_options::get_compression
val

sink_info const& cudf::io::json_writer_options::get_sink

要写入输出的表
返回用于写入器输出的 sink。

用于写入器输出的 sink

定义于文件 io/json.hpp1004 行。

◆ get_table() ( ) compression_type cudf::io::json_writer_options::get_compression
val

table_view const& cudf::io::json_writer_options::get_table

要写入输出的表
返回将写入输出的表。

将写入输出的表

定义于文件 io/json.hpp1011 行。

◆ get_true_value() ( ) compression_type cudf::io::json_writer_options::get_compression
val

std::string const& cudf::io::json_writer_options::get_true_value

要写入输出的表
返回用于 INT8 类型中值 != 0 的字符串。

用于 INT8 类型中值 != 0 的字符串

定义于文件 io/json.hpp1060 行。

◆ is_enabled_include_nulls() ( ) compression_type cudf::io::json_writer_options::get_compression
val

bool cudf::io::json_writer_options::is_enabled_include_nulls

要写入输出的表
是否将 null 输出为 'null'。

如果将 null 输出为 'null' 则为 true

定义于文件 io/json.hpp1039 行。

◆ is_enabled_lines() ( ) compression_type cudf::io::json_writer_options::get_compression
val

bool cudf::io::json_writer_options::is_enabled_lines

要写入输出的表
是否将记录格式使用 JSON Lines。

如果将记录格式使用 JSON Lines 则为 true

定义于文件 io/json.hpp1046 行。

◆ set_compression() ( compression_type  void cudf::io::json_writer_options::set_compression)
val

comptype

创建用于构建 json_writer_options 的 builder。
void cudf::io::json_writer_options::set_compression设置要使用的压缩类型。

sink 的压缩类型

定义于文件 io/json.hpp1083 行。

◆ set_false_value() ( void cudf::io::json_writer_options::set_false_value void cudf::io::json_writer_options::enable_include_nulls)
val

std::string 

创建用于构建 json_writer_options 的 builder。
void cudf::io::json_writer_options::enable_include_nulls设置用于 INT8 类型中值 == 0 的字符串。

表示 INT8 类型中值 == 0 的字符串

定义于文件 io/json.hpp1132 行。

◆ set_metadata() ( void cudf::io::json_writer_options::set_metadata table_metadata )
val

metadata

创建用于构建 json_writer_options 的 builder。
table_metadata 设置元数据。

关联的元数据

定义于文件 io/json.hpp1090 行。

◆ set_na_rep() ( void cudf::io::json_writer_options::set_false_value void cudf::io::json_writer_options::enable_include_nulls)
val

void cudf::io::json_writer_options::set_na_rep

创建用于构建 json_writer_options 的 builder。
void cudf::io::json_writer_options::enable_include_nulls设置用于空条目的字符串。

表示 null 值的字符串

定义于文件 io/json.hpp1097 行。

◆ set_rows_per_chunk() ( size_type  void cudf::io::json_writer_options::enable_include_nulls)
val

void cudf::io::json_writer_options::set_rows_per_chunk

创建用于构建 json_writer_options 的 builder。
void cudf::io::json_writer_options::enable_include_nulls设置每次文件写入要处理的最大行数。

每个 chunk 的行数

定义于文件 io/json.hpp1118 行。

◆ set_table() ( void cudf::io::json_writer_options::set_table table_view )
val

tbl

创建用于构建 json_writer_options 的 builder。
table_view 设置要写入输出的表。

用于输出的表

定义于文件 io/json.hpp1076 行。

◆ set_true_value() ( void cudf::io::json_writer_options::set_false_value void cudf::io::json_writer_options::enable_include_nulls)
val

void cudf::io::json_writer_options::set_true_value

创建用于构建 json_writer_options 的 builder。
void cudf::io::json_writer_options::enable_include_nulls设置用于 INT8 类型中值 != 0 的字符串。

表示 INT8 类型中值 != 0 的字符串


定义于文件 io/json.hpp1125 行。