Struct datafusion::datasource::listing::ListingTableUrl

pub struct ListingTableUrl { /* private fields */ }

A parsed URL identifying files for a listing table, see ListingTableUrl::parse for more information on the supported expressions

Implementations

impl ListingTableUrl

pub fn parse(s: impl AsRef<str>) -> Result<Self>

Parse a provided string as a ListingTableUrl

Paths without a Scheme

If no scheme is provided, or the string is an absolute filesystem path as determined std::path::Path::is_absolute, the string will be interpreted as a path on the local filesystem using the operating system’s standard path delimiter, i.e. \ on Windows, / on Unix.

If the path contains any of '?', '*', '[', it will be considered a glob expression and resolved as described in the section below.

Otherwise, the path will be resolved to an absolute path, returning an error if it does not exist, and converted to a file URI

If you wish to specify a path that does not exist on the local machine you must provide it as a fully-qualified file URI e.g. file:///myfile.txt

Glob File Paths

If no scheme is provided, and the path contains a glob expression, it will be resolved as follows.

The string up to the first path segment containing a glob expression will be extracted, and resolved in the same manner as a normal scheme-less path. That is, resolved to an absolute path on the local filesystem, returning an error if it does not exist, and converted to a file URI

The remaining string will be interpreted as a glob::Pattern and used as a filter when listing files from object storage

pub fn scheme(&self) -> &str

Returns the URL scheme

pub fn as_str(&self) -> &str

Returns this ListingTableUrl as a string

pub fn object_store(&self) -> ObjectStoreUrl

Return the ObjectStoreUrl for this ListingTableUrl

Trait Implementations

impl AsRef<Url> for ListingTableUrl

fn as_ref(&self) -> &Url

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for ListingTableUrl

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ListingTableUrl

fn clone(&self) -> ListingTableUrl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListingTableUrl

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

Formats the value using the given formatter.

impl Display for ListingTableUrl

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

Formats the value using the given formatter.