@the-/db v21.0.5

@the-/db

DB for the-framework

Installation

$ npm install @the-/db --save

Usage

'use strict'

const { TheDB } = require('@the-/db')
const {
  DataTypes: { STRING },
} = require('@the-/resource')

const db = new TheDB({
  dialect: 'sqlite', // Uses "clay-driver-sqlite" package
  storage: 'var/my-app.db', // File path to save
})

// Define factory method for resource
// See https://github.com/realglobe-Inc/clay-resource for more detail
const User = db.defineResource(
  'User',
  // Resource policy'
  // https://github.com/realglobe-Inc/clay-policy#usage
  {
    password: { type: STRING },
    username: { type: STRING },
  },
  {
    interceptors: {
      // Convert entity attributes on inbound
      inbound(attributes) {
        const digest = () => {
          /* ... */
        }
        attributes.passwordHash = digest(attributes.password)
        return attributes
      },
      // Convert entity attributes on outbound
      outbound(attributes) {
        delete attributes.password
        return attributes
      },
    },
    // Enhance entity class
    entityClass(ResourceEntity) {
      return class UserResourceEntity extends ResourceEntity {
        get fullName() {
          const { firstName, lastName } = this
          return [firstName, lastName].filter(Boolean).join(' ')
        }
      }
    },
    // Create index to enable filter/sort with nested attributes
    indices() {
      return ['profile.name', 'profile.email']
    },
    schema() {
      return {}
    },
  },
)

async function tryExample() {
  const user = await User.create({
    password: 'Super Cool',
    username: 'Black Fire',
  })
  console.log(user)
  /* ... */
}

tryExample().catch((err) => console.error(err))

API Guide

• execSqlite
  • .parsePolicy(policy)
• module:@the-/db
  • .cascadeMix(Class)
  • .cliMix(Class)
  • .create(args)
  • .default()
  • .driverFromEnv(env,options)
  • .execForEnv(env,sql)
  • .helpers
  • .migrateMix()
  • .mixins
  • .refreshMix(Class)
  • .resourceMix(Class)
  • .resources
  • .setupForEnv(env)
  • .TheDB
  • .TheDBBase
  • .TheLogResource
  • .TheSchemaResource
  • ~MigrateMixed
• module:@the-/db.cascadeMix
  • ~CascadeMixed
• module:@the-/db.cliMix
  • ~CliMixed
• module:@the-/db.helpers
  • .binder
  • .createTerminal(handler,options=)
  • .execMysql(env,sqls)
  • .execSqlite(env,sql,options=)
• module:@the-/db.refreshMix
  • ~RefreshMixed
• module:@the-/db.refreshMix~RefreshMixed
  • #requestToRefresh(entityRef)
  • #startRefreshLoop(interval)
  • #stopRefreshLoop()
  • #waitToRefresh(entityRef,options)
• module:@the-/db.resourceMix
  • ~ResourceMixed
• module:@the-/db.resourceMix~ResourceMixed
  • #assertResource(resourceName)
  • #getResource(resourceName)
  • #hasResource(resourceName)
• module:@the-/db.setup
  • .setupMysql(env,options=)
  • .setupPostgres(env,options=)
  • .setupSqlite(env,options=)
• module:@the-/db.TheDB
  • #assertResource(resourceName)
  • #getResource(resourceName)
  • #hasResource(resourceName)
  • #requestToRefresh(entityRef)
  • #startRefreshLoop(interval)
  • #stopRefreshLoop()
  • #waitToRefresh(entityRef,options)
• module:@the-/db~MigrateMixed
  • #migrate(handlers)
• TheDB
  • #drop()
  • #hooksFromMapping(HookMapping)
  • #invalidate(entityRef)
  • #load(ResourceFactory,resourceName)
  • #loadFromMapping(ResourceMapping)
  • #pluginFromMapping(PluginMapping)
  • #transaction(callback)
  • #unref()
  • #updateVersion(version)

See API Guide for more detail

License

This software is released under the MIT License.

Links

• THE Labo