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

构建用于 read_json() 的设置。更多...

#include <json.hpp>

公共成员函数

 json_reader_options_builder ()=default
 默认构造函数。更多...
 
 json_reader_options_builder (source_info src)
 从源信息构造。更多...
 
json_reader_options_builderdtypes (std::vector< data_type > types)
 设置要读取的列的数据类型。更多...
 
json_reader_options_builderdtypes (std::map< std::string, data_type > types)
 设置要读取的列的数据类型。更多...
 
json_reader_options_builderdtypes (std::map< std::string, schema_element > types)
 设置要读取的列的数据类型。更多...
 
json_reader_options_builderdtypes (schema_element types)
 设置要读取的列的数据类型。更多...
 
json_reader_options_buildercompression (compression_type comp_type)
 设置压缩类型。更多...
 
json_reader_options_builderbyte_range_offset (size_type offset)
 设置从源开始跳过的字节数。更多...
 
json_reader_options_builderbyte_range_size (size_type size)
 设置要读取的字节数。更多...
 
json_reader_options_builderdelimiter (char delimiter)
 设置 JSON 行中分隔记录的分隔符。更多...
 
json_reader_options_builderlines (bool val)
 设置是否按行读取 JSON 对象。更多...
 
json_reader_options_buildermixed_types_as_string (bool val)
 设置是否将混合类型解析为字符串列。也启用使用模式将结构体强制读取为字符串列。更多...
 
json_reader_options_builderprune_columns (bool val)
 设置是否在读取时剪除列,根据 dtypes 选项进行选择。更多...
 
json_reader_options_builderexperimental (bool val)
 设置是否启用实验性特性。更多...
 
json_reader_options_builderdayfirst (bool val)
 设置是否将日期解析为 DD/MM 而不是 MM/DD。更多...
 
json_reader_options_builderkeep_quotes (bool val)
 设置读取器是否应保留字符串值的引号。更多...
 
json_reader_options_buildernormalize_single_quotes (bool val)
 设置读取器是否应规范化字符串周围的单引号。更多...
 
json_reader_options_buildernormalize_whitespace (bool val)
 设置读取器是否应规范化未加引号的空白字符。更多...
 
json_reader_options_builderrecovery_mode (json_recovery_mode_t val)
 指定 JSON 读取器在遇到无效 JSON 行时的行为。更多...
 
json_reader_options_builderstrict_validation (bool val)
 设置 JSON 验证是否应严格。更多...
 
json_reader_options_buildernumeric_leading_zeros (bool val)
 设置数字值中是否允许前导零。必须启用严格验证此设置才有效。更多...
 
json_reader_options_buildernonnumeric_numbers (bool val)
 设置特定未加引号的数值是否为有效的 JSON。这些值包括 NaN, +INF, -INF, +Infinity, Infinity 和 -Infinity。必须启用严格验证此设置才有效。更多...
 
json_reader_options_builderunquoted_control_chars (bool val)
 设置在没有某种形式转义的情况下,是否允许在带引号的字符串中使用 >= 0 且 < 32 的字符。必须启用严格验证此设置才有效。更多...
 
json_reader_options_builderna_values (std::vector< std::string > vals)
 设置其他要识别为 null 值的值。更多...
 
 operator json_reader_options && ()
 一旦构建完成,移动 json_reader_options 成员。
 
json_reader_options && build ()
 一旦构建完成,移动 json_reader_options 成员。更多...
 

详细描述

构建用于 read_json() 的设置。

定义于文件 io/json.hpp 的第 590 行。

构造函数和析构函数文档

◆ json_reader_options_builder() [1/2]

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

默认构造函数。

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

◆ json_reader_options_builder() [2/2]

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

从源信息构造。

参数
src用于读取 avro 文件的源信息

定义于文件 io/json.hpp 的第 606 行。

成员函数文档

◆ build()

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

一旦构建完成,移动 json_reader_options 成员。

添加此函数是因为 Cython 不支持转换运算符的重载。

返回值
构建好的 json_reader_options 对象的右值引用

定义于文件 io/json.hpp 的第 905 行。

◆ byte_range_offset()

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

设置从源开始跳过的字节数。

参数
offset偏移字节数
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 674 行。

◆ byte_range_size()

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

设置要读取的字节数。

参数
size要读取的字节数
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 686 行。

◆ compression()

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

设置压缩类型。

参数
comp_type使用的压缩类型
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 662 行。

◆ dayfirst()

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

设置是否将日期解析为 DD/MM 而不是 MM/DD。

参数
val布尔值,用于启用/禁用“日优先”解析格式
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 766 行。

◆ delimiter()

json_reader_options_builder& cudf::io::json_reader_options_builder::delimiter ( char  delimiter)
inline

设置 JSON 行中分隔记录的分隔符。

参数
delimiterJSON 行中分隔记录的分隔符
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 698 行。

◆ dtypes() [1/4]

json_reader_options_builder& cudf::io::json_reader_options_builder::dtypes ( schema_element  types)
inline

设置要读取的列的数据类型。

参数
types结构体 schema_element,包含列名 -> schema_element(带 map 和顺序)
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 650 行。

◆ dtypes() [2/4]

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

设置要读取的列的数据类型。

参数
types列名 -> dtype map
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 626 行。

◆ dtypes() [3/4]

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

设置要读取的列的数据类型。

参数
types列名 -> schema_element map
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 638 行。

◆ dtypes() [4/4]

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

设置要读取的列的数据类型。

参数
typesdtype 向量
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 614 行。

◆ experimental()

json_reader_options_builder& cudf::io::json_reader_options_builder::experimental ( bool  val)
inline

设置是否启用实验性特性。

设置为 true 时,将启用实验性特性,例如新的列树构建、字段名的 utf-8 匹配。

参数
val布尔值,用于启用/禁用实验性特性
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 754 行。

◆ keep_quotes()

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

设置读取器是否应保留字符串值的引号。

参数
val布尔值,指示读取器是否应保留字符串值的引号
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 779 行。

◆ lines()

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

设置是否按行读取 JSON 对象。

参数
val布尔值,用于启用/禁用将每行读取为 JSON 对象的选项
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 710 行。

◆ mixed_types_as_string()

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

设置是否将混合类型解析为字符串列。也启用使用模式将结构体强制读取为字符串列。

参数
val布尔值,用于启用/禁用将混合类型解析为字符串列
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 723 行。

◆ na_values()

json_reader_options_builder& cudf::io::json_reader_options_builder::na_values ( std::vector< std::string >  vals)
inline

设置其他要识别为 null 值的值。

参数
vals向量,包含要视为 null 的值
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 887 行。

◆ nonnumeric_numbers()

json_reader_options_builder& cudf::io::json_reader_options_builder::nonnumeric_numbers ( bool  val)
inline

设置特定未加引号的数值是否为有效的 JSON。这些值包括 NaN, +INF, -INF, +Infinity, Infinity 和 -Infinity。必须启用严格验证此设置才有效。

异常
cudf::logic_error如果在设置此选项之前未启用 strict_validation
参数
val布尔值,指示未加引号的非数值是否为有效的 JSON。
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 860 行。

◆ normalize_single_quotes()

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

设置读取器是否应规范化字符串周围的单引号。

参数
val布尔值,指示读取器是否应规范化字符串的单引号
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 792 行。

◆ normalize_whitespace()

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

设置读取器是否应规范化未加引号的空白字符。

参数
val布尔值,指示读取器是否应规范化未加引号的空白字符
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 805 行。

◆ numeric_leading_zeros()

json_reader_options_builder& cudf::io::json_reader_options_builder::numeric_leading_zeros ( bool  val)
inline

设置数字值中是否允许前导零。必须启用严格验证此设置才有效。

异常
cudf::logic_error如果在设置此选项之前未启用 strict_validation
参数
val布尔值,指示数字值中是否允许前导零
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 844 行。

◆ prune_columns()

json_reader_options_builder& cudf::io::json_reader_options_builder::prune_columns ( bool  val)
inline

设置是否在读取时剪除列,根据 dtypes 选项进行选择。

当设置为 true 时,如果读取器选项包含 dtypes,则读取器将仅返回 dtypes 中提及的那些列。如果为 false,则无论 dtypes 设置如何,都返回所有列。

参数
val布尔值,用于启用/禁用列剪除
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 739 行。

◆ recovery_mode()

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

指定 JSON 读取器在遇到无效 JSON 行时的行为。

参数
val一个枚举值,用于指示 JSON 读取器在遇到无效 JSON 行时的行为。
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 817 行。

◆ strict_validation()

json_reader_options_builder& cudf::io::json_reader_options_builder::strict_validation ( bool  val)
inline

设置 JSON 验证是否应严格。

参数
val布尔值,指示 JSON 验证是否应严格。
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 829 行。

◆ unquoted_control_chars()

json_reader_options_builder& cudf::io::json_reader_options_builder::unquoted_control_chars ( bool  val)
inline

设置在没有某种形式转义的情况下,是否允许在带引号的字符串中使用 >= 0 且 < 32 的字符。必须启用严格验证此设置才有效。

异常
cudf::logic_error如果在设置此选项之前未启用 strict_validation
参数
val布尔值,指示是否允许未加引号的控制字符。
返回值
用于链式调用的 this

定义于文件 io/json.hpp 的第 875 行。


此类的文档生成自以下文件: