airbyte-cdk 0.72.1__py3-none-any.whl → 6.17.1.dev1__py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (518) hide show
  1. airbyte_cdk/__init__.py +355 -6
  2. airbyte_cdk/cli/__init__.py +1 -0
  3. airbyte_cdk/cli/source_declarative_manifest/__init__.py +5 -0
  4. airbyte_cdk/cli/source_declarative_manifest/_run.py +230 -0
  5. airbyte_cdk/cli/source_declarative_manifest/spec.json +17 -0
  6. airbyte_cdk/config_observation.py +29 -10
  7. airbyte_cdk/connector.py +24 -24
  8. airbyte_cdk/connector_builder/README.md +53 -0
  9. airbyte_cdk/connector_builder/connector_builder_handler.py +37 -11
  10. airbyte_cdk/connector_builder/main.py +45 -13
  11. airbyte_cdk/connector_builder/message_grouper.py +189 -50
  12. airbyte_cdk/connector_builder/models.py +3 -2
  13. airbyte_cdk/destinations/__init__.py +4 -3
  14. airbyte_cdk/destinations/destination.py +54 -20
  15. airbyte_cdk/destinations/vector_db_based/README.md +37 -0
  16. airbyte_cdk/destinations/vector_db_based/config.py +40 -17
  17. airbyte_cdk/destinations/vector_db_based/document_processor.py +56 -17
  18. airbyte_cdk/destinations/vector_db_based/embedder.py +57 -15
  19. airbyte_cdk/destinations/vector_db_based/test_utils.py +14 -4
  20. airbyte_cdk/destinations/vector_db_based/utils.py +8 -2
  21. airbyte_cdk/destinations/vector_db_based/writer.py +24 -5
  22. airbyte_cdk/entrypoint.py +153 -44
  23. airbyte_cdk/exception_handler.py +21 -3
  24. airbyte_cdk/logger.py +30 -44
  25. airbyte_cdk/models/__init__.py +13 -2
  26. airbyte_cdk/models/airbyte_protocol.py +86 -1
  27. airbyte_cdk/models/airbyte_protocol_serializers.py +44 -0
  28. airbyte_cdk/models/file_transfer_record_message.py +13 -0
  29. airbyte_cdk/models/well_known_types.py +1 -1
  30. airbyte_cdk/sources/__init__.py +5 -1
  31. airbyte_cdk/sources/abstract_source.py +125 -79
  32. airbyte_cdk/sources/concurrent_source/__init__.py +7 -2
  33. airbyte_cdk/sources/concurrent_source/concurrent_read_processor.py +102 -36
  34. airbyte_cdk/sources/concurrent_source/concurrent_source.py +29 -36
  35. airbyte_cdk/sources/concurrent_source/concurrent_source_adapter.py +94 -10
  36. airbyte_cdk/sources/concurrent_source/stream_thread_exception.py +25 -0
  37. airbyte_cdk/sources/concurrent_source/thread_pool_manager.py +20 -14
  38. airbyte_cdk/sources/config.py +3 -2
  39. airbyte_cdk/sources/connector_state_manager.py +49 -83
  40. airbyte_cdk/sources/declarative/async_job/job.py +52 -0
  41. airbyte_cdk/sources/declarative/async_job/job_orchestrator.py +497 -0
  42. airbyte_cdk/sources/declarative/async_job/job_tracker.py +75 -0
  43. airbyte_cdk/sources/declarative/async_job/repository.py +35 -0
  44. airbyte_cdk/sources/declarative/async_job/status.py +24 -0
  45. airbyte_cdk/sources/declarative/async_job/timer.py +39 -0
  46. airbyte_cdk/sources/declarative/auth/__init__.py +2 -3
  47. airbyte_cdk/sources/declarative/auth/declarative_authenticator.py +3 -1
  48. airbyte_cdk/sources/declarative/auth/jwt.py +191 -0
  49. airbyte_cdk/sources/declarative/auth/oauth.py +60 -20
  50. airbyte_cdk/sources/declarative/auth/selective_authenticator.py +10 -2
  51. airbyte_cdk/sources/declarative/auth/token.py +28 -10
  52. airbyte_cdk/sources/declarative/auth/token_provider.py +9 -8
  53. airbyte_cdk/sources/declarative/checks/check_stream.py +16 -8
  54. airbyte_cdk/sources/declarative/checks/connection_checker.py +4 -2
  55. airbyte_cdk/sources/declarative/concurrency_level/__init__.py +7 -0
  56. airbyte_cdk/sources/declarative/concurrency_level/concurrency_level.py +50 -0
  57. airbyte_cdk/sources/declarative/concurrent_declarative_source.py +490 -0
  58. airbyte_cdk/sources/declarative/datetime/datetime_parser.py +4 -0
  59. airbyte_cdk/sources/declarative/datetime/min_max_datetime.py +26 -6
  60. airbyte_cdk/sources/declarative/declarative_component_schema.yaml +1185 -85
  61. airbyte_cdk/sources/declarative/declarative_source.py +5 -2
  62. airbyte_cdk/sources/declarative/declarative_stream.py +95 -9
  63. airbyte_cdk/sources/declarative/decoders/__init__.py +23 -2
  64. airbyte_cdk/sources/declarative/decoders/composite_raw_decoder.py +97 -0
  65. airbyte_cdk/sources/declarative/decoders/decoder.py +11 -4
  66. airbyte_cdk/sources/declarative/decoders/json_decoder.py +92 -5
  67. airbyte_cdk/sources/declarative/decoders/noop_decoder.py +21 -0
  68. airbyte_cdk/sources/declarative/decoders/pagination_decoder_decorator.py +39 -0
  69. airbyte_cdk/sources/declarative/decoders/xml_decoder.py +98 -0
  70. airbyte_cdk/sources/declarative/extractors/__init__.py +12 -1
  71. airbyte_cdk/sources/declarative/extractors/dpath_extractor.py +29 -24
  72. airbyte_cdk/sources/declarative/extractors/http_selector.py +4 -5
  73. airbyte_cdk/sources/declarative/extractors/record_extractor.py +2 -3
  74. airbyte_cdk/sources/declarative/extractors/record_filter.py +63 -8
  75. airbyte_cdk/sources/declarative/extractors/record_selector.py +85 -26
  76. airbyte_cdk/sources/declarative/extractors/response_to_file_extractor.py +177 -0
  77. airbyte_cdk/sources/declarative/extractors/type_transformer.py +55 -0
  78. airbyte_cdk/sources/declarative/incremental/__init__.py +31 -3
  79. airbyte_cdk/sources/declarative/incremental/concurrent_partition_cursor.py +340 -0
  80. airbyte_cdk/sources/declarative/incremental/datetime_based_cursor.py +156 -48
  81. airbyte_cdk/sources/declarative/incremental/declarative_cursor.py +13 -0
  82. airbyte_cdk/sources/declarative/incremental/global_substream_cursor.py +350 -0
  83. airbyte_cdk/sources/declarative/incremental/per_partition_cursor.py +174 -74
  84. airbyte_cdk/sources/declarative/incremental/per_partition_with_global.py +200 -0
  85. airbyte_cdk/sources/declarative/incremental/resumable_full_refresh_cursor.py +122 -0
  86. airbyte_cdk/sources/declarative/interpolation/filters.py +27 -1
  87. airbyte_cdk/sources/declarative/interpolation/interpolated_boolean.py +23 -5
  88. airbyte_cdk/sources/declarative/interpolation/interpolated_mapping.py +12 -8
  89. airbyte_cdk/sources/declarative/interpolation/interpolated_nested_mapping.py +13 -6
  90. airbyte_cdk/sources/declarative/interpolation/interpolated_string.py +21 -6
  91. airbyte_cdk/sources/declarative/interpolation/interpolation.py +9 -3
  92. airbyte_cdk/sources/declarative/interpolation/jinja.py +72 -37
  93. airbyte_cdk/sources/declarative/interpolation/macros.py +72 -17
  94. airbyte_cdk/sources/declarative/manifest_declarative_source.py +193 -52
  95. airbyte_cdk/sources/declarative/migrations/legacy_to_per_partition_state_migration.py +98 -0
  96. airbyte_cdk/sources/declarative/migrations/state_migration.py +24 -0
  97. airbyte_cdk/sources/declarative/models/__init__.py +1 -1
  98. airbyte_cdk/sources/declarative/models/declarative_component_schema.py +1319 -603
  99. airbyte_cdk/sources/declarative/parsers/custom_exceptions.py +2 -2
  100. airbyte_cdk/sources/declarative/parsers/manifest_component_transformer.py +26 -4
  101. airbyte_cdk/sources/declarative/parsers/manifest_reference_resolver.py +26 -15
  102. airbyte_cdk/sources/declarative/parsers/model_to_component_factory.py +1759 -225
  103. airbyte_cdk/sources/declarative/partition_routers/__init__.py +24 -4
  104. airbyte_cdk/sources/declarative/partition_routers/async_job_partition_router.py +65 -0
  105. airbyte_cdk/sources/declarative/partition_routers/cartesian_product_stream_slicer.py +176 -0
  106. airbyte_cdk/sources/declarative/partition_routers/list_partition_router.py +39 -9
  107. airbyte_cdk/sources/declarative/partition_routers/partition_router.py +62 -0
  108. airbyte_cdk/sources/declarative/partition_routers/single_partition_router.py +15 -3
  109. airbyte_cdk/sources/declarative/partition_routers/substream_partition_router.py +222 -39
  110. airbyte_cdk/sources/declarative/requesters/error_handlers/__init__.py +19 -5
  111. airbyte_cdk/sources/declarative/requesters/error_handlers/backoff_strategies/__init__.py +3 -1
  112. airbyte_cdk/sources/declarative/requesters/error_handlers/backoff_strategies/constant_backoff_strategy.py +19 -7
  113. airbyte_cdk/sources/declarative/requesters/error_handlers/backoff_strategies/exponential_backoff_strategy.py +19 -7
  114. airbyte_cdk/sources/declarative/requesters/error_handlers/backoff_strategies/header_helper.py +4 -2
  115. airbyte_cdk/sources/declarative/requesters/error_handlers/backoff_strategies/wait_time_from_header_backoff_strategy.py +41 -9
  116. airbyte_cdk/sources/declarative/requesters/error_handlers/backoff_strategies/wait_until_time_from_header_backoff_strategy.py +29 -14
  117. airbyte_cdk/sources/declarative/requesters/error_handlers/backoff_strategy.py +5 -13
  118. airbyte_cdk/sources/declarative/requesters/error_handlers/composite_error_handler.py +32 -16
  119. airbyte_cdk/sources/declarative/requesters/error_handlers/default_error_handler.py +46 -56
  120. airbyte_cdk/sources/declarative/requesters/error_handlers/default_http_response_filter.py +40 -0
  121. airbyte_cdk/sources/declarative/requesters/error_handlers/error_handler.py +6 -32
  122. airbyte_cdk/sources/declarative/requesters/error_handlers/http_response_filter.py +119 -41
  123. airbyte_cdk/sources/declarative/requesters/http_job_repository.py +228 -0
  124. airbyte_cdk/sources/declarative/requesters/http_requester.py +98 -344
  125. airbyte_cdk/sources/declarative/requesters/paginators/__init__.py +14 -3
  126. airbyte_cdk/sources/declarative/requesters/paginators/default_paginator.py +105 -46
  127. airbyte_cdk/sources/declarative/requesters/paginators/no_pagination.py +14 -8
  128. airbyte_cdk/sources/declarative/requesters/paginators/paginator.py +19 -8
  129. airbyte_cdk/sources/declarative/requesters/paginators/strategies/__init__.py +9 -3
  130. airbyte_cdk/sources/declarative/requesters/paginators/strategies/cursor_pagination_strategy.py +53 -21
  131. airbyte_cdk/sources/declarative/requesters/paginators/strategies/offset_increment.py +42 -19
  132. airbyte_cdk/sources/declarative/requesters/paginators/strategies/page_increment.py +25 -12
  133. airbyte_cdk/sources/declarative/requesters/paginators/strategies/pagination_strategy.py +13 -10
  134. airbyte_cdk/sources/declarative/requesters/paginators/strategies/stop_condition.py +26 -13
  135. airbyte_cdk/sources/declarative/requesters/request_options/__init__.py +15 -2
  136. airbyte_cdk/sources/declarative/requesters/request_options/datetime_based_request_options_provider.py +91 -0
  137. airbyte_cdk/sources/declarative/requesters/request_options/default_request_options_provider.py +60 -0
  138. airbyte_cdk/sources/declarative/requesters/request_options/interpolated_nested_request_input_provider.py +31 -14
  139. airbyte_cdk/sources/declarative/requesters/request_options/interpolated_request_input_provider.py +27 -15
  140. airbyte_cdk/sources/declarative/requesters/request_options/interpolated_request_options_provider.py +63 -10
  141. airbyte_cdk/sources/declarative/requesters/request_options/request_options_provider.py +1 -1
  142. airbyte_cdk/sources/declarative/requesters/requester.py +9 -17
  143. airbyte_cdk/sources/declarative/resolvers/__init__.py +41 -0
  144. airbyte_cdk/sources/declarative/resolvers/components_resolver.py +55 -0
  145. airbyte_cdk/sources/declarative/resolvers/config_components_resolver.py +136 -0
  146. airbyte_cdk/sources/declarative/resolvers/http_components_resolver.py +112 -0
  147. airbyte_cdk/sources/declarative/retrievers/__init__.py +6 -2
  148. airbyte_cdk/sources/declarative/retrievers/async_retriever.py +100 -0
  149. airbyte_cdk/sources/declarative/retrievers/retriever.py +1 -3
  150. airbyte_cdk/sources/declarative/retrievers/simple_retriever.py +229 -73
  151. airbyte_cdk/sources/declarative/schema/__init__.py +14 -1
  152. airbyte_cdk/sources/declarative/schema/default_schema_loader.py +5 -3
  153. airbyte_cdk/sources/declarative/schema/dynamic_schema_loader.py +236 -0
  154. airbyte_cdk/sources/declarative/schema/json_file_schema_loader.py +8 -8
  155. airbyte_cdk/sources/declarative/spec/spec.py +12 -5
  156. airbyte_cdk/sources/declarative/stream_slicers/__init__.py +1 -2
  157. airbyte_cdk/sources/declarative/stream_slicers/declarative_partition_generator.py +88 -0
  158. airbyte_cdk/sources/declarative/stream_slicers/stream_slicer.py +9 -14
  159. airbyte_cdk/sources/declarative/transformations/add_fields.py +19 -11
  160. airbyte_cdk/sources/declarative/transformations/flatten_fields.py +52 -0
  161. airbyte_cdk/sources/declarative/transformations/keys_replace_transformation.py +61 -0
  162. airbyte_cdk/sources/declarative/transformations/keys_to_lower_transformation.py +22 -0
  163. airbyte_cdk/sources/declarative/transformations/keys_to_snake_transformation.py +68 -0
  164. airbyte_cdk/sources/declarative/transformations/remove_fields.py +13 -10
  165. airbyte_cdk/sources/declarative/transformations/transformation.py +5 -5
  166. airbyte_cdk/sources/declarative/types.py +19 -110
  167. airbyte_cdk/sources/declarative/yaml_declarative_source.py +31 -10
  168. airbyte_cdk/sources/embedded/base_integration.py +16 -5
  169. airbyte_cdk/sources/embedded/catalog.py +16 -4
  170. airbyte_cdk/sources/embedded/runner.py +19 -3
  171. airbyte_cdk/sources/embedded/tools.py +5 -2
  172. airbyte_cdk/sources/file_based/README.md +152 -0
  173. airbyte_cdk/sources/file_based/__init__.py +24 -0
  174. airbyte_cdk/sources/file_based/availability_strategy/__init__.py +9 -2
  175. airbyte_cdk/sources/file_based/availability_strategy/abstract_file_based_availability_strategy.py +22 -6
  176. airbyte_cdk/sources/file_based/availability_strategy/default_file_based_availability_strategy.py +46 -10
  177. airbyte_cdk/sources/file_based/config/abstract_file_based_spec.py +47 -10
  178. airbyte_cdk/sources/file_based/config/avro_format.py +2 -1
  179. airbyte_cdk/sources/file_based/config/csv_format.py +29 -10
  180. airbyte_cdk/sources/file_based/config/excel_format.py +18 -0
  181. airbyte_cdk/sources/file_based/config/file_based_stream_config.py +16 -4
  182. airbyte_cdk/sources/file_based/config/jsonl_format.py +2 -1
  183. airbyte_cdk/sources/file_based/config/parquet_format.py +2 -1
  184. airbyte_cdk/sources/file_based/config/unstructured_format.py +13 -5
  185. airbyte_cdk/sources/file_based/discovery_policy/__init__.py +6 -2
  186. airbyte_cdk/sources/file_based/discovery_policy/abstract_discovery_policy.py +2 -4
  187. airbyte_cdk/sources/file_based/discovery_policy/default_discovery_policy.py +7 -2
  188. airbyte_cdk/sources/file_based/exceptions.py +18 -15
  189. airbyte_cdk/sources/file_based/file_based_source.py +140 -33
  190. airbyte_cdk/sources/file_based/file_based_stream_reader.py +69 -5
  191. airbyte_cdk/sources/file_based/file_types/__init__.py +14 -1
  192. airbyte_cdk/sources/file_based/file_types/avro_parser.py +75 -24
  193. airbyte_cdk/sources/file_based/file_types/csv_parser.py +116 -34
  194. airbyte_cdk/sources/file_based/file_types/excel_parser.py +196 -0
  195. airbyte_cdk/sources/file_based/file_types/file_transfer.py +37 -0
  196. airbyte_cdk/sources/file_based/file_types/file_type_parser.py +4 -1
  197. airbyte_cdk/sources/file_based/file_types/jsonl_parser.py +24 -8
  198. airbyte_cdk/sources/file_based/file_types/parquet_parser.py +60 -18
  199. airbyte_cdk/sources/file_based/file_types/unstructured_parser.py +141 -41
  200. airbyte_cdk/sources/file_based/remote_file.py +1 -1
  201. airbyte_cdk/sources/file_based/schema_helpers.py +38 -10
  202. airbyte_cdk/sources/file_based/schema_validation_policies/__init__.py +3 -1
  203. airbyte_cdk/sources/file_based/schema_validation_policies/abstract_schema_validation_policy.py +3 -1
  204. airbyte_cdk/sources/file_based/schema_validation_policies/default_schema_validation_policies.py +16 -5
  205. airbyte_cdk/sources/file_based/stream/abstract_file_based_stream.py +50 -13
  206. airbyte_cdk/sources/file_based/stream/concurrent/adapters.py +67 -27
  207. airbyte_cdk/sources/file_based/stream/concurrent/cursor/__init__.py +5 -1
  208. airbyte_cdk/sources/file_based/stream/concurrent/cursor/abstract_concurrent_file_based_cursor.py +14 -23
  209. airbyte_cdk/sources/file_based/stream/concurrent/cursor/file_based_concurrent_cursor.py +54 -18
  210. airbyte_cdk/sources/file_based/stream/concurrent/cursor/file_based_final_state_cursor.py +21 -9
  211. airbyte_cdk/sources/file_based/stream/cursor/abstract_file_based_cursor.py +3 -1
  212. airbyte_cdk/sources/file_based/stream/cursor/default_file_based_cursor.py +27 -10
  213. airbyte_cdk/sources/file_based/stream/default_file_based_stream.py +147 -45
  214. airbyte_cdk/sources/http_logger.py +8 -3
  215. airbyte_cdk/sources/message/__init__.py +7 -1
  216. airbyte_cdk/sources/message/repository.py +18 -4
  217. airbyte_cdk/sources/source.py +42 -38
  218. airbyte_cdk/sources/streams/__init__.py +2 -2
  219. airbyte_cdk/sources/streams/availability_strategy.py +54 -3
  220. airbyte_cdk/sources/streams/call_rate.py +64 -21
  221. airbyte_cdk/sources/streams/checkpoint/__init__.py +26 -0
  222. airbyte_cdk/sources/streams/checkpoint/checkpoint_reader.py +335 -0
  223. airbyte_cdk/sources/{declarative/incremental → streams/checkpoint}/cursor.py +17 -14
  224. airbyte_cdk/sources/streams/checkpoint/per_partition_key_serializer.py +22 -0
  225. airbyte_cdk/sources/streams/checkpoint/resumable_full_refresh_cursor.py +51 -0
  226. airbyte_cdk/sources/streams/checkpoint/substream_resumable_full_refresh_cursor.py +110 -0
  227. airbyte_cdk/sources/streams/concurrent/README.md +7 -0
  228. airbyte_cdk/sources/streams/concurrent/abstract_stream.py +7 -2
  229. airbyte_cdk/sources/streams/concurrent/adapters.py +84 -75
  230. airbyte_cdk/sources/streams/concurrent/availability_strategy.py +30 -2
  231. airbyte_cdk/sources/streams/concurrent/cursor.py +313 -48
  232. airbyte_cdk/sources/streams/concurrent/default_stream.py +12 -3
  233. airbyte_cdk/sources/streams/concurrent/exceptions.py +3 -0
  234. airbyte_cdk/sources/streams/concurrent/helpers.py +14 -3
  235. airbyte_cdk/sources/streams/concurrent/partition_enqueuer.py +12 -3
  236. airbyte_cdk/sources/streams/concurrent/partition_reader.py +10 -3
  237. airbyte_cdk/sources/streams/concurrent/partitions/partition.py +1 -16
  238. airbyte_cdk/sources/streams/concurrent/partitions/stream_slicer.py +21 -0
  239. airbyte_cdk/sources/streams/concurrent/partitions/types.py +15 -5
  240. airbyte_cdk/sources/streams/concurrent/state_converters/abstract_stream_state_converter.py +109 -17
  241. airbyte_cdk/sources/streams/concurrent/state_converters/datetime_stream_state_converter.py +90 -72
  242. airbyte_cdk/sources/streams/core.py +412 -87
  243. airbyte_cdk/sources/streams/http/__init__.py +2 -1
  244. airbyte_cdk/sources/streams/http/availability_strategy.py +12 -101
  245. airbyte_cdk/sources/streams/http/error_handlers/__init__.py +22 -0
  246. airbyte_cdk/sources/streams/http/error_handlers/backoff_strategy.py +28 -0
  247. airbyte_cdk/sources/streams/http/error_handlers/default_backoff_strategy.py +17 -0
  248. airbyte_cdk/sources/streams/http/error_handlers/default_error_mapping.py +86 -0
  249. airbyte_cdk/sources/streams/http/error_handlers/error_handler.py +42 -0
  250. airbyte_cdk/sources/streams/http/error_handlers/error_message_parser.py +19 -0
  251. airbyte_cdk/sources/streams/http/error_handlers/http_status_error_handler.py +110 -0
  252. airbyte_cdk/sources/streams/http/error_handlers/json_error_message_parser.py +52 -0
  253. airbyte_cdk/sources/streams/http/error_handlers/response_models.py +65 -0
  254. airbyte_cdk/sources/streams/http/exceptions.py +27 -7
  255. airbyte_cdk/sources/streams/http/http.py +369 -246
  256. airbyte_cdk/sources/streams/http/http_client.py +531 -0
  257. airbyte_cdk/sources/streams/http/rate_limiting.py +76 -12
  258. airbyte_cdk/sources/streams/http/requests_native_auth/abstract_oauth.py +28 -9
  259. airbyte_cdk/sources/streams/http/requests_native_auth/abstract_token.py +2 -1
  260. airbyte_cdk/sources/streams/http/requests_native_auth/oauth.py +90 -35
  261. airbyte_cdk/sources/streams/http/requests_native_auth/token.py +13 -3
  262. airbyte_cdk/sources/types.py +154 -0
  263. airbyte_cdk/sources/utils/record_helper.py +36 -21
  264. airbyte_cdk/sources/utils/schema_helpers.py +13 -6
  265. airbyte_cdk/sources/utils/slice_logger.py +4 -1
  266. airbyte_cdk/sources/utils/transform.py +54 -20
  267. airbyte_cdk/sql/_util/hashing.py +34 -0
  268. airbyte_cdk/sql/_util/name_normalizers.py +92 -0
  269. airbyte_cdk/sql/constants.py +32 -0
  270. airbyte_cdk/sql/exceptions.py +235 -0
  271. airbyte_cdk/sql/secrets.py +123 -0
  272. airbyte_cdk/sql/shared/__init__.py +15 -0
  273. airbyte_cdk/sql/shared/catalog_providers.py +145 -0
  274. airbyte_cdk/sql/shared/sql_processor.py +786 -0
  275. airbyte_cdk/sql/types.py +160 -0
  276. airbyte_cdk/test/catalog_builder.py +70 -18
  277. airbyte_cdk/test/entrypoint_wrapper.py +117 -42
  278. airbyte_cdk/test/mock_http/__init__.py +1 -1
  279. airbyte_cdk/test/mock_http/matcher.py +6 -0
  280. airbyte_cdk/test/mock_http/mocker.py +57 -10
  281. airbyte_cdk/test/mock_http/request.py +19 -3
  282. airbyte_cdk/test/mock_http/response.py +3 -1
  283. airbyte_cdk/test/mock_http/response_builder.py +32 -16
  284. airbyte_cdk/test/state_builder.py +18 -10
  285. airbyte_cdk/test/utils/__init__.py +1 -0
  286. airbyte_cdk/test/utils/data.py +24 -0
  287. airbyte_cdk/test/utils/http_mocking.py +16 -0
  288. airbyte_cdk/test/utils/manifest_only_fixtures.py +60 -0
  289. airbyte_cdk/test/utils/reading.py +26 -0
  290. airbyte_cdk/utils/__init__.py +2 -1
  291. airbyte_cdk/utils/airbyte_secrets_utils.py +5 -3
  292. airbyte_cdk/utils/analytics_message.py +10 -2
  293. airbyte_cdk/utils/datetime_format_inferrer.py +4 -1
  294. airbyte_cdk/utils/event_timing.py +10 -10
  295. airbyte_cdk/utils/mapping_helpers.py +3 -1
  296. airbyte_cdk/utils/message_utils.py +20 -11
  297. airbyte_cdk/utils/print_buffer.py +75 -0
  298. airbyte_cdk/utils/schema_inferrer.py +198 -28
  299. airbyte_cdk/utils/slice_hasher.py +30 -0
  300. airbyte_cdk/utils/spec_schema_transformations.py +6 -3
  301. airbyte_cdk/utils/stream_status_utils.py +8 -1
  302. airbyte_cdk/utils/traced_exception.py +61 -21
  303. airbyte_cdk-6.17.1.dev1.dist-info/METADATA +109 -0
  304. airbyte_cdk-6.17.1.dev1.dist-info/RECORD +350 -0
  305. {airbyte_cdk-0.72.1.dist-info → airbyte_cdk-6.17.1.dev1.dist-info}/WHEEL +1 -2
  306. airbyte_cdk-6.17.1.dev1.dist-info/entry_points.txt +3 -0
  307. airbyte_cdk/sources/declarative/create_partial.py +0 -92
  308. airbyte_cdk/sources/declarative/parsers/class_types_registry.py +0 -102
  309. airbyte_cdk/sources/declarative/parsers/default_implementation_registry.py +0 -64
  310. airbyte_cdk/sources/declarative/requesters/error_handlers/response_action.py +0 -16
  311. airbyte_cdk/sources/declarative/requesters/error_handlers/response_status.py +0 -68
  312. airbyte_cdk/sources/declarative/stream_slicers/cartesian_product_stream_slicer.py +0 -114
  313. airbyte_cdk/sources/deprecated/base_source.py +0 -94
  314. airbyte_cdk/sources/deprecated/client.py +0 -99
  315. airbyte_cdk/sources/singer/__init__.py +0 -8
  316. airbyte_cdk/sources/singer/singer_helpers.py +0 -304
  317. airbyte_cdk/sources/singer/source.py +0 -186
  318. airbyte_cdk/sources/streams/concurrent/partitions/record.py +0 -23
  319. airbyte_cdk/sources/streams/http/auth/__init__.py +0 -17
  320. airbyte_cdk/sources/streams/http/auth/core.py +0 -29
  321. airbyte_cdk/sources/streams/http/auth/oauth.py +0 -113
  322. airbyte_cdk/sources/streams/http/auth/token.py +0 -47
  323. airbyte_cdk/sources/streams/utils/stream_helper.py +0 -40
  324. airbyte_cdk/sources/utils/catalog_helpers.py +0 -22
  325. airbyte_cdk/sources/utils/schema_models.py +0 -84
  326. airbyte_cdk-0.72.1.dist-info/METADATA +0 -243
  327. airbyte_cdk-0.72.1.dist-info/RECORD +0 -466
  328. airbyte_cdk-0.72.1.dist-info/top_level.txt +0 -3
  329. source_declarative_manifest/main.py +0 -29
  330. unit_tests/connector_builder/__init__.py +0 -3
  331. unit_tests/connector_builder/test_connector_builder_handler.py +0 -871
  332. unit_tests/connector_builder/test_message_grouper.py +0 -713
  333. unit_tests/connector_builder/utils.py +0 -27
  334. unit_tests/destinations/test_destination.py +0 -243
  335. unit_tests/singer/test_singer_helpers.py +0 -56
  336. unit_tests/singer/test_singer_source.py +0 -112
  337. unit_tests/sources/__init__.py +0 -0
  338. unit_tests/sources/concurrent_source/__init__.py +0 -3
  339. unit_tests/sources/concurrent_source/test_concurrent_source_adapter.py +0 -106
  340. unit_tests/sources/declarative/__init__.py +0 -3
  341. unit_tests/sources/declarative/auth/__init__.py +0 -3
  342. unit_tests/sources/declarative/auth/test_oauth.py +0 -331
  343. unit_tests/sources/declarative/auth/test_selective_authenticator.py +0 -39
  344. unit_tests/sources/declarative/auth/test_session_token_auth.py +0 -182
  345. unit_tests/sources/declarative/auth/test_token_auth.py +0 -200
  346. unit_tests/sources/declarative/auth/test_token_provider.py +0 -73
  347. unit_tests/sources/declarative/checks/__init__.py +0 -3
  348. unit_tests/sources/declarative/checks/test_check_stream.py +0 -146
  349. unit_tests/sources/declarative/decoders/__init__.py +0 -0
  350. unit_tests/sources/declarative/decoders/test_json_decoder.py +0 -16
  351. unit_tests/sources/declarative/external_component.py +0 -13
  352. unit_tests/sources/declarative/extractors/__init__.py +0 -3
  353. unit_tests/sources/declarative/extractors/test_dpath_extractor.py +0 -55
  354. unit_tests/sources/declarative/extractors/test_record_filter.py +0 -55
  355. unit_tests/sources/declarative/extractors/test_record_selector.py +0 -179
  356. unit_tests/sources/declarative/incremental/__init__.py +0 -0
  357. unit_tests/sources/declarative/incremental/test_datetime_based_cursor.py +0 -860
  358. unit_tests/sources/declarative/incremental/test_per_partition_cursor.py +0 -406
  359. unit_tests/sources/declarative/incremental/test_per_partition_cursor_integration.py +0 -332
  360. unit_tests/sources/declarative/interpolation/__init__.py +0 -3
  361. unit_tests/sources/declarative/interpolation/test_filters.py +0 -80
  362. unit_tests/sources/declarative/interpolation/test_interpolated_boolean.py +0 -40
  363. unit_tests/sources/declarative/interpolation/test_interpolated_mapping.py +0 -35
  364. unit_tests/sources/declarative/interpolation/test_interpolated_nested_mapping.py +0 -45
  365. unit_tests/sources/declarative/interpolation/test_interpolated_string.py +0 -25
  366. unit_tests/sources/declarative/interpolation/test_jinja.py +0 -240
  367. unit_tests/sources/declarative/interpolation/test_macros.py +0 -73
  368. unit_tests/sources/declarative/parsers/__init__.py +0 -3
  369. unit_tests/sources/declarative/parsers/test_manifest_component_transformer.py +0 -406
  370. unit_tests/sources/declarative/parsers/test_manifest_reference_resolver.py +0 -139
  371. unit_tests/sources/declarative/parsers/test_model_to_component_factory.py +0 -1847
  372. unit_tests/sources/declarative/parsers/testing_components.py +0 -36
  373. unit_tests/sources/declarative/partition_routers/__init__.py +0 -3
  374. unit_tests/sources/declarative/partition_routers/test_list_partition_router.py +0 -155
  375. unit_tests/sources/declarative/partition_routers/test_single_partition_router.py +0 -14
  376. unit_tests/sources/declarative/partition_routers/test_substream_partition_router.py +0 -404
  377. unit_tests/sources/declarative/requesters/__init__.py +0 -3
  378. unit_tests/sources/declarative/requesters/error_handlers/__init__.py +0 -3
  379. unit_tests/sources/declarative/requesters/error_handlers/backoff_strategies/__init__.py +0 -3
  380. unit_tests/sources/declarative/requesters/error_handlers/backoff_strategies/test_constant_backoff.py +0 -34
  381. unit_tests/sources/declarative/requesters/error_handlers/backoff_strategies/test_exponential_backoff.py +0 -36
  382. unit_tests/sources/declarative/requesters/error_handlers/backoff_strategies/test_header_helper.py +0 -38
  383. unit_tests/sources/declarative/requesters/error_handlers/backoff_strategies/test_wait_time_from_header.py +0 -35
  384. unit_tests/sources/declarative/requesters/error_handlers/backoff_strategies/test_wait_until_time_from_header.py +0 -64
  385. unit_tests/sources/declarative/requesters/error_handlers/test_composite_error_handler.py +0 -213
  386. unit_tests/sources/declarative/requesters/error_handlers/test_default_error_handler.py +0 -178
  387. unit_tests/sources/declarative/requesters/error_handlers/test_http_response_filter.py +0 -121
  388. unit_tests/sources/declarative/requesters/error_handlers/test_response_status.py +0 -44
  389. unit_tests/sources/declarative/requesters/paginators/__init__.py +0 -3
  390. unit_tests/sources/declarative/requesters/paginators/test_cursor_pagination_strategy.py +0 -64
  391. unit_tests/sources/declarative/requesters/paginators/test_default_paginator.py +0 -313
  392. unit_tests/sources/declarative/requesters/paginators/test_no_paginator.py +0 -12
  393. unit_tests/sources/declarative/requesters/paginators/test_offset_increment.py +0 -58
  394. unit_tests/sources/declarative/requesters/paginators/test_page_increment.py +0 -70
  395. unit_tests/sources/declarative/requesters/paginators/test_request_option.py +0 -43
  396. unit_tests/sources/declarative/requesters/paginators/test_stop_condition.py +0 -105
  397. unit_tests/sources/declarative/requesters/request_options/__init__.py +0 -3
  398. unit_tests/sources/declarative/requesters/request_options/test_interpolated_request_options_provider.py +0 -101
  399. unit_tests/sources/declarative/requesters/test_http_requester.py +0 -974
  400. unit_tests/sources/declarative/requesters/test_interpolated_request_input_provider.py +0 -32
  401. unit_tests/sources/declarative/retrievers/__init__.py +0 -3
  402. unit_tests/sources/declarative/retrievers/test_simple_retriever.py +0 -542
  403. unit_tests/sources/declarative/schema/__init__.py +0 -6
  404. unit_tests/sources/declarative/schema/source_test/SourceTest.py +0 -8
  405. unit_tests/sources/declarative/schema/source_test/__init__.py +0 -3
  406. unit_tests/sources/declarative/schema/test_default_schema_loader.py +0 -32
  407. unit_tests/sources/declarative/schema/test_inline_schema_loader.py +0 -19
  408. unit_tests/sources/declarative/schema/test_json_file_schema_loader.py +0 -26
  409. unit_tests/sources/declarative/states/__init__.py +0 -3
  410. unit_tests/sources/declarative/stream_slicers/__init__.py +0 -3
  411. unit_tests/sources/declarative/stream_slicers/test_cartesian_product_stream_slicer.py +0 -225
  412. unit_tests/sources/declarative/test_create_partial.py +0 -83
  413. unit_tests/sources/declarative/test_declarative_stream.py +0 -103
  414. unit_tests/sources/declarative/test_manifest_declarative_source.py +0 -1260
  415. unit_tests/sources/declarative/test_types.py +0 -39
  416. unit_tests/sources/declarative/test_yaml_declarative_source.py +0 -148
  417. unit_tests/sources/file_based/__init__.py +0 -0
  418. unit_tests/sources/file_based/availability_strategy/__init__.py +0 -0
  419. unit_tests/sources/file_based/availability_strategy/test_default_file_based_availability_strategy.py +0 -100
  420. unit_tests/sources/file_based/config/__init__.py +0 -0
  421. unit_tests/sources/file_based/config/test_abstract_file_based_spec.py +0 -28
  422. unit_tests/sources/file_based/config/test_csv_format.py +0 -34
  423. unit_tests/sources/file_based/config/test_file_based_stream_config.py +0 -84
  424. unit_tests/sources/file_based/discovery_policy/__init__.py +0 -0
  425. unit_tests/sources/file_based/discovery_policy/test_default_discovery_policy.py +0 -31
  426. unit_tests/sources/file_based/file_types/__init__.py +0 -0
  427. unit_tests/sources/file_based/file_types/test_avro_parser.py +0 -243
  428. unit_tests/sources/file_based/file_types/test_csv_parser.py +0 -546
  429. unit_tests/sources/file_based/file_types/test_jsonl_parser.py +0 -158
  430. unit_tests/sources/file_based/file_types/test_parquet_parser.py +0 -274
  431. unit_tests/sources/file_based/file_types/test_unstructured_parser.py +0 -593
  432. unit_tests/sources/file_based/helpers.py +0 -70
  433. unit_tests/sources/file_based/in_memory_files_source.py +0 -211
  434. unit_tests/sources/file_based/scenarios/__init__.py +0 -0
  435. unit_tests/sources/file_based/scenarios/avro_scenarios.py +0 -744
  436. unit_tests/sources/file_based/scenarios/check_scenarios.py +0 -220
  437. unit_tests/sources/file_based/scenarios/concurrent_incremental_scenarios.py +0 -2844
  438. unit_tests/sources/file_based/scenarios/csv_scenarios.py +0 -3105
  439. unit_tests/sources/file_based/scenarios/file_based_source_builder.py +0 -91
  440. unit_tests/sources/file_based/scenarios/incremental_scenarios.py +0 -1926
  441. unit_tests/sources/file_based/scenarios/jsonl_scenarios.py +0 -930
  442. unit_tests/sources/file_based/scenarios/parquet_scenarios.py +0 -754
  443. unit_tests/sources/file_based/scenarios/scenario_builder.py +0 -234
  444. unit_tests/sources/file_based/scenarios/unstructured_scenarios.py +0 -608
  445. unit_tests/sources/file_based/scenarios/user_input_schema_scenarios.py +0 -746
  446. unit_tests/sources/file_based/scenarios/validation_policy_scenarios.py +0 -726
  447. unit_tests/sources/file_based/stream/__init__.py +0 -0
  448. unit_tests/sources/file_based/stream/concurrent/__init__.py +0 -0
  449. unit_tests/sources/file_based/stream/concurrent/test_adapters.py +0 -362
  450. unit_tests/sources/file_based/stream/concurrent/test_file_based_concurrent_cursor.py +0 -458
  451. unit_tests/sources/file_based/stream/test_default_file_based_cursor.py +0 -310
  452. unit_tests/sources/file_based/stream/test_default_file_based_stream.py +0 -244
  453. unit_tests/sources/file_based/test_file_based_scenarios.py +0 -320
  454. unit_tests/sources/file_based/test_file_based_stream_reader.py +0 -272
  455. unit_tests/sources/file_based/test_scenarios.py +0 -253
  456. unit_tests/sources/file_based/test_schema_helpers.py +0 -346
  457. unit_tests/sources/fixtures/__init__.py +0 -3
  458. unit_tests/sources/fixtures/source_test_fixture.py +0 -153
  459. unit_tests/sources/message/__init__.py +0 -0
  460. unit_tests/sources/message/test_repository.py +0 -153
  461. unit_tests/sources/streams/__init__.py +0 -0
  462. unit_tests/sources/streams/concurrent/__init__.py +0 -3
  463. unit_tests/sources/streams/concurrent/scenarios/__init__.py +0 -3
  464. unit_tests/sources/streams/concurrent/scenarios/incremental_scenarios.py +0 -250
  465. unit_tests/sources/streams/concurrent/scenarios/stream_facade_builder.py +0 -140
  466. unit_tests/sources/streams/concurrent/scenarios/stream_facade_scenarios.py +0 -452
  467. unit_tests/sources/streams/concurrent/scenarios/test_concurrent_scenarios.py +0 -76
  468. unit_tests/sources/streams/concurrent/scenarios/thread_based_concurrent_stream_scenarios.py +0 -418
  469. unit_tests/sources/streams/concurrent/scenarios/thread_based_concurrent_stream_source_builder.py +0 -142
  470. unit_tests/sources/streams/concurrent/scenarios/utils.py +0 -55
  471. unit_tests/sources/streams/concurrent/test_adapters.py +0 -380
  472. unit_tests/sources/streams/concurrent/test_concurrent_read_processor.py +0 -684
  473. unit_tests/sources/streams/concurrent/test_cursor.py +0 -139
  474. unit_tests/sources/streams/concurrent/test_datetime_state_converter.py +0 -369
  475. unit_tests/sources/streams/concurrent/test_default_stream.py +0 -197
  476. unit_tests/sources/streams/concurrent/test_partition_enqueuer.py +0 -90
  477. unit_tests/sources/streams/concurrent/test_partition_reader.py +0 -67
  478. unit_tests/sources/streams/concurrent/test_thread_pool_manager.py +0 -106
  479. unit_tests/sources/streams/http/__init__.py +0 -0
  480. unit_tests/sources/streams/http/auth/__init__.py +0 -0
  481. unit_tests/sources/streams/http/auth/test_auth.py +0 -173
  482. unit_tests/sources/streams/http/requests_native_auth/__init__.py +0 -0
  483. unit_tests/sources/streams/http/requests_native_auth/test_requests_native_auth.py +0 -423
  484. unit_tests/sources/streams/http/test_availability_strategy.py +0 -180
  485. unit_tests/sources/streams/http/test_http.py +0 -635
  486. unit_tests/sources/streams/test_availability_strategy.py +0 -70
  487. unit_tests/sources/streams/test_call_rate.py +0 -300
  488. unit_tests/sources/streams/test_stream_read.py +0 -405
  489. unit_tests/sources/streams/test_streams_core.py +0 -184
  490. unit_tests/sources/test_abstract_source.py +0 -1442
  491. unit_tests/sources/test_concurrent_source.py +0 -112
  492. unit_tests/sources/test_config.py +0 -92
  493. unit_tests/sources/test_connector_state_manager.py +0 -482
  494. unit_tests/sources/test_http_logger.py +0 -252
  495. unit_tests/sources/test_integration_source.py +0 -86
  496. unit_tests/sources/test_source.py +0 -684
  497. unit_tests/sources/test_source_read.py +0 -460
  498. unit_tests/test/__init__.py +0 -0
  499. unit_tests/test/mock_http/__init__.py +0 -0
  500. unit_tests/test/mock_http/test_matcher.py +0 -53
  501. unit_tests/test/mock_http/test_mocker.py +0 -214
  502. unit_tests/test/mock_http/test_request.py +0 -117
  503. unit_tests/test/mock_http/test_response_builder.py +0 -177
  504. unit_tests/test/test_entrypoint_wrapper.py +0 -240
  505. unit_tests/utils/__init__.py +0 -0
  506. unit_tests/utils/test_datetime_format_inferrer.py +0 -60
  507. unit_tests/utils/test_mapping_helpers.py +0 -54
  508. unit_tests/utils/test_message_utils.py +0 -91
  509. unit_tests/utils/test_rate_limiting.py +0 -26
  510. unit_tests/utils/test_schema_inferrer.py +0 -202
  511. unit_tests/utils/test_secret_utils.py +0 -135
  512. unit_tests/utils/test_stream_status_utils.py +0 -61
  513. unit_tests/utils/test_traced_exception.py +0 -107
  514. /airbyte_cdk/sources/{deprecated → declarative/async_job}/__init__.py +0 -0
  515. {source_declarative_manifest → airbyte_cdk/sources/declarative/migrations}/__init__.py +0 -0
  516. {unit_tests/destinations → airbyte_cdk/sql}/__init__.py +0 -0
  517. {unit_tests/singer → airbyte_cdk/sql/_util}/__init__.py +0 -0
  518. {airbyte_cdk-0.72.1.dist-info → airbyte_cdk-6.17.1.dev1.dist-info}/LICENSE.txt +0 -0
@@ -2,109 +2,167 @@
2
2
  # Copyright (c) 2023 Airbyte, Inc., all rights reserved.
3
3
  #
4
4
 
5
- import json
6
- from typing import Any, Callable, Iterable, Mapping, MutableMapping, Optional, Union
5
+ import logging
6
+ from collections import OrderedDict
7
+ from typing import Any, Callable, Iterable, Mapping, Optional, Union
7
8
 
8
- from airbyte_cdk.sources.declarative.incremental.cursor import Cursor
9
- from airbyte_cdk.sources.declarative.stream_slicers.stream_slicer import StreamSlicer
10
- from airbyte_cdk.sources.declarative.types import Record, StreamSlice, StreamState
9
+ from airbyte_cdk.sources.declarative.incremental.declarative_cursor import DeclarativeCursor
10
+ from airbyte_cdk.sources.declarative.partition_routers.partition_router import PartitionRouter
11
+ from airbyte_cdk.sources.streams.checkpoint.per_partition_key_serializer import (
12
+ PerPartitionKeySerializer,
13
+ )
14
+ from airbyte_cdk.sources.types import Record, StreamSlice, StreamState
11
15
 
12
-
13
- class PerPartitionKeySerializer:
14
- """
15
- We are concerned of the performance of looping through the `states` list and evaluating equality on the partition. To reduce this
16
- concern, we wanted to use dictionaries to map `partition -> cursor`. However, partitions are dict and dict can't be used as dict keys
17
- since they are not hashable. By creating json string using the dict, we can have a use the dict as a key to the dict since strings are
18
- hashable.
19
- """
20
-
21
- @staticmethod
22
- def to_partition_key(to_serialize: Any) -> str:
23
- # separators have changed in Python 3.4. To avoid being impacted by further change, we explicitly specify our own value
24
- return json.dumps(to_serialize, indent=None, separators=(",", ":"), sort_keys=True)
25
-
26
- @staticmethod
27
- def to_partition(to_deserialize: Any) -> Mapping[str, Any]:
28
- return json.loads(to_deserialize) # type: ignore # The partition is known to be a dict, but the type hint is Any
16
+ logger = logging.getLogger("airbyte")
29
17
 
30
18
 
31
19
  class CursorFactory:
32
- def __init__(self, create_function: Callable[[], Cursor]):
20
+ def __init__(self, create_function: Callable[[], DeclarativeCursor]):
33
21
  self._create_function = create_function
34
22
 
35
- def create(self) -> Cursor:
23
+ def create(self) -> DeclarativeCursor:
36
24
  return self._create_function()
37
25
 
38
26
 
39
- class PerPartitionCursor(Cursor):
27
+ class PerPartitionCursor(DeclarativeCursor):
40
28
  """
41
- Given a stream has many partitions, it is important to provide a state per partition.
42
-
43
- Record | Stream Slice | Last Record | DatetimeCursorBased cursor
44
- -- | -- | -- | --
45
- 1 | {"start_time": "2021-01-01","end_time": "2021-01-31","owner_resource": "1"''} | cursor_field: “2021-01-15” | 2021-01-15
46
- 2 | {"start_time": "2021-02-01","end_time": "2021-02-28","owner_resource": "1"''} | cursor_field: “2021-02-15” | 2021-02-15
47
- 3 | {"start_time": "2021-01-01","end_time": "2021-01-31","owner_resource": "2"''} | cursor_field: “2021-01-03” | 2021-01-03
48
- 4 | {"start_time": "2021-02-01","end_time": "2021-02-28","owner_resource": "2"''} | cursor_field: “2021-02-14” | 2021-02-14
49
-
50
- Given the following errors, this can lead to some loss or duplication of records:
51
- When | Problem | Affected Record
52
- -- | -- | --
53
- Between record #1 and #2 | Loss | #3
54
- Between record #2 and #3 | Loss | #3, #4
55
- Between record #3 and #4 | Duplication | #1, #2
56
-
57
- Therefore, we need to manage state per partition.
29
+ Manages state per partition when a stream has many partitions, to prevent data loss or duplication.
30
+
31
+ **Partition Limitation and Limit Reached Logic**
32
+
33
+ - **DEFAULT_MAX_PARTITIONS_NUMBER**: The maximum number of partitions to keep in memory (default is 10,000).
34
+ - **_cursor_per_partition**: An ordered dictionary that stores cursors for each partition.
35
+ - **_over_limit**: A counter that increments each time an oldest partition is removed when the limit is exceeded.
36
+
37
+ The class ensures that the number of partitions tracked does not exceed the `DEFAULT_MAX_PARTITIONS_NUMBER` to prevent excessive memory usage.
38
+
39
+ - When the number of partitions exceeds the limit, the oldest partitions are removed from `_cursor_per_partition`, and `_over_limit` is incremented accordingly.
40
+ - The `limit_reached` method returns `True` when `_over_limit` exceeds `DEFAULT_MAX_PARTITIONS_NUMBER`, indicating that the global cursor should be used instead of per-partition cursors.
41
+
42
+ This approach avoids unnecessary switching to a global cursor due to temporary spikes in partition counts, ensuring that switching is only done when a sustained high number of partitions is observed.
58
43
  """
59
44
 
45
+ DEFAULT_MAX_PARTITIONS_NUMBER = 10000
60
46
  _NO_STATE: Mapping[str, Any] = {}
61
47
  _NO_CURSOR_STATE: Mapping[str, Any] = {}
62
48
  _KEY = 0
63
49
  _VALUE = 1
50
+ _state_to_migrate_from: Mapping[str, Any] = {}
64
51
 
65
- def __init__(self, cursor_factory: CursorFactory, partition_router: StreamSlicer):
52
+ def __init__(self, cursor_factory: CursorFactory, partition_router: PartitionRouter):
66
53
  self._cursor_factory = cursor_factory
67
54
  self._partition_router = partition_router
68
- self._cursor_per_partition: MutableMapping[str, Cursor] = {}
55
+ # The dict is ordered to ensure that once the maximum number of partitions is reached,
56
+ # the oldest partitions can be efficiently removed, maintaining the most recent partitions.
57
+ self._cursor_per_partition: OrderedDict[str, DeclarativeCursor] = OrderedDict()
58
+ self._over_limit = 0
69
59
  self._partition_serializer = PerPartitionKeySerializer()
70
60
 
71
61
  def stream_slices(self) -> Iterable[StreamSlice]:
72
62
  slices = self._partition_router.stream_slices()
