Template: es-database-script

This template demonstrates a CRUD API backed by Bunny Database, built for Bunny using a local Deno.

You do not want to use Deno? Feel free to use something else, here is a full fledged example with node instead!

Queries go through the libSQL client. Reads hit the replica closest to the request, writes go to the primary region.

Endpoints

GET    /           a hello message pointing at the notes endpoint
GET    /notes      list every note
POST   /notes      create a note from a { title, body } payload
GET    /notes/:id  read a single note
PUT    /notes/:id  replace a note
DELETE /notes/:id  remove a note

curl https://your-script.b-cdn.net/notes

curl -X POST https://your-script.b-cdn.net/notes \
  -H 'content-type: application/json' \
  -d '{"title": "Hello", "body": "From the edge."}'

curl -X PUT https://your-script.b-cdn.net/notes/1 \
  -H 'content-type: application/json' \
  -d '{"title": "Hello again", "body": "Updated."}'

curl -X DELETE https://your-script.b-cdn.net/notes/1

Database

The script reads BUNNY_DATABASE_URL and BUNNY_DATABASE_AUTH_TOKEN.

Creating a database

You have three options, so pick whichever fits how you work:

• From the dashboard — click Add in the sidebar and choose Database, then set a name and the regions to deploy to. See the Database quickstart.
• While creating an Edge Script — you can provision a database as part of the script creation flow, which saves wiring the credentials up separately.
• With the Bunny CLI — handy if you'd rather not leave the terminal, and the only option that scripts cleanly.

For the CLI:

bunny login

# Prompts for a name and regions, then offers to link this directory,
# generate an auth token, and write both variables to .env
bunny db create

# Non-interactive, for CI — prompts are suppressed under --output json,
# so the flags are what opt you in
bunny db create --name es-database-script --primary FR \
  --token --save-env --output json

bunny db list shows what you already have, bunny db shell opens a SQL REPL against it, and bunny db studio gives you a read-only table viewer in the browser.

Connecting it to this script

For a database that already exists, go to Dashboard > Edge Platform > Database > [Select Database] > Access, click Generate Tokens, then Add Secrets to Edge Script and pick this script. Bunny adds both variables to the script for you. See Connect Edge Scripting to Bunny Database.

The notes table is created on startup with CREATE TABLE IF NOT EXISTS. Use migrations for anything beyond a demo.

Setup

To run this example you'll need to have a valid Deno installation.

When you have the deno binary available, you should be able to run the check task which is the task ensuring everything is compiling fine.

# A tiny lint just to be sure!
deno task lint

# We ensure everything is type compliant!
deno task check

To run the script locally, set both database variables in your environment first:

BUNNY_DATABASE_URL=... BUNNY_DATABASE_AUTH_TOKEN=... deno task dev

If you let bunny db create --save-env write a .env for you, note that deno task dev does not pick it up on its own — Deno only reads .env when you ask it to:

deno run --env-file src/main.ts

We also use pnpm to use changeset.

Changeset

This template uses changeset for version management. Changeset helps track and document changes in your project, making it easier to manage releases and generate changelogs.

When you make changes to the project, you should create a changeset to describe those changes:

1. Run the following command:

   pnpm changeset
   

2. Follow the prompts to select the type of change (major, minor, or patch) and provide a brief description.
3. Commit the generated changeset file along with your code changes.

This process ensures that all modifications are properly documented and versioned, facilitating smoother releases and better communication about project updates.

When you merge a pull request that includes a changeset, it will automatically create an associated pull request to release your changes.

This new pull request will trigger the release process of the script to your PullZone in Bunny.

This behavior is disabled by default, every pushes on main are now pushed to Bunny directly. You can enable this pattern again by updating this action