Guides Databases

Use PostgreSQL

Add PostgreSQL as a database with the @primate/postgresql module. Configure it in config/db; Primate connects to it and provides a unified API.

Ensure PostgreSQL is running and accessible.

1) Install

Install the Primate PostgreSQL package.

$ npm install @primate/postgresql

2) Configure

Create a database configuration file.

TypeScriptconfig/db.ts

import postgresql from "@primate/postgresql";

export default postgresql({
  host: "localhost",
  port: 3306,
  database: "app",
  // username: "user",
  // password: "pass",
});

3) Create a store

PostgreSQL stores abstract a table. Give the store a name and wire the database.

TypeScriptstores/User.ts

import p from "pema";
import store from "primate/store";
import db from "../config/db.ts";

export default store({
  table: "user",
  db,
  schema: {
    id: store.key.primary(p.uuid),
    name: p.string,
    email: p.string.email(),
  },
});

4) Use the store

Use the store in routes.

TypeScriptroutes/users.ts

import User from "#store/User";
import route from "primate/route";

export default route({
  async get() {
    const users = await User.find({});
    return users;
  },
  async post(request) {
    const user = await User.insert(await request.body.form());
    return user;
  },
});