Orb Source Plugin

Authentication #

Example Configuration #

kind: source
spec:
  name: "orb"
  path: "cloudquery/orb"
  registry: cloudquery
  version: "v1.2.4"
  destinations: ["postgresql"]
  tables: ["*"]
  # Learn more about the configuration options at https://cql.ink/orb_source
  spec:
    api_key: ${ORB_API_KEY}
    # Optional:
    # page_fetch_limit: 500
    # max_retries: 3
    # timeframe_start: 2023-01-01T00:00:00Z
    # timeframe_end: 2024-01-01T00:00:00Z
    # concurrency: 50000

Configuration Reference #

• api_key (string) (required)

  Orb API key to authenticate with (recommendation: Use environment variable instead of hardcoded the key in the config).
• page_fetch_limit (integer) (optional, default: 500)

  The maximum number of items to fetch in a single request.
• max_retries (integer) (optional, default: 3)

  The maximum number of times to retry a failed request.
• timeframe_start (string) (optional)

  A date-time string in RFC3339 format. For example, "2024-01-01T00:00:00Z" will sync all items created on or after January 1, 2024. If not specified, the plugin will fetch items from the past year.
• timeframe_end (string) (optional)

  A date-time string in RFC3339 format. For example, "2024-01-01T00:00:00Z" will sync all items created before January 1, 2024. If not specified, the plugin will fetch items up to the current time.
• concurrency (integer, optional, default: 50000) A best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
• scheduler (string, optional, default: dfs) The scheduler to use when determining the priority of resources to sync. Supported values are dfs (depth-first search), round-robin, shuffle and shuffle-queue.

  For more information about this, see performance tuning.