Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/devtool-db-introspection
Database Introspection Tool - Open-Source | AppSeed
https://github.com/app-generator/devtool-db-introspection
data-analysis database-schema database-tool db-scan db-tool developer-tools peewee peewee-orm python-database python-datatypes python-db python-tool
Last synced: 13 days ago
JSON representation
Database Introspection Tool - Open-Source | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/devtool-db-introspection
- Owner: app-generator
- License: other
- Created: 2022-02-11T03:14:41.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-26T13:47:02.000Z (over 2 years ago)
- Last Synced: 2024-10-11T04:44:42.377Z (about 1 month ago)
- Topics: data-analysis, database-schema, database-tool, db-scan, db-tool, developer-tools, peewee, peewee-orm, python-database, python-datatypes, python-db, python-tool
- Language: Python
- Homepage: https://appseed.us/developer-tools/
- Size: 26.4 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Database Introspection Tool
`Open-Source` **[developers tool](https://appseed.us/developer-tools/)** that provides simple helpers for legacy databases introspection. Crafted on top of `Python` and [Peewee](http://docs.peewee-orm.com/en/latest/).
- 👉 Free [support](https://appseed.us/support/) via Email and [Discord](https://discord.gg/fZC6hup)
- 👉 More [Developer Tools](https://appseed.us/developer-tools/) - provided by AppSeed
> Features
- `Peewee` DB Reflection
- Supported DB:
- SQLite, MySql, PostgreSQL
- DbWrapper Class:
- `print_all_models()` - returns all tables
- `print_db_model` - print table definition
- `dump_tables()` - Dump SQL definitions (all tables)
- `dump_tables_data()` - Dump database content (all tables)
> [Support](https://appseed.us/support) via **Github** (issues tracker) and [Discord](https://discord.gg/fZC6hup).
## ✨ Quick Start
> Clone Sources (this repo)
```bash
$ git clone https://github.com/app-generator/devtool-db.git
$ cd devtool-db
```
> Install Modules using a Virtual Environment
```bash
$ virtualenv env
$ source env/bin/activate
$ pip install -r requirements.txt
```
Or for **Windows-based Systems**
```bash
$ virtualenv env
$ .\env\Scripts\activate
$
$ # Install modules - SQLite Database
$ pip3 install -r requirements.txt
```
> Launch the Python console
```bash
$ python
>>>
>>> from util import * # import helpers
>>>
>>> db_sqlite = DbWrapper() # invoke the Base Class
>>> db_sqlite.driver = COMMON.DB_SQLITE # set driver
>>> db_sqlite.db_name = 'samples/api-django.sqlite3' # set db name
>>> db_sqlite.connect() # connect
True
>>> db_sqlite.load_models() # load DB SChema
True
>>> db_sqlite.dump_tables() # Dump tables definitions
True
>>> db_sqlite.dump_tables_data() # Dump data
> Dump data for [api_user_user]
> Dump data for [api_authentication_activesession]
> Dump data for [auth_group]
> Dump data for [api_user_user_groups]
> Dump data for [django_content_type]
> Dump data for [auth_permission]
> Dump data for [api_user_user_user_permissions]
> Dump data for [auth_group_permissions]
> Dump data for [django_admin_log]
> Dump data for [django_migrations]
> Dump data for [django_session]
True
>>> db_sqlite.reset() # reset the Class data
>>>
```
At this point, the tables and data are saved in the [output](https://github.com/app-generator/devtool-db/tree/main/output) directory.
```bash
$ cd output ; ls
$ SQLITE.sql
$ SQLITE_api_user_user.sql
$ SQLITE_auth_permission.sql
$ SQLITE_django_content_type.sql
$ SQLITE_django_migrations.sql
```
---
Database Introspection Tool - Provided by **AppSeed** [App Generator](https://appseed.us/app-generator).