73
63
  for partition in slices:
74
- cursor = self._cursor_per_partition.get(self._to_partition_key(partition.partition))
75
- if not cursor:
76
- cursor = self._create_cursor(self._NO_CURSOR_STATE)
77
- self._cursor_per_partition[self._to_partition_key(partition.partition)] = cursor
64
+ yield from self.generate_slices_from_partition(partition)
65
+
66
+ def generate_slices_from_partition(self, partition: StreamSlice) -> Iterable[StreamSlice]:
67
+ # Ensure the maximum number of partitions is not exceeded
68
+ self._ensure_partition_limit()
69
+
70
+ cursor = self._cursor_per_partition.get(self._to_partition_key(partition.partition))
71
+ if not cursor:
72
+ partition_state = (
73
+ self._state_to_migrate_from
74
+ if self._state_to_migrate_from
75
+ else self._NO_CURSOR_STATE
76
+ )
77
+ cursor = self._create_cursor(partition_state)
78
+ self._cursor_per_partition[self._to_partition_key(partition.partition)] = cursor
78
79
 
79
- for cursor_slice in cursor.stream_slices():
80
- yield StreamSlice(partition=partition, cursor_slice=cursor_slice)
80
+ for cursor_slice in cursor.stream_slices():
81
+ yield StreamSlice(
82
+ partition=partition, cursor_slice=cursor_slice, extra_fields=partition.extra_fields
83
+ )
84
+
85
+ def _ensure_partition_limit(self) -> None:
86
+ """
87
+ Ensure the maximum number of partitions is not exceeded. If so, the oldest added partition will be dropped.
88
+ """
89
+ while len(self._cursor_per_partition) > self.DEFAULT_MAX_PARTITIONS_NUMBER - 1:
90
+ self._over_limit += 1
91
+ oldest_partition = self._cursor_per_partition.popitem(last=False)[
92
+ 0
93
+ ] # Remove the oldest partition
94
+ logger.warning(
95
+ f"The maximum number of partitions has been reached. Dropping the oldest partition: {oldest_partition}. Over limit: {self._over_limit}."
96
+ )
97
+
98
+ def limit_reached(self) -> bool:
99
+ return self._over_limit > self.DEFAULT_MAX_PARTITIONS_NUMBER
81
100
 
82
101
  def set_initial_state(self, stream_state: StreamState) -> None:
102
+ """
103
+ Set the initial state for the cursors.
104
+
105
+ This method initializes the state for each partition cursor using the provided stream state.
106
+ If a partition state is provided in the stream state, it will update the corresponding partition cursor with this state.
107
+
108
+ Additionally, it sets the parent state for partition routers that are based on parent streams. If a partition router
109
+ does not have parent streams, this step will be skipped due to the default PartitionRouter implementation.
110
+
111
+ Args:
112
+ stream_state (StreamState): The state of the streams to be set. The format of the stream state should be:
113
+ {
114
+ "states": [
115
+ {
116
+ "partition": {
117
+ "partition_key": "value"
118
+ },
119
+ "cursor": {
120
+ "last_updated": "2023-05-27T00:00:00Z"
121
+ }
122
+ }
123
+ ],
124
+ "parent_state": {
125
+ "parent_stream_name": {
126
+ "last_updated": "2023-05-27T00:00:00Z"
127
+ }
128
+ }
129
+ }
130
+ """
83
131
  if not stream_state:
84
132
  return
85
133
 
86
- for state in stream_state["states"]:
87
- self._cursor_per_partition[self._to_partition_key(state["partition"])] = self._create_cursor(state["cursor"])
134
+ if "states" not in stream_state:
135
+ # We assume that `stream_state` is in a global format that can be applied to all partitions.
136
+ # Example: {"global_state_format_key": "global_state_format_value"}
137
+ self._state_to_migrate_from = stream_state
138
+
139
+ else:
140
+ for state in stream_state["states"]:
141
+ self._cursor_per_partition[self._to_partition_key(state["partition"])] = (
142
+ self._create_cursor(state["cursor"])
143
+ )
144
+
145
+ # set default state for missing partitions if it is per partition with fallback to global
146
+ if "state" in stream_state:
147
+ self._state_to_migrate_from = stream_state["state"]
148
+
149
+ # Set parent state for partition routers based on parent streams
150
+ self._partition_router.set_initial_state(stream_state)
88
151
 
89
152
  def observe(self, stream_slice: StreamSlice, record: Record) -> None:
90
153
  self._cursor_per_partition[self._to_partition_key(stream_slice.partition)].observe(
91
154
  StreamSlice(partition={}, cursor_slice=stream_slice.cursor_slice), record
92
155
  )
93
156
 
94
- def close_slice(self, stream_slice: StreamSlice, most_recent_record: Optional[Record]) -> None:
157
+ def close_slice(self, stream_slice: StreamSlice, *args: Any) -> None:
95
158
  try:
96
- cursor_most_recent_record = (
97
- Record(most_recent_record.data, StreamSlice(partition={}, cursor_slice=stream_slice.cursor_slice))
98
- if most_recent_record
99
- else most_recent_record
100
- )
101
159
  self._cursor_per_partition[self._to_partition_key(stream_slice.partition)].close_slice(
102
- StreamSlice(partition={}, cursor_slice=stream_slice.cursor_slice), cursor_most_recent_record
160
+ StreamSlice(partition={}, cursor_slice=stream_slice.cursor_slice), *args
103
161
  )
104
162
  except KeyError as exception:
105
163
  raise ValueError(
106
164
  f"Partition {str(exception)} could not be found in current state based on the record. This is unexpected because "
107
- f"we should only update state for partition that where emitted during `stream_slices`"
165
+ f"we should only update state for partitions that were emitted during `stream_slices`"
108
166
  )
109
167
 
110
168
  def get_stream_state(self) -> StreamState:
@@ -118,7 +176,12 @@ class PerPartitionCursor(Cursor):
118
176
  "cursor": cursor_state,
119
177
  }
120
178
  )
121
- return {"states": states}
179
+ state: dict[str, Any] = {"states": states}
180
+
181
+ parent_state = self._partition_router.get_stream_state()
182
+ if parent_state:
183
+ state["parent_state"] = parent_state
184
+ return state
122
185
 
123
186
  def _get_state_for_partition(self, partition: Mapping[str, Any]) -> Optional[StreamState]:
124
187
  cursor = self._cursor_per_partition.get(self._to_partition_key(partition))
@@ -146,7 +209,7 @@ class PerPartitionCursor(Cursor):
146
209
 
147
210
  return self._get_state_for_partition(stream_slice.partition)
148
211
 
149
- def _create_cursor(self, cursor_state: Any) -> Cursor:
212
+ def _create_cursor(self, cursor_state: Any) -> DeclarativeCursor:
150
213
  cursor = self._cursor_factory.create()
151
214
  cursor.set_initial_state(cursor_state)
152
215
  return cursor
@@ -163,7 +226,9 @@ class PerPartitionCursor(Cursor):
163
226
  stream_state=stream_state,
164
227
  stream_slice=StreamSlice(partition=stream_slice.partition, cursor_slice={}),
165
228
  next_page_token=next_page_token,
166
- ) | self._cursor_per_partition[self._to_partition_key(stream_slice.partition)].get_request_params(
229
+ ) | self._cursor_per_partition[
230
+ self._to_partition_key(stream_slice.partition)
231
+ ].get_request_params(
167
232
  stream_state=stream_state,
168
233
  stream_slice=StreamSlice(partition={}, cursor_slice=stream_slice.cursor_slice),
169
234
  next_page_token=next_page_token,
@@ -183,7 +248,9 @@ class PerPartitionCursor(Cursor):
183
248
  stream_state=stream_state,
184
249
  stream_slice=StreamSlice(partition=stream_slice.partition, cursor_slice={}),
185
250
  next_page_token=next_page_token,
186
- ) | self._cursor_per_partition[self._to_partition_key(stream_slice.partition)].get_request_headers(
251
+ ) | self._cursor_per_partition[
252
+ self._to_partition_key(stream_slice.partition)
253
+ ].get_request_headers(
187
254
  stream_state=stream_state,
188
255
  stream_slice=StreamSlice(partition={}, cursor_slice=stream_slice.cursor_slice),
189
256
  next_page_token=next_page_token,
@@ -203,7 +270,9 @@ class PerPartitionCursor(Cursor):
203
270
  stream_state=stream_state,
204
271
  stream_slice=StreamSlice(partition=stream_slice.partition, cursor_slice={}),
205
272
  next_page_token=next_page_token,
206
- ) | self._cursor_per_partition[self._to_partition_key(stream_slice.partition)].get_request_body_data(
273
+ ) | self._cursor_per_partition[
274
+ self._to_partition_key(stream_slice.partition)
275
+ ].get_request_body_data(
207
276
  stream_state=stream_state,
208
277
  stream_slice=StreamSlice(partition={}, cursor_slice=stream_slice.cursor_slice),
209
278
  next_page_token=next_page_token,
@@ -223,7 +292,9 @@ class PerPartitionCursor(Cursor):
223
292
  stream_state=stream_state,
224
293
  stream_slice=StreamSlice(partition=stream_slice.partition, cursor_slice={}),
225
294
  next_page_token=next_page_token,
226
- ) | self._cursor_per_partition[self._to_partition_key(stream_slice.partition)].get_request_body_json(
295
+ ) | self._cursor_per_partition[
296
+ self._to_partition_key(stream_slice.partition)
297
+ ].get_request_body_json(
227
298
  stream_state=stream_state,
228
299
  stream_slice=StreamSlice(partition={}, cursor_slice=stream_slice.cursor_slice),
229
300
  next_page_token=next_page_token,
@@ -232,32 +303,61 @@ class PerPartitionCursor(Cursor):
232
303
  raise ValueError("A partition needs to be provided in order to get request body json")
233
304
 
234
305
  def should_be_synced(self, record: Record) -> bool:
235
- return self._get_cursor(record).should_be_synced(self._convert_record_to_cursor_record(record))
306
+ if (
307
+ record.associated_slice
308
+ and self._to_partition_key(record.associated_slice.partition)
309
+ not in self._cursor_per_partition
310
+ ):
311
+ partition_state = (
312
+ self._state_to_migrate_from
313
+ if self._state_to_migrate_from
314
+ else self._NO_CURSOR_STATE
315
+ )
316
+ cursor = self._create_cursor(partition_state)
317
+
318
+ self._cursor_per_partition[
319
+ self._to_partition_key(record.associated_slice.partition)
320
+ ] = cursor
321
+ return self._get_cursor(record).should_be_synced(
322
+ self._convert_record_to_cursor_record(record)
323
+ )
236
324
 
237
325
  def is_greater_than_or_equal(self, first: Record, second: Record) -> bool:
238
326
  if not first.associated_slice or not second.associated_slice:
239
- raise ValueError(f"Both records should have an associated slice but got {first.associated_slice} and {second.associated_slice}")
327
+ raise ValueError(
328
+ f"Both records should have an associated slice but got {first.associated_slice} and {second.associated_slice}"
329
+ )
240
330
  if first.associated_slice.partition != second.associated_slice.partition:
241
331
  raise ValueError(
242
332
  f"To compare records, partition should be the same but got {first.associated_slice.partition} and {second.associated_slice.partition}"
243
333
  )
244
334
 
245
335
  return self._get_cursor(first).is_greater_than_or_equal(
246
- self._convert_record_to_cursor_record(first), self._convert_record_to_cursor_record(second)
336
+ self._convert_record_to_cursor_record(first),
337
+ self._convert_record_to_cursor_record(second),
247
338
  )
248
339
 
249
340
  @staticmethod
250
341
  def _convert_record_to_cursor_record(record: Record) -> Record:
251
342
  return Record(
252
- record.data,
253
- StreamSlice(partition={}, cursor_slice=record.associated_slice.cursor_slice) if record.associated_slice else None,
343
+ data=record.data,
344
+ stream_name=record.stream_name,
345
+ associated_slice=StreamSlice(
346
+ partition={}, cursor_slice=record.associated_slice.cursor_slice
347
+ )
348
+ if record.associated_slice
349
+ else None,
254
350
  )
255
351
 
256
- def _get_cursor(self, record: Record) -> Cursor:
352
+ def _get_cursor(self, record: Record) -> DeclarativeCursor:
257
353
  if not record.associated_slice:
258
- raise ValueError("Invalid state as stream slices that are emitted should refer to an existing cursor")
354
+ raise ValueError(
355
+ "Invalid state as stream slices that are emitted should refer to an existing cursor"
356
+ )
259
357
  partition_key = self._to_partition_key(record.associated_slice.partition)
260
358
  if partition_key not in self._cursor_per_partition:
261
- raise ValueError("Invalid state as stream slices that are emitted should refer to an existing cursor")
359
+ raise ValueError(
360
+ "Invalid state as stream slices that are emitted should refer to an existing cursor"
361
+ )
262
362
  cursor = self._cursor_per_partition[partition_key]
263
363
  return cursor
@@ -0,0 +1,200 @@
1
+ #
2
+ # Copyright (c) 2023 Airbyte, Inc., all rights reserved.
3
+ #
4
+ from typing import Any, Iterable, Mapping, MutableMapping, Optional, Union
5
+
6
+ from airbyte_cdk.sources.declarative.incremental.datetime_based_cursor import DatetimeBasedCursor
7
+ from airbyte_cdk.sources.declarative.incremental.declarative_cursor import DeclarativeCursor
8
+ from airbyte_cdk.sources.declarative.incremental.global_substream_cursor import (
9
+ GlobalSubstreamCursor,
10
+ iterate_with_last_flag_and_state,
11
+ )
12
+ from airbyte_cdk.sources.declarative.incremental.per_partition_cursor import (
13
+ CursorFactory,
14
+ PerPartitionCursor,
15
+ )
16
+ from airbyte_cdk.sources.declarative.partition_routers.partition_router import PartitionRouter
17
+ from airbyte_cdk.sources.types import Record, StreamSlice, StreamState
18
+
19
+
20
+ class PerPartitionWithGlobalCursor(DeclarativeCursor):
21
+ """
22
+ Manages state for streams with multiple partitions, with an optional fallback to a global cursor when specific conditions are met.
23
+
24
+ This cursor handles partitioned streams by maintaining individual state per partition using `PerPartitionCursor`. If the number of partitions exceeds a defined limit, it switches to a global cursor (`GlobalSubstreamCursor`) to manage state more efficiently.
25
+
26
+ **Overview**
27
+
28
+ - **Partition-Based State**: Initially manages state per partition to ensure accurate processing of each partition's data.
29
+ - **Global Fallback**: Switches to a global cursor when the partition limit is exceeded to handle state management more effectively.
30
+
31
+ **Switching Logic**
32
+
33
+ - Monitors the number of partitions.
34
+ - If `PerPartitionCursor.limit_reached()` returns `True`, sets `_use_global_cursor` to `True`, activating the global cursor.
35
+
36
+ **Active Cursor Selection**
37
+
38
+ - Uses the `_get_active_cursor()` helper method to select the active cursor based on the `_use_global_cursor` flag.
39
+ - This simplifies the logic and ensures consistent cursor usage across methods.
40
+
41
+ **State Structure Example**
42
+
43
+ ```json
44
+ {
45
+ "states": [
46
+ {
47
+ "partition": {"partition_key": "partition_1"},
48
+ "cursor": {"cursor_field": "2021-01-15"}
49
+ },
50
+ {
51
+ "partition": {"partition_key": "partition_2"},
52
+ "cursor": {"cursor_field": "2021-02-14"}
53
+ }
54
+ ],
55
+ "state": {
56
+ "cursor_field": "2021-02-15"
57
+ },
58
+ "use_global_cursor": false
59
+ }
60
+ ```
61
+
62
+ In this example, the cursor is using partition-based state management (`"use_global_cursor": false`), maintaining separate cursor states for each partition.
63
+
64
+ **Usage Scenario**
65
+
66
+ Suitable for streams where the number of partitions may vary significantly, requiring dynamic switching between per-partition and global state management to ensure data consistency and efficient synchronization.
67
+ """
68
+
69
+ def __init__(
70
+ self,
71
+ cursor_factory: CursorFactory,
72
+ partition_router: PartitionRouter,
73
+ stream_cursor: DatetimeBasedCursor,
74
+ ):
75
+ self._partition_router = partition_router
76
+ self._per_partition_cursor = PerPartitionCursor(cursor_factory, partition_router)
77
+ self._global_cursor = GlobalSubstreamCursor(stream_cursor, partition_router)
78
+ self._use_global_cursor = False
79
+ self._current_partition: Optional[Mapping[str, Any]] = None
80
+ self._last_slice: bool = False
81
+ self._parent_state: Optional[Mapping[str, Any]] = None
82
+
83
+ def _get_active_cursor(self) -> Union[PerPartitionCursor, GlobalSubstreamCursor]:
84
+ return self._global_cursor if self._use_global_cursor else self._per_partition_cursor
85
+
86
+ def stream_slices(self) -> Iterable[StreamSlice]:
87
+ self._global_cursor.start_slices_generation()
88
+
89
+ # Iterate through partitions and process slices
90
+ for partition, is_last_partition, parent_state in iterate_with_last_flag_and_state(
91
+ self._partition_router.stream_slices(), self._partition_router.get_stream_state
92
+ ):
93
+ # Generate slices for the current cursor and handle the last slice using the flag
94
+ self._parent_state = parent_state
95
+ for slice, is_last_slice, _ in iterate_with_last_flag_and_state(
96
+ self._get_active_cursor().generate_slices_from_partition(partition=partition),
97
+ lambda: None,
98
+ ):
99
+ self._global_cursor.register_slice(is_last_slice and is_last_partition)
100
+ yield slice
101
+ self._parent_state = self._partition_router.get_stream_state()
102
+
103
+ def set_initial_state(self, stream_state: StreamState) -> None:
104
+ """
105
+ Set the initial state for the cursors.
106
+ """
107
+ self._use_global_cursor = stream_state.get("use_global_cursor", False)
108
+
109
+ self._parent_state = stream_state.get("parent_state", {})
110
+
111
+ self._global_cursor.set_initial_state(stream_state)
112
+ if not self._use_global_cursor:
113
+ self._per_partition_cursor.set_initial_state(stream_state)
114
+
115
+ def observe(self, stream_slice: StreamSlice, record: Record) -> None:
116
+ if not self._use_global_cursor and self._per_partition_cursor.limit_reached():
117
+ self._use_global_cursor = True
118
+
119
+ if not self._use_global_cursor:
120
+ self._per_partition_cursor.observe(stream_slice, record)
121
+ self._global_cursor.observe(stream_slice, record)
122
+
123
+ def close_slice(self, stream_slice: StreamSlice, *args: Any) -> None:
124
+ if not self._use_global_cursor:
125
+ self._per_partition_cursor.close_slice(stream_slice, *args)
126
+ self._global_cursor.close_slice(stream_slice, *args)
127
+
128
+ def get_stream_state(self) -> StreamState:
129
+ final_state: MutableMapping[str, Any] = {"use_global_cursor": self._use_global_cursor}
130
+
131
+ final_state.update(self._global_cursor.get_stream_state())
132
+ if not self._use_global_cursor:
133
+ final_state.update(self._per_partition_cursor.get_stream_state())
134
+
135
+ final_state["parent_state"] = self._parent_state
136
+ if not final_state.get("parent_state"):
137
+ del final_state["parent_state"]
138
+
139
+ return final_state
140
+
141
+ def select_state(self, stream_slice: Optional[StreamSlice] = None) -> Optional[StreamState]:
142
+ return self._get_active_cursor().select_state(stream_slice)
143
+
144
+ def get_request_params(
145
+ self,
146
+ *,
147
+ stream_state: Optional[StreamState] = None,
148
+ stream_slice: Optional[StreamSlice] = None,
149
+ next_page_token: Optional[Mapping[str, Any]] = None,
150
+ ) -> Mapping[str, Any]:
151
+ return self._get_active_cursor().get_request_params(
152
+ stream_state=stream_state,
153
+ stream_slice=stream_slice,
154
+ next_page_token=next_page_token,
155
+ )
156
+
157
+ def get_request_headers(
158
+ self,
159
+ *,
160
+ stream_state: Optional[StreamState] = None,
161
+ stream_slice: Optional[StreamSlice] = None,
162
+ next_page_token: Optional[Mapping[str, Any]] = None,
163
+ ) -> Mapping[str, Any]:
164
+ return self._get_active_cursor().get_request_headers(
165
+ stream_state=stream_state,
166
+ stream_slice=stream_slice,
167
+ next_page_token=next_page_token,
168
+ )
169
+
170
+ def get_request_body_data(
171
+ self,
172
+ *,
173
+ stream_state: Optional[StreamState] = None,
174
+ stream_slice: Optional[StreamSlice] = None,
175
+ next_page_token: Optional[Mapping[str, Any]] = None,
176
+ ) -> Union[Mapping[str, Any], str]:
177
+ return self._get_active_cursor().get_request_body_data(
178
+ stream_state=stream_state,
179
+ stream_slice=stream_slice,
180
+ next_page_token=next_page_token,
181
+ )
182
+
183
+ def get_request_body_json(
184
+ self,
185
+ *,
186
+ stream_state: Optional[StreamState] = None,
187
+ stream_slice: Optional[StreamSlice] = None,
188
+ next_page_token: Optional[Mapping[str, Any]] = None,
189
+ ) -> Mapping[str, Any]:
190
+ return self._get_active_cursor().get_request_body_json(
191
+ stream_state=stream_state,
192
+ stream_slice=stream_slice,
193
+ next_page_token=next_page_token,
194
+ )
195
+
196
+ def should_be_synced(self, record: Record) -> bool:
197
+ return self._get_active_cursor().should_be_synced(record)
198
+
199
+ def is_greater_than_or_equal(self, first: Record, second: Record) -> bool:
200
+ return self._global_cursor.is_greater_than_or_equal(first, second)