Skip to content

Terminology

TermMeansExample
AgentA tool that can invoke OneQuery commands for approved context.Coding agent, CI assistant
Audit historyRecords of who asked, which source was used, what ran, and when.Query and Source API records
GatewayThe OneQuery server runtime for local or self-hosted deployments.onequery gateway start
Provider IDThe integration type passed to source setup.postgres, github, sentry
Local nameThe name you choose for one connection.warehouse, github_main, sentry_prod
SourceA named connection to a provider.PostgreSQL warehouse
sourceKeyThe JSON field for the local name during source setup."sourceKey": "warehouse"
Source identifierThe address used by the CLI and agents.postgres://warehouse
Query-capable sourceA source that supports SQL-oriented query execution.PostgreSQL, Snowflake, BigQuery
Source API sourceA source where the useful operation is a provider API request.GitHub pull requests, Sentry issues
Read-onlyAccess intended for inspection, not mutation.select 1, limited API tokens
ProfileA named CLI state selection for separate environments or organizations.onequery --profile work auth login
OneQuery homeThe local directory where CLI state and gateway runtime state live.~/.onequery/, or a custom ONEQUERY_HOME
Shared serverA OneQuery server operated for a team or organization.https://onequery.example.com
Local gatewayA OneQuery gateway process you run yourself.onequery gateway start