Struct AirbyteStream

pub struct AirbyteStream {
    pub name: String,
    pub json_schema: JsonSchema,
    pub default_cursor_field: Option<Vec<String>>,
    pub is_resumable: Option<bool>,
    pub namespace: Option<String>,
    pub source_defined_cursor: Option<bool>,
    pub source_defined_primary_key: Option<Vec<Vec<String>>>,
    pub supported_sync_modes: Vec<SyncMode>,
}

Fields

name: String

Stream’s name.

json_schema: JsonSchema

Stream schema using Json Schema specs.

default_cursor_field: Option<Vec<String>>

Path to the field that will be used to determine if a record is new or modified since the last sync. If not provided by the source, the end user will have to specify the comparable themselves.

is_resumable: Option<bool>

If the stream is resumable or not. Should be set to true if the stream supports incremental. Defaults to false. Primarily used by the Platform in Full Refresh to determine if a Full Refresh stream should actually be treated as incremental within a job.

namespace: Option<String>

Optional Source-defined namespace. Currently only used by JDBC destinations to determine what schema to write to. Airbyte streams from the same sources should have the same namespace.

source_defined_cursor: Option<bool>

If the source defines the cursor field, then any other cursor field inputs will be ignored. If it does not, either the user_provided one is used, or the default one is used as a backup. This field must be set if is_resumable is set to true, including resumable full refresh synthetic cursors.

source_defined_primary_key: Option<Vec<Vec<String>>>

If the source defines the primary key, paths to the fields that will be used as a primary key. If not provided by the source, the end user will have to specify the primary key themselves.

supported_sync_modes: Vec<SyncMode>

List of sync modes supported by this stream.

Trait Implementations

impl Clone for AirbyteStream

fn clone(&self) -> AirbyteStream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AirbyteStream

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AirbyteStream

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AirbyteStream

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AirbyteStream