|
1 | | -# SeeQL |
| 1 | +<p align="center"> |
| 2 | +<img width="250" alt="SeeQL Title" src="https://user-images.githubusercontent.com/29069478/60289605-ca915b80-98e4-11e9-943f-c40cb919c21e.png"> |
| 3 | +</p> |
2 | 4 |
|
3 | | -now loading... |
| 5 | +--- |
| 6 | + |
| 7 | +Welcome to **SeeQL (beta)**: An easy-to-use desktop application that helps you visualize your database tables (including all foreign and primary key relationships), to quickly generate complex queries. |
| 8 | + |
| 9 | + |
| 10 | +## Getting Started |
| 11 | + |
| 12 | +#### Requirements |
| 13 | + |
| 14 | +You'll need a Postgres database to connect to. |
| 15 | + |
| 16 | +#### How to Install |
| 17 | + |
| 18 | +Beta Release 0.0.1 |
| 19 | + |
| 20 | +**MacOS:** [seeql-0.0.1.dmg](https://github.com/oslabs-beta/seeql/releases/download/untagged-bc5bc2c547e0407d958d/SeeQL-0.0.1.dmg) |
| 21 | + |
| 22 | +*Note:* For now, you might need to go to your security settings to allow the app run on your system to allow the application to run. |
| 23 | + |
| 24 | +Or from the **terminal**, run: |
| 25 | + |
| 26 | +``` |
| 27 | +git clone https://github.com/oslabs-beta/seeql.git |
| 28 | +cd seeql |
| 29 | +yarn |
| 30 | +yarn run build |
| 31 | +yarn start |
| 32 | +
|
| 33 | +``` |
| 34 | + |
| 35 | + |
| 36 | +## Features |
| 37 | + |
| 38 | +**Logging In** |
| 39 | + |
| 40 | +You have the option to log in with a `postgres://` URI connection string, or enter your database credentials individually. |
| 41 | + |
| 42 | + |
| 43 | + |
| 44 | +**Viewing Database Information** |
| 45 | + |
| 46 | +After logging in, you'll see three sections - the side panel, the input box, and the database tables section. In the tables section, when you **hover** over a primary key in a table, any references to this **primary key** in other tables will be highlighted. Similarly, if you hover over a **foreign key** in a table, its related primary key will be highlighted. |
| 47 | + |
| 48 | +Click on any table's **info** icon to view its information in the side panel. |
| 49 | + |
| 50 | +Choose the **Search** option above the input box to filter which tables will be displayed. You can **pin** tables to the top of the page for your convinience by clicking on any table's pin icon. |
| 51 | + |
| 52 | + |
| 53 | + |
| 54 | +**Generating SQL queries & Viewing the results** |
| 55 | + |
| 56 | +You can write a **SQL SELECT query** in the SQL input box, or automatically generate a query by clicking on the rows of a table. Once your query is complete, click **execute query**. If your query has any errors, an error message will display telling you exactly where the error occured. |
| 57 | + |
| 58 | + |
| 59 | + |
| 60 | +After clicking execute, you'll be able to see your results in the **Results** section. Clicking on a column name will sort your table data accordingly. |
| 61 | +You can filter which rows are visible by clicking the search icon next to each column name. |
| 62 | + |
| 63 | + |
| 64 | +## Resources |
| 65 | + |
| 66 | +Built on Electron, React and Typescript |
| 67 | + |
| 68 | +**Creators:** [Kate Matthrews](http://github.com/katesmatthews), [Tyler Sayles](https://github.com/saylestyler), [Ariel Hyman](https://github.com/AHyman18), [Alice Wong](https://github.com/aliicewong) |
0 commit comments