https://github.com/mi2-warsaw/dbexplorer
Database exploring tool
https://github.com/mi2-warsaw/dbexplorer
database mysql postgres python redshift teradata
Last synced: about 1 month ago
JSON representation
Database exploring tool
- Host: GitHub
- URL: https://github.com/mi2-warsaw/dbexplorer
- Owner: mi2-warsaw
- License: apache-2.0
- Created: 2018-06-04T10:15:51.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-11T15:40:44.000Z (about 8 years ago)
- Last Synced: 2025-06-19T10:47:02.027Z (12 months ago)
- Topics: database, mysql, postgres, python, redshift, teradata
- Language: HTML
- Homepage:
- Size: 948 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DatabaseExplorer
## Description
### Info
The program was created for *Team project - development of data analysis system* course run by [@pbiecek](https://github.com/pbiecek).
### Program description
The aim of the created program is to generate a summary report of provided database.
It extracts basic or extended information such as:
* table, column names
* data stats (top values, mean, quartiles etc.)
* types of data and number of rows
Generated report has a searching feature which allows to find tables or columns by names and exact values.
#### Further information
Full specification and more detailed description of summarization features (in Polish) can be found in [this file](https://github.com/mi2-warsaw/dbexplorer/blob/master/docs/Specyfikacja%20wymaga%C5%84.pdf).
## Installation
1. Clone repository: `git clone https://github.com/mi2-warsaw/dbexplorer.git`
2. Change to directory: `cd dbexplorer`
3. Install package: `pip install .`
4. Run program with proper arguments: `dbexplorer -s 192.2.3.4 -p 5432 -n dvdrental -u dbadmin -pass password -t postgres -o out.html`
## Usage
### Running
The program can be run from command line with following arguments:
* -e (--extended) — generating report in extended format
(default: basic format), parameterless,
* -s (--server) — address of the database host,
* -p (--port) — port of the database host,
* -n (--database_name) — name of the database,
* -u (--user) — user name on behalf of whom the extraction will be done,
* -pass (--password) — password for the user name,
* -t (--database_type) — type of database (currenly supported: Redshift, Postgress,
Mysql and Teradata),
* -o (--output) — output file path,
* -sc (--schema) — schema name (only postgres, default: public),
* -d (--odbc_driver) — odbc driver name for Teradata connection (only TeraData).
* -top (--top_number) — number of desired most frequent values (default: 5)
* -m (--max_text_length) — max length of text in given column that will allow to summarise top values and distinct count (default: 100)
#### Example commands
* Postgres:
`dbexplorer -s 192.2.3.4 -p 5432 -n dvdrental -u dbadmin
-pass password -t postgres -o out.html`
* Teradata:
`dbexplorer -e -t teradata -s 192.168.44.128 -u dbc -n
sample1 -pass dbc -o test.html -d 'Teradata Database ODBC
Driver 16.20'`
### Screenshots and live examples
Examples of generated reports can be found [here](https://github.com/ppollakr/dbexplorer/blob/master/misc/example_reports).
#### Basic report
Live example is [here](https://cdn.rawgit.com/ppollakr/dbexplorer/68a9e4ae95159aa132f8156386770aa0e7d19c9c/misc/example_reports/basic/mysql_employees.html)
#### Extended report
Live example is [here](https://cdn.rawgit.com/ppollakr/dbexplorer/68a9e4ae95159aa132f8156386770aa0e7d19c9c/misc/example_reports/extended/mysql_employees_extended.html)
## Authors
* Karol Prusinowski
* Paweł Pollak
* Karol Szczawiński