Giter VIP home page Giter VIP logo

pixidb's Introduction

PixiDB

A small all-in-memory database with background file writing.

Basic Example

// Types for saftey and completion
interface User {
  id: string;
  age: number;
}

// Make an object that will house all your tables
export const db = {
  users: new Table<User>('/path/to/db/dir', 'users')
}

db.users.set({
  id: 'cool_guy',
  age: 42
})
let arr = db.users.getAll()
let arr = db.users.get((v) => v.age > 10)
let user = db.users.getOne('cool_guy')

Schemas

You can define a schema for a table with the .schema().

Doing so will enable validation checking on all .set() and .new() calls.

let users = new Table('users', null).schema({
  id: 'string',
  age: 'number',
  verified: 'boolean',
})

Schema objects can also be nested like so:
{
  id: 'string',
  age: 'number',
  settings: {
    darkmode: 'boolean',
    volume: 'number'
  }
}

Valid types:

  • any
  • string
  • number
  • boolean
  • array
  • object (defined as above)

Logging and Debugging

There is a static property in the Table class to set the level of logging for all tables, you can set like this:

Table.loglevel = LogLevel.None

The levels are:

  • None (default)
  • Init (shows table initialisation info)
  • Operations (shows table operations)
  • Verbose (lots of info for debugging)

pixidb's People

Contributors

garystrousers avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.