Skip to main content

ParentStreamConfig

Describes how to construct partitions from the records retrieved from the parent stream..

  • type: object
  • required: ["type","parent_key","partition_field","stream"]

type​

  • Required: Yes
  • type: string
  • enum: ["ParentStreamConfig"]

stream​

Reference to the parent stream.

parent_key​

The primary key of records from the parent stream that will be used during the retrieval of records for the current substream. This parent identifier field is typically a characteristic of the child records being extracted from the source API.

  • Required: Yes
  • type: string

Examples:

id
{{ config['parent_record_id'] }}

partition_field​

While iterating over parent records during a sync, the parent_key value can be referenced by using this field.

  • Required: Yes
  • type: string

Examples:

parent_id
{{ config['parent_partition_field'] }}

request_option​

A request option describing where the parent key value should be injected into and under what field name if applicable.

incremental_dependency​

Indicates whether the parent stream should be read incrementally based on updates in the child stream.

  • Required: No
  • type: boolean
  • default: false

lazy_read_pointer​

If set, this will enable lazy reading, using the initial read of parent records to extract child records.

  • Required: No

  • type: array

  • default: []

  • Available variables: config

  • items:

    • type: string

extra_fields​

Array of field paths to include as additional fields in the stream slice. Each path is an array of strings representing keys to access fields in the respective parent record. Accessible via stream_slice.extra_fields. Missing fields are set to None.

  • Required: No

  • type: array

  • Available variables: config

  • items:

    Defines a field path as an array of strings.

    • type: array

    Examples:

    - field1
    - nested
    - field2

    • items:

      • type: string

$parameters​

  • Required: No
  • type: object
Was this page helpful?