Skip to content

chore: reorder and modify title/defaults for partition router fields #626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions airbyte_cdk/sources/declarative/declarative_component_schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3145,28 +3145,19 @@ definitions:
type:
type: string
enum: [ParentStreamConfig]
lazy_read_pointer:
title: Lazy Read Pointer
description: If set, this will enable lazy reading, using the initial read of parent records to extract child records.
type: array
default: []
items:
type: string
interpolation_context:
- config
stream:
title: Parent Stream
description: Reference to the parent stream.
anyOf:
- "$ref": "#/definitions/DeclarativeStream"
- "$ref": "#/definitions/StateDelegatingStream"
parent_key:
title: Parent Key
description: 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.
type: string
examples:
- "id"
- "{{ config['parent_record_id'] }}"
stream:
title: Parent Stream
description: Reference to the parent stream.
anyOf:
- "$ref": "#/definitions/DeclarativeStream"
- "$ref": "#/definitions/StateDelegatingStream"
partition_field:
title: Current Parent Key Value Identifier
description: While iterating over parent records during a sync, the parent_key value can be referenced by using this field.
Expand All @@ -3183,6 +3174,15 @@ definitions:
description: Indicates whether the parent stream should be read incrementally based on updates in the child stream.
type: boolean
default: false
lazy_read_pointer:
title: Lazy Read Pointer
description: If set, this will enable lazy reading, using the initial read of parent records to extract child records.
type: array
default: []
items:
type: string
interpolation_context:
- config
extra_fields:
title: Extra Fields
description: 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`.
Expand Down Expand Up @@ -3616,18 +3616,18 @@ definitions:
default: false
partition_router:
title: Partition Router
description: PartitionRouter component that describes how to partition the stream, enabling incremental syncs and checkpointing.
default: []
description: Used to iteratively execute requests over a set of values, such as a parent stream's records or a list of constant values.
anyOf:
- "$ref": "#/definitions/ListPartitionRouter"
- "$ref": "#/definitions/SubstreamPartitionRouter"
- "$ref": "#/definitions/ListPartitionRouter"
- "$ref": "#/definitions/GroupingPartitionRouter"
- "$ref": "#/definitions/CustomPartitionRouter"
- type: array
title: Multiple Partition Routers
items:
anyOf:
- "$ref": "#/definitions/ListPartitionRouter"
- "$ref": "#/definitions/SubstreamPartitionRouter"
- "$ref": "#/definitions/ListPartitionRouter"
- "$ref": "#/definitions/GroupingPartitionRouter"
- "$ref": "#/definitions/CustomPartitionRouter"
$parameters:
Expand Down
Loading
Loading