Skip to main content

Module config

Module config 

Source
Expand description

Runtime configuration, via ConfigOptions

Structs§

CatalogOptions
Options related to catalog and directory scanning
ColumnDecryptionProperties
ColumnEncryptionProperties
ConfigEntry
A key value pair, with a corresponding description
ConfigFileDecryptionProperties
ConfigFileEncryptionProperties
ConfigMinTwoUsize
A usize configuration value that rejects 0 and 1 when set from strings.
ConfigNonZeroUsize
A usize configuration value that rejects zero when set from strings.
ConfigOptions
Configuration options struct, able to store both built-in configuration and custom options
CsvOptions
Options controlling CSV format
DialectInfo
Metadata for a SQL dialect supported by DataFusion configuration.
EncryptionFactoryOptions
Holds implementation-specific options for an encryption factory
ExecutionOptions
Options related to query execution
ExplainOptions
Options controlling explain output
Extensions
A type-safe container for ConfigExtension
FormatOptions
Options controlling the format of output when printing record batches Copies arrow::util::display::FormatOptions
JsonOptions
Options controlling JSON format
MaxRowGroupBytes
Target maximum size of a Parquet row group in bytes.
OptimizerOptions
Options related to query optimization
ParquetCdcOptions
Options for content-defined chunking (CDC) when writing parquet files. Mirrors parquet::file::properties::CdcOptions.
ParquetColumnOptions
Options controlling parquet format for individual columns.
ParquetEncryptionOptions
Options for configuring Parquet Modular Encryption
ParquetOptions
Options for reading and writing parquet files
SparkOptions
Options controlling DataFusion’s Spark-compatibility layer (functions under datafusion/spark). Keys here mirror their spark.sql.* equivalents in Apache Spark.
SqlParserOptions
Options related to SQL parser
TableOptions
Represents the configuration options available for handling different table formats within a data processing application. This struct encompasses options for various file formats including CSV, Parquet, and JSON, allowing for flexible configuration of parsing and writing behaviors specific to each format. Additionally, it supports extending functionality through custom extensions.
TableParquetOptions
Options that control how Parquet files are read, including global options that apply to all columns and optional column-specific overrides

Enums§

ConfigFileType
These file types have special built in behavior for configuration. Use TableOptions::Extensions for configuring other file types.
Dialect
This is the SQL dialect used by DataFusion’s parser. This mirrors sqlparser::dialect::Dialect trait in order to offer an easier API and avoid adding the sqlparser dependency
MapKeyDedupPolicy
Policy for handling duplicate keys in Spark-compatible map-construction functions (map_from_arrays, map_from_entries, str_to_map). Mirrors Spark’s spark.sql.mapKeyDedupPolicy.
OutputFormat
SpillCompression

Constants§

DATAFUSION_FFI_CONFIG_NAMESPACE
This namespace is reserved for interacting with Foreign Function Interface (FFI) based configuration extensions.

Traits§

ConfigExtension
ConfigExtension provides a mechanism to store third-party configuration within DataFusion ConfigOptions
ConfigField
A trait implemented by config_namespace and for field types that provides the ability to walk and mutate the configuration tree
ExtensionOptions
An object-safe API for storing arbitrary configuration.
OutputFormatExt
Visit
An implementation trait used to recursively walk configuration

Functions§

default_config_transform
Default transformation to parse a ConfigField for a string.