Skip to main content
Module

x/kvdex/mod.ts>createDb

Database wrapper for Deno KV
Go to Latest
function createDb
import { createDb } from "https://deno.land/x/kvdex@v0.3.0/mod.ts";

Create a new database instance.

Builds the database collections and checks for duplicate keys. In the case where two collections have the same key, an error will be thrown.

Example:

interface User extends Model {
  username: string
  age: number
}

const kv = await Deno.openKv()

const db = createDb(kv, (builder) => ({
  numbers: builder.collection<number>(["numbers"]),
  users: builder.indexableCollection<User>(["users"]).indices({
    username: "primary",
    age: "secondary"
  })
}))

Parameters

  • The Deno KV instance to be used for storing and retrieving data.
schemaBuilder: (builder: CollectionBuilder) => T
  • Builder function for building the database schema.