1. guides
prorm
  • prorm documentation
  • Known test gaps
  • Architecture
  • Core concepts
  • Database types & coverage
  • Getting started
  • Going further
  • compliance
    • Compliance
    • The security toolkit: `prorm audit`
    • Checklists by regulation
    • Declaring personal data
    • Evidence bundles
    • Evidence
    • Frameworks: `@Security`
    • Jurisdictions
    • Platform policies
    • Protecting data
    • The regulation dataset
    • Residency and cross-border transfers
    • Retention & integrity
    • Status
    • Subject rights
  • decorators
    • prorm with decorators
    • Models with decorators
    • Querying a decorated model
    • Relations with decorators
  • diagrams
    • Diagram generators
    • Chen diagram
    • Class diagram
    • Dependency diagram
    • ER diagram
    • Flow diagram
    • From your models to a diagram
    • Gantt diagram
    • Index diagram
    • Migration diagram
    • Model diagram
    • Package diagram
    • Crow’s-foot diagram
    • Schema documentation
    • Sequence diagram
    • State diagram
    • Tree diagram
  • dialects
    • SQL dialects
    • AlloyDB Dialect
    • AlloyDB Omni Dialect
    • Amazon Athena Dialect
    • Aurora DSQL Dialect
    • Amazon Aurora MySQL Dialect
    • Amazon Aurora PostgreSQL Dialect
    • Azure Database for MySQL Dialect
    • Azure Database for PostgreSQL Dialect
    • Azure SQL Database Dialect
    • Azure SQL Managed Instance Dialect
    • Google BigQuery Dialect
    • Citus Dialect
    • ClickHouse dialect
    • Cloud Authentication (`cloud-auth`)
    • Cloud SQL for SQL Server Dialect
    • Cloud SQL for MySQL Dialect
    • Cloud SQL for PostgreSQL Dialect
    • CockroachDB Dialect
    • Azure Cosmos DB for PostgreSQL Dialect
    • CrateDB Dialect
    • Cloudflare D1 Dialect
    • Databricks dialect
    • IBM Db2 Dialect
    • Dolt Dialect
    • Apache Doris Dialect
    • Druid Dialect
    • DuckDB Dialect
    • Exasol dialect
    • Microsoft Fabric Data Warehouse Dialect
    • Firebird Dialect
    • Greenplum Dialect
    • SAP HANA Dialect
    • MySQL HeatWave Dialect
    • Azure Data Explorer (Kusto) Dialect — T-SQL
    • MariaDB Dialect
    • Materialize Dialect
    • MonetDB Dialect
    • MotherDuck Dialect
    • Microsoft SQL Server Dialect
    • MySQL Dialect
    • Neon Dialect
    • OceanBase Dialect
    • openGauss Dialect
    • Oracle Dialect
    • Oracle Autonomous Database Dialect
    • ParadeDB Dialect
    • PolarDB Dialect
    • PostgreSQL Dialect
    • Presto Dialect
    • QuestDB Dialect
    • Aurora RDS Data API Dialect (`rdsdata`)
    • Amazon RDS for Db2 Dialect
    • Amazon RDS for MariaDB Dialect
    • Amazon RDS for SQL Server Dialect
    • Amazon RDS for MySQL Dialect
    • Amazon RDS for Oracle Dialect
    • Amazon RDS for PostgreSQL Dialect
    • Amazon Redshift
    • Amazon Redshift Data API Dialect
    • RisingWave Dialect
    • rqlite Dialect
    • SingleStore Dialect
    • Snowflake Dialect
    • Google Cloud Spanner Dialect
    • Spanner (PostgreSQL interface) Dialect
    • SQLite Dialect
    • StarRocks Dialect
    • Supabase Dialect
    • Azure Synapse Analytics (dedicated SQL pool)
    • Teradata Dialect
    • TiDB Dialect
    • TimescaleDB Dialect
    • Trino Dialect
    • Turso / libSQL Dialect
    • Vertica dialect
    • Vitess Dialect
    • Yellowbrick Dialect
    • YugabyteDB Dialect
  • guides
    • Access rules and behaviour profiles
    • ArangoDB (AQL)
    • Associations
    • Audit levels and escalation
    • Audit logging
    • In the browser
    • Bulk operations
    • Caching
    • Capabilities, tiers and team roles
    • CLI
    • Cloudflare
    • Compliance & data protection
    • Connection Pooling & Performance
    • Security in the console
    • Couchbase: structured N1QL queries
    • Data types
    • Decorators
    • Eager loading
    • Enums and constants
    • Error handling & error types
    • Extensions
    • External fields
    • Foreign data wrappers
    • Graph databases
    • Hooks & lifecycle events
    • Indexes & constraints
    • InfluxDB: structured Flux pipelines
    • klock-errors
    • klock — the `.klock` file
    • Local databases (`prorm db up`)
    • Structured log search — Splunk, Graylog, Papertrail, Sumo Logic
    • Logging
    • Grafana Loki: structured LogQL queries
    • MCP server
    • Migrate — the data transfer subsystem
    • Migrations & Schema Sync
    • Models from an existing database
    • Defining models
    • Multiple databases
    • OrientDB, Neptune and TigerGraph
    • Passwords
    • Importing a Prisma schema
    • Structured PromQL and MetricsQL
    • Query firewall
    • QueryInterface
    • Query operators reference
    • Query optimization
    • Composing find options with `pipe()` and `Q`
    • Query safety: the fail-closed WHERE guard
    • Querying
    • Raw Queries & Query Building
    • Read replicas
    • Schema diffing & migration generation
    • Views, triggers & other schema objects
    • Scopes & default scopes
    • Seeders
    • SPARQL / RDF triplestores
    • SQL constants
    • SQL features
    • SQL function builders
    • SQLite advanced features
    • StoreKey — a prod-orm database as the storage
    • Streaming results
    • Terraform
    • Transactions & Isolation Levels
    • Type mapping: legacy and modern
    • TypeScript types
    • Database users, roles & privileges
    • Validation & constraints
    • Virtual & Computed Fields
    • Writing docs
  • javascript
    • prorm in JavaScript
    • Models in JavaScript
    • Querying in JavaScript
    • Relations in JavaScript
  • runbooks
    • Operational runbooks
    • Connection failures
    • Credential rotation
    • Failover
    • Incident checklist
    • Deploying klock v2
    • Migration rollback
  • running-databases
    • Running databases in Docker
    • Running prorm under Bun in Docker
    • Running Cassandra in Docker with prorm
    • Running ClickHouse in Docker with prorm
    • Running CockroachDB in Docker with prorm
    • Running prorm under Deno in Docker
    • Running Elasticsearch in Docker with prorm
    • Running MariaDB in Docker with prorm
    • Running MongoDB in Docker with prorm
  • prorm control plane
    • Introduction
    • Authentication
    • Errors
    • Getting started
      • Service
        • Is it up
        • This description
    • Account
      • Sign-up and verification
        • Create an account
        • Exchange credentials for a token
        • Verify with the emailed code
        • Verify by clicking the emailed link
        • Name the parent or guardian
        • What a consent link is about
        • Give consent for a child's account
        • Ask the parent or guardian again
        • Send a new code and link
      • Family
        • Everyone this account is responsible for
        • One child, in detail
        • Turn a limit on or off
      • Profile
        • Who am I
        • Change the account
        • Every address on the account
        • Add an address
        • Confirm an address with the code mailed to it
        • Mail a fresh code to an unconfirmed address
        • Make an address primary
        • Remove an address
        • What this caller may do
    • Security
      • Sessions
        • Everywhere this account is signed in
        • Sign out everywhere else
        • Sign one out
        • A token for the CLI on a named machine
        • A token for the customer console, from the staff one
        • Park a sign-in for the CLI to collect
        • The CLI collecting its sign-in
        • The team's members' live sessions
        • Sign a member's session out
        • Sign an account out everywhere
        • Everywhere the account is signed in
        • Sign an account's session out
      • Single sign-on
        • Begin a single sign-on
        • The provider's return
        • Link the signed-in account to a team's provider
        • Which team an address signs in to
        • The team's single sign-on, as a member sees it
        • Set the team's OpenID Connect provider up, or change it
        • Remove the provider
        • The team's domain claims and the DNS record each needs
        • Prove a claimed domain
      • MFA and passwords
        • Start enrolling a second factor
        • Prove the app has it
        • Remove the second factor
        • Ask for a reset link
        • Set a new password with the emailed token
      • Klock
        • Open a device-bound klock session
        • Check in, for the next grant
        • Step up the session asking
        • Rotate the device key
        • Freeze a session
        • Unfreeze a session
        • A guest grant
        • The revocation feed
        • The published keyset
        • What this control plane supports
      • Devices
        • Your devices, or a team's
        • Approve a new device's pairing code
        • One device
        • Rename a device
        • Revoke a device
        • Suspend a device
        • Reinstate a suspended device
        • Wipe a device
        • Ask a device to rotate its key
        • The team's members' devices
        • Revoke a member's device
        • An account's devices
        • Revoke an account's device
        • Wipe an account's device
        • The device fleet
      • Access rules and behaviour
        • The access rules that bear on you
        • Add an access rule
        • This request, as the rules see it
        • One access rule
        • Remove an access rule
        • The behaviour profiles that bear on you
        • Add or change a behaviour profile
        • The profile presets
        • Your behaviour findings
        • Acknowledge a finding
        • One behaviour profile
        • Remove a behaviour profile
        • The team's access rules
        • Add a team access rule
        • Remove a team access rule
        • The team's behaviour profiles
        • Add or change a team behaviour profile
        • Remove a team behaviour profile
        • What the team's profiles caught
        • Acknowledge a team finding
      • Recovery and lockdown
        • Ask for a recovery link
        • Recover access with the emailed code
        • Is the account locked down
        • Lock the account down
        • Release a lockdown
        • Lock a member down
        • Release a member's lockdown
      • MCP tokens
        • Make a delegated token for one MCP client
        • The account's delegated tokens
        • Revoke a delegated token
        • What a delegated token may do now
        • Run one MCP tool with a delegated token
        • Run a device-signed MCP tool call relayed by the MCP Worker
      • Kerberos
        • Give the team its own Kerberos realm
        • The team's realm
        • Remove the team's realm
    • Logging and monitoring
      • Audit log
        • What has been done to the account
        • What has happened to this account
        • The account's audit trail
      • Operations
        • Everything that has been asked of this database
        • One, with its steps
        • Stop it
        • Put a failed one back in the queue
        • Every operation, across all accounts
      • Metrics and events
        • Every measurement, for a graph
        • Who did what to it
    • Billing
      • Plans and pricing
        • What the plans allow
        • The rate card
        • What one database would cost
        • What this account is paying for, itemised
      • Subscriptions and invoices
        • What this month's invoice will say
        • What this account is on
        • What it has been charged
        • Start a Stripe Checkout session
        • Open the customer portal
        • Stripe's events
        • Buy more connection pools
      • Team billing
        • The team's billing account
        • What the team has been charged
        • What this month's invoice will say
        • The team's cards
        • Add a card, through a Stripe-hosted setup session
        • Make a card the team's default
        • Remove a card
        • Start the team paying
        • Open the Stripe portal on the team's customer
        • Change the team's plan
        • Who receives the team's bills
        • How the team pays for transfers
    • Support
      • Support chat
        • My conversations
        • Start a conversation
        • Every support conversation, open first
        • A ticket for the socket
        • One conversation, with who is in it and who is connected
        • Rename a group; open or close a support conversation
        • The lines, oldest first
        • Say something
        • Add somebody
        • Mark read
    • Administration
      • Users
        • Every account
        • One account, with everything hanging off it
        • Grant or revoke admin
        • Verify an account by hand
        • Lock or unlock sign-in
        • Allow or hold provisioning
        • Send the verification mail again
        • Set the plan by hand
      • Platform
        • Every database and store, across all accounts
        • The counts worth putting on a dashboard
      • Staff and permissions
        • What kind of admin the caller is, and which scopes they hold
        • The admin presets
        • Every admin, and the scopes each resolves to
        • Make an account an admin of a kind
        • Change an admin's kind, or a custom admin's scopes
        • Revoke admin
      • Team administration
        • Every team, with its owner and size
        • One team in full — members with their accounts, and projects
        • Hand the team to another member
        • Put an account in the team, active at once
        • Change a member's role
        • Remove a member
      • Assumed identities
        • Assume an identity — act as a customer account
        • The identities the caller holds open
        • End an assumed identity
      • Support inbox
        • The platform's addresses
        • Add a platform address
        • One address, with its counts
        • Change an address's label, routing, or whether it accepts mail
        • Remove an address that holds no mail
        • Make, adopt or repair the address's routing rule
        • Every admin's personal address, made where missing
        • File a raw message, as if it had arrived
        • The inbox
        • One message, whole
        • Mark a message
        • Hand a message to an admin, or take it back
        • Leave an internal note
        • Reply, from the address the message came to
        • What is waiting
    • Databases
      • Databases
        • Data stores
          • Every data store on the account
          • Provision a data store
          • Change a data store that is already running
          • One data store
          • Deprovision it
          • Report what it is using
          • How to reach a data store
        • Connections and credentials
          • The api keys on a database
          • Issue a key
          • Revoke a key
          • The engine users we created
          • Create a user inside the database
          • Give a user a new password
          • Drop a user
          • How the database is reached
          • Set how it is reached
          • Revoke every api key on it
          • How to connect to it
          • The ssh keys that open its bastion
          • Add a key, or have one made
          • The private half of a generated key, once
          • Revoke an ssh key
        • Schema and objects
          • The SQL objects we put in it
          • Create one, and apply it
          • What is in the database, as the engine reports it
          • One table
          • What it would run, without running it
          • Redefine an object in place
          • Drop it
          • The extensions installed in it
        • Migrations
          • A plan compiled to statements, recording nothing
          • The migrations recorded for it
          • Record one
          • Apply everything recorded and not yet run
          • Apply everything pending, oldest version first
        • Lifecycle
          • Grow or shrink it
          • Stop it accepting connections
          • Start it again
          • Move it to another region
        • Backups and replicas
          • Take a backup
          • The backups it has
          • Restore one into it
          • What has been restored into it, and from where
          • Its read copies
          • Add one
        • Policies
          • The catalog
          • One policy
          • What this database is held to
          • Switch a policy on, or change its knobs
          • Switch it off
          • Mark the policies reviewed
          • Evaluate the periodic policies now
          • Who is behind a credential
        • Passwordless
          • The database's passwordless sessions
          • Issue a passwordless session (v1)
          • Revoke a passwordless session
          • Bind a session to a device key
          • Issue a v2 session for a host to bind
          • Redeem an enrolment ticket on the host
          • Check a passwordless credential
          • Run one described query under a passwordless credential
        • Database roles
          • The database's roles
          • Define a role
          • One role
          • Change what a role permits
          • Delete a role, and revoke every key granted it
          • Grant a role, which mints a key
          • Who holds a role
          • The api keys bound to a role
        • Pools
          • A database's connection pools, and how busy each is
          • Open another pool
          • Rename a pool or change its size
          • Close a pool
        • Data plane
          • Run a query against a database
          • Several statements, in order, over one connection
          • Is this database answering
          • What the proxy itself is holding
        • Transfers
          • The strategies this account's tier may use
          • Price a transfer without creating it
          • The account's transfer jobs, newest first
          • Create a transfer job
          • One job, and whether its certificate holds
          • Cancel an unfinished job
          • Start a created job, confirming its price
          • Report a job's status (the runner, or the owner's side of a local run)
        • Every database on the account
        • Provision a database
        • Change a database that is already running
        • One database
        • Deprovision it
        • Read or write it
        • Report what it is using
        • The engines this API will provision
        • Where a managed database can be put
    • Teams
      • Teams
        • Members
          • Who is on it
          • Invite somebody
          • Accept an invitation
          • Change somebody's role
          • Remove somebody
        • Projects
          • The projects a team runs
          • Start one
          • Rename a project, or move its environment
          • Delete a project
          • One project, and what is in it
          • Put a database or store in it
          • What is in a project
          • Take one out
        • The teams this account is on
        • Start one
        • The twelve roles, and what each may do
        • Rename a team
        • Close a team
        • One team
        • Hand the team to somebody else
        • Leave a team
    • Schemas
      • Error
      • ValidationErrors
      • Token
      • PolicyCategory
      • PolicySeverity
      • PolicyAction
      • PolicyTrigger
      • PolicyParam
      • Policy
      • PolicyCatalog
      • PolicyAssignment
      • PolicyOutcome
      • PolicyFiring
      • CredentialTrace
      • Relation
      • Restrictions
      • ChildSummary
      • SignupRequest
      • SigninRequest
      • UpdateMeRequest
      • User
      • Address
      • GeoPoint
      • D1Region
      • Usage
      • UsageReport
      • Resource
      • Database
      • DataStore
      • NewDatabase
      • NewDataStore
      • QueryRequest
      • DatabasePrivilege
      • ApiKey
      • DbUser
      • Access
      • AccessRequest
      • DatabaseObject
      • NewDatabaseObject
      • NewMigration
      • SchemaOperation
      • Migration
      • Operation
      • Session
      • AdminPowers
      • Admin
      • AuditEntry
      • TeamRole
      • Conversation
      • ChatMessage
      • TeamSso
      • Team
      • TeamMember
      • SshKey
      • ConnectionInfo
      • InboxAddress
      • InboxMailbox
      • InboxMessageSummary
      • InboxMessage
      • InboxNote
      • Page
      • Quote
      • Plan
      • ApiError
      • CapabilityRefusal
      • KlockErrorCode
      • PageWindow
      • SessionView
      • KlockStepUpRequest
      • KlockOpenRequest
      • KlockOpenedSession
      • UpdateMeResult
      • CapabilitiesView
      • SessionLimits
      • Device
      • DeviceListed
      • DeviceTeamRef
      • DeviceCommand
      • DeviceAuditLine
      • DeviceActionRequest
      • StaffActionRequest
      • ManagedSession
      • SessionRevoked
      • AccessRule
      • AccessRuleRequest
      • BehaviourProfile
      • BehaviourProfileRequest
      • BehaviourProfileSaved
      • BehaviourFinding
      • BehaviourFindingAck
      • StepUpProof
      • Removed
      • MemberLockdownRequest
      • McpClient
      • McpDelegatedView
      • McpToolCall
      • McpForwardRequest
      • PasswordlessScope
      • RoleScope
      • PasswordlessSession
      • PasswordlessTlsMaterial
      • PasswordlessKerberosMaterial
      • ServiceDeviceKeys
      • ServiceSession
      • DatabaseRole
      • TransferEndpoint
      • TransferJobRequest
      • TransferQuote
      • TransferStrategy
      • TransferJob
      • TransferJobAccess
      • Pool
      • PoolAllowance
      • BillingSubscription
      • Invoice
      • BillingContact
      • PaymentMethod
      • UpcomingCharges
      • TeamBilling
      • TeamKerberosRealm
      • TeamSsoDomain
      • TeamSsoResponse
      • StoreConnection
      • BatchFailure
      • ProxyStatus
  1. guides

