Getting Started

Install

TypeScript

npm install @csdb/typescript

Python

pip install csdb

The Python package is not implemented yet. This command reserves the intended installation shape.

Create A Database In Memory

TypeScript

import { CSDBDatabase } from "@csdb/typescript";

const db = CSDBDatabase.parse(`--- csdb
format: CSDB
version: 1
name: demo
tables:
  - notes

--- table:notes:schema
name: notes
columns:
  id: text
  body: text
required:
  - id
primary_key:
  columns: [id]

--- table:notes:data
id,body
n_001,hello
`);

Python

from csdb import CSDBDatabase

db = CSDBDatabase.parse("""--- csdb
format: CSDB
version: 1
name: demo
tables:
  - notes

--- table:notes:schema
name: notes
columns:
  id: text
  body: text
required:
  - id
primary_key:
  columns: [id]

--- table:notes:data
id,body
n_001,hello
""")

Insert And Query Rows

TypeScript

db.table("notes").insert({ id: "n_002", body: "from the fluent API" });
db.table("notes").insert({ id: "n_003", body: null });

const notes = db.table("notes")
  .where("body", "!=", null)
  .orderBy("id")
  .all();

Python

db.table("notes").insert({"id": "n_002", "body": "from the fluent API"})
db.table("notes").insert({"id": "n_003", "body": None})

notes = (
    db.table("notes")
    .where("body", "!=", None)
    .order_by("id")
    .all()
)

SQL

INSERT INTO notes (id, body)
VALUES ('n_002', 'from SQL');

INSERT INTO notes (id, body)
VALUES ('n_003', NULL);

SELECT *
FROM notes
WHERE body IS NOT NULL
ORDER BY id ASC;

Optional non-primary-key columns accept null. In CSV, unquoted empty fields represent null, while quoted empty strings remain empty strings.

Save A File

TypeScript

import { saveCSDB } from "@csdb/typescript";

await saveCSDB(db, "demo.csdb", { machineIndexes: "omit" });

Python

from csdb import save_csdb

save_csdb(db, "demo.csdb", machine_indexes="omit")

What To Read Next

• Overview explains the document model.
• Database API shows table creation, validation, and serialization.
• TableQuery API covers the fluent table API.