Data IntegrationETLELTOpen-SourceData PipelineConnectorsData
StreamConfiguration is a JSON Structure definition published by Airbyte, describing 9 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/json-structure/airbyte-stream-configuration-structure.json",
"name": "StreamConfiguration",
"description": "Configurations for a single stream.",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"namespace": {
"type": "string",
"description": "Namespace of the stream."
},
"syncMode": {
"$ref": "#/components/schemas/ConnectionSyncModeEnum"
},
"cursorField": {
"description": "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.",
"type": "array",
"items": {
"type": "string"
}
},
"primaryKey": {
"description": "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.",
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"includeFiles": {
"description": "Whether to move raw files from the source to the destination during the sync.",
"type": "boolean"
},
"destinationObjectName": {
"description": "The name of the destination object that this stream will be written to, used for data activation destinations.",
"type": "string"
},
"selectedFields": {
"description": "By default (if not provided in the request) all fields will be synced. Otherwise, only the fields in this list will be synced.",
"$ref": "#/components/schemas/SelectedFields"
},
"mappers": {
"description": "Mappers that should be applied to the stream before writing to the destination.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfiguredStreamMapper"
}
}
},
"required": [
"name"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.