Configurations for a single stream.
| Field | Type | Required | Description |
|---|---|---|---|
name |
str | ✔️ | N/A |
cursor_field |
List[str] | ➖ | Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if sync_mode is incremental unless there is a default. |
destination_object_name |
Optional[str] | ➖ | The name of the destination object that this stream will be written to, used for data activation destinations. |
include_files |
Optional[bool] | ➖ | Whether to move raw files from the source to the destination during the sync. |
mappers |
List[models.ConfiguredStreamMapper] | ➖ | Mappers that should be applied to the stream before writing to the destination. |
namespace |
Optional[str] | ➖ | Namespace of the stream. |
primary_key |
List[List[str]] | ➖ | Paths to the fields that will be used as primary key. This field is REQUIRED if destination_sync_mode is *_dedup unless it is already supplied by the source schema. |
selected_fields |
List[models.SelectedFieldInfo] | ➖ | Paths to the fields that will be included in the configured catalog. |
sync_mode |
Optional[models.ConnectionSyncModeEnum] | ➖ | N/A |