Content editing

Change all your data from your database ORM models directly in your local browser. Adding, editing, removing, change relations, filtering, sorting, and much more.

Query

Explore your data by using regular JavaScript query commands like you would do in your Typescript source.

Model diagram

See all your models with relations, fields, and primary keys in one big diagram.

Seed

Seed your database with a powerful faker library directly from within your browser.

Easy to use

You only have to provide your database as TypeScript source. No configuration files, compilation, or anything else necessary.

import { entity, PrimaryKey, AutoIncrement } from '@deepkit/type';
import { Database } from '@deepkit/orm';
import { SQLiteDatabaseAdapter } from '@deepkit/sqlite';

@entity.collection('groups')
export class Group {
    public id: number & PrimaryKey & AutoIncrement = 0;
    created: Date = new Date;

    constructor(
        public name: string
    ) {
    }
}

const database = new Database(new SQLiteDatabaseAdapter('./example.sqlite'), [Group]);

import { Entity, PrimaryKey, AutoIncrement } from '@deepkit/type';
import { Database } from '@deepkit/orm';
import { SQLiteDatabaseAdapter } from '@deepkit/sqlite';

export interface Group extends Entity<{collection: 'groups'}> {
    id: number & PrimaryKey & AutoIncrement;
    created: Date;
    name: string;
}

const database = new Database(new SQLiteDatabaseAdapter('./example.sqlite')).register<Group>();

$ deepkit-orm-browser database.ts
2021-06-22T10:28:13.144Z [LOG] Start HTTP server, using 1 workers.
2021-06-22T10:28:13.146Z [LOG] RPC OrmBrowserController orm-browser/controller
2021-06-22T10:28:13.146Z [LOG] HTTP OrmBrowserController
2021-06-22T10:28:13.146Z [LOG]     GET /_orm-browser/query httpQuery
2021-06-22T10:28:13.146Z [LOG] HTTP StaticController
2021-06-22T10:28:13.146Z [LOG]     GET /:any serviceApp
2021-06-22T10:28:13.146Z [LOG] HTTP listening at http://localhost:9090/

By opening now http://localhost:9090/ you can directly start managing content. The ORM Browser is integrated automatically when using Deepkit Framework in its Framework Debugger.