Enum datafusion_sql::TableReference

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

A multi part identifier (path) to a table that may require further resolution (e.g. foo.bar).

TableReferences are cheap to clone() as they are implemented with Arc.

See ResolvedTableReference for a fully resolved table reference.

Creating TableReference

When converting strings to TableReferences, the string is parsed as though it were a SQL identifier, normalizing (convert to lowercase) any unquoted identifiers. TableReference::bare creates references without applying normalization semantics.

Examples

// Get a table reference to 'mytable'
let table_reference = TableReference::from("mytable");
assert_eq!(table_reference, TableReference::bare("mytable"));

// Get a table reference to 'mytable' (note the capitalization)
let table_reference = TableReference::from("MyTable");
assert_eq!(table_reference, TableReference::bare("mytable"));

// Get a table reference to 'MyTable' (note the capitalization) using double quotes
// (programmatically it is better to use `TableReference::bare` for this)
let table_reference = TableReference::from(r#""MyTable""#);
assert_eq!(table_reference, TableReference::bare("MyTable"));

// Get a table reference to 'myschema.mytable' (note the capitalization)
let table_reference = TableReference::from("MySchema.MyTable");
assert_eq!(table_reference, TableReference::partial("myschema", "mytable"));

Variants

Bare

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

Fields

table: Arc<str>

The table name

Partial

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

Fields

schema: Arc<str>

The schema containing the table

table: Arc<str>

The table name

Full

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

Fields

catalog: Arc<str>

The catalog (aka database) containing the table

schema: Arc<str>

The schema containing the table

table: Arc<str>

The table name

Implementations

impl TableReference

pub fn none() -> Option<TableReference>

Convenience method for creating a typed none None

pub fn bare(table: impl Into<Arc<str>>) -> TableReference

Convenience method for creating a TableReference::Bare

As described on TableReference this does NO normalization at all, so “Foo.Bar” stays as a reference to the table named “Foo.Bar” (rather than “foo”.“bar”)

pub fn partial( schema: impl Into<Arc<str>>, table: impl Into<Arc<str>>, ) -> TableReference

Convenience method for creating a TableReference::Partial.

Note: NO normalization is applied to the schema or table name.

pub fn full( catalog: impl Into<Arc<str>>, schema: impl Into<Arc<str>>, table: impl Into<Arc<str>>, ) -> TableReference

Convenience method for creating a TableReference::Full

Note: NO normalization is applied to the catalog, schema or table name.

pub fn table(&self) -> &str

Retrieve the table name, regardless of qualification.

pub fn schema(&self) -> Option<&str>

Retrieve the schema name if [Self::Partial] or [Self::Full], None` otherwise.

pub fn catalog(&self) -> Option<&str>

Retrieve the catalog name if Self::Full, None otherwise.

pub fn resolved_eq(&self, other: &TableReference) -> bool

Compare with another TableReference as if both are resolved. This allows comparing across variants. If a field is not present in both variants being compared then it is ignored in the comparison.

e.g. this allows a TableReference::Bare to be considered equal to a fully qualified TableReference::Full if the table names match.

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

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

pub fn to_quoted_string(&self) -> String

Forms a string where the identifiers are quoted

Example

let table_reference = TableReference::partial("myschema", "mytable");
assert_eq!(table_reference.to_quoted_string(), "myschema.mytable");

let table_reference = TableReference::partial("MySchema", "MyTable");
assert_eq!(table_reference.to_quoted_string(), r#""MySchema"."MyTable""#);

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

Forms a TableReference by parsing s as a multipart SQL identifier. See docs on TableReference for more details.

pub fn to_vec(&self) -> Vec<String>

Decompose a TableReference to separate parts. The result vector contains at most three elements in the following sequence:

[<catalog>, <schema>, table]

Trait Implementations

impl Clone for TableReference

fn clone(&self) -> TableReference

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TableReference

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

Formats the value using the given formatter.

impl Display for TableReference

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

Parse a string into a TableReference, normalizing where appropriate

See full details on TableReference::parse_str

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

Converts to this type from the input type.

impl From<ResolvedTableReference> for TableReference

fn from(resolved: ResolvedTableReference) -> TableReference

Converts to this type from the input type.

impl From<String> for TableReference

fn from(s: String) -> TableReference

Converts to this type from the input type.

impl Hash for TableReference

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TableReference

fn cmp(&self, other: &TableReference) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for TableReference

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

fn partial_cmp(&self, other: &TableReference) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for TableReference

impl StructuralPartialEq for TableReference