Enum datafusion_sql::TableReference

pub enum TableReference<'a> {
    Bare {
        table: Cow<'a, str>,
    },
    Partial {
        schema: Cow<'a, str>,
        table: Cow<'a, str>,
    },
    Full {
        catalog: Cow<'a, str>,
        schema: Cow<'a, str>,
        table: Cow<'a, str>,
    },
}

Represents a path to a table that may require further resolution

Variants

Bare

Fields

table: Cow<'a, str>

The table name

An unqualified table reference, e.g. “table”

Partial

Fields

schema: Cow<'a, str>

The schema containing the table

table: Cow<'a, str>

The table name

A partially resolved table reference, e.g. “schema.table”

Full

Fields

catalog: Cow<'a, str>

The catalog (aka database) containing the table

schema: Cow<'a, str>

The schema containing the table

table: Cow<'a, str>

The table name

A fully resolved table reference, e.g. “catalog.schema.table”

Implementations

impl<'a> TableReference<'a>

pub fn table(&self) -> &str

Retrieve the actual table name, regardless of qualification

pub fn resolve( self, default_catalog: &'a str, default_schema: &'a str ) -> ResolvedTableReference<'a>

Given a default catalog and schema, ensure this table reference is fully resolved

pub fn parse_str(s: &'a str) -> TableReference<'a>

Forms a TableReference by attempting to parse s as a multipart identifier, failing that then taking the entire unnormalized input as the identifier itself.

Will normalize (convert to lowercase) any unquoted identifiers.

e.g. Foo will be parsed as foo, and "Foo"".bar" will be parsed as Foo".bar (note the preserved case and requiring two double quotes to represent a single double quote in the identifier)

Trait Implementations

impl<'a> Clone for TableReference<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TableReference<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a OwnedTableReference> for TableReference<'a>

Convert OwnedTableReference into a TableReference. Somewhat awkward to use but ‘idiomatic’: (&table_ref).into()

fn from(r: &'a OwnedTableReference) -> TableReference<'a>

Converts to this type from the input type.

impl<'a> From<&'a str> for TableReference<'a>

Parse a string into a TableReference, normalizing where appropriate

See full details on TableReference::parse_str

fn from(s: &'a str) -> TableReference<'a>

Converts to this type from the input type.

impl<'a> From<ResolvedTableReference<'a>> for TableReference<'a>

fn from(resolved: ResolvedTableReference<'a>) -> TableReference<'a>

Converts to this type from the input type.

impl<'a> PartialEq<TableReference<'a>> for TableReference<'a>

fn eq(&self, other: &TableReference<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> Eq for TableReference<'a>

impl<'a> StructuralEq for TableReference<'a>

impl<'a> StructuralPartialEq for TableReference<'a>