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
+43-18Lines changed: 43 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -940,6 +940,9 @@ definitions:
940
940
- "{{ config['record_cursor'] }}"
941
941
cursor_datetime_formats:
942
942
title: Cursor Datetime Formats
943
+
type: array
944
+
items:
945
+
type: string
943
946
description: |
944
947
The possible formats for the cursor field, in order of preference. The first format that matches the cursor field value will be used to parse it. If not provided, the Outgoing Datetime Format will be used.
945
948
@@ -974,20 +977,17 @@ definitions:
974
977
* **%%**: Literal '%' character
975
978
976
979
Some placeholders depend on the locale of the underlying system - in most cases this locale is configured as en/US. For more information see the [Python documentation](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes).
977
-
type: array
978
-
items:
979
-
type: string
980
-
examples:
981
-
- "%Y-%m-%d"
982
-
- "%Y-%m-%d %H:%M:%S"
983
-
- "%Y-%m-%dT%H:%M:%S"
984
-
- "%Y-%m-%dT%H:%M:%SZ"
985
-
- "%Y-%m-%dT%H:%M:%S%z"
986
-
- "%Y-%m-%dT%H:%M:%S.%fZ"
987
-
- "%Y-%m-%dT%H:%M:%S.%f%z"
988
-
- "%Y-%m-%d %H:%M:%S.%f+00:00"
989
-
- "%s"
990
-
- "%ms"
980
+
examples:
981
+
- "%Y-%m-%d"
982
+
- "%Y-%m-%d %H:%M:%S"
983
+
- "%Y-%m-%dT%H:%M:%S"
984
+
- "%Y-%m-%dT%H:%M:%SZ"
985
+
- "%Y-%m-%dT%H:%M:%S%z"
986
+
- "%Y-%m-%dT%H:%M:%S.%fZ"
987
+
- "%Y-%m-%dT%H:%M:%S.%f%z"
988
+
- "%Y-%m-%d %H:%M:%S.%f+00:00"
989
+
- "%s"
990
+
- "%ms"
991
991
start_datetime:
992
992
title: Start Datetime
993
993
description: The datetime that determines the earliest record that should be synced.
@@ -1068,9 +1068,15 @@ definitions:
1068
1068
- "%s_as_float"
1069
1069
cursor_granularity:
1070
1070
title: Cursor Granularity
1071
-
description:
1071
+
description:|
1072
1072
Smallest increment the datetime_format has (ISO 8601 duration) that is used to ensure the start of a slice does not overlap with the end of the previous one, e.g. for %Y-%m-%d the granularity should
1073
1073
be P1D, for %Y-%m-%dT%H:%M:%SZ the granularity should be PT1S. Given this field is provided, `step` needs to be provided as well.
1074
+
* **PT0.000001S**: 1 microsecond
1075
+
* **PT0.001S**: 1 millisecond
1076
+
* **PT1S**: 1 second
1077
+
* **PT1M**: 1 minute
1078
+
* **PT1H**: 1 hour
1079
+
* **P1D**: 1 day
1074
1080
type: string
1075
1081
examples:
1076
1082
- "PT1S"
@@ -1094,7 +1100,13 @@ definitions:
1094
1100
default: false
1095
1101
lookback_window:
1096
1102
title: Lookback Window
1097
-
description: Time interval before the start_datetime to read data for, e.g. P1M for looking back one month.
1103
+
description: |
1104
+
Time interval (ISO8601 duration) before the start_datetime to read data for, e.g. P1M for looking back one month.
1105
+
* **PT1H**: 1 hour
1106
+
* **P1D**: 1 day
1107
+
* **PT1W**: 1 week
1108
+
* **P1M**: 1 month
1109
+
* **P1Y**: 1 year
1098
1110
type: string
1099
1111
interpolation_context:
1100
1112
- config
@@ -1115,7 +1127,13 @@ definitions:
1115
1127
- "starting_time"
1116
1128
step:
1117
1129
title: Step
1118
-
description: The size of the time window (ISO8601 duration). Given this field is provided, `cursor_granularity` needs to be provided as well.
1130
+
description: |
1131
+
The size of the time window (ISO8601 duration). Given this field is provided, `cursor_granularity` needs to be provided as well.
1132
+
* **PT1H**: 1 hour
1133
+
* **P1D**: 1 day
1134
+
* **PT1W**: 1 week
1135
+
* **P1M**: 1 month
1136
+
* **P1Y**: 1 year
1119
1137
type: string
1120
1138
examples:
1121
1139
- "P1W"
@@ -1955,7 +1973,13 @@ definitions:
1955
1973
type: string
1956
1974
expiration_duration:
1957
1975
title: Expiration Duration
1958
-
description: The duration in ISO 8601 duration notation after which the session token expires, starting from the time it was obtained. Omitting it will result in the session token being refreshed for every request.
1976
+
description: |
1977
+
The duration in ISO 8601 duration notation after which the session token expires, starting from the time it was obtained. Omitting it will result in the session token being refreshed for every request.
0 commit comments