README
¶
DB Descriptor
DB Descriptor — a light tool for describing a database.
This tool inspects a database (for now PostgreSQL) and retrieves basic information about some database objects: table/view names, column names, column data type and comments. It writes a JSON file with the information, but also exposes methods to process the information programatically.
Usage
USAGE:
database descriptor [global options] command [command options] [arguments...]
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--host value, -H value database host (default: "localhost")
--port value, -P value database port (default: 8080)
--user value, -u value database user (default: "admin")
--password value, -p value database password (default: "password")
--name value, -n value database name (default: "test")
--schemas value, -s value [ --schemas value, -s value ] comma separated list of schemas to describe (default: "public")
--dbtype value, --dt value specify the database type (default: "postgres")
--output value, -o value JSON output file name the description of the database (default: "output.json")
--help, -h show help
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
db-descriptor
db-descriptor analyses a list of schemas in a database and creates a JSON file with information about its tables, views and columns.
|
db-descriptor analyses a list of schemas in a database and creates a JSON file with information about its tables, views and columns. |
|
internal
|
|
|
extractor
Package extractor contains the logic to extract descriptions from a database.
|
Package extractor contains the logic to extract descriptions from a database. |
|
pkg
|
|
|
connector
Package connector contains structs and interfaces to connect to the database and get the descriptions.
|
Package connector contains structs and interfaces to connect to the database and get the descriptions. |
|
model
Package model contains structs to represent the information extracted from a database, like table names, view names, column names, etc.
|
Package model contains structs to represent the information extracted from a database, like table names, view names, column names, etc. |
|
report
Package report contains logic to report the descriptions of a database.
|
Package report contains logic to report the descriptions of a database. |
|
service
Package service contains the entry point of the logic to retrieve descriptions from a database.
|
Package service contains the entry point of the logic to retrieve descriptions from a database. |
Click to show internal directories.
Click to hide internal directories.