v0.0.4 (#9)

* Test improvement

added reading parallel schema for postgres

* Update devDependencies

* Update .travis.yml

Using PostgreSQL 9.5

* Refactored reading methods

Reading different types of database objects with a single call to the 'read()' method

Remove 'read.tables()' and 'read.sequences()' methods

* Update README

.travis.yml

@@ -1,7 +1,11 @@
-dist: trusty
 language: node_js
 node_js:
   - "9"
+addons:
+  postgresql: "9.5"
+services:
+  - mysql
+  - postgresql
 install:
   - npm install
   - npm install codecov nyc

README.md

@@ -1,3 +1,5 @@
+<br/>
+
 ![](https://multum.github.io/metalize/logo.svg)
 
 Node.js tool for easy reading **database metadata**
@@ -10,7 +12,7 @@ Node.js tool for easy reading **database metadata**
 ## Features
 
 - **PostgreSQL** and **MySQL** dialects
-- Reading **tables** (columns, indexes, primary key, unique, foreign keys, checks)
+- Reading **tables** (columns, indexes, primary keys, unique, foreign keys, checks)
 - Reading **sequences** (start, max, min, cycle, increment)
 
 ## Documentation
@@ -42,8 +44,10 @@ const metalize = new Metalize({
   },
 });
 
-const tables = await metalize.read.tables(['public.users', 'public.events']);
-console.log(tables);
+metalize
+  .read({ tables: ['public.users', 'public.events'] })
+  .then(result => console.log(result.tables));
+
 /**
 Map {
   'public.users' => {
@@ -64,7 +68,7 @@ Map {
 
 - **[Node.js](https://nodejs.org)** **v8.10** or more
 - **[PostgreSQL server](https://www.postgresql.org/download)** **v9.2** or more
-- **[node-postgres](https://github.com/brianc/node-postgres)**
+- **[node-postgres](https://github.com/brianc/node-postgres)** **v7.1** or more
 
 ```bash
 npm install metalize pg
@@ -84,8 +88,10 @@ const metalize = new Metalize({
   },
 });
 
-const tables = await metalize.read.tables(['public.users', 'public.events']);
-console.log(tables);
+metalize
+  .read({ tables: ['public.users', 'public.events'] })
+  .then(result => console.log(result.tables));
+
 /**
 Map {
   'public.users' => {
@@ -100,8 +106,10 @@ Map {
 }
 */
 
-const sequences = await metalize.read.sequences(['public.users_seq']);
-console.log(sequences);
+metalize
+  .read({ sequences: ['public.users_seq'] })
+  .then(result => console.log(result.sequences));
+
 /**
 Map {
   'public.users_seq' => {

docs/metadata/check.md

@@ -1,5 +1,11 @@
 # Check
 
+## name
+
+- Type: `String`
+
+Constraint name
+
 ## condition
 
 - Type: `string`

docs/metadata/foreign-key.md

@@ -1,5 +1,11 @@
 # ForeignKey
 
+## name
+
+- Type: `String`
+
+Constraint name
+
 ## columns
 
 - Type: `Array<String>`

docs/metadata/index.md

@@ -1,5 +1,11 @@
 # Index
 
+## name
+
+- Type: `String`
+
+Index name
+
 ## columns
 
 - Type: `Array<String>`

docs/metadata/primary-key.md

@@ -1,5 +1,11 @@
 # PrimaryKey
 
+## name
+
+- Type: `String`
+
+Constraint name
+
 ## columns
 
 - Type: `Array<String>`

docs/metadata/unique.md

@@ -1,5 +1,11 @@
 # unique
 
+## name
+
+- Type: `String`
+
+Constraint name
+
 ## columns
 
 - Type: `Array<String>`

docs/methods.md

@@ -1,15 +1,10 @@
 # Methods
 
-## read.tables
+## read
 
-- Arguments: (names: `Array<String>`)
-- Returns: [`Promise<TableMetadata>`](metadata/table.md)
+- Arguments: (`{ ['tables' | 'sequences']: Array<String> }`)
+- Returns: `Promise<{ ['tables' | 'sequences']: Map<String, Metadata | undefined> }>`
 
-Getting the metadata of an existing tables
+> see [table metadata](metadata/table.md) and [sequence metadata](metadata/sequence.md)
 
-## read.sequences
-
-- Arguments: (names: `Array<String>`)
-- Returns: [`Promise<SequenceMetadata>`](metadata/sequence.md)
-
-Getting the metadata of an existing sequences
+Getting the metadata of an existing objects

lib/dialects/abstract/client.js → lib/dialects/base/connectionManeger.js

@@ -6,7 +6,7 @@
  */
 'use strict';
 
-class AbstractClient {
+class BaseConnectionManager {
   _loadDialectModule(name) {
     try {
       return require(name);
@@ -23,4 +23,4 @@ class AbstractClient {
   _end() {}
 }
 
-module.exports = AbstractClient;
+module.exports = BaseConnectionManager;

lib/dialects/abstract/sequence.js → lib/dialects/base/sequence.js

@@ -6,16 +6,12 @@
  */
 'use strict';
 
-class AbstractSequenceReader {
-  constructor(metalize) {
-    this.metalize = metalize;
-  }
-
-  async read() {
+class BaseSequenceReader {
+  static async read(metalize) {
     throw new Error(
-      `read.sequences(names) method for the \`${this.metalize.dialect}\` dialect is not supported`
+      `read({ sequences: [...] }) method for the \`${metalize.dialect}\` dialect is not supported`
     );
   }
 }
 
-module.exports = AbstractSequenceReader;
+module.exports = BaseSequenceReader;

lib/dialects/mysql/client.js → lib/dialects/mysql/connectionManager.js

@@ -7,11 +7,11 @@
 'use strict';
 
 const helpers = require('../../helpers');
-const AbstractClient = require('../abstract/client');
+const BaseConnectionManager = require('../base/connectionManeger');
 
 let lib;
 
-class MySqlClient extends AbstractClient {
+class ConnectionManager extends BaseConnectionManager {
   constructor(metalize) {
     super();
     this.metalize = metalize;
@@ -54,4 +54,4 @@ class MySqlClient extends AbstractClient {
   }
 }
 
-module.exports = MySqlClient;
+module.exports = ConnectionManager;

lib/dialects/mysql/index.js

@@ -6,9 +6,9 @@
  */
 'use strict';
 
-const Client = require('./client');
-const Table = require('./tables');
-const Sequence = require('./sequence');
+const TableInterface = require('./tables');
+const SequenceInterface = require('./sequences');
+const ConnectionManager = require('./connectionManager');
 
 /**
  *
@@ -18,9 +18,9 @@ const Sequence = require('./sequence');
 
 class MySqlDialect {
   constructor() {
-    this.Client = Client;
-    this.Table = Table;
-    this.Sequence = Sequence;
+    this.TableInterface = TableInterface;
+    this.SequenceInterface = SequenceInterface;
+    this.ConnectionManager = ConnectionManager;
   }
 }
 

lib/dialects/mysql/sequence/index.js → lib/dialects/mysql/sequences/index.js

@@ -6,13 +6,8 @@
  */
 'use strict';
 
-const AbstractSequenceReader = require('../../abstract/sequence');
+const BaseSequenceReader = require('../../base/sequence');
 
-class SequenceReader extends AbstractSequenceReader {
-  constructor(metalize, options) {
-    super(metalize);
-    this.options = options;
-  }
-}
+class SequenceReader extends BaseSequenceReader {}
 
 module.exports = SequenceReader;

lib/dialects/mysql/tables/index.js

@@ -11,46 +11,36 @@ const parser = require('./parser');
 const utils = require('../../../utils');
 
 class TableReader {
-  constructor(metalize, options) {
-    this.metalize = metalize;
-    this.names = options.names;
-  }
-
-  getColumns() {
-    return this.metalize._client
-      .query(queries.getColumns(this.names))
+  static getColumns(metalize, names) {
+    return metalize._client
+      .query(queries.getColumns(names))
       .then(utils.group('table'))
       .then(utils.map(parser.columns));
   }
 
-  getConstraints() {
-    return this.metalize._client
-      .query(queries.getConstraints(this.names))
+  static getConstraints(metalize, names) {
+    return metalize._client
+      .query(queries.getConstraints(names))
       .then(utils.group('table'))
       .then(
-        utils.map(
-          utils.pipe(
-            parser.constraints,
-            utils.cleanableGroup('type')
-          )
-        )
+        utils.map(utils.pipe(parser.constraints, utils.cleanableGroup('type')))
       );
   }
 
-  getIndexes() {
-    return this.metalize._client
-      .query(queries.getIndexes(this.names))
+  static getIndexes(metalize, names) {
+    return metalize._client
+      .query(queries.getIndexes(names))
       .then(utils.group('table'))
       .then(utils.map(parser.indexes));
   }
 
-  async read() {
+  static async read(metalize, names) {
     const [columns, constraints, indexes] = await Promise.all([
-      this.getColumns(),
-      this.getConstraints(),
-      this.getIndexes(),
+      TableReader.getColumns(metalize, names),
+      TableReader.getConstraints(metalize, names),
+      TableReader.getIndexes(metalize, names),
     ]);
-    return this.names.reduce((acc, name) => {
+    return names.reduce((acc, name) => {
       const structure = utils.get([name, 0], columns)
         ? {
             name,

lib/dialects/postgres/client.js → lib/dialects/postgres/connectionManager.js

@@ -6,11 +6,11 @@
  */
 'use strict';
 
-const AbstractClient = require('../abstract/client');
+const BaseConnectionManager = require('../base/connectionManeger');
 
 let lib;
 
-class PostgresClient extends AbstractClient {
+class ConnectionManager extends BaseConnectionManager {
   constructor(metalize) {
     super();
     this.metalize = metalize;
@@ -36,12 +36,12 @@ class PostgresClient extends AbstractClient {
     }
   }
 
-  async query(sql) {
+  query(sql) {
     if (!this._client) {
-      await this._connect();
+      this._connect();
     }
     return this._client.query(sql);
   }
 }
 
-module.exports = PostgresClient;
+module.exports = ConnectionManager;

lib/dialects/postgres/index.js

@@ -6,9 +6,9 @@
  */
 'use strict';
 
-const Client = require('./client');
-const Table = require('./tables');
-const Sequence = require('./sequence');
+const TableInterface = require('./tables');
+const SequenceInterface = require('./sequences');
+const ConnectionManager = require('./connectionManager');
 
 /**
  *
@@ -18,9 +18,9 @@ const Sequence = require('./sequence');
 
 class PostgresDialect {
   constructor() {
-    this.Client = Client;
-    this.Table = Table;
-    this.Sequence = Sequence;
+    this.TableInterface = TableInterface;
+    this.SequenceInterface = SequenceInterface;
+    this.ConnectionManager = ConnectionManager;
   }
 }