Struct SqlParserOptions 

pub struct SqlParserOptions {
    pub parse_float_as_decimal: bool,
    pub enable_ident_normalization: bool,
    pub enable_options_value_normalization: bool,
    pub dialect: Dialect,
    pub support_varchar_with_length: bool,
    pub map_string_types_to_utf8view: bool,
    pub collect_spans: bool,
    pub recursion_limit: usize,
    pub default_null_ordering: String,
    pub enable_subquery_sort_elimination: bool,
}

Options related to SQL parser

See also: SessionConfig

Fields

parse_float_as_decimal: bool

When set to true, SQL parser will parse float as decimal type

enable_ident_normalization: bool

When set to true, SQL parser will normalize ident (convert ident to lowercase when not quoted)

enable_options_value_normalization: bool

When set to true, SQL parser will normalize options value (convert value to lowercase). Note that this option is ignored and will be removed in the future. All case-insensitive values are normalized automatically.

dialect: Dialect

Configure the SQL dialect used by DataFusion’s parser; supported values include: Generic, MySQL, PostgreSQL, Hive, SQLite, Snowflake, Redshift, MsSQL, ClickHouse, BigQuery, Ansi, DuckDB and Databricks.

support_varchar_with_length: bool

If true, permit lengths for VARCHAR such as VARCHAR(20), but ignore the length. If false, error if a VARCHAR with a length is specified. The Arrow type system does not have a notion of maximum string length and thus DataFusion can not enforce such limits.

map_string_types_to_utf8view: bool

If true, string types (VARCHAR, CHAR, Text, and String) are mapped to Utf8View during SQL planning. If false, they are mapped to Utf8. Default is true.

collect_spans: bool

When set to true, the source locations relative to the original SQL query (i.e. Span) will be collected and recorded in the logical plan nodes.

recursion_limit: usize

Specifies the recursion depth limit when parsing complex SQL Queries

default_null_ordering: String

Specifies the default null ordering for query results. There are 4 options:

• nulls_max: Nulls appear last in ascending order.
• nulls_min: Nulls appear first in ascending order.
• nulls_first: Nulls always be first in any order.
• nulls_last: Nulls always be last in any order.

By default, nulls_max is used to follow Postgres’s behavior. postgres rule: https://www.postgresql.org/docs/current/queries-order.html

enable_subquery_sort_elimination: bool

When set to true, DataFusion may remove ORDER BY clauses from subqueries or CTEs during SQL planning when their ordering cannot affect the result, such as when no LIMIT or other order-sensitive operator depends on them.

Disable this option to preserve explicit subquery ordering in the planned query.

Trait Implementations

impl Clone for SqlParserOptions

fn clone(&self) -> SqlParserOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConfigField for SqlParserOptions

fn set(&mut self, key: &str, value: &str) -> Result<(), DataFusionError>

fn visit<V>(&self, v: &mut V, key_prefix: &str, _description: &'static str)

where V: Visit,

fn reset(&mut self, key: &str) -> Result<(), DataFusionError>

impl Debug for SqlParserOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for SqlParserOptions

fn default() -> SqlParserOptions

Returns the “default value” for a type.

impl From<&SqlParserOptions> for ParserOptions

fn from(options: &SqlParserOptions) -> ParserOptions

Converts to this type from the input type.

impl PartialEq for SqlParserOptions

fn eq(&self, other: &SqlParserOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SqlParserOptions