feat: duckdb-wasm query UI [DRAFT] #39
+1,186
−514
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export * from './types/src/targets/duckdb-browser-blocking'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export * from './types/src/targets/duckdb'; |
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export * from './types/src/targets/duckdb-node-blocking'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export * from './types/src/targets/duckdb'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,209 @@ | ||
| import { sql } from "@codemirror/lang-sql"; | ||
| import * as duckdb from "@duckdb/duckdb-wasm"; | ||
| import CodeMirror from "@uiw/react-codemirror"; | ||
| import React, { useEffect, useMemo, useRef, useState } from "react"; | ||
| import { useQuery } from "react-query"; | ||
| import { useDebounce } from "use-debounce"; | ||
| import { useRawDataFile } from "../hooks"; | ||
| import { LoadingState } from "./loading-state"; | ||
| import { Spinner } from "./spinner"; | ||
|
|
||
| interface Props { | ||
| sha: string; | ||
| filename: string; | ||
| owner: string; | ||
| name: string; | ||
| } | ||
|
|
||
| interface DBExplorerInnerProps { | ||
| content: string; | ||
| filename: string; | ||
| extension: string; | ||
| sha: string; | ||
| } | ||
|
|
||
| const VALID_EXTENSIONS = ["csv", "json"]; | ||
|
|
||
| function DBExplorerInner(props: DBExplorerInnerProps) { | ||
| const { content, extension, filename, sha } = props; | ||
| const connectionRef = useRef<duckdb.AsyncDuckDBConnection>(); | ||
| const [query, setQuery] = useState(""); | ||
| const [debouncedQuery] = useDebounce(query, 1000); | ||
| const [dbStatus, setDbStatus] = useState<"error" | "idle" | "success">( | ||
| "idle" | ||
| ); | ||
|
|
||
| const execQuery = async (query: string) => { | ||
| if (!connectionRef.current) return; | ||
| const queryRes = await connectionRef.current.query(query); | ||
| const asArray = queryRes.toArray(); | ||
|
There was a problem hiding this comment. You don't need to convert the result to an array. Arrow tables already behave like arrays of objects if you iterate over them for There was a problem hiding this comment. @domoritz Fantastic! This felt kludgy and I suspected there was a better way. There was a problem hiding this comment.
There was a problem hiding this comment. @domoritz Good call. We're ultimately passing this data down to our There was a problem hiding this comment. You may need to refactor the component. Shouldn't be a big deal, though, and would be great for interoperability anyway. |
||
| return { | ||
| numRows: queryRes.numRows, | ||
| numCols: queryRes.numCols, | ||
| results: asArray.map((row) => { | ||
| return row.toJSON(); | ||
mattrothenberg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }), | ||
| }; | ||
| }; | ||
|
|
||
| const { data, status, error } = useQuery( | ||
| ["query-results", filename, sha, debouncedQuery], | ||
| () => execQuery(debouncedQuery), | ||
| { | ||
| refetchOnWindowFocus: false, | ||
| retry: false, | ||
| } | ||
| ); | ||
|
|
||
| useEffect(() => { | ||
| const initDuckDb = async () => { | ||
| const MANUAL_BUNDLES: duckdb.DuckDBBundles = { | ||
| mvp: { | ||
| mainModule: "/duckdb/duckdb.wasm", | ||
| mainWorker: "/duckdb/duckdb-browser-mvp.worker.js", | ||
| }, | ||
| eh: { | ||
| mainModule: "/duckdb/duckdb-eh.wasm", | ||
| mainWorker: "/duckdb/duckdb-browser-eh.worker.js", | ||
| }, | ||
| }; | ||
| const bundle = await duckdb.selectBundle(MANUAL_BUNDLES); | ||
| const worker = new Worker(bundle.mainWorker!); | ||
| const logger = new duckdb.ConsoleLogger(); | ||
| const db = new duckdb.AsyncDuckDB(logger, worker); | ||
| await db.instantiate(bundle.mainModule, bundle.pthreadWorker); | ||
|
|
||
| const c = await db.connect(); | ||
| connectionRef.current = c; | ||
|
|
||
| if (extension === "csv") { | ||
| await db.registerFileText(`data.csv`, content); | ||
| await c.insertCSVFromPath(`data.csv`, { name: "data" }); | ||
| } else if (extension === "json") { | ||
| await db.registerFileText(`data.json`, content); | ||
| await c.insertJSONFromPath("data.json", { name: "data" }); | ||
| } | ||
|
|
||
| setDbStatus("success"); | ||
| setQuery("select * from data"); | ||
| }; | ||
|
|
||
| initDuckDb(); | ||
|
|
||
| return () => { | ||
| if (connectionRef.current) { | ||
| connectionRef.current.close(); | ||
| } | ||
| }; | ||
| }, [content]); | ||
|
|
||
| const sqlSchema = useMemo(() => { | ||
| if (!content) return []; | ||
|
|
||
| if (extension === "csv") { | ||
| const names = content.split("\n")[0].split(","); | ||
| return names.map((name) => name.replace(/"/g, "")); | ||
| } else if (extension === "json") { | ||
| return Object.keys(JSON.parse(content)[0]); | ||
| } else { | ||
| return []; | ||
| } | ||
| }, [content]); | ||
|
|
||
| return ( | ||
| <div className="flex-1 flex-shrink-0 overflow-hidden flex flex-col z-0"> | ||
| {dbStatus === "idle" && <LoadingState text="Initializing DuckDB 🦆" />} | ||
| {dbStatus === "success" && ( | ||
| <> | ||
| <div className="border-b bg-gray-50 sticky top-0 z-20"> | ||
| <CodeMirror | ||
| value={query} | ||
| height={"120px"} | ||
| className="w-full" | ||
| extensions={[ | ||
| sql({ | ||
| defaultTable: "data", | ||
| schema: { | ||
| data: sqlSchema, | ||
| }, | ||
| }), | ||
| ]} | ||
| onChange={(value) => { | ||
| setQuery(value); | ||
| }} | ||
| /> | ||
| </div> | ||
| <div className="flex-1 flex flex-col h-full overflow-scroll"> | ||
| <div className="border-b p-2 flex items-center space-x-2 sticky top-0 bg-white z-10"> | ||
| <div> | ||
| <p className="text-xs uppercase tracking-widest font-medium"> | ||
| # Rows | ||
| </p> | ||
| {status === "loading" ? ( | ||
| <span className="skeleton">Loading</span> | ||
| ) : ( | ||
| <span>{data && data.numRows}</span> | ||
| )} | ||
| </div> | ||
| <div> | ||
| <p className="text-xs uppercase tracking-widest font-medium"> | ||
| # Columns | ||
| </p> | ||
| {status === "loading" ? ( | ||
| <span className="skeleton">Loading</span> | ||
| ) : ( | ||
| <span>{data && data.numCols}</span> | ||
| )} | ||
| </div> | ||
| </div> | ||
| {status === "error" && error && ( | ||
| <div className="bg-red-50 border-b border-red-600 p-2 text-sm text-red-600"> | ||
| {(error as Error)?.message || "An unexpected error occurred."} | ||
| </div> | ||
| )} | ||
| <div className="relative"> | ||
| {status === "loading" && ( | ||
| <div className="absolute top-4 right-4 z-20"> | ||
| <Spinner /> | ||
| </div> | ||
| )} | ||
| <pre>{JSON.stringify(data, null, 2)}</pre> | ||
| </div> | ||
| </div> | ||
| </> | ||
| )} | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| export function DBExplorer(props: Props) { | ||
| const { sha, filename, owner, name } = props; | ||
| const { data, status } = useRawDataFile( | ||
| { | ||
| sha, | ||
| filename, | ||
| owner, | ||
| name, | ||
| }, | ||
| { | ||
| refetchOnWindowFocus: false, | ||
| retry: false, | ||
| } | ||
| ); | ||
|
|
||
| const extension = filename.split(".").pop() || ""; | ||
|
|
||
| return ( | ||
| <> | ||
| {status === "loading" && <LoadingState />} | ||
| {status === "success" && data && VALID_EXTENSIONS.includes(extension) && ( | ||
| <DBExplorerInner | ||
| sha={sha} | ||
| filename={filename} | ||
| extension={extension} | ||
| content={data} | ||
| /> | ||
| )} | ||
| </> | ||
| ); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.