MYSQL-TABLE
Useful utility for creating and manipulating mysql tables using KnexJS. Works with any db knex supports: Postgres, MSSQL, MySQL, MariaDB, SQLite3, Oracle, and Amazon Redshift. Simplified schema definition, and automatic db/table creation. Includes a streaming interface.
Initialization
var Table Init Utils = ; const config = database: 'series' host: '127.0.0.1' port: 3306 user: 'root' password: 'some_secret_password' { var SCHEMA = table: 'series' { // columnss schema schema schema // indexs schemaindex'rank' } return };
Data Models
Config Object
Object containing connection options or knex config object.
const config = database: 'epic_application' host: '127.0.0.1' port: 3306 user: 'root' password: 'some_secret_password'
Schema Object
table
- the table namefields
- function using the knex schema building tools. Referance Docs
var SCHEMA = table: 'users' { // columnss schema schema schema // indexs schemaindex'rank' }
API INTERFACE
Init(config, tables)
Creates the database and initalizes connection pool. Also creates and initalizes table schemas.
returns object keyed by table name each containing Table Methods for the table.
config
- configuration and database connection options.tables
- single or array of table definitions.
const config = ... // SINGLE DEFINITIONvar tables = // OR, ARRAY OF DEFINITIONSvar tables = ...
Table(con, schema) & Utils
Creates table and initalizes your defined schema, will ignore if the table is already created.
Returns object of Table Methods.
con
- Database connection from the init method.schema
- Schema Object
module { var Table Utils = var schema = ... return }
Table Methods
table.alter(schema)
Modify the table schema.
table.get(id)
Get a single row from the table.
table.getAll(ids)
Get many rows from the table.
table.getBy(field, id)
Get rows from the table by column.
table.has(id)
Check table for existing row using id.
table.hasBy(field, id)
Check table for existing row using column and id.
table.update(id, fieldsObj)
Update a row.
table.upsert(fieldsObj)
Update an object if key exists, or insert new object otherwise.
table.create(fieldsObj)
Create a new row in the table, will throw error if another row is exisitng with the same id.
table.filter(filterObj)
Filter the table.
table.count()
Count all rows in the table.
table.readStream()
Stream the table.
table.streamify(query)
Streamify a query.
table.list()
List all rows in the table.
table.delete(id)
Delete a row from the table.
table.drop()
Drop the table entirely.
table.schema
Return the current table schema.
table.con
Return the base class knex object.