hibernatets

hibernate clone for typescript

Usage no npm install needed!

<script type="module">
  import hibernatets from 'https://cdn.skypack.dev/hibernatets';
</script>

README

hibernateTS

typescript clone for hiberante/persistance API

Install

  npm i hibernatets

Setup

currently only support for mariadb databases

set up by setting these environment variables

const db = process.env.DB_NAME;
const port = +process.env.DB_PORT;
const user = process.env.DB_USER;
const url = process.env.DB_URL;
const password = process.env.DB_PASSWORD;

experimentalDecorators needs to be enabled

Api

Models

configure database with annotations

import { table,primary,column ,mapping,Mappings } from "hibernatets"
import { OtherModel } from "./otherModel"

@table({
  // can be omitted defaults to ClassName toLowercase
  name:"testmodel"
})
class TestModel{
  
  // { strategy: 'custom'|'auto-increment' }
  // custom for mapping to non auto-increment tables
  @primary()
  id:number
  
  @column()
  randomcolumn:string
  
  // key 'reverseforeignkey' in OtherModel references primary key of current table(TestModel)
  //alternative @mapping(Mappings.OneToMany,OtherModel,o=>o.reverseforeignkey) for autocompletion
  @mapping(Mappings.OneToMany,OtherModel,"reverseforeignkey")
  othermodels:Array<OtherModel>

  // key 'othermodel' in current table(TestModel) references primary key of OtherModel
  @mapping(Mappings.OneToOne,OtherModel)
  othermodel:OtherModel
  //...
}

Functions

Load

objects can be loaded with

const obj:TestModel=await load(TestModel,1) // primary key

or

import { load } from "hibernatets"

const obj:Array<TestModel> = await load(TestModel,t=>t.randomcolumn="test"); //assignment here
const obj:TestModel = await load(TestModel,t=>t.randomcolumn="test",[],{first:true}); //assignment here

or

//!!!careful of sql injection
const obj:Array<TestModel> = await load(TestModel,"randomcolumn = ?",["test"]);
//!!!careful of sql injection
const obj:TestModel = await load(TestModel,"randomcolumn = ?",["test"],{first:true});

for mappings the default is to not load nested mappings this can be enabled by adding the optional "deep" parameter

const obj:Array<TestModel> = await load(TestModel,t=>t.randomcolumn="test",[],{ deep :true});
const obj:TestModel = await load(TestModel,t=>t.randomcolumn="test",[],{ first:true, deep :true});

const obj:TestModel = await load(TestModel,t=>t.randomcolumn="test",[],{ first:true, deep :['othermodels']});  //only loads othermodels mappings
const obj:TestModel = await load(TestModel,t=>t.randomcolumn="test",[],{ first:true, deep :{
  othermodels:" othermodelatt = 'test'  "
}});  //only loads othermodels with query !!!careful of sql injection
Updates

see Timing if you want to await finishing of request

// with @column() attribute
const obj:TestModel = await load(TestModel,1);

// automatically gets persisted to database 
obj.attribute= "test"

// with @mapping(Mappings.OneToMany) attributes
const obj:TestModel = await load(TestModel,1);
 
const newObject=new NewObject();
// automatically gets added and persisted
obj.attributes.push(newObject)

Timing

assignments to loaded objects get automatically persisted and can be awaited with

const obj=await load(TestModel,0)
obj.attribute="test"
//sql request not finished yet
await database.queries(obj)
//sql requests all finished
Delete



//alternative delete(Class,primary)
database.delete(obj)
Save
// for new Objects - loaded objects autoupdate on attribute change
database.save(obj)

Database Updates

includes optional automatic database adjust column annotations have optional parameters to indicate

  • database type 'text' 'number'
  • database size 'small' 'medium' 'large'
import { updateDatabase,table,column } from "hibernatets"

@table()
export class TestModel {
    
    // creates database column with type BIGINT
    @column({
      type:"number"
      size:"large"
    })
    example

}

// creates missing tables
// adds missing columns
// increases column size
// takes argument for folder with model files
updateDatabase(`${__dirname}/testmodels`)

npm at https://www.npmjs.com/package/hibernatets