Overview

The types in this reference are exported from @telnyx/edge-runtime (TypeScript) and describe version ≥ 0.9.0 — the first release that exports SqlDatabase and wires the env binding. They describe the env binding, the in-function surface. Running SQL from outside a function — schema changes, ad-hoc queries, migrations — goes over a separate REST path, covered in the CLI reference.

The SQL Databases Runtime API is a single binding type plus the statement and result types its methods return. A database declared as [storage.sqldb.<NAME>] in telnyx.toml resolves on env.<NAME> as a SqlDatabase.

Surface	Where it lives	What it’s for
`SqlDatabase`	`env.<BINDING>`	The binding handle — `prepare`, `batch`, `exec`.
`SqlPreparedStatement`	returned by `prepare()`	`bind()`, then one terminal: `first`, `run`, `all`, `raw`.
`SqlQueryResult<T>`	resolved by `run()`, `all()`, and each entry of `batch()`	`{ results, success, meta }` — the rows plus their envelope.
`SqlQueryResultMeta`	`SqlQueryResult.meta`	`duration`, `rows_read`, `rows_written`, `last_row_id`, `changes` — the statement’s own accounting.
`SqlExecResult`	resolved by `exec()`	`{ count, duration }` — how many statements ran. Returns no rows.

Getting the Binding

import { env } from "@telnyx/edge-runtime";

// env.DB is a SqlDatabase, from [storage.sqldb.DB] in telnyx.toml
const { results } = await env.DB
  .prepare("SELECT id, email FROM users WHERE id = ?")
  .bind(1)
  .all<{ id: number; email: string }>();

Read the binding off the imported env — not the env argument of fetch(request, env). The object handed to fetch carries actor bindings only: env.DB on it is undefined, and the call fails at runtime with Cannot read properties of undefined (reading 'prepare') even though it type-checks cleanly. The generated types deliberately declare the binding in both places, so the compiler will not catch this.

Declaring the binding is covered in the Quick Start. The binding resolves at runtime from telnyx.toml; run telnyx-edge types after editing the manifest to regenerate telnyx-env.d.ts, which types env.<NAME> as a SqlDatabase. That command checks the @telnyx/edge-runtime version declared in package.json and fails with @telnyx/edge-runtime <version> does not export SqlDatabase (requires >= 0.9.0) when the floor is not met.

SqlDatabase — the method-by-method reference
Quick Start — create a database, bind it, query it
How SQL Databases Work — one primary per database, and what that means for consistency
Bindings — how bindings resolve on env
CLI — telnyx-edge storage sqldb for provisioning, ad-hoc SQL, and migrations
Limits — database and value size, bound parameters, and query performance
Stateful Actor SQL — a different product: the private embedded SQLite at ctx.storage.sql, visible to one actor instance only and called synchronously

Get Started

Concepts

Reference

Getting the Binding

​Getting the Binding

​Related Resources

Getting the Binding

Related Resources