Cloudflare

Cloudflare has six data products, and prorm reaches all six. They are spread
across three parts of the library, because they are three different kinds of
thing — and the mapping is the first thing worth knowing:
CloudflareIn prormImport
D1a SQL dialectnew Prorm({ dialect: 'd1', … })
Hyperdrivea connection to Postgres or MySQLfromHyperdrive(env.HYPERDRIVE)
Workers KVa storets-prorm-orm/nosql/cloudflare-kv
R2a storets-prorm-orm/nosql/r2
Vectorizea storets-prorm-orm/nosql/cloudflare-vectorize
Queuesa storets-prorm-orm/nosql/cloudflare-queues
Durable Objectsa storets-prorm-orm/nosql/cloudflare-do
Inside a Worker, two of them are bindings the platform hands you and the rest
are reached over Cloudflare's REST API; Hyperdrive is a hop to a database that
lives somewhere else entirely:
prorm packages lists them together under a Cloudflare heading, so you can
pick your whole stack in one pass:
$ npx prorm packages --dialects d1 --stores cloudflare-kv,cloudflare-vectorize,r2
1 packages for what you picked:
  npm install @aws-sdk/client-s3

Re-run with --run to execute it here.
Only R2 installs anything (@aws-sdk/client-s3, because R2 speaks the S3
protocol). Everything else is fetch or a Worker binding. So a D1-plus-R2
Worker needs exactly two packages:
$ npm install ts-prorm-orm @aws-sdk/client-s3
$ pnpm add ts-prorm-orm @aws-sdk/client-s3
$ yarn add ts-prorm-orm @aws-sdk/client-s3
$ bun add ts-prorm-orm @aws-sdk/client-s3

D1 — SQL#

D1 is SQLite, so it is a dialect rather than a store, and the whole model layer
works against it. See the D1 dialect page for what differs
from SQLite — most importantly that D1 has no interactive transactions.

A Worker on D1, end to end#

A small notes API: the Worker reaches D1 through its binding, and migrations
run from your machine or CI over the D1 HTTP API, with the same migration files
you would use anywhere else.
notes-api/
  migrations/
    20260926120000-create-notes.js
  scripts/
    migrate-d1.ts       # runs the migrations over the HTTP API
  src/
    worker.ts
  .env                  # CF_ACCOUNT_ID, CF_D1_DATABASE_ID, CF_API_TOKEN (git-ignored)
  wrangler.toml

Create the database and bind it#

$ npx wrangler d1 create notes
Copy the database_id it prints into wrangler.toml:
name = "notes-api"
main = "src/worker.ts"
compatibility_date = "2026-09-01"
compatibility_flags = ["nodejs_compat"]

[[d1_databases]]
binding = "DB"                   # env.DB in the Worker
database_name = "notes"
database_id = "<the id wrangler printed>"

Write the migration#

prorm migration:create -- --name create-notes makes the file; fill it in:

Run it against D1 over HTTP#

prorm migration:run builds its connection from DATABASE_URL or the DB_*
variables, which have no slot for an account id and API token. So D1
migrations run through the same Migrator the CLI uses, from a script:
CF_ACCOUNT_ID=0123456789abcdef0123456789abcdef
CF_D1_DATABASE_ID=6f1c2e1a-0000-4000-8000-000000000000
CF_API_TOKEN=...            # a token with D1:Edit
import { Prorm, createMigrator } from 'ts-prorm-orm';

const prorm = new Prorm({
  dialect: 'd1',
  dialectOptions: {
    accountId: process.env.CF_ACCOUNT_ID,
    databaseId: process.env.CF_D1_DATABASE_ID,
    token: process.env.CF_API_TOKEN,
  },
});
await prorm.connect(); // checks all three are set; opens nothing

const migrator = createMigrator({ prorm, path: './migrations' });
await migrator.syncMigrationsTable();

const pending = await migrator.pending();
console.log(`Running ${pending.length} pending migration(s)...`);
const { executed, migrations } = await migrator.up();
console.log(`Executed ${executed} migration(s)`, migrations);

await prorm.close();
$ node --env-file=.env scripts/migrate-d1.ts     # Node 22.18+ runs .ts directly
Running 1 pending migration(s)...
Executed 1 migration(s) [ '20260926120000-create-notes' ]

Use it from the Worker#

import { Prorm, DataTypes } from 'ts-prorm-orm';

interface Env {
  DB: unknown; // a D1Database, typed by @cloudflare/workers-types if you use it
}

export default {
  async fetch(request: Request, env: Env): Promise<Response> {
    const db = new Prorm({ dialect: 'd1', dialectOptions: { binding: env.DB } });
    await db.connect();

    const Note = db.define(
      'Note',
      {
        title: { type: DataTypes.STRING, allowNull: false },
        done: { type: DataTypes.BOOLEAN, defaultValue: false },
      },
      { tableName: 'notes' },
    );

    if (request.method === 'POST') {
      const { title } = (await request.json()) as { title: string };
      const note = await Note.create({ title });
      return Response.json(note.toJSON(), { status: 201 });
    }

    const open = await Note.findAll({
      where: { done: false },
      order: [['id', 'DESC']],
      limit: 50,
    });
    return Response.json(open.map((n) => n.toJSON()));
  },
};

Try it locally, then deploy#

$ npx wrangler dev          # Miniflare's local D1 behind the same binding
$ npx wrangler deploy
[!WARNING]
db.transaction(async (t) => …) on D1 runs each statement as it comes and
cannot roll any of them back: D1 has no BEGIN that survives an await. When
two writes must land together, send them as one batch() on the binding,
which D1 applies atomically:

Hyperdrive — a connection, not a database#

Hyperdrive is the one Cloudflare data product that is not a store. It is a
pooler and cache in front of a Postgres or MySQL server you already have, and
what it hands your Worker is an ordinary connection to that server. There is no
Hyperdrive dialect and there should not be one:
import { Prorm, fromHyperdrive } from 'ts-prorm-orm';

export default {
  async fetch(request: Request, env: Env) {
    const prorm = new Prorm(fromHyperdrive(env.HYPERDRIVE));
    await prorm.connect();
    // …everything else is ordinary Postgres.
  },
};
Two things bite here:
Pool size. Hyperdrive is the pool. A Worker invocation is short-lived and
there may be thousands of them at once, so a driver-side pool of 10 per
invocation multiplies into connections Hyperdrive then holds open against your
database. fromHyperdrive defaults to pool: { max: 1, min: 0 } for that
reason; raise it only if you have measured a reason to.
Which engine. The binding does not say whether it fronts Postgres or MySQL
— that was decided when the Hyperdrive config was created, and only you know
it. It defaults to postgres; pass { dialect: 'mysql' } when it is not.
The binding comes from wrangler.toml:
compatibility_flags = ["nodejs_compat"]   # the pg and mysql2 drivers need Node's APIs

[[hyperdrive]]
binding = "HYPERDRIVE"
id = "<the id from: npx wrangler hyperdrive create …>"
import { Prorm, fromHyperdrive } from 'ts-prorm-orm';

export default {
  async fetch(request: Request, env: Env) {
    const prorm = new Prorm(fromHyperdrive(env.HYPERDRIVE)); // postgres is the default
    await prorm.connect();
    try {
      const rows = await prorm.query('SELECT now() AS at'); // a SELECT returns its rows
      return Response.json(rows);
    } finally {
      await prorm.close();
    }
  },
};
import { Prorm, fromHyperdrive } from 'ts-prorm-orm';

export default {
  async fetch(request: Request, env: Env) {
    const prorm = new Prorm(fromHyperdrive(env.HYPERDRIVE, { dialect: 'mysql' }));
    await prorm.connect();
    try {
      const rows = await prorm.query('SELECT NOW() AS at');
      return Response.json(rows);
    } finally {
      await prorm.close();
    }
  },
};
Everything after the first argument is ordinary PrormOptions, so
fromHyperdrive(env.HYPERDRIVE, { logging: false, pool: { max: 2 } }) works,
and a pool you pass is merged over the { max: 1, min: 0 } default.

Vectorize — vector search#

import { CloudflareVectorizeStore } from 'ts-prorm-orm/nosql/cloudflare-vectorize';

const vectors = new CloudflareVectorizeStore({ accountId, indexName: 'docs', apiToken });
await vectors.connect();

await vectors.upsert([{ id: '1', values: embedding, metadata: { url: '/a' } }]);
const { matches } = await vectors.query(queryEmbedding, { topK: 3, returnMetadata: 'all' });
Writes are queued, not applied: upsert() returns a mutationId and the
vectors become queryable a little later, so a query issued immediately after a
write can legitimately miss it. describe() reports the last processed
mutation. A filter on a metadata key matches nothing until
createMetadataIndex() has been called for that key.
Full page: Vectorize.

Queues — messages#

import { CloudflareQueuesStore } from 'ts-prorm-orm/nosql/cloudflare-queues';

const queue = new CloudflareQueuesStore({
  accountId: process.env.CF_ACCOUNT_ID,
  queueId: process.env.CF_QUEUE_ID,
  apiToken: process.env.CF_API_TOKEN,
});
await queue.connect();

await queue.send({ orderId: 7 });

const { messages } = await queue.pull({ batchSize: 10 });
await queue.ack(messages.map((m) => m.lease_id));
pull() needs the queue to have an HTTP pull consumer. Against a queue
whose consumer is a Worker it returns nothing, which looks like an empty queue
rather than a misconfiguration.
A pulled message is borrowed, not consumed: hold on to its lease_id and
acknowledge it, or it is redelivered and processed twice.
Full page: Queues.

Durable Objects — the one with a caveat#

There is no REST API for a Durable Object's storage, and there will not be one:
the storage is reachable only from inside the object. Cloudflare's API exposes
two read-only inventory endpoints and nothing else.
So this store has two modes. With a binding, inside a Worker, it routes
requests to objects. With an account id and token, from anywhere, it lists
namespaces and object ids and reaches no data at all. Asking one mode for what
only the other can do throws and says why.
const objects = new CloudflareDurableObjectsStore({ namespace: env.COUNTER });
await objects.connect();
await objects.fetch('room-42', new Request('https://do/increment'));
There is deliberately no get(name, key): it would have to invent a wire
protocol every one of your Durable Object classes had to implement, and any
that did not would answer 404 and look empty. You own the protocol; this
routes to the right instance.
Full page: Durable Objects.

Workers KV and R2#

Both shipped earlier and are unchanged: Workers KV
is the edge key-value store over REST, and R2 is the
S3-compatible object store, built on @aws-sdk/client-s3 — the only Cloudflare
store here that installs a package.
Modified at 2026-10-04 00:40:16
Previous
CLI
Next
Compliance & data protection
Built with