D1

The D1 component lets you add a Cloudflare D1 database to your app.

Minimal example

sst.config.ts

const db = new sst.cloudflare.D1("MyDatabase");

Link to a worker

You can link the db to a worker.

sst.config.ts

new sst.cloudflare.Worker("MyWorker", {
  handler: "./index.ts",
  link: [db],
  url: true
});

Once linked, you can use the SDK to interact with the db.

index.ts

import { Resource } from "sst";

await Resource.MyDatabase.prepare(
  "SELECT id FROM todo ORDER BY id DESC LIMIT 1",
).first();

---

Constructor

new D1(name, args?, opts?)

Parameters

• name string

• args? D1Args

• opts? ComponentResourceOptions

D1Args

transform?

Type Object

• database?

Transform how this component creates its underlying resources.

transform.database?

Type D1DatabaseArgs | (args: D1DatabaseArgs, opts: ComponentResourceOptions, name: string) => void

Transform the D1 resource.

Properties

databaseId

Type Output<string>

The generated ID of the D1 database.

nodes

Type Object

• database

The underlying resources this component creates.

nodes.database

Type D1Database

The Cloudflare D1 database.

SDK

Use the SDK in your runtime to interact with your infrastructure.

---

Links

This is accessible through the Resource object in the SDK.

• databaseId string

  The generated ID of the D1 database.

Bindings

When you link a D1 database, the database will be available to the worker and you can query it using its API methods.

index.ts

import { Resource } from "sst";

await Resource.MyDatabase.prepare(
  "SELECT id FROM todo ORDER BY id DESC LIMIT 1",
).first();