Advanced Examples

const db = DB.init("MyDatabase");

/**
 * Fetch paginated and sorted employee data.
 */

function fetchPaginatedEmployees() {
  const options = {
    page: 2, // Page number
    pageSize: 5, // Number of records per page
    sortBy: "age", // Field to sort by
    sortOrder: "asc", // Sort order: 'asc' or 'desc'
  };

  const result = db.getAll("EMPLOYEES", options, true); // `true` to use cache
  console.log(result.data);
}

const db = DB.init("MyDatabase");

/**
 * Add an employee with type validation.
 */
function addEmployeeWithValidation() {
  const employee = {
    name: "Alice Johnson",
    age: "Thirty", // Incorrect type: should be a number
    position: "Designer",
    employed: true,
    hire_date: new Date("2023-03-10"),
  };

  // this will err
  const result = db.create("EMPLOYEES", employee, [
    "name",
    "age",
    "position",
    "employed",
    "hire_date",
  ]);

  if (result.status === 500) {
    console.error("Failed to create employee:", result.error);
  } else {
    console.log("Employee created:", result);
  }
}

// 1. Create the relation config
const relationConfig = db.createManyToManyTableConfig({
  entity1TableName: "PROJECTS",
  entity2TableName: "EMPLOYEES",
  fieldsRelatedToBothEntities: {
    extra_field: "string", // optional
  },
});

/*
 relationConfig.data is an object just like: 
 {
   tableName: "PROJECTS_EMPLOYEES_RELATION",
   historyTableName: "DELETED_PROJECTS_EMPLOYEES_RELATION",
   fields: { created_at: "date", projects_id: "number", employees_id: "number", ...}
 }
*/

// 2. Create that table
db.createTable(relationConfig.data);
db.putTableIntoDbContext(relationConfig.data);

// 3. Insert a record in the junction table
db.createJunctionRecord(
  "PROJECTS_EMPLOYEES_RELATION",
  {
    projects_id: 10,
    employees_id: 5,
  },
  ["projects_id", "employees_id"]
);

function readManyEmployees() {
  // pass an array of IDs
  const result = db.readIdList("EMPLOYEES", [1, 2, 3, 100]);
  console.log(result.data); // found records
  console.log(result.notFound); // array of IDs not found
  return JSON.stringify(result);
}

const db = DB.init("MyDatabase");

const productTableConfig = {
  tableName: "PRODUCTS",
  historyTableName: "DELETED_PRODUCTS",
  fields: {
    name: { type: "string", treatEmptyStringAsMissing: true },
    price: "number",
    active: { type: "boolean", default: true },
    created_at: { type: "date", default: "now" },
  },
};

db.createTable(productTableConfig);
db.putTableIntoDbContext(productTableConfig);

// Defaults in action (active defaults to true, created_at defaults to now)
const resA = db.create("PRODUCTS", { name: "Widget", price: 9.99 }, [
  "name",
  "price",
]);

// Empty string treated as missing; will be replaced by default true
const resB = db.update(
  "PRODUCTS",
  resA.id,
  { name: "", price: 9.99, active: "" },
  ["name", "price", "active"]
);

console.log(resA, resB);