Void ORM

Void ORM is a simple, and speedy ORM for PostgreSQL, designed for you not to write a single line of SQL.

Why Void ORM?

• Lightweight, and Speedy
• No SQL
• TypeScript oriented

---

Guide

Initialize using a Connection String

import { DatabaseClient } from "void-orm";

const db = new DatabaseClient({
  connectionString:
    "postgresql://username:password@localhost:port/dbName?schema=public",
  successMessage: "PostgreSQL Database started",
});

Fill out fields individually

import { DatabaseClient } from "void-orm";

const db = new DatabaseClient({
  user: "username",
  password: "password",
  db: "dbName",
  port: 5432,
  successMessage: "Success message",
});

Create a Database

const createdDatabase = await db.createDatabase("dbName");

Create a Table

const createdTable = await db.createTable("tableName");

Create Data

const data = await db.create({ table: "table", values: [1, "value", true] });

Update Data

await db.update({
  table: "table",
  selectedColumns: ["selectedColumn"],
  updatedData: ["newValue"],
});

Find One

await db.findOne({
  table: "tableName",
  where: { key: "value" },
});

Find All

await db.findAll("table");

Raw Query You can also send a raw SQL query, if you want, like so

await db.rawQuery("SELECT * FROM table;");

Delete Database

await db.deleteDatabase("dbName");

Delete Table

await db.deleteTable("table");

API

Methods

createDatabase(dbName: string): Promise[QueryResult]

createTable(tableName: string): Promise[QueryResult]

create(data: CreateOptions): Promise[QueryResult]

update(data: UpdateOptions): Promise[QueryResult]

findOne(data: FindOneOptions): Promise[QueryResult]

findAll(data: FindAllOptions): Promise[QueryResult]

rawQuery(queryData: string): Promise[QueryResult]

deleteDatabase(droppedDb: string): Promise[QueryResult]

deleteTable(droppedTable: string): Promise[QueryResult]

Interfaces

CreateOptions
table: string;
values: Array;

UpdateOptions
table: string;
selectedColumns: Array;
updatedData: Array;

FindOneOptions
table: string;
where: object;

FindAllOptions
table: string;