Skip to main content

Command reference

Settings resolve flag > QOD_* env var > active profile > built-in default; see The qod CLI for the full table. --profile NAME and --json are top-level flags that go before the noun, e.g. qod --json tenant list.

Purposes below are one line each; run qod <noun> <verb> --help for the full flag list of any command.

auth

CommandPurpose
qod loginMint a session, store it and the edge settings in the active profile.
qod logoutRevoke the current session token.
qod whoamiVerify the current session.
qod auth modeShow the auth mode (db or oidc) the manager expects.
qod healthLiveness plus pool/node counts (open endpoint).

tenant

CommandPurpose
qod tenant listList tenants.
qod tenant createCreate a tenant.
qod tenant deleteDelete a tenant (must have no pools).
qod tenant set-disabledEnable or disable a tenant.
qod tenant set-authChange a tenant's auth provider/config.

database

CommandPurpose
qod database listList databases for a tenant.
qod database createCreate a tenant database.
qod database updateUpdate a tenant database's metastore/object-store/init settings.
qod database deleteDelete a tenant database.

pool

CommandPurpose
qod pool listList pools.
qod pool createCreate a pool.
qod pool scaleChange a pool's target size and role distribution.
qod pool stopStop a pool's nodes.
qod pool deleteDelete a pool.
qod pool set-disabledEnable or disable a pool.
qod pool set-resourcesSet CPU/memory requests for a pool's nodes.
qod pool set-pod-templateSet the Kubernetes pod template YAML for a pool.

pool permission

CommandPurpose
qod pool permission listList pool access grants.
qod pool permission grantGrant pool access to a user or group.
qod pool permission revokeRevoke a pool access grant.

node

CommandPurpose
qod node quarantineTake a node out of routing rotation.
qod node unquarantineReturn a node to routing rotation.
qod node restartRestart a node.
qod node set-max-concurrentSet a node's max concurrent statement limit.
qod node statementsRecent statement history, newest first.
qod node active-statementsCurrently running statements.

statement

CommandPurpose
qod statement killKill a running statement by id.

user

CommandPurpose
qod user listList users.
qod user createCreate a user (tenant-scoped, or --superuser for tenant-less).
qod user updateUpdate a user's tenant, password, or role.
qod user deleteDelete a user.
qod user effectiveClosure of roles, groups, table permissions, and pool grants.

role

CommandPurpose
qod role listList roles for a tenant.
qod role createCreate a role.
qod role deleteDelete a role.

role permission

CommandPurpose
qod role permission listList table permissions attached to a role.
qod role permission grantGrant a table permission to a role.
qod role permission revokeRevoke a table permission from a role.

role row-policy

CommandPurpose
qod role row-policy listList row-level security predicates on a role.
qod role row-policy createAdd a row-level security predicate.
qod role row-policy updateUpdate a row-level security predicate.
qod role row-policy deleteDelete a row-level security predicate.

role column-policy

CommandPurpose
qod role column-policy listList column-level security policies on a role.
qod role column-policy createAdd a column-level security policy.
qod role column-policy updateUpdate a column-level security policy.
qod role column-policy deleteDelete a column-level security policy.

group

CommandPurpose
qod group listList groups for a tenant.
qod group createCreate a group.
qod group deleteDelete a group.

membership

CommandPurpose
qod membership user-role addAdd a user to a role.
qod membership user-role removeRemove a user from a role.
qod membership user-group addAdd a user to a group.
qod membership user-group removeRemove a user from a group.
qod membership group-role addAdd a role to a group.
qod membership group-role removeRemove a role from a group.
qod membership group-role listList roles held by a group.

catalog

CommandPurpose
qod catalog schemasList schemas in a tenant database.
qod catalog tablesList tables in a schema.
qod catalog describeDescribe a table's columns, optionally as of a snapshot/tag/timestamp.
qod catalog snapshotsList snapshots for a tenant database, optionally filtered to a table.
qod catalog historySnapshot history for a table (operation, author, time range filters).
qod catalog previewPreview table rows, optionally as of a snapshot/tag/timestamp.
qod catalog data-diffRow-level diff of a table between two snapshot selectors.
qod catalog schema-diffSchema diff of a table between two snapshot selectors.
qod catalog recoverableDropped tables still recoverable via undrop.
qod catalog undropRecover a dropped table, optionally under a different name.
qod catalog restoreRoll a live table back to a prior snapshot or tag, as a new forward snapshot.
qod catalog restore --tenant acme --db acme_tpch --schema tpch1 --table orders --to 480 --dry-run

--to takes a snapshot id or a tag name. qod catalog restore is non-destructive: it runs the dry run first and prints the change summary, then prompts to confirm before writing the new snapshot (skip the prompt with --yes, or stop after the preview with --dry-run). Requires an ALL grant, or DDL plus RO/RW, on the table. For dropped tables, use qod catalog undrop instead.

tag

CommandPurpose
qod tag createTag a snapshot, optionally marking it protected.
qod tag deleteDelete a tag.
qod tag protectChange a tag's protected flag.

maintenance

CommandPurpose
qod maintenance policyShow the maintenance policy for a scope.
qod maintenance policy-upsertCreate or update a maintenance policy.
qod maintenance policy-deleteDelete a maintenance policy.
qod maintenance runTrigger a maintenance run.
qod maintenance runsList past maintenance runs.

manifest

CommandPurpose
qod manifest exportExport the whole control-plane topology as YAML.
qod manifest importImport a topology manifest (YAML) into the control plane.

federation

CommandPurpose
qod federation listList federated sources.
qod federation getShow one federated source.
qod federation createCreate a federated source.
qod federation deleteDelete a federated source.
qod federation secret listList secrets referenced by a federated source's setup SQL.
qod federation secret setSet a secret (inline value or external reference).
qod federation secret deleteDelete a secret.

audit

CommandPurpose
qod audit listList audit log entries with filters.
qod audit actionsDistinct audit action names, for filter values.

usage

CommandPurpose
qod usageUsage accounting rollups.

history

CommandPurpose
qod history statementsList past statements with filters.
qod history trendsAggregate statement trends over time.

config

CommandPurpose
qod config clientEdge host/port/TLS for client bootstrapping (open endpoint).
qod config serverEffective manager configuration.

sql

CommandPurpose
qod sqlRun SQL against the FlightSQL edge; one-shot or interactive REPL.

qod <noun> <verb> --help prints every flag for any command above.