You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: airbyte_cdk/sources/declarative/declarative_component_schema.yaml
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1081,21 +1081,21 @@ definitions:
1081
1081
examples:
1082
1082
- "PT1S"
1083
1083
is_data_feed:
1084
-
title: Whether the target API is formatted as a data feed
1084
+
title: Data Feed API
1085
1085
description: A data feed API is an API that does not allow filtering and paginates the content from the most recent to the least recent. Given this, the CDK needs to know when to stop paginating and this field will generate a stop condition for pagination.
1086
1086
type: boolean
1087
1087
is_client_side_incremental:
1088
-
title: Whether the target API does not support filtering and returns all data (the cursor filters records in the client instead of the API side)
1089
-
description: If the target API endpoint does not take cursor values to filter records and returns all records anyway, the connector with this cursor will filter out records locally, and only emit new records from the last sync, hence incremental. This means that all records would be read from the API, but only new records will be emitted to the destination.
1088
+
title: Client-side Incremental Filtering
1089
+
description: Set to True if the target API endpoint does not take cursor values to filter records and returns all records anyway. This will cause the connector to filter out records locally, and only emit new records from the last sync, hence incremental. This means that all records would be read from the API, but only new records will be emitted to the destination.
1090
1090
type: boolean
1091
1091
is_compare_strictly:
1092
-
title: Whether to skip requests if the start time equals the end time
1093
-
description: Set to True if the target API does not accept queries where the start time equal the end time.
1092
+
title: Strict Start-End Time Comparison
1093
+
description: Set to True if the target API does not accept queries where the start time equal the end time. This will cause those requests to be skipped.
1094
1094
type: boolean
1095
1095
default: False
1096
1096
global_substream_cursor:
1097
-
title: Whether to store cursor as one value instead of per partition
1098
-
description: This setting optimizes performance when the parent stream has thousands of partitions by storing the cursor as a single value rather than per partition. Notably, the substream state is updated only at the end of the sync, which helps prevent data loss in case of a sync failure. See more info in the [docs](https://docs.airbyte.com/connector-development/config-based/understanding-the-yaml-file/incremental-syncs).
1097
+
title: Global Substream Cursor
1098
+
description: Setting to True causes the connector to store the cursor as one value, instead of per-partition. This setting optimizes performance when the parent stream has thousands of partitions. Notably, the substream state is updated only at the end of the sync, which helps prevent data loss in case of a sync failure. See more info in the [docs](https://docs.airbyte.com/connector-development/config-based/understanding-the-yaml-file/incremental-syncs).
0 commit comments