Schema Introspection

​

tables

const tables = await db.tables<{ table_name: string }>()
// [{ table_name: 'events' }, { table_name: 'users' }]

• Signature: tables<T = Record<string, unknown>>(): Promise<T[]>.
• Backed by:
  SELECT table_name FROM information_schema.tables
  WHERE table_schema = 'main' ORDER BY table_name
  

​

columns

const cols = await db.columns<{
  column_name: string
  data_type: string
  is_nullable: string
}>('events')
// [{ column_name: 'id', data_type: 'INTEGER', is_nullable: 'YES' }, …]

• Signature: columns<T = Record<string, unknown>>(table: string): Promise<T[]>.
• Backed by (the table name is passed as a bound parameter, not interpolated):
  SELECT column_name, data_type, is_nullable FROM information_schema.columns
  WHERE table_name = $1 ORDER BY ordinal_position
  

​

explain

const plan = await db.explain('SELECT * FROM events WHERE id > 1')
// rows describing the physical plan; render plan.length / the plan text

• Signature: explain<T = Record<string, unknown>>(query: string): Promise<T[]>.
• The backend runs EXPLAIN <query> and returns the resulting rows.

​

Permissions

​

See also

• Query & execute — run the queries you discover here.
• Connections, Database & Config — the main schema and catalog model.