Skip to content

Commit

Permalink
documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Diego Arenas authored and Diego Arenas committed Apr 29, 2019
1 parent 1ea3d58 commit e99673e
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
notebook/.ipynb_checkpoints/*
notebook/Example MySQL.ipynb
notebook/Example Postgres.ipynb
notebook/__pycache__/
notebook/*
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,14 @@ Given two connections, a source and target database, it will collect metadata fo

The metadata from the `source` database will be stored in a `metadata` database that it will be accesible for any visualization tool to explore it.

## How To use AutoEda
## How To use AutoEDADB

* Clone or download the package.
* Create a connection to a source database and another one to a metadata database.
* Run `describe_database()` or `describe_table()` functions to get the metadata from the `source` using your connections.
* Create two connections as described [here](docs/Connections.md) to a source database and to the metadata database.
* Source database: This is the DB you want to explore. You don't need any additional information, just a valid connection to the database.
* Metadata database: It can be created if not exists. This database will store the information from the source databases.
* Edit the call of `describe_server(<YOUR_SERVER>)`.
* Run it with `python explorer.py`

## To Do
- [x] Using samples for large tables.
Expand Down
16 changes: 16 additions & 0 deletions docs/Connections.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Connections

Connections are stoder in `string_connections/` folder.

Should be of the type:

## ODBC

If you have an ODBC created pointed to the database

DSN=<YOUR_ODBC_NAME>

If you had it installed, you can use it directly from the code creating the following string_connection.

DRIVER={ODBC Driver 13 for SQL Server};SERVER=<FQDN_OF_THE_SERVER>;DATABASE=<YOUR_DATABASE>;UID=<YOUR_USER>;PWD=<YOUR_PASSWORD>

0 comments on commit e99673e

Please sign in to comment.