Interface AirbyteStream

the immutable schema defined by the source

Hierarchy

  • AirbyteStream

Properties

defaultCursorField jsonSchema name namespace sourceDefinedCursor sourceDefinedPrimaryKey supportedSyncModes

Properties

Optional defaultCursorField

defaultCursorField?: 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.

Optional jsonSchema

jsonSchema?: StreamJsonSchema

name

name: string

Stream's name.

Optional namespace

namespace?: string

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

Optional sourceDefinedCursor

sourceDefinedCursor?: boolean

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.

Optional sourceDefinedPrimaryKey

sourceDefinedPrimaryKey?: 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.

Optional supportedSyncModes

supportedSyncModes?: SyncMode[]

Settings

Member Visibility

Theme

Generated using TypeDoc