driver-interface - npm Package Compare versions

Comparing version 1.0.6 to 1.0.8

layers/migratable/define-physical-model.js

@@ -7,3 +7,3 @@ module.exports = {
 
-  description: '',//TODO
+  description: 'Define a physical model (e.g. relational table or Mongo collection, etc) with the specified characteristics, creating indexes as needed.',
 
@@ -16,5 +16,25 @@
 
-    connection: require('../../constants/connection.input'),
-    // TODO: the rest
+    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'),
+
   },
@@ -25,3 +45,5 @@
 
-    // TODO
+    success: {
+      description: 'New physical model (and any necessary indexes) were created successfully.'
+    }
 
@@ -28,0 +50,0 @@ },

layers/migratable/drop-physical-model.js

@@ -7,3 +7,3 @@ module.exports = {
 
-  description: '',//TODO
+  description: 'Completely drop & destroy any traces of a particular physical model (e.g. relational table or Mongo collection, etc).',
 
@@ -16,5 +16,11 @@
 
-    connection: require('../../constants/connection.input'),
-    // TODO: the rest
+    connection:
+      require('../../constants/connection.input'),
 
+    tableName:
+      require('../../constants/tableName.input'),
+
+    meta:
+      require('../../constants/meta.input'),
+
   },
@@ -25,3 +31,5 @@
 
-    // TODO
+    success: {
+      description: 'If such a physical model exists, it was dropped successfully.'
+    }
 
@@ -28,0 +36,0 @@ },

layers/migratable/set-physical-sequence.js

@@ -7,3 +7,3 @@ module.exports = {
 
-  description: '',//TODO
+  description: 'Reset an auto-incrementing sequence to the specified value.',
 
@@ -16,5 +16,19 @@
 
-    connection: require('../../constants/connection.input'),
-    // TODO: the rest
+    connection:
+      require('../../constants/connection.input'),
 
+    sequenceName: {
+      description: 'The (physical layer) name of the auto-incrementing sequence.',
+      example: 'user_id_seq',
+      required: true
+    },
+
+    sequenceValue: {
+      example: 1,
+      required: true
+    },
+
+    meta:
+      require('../../constants/meta.input'),
+
   },
@@ -25,4 +39,11 @@
 
-    // TODO
+    success: {
+      description: 'The auto-incrementing sequence was successfully reset to the specified value.',
+      extendedDescription: 'This means the next value in this auto-incrementing sequence will start from here.'
+    },
 
+    notFound: {
+      description: 'Could not find a sequence with the specified name.'
+    },
+
   },
@@ -29,0 +50,0 @@

layers/queryable/send-native-query.js

@@ -12,2 +12,5 @@ module.exports = {
 
+    connection:
+      require('../../constants/connection.input'),
+
     nativeQuery: {
@@ -30,5 +33,2 @@ description: 'A native query for the database.',
     },
-    
-    connection:
-      require('../../constants/connection.input'),
 
@@ -35,0 +35,0 @@ meta:

package.json

 {
   "name": "driver-interface",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Standardized interface for common functionality, expressed in layers.  Covers communication with databases, hardware, web services, and more.",
@@ -5,0 +5,0 @@ "scripts": {

No alert changes

Improved metrics

Total package byte prevSize

68388

increased by2.75%

Number of package files

42

increased by2.44%

Lines of code

1021

increased by5.58%

No dependency changes