Skip to content

Connect a Source

A source is a named connection to a provider. --source postgres plus "sourceKey": "warehouse" creates the identifier postgres://warehouse.

  1. Pick the provider.

    Terminal window
    onequery source connect --help
  2. Ask for provider-specific setup guidance.

    Terminal window
    onequery source connect --source postgres
  3. Build the input payload with a read-only credential.

    {
    "sourceKey": "warehouse",
    "credentials": {
    "host": "db.example.com",
    "port": 5432,
    "database": "app",
    "username": "onequery_readonly",
    "password": "<read-only-password>",
    "sslMode": "require"
    }
    }
  4. Connect the source.

    Terminal window
    onequery source connect --source postgres \
    --input '{"sourceKey":"warehouse","credentials":{"host":"db.example.com","port":5432,"database":"app","username":"onequery_readonly","password":"<read-only-password>","sslMode":"require"}}'
  5. Confirm the source appears.

    Terminal window
    onequery source list
  • Prefer read-only users or provider tokens.
  • Create separate OneQuery sources for production, staging, and customer data.
  • Rotate provider credentials outside the agent runtime.
  • Do not paste source credentials into prompts or task descriptions.

Use the integration pages for provider-specific patterns: