Enum datafusion_common::TableReference

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

Represents a path to a table that may require further resolution

Variants

Bare

Fields

table: &'a str

The table name

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

Partial

Fields

schema: &'a str

The schema containing the table

table: &'a str

The table name

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

Full

Fields

catalog: &'a str

The catalog (aka database) containing the table

schema: &'a str

The schema containing the table

table: &'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) -> Self

Forms a TableReference by splitting s on periods ..

Note that this function does NOT handle periods or name normalization correctly (e.g. "foo.bar" will be parsed as "foo.bar". and Foo will be parsed as Foo (not foo).

If you need to handle such identifiers correctly, you should use a SQL parser or form the OwnedTableReference directly.

See more detail in https://github.com/apache/arrow-datafusion/issues/4532

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

Formats the value using the given formatter.

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

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

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

Converts to this type from the input type.

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

Parse a string into a TableReference, by splittig on .

See caveats on TableReference::parse_str

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'a> Copy for TableReference<'a>