Tiny embedding document-oriented database written in typescript.
npm install miningo- For playground / experimental / simple / application use.
- For who not want to use mongodb / redis / postgress, but want to use database.
$ npm i miningo
API
$3
- esmodule / ts
js
import miningo from 'miningo'
`- commonjs
js
const miningo = require('miningo').default
`$3
ts
const db = miningo()
`$3
ts
// default
import InMemoryAdapter from 'miningo/adapters/InMemoryAdapter'
const db = miningo(new InMemoryAdapter())// persistent json storage. save json to dataDir. very low performance.
import JsonStorageAdapter from 'miningo/adapters/JsonStorageAdapter'
const db = miningo(new JsonStorageAdapter('./data'))
// persistent storage faster than json storage.
import FastStorageAdapter from 'miningo/adapters/FastStorageAdapter'
const db = miningo(new FastStorageAdapter('./data'))
// persistent local storage for browser.
import LocalStorageAdapter from 'miningo/adapters/LocalStorageAdapter'
const namespace = 'test'
const db = miningo(new LocalStorageAdapter(namespace))
// commonjs
const JsonStorageAdapter = require('miningo/adapters/JsonStorageAdapter').default
`$3
ts
interface Human {
name: string
}const Human = db.collection('Human')
// or you can use json schema
const Human = db.collection('Human', {
name: { type: 'string' }
})
`$3
ts
await Human.drop()
`$3
ts
const you = await Human.insert({ name: 'you' })
`$3
ts
const [you, me] = await Human.insertMany([{ name: 'you' }, { name: 'me' }])
`$3
ts
const doc = await Human.find(you._id)
`$3
ts
const docs = await Human.findAll()
`$3
ts
const docs = await Human.findMany([you._id, me._id])
`$3
ts
const [you] = await Human.findBy({ name: 'you' })
`$3
ts
const updated = await Human.update(you._id, { name: 'me' })
`$3
ts
const removed = await Human.remove(you._id)
`$3
ts
const removed = await Human.removeMany([you._id, me._id])
`$3
ts
await Human.size()
``