Skip to main content

DatabricksSourceConfig

Struct DatabricksSourceConfig 

Source
pub struct DatabricksSourceConfig {
    pub workspace_url: String,
    pub warehouse_id: String,
    pub sql: String,
    pub auth: AuthSpec<DatabricksAuth>,
    pub catalog: Option<String>,
    pub schema: Option<String>,
    pub parameters: Vec<DatabricksParam>,
    pub wait_timeout_secs: u64,
    pub poll_interval_secs: u64,
    pub batch_size: usize,
    pub replication: DatabricksReplication,
    pub state_key: Option<String>,
}
Expand description

Configuration for the Databricks SQL query source.

Runs sql against a Databricks SQL Warehouse via the Statement Execution REST API and streams the result rows as typed JSON objects.

Fields§

§workspace_url: String

Workspace base URL, e.g. https://dbc-abc123.cloud.databricks.com.

§warehouse_id: String

Target SQL Warehouse id.

§sql: String

The SQL statement to run. May contain :name parameter markers (see parameters) and a ${bookmark} token for incremental replication.

§auth: AuthSpec<DatabricksAuth>

Authentication (PAT / OAuth bearer), inline or via a shared auth: { ref }.

§catalog: Option<String>

Default Unity Catalog catalog for the statement.

§schema: Option<String>

Default schema for the statement.

§parameters: Vec<DatabricksParam>

Named SQL parameters (:name markers).

§wait_timeout_secs: u64

Server-side wait before the statement goes async (seconds). Databricks accepts 0 (fully async) or 550. Defaults to 50.

§poll_interval_secs: u64

Client poll cadence while the statement is PENDING/RUNNING (seconds).

§batch_size: usize

Page size — rows accumulated before a StreamPage is emitted.

§replication: DatabricksReplication

Replication mode. Defaults to DatabricksReplication::Full.

§state_key: Option<String>

Explicit state-store key for the incremental bookmark. When unset, a key is derived from the workspace/warehouse and a query fingerprint.

Implementations§

Source§

impl DatabricksSourceConfig

Source

pub fn validate(&self) -> Result<(), FaucetError>

Validate the config; returns a human-readable error if invalid.

Trait Implementations§

Source§

impl Clone for DatabricksSourceConfig

Source§

fn clone(&self) -> DatabricksSourceConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'de> Deserialize<'de> for DatabricksSourceConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for DatabricksSourceConfig

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Serialize for DatabricksSourceConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more