WEweld
ELT Streams

Get ELT Stream

Changed on

Get details of a specific ELT Stream by its ID.

get/elt_streams/{id}

Request

  • Base URL
    https://connect.weld.app
  • URL
    https://connect.weld.app/elt_streams/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required
Example:vBjnEbMi9i3P4K

The ID of the ELT Stream.

Response

idstring required

The Id of the ELT Stream.

elt_sync_idstring required

The Id of the ELT Sync that the ELT Stream belongs to.

namestring required

The name of the ELT Stream

incremental_primary_key_namestring[]

The name of the primary key field used for incremental sync. Most commonly used for database incremental syncs.

primary_keysstring[] required

The primary key columns stored for the stream. These cannot be excluded from the sync. Empty for streams that run a full sync, which store no primary keys; the available streams of the ELT sync report the keys the source offers.

excluded_columnsstring[] required

Columns of the stream that are not synced to the destination.

hashed_columnsstring[] required

Columns of the stream that are hashed before they reach the destination.

incremental_pointer_idstring

The name of the field used for incremental sync cursor.

additional_incremental_pointer_idsstring[] required

Further cursor columns read alongside incremental_pointer_id; a row is synced again when any cursor column is later than the last sync.

full_sync_at_midnightboolean required

Deprecated. True whenever full_sync_schedule is 0 0 * * *, which is all this ever meant.

full_sync_alwaysboolean required

Indicates whether the full sync should always be performed.

protected_from_full_syncboolean required

Indicates whether the stream is protected from full sync.

created_atstring date-time required

The datetime when the ELT Stream was created.

updated_atstring date-time required

The datetime when the ELT Stream was last updated.

excluded_substreamsstring[] required

Excluded substreams from syncing.

enabled_history_tableboolean required

Whether history table(s) are enabled for this stream

change_data_capture_enabledboolean required

Whether the stream reads changes through Change Data Capture instead of scheduled extracts.

sync_intervalstring nullable

Custom cron schedule for this stream. When set, the stream is pulled out of its ELT Sync (orchestration or schedule) and runs on its own schedule. Null means it follows the parent ELT Sync.

soft_delete_enabledboolean required

Beta. Whether full syncs of this stream keep the rows the source no longer returns, marked with _weld_deleted_at, instead of replacing the table

full_sync_schedulestring nullable

Cron on which this stream runs a full sync, whatever the reason. Evaluated in UTC. The full sync is the stream's next scheduled run at or after each occurrence. Null means the stream has no full sync scheduled.

retiredboolean required

If the stream is retired and should not be used anymore

Example response

{
  "id": "SCTVdLAcyDTgNx",
  "elt_sync_id": "3LIw2FdxoByya9",
  "name": "users",
  "incremental_primary_key_name": [
    "id"
  ],
  "primary_keys": [
    "id"
  ],
  "excluded_columns": [
    "email"
  ],
  "hashed_columns": [
    "phone"
  ],
  "incremental_pointer_id": "updated_at",
  "additional_incremental_pointer_ids": [
    "closed_at"
  ],
  "created_at": "2020-01-01T00:00:00.000Z",
  "updated_at": "2020-01-01T00:00:00.000Z",
  "excluded_substreams": [
    "substream1",
    "substream2"
  ],
  "sync_interval": "0 0 * * *",
  "full_sync_schedule": "0 3 * * 0"
}

Changes

  • 4f3762e39f50Revision changes
    • info

      added the required property to the response with the status

  • 85974449323dRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status