Struct datafusion::execution::options::NdJsonReadOptions

pub struct NdJsonReadOptions<'a> {
    pub schema: Option<SchemaRef>,
    pub schema_infer_max_records: usize,
    pub file_extension: &'a str,
    pub table_partition_cols: Vec<(String, DataType)>,
    pub file_compression_type: FileCompressionType,
}

Options that control the reading of Line-delimited JSON files (NDJson)

Note this structure is supplied when a datasource is created and can not not vary from statement to statement. For settings that can vary statement to statement see ConfigOptions.

Fields

schema: Option<SchemaRef>

The data source schema.

schema_infer_max_records: usize

Max number of rows to read from JSON files for schema inference if needed. Defaults to DEFAULT_SCHEMA_INFER_MAX_RECORD.

file_extension: &'a str

File extension; only files with this extension are selected for data input. Defaults to FileType::JSON.get_ext().as_str().

table_partition_cols: Vec<(String, DataType)>

Partition Columns

file_compression_type: FileCompressionType

File compression type

Implementations

impl<'a> NdJsonReadOptions<'a>

pub fn table_partition_cols(
    self,
    table_partition_cols: Vec<(String, DataType)>
) -> Self

Specify table_partition_cols for partition pruning

pub fn file_extension(self, file_extension: &'a str) -> Self

Specify file_extension

pub fn file_compression_type(
    self,
    file_compression_type: FileCompressionType
) -> Self

Specify file_compression_type

pub fn to_listing_options(&self, target_partitions: usize) -> ListingOptions

Helper to convert these user facing options to ListingTable options

Trait Implementations

impl<'a> Clone for NdJsonReadOptions<'a>

fn clone(&self) -> NdJsonReadOptions<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Default for NdJsonReadOptions<'a>

fn default() -> Self

Returns the “default value” for a type.