|
| 1 | +# Trino Query UI |
| 2 | + |
| 3 | +This Trino Query UI is a new UI component that can be integrated into Trino and run directly from the Trino installation at the `/query/` path. For testing, it can also be run separately and can proxy to a Trino running locally or elsewhere. |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +Implementation details: |
| 8 | +* React Typescript project with Vite |
| 9 | +* Using Node.js v20+ |
| 10 | +* Monaco editor + ANTLR parser using Trino language |
| 11 | + |
| 12 | +## Building and Shipping in Trino |
| 13 | + |
| 14 | +The Query UI builds just like the existing UI in Trino. |
| 15 | +1. First you build the TypeScript into Javascript and CSS |
| 16 | +2. Then copy the distributable path into Trino. |
| 17 | +3. Then modify Trino to respond to the query ui path. |
| 18 | + |
| 19 | +### Building for Integration |
| 20 | + |
| 21 | +``` |
| 22 | +cd precise |
| 23 | +npm run build |
| 24 | +``` |
| 25 | + |
| 26 | +### Copying into Trino |
| 27 | + |
| 28 | +mkdir -p $TRINO_HOME/core/trino-main/src/main/resources/query_ui_webapp/ |
| 29 | +cp -r dist/* $TRINO_HOME/core/trino-main/src/main/resources/query_ui_webapp/ |
| 30 | + |
| 31 | +### Modifying Trino to Respond to /query/ |
| 32 | + |
| 33 | +Modify `$TRINO_HOME/core/trino-main/src/main/java/io/trino/server/ui/WebUiStaticResource.java`: |
| 34 | + |
| 35 | +Add `/query/` path. Note any path can be used: |
| 36 | + |
| 37 | +```java |
| 38 | + @GET |
| 39 | + @Path("/query") |
| 40 | + public Response getQuery(@BeanParam ExternalUriInfo externalUriInfo) |
| 41 | + { |
| 42 | + return Response.seeOther(externalUriInfo.absolutePath("/query/")).build(); |
| 43 | + } |
| 44 | + |
| 45 | + // asset files are always visible |
| 46 | + @ResourceSecurity(PUBLIC) |
| 47 | + @GET |
| 48 | + @Path("/query/assets/{path: .*}") |
| 49 | + public Response getQueryAssetsFile(@PathParam("path") String path) |
| 50 | + throws IOException |
| 51 | + { |
| 52 | + return getQueryFile("assets/" + path); |
| 53 | + } |
| 54 | + |
| 55 | + @ResourceSecurity(PUBLIC) |
| 56 | + @GET |
| 57 | + @Path("/query/{path: .*}") |
| 58 | + public Response getQueryFile(@PathParam("path") String path) |
| 59 | + throws IOException |
| 60 | + { |
| 61 | + if (path.isEmpty()) { |
| 62 | + path = "index.html"; |
| 63 | + } |
| 64 | + |
| 65 | + String fullPath = "/query_ui_webapp/" + path; |
| 66 | + if (!isCanonical(fullPath)) { |
| 67 | + return Response.status(NOT_FOUND).build(); |
| 68 | + } |
| 69 | + |
| 70 | + URL resource = getClass().getResource(fullPath); |
| 71 | + if (resource == null) { |
| 72 | + return Response.status(NOT_FOUND).build(); |
| 73 | + } |
| 74 | + |
| 75 | + return Response.ok(resource.openStream()).build(); |
| 76 | + } |
| 77 | + |
| 78 | + private static boolean isCanonical(String fullPath) |
| 79 | + { |
| 80 | + try { |
| 81 | + return new URI(fullPath).normalize().getPath().equals(fullPath); |
| 82 | + } |
| 83 | + catch (URISyntaxException e) { |
| 84 | + return false; |
| 85 | + } |
| 86 | + } |
| 87 | +``` |
| 88 | + |
| 89 | +## Development |
| 90 | + |
| 91 | +### Setup the Coding Environment |
| 92 | + |
| 93 | +Tested on Ubuntu and Windows. |
| 94 | + |
| 95 | +1. Install node.js <https://nodejs.org/en/download/> at least v20 |
| 96 | +2. Create an NPM enviroment using Vite: `npm create vite@latest`, pick *React*, then *Typescript* |
| 97 | +3. In the precise folder, install monaco `npm install @monaco-editor/react` |
| 98 | +4. Install Typescript Runtime for ANTLR4 `npm install antlr4ng` and the cli `npm install --save-dev antlr4ng-cli` |
| 99 | + because <https://github.com/tunnelvisionlabs/antlr4ts> seems abandoned? |
| 100 | + |
| 101 | +### Setup Proxying to Local Trino Instance |
| 102 | + |
| 103 | +To run outside of Trino, update the contents of the `vite.config.ts` with the following so that queries can be properly proxied over to Trino's query endpoint running on `http://localhost:8080` or any other proxy path required. |
| 104 | + |
| 105 | +```tsx |
| 106 | +import { defineConfig } from 'vite' |
| 107 | +import react from '@vitejs/plugin-react' |
| 108 | + |
| 109 | +// https://vitejs.dev/config/ |
| 110 | +export default defineConfig({ |
| 111 | + base: '/query/', |
| 112 | + plugins: [react()], |
| 113 | + server: { |
| 114 | + proxy: { |
| 115 | + '/v1': { |
| 116 | + target: 'http://localhost:8080', |
| 117 | + changeOrigin: true, |
| 118 | + secure: false, |
| 119 | + }, |
| 120 | + }, |
| 121 | + }, |
| 122 | +}); |
| 123 | +``` |
| 124 | + |
| 125 | +### Build and Run |
| 126 | + |
| 127 | +To run, start: |
| 128 | + |
| 129 | +```shell |
| 130 | + cd precise |
| 131 | + npm install |
| 132 | + npm run dev |
| 133 | +``` |
| 134 | + |
| 135 | +The local URL will be be displayed which you can open in your browser. |
| 136 | + |
| 137 | +### Building the Parser |
| 138 | + |
| 139 | +To build parser: `npm run antlr4ng`, as configured in **package.json** |
| 140 | + |
| 141 | +## Philosophy |
| 142 | + |
| 143 | +This UI's purpose is to provide an environment where once the cluster is stood up, executing queries and exploring data sets can be done right away. The idended use cases are: |
| 144 | +* Initial proof-of-concept queries. |
| 145 | +* Exploration of data sets. |
| 146 | +* Performance analysis. |
| 147 | +* Adhoc query execution. |
| 148 | +* Quickly enabling a data engineering team to start work before other integrations are in place. |
| 149 | +* Early demos. |
| 150 | + |
| 151 | +The approach taken: |
| 152 | +1. Direct integration into Trino UI |
| 153 | + - No need for additional authentication hop (although it could be added in the future) |
| 154 | + - Auth as the user executing the query if using Oauth2 |
| 155 | + - Trino does the heavy lifting |
| 156 | +2. Don't need to think, just write a query |
| 157 | + - Autocomplete must be aware of not just Trino language but tables and columns |
| 158 | + - Syntax highlighting, validation |
| 159 | + - Comprehensive catalog explorer |
| 160 | +3. No black box query execution |
| 161 | + - Show progress and details of execution: people ask "why is my query slow" but mostly this is because they are only shown a spinner for 10 minutes. |
| 162 | + - Link to Trino query UI to drill into query performance |
| 163 | + - Show stages and split counts like Trino console client |
| 164 | +4. Easy to navigate |
| 165 | + |
| 166 | +### Gaps and Future Direction |
| 167 | + |
| 168 | +* The ability to save queries and use source control requires either back end capabilities in the Trino service or can utilize Trino to write queries as tables. |
| 169 | +* No autocomplete for the Trino function list. |
| 170 | +* Basic graphing capabilities - looking at a table is not enough even for inspecting data sets. |
| 171 | +* No LLM copilot integration yet, this is done badly in many query UIs and if done well could make query crafting very fast, and solve other issues like translation from other query languages. |
| 172 | +* Parameters and string replace: this is partly implemented in `SubstitutionEditor` and should support both SQL parameters and string replacement. |
0 commit comments