knex-schema-inspector - npm Package Compare versions

Comparing version 1.6.6 to 1.7.0

dist/dialects/postgres.d.ts

@@ -12,3 +12,3 @@ import { Knex } from 'knex';
     column_default: any | null;
-    character_maximum_length: number | null;
+    character_maximum_length: null | number | string;
     is_generated: 'NEVER' | 'ALWAYS';
@@ -20,4 +20,4 @@ is_nullable: 'YES' | 'NO';
     generation_expression: null | string;
-    numeric_precision: null | number;
-    numeric_scale: null | number;
+    numeric_precision: null | number | string;
+    numeric_scale: null | number | string;
     serial: null | string;
@@ -24,0 +24,0 @@ column_comment: string | null;

dist/dialects/postgres.js

@@ -45,2 +45,5 @@ "use strict";
 var lodash_isnil_1 = __importDefault(require("lodash.isnil"));
+function convertStringOrNumber(t) {
+    return t == undefined ? t : Number(t);
+}
 function rawColumnToColumn(rawColumn) {
@@ -53,5 +56,5 @@ return {
         generation_expression: rawColumn.generation_expression || null,
-        max_length: rawColumn.character_maximum_length,
-        numeric_precision: rawColumn.numeric_precision,
-        numeric_scale: rawColumn.numeric_scale,
+        max_length: convertStringOrNumber(rawColumn.character_maximum_length),
+        numeric_precision: convertStringOrNumber(rawColumn.numeric_precision),
+        numeric_scale: convertStringOrNumber(rawColumn.numeric_scale),
         is_generated: rawColumn.is_generated === 'ALWAYS',
@@ -58,0 +61,0 @@ is_nullable: rawColumn.is_nullable === 'YES',

dist/index.js

@@ -12,2 +12,5 @@ "use strict";
             break;
+        case 'Client_CockroachDB':
+            constructor = require('./dialects/cockroachdb').default;
+            break;
         case 'Client_SQLite3':
@@ -14,0 +17,0 @@ constructor = require('./dialects/sqlite').default;

lib/dialects/postgres.ts

@@ -21,3 +21,3 @@ import { Knex } from 'knex';
   column_default: any | null;
-  character_maximum_length: number | null;
+  character_maximum_length: null | number | string;
   is_generated: 'NEVER' | 'ALWAYS';
@@ -29,4 +29,4 @@ is_nullable: 'YES' | 'NO';
   generation_expression: null | string;
-  numeric_precision: null | number;
-  numeric_scale: null | number;
+  numeric_precision: null | number | string;
+  numeric_scale: null | number | string;
   serial: null | string;
@@ -39,2 +39,6 @@ column_comment: string | null;
 
+function convertStringOrNumber(t: string | number | null): number | null {
+  return t == undefined ? t : Number(t);
+}
+
 export function rawColumnToColumn(rawColumn: RawColumn): Column {
@@ -47,5 +51,5 @@ return {
     generation_expression: rawColumn.generation_expression || null,
-    max_length: rawColumn.character_maximum_length,
-    numeric_precision: rawColumn.numeric_precision,
-    numeric_scale: rawColumn.numeric_scale,
+    max_length: convertStringOrNumber(rawColumn.character_maximum_length),
+    numeric_precision: convertStringOrNumber(rawColumn.numeric_precision),
+    numeric_scale: convertStringOrNumber(rawColumn.numeric_scale),
     is_generated: rawColumn.is_generated === 'ALWAYS',
@@ -52,0 +56,0 @@ is_nullable: rawColumn.is_nullable === 'YES',

lib/index.ts

@@ -14,2 +14,5 @@ import { Knex } from 'knex';
       break;
+    case 'Client_CockroachDB':
+      constructor = require('./dialects/cockroachdb').default;
+      break;
     case 'Client_SQLite3':
@@ -16,0 +19,0 @@ constructor = require('./dialects/sqlite').default;

package.json

 {
   "name": "knex-schema-inspector",
-  "version": "1.6.6",
+  "version": "1.7.0",
   "description": "Utility for extracting information about existing DB schema",
@@ -46,3 +46,3 @@ "main": "dist/index.js",
     "husky": "^4.2.5",
-    "knex": "^0.95.1",
+    "knex": "^0.95.14",
     "lint-staged": "^10.2.11",
@@ -49,0 +49,0 @@ "mocha": "^8.3.0",

README.md

@@ -16,3 +16,3 @@ # knex-schema-inspector
 ```
-yarn knex-schema-inspector
+yarn add knex-schema-inspector
 ```
@@ -28,3 +28,3 @@
 
-const database = knex({
+const database = Knex({
   client: 'mysql',
@@ -64,2 +64,24 @@ connection: {
 
+### Methods
+
+**Table**
+
+- [`tables(): Promise<string[]>`](#tables-promisestring)
+- [`tableInfo(table?: string): Promise<Table | Table[]>`](#tableinfotable-string-promisetable--table)
+- [`hasTable(table: string): Promise<boolean>`](#hastabletable-string-promiseboolean)
+
+**Columns**
+
+- [`columns(table?: string): Promise<{ table: string, column: string }[]>`](#columnstable-string-promise-table-string-column-string-)
+- [`columnInfo(table?: string, column?: string): Promise<Column[] | Column>`](#columninfotable-string-column-string-promisecolumn--column)
+- [`primary(table: string): Promise<string>`](#primarytable-string-promisestring)
+
+**Foreign Keys**
+
+- [`foreignKeys(): Promise<ForeignKey>`](#foreign-keys)
+
+**Misc.**
+
+- [`withSchema(schema: string): void`](#withschemaschema-string-void)
+
 ### Tables
@@ -66,0 +88,0 @@

No alert changes

Improved metrics

Total package byte prevSize

338824

increased by9.18%

Number of package files

67

increased by9.84%

Lines of code

7588

increased by11.85%

Number of lines in readme file

288

increased by8.27%

No dependency changes