Struct Profile

pub struct Profile { /* private fields */ }

Delta Sharing profile.

The Delta Sharing profile is used to connect with a Delta Sharing server. The profile contains the endpoint and authentication information to make a succesful connection.

Implementations

impl Profile

pub fn try_from_path<P: AsRef<Path>>(path: P) -> Result<Self, DeltaSharingError>

Try to create a new Delta Sharing profile from a profile file.

Example

use datafusion_delta_sharing::Profile;

let profile = Profile::try_from_path("./path/to/profile.json")?;

pub fn from_profile_type( share_credentials_version: u32, endpoint: Url, profile_type: ProfileType, ) -> Self

Create a new Delta Sharing profile with a profile type.

Example

use datafusion_delta_sharing::{Profile, profile::ProfileType};
use url::Url;

let version = 1;
let endpoint = Url::parse("https://sharing.delta.io/delta-sharing/").unwrap();
let profile_type = ProfileType::new_bearer_token("foo", None);

let profile = Profile::from_profile_type(version, endpoint.clone(), profile_type);
assert_eq!(profile.share_credentials_version(), 1);
assert_eq!(profile.endpoint(), &endpoint);
assert!(profile.is_bearer_token());

pub fn share_credentials_version(&self) -> u32

Retrieve the share credentials version from the profile.

Example

use datafusion_delta_sharing::{Profile, profile::ProfileType};
use url::Url;

let version = 1;
let endpoint = "https://sharing.delta.io/delta-sharing/".parse::<Url>().unwrap();
let profile_type = ProfileType::new_bearer_token("token", None);
let profile = Profile::from_profile_type(1, endpoint, profile_type);

assert_eq!(profile.share_credentials_version(), 1);

pub fn endpoint(&self) -> &Url

Retrieve the endpoint from the profile.

Example

use datafusion_delta_sharing::{Profile, profile::ProfileType};
use url::Url;

let version = 1;
let endpoint = "https://sharing.delta.io/delta-sharing/".parse::<Url>().unwrap();
let profile_type = ProfileType::new_bearer_token("token", None);
let profile = Profile::from_profile_type(1, endpoint.clone(), profile_type);

assert_eq!(profile.endpoint(), &endpoint);

pub fn new_bearer_token( version: u32, endpoint: impl Into<String>, bearer_token: impl Into<String>, expiration_time: Option<DateTime<Utc>>, ) -> Self

Create a new Delta Sharing profile using a bearer token.

Example

use datafusion_delta_sharing::Profile;

let profile = Profile::new_bearer_token(1, "https://sharing.delta.io/delta-sharing/", "token", None);
assert!(profile.is_bearer_token());

pub fn is_bearer_token(&self) -> bool

Check if the profile is a bearer token profile.

Example

use datafusion_delta_sharing::{Profile, profile::ProfileType};
use url::Url;

let version = 1;
let endpoint = "https://sharing.delta.io/delta-sharing/".parse::<Url>().unwrap();
let profile_type = ProfileType::new_bearer_token("token", None);
let profile = Profile::from_profile_type(1, endpoint, profile_type);

assert!(profile.is_bearer_token());

Trait Implementations

impl Clone for Profile

fn clone(&self) -> Profile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Profile

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

Formats the value using the given formatter.