Skip to main content

OrgDatabaseQueries

No description

type OrgDatabaseQueries {
  orgDatabase: OrgDatabaseInfo
  orgDatabaseCredentials: [OrgDatabaseCredential!]
  orgDatabaseSchema(
    integrationId: Long!
  ): OrgDbSchema
}

Fields​

OrgDatabaseQueries.orgDatabase ● OrgDatabaseInfo object​

The organization's database (if provisioned) plus feature availability (capability=false hides the whole surface). Requires canQueryOrgDatabase or canManageOrgDatabase.

OrgDatabaseQueries.orgDatabaseCredentials ● [OrgDatabaseCredential!] list object​

The connection credentials the caller is entitled to, for external clients (DBeaver, Metabase, Airbyte, ...): canQueryOrgDatabase sees read-only, canManageOrgDatabase adds read-write, canViewOrgDatabaseCredentials adds admin (full control). Requires a Ready database. Fetched on demand; treat as secrets.

OrgDatabaseQueries.orgDatabaseSchema ● OrgDbSchema object​

Live introspection of the organization database's public schema (tables, columns, primary keys) for the FetchSQL/MutateSQL editors. Requires canQueryOrgDatabase and a Ready database.

OrgDatabaseQueries.orgDatabaseSchema.integrationId ● Long! non-null scalar​

Returned By​

orgDatabase query