Skip to main content

CheckStream

Defines the streams to try reading when running a check operation.

  • type: object
  • required: ["type"]

type​

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

stream_names​

Names of the streams to try reading from when running a check operation.

  • Required: No
  • type: array

Examples:

- users
- users
- contacts

  • items:

    • type: string

dynamic_streams_check_configs​

config_overrides​

Values overlaid onto the connector config for the duration of the check operation only. Use this when a check must behave differently from a sync - for example a shorter rate limit wait budget, so that check fails fast with a clear message instead of sleeping until the quota resets. Keys should be fields declared in the connector's spec. Values are used as-is. They are not interpolated, a $ref inside them is not resolved, they replace a nested object rather than deep-merging into it, and they are applied after config migrations and transformations have run, so a field derived from an overridden field is not recomputed. Keys must be strings, and two combinations are rejected outright. Keys prefixed with __airbyte belong to the platform rather than to the connector's spec. And a manifest that declares a refresh_token_updater cannot use this field at all, because a token refresh during check emits the whole config it was handed as a CONNECTOR_CONFIG control message, which the platform persists - so a check-only override would become the connection's saved config and apply to every later sync.

  • Required: No
  • type: object

Examples:

max_waiting_time: 0
page_size: 1
Was this page helpful?