Update readme

Author: nettofarah

README.md

@@ -1,99 +1,46 @@
 # postgres-schema-ts
 
-> postgres-schema-ts is a simple npm module you can use to convert a mysql schema into typescript interfaces
+> postgres-schema-ts is a simple npm module you can use to convert a postgres schema into typescript interfaces
 
 # Usage
 
 ```bash
 # to infer an entire schema
-$ npx postgres-schema-ts mysql://root@localhost:3306/database
+$ npx postgres-schema-ts postgresql://postgres@localhost:5433/db?currentSchema=public
 
 # to infer a specific table
-$ npx postgres-schema-ts mysql://root@localhost:3306/database table_name
+$ npx postgres-schema-ts postgresql://postgres@localhost:5433/db?currentSchema=public table_name
 ```
 
 tip: You can pipe the output of postgres-schema-ts into a file with `npx postgres-schema-ts <args> > schema.ts`
 
 ## Demo
 
-For the following SQL schema: (from the musicbrainz database)
+For the following SQL schema:
 
 ```sql
-CREATE TABLE IF NOT EXISTS artist ( -- replicate (verbose)
-    id                  SERIAL,
-    gid                 CHAR(36) NOT NULL,
-    name                VARCHAR(255) NOT NULL,
-    sort_name           VARCHAR(255) NOT NULL,
-    begin_date_year     SMALLINT,
-    begin_date_month    SMALLINT,
-    begin_date_day      SMALLINT,
-    end_date_year       SMALLINT,
-    end_date_month      SMALLINT,
-    end_date_day        SMALLINT,
-    type                INTEGER, -- references artist_type.id
-    area                INTEGER, -- references area.id
-    gender              INTEGER, -- references gender.id
-    comment             VARCHAR(255) NOT NULL DEFAULT '',
-    edits_pending       INTEGER NOT NULL DEFAULT 0 CHECK (edits_pending >= 0),
-    last_updated        TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
-    ended               CHAR(1) NOT NULL DEFAULT FALSE
-);
-
-CREATE TABLE IF NOT EXISTS track ( -- replicate (verbose)
-    id                  SERIAL,
-    gid                 CHAR(36) NOT NULL,
-    recording           INTEGER NOT NULL, -- references recording.id
-    medium              INTEGER NOT NULL, -- references medium.id
-    position            INTEGER NOT NULL,
-    number              TEXT NOT NULL,
-    name                VARCHAR(255) NOT NULL,
-    artist_credit       INTEGER NOT NULL, -- references artist_credit.id
-    length              INTEGER CHECK (length IS NULL OR length > 0),
-    edits_pending       INTEGER NOT NULL DEFAULT 0 CHECK (edits_pending >= 0),
-    last_updated        TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
-    is_data_track       CHAR(1) NOT NULL DEFAULT FALSE
-) CHARACTER SET utf8 COLLATE utf8_general_ci;
+CREATE TABLE account (
+  username VARCHAR (50) UNIQUE NOT NULL,
+  password VARCHAR (50) NOT NULL,
+  email VARCHAR (355) UNIQUE NOT NULL,
+  created_on TIMESTAMP NOT NULL,
+  last_login TIMESTAMP
+)
 ```
 
 run:
 
 ```bash
-$ npx postgres-schema-ts mysql://root@localhost:3306/musicbrainz
+$ npx postgres-schema-ts postgresql://postgres@localhost:5433/db?currentSchema=public
 ```
 
 ```typescript
-export interface artist {
-  id: number
-  gid: string
-  name: string
-  sort_name: string
-  begin_date_year: number | null
-  begin_date_month: number | null
-  begin_date_day: number | null
-  end_date_year: number | null
-  end_date_month: number | null
-  end_date_day: number | null
-  type: number | null
-  area: number | null
-  gender: number | null
-  comment: string
-  edits_pending: number
-  last_updated: Date
-  ended: string
-}
-export interface track {
-  id: number
-  gid: string
-  recording: number
-  medium: number
-  position: number
-  number_: string
-  name: string
-  artist_credit: number
-  length: number | null
-  edits_pending: number
-  last_updated: Date
-  is_data_track: string
+export interface account {
+  username: string
+  password: string
+  email: string
+  created_on: Date
+  last_login: Date | null
 }
 ```
 
@@ -112,7 +59,7 @@ postgres-schema-ts is inpired by the awesome [schemats](https://github.com/Sweet
 But takes a simpler, more blunt, and configuration free approach:
 
 - Simpler defaults
-- MySQL support only
+- Postgres support only
 - Inline enums
 - No support for namespaces
 

package.json

@@ -57,7 +57,6 @@
   "devDependencies": {
     "@types/jest": "^24.0.23",
     "@types/lodash": "^4.14.149",
-    "@types/mysql": "^2.15.8",
     "@types/node": "^12.12.14",
     "@types/prettier": "^1.19.0",
     "@typescript-eslint/eslint-plugin": "^2.10.0",

yarn.lock

@@ -425,13 +425,6 @@
   resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.3.tgz#3dca0e3f33b200fc7d1139c0cd96c1268cadfd9d"
   integrity sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA==
 
-"@types/mysql@^2.15.8":
-  version "2.15.8"
-  resolved "https://registry.yarnpkg.com/@types/mysql/-/mysql-2.15.8.tgz#305172ee6ec530acd16a713f680dbfb4399960a8"
-  integrity sha512-l0TUdg6KDEaLO75/yjdjksobJDRWv8iZlpRfv/WW1lQZCQDKdTDnKCkeH10oapzP/JTuKiTy6Cvq/sm/0GgcUw==
-  dependencies:
-    "@types/node" "*"
-
 "@types/node@*", "@types/node@^12.12.14":
   version "12.12.18"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-12.12.18.tgz#8d16634797d63c2af5bc647ce879f8de20b56469"