driver-interface
Version:
Standardized interface for common functionality, expressed in layers. Covers communication with databases, hardware, web services, and more.
51 lines (31 loc) • 896 B
JavaScript
module.exports = {
friendlyName: 'Define (physical model)',
description: 'Define a physical model (e.g. relational table or Mongo collection, etc) with the specified characteristics, creating indexes as needed.',
sideEffects: 'idempotent',
inputs: {
connection:
require('../../constants/connection.input'),
tableName:
require('../../constants/tableName.input'),
columns: {
description: 'An array of column definitions.',
required: true,
type: [ {}, ],
example: [
{
columnName: 'foo_bar',
unique: true,
columnType: 'VARCHAR(255)',
autoIncrement: false,
},
]
},
meta:
require('../../constants/meta.input'),
},
exits: {
success: {
description: 'New physical model (and any necessary indexes) were created successfully.'
}
},
};