Struct DFParser 

pub struct DFParser<'a> {
    pub parser: Parser<'a>,
    options: SqlParserOptions,
}

DataFusion SQL Parser based on [sqlparser]

Parses DataFusion’s SQL dialect, often delegating to [sqlparser]’s [Parser].

DataFusion mostly follows existing SQL dialects via sqlparser. However, certain statements such as COPY and CREATE EXTERNAL TABLE have special syntax in DataFusion. See Statement for a list of this special syntax

Fields

parser: Parser<'a>

options: SqlParserOptions

Implementations

impl<'a> DFParser<'a>

pub fn new(sql: &'a str) -> Result<Self, DataFusionError>

👎Deprecated since 46.0.0: DFParserBuilder

pub fn new_with_dialect( sql: &'a str, dialect: &'a dyn Dialect, ) -> Result<Self, DataFusionError>

👎Deprecated since 46.0.0: DFParserBuilder

pub fn parse_sql(sql: &'a str) -> Result<VecDeque<Statement>, DataFusionError>

Parse a sql string into one or Statements using the [GenericDialect].

pub fn parse_sql_with_dialect( sql: &str, dialect: &dyn Dialect, ) -> Result<VecDeque<Statement>, DataFusionError>

Parse a SQL string and produce one or more Statements with with the specified dialect.

pub fn parse_sql_into_expr(sql: &str) -> Result<ExprWithAlias, DataFusionError>

pub fn parse_sql_into_expr_with_dialect( sql: &str, dialect: &dyn Dialect, ) -> Result<ExprWithAlias, DataFusionError>

pub fn parse_statements( &mut self, ) -> Result<VecDeque<Statement>, DataFusionError>

Parse a sql string into one or Statements

fn expected<T>( &self, expected: &str, found: TokenWithSpan, ) -> Result<T, DataFusionError>

Report an unexpected token

fn expect_token( &mut self, expected: &str, token: Token, ) -> Result<(), DataFusionError>

pub fn parse_statement(&mut self) -> Result<Statement, DataFusionError>

Parse a new expression

pub fn parse_expr(&mut self) -> Result<ExprWithAlias, DataFusionError>

pub fn parse_into_expr(&mut self) -> Result<ExprWithAlias, DataFusionError>

Parses the entire SQL string into an expression.

In contrast to DFParser::parse_expr, this function will report an error if the input contains any trailing, unparsed tokens.

fn parse_and_handle_statement(&mut self) -> Result<Statement, DataFusionError>

Helper method to parse a statement and handle errors consistently, especially for recursion limits

pub fn parse_copy(&mut self) -> Result<Statement, DataFusionError>

Parse a SQL COPY TO statement

pub fn parse_option_key(&mut self) -> Result<String, DataFusionError>

Parse the next token as a key name for an option list

Note this is different than parse_literal_string because it allows keywords as well as other non words

pub fn parse_option_value(&mut self) -> Result<Value, DataFusionError>

Parse the next token as a value for an option list

Note this is different than parse_value as it allows any word or keyword in this location.

pub fn parse_explain(&mut self) -> Result<Statement, DataFusionError>

Parse a SQL EXPLAIN

pub fn parse_explain_format( &mut self, ) -> Result<Option<String>, DataFusionError>

pub fn parse_create(&mut self) -> Result<Statement, DataFusionError>

Parse a SQL CREATE statement handling CREATE EXTERNAL TABLE

fn parse_partitions(&mut self) -> Result<Vec<String>, DataFusionError>

pub fn parse_order_by_exprs( &mut self, ) -> Result<Vec<OrderByExpr>, DataFusionError>

Parse the ordering clause of a CREATE EXTERNAL TABLE SQL statement

pub fn parse_order_by_expr(&mut self) -> Result<OrderByExpr, DataFusionError>

Parse an ORDER BY sub-expression optionally followed by ASC or DESC.

fn parse_columns( &mut self, ) -> Result<(Vec<ColumnDef>, Vec<TableConstraint>), DataFusionError>

fn parse_column_def(&mut self) -> Result<ColumnDef, DataFusionError>

fn parse_create_external_table( &mut self, unbounded: bool, or_replace: bool, ) -> Result<Statement, DataFusionError>

fn parse_file_format(&mut self) -> Result<String, DataFusionError>

Parses the set of valid formats

fn parse_value_options( &mut self, ) -> Result<Vec<(String, Value)>, DataFusionError>

Parses (key value) style options into a map of String –> [Value].

This method supports keywords as key names as well as multiple value types such as Numbers as well as Strings.