Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

4.3 KB
Raw Blame
import { sqlKeys } from '@/data/sql/keys'

export const databaseKeys = {
  schemas: (projectRef: string | undefined) => ['projects', projectRef, 'schemas'] as const,
  keywords: (projectRef: string | undefined) => ['projects', projectRef, 'keywords'] as const,
  entitySearch: (projectRef: string | undefined, query: string) =>
    ['projects', projectRef, 'entity-search', query] as const,
  migrations: (projectRef: string | undefined) => ['projects', projectRef, 'migrations'] as const,
  tableColumns: (
    projectRef: string | undefined,
    schema: string | undefined,
    table: string | undefined
  ) => ['projects', projectRef, 'table-columns', schema, table] as const,
  tableColumnsPrefix: (projectRef: string | undefined) =>
    ['projects', projectRef, 'table-columns'] as const,
  databaseFunctions: (projectRef: string | undefined, schema?: string) =>
    ['projects', projectRef, 'database-functions', schema].filter(Boolean),
  entityDefinition: (projectRef: string | undefined, id?: number) =>
    ['projects', projectRef, 'entity-definition', id] as const,
  entityDefinitions: (projectRef: string | undefined, schemas: string[]) =>
    ['projects', projectRef, 'entity-definitions', schemas] as const,
  tableDefinition: (projectRef: string | undefined, id?: number) =>
    ['projects', projectRef, 'table-definition', id] as const,
  viewDefinition: (projectRef: string | undefined, id?: number, includeCreateStatement?: boolean) =>
    ['projects', projectRef, 'view-definition', id, includeCreateStatement ?? false] as const,
  backups: (projectRef: string | undefined) =>
    ['projects', projectRef, 'database', 'backups'] as const,
  poolingConfiguration: (projectRef: string | undefined) =>
    ['projects', projectRef, 'database', 'pooling-configuration'] as const,
  indexesFromQuery: (projectRef: string | undefined, query: string) =>
    ['projects', projectRef, 'indexes', { query }] as const,
  indexAdvisorFromQuery: (
    projectRef: string | undefined,
    query: string,
    connectionString?: string
  ) => {
    // Use only the host (no credentials) as a safe cache discriminator
    let connectionFingerprint: string | undefined
    if (connectionString) {
      try {
        connectionFingerprint = new URL(connectionString).host
      } catch {
        connectionFingerprint = undefined
      }
    }
    return ['projects', projectRef, 'index-advisor', { query, connectionFingerprint }] as const
  },
  tableConstraints: (projectRef: string | undefined, id?: number) =>
    ['projects', projectRef, 'table-constraints', id] as const,
  foreignKeyConstraintsPrefix: (projectRef: string | undefined, schema?: string) =>
    schema === undefined
      ? (['projects', projectRef, 'foreign-key-constraints'] as const)
      : (['projects', projectRef, 'foreign-key-constraints', schema] as const),
  foreignKeyConstraints: (projectRef: string | undefined, schema?: string, options = {}) =>
    ['projects', projectRef, 'foreign-key-constraints', schema, options] as const,
  databaseSize: (projectRef: string | undefined) =>
    ['projects', projectRef, 'database-size'] as const,
  maxConnections: (projectRef: string | undefined) =>
    ['projects', projectRef, 'max-connections'] as const,
  pgbouncerStatus: (projectRef: string | undefined) =>
    ['projects', projectRef, 'pgbouncer', 'status'] as const,
  pgbouncerConfig: (projectRef: string | undefined) =>
    ['projects', projectRef, 'pgbouncer', 'config'] as const,
  checkPrimaryKeysExists: (
    projectRef: string | undefined,
    tables: { name: string; schema: string }[]
  ) => ['projects', projectRef, 'check-primary-keys', tables] as const,
  tableIndexAdvisor: (
    projectRef: string | undefined,
    schema: string | undefined,
    table: string | undefined
  ) => ['projects', projectRef, 'table-index-advisor', schema, table] as const,
  supamonitorEnabled: (projectRef: string | undefined) =>
    ['projects', projectRef, 'supamonitor-enabled'] as const,
  databaseActivity: (projectRef: string | undefined) =>
    ['projects', projectRef, 'database-activity'] as const,
  authenticatorRoleConfig: (projectRef: string | undefined) =>
    ['projects', projectRef, 'authenticator-role-config'] as const,
}

export const getLiveTupleEstimateKey = (
  projectRef: string | undefined,
  table: string,
  schema = 'public'
) => sqlKeys.query(projectRef, ['live-tuple-estimate', schema, table])