#Databáze, migrace & NPX (Drizzle)

Jako databázi budeme používat SQLite: SQLite Home Page. Pro komunikaci s databází využijeme knihovnu Drizzle: Drizzle ORM.

Nejprve nainstalujeme knihovnu drizzle-orm:

npm install drizzle-orm

Drizzle je ORM (Object-Relational Mapper) – knihovna, která bude náš objektový JS kód převádět na relační jazyk SQL, kterému rozumí databáze. Tato knihovna sama o sobě komunikovat s databází neumí, a proto musíme nainstalovat ještě jednu dodatečnou knihovnu:

npm install @libsql/client

Pro jednodušší práci s knihovnou Drizzle při vývoji nabízí Drizzle balíček drizzle-kit. Ten obsahuje například grafické rozhraní pro prohlížení dat v databázi nebo příkazy pro vytváření a spouštění migrací. Nainstalujeme jej tedy také:

npm install drizzle-kit

#Definice schématu databáze

SQLite, jako všechny relační databáze, vyžaduje schéma. Toto schéma se standardně definuje jazykem SQL. My si jej ale necháme od Drizzlu vygenerovat. Aby jej Drizzle dokázal vytvořit, musíme jej definovat v JavaScriptu. Založíme soubor src/schema.js, kde jej popíšeme:

// src/schema.js

import { sqliteTable, int, text } from "drizzle-orm/sqlite-core"

export const todosTable = sqliteTable("todos", {
  id: int().primaryKey({ autoIncrement: true }),
  title: text().notNull(),
  done: int({ mode: "boolean" }).notNull(),
})

Toto schéma nyní exportuje jednu tabulku nazvanou todos. Tato tabulka má tři sloupečky: id, title a done.

• Sloupeček id bude obsahovat pouze celá čísla int(), jedná se o primární klíč (unikátní identifikátor záznamu v databázi) primaryKey() a jeho hodnotu si necháme generovat databází autoIncrement: true.
• Sloupeček title je textový text() a nenulový notNull().
• Sloupeček done by ideálně obsahoval booleanovskou hodnotu true/false, ale tu SQLite přímo nepodporuje. Definujeme tedy sloupeček jako celé číslo v módu boolean – Drizzle bude automaticky převádět na true/false a obráceně.

Schéma máme hotové a pomocí drizzle-kit z něj můžeme nechat vygenerovat SQL příkazy (migrace), které uvedou databázi do žádaného stavu. Nejprve musíme ale drizzle-kit nakonfigurovat.

#Nastavení knihovny drizzle-kit

Pokud chceme používat knihovnu drizzle-kit na správu databáze, musíme ji nejdříve nastavit (například definovat, kde se databáze nachází). Tato konfigurace se nachází v souboru drizzle.config.js v kořenovém adresáři projektu (zde musíme dodržet jak umístění souboru, tak jmennou konvenci).

// drizzle.config.js

import { defineConfig } from "drizzle-kit"

export default defineConfig({
  dialect: "sqlite",
  schema: "./src/schema.js",
  dbCredentials: {
    url: "file:db.sqlite",
  },
})

Tato konfigurace říká knihovně drizzle-kit tři věci:

1. dialect – Dialekt generovaného SQL. Každý typ databáze (SQLite, PostgreSQL, MySQL...) má trošičku odlišné SQL.
2. schema – Kde se nachází soubor s JavaScriptovým zápisem schématu.
3. dbCredentials – Kde se nachází databáze. file:db.sqlite znamená, že bude v souboru nazvaném db.sqlite (Drizzle si jej vytvoří).

Nyní můžeme vygenerovat migrační SQL soubory:

npx drizzle-kit generate

Drizzle by měl vytvořit nový adresář nazvaný drizzle a v něm soubor 0000_nejaka_slova.sql – SQL soubor s migrací. Adresář drizzle/meta obsahuje dodatečné metainformace pro Drizzle, které nás aktuálně nezajímají.

Pokud chceme migrace aplikovat do databáze, provedeme to příkazem:

npx drizzle-kit migrate 

Měl by vzniknout soubor db.sqlite obsahující naši databázi. Obsah databáze můžeme prohlížet a modifikovat aplikací Drizzle Studio, kterou spustíme příkazem:

npx drizzle-kit studio

#NPX

Určitě jste si všimli, že u posledního příkazu jsme použili příkaz npx, a ne npm. Node.js knihovny mohou vedle zdrojového kódu přibalit malé konzolové aplikace, které nám usnadní vývoj – CLI. S těmito CLI interagujeme pomocí příkazu npx. Tzn. npx drizzle-kit spustí CLI dodávané s knihovnou Drizzle.

#Načítání todos z databáze

Pokud jsme si pomocí Drizzle Studio vložili do databáze nějaká testovací todočka, můžeme je nyní načíst v naší aplikaci. Nejprve vytvoříme spojení do naší databáze:

// index.js
// ostatní importy...
import { drizzle } from "drizzle-orm/libsql"

const db = drizzle({
  connection: "file:db.sqlite",
  logger: true,
})
// zbytek aplikace...

connection musí odkazovat na stejnou databázi jako v drizzle.config.js. logger určuje, zda má Drizzle do konzole vypisovat spuštěné SQL příkazy. Pro lepší pochopení toho, co Drizzle dělá na pozadí, jej necháme na true.

Nyní můžeme v handleru pro index načíst todočka z databáze:

// index.js
import { todosTable } from "./src/schema.js"

app.get("/", async (c) => {
  const todos = await db.select().from(todosTable).all()

  const index = await renderFile("views/index.html", {
    title: "My todo app",
    todos,
  })

  return c.html(index)
})

Zde přibyl jeden nový import, a to definice todosTable z našeho schématu – pozor, importujeme soubor, takže nezapomeňte na příponu .js na konci. Načítání z databáze je asynchronní operace, a tak musíme použít klíčové slovo await. Funkce select() značí, že chceme načíst data, from() určuje tabulku a all() říká, že chceme načíst vše.

#Vložení dat do databáze

Nyní upravíme handler pro vytváření nových todoček:

// index.js

app.post("/todos", async (c) => {
  const form = await c.req.formData()

  await db.insert(todosTable).values({
    title: form.get("title"),
    done: false,
  })

  return c.redirect("/")
})

Databázi nemusíme předávat hodnotu id, jelikož si ji vygeneruje sama (auto increment).

#Získání jednoho todočka

// index.js

import { eq } from "drizzle-orm"

app.get("/todos/:id", async (c) => {
  const id = Number(c.req.param("id"))

  const todo = await db
    .select()
    .from(todosTable)
    .where(eq(todosTable.id, id))
    .get()

  if (!todo) return c.notFound()

  const detail = await renderFile("views/detail.html", {
    todo,
  })

  return c.html(detail)
})

Zde přibyl nový import: eq (equals). Získání jednoho todočka má navíc funkci where(), pomocí které omezujeme, co chceme z databáze získat. Konkrétně zde je podmínka, že se hodnota ve sloupečku todosTable.id musí rovnat hodnotě v konstantě id. Funkce get() na rozdíl od all() vrátí pouze jeden záznam.

#Úprava todočka

app.post("/todos/:id", async (c) => {
  const id = Number(c.req.param("id"))

  const todo = await db
    .select()
    .from(todosTable)
    .where(eq(todosTable.id, id))
    .get()

  if (!todo) return c.notFound()

  const form = await c.req.formData()

  await db
    .update(todosTable)
    .set({ title: form.get("title") })
    .where(eq(todosTable.id, id))

  return c.redirect(c.req.header("Referer"))
})

Pro úpravu dat využijeme funkci update(). Zde pozor – nesmíme zapomenout na omezující funkci where(), jinak upravíme všechna todočka v databázi! Funkce set() očekává objekt s daty, která chceme změnit.

#Smazání todočka

app.get("/todos/:id/remove", async (c) => {
  const id = Number(c.req.param("id"))

  const todo = await db
    .select()
    .from(todosTable)
    .where(eq(todosTable.id, id))
    .get()

  if (!todo) return c.notFound()

  await db.delete(todosTable).where(eq(todosTable.id, id))

  return c.redirect("/")
})

Smazání je jednoduché. Zde opět pozor na vynechání podmínky where(), jinak smažete celou tabulku!