{"id":18601715,"url":"https://github.com/mi2-warsaw/dbexplorer","last_synced_at":"2026-05-05T09:32:12.698Z","repository":{"id":80424178,"uuid":"136007932","full_name":"mi2-warsaw/dbexplorer","owner":"mi2-warsaw","description":"Database exploring tool","archived":false,"fork":false,"pushed_at":"2018-06-11T15:40:44.000Z","size":971,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-19T10:47:02.027Z","etag":null,"topics":["database","mysql","postgres","python","redshift","teradata"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mi2-warsaw.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-04T10:15:51.000Z","updated_at":"2018-06-11T15:40:46.000Z","dependencies_parsed_at":"2023-03-12T10:57:22.910Z","dependency_job_id":null,"html_url":"https://github.com/mi2-warsaw/dbexplorer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mi2-warsaw/dbexplorer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mi2-warsaw%2Fdbexplorer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mi2-warsaw%2Fdbexplorer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mi2-warsaw%2Fdbexplorer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mi2-warsaw%2Fdbexplorer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mi2-warsaw","download_url":"https://codeload.github.com/mi2-warsaw/dbexplorer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mi2-warsaw%2Fdbexplorer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32643587,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"online","status_checked_at":"2026-05-05T02:00:06.033Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","mysql","postgres","python","redshift","teradata"],"created_at":"2024-11-07T02:09:13.403Z","updated_at":"2026-05-05T09:32:12.673Z","avatar_url":"https://github.com/mi2-warsaw.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DatabaseExplorer\n\n## Description\n\n### Info\nThe program was created for *Team project - development of data analysis system* course run by [@pbiecek](https://github.com/pbiecek).\n\n\n### Program description\n\nThe aim of the created program is to generate a summary report of provided database.\nIt extracts basic or extended information such as:\n \n* table, column names\n* data stats (top values, mean, quartiles etc.)\n* types of data and number of rows\n\nGenerated report has a searching feature which allows to find tables or columns by names and exact values.\n\n#### Further information\n\nFull 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).\n\n\n## Installation\n\n1. Clone repository: `git clone https://github.com/mi2-warsaw/dbexplorer.git`\n2. Change to directory: `cd dbexplorer`\n3. Install package: `pip install .`\n4. Run program with proper arguments: `dbexplorer -s 192.2.3.4 -p 5432 -n dvdrental -u dbadmin -pass password -t postgres -o out.html`\n\n\n## Usage\n\n### Running\n\nThe program can be run from command line with following arguments:\n \n* -e (--extended) — generating report in extended format\n(default: basic format), parameterless,\n* -s (--server) — address of the database host,\n* -p (--port) — port of the database host,\n* -n (--database_name) — name of the database,\n* -u (--user) — user name on behalf of whom the extraction will be done,\n* -pass (--password) — password for the user name,\n* -t (--database_type) — type of database (currenly supported: Redshift, Postgress,\nMysql and Teradata),\n* -o (--output) — output file path,\n* -sc (--schema) — schema name (only postgres, default: public),\n* -d (--odbc_driver) — odbc driver name for Teradata connection (only TeraData).\n* -top (--top_number) — number of desired most frequent values (default: 5)\n* -m (--max_text_length) — max length of text in given column that will allow to summarise top values and distinct count (default: 100)\n\n#### Example commands\n\n* Postgres: \n\n`dbexplorer -s 192.2.3.4 -p 5432 -n dvdrental -u dbadmin\n-pass password -t postgres -o out.html`\n\n* Teradata: \n\n`dbexplorer -e -t teradata -s 192.168.44.128 -u dbc -n\nsample1 -pass dbc -o test.html -d 'Teradata Database ODBC\nDriver 16.20'`\n\n### Screenshots and live examples\n\nExamples of generated reports can be found [here](https://github.com/ppollakr/dbexplorer/blob/master/misc/example_reports).\n\n#### Basic report\n\nLive example is [here](https://cdn.rawgit.com/ppollakr/dbexplorer/68a9e4ae95159aa132f8156386770aa0e7d19c9c/misc/example_reports/basic/mysql_employees.html)\n\n![basic report screenshot](https://github.com/ppollakr/dbexplorer/blob/master/misc/screenshots/basic.png)\n\n#### Extended report\n\nLive example is [here](https://cdn.rawgit.com/ppollakr/dbexplorer/68a9e4ae95159aa132f8156386770aa0e7d19c9c/misc/example_reports/extended/mysql_employees_extended.html)\n\n![extended report screenshot](https://github.com/ppollakr/dbexplorer/blob/master/misc/screenshots/extended.png)\n\n## Authors\n\n* Karol Prusinowski\n* Paweł Pollak\n* Karol Szczawiński\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmi2-warsaw%2Fdbexplorer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmi2-warsaw%2Fdbexplorer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmi2-warsaw%2Fdbexplorer/lists"}