unstorage

SQL Database

Store data in a supported SQL database through db0.

#Usage

Driver name: db0

This driver stores key-value data through db0. It supports db0 connections using the sqlite, libsql, postgresql, and mysql dialects.

Warning

Database driver is experimental and behavior may change in the future.

To use, you will need to install db0 in your project:

npm i db0

Select and configure the appropriate connector for your database.

Important

Learn more about configuring connectors in the db0 documentation.

You can then configure the driver like this:

import { createDatabase } from "db0";
import { createStorage } from "unstorage";
import dbDriver from "unstorage/drivers/db0";
import sqlite from "db0/connectors/better-sqlite3";

// Learn more: https://db0.unjs.io
const database = createDatabase(sqlite({/* db0 connector options */}));

const storage = createStorage({
  driver: dbDriver({
    database,
    tableName: "custom_table_name", // Default is "unstorage"
  }),
});

Tip

No manual schema setup is required. Before the first operation, the driver creates a table with key, value, blob, created_at, and updated_at columns when it does not already exist.

Options:

  • database (required): A db0 database instance.
  • tableName: The name of the table to use. It defaults to unstorage.
Edit this page
Previous Cloudflare Next Deno KV