Sqlite ORM for deno. Tables with relations are not supported.

Usage

Create an instance of the ORM:

import{SqliteOrm,SqlTable}from'https://deno.land/x/deno_sqlite_orm@1.2.0/mod.ts';constorm=newSqliteOrm({dbPath: 'path/to/database.db'});

You can access the database instance directly by orm.db. If you are using an existing database and it contains JSON objects, enable jsonCompatMode in options or objects similar to following will not be parsed.

{
"foo": "baz",
"bar": 0
}

Create a model:
Use the @orm.model() decorator for creating a new model. After all models are loaded, call orm.modelsLoaded()

@orm.model()classFooextendsSqlTable{}orm.modelsLoaded()

Incase Foo exists in the database but has a different name, use @orm.model('bar'). All Tables have id as a primary key. It can be removed by overriding it and using @orm.ignoreColumn(). Tables are created if they don't exist. If new columns are added, the table is altered. If a column is removed from the model, it still stays in the database. If you want to rename the property, or the column exists with a different name use @orm.mappedTo('oldName')

Defining columns:
All properties of the table are considered as columns. Column types are automatically inferred from the default value
of the property.

classFooextendsSqlTable{
@orm.model()classFooextendsSqlTable{// type is automatically inferred as "string"publicfoo='bar'// column type is required when property doesn't have a default value
@orm.columnType('string')publicbar!: string// set a column as a primary key
@orm.primaryKey()publicfooId=0// ignore property
@orm.ignoreColumn()
@orm.autoIncrement()// mark it as autoincrementpublicignored=0// remove id from primary key
@orm.ignoreColumn()publicid=-1// automatically marked as nullable
@orm.columnType('string')
@orm.nullable()// or manually mark itpublicbaz: string|null=null// incase the column exists with a different name
@orm.mappedTo('bar')publicbaa=''// if you don't want to stack multiple decorators, you can do:
@orm.column({type: 'string',nullable: true})publicfaz!: string|null}

Querying data:

// find a single a row, throws an error (`DBNotFound`) when not foundorm.findOne(Foo,1)// finds a row in Foo where id = 1// equivalent to aboveorm.findOne(Foo,{where: {clause: 'id = ?',values: [1]// optional when not using placeholders}})// same usage as above, but returns a new instance of `Foo` when not found// you can check if its new from `Foo._new`orm.findOneOptional(Foo,1)// same as `findOne` but returns multiple instances of or rows of Fooorm.findMany(Foo,{where: {clause: 'id > 5'},limit: 10,// optionaloffset: 3// optional})// save an instance of Fooconstbaz=newFoo()orm.save(baz)// delete rows from Foo where id = 1orm.delete(Foo,{where: {clause: 'id = 1'}})// count rows of Foo where id < 5orm.countWhere(Foo,{where: {clause: 'id < 5'}})// or you can do a more advanced countorm.aggregateSelect<[foo: string,count: number]>(Foo,{select: {clause: 'foo, COUNT(baz)'},group: {cols: ['foo']}})

Saving objects:
Objects are converted to JSON before saving, and parsed when read. If its a class instance then the class should be registered by @registerJsonSerializable()

import{registerJsonSerializable}from'https://deno.land/x/deno_sqlite_orm@1.2.0/mod.ts';// the property "ignored" will be ignored and not saved
@registerJsonSerializable(['ignored'])classBar{publicfoo='bar'publicignored=''}
@orm.model()classFooextendsSqlTable{// type is automatically inferred as jsonbar: Record<string,any>={}baz: Bar=newBar()}

Example

import{SqliteOrm,SqlTable}from'https://deno.land/x/deno_sqlite_orm@1.2.0/mod.ts';constorm=newSqliteOrm({dbPath: 'path/to/database.db',});// register the class as a table
@orm.model()classFooextendsSqlTable{// type is automatically inferredpublicfoo='baz'// type is required when not set
@orm.columnType('string')publicbar!: string// type is inferred as jsonpublicbaz: Record<string,any>={foo: 'foo',bar: 'baz'}// ignore this property
@orm.ignoreColumn()publicignored=''}orm.modelsLoaded()constobj=newFoo()// save the objorm.save(obj)// fetch the saved objconsole.log(db.findOne(Foo,1))// count number of rows of `Foo` where id > 1console.log(db.countWhere(Foo,{where: {clause: 'id > ?',values: [1]}}))