Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ilyaplot/postgres-markdown
https://github.com/ilyaplot/postgres-markdown
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ilyaplot/postgres-markdown
- Owner: ilyaplot
- Created: 2019-09-04T21:17:08.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-25T20:33:31.000Z (almost 2 years ago)
- Last Synced: 2024-08-22T13:53:47.572Z (4 months ago)
- Language: TypeScript
- Size: 247 KB
- Stars: 11
- Watchers: 2
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Postgres Markdown
> Builds markdown from a Postgres connection
## Installation:
```
npm install -g postgres-markdown
```
## Usage:
```
Usage: postgres-markdown [options]
Options:
-V, --version output the version number
-H, --host [host] Host (default: "127.0.0.1")
-p, --port [port] Port (default: 5432)
-u, --user [user] User (default: "postgres")
-W, --password [password] Password
-d, --database [database] Database (default: "postgres")
-o, --output [output] Output file name (default: "index.md")
-l, --locale [locale] Locale (default: "ru")
-i, --ignore Pattern of objects to ignore
-v, --verbose Verbose output
-h, --help output usage information
```
## Example DB:
```sql
CREATE SCHEMA users;
COMMENT ON SCHEMA users
IS 'Пользователи';
CREATE TABLE users."user"
(
id serial NOT NULL,
email character varying(100) NOT NULL,
CONSTRAINT user_pkey PRIMARY KEY (id),
CONSTRAINT user_email_key UNIQUE (email)
);
COMMENT ON COLUMN users."user".email IS 'Уникальный email пользователя (логин)';
CREATE TYPE web_users.test_enum AS ENUM
('NEW',
'CLOSED');
CREATE TABLE web_users."user"
(
settings integer[],
status web_users.test_enum,
CONSTRAINT user_pkey PRIMARY KEY (id)
)
INHERITS (users."user");
COMMENT ON COLUMN web_users."user".settings IS 'Массив int флагов';
COMMENT ON COLUMN web_users."user".status IS 'Статус пользователя
NEW - новый, CLOSED - закрытый
Статусы указаны для примера';
```
## Example output:
# Database Documentation
Created at: 2019-09-08T14:32:51.401Z
Server version: PostgreSQL 10.10, compiled by Visual C++ build 1800, 64-bit
## Schema: users
### Tables
#### users.user
Inherited tables:
- [web_users.user](#web_usersuser)
column | comment | type | length | default | constraints | values
--- | --- | --- | --- | --- | --- | ---
**id** _(pk)_ | | integer | | nextval('users.user_id_seq'::regclass) | NOT NULL |
email | Уникальный email пользователя (логин) | character varying | 100 | | NOT NULL |
## Schema: web_users
### Tables
#### web_users.user
column | comment | type | length | default | constraints | values
--- | --- | --- | --- | --- | --- | ---
**id** _(pk)_ | | integer | | nextval('users.user_id_seq'::regclass) | NOT NULL |
email *inherits from [users.user](#usersuser)* | Уникальный email пользователя (логин) | character varying | 100 | | NOT NULL |
settings | Массив int флагов | integer[] | | | |
status | Статус пользователя NEW - новый, CLOSED - закрытый Статусы указаны для примера | user-defined | | | | NEW, CLOSED