Struct CatalogOptions

pub struct CatalogOptions {
    pub create_default_catalog_and_schema: bool,
    pub default_catalog: String,
    pub default_schema: String,
    pub information_schema: bool,
    pub location: Option<String>,
    pub format: Option<String>,
    pub has_header: bool,
    pub newlines_in_values: bool,
}

Options related to catalog and directory scanning

See also: SessionConfig

Fields

create_default_catalog_and_schema: bool

Whether the default catalog and schema should be created automatically.

default_catalog: String

The default catalog name - this impacts what SQL queries use if not specified

default_schema: String

The default schema name - this impacts what SQL queries use if not specified

information_schema: bool

Should DataFusion provide access to information_schema virtual tables for displaying schema information

location: Option<String>

Location scanned to load tables for default schema

format: Option<String>

Type of TableProvider to use when loading default schema

has_header: bool

Default value for format.has_header for CREATE EXTERNAL TABLE if not specified explicitly in the statement.

newlines_in_values: bool

Specifies whether newlines in (quoted) CSV values are supported.

This is the default value for format.newlines_in_values for CREATE EXTERNAL TABLE if not specified explicitly in the statement.

Parsing newlines in quoted values may be affected by execution behaviour such as parallel file scanning. Setting this to true ensures that newlines in values are parsed successfully, which may reduce performance.

Trait Implementations

impl Clone for CatalogOptions

fn clone(&self) -> CatalogOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConfigField for CatalogOptions

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

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

impl Debug for CatalogOptions

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

Formats the value using the given formatter.

impl Default for CatalogOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CatalogOptions

fn eq(&self, other: &CatalogOptions) -> 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 CatalogOptions