Skip to content

Commit

Permalink
add ui screenshots to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
KevinGe00 committed Sep 29, 2023
1 parent b05226d commit ed45afd
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,22 +153,34 @@ or `../gradlew bootRun` (for remote metastore mode) from coral-service module, c
npm run dev
```
Once compiled, the UI can be accessed from the browser at http://localhost:3000.

<p align="center">
<img src="docs/coral-service-ui/start.png" title="Coral Service UI">
</p>
The UI provides 3 features:

#### Create a database/table/view in local metastore mode
This feature is only available with Coral Service in local metastore mode, it calls `/api/catalog-ops/execute` API above.

You can enter a SQL statement to create a database/table/view in the local metastore.
<p align="center">
<img src="docs/coral-service-ui/creation.png" title="Coral Service Creation Feature">
</p>

#### Translate SQL from source language to target language (with rewrites)
This feature is available with Coral Service in both local and remote metastore modes, it calls `/api/translations/translate` API above.

You can enter a SQL query and specify the source and target language to use Coral translation service. You can also
specify the rewrite type to apply on the input query.
<p align="center">
<img src="docs/coral-service-ui/translation.png" title="Coral Service Translation Feature">
</p>

#### Generate graphviz visualizations of Coral intermediate representations
During translation, graphs of the Coral intermediate representations
will also be generated and shown on screen. This will also include any rewritten nodes.
will also be generated and shown on screen. This will also include any post-rewrite nodes.
<p align="center">
<img src="docs/coral-service-ui/graphs.png" title="Coral Service Translation Feature">
</p>

#### Developing on the frontend code

Expand Down
Binary file modified docs/coral-service-ui/creation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/coral-service-ui/graphs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/coral-service-ui/start.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/coral-service-ui/translation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ed45afd

Please sign in to comment.