Files And Serialization

Open File

Open and parse a CSDB file.

TypeScript

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

const db = await openCSDB("payroll.csdb");

Python

from csdb import open_csdb

db = open_csdb("payroll.csdb")

Save File

Serialize and save a CSDB file. The TypeScript writer uses a temporary file and rename for safer replacement.

TypeScript

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

await saveCSDB(db, "payroll.csdb", { machineIndexes: "auto" });

Python

from csdb import save_csdb

save_csdb(db, "payroll.csdb", machine_indexes="auto")

Parse Text

Parse text into a database.

TypeScript

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

const db = parseCSDB(text);

Python

from csdb import parse_csdb

db = parse_csdb(text)

Serialize Text

Serialize a database to CSDB text.

TypeScript

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

const text = serializeCSDB(db);

Python

from csdb import serialize_csdb

text = serialize_csdb(db)

Configure Parsing And Serialization

Parsing supports validation control:

TypeScript

CSDBDatabase.parse(text, { validate: false });

Python

CSDBDatabase.parse(text, validate=False)

Serialization supports machine index control:

TypeScript

db.toString({ machineIndexes: "omit" });
db.toString({ machineIndexes: "auto" });

Python

db.to_string(machine_indexes="omit")
db.to_string(machine_indexes="auto")