Skip to main content

OrgDatabaseMutations

No description

type OrgDatabaseMutations {
  provisionOrgDatabase: OrgDatabase
  deprovisionOrgDatabase: Boolean
  orgDatabaseConnectTicket(
    role: String!
  ): String
}

Fields​

OrgDatabaseMutations.provisionOrgDatabase ● OrgDatabase object​

Activate the organization database: creates the Neon project in the background — poll orgDatabase until status is Ready or Error. Re-runnable from Error. Requires canManageOrgDatabase.

OrgDatabaseMutations.deprovisionOrgDatabase ● Boolean scalar​

DESTRUCTIVE: delete the organization database — the Neon project (all data), stored credentials and the integration. Requires canManageOrgDatabase.

OrgDatabaseMutations.orgDatabaseConnectTicket ● String scalar​

Mint a short-lived, single-use ticket the SPA hands to the embedded pgweb database browser as its connect resource. role is "ro" or "rw"; "rw" requires canManageOrgDatabase, "ro" needs canQueryOrgDatabase (the default and floor is read-only). The ticket carries NO credentials — pgweb redeems it server-side. Requires a Ready database.

OrgDatabaseMutations.orgDatabaseConnectTicket.role ● String! non-null scalar​

Returned By​

orgDatabase mutation