@adecore/database 0.17.0-beta.2 → 0.18.0

package/src/grid/types.ts

@@ -4,6 +4,8 @@ import type { Shown } from './display.ts';
 /* A column of a result, with what the grid draws from its table when it comes from one. */
 export interface GridColumn extends ResultColumn {
     readonly primaryKey?: boolean;
+    /* A column of a foreign key of its table. */
+    readonly foreignKey?: boolean;
     /* `false` makes Set NULL unavailable; unknown (an expression) leaves it open. */
     readonly nullable?: boolean;
     /* A column no cell of which can be edited, such as a generated one. */
@@ -29,10 +31,15 @@ export interface GridRow {
     readonly locked?: boolean;
 }
 
-/* Builds the column of a table from the result column and the structure's column of the same name. */
-export const gridColumnOf = (column: ResultColumn, info: ColumnInfo | undefined, primaryKey: readonly string[]): GridColumn => ({
+/* Builds the column of a table from the result column, the structure's column of the same name and the columns of its keys. */
+export const gridColumnOf = (
+    column: ResultColumn,
+    info: ColumnInfo | undefined,
+    keys: { readonly primaryKey: readonly string[]; readonly foreignKey: readonly string[] }
+): GridColumn => ({
     ...column,
-    primaryKey: primaryKey.includes(column.name),
+    primaryKey: keys.primaryKey.includes(column.name),
+    foreignKey: keys.foreignKey.includes(column.name),
     nullable: info?.nullable,
     readOnly: info?.generated === true,
     defaultValue: info?.defaultValue,
@@ -45,6 +52,11 @@ export interface FocusedCell {
     readonly column: number;
 }
 
+/* A cell to move the grid's focus to. `quiet` moves it without taking the keyboard, for a panel beside the grid that follows along. */
+export interface FocusRequest extends FocusedCell {
+    readonly quiet?: boolean;
+}
+
 /* What a menu item added to the grid's context menu acts on. */
 export interface GridMenuContext {
     /* The selected rows when the row under the pointer is one of them, else that row alone. */

package/src/index.ts

@@ -20,16 +20,20 @@ export {
     type TableRef
 } from './client/index.ts';
 
-export type { DatabaseAction, DatabaseFiles, DatabaseStorage, ExplorerSelection } from './actions.ts';
+export type { DatabaseAction, DatabaseFiles, DatabaseNotice, DatabaseStorage, ExplorerSelection } from './actions.ts';
 
 export { ConnectionForm, type ConnectionFormProps } from './connections/ConnectionForm.tsx';
+export { configProblems, isValidConfig, type ConfigProblem, type ConfigProblems } from './connections/connection-config.ts';
 export { ConnectionManager, type ConnectionManagerProps } from './connections/ConnectionManager.tsx';
+export { connectionFromContainer, containerTitle, isMysqlContainer, withContainer } from './connections/docker.ts';
 export { DatabaseExplorer, type DatabaseExplorerProps } from './explorer/DatabaseExplorer.tsx';
+export type { ExplorerFolder, ExplorerItem } from './explorer/folders.ts';
 export { TableDesigner, type TableDesignerProps } from './designer/TableDesigner.tsx';
 export { DatabaseProvider, type DatabaseProviderProps } from './DatabaseProvider.tsx';
 export { useDatabaseClient } from './client-context.ts';
 export type { NumberNotation } from './grid/display.ts';
 export { QueryConsole, type QueryConsoleProps } from './console/QueryConsole.tsx';
+export type { QueryConsoleEditorHandle, QueryConsoleEditorProps, QueryConsoleRunScope } from './console/editor-slot.ts';
 export { StructureView, type StructureViewProps } from './structure/StructureView.tsx';
 export { TableView, type TableViewProps } from './table/TableView.tsx';
 export { DatabaseWorkbench, type DatabaseWorkbenchProps } from './workbench/DatabaseWorkbench.tsx';

package/src/locales/en.json

@@ -17,7 +17,8 @@
         "test": {
             "action": "Test connection",
             "success": "Connected to {{server}}.",
-            "failed": "The connection failed."
+            "failed": "The connection failed.",
+            "dismiss": "Dismiss"
         },
         "delete": {
             "action": "Delete",
@@ -116,6 +117,18 @@
         "views": "Views",
         "primaryKey": "Primary key",
         "foreignKey": "Foreign key",
+        "primaryAndForeignKey": "Primary key and foreign key",
+        "parts": {
+            "columns": "Columns",
+            "keys": "Keys",
+            "foreignKeys": "Foreign keys",
+            "indexes": "Indexes",
+            "checks": "Checks",
+            "triggers": "Triggers"
+        },
+        "references": "{{columns}} → {{table}} ({{referenced}})",
+        "unique": "unique",
+        "check": "Check",
         "readOnly": "Read only",
         "schemaCount": "{{shown}} of {{total}}",
         "schemaCountHint_one": "{{shown}} of {{total}} schema shown, system schemas are hidden",
@@ -272,7 +285,6 @@
         },
         "cloneRows": "Clone selected rows",
         "revertRows": "Revert selected rows",
-        "valuePanel": "Value editor",
         "firstPage": "First page",
         "lastPage": "Last page",
         "lastPageCounts": "Counts the rows first",
@@ -295,7 +307,10 @@
             "next": "Next row",
             "newRow": "New row",
             "row": "Row {{number}}",
-            "position": "{{index}} of {{count}} on this page"
+            "position": "{{index}} of {{count}} on this page",
+            "close": "Close record view",
+            "expand": "Show the whole value",
+            "collapse": "Hide the whole value"
         },
         "aggregates": {
             "sum": "Sum",
@@ -313,7 +328,8 @@
             "running": "Exporting as {{format}}",
             "cancel": "Cancel",
             "done_one": "Exported {{rows}} row.",
-            "done_other": "Exported {{rows}} rows."
+            "done_other": "Exported {{rows}} rows.",
+            "failed": "Export failed"
         },
         "import": {
             "menu": "Import from file",
@@ -329,7 +345,8 @@
             "skip": "Skip",
             "preview": "First {{count}} rows of the file",
             "cancel": "Cancel",
-            "confirm": "Import"
+            "confirm": "Import",
+            "readFailed": "Could not read the file"
         },
         "more": "More actions",
         "of": "of",
@@ -357,6 +374,8 @@
         "running": "Running",
         "cancelled": "The statement was cancelled.",
         "result": "Result",
+        "results": "Results",
+        "closeResults": "Close results",
         "noRows": "The statement returned no rows.",
         "rows": "Rows: {{rows}}",
         "hasMore": "More rows exist but are not shown.",
@@ -369,10 +388,6 @@
         "runAll": "Run all",
         "loading": "Loading",
         "dismiss": "Dismiss",
-        "ranStatement": "Ran: {{statement}}",
-        "ranSelection": "Ran the selection",
-        "ranAll_one": "Ran {{formatted}} statement",
-        "ranAll_other": "Ran all {{formatted}} statements",
         "rowRange": "Rows: {{from}} to {{to}}",
         "page": "Page {{page}}",
         "previousPage": "Previous page",
@@ -384,15 +399,15 @@
         "schema": "Schema",
         "schemaPlaceholder": "Schema",
         "transaction": {
-            "mode": "Transaction mode",
-            "auto": "Auto",
-            "manual": "Manual",
-            "hint": "Auto commits every run. Manual keeps a transaction open until you commit or roll back.",
+            "autoCommit": "Auto-commit",
+            "hint": "On, every run commits. Off, a transaction stays open until you commit or roll back.",
             "open": "Transaction open",
             "commit": "Commit",
             "rollback": "Roll back",
             "endTitle": "End the transaction?",
-            "endDescription": "A transaction is still open. Commit it to keep its changes, or roll it back to discard them."
+            "endDescription": "A transaction is still open. Commit it to keep its changes, or roll it back to discard them.",
+            "commitFailed": "Could not commit",
+            "rollbackFailed": "Could not roll back"
         },
         "destructive": {
             "title": "Run destructive statements?",
@@ -414,7 +429,9 @@
             "hint": "Click to edit, double click to run.",
             "rows_one": "{{formatted}} row",
             "rows_other": "{{formatted}} rows"
-        }
+        },
+        "pageFailed": "Could not read the page",
+        "exportFailed": "Export failed"
     },
     "value": {
         "title": "Value",

package/src/locales/nl.json

@@ -17,7 +17,8 @@
         "test": {
             "action": "Verbinding testen",
             "success": "Verbonden met {{server}}.",
-            "failed": "De verbinding is mislukt."
+            "failed": "De verbinding is mislukt.",
+            "dismiss": "Sluiten"
         },
         "delete": {
             "action": "Verwijderen",
@@ -116,6 +117,18 @@
         "views": "Views",
         "primaryKey": "Primaire sleutel",
         "foreignKey": "Refererende sleutel",
+        "primaryAndForeignKey": "Primaire en refererende sleutel",
+        "parts": {
+            "columns": "Kolommen",
+            "keys": "Sleutels",
+            "foreignKeys": "Refererende sleutels",
+            "indexes": "Indexen",
+            "checks": "Checks",
+            "triggers": "Triggers"
+        },
+        "references": "{{columns}} → {{table}} ({{referenced}})",
+        "unique": "uniek",
+        "check": "Check",
         "readOnly": "Alleen lezen",
         "schemaCount": "{{shown}} van {{total}}",
         "schemaCountHint_one": "{{shown}} van {{total}} schema getoond, systeemschema's zijn verborgen",
@@ -272,7 +285,6 @@
         },
         "cloneRows": "Geselecteerde rijen klonen",
         "revertRows": "Geselecteerde rijen terugdraaien",
-        "valuePanel": "Waardeneditor",
         "firstPage": "Eerste pagina",
         "lastPage": "Laatste pagina",
         "lastPageCounts": "Telt eerst de rijen",
@@ -295,7 +307,10 @@
             "next": "Volgende rij",
             "newRow": "Nieuwe rij",
             "row": "Rij {{number}}",
-            "position": "{{index}} van {{count}} op deze pagina"
+            "position": "{{index}} van {{count}} op deze pagina",
+            "close": "Recordweergave sluiten",
+            "expand": "Hele waarde tonen",
+            "collapse": "Hele waarde verbergen"
         },
         "aggregates": {
             "sum": "Som",
@@ -313,7 +328,8 @@
             "running": "Exporteren als {{format}}",
             "cancel": "Annuleren",
             "done_one": "{{rows}} rij geëxporteerd.",
-            "done_other": "{{rows}} rijen geëxporteerd."
+            "done_other": "{{rows}} rijen geëxporteerd.",
+            "failed": "Exporteren is mislukt"
         },
         "import": {
             "menu": "Importeren uit bestand",
@@ -329,7 +345,8 @@
             "skip": "Overslaan",
             "preview": "Eerste {{count}} rijen van het bestand",
             "cancel": "Annuleren",
-            "confirm": "Importeren"
+            "confirm": "Importeren",
+            "readFailed": "Het bestand kon niet worden gelezen"
         },
         "more": "Meer acties",
         "of": "van",
@@ -357,6 +374,8 @@
         "running": "Bezig",
         "cancelled": "De opdracht is geannuleerd.",
         "result": "Resultaat",
+        "results": "Resultaten",
+        "closeResults": "Resultaten sluiten",
         "noRows": "De opdracht gaf geen rijen terug.",
         "rows": "Rijen: {{rows}}",
         "hasMore": "Er zijn meer rijen, maar die worden niet getoond.",
@@ -369,10 +388,6 @@
         "runAll": "Alles uitvoeren",
         "loading": "Laden",
         "dismiss": "Sluiten",
-        "ranStatement": "Uitgevoerd: {{statement}}",
-        "ranSelection": "De selectie is uitgevoerd",
-        "ranAll_one": "{{formatted}} opdracht uitgevoerd",
-        "ranAll_other": "Alle {{formatted}} opdrachten uitgevoerd",
         "rowRange": "Rijen: {{from}} tot {{to}}",
         "page": "Pagina {{page}}",
         "previousPage": "Vorige pagina",
@@ -384,15 +399,15 @@
         "schema": "Schema",
         "schemaPlaceholder": "Schema",
         "transaction": {
-            "mode": "Transactiemodus",
-            "auto": "Automatisch",
-            "manual": "Handmatig",
-            "hint": "Automatisch legt elke uitvoering vast. Handmatig houdt een transactie open tot je vastlegt of terugdraait.",
+            "autoCommit": "Automatisch vastleggen",
+            "hint": "Aan legt elke uitvoering vast. Uit houdt een transactie open tot je vastlegt of terugdraait.",
             "open": "Transactie open",
             "commit": "Vastleggen",
             "rollback": "Terugdraaien",
             "endTitle": "De transactie afsluiten?",
-            "endDescription": "Er staat nog een transactie open. Leg haar vast om de wijzigingen te bewaren, of draai haar terug om ze weg te gooien."
+            "endDescription": "Er staat nog een transactie open. Leg haar vast om de wijzigingen te bewaren, of draai haar terug om ze weg te gooien.",
+            "commitFailed": "Vastleggen is mislukt",
+            "rollbackFailed": "Terugdraaien is mislukt"
         },
         "destructive": {
             "title": "Destructieve opdrachten uitvoeren?",
@@ -414,7 +429,9 @@
             "hint": "Klik om te bewerken, dubbelklik om uit te voeren.",
             "rows_one": "{{formatted}} rij",
             "rows_other": "{{formatted}} rijen"
-        }
+        },
+        "pageFailed": "De pagina kon niet worden gelezen",
+        "exportFailed": "Exporteren is mislukt"
     },
     "value": {
         "title": "Waarde",

package/src/protocol/index.ts

@@ -29,5 +29,17 @@ export {
     type RowsResult,
     type StatementResult
 } from './messages.ts';
-export type { ColumnInfo, ForeignKeyInfo, IndexInfo, ResultColumn, SchemaInfo, TableInfo, TableKind, TableStructure } from './schema.ts';
+export type {
+    CheckInfo,
+    ColumnInfo,
+    ColumnSource,
+    ForeignKeyInfo,
+    IndexInfo,
+    ResultColumn,
+    SchemaInfo,
+    TableInfo,
+    TableKind,
+    TableStructure,
+    TriggerInfo
+} from './schema.ts';
 export { valueOfCell, type BinaryCell, type BinaryValue, type Cell, type EditValue, type LongTextCell, type Value, type ValueKind } from './values.ts';

package/src/protocol/messages.ts

@@ -4,7 +4,7 @@ import type { ResultColumn, SchemaInfo, TableInfo, TableStructure } from './sche
 import type { Cell, EditValue, Value } from './values.ts';
 
 /* Raised whenever a message changes shape, so a host refuses a helper from another release. */
-export const PROTOCOL_VERSION = 2;
+export const PROTOCOL_VERSION = 3;
 
 /* The columns of the row key and their values. */
 export type RowKey = Readonly<Record<string, Value>>;

package/src/protocol/schema.ts

@@ -50,6 +50,21 @@ export interface ForeignKeyInfo {
     readonly onDelete: string | null;
 }
 
+export interface CheckInfo {
+    /* `null` where the engine keeps no name. */
+    readonly name: string | null;
+    /* The condition as the server writes it, without `CHECK` and the parentheses around it. */
+    readonly expression: string;
+}
+
+export interface TriggerInfo {
+    readonly name: string;
+    /* `BEFORE`, `AFTER` or `INSTEAD OF`. */
+    readonly timing: string;
+    /* `INSERT`, `UPDATE` or `DELETE`. */
+    readonly event: string;
+}
+
 export interface TableStructure {
     readonly schema: string;
     readonly name: string;
@@ -63,14 +78,27 @@ export interface TableStructure {
     readonly rowKey: readonly string[] | null;
     readonly indexes: readonly IndexInfo[];
     readonly foreignKeys: readonly ForeignKeyInfo[];
+    /* Left out on a view, and where the engine keeps no list of them: SQLite has its checks only inside the DDL. */
+    readonly checks?: readonly CheckInfo[];
+    /* Left out on a view. */
+    readonly triggers?: readonly TriggerInfo[];
     /* The `CREATE` statement as the server writes it. */
     readonly ddl: string | null;
 }
 
+/* The column of a table a result column holds, as the server reports it. */
+export interface ColumnSource {
+    readonly schema: string;
+    readonly table: string;
+    readonly column: string;
+}
+
 /* A column of a result, which may come from a table or from an expression. */
 export interface ResultColumn {
     readonly name: string;
     /* The engine's name for the type of the value, such as `VARCHAR`; empty when it reports none. */
     readonly type: string;
     readonly kind: ValueKind;
+    /* Where the values come from, when the server says: left out for an expression, an alias of one and, on MySQL, a derived table. */
+    readonly source?: ColumnSource;
 }

package/src/structure/StructureView.tsx

@@ -2,9 +2,10 @@ import { useEffect, useState, type ReactNode, type Ref } from 'react';
 import clsx from 'clsx';
 import { CircleAlert, Copy, KeyRound, Link2 } from 'lucide-react';
 import { useTranslation } from 'react-i18next';
-import { Banner, Button, EmptyState, Icon, Pill, Spinner, Tabs, copyText, messageOf } from '@adecore/ui';
+import { Banner, Button, EmptyState, Icon, Pill, Separator, Spinner, Tabs, copyText, messageOf } from '@adecore/ui';
 import { useDatabaseClient } from '../client-context.ts';
 import type { Connection } from '../client/types.ts';
+import { CODE_TEXT } from '../code-text.ts';
 import type { ColumnInfo, ForeignKeyInfo, IndexInfo, TableStructure } from '../protocol/index.ts';
 import { useSchemaChange } from '../use-schema-change.ts';
 import { referenceOf } from './structure-text.ts';
@@ -13,6 +14,8 @@ export interface StructureViewProps {
     connection: Connection;
     schema: string;
     table: string;
+    /* The app's own content before the tabs, such as where the table is, with a separator after it. */
+    toolbarStart?: ReactNode;
     className?: string;
     ref?: Ref<HTMLDivElement>;
 }
@@ -33,10 +36,10 @@ interface Answer {
 
 const TH = 'sticky top-0 h-7 bg-surface px-3 text-left text-xs font-medium whitespace-nowrap text-text-faint';
 const TD = 'h-7 border-t border-border-soft px-3 text-xs whitespace-nowrap text-text select-text';
-const MONO = 'font-mono text-code';
+const MONO = CODE_TEXT;
 
 /* The columns, indexes, foreign keys and DDL of one table or view. */
-export function StructureView({ connection, schema, table, className, ref }: StructureViewProps) {
+export function StructureView({ connection, schema, table, toolbarStart, className, ref }: StructureViewProps) {
     const { t } = useTranslation('database');
     const client = useDatabaseClient();
     const [answer, setAnswer] = useState<Answer | null>(null);
@@ -83,16 +86,23 @@ export function StructureView({ connection, schema, table, className, ref }: Str
                     </Banner>
                 </div>
             )}
-            {load.status === 'ready' && <StructureTabs structure={load.structure} />}
+            {load.status === 'ready' && <StructureTabs structure={load.structure} start={toolbarStart} />}
         </div>
     );
 }
 
-export function StructureTabs({ structure }: { structure: TableStructure }) {
+export function StructureTabs({ structure, start }: { structure: TableStructure; start?: ReactNode }) {
     const { t } = useTranslation('database');
+    const head =
+        start === undefined || start === null || start === false ? undefined : (
+            <span className="flex items-center gap-4">
+                {start}
+                <Separator />
+            </span>
+        );
     return (
         <Tabs.Root defaultValue="columns" className="flex min-h-0 grow flex-col">
-            <Tabs.List className="shrink-0 px-3">
+            <Tabs.List className="shrink-0 px-3" start={head}>
                 <Tabs.Tab value="columns">
                     {t('structure.columns')}
                     <Tabs.Count value={structure.columns.length} />

package/src/table/CommandField.tsx

@@ -2,7 +2,7 @@ import { useId, useImperativeHandle, useMemo, useRef, useState, type KeyboardEve
 import clsx from 'clsx';
 import { ArrowDown, ArrowDownWideNarrow, ArrowRightToLine, ArrowUp, Code, Filter, Search, X, type LucideIcon } from 'lucide-react';
 import { useTranslation } from 'react-i18next';
-import { Icon, IconButton, Kbd, KEY_SHORTCUTS, Menu, shortcut } from '@adecore/ui';
+import { Icon, IconButton, Kbd, KEY_SHORTCUTS, Keys, Menu, shortcut } from '@adecore/ui';
 import type { Engine } from '../protocol/index.ts';
 import {
     addChip,
@@ -194,7 +194,7 @@ export function CommandField({ chips, columns, engine, onChipsChange, onJumpToCo
                 onFocus={() => setFocused(true)}
                 onBlur={handleBlur}
             />
-            <Kbd shortcut={FOCUS_SHORTCUT} variant="inline" className="shrink-0" />
+            <Keys shortcut={FOCUS_SHORTCUT} size="sm" className="shrink-0" />
             {open && (
                 <div
                     id={listId}

package/src/table/TableStatusBar.tsx

@@ -2,7 +2,7 @@ import type { Ref } from 'react';
 import clsx from 'clsx';
 import { ChevronLeft, ChevronRight } from 'lucide-react';
 import { useTranslation } from 'react-i18next';
-import { Button, IconButton, Spinner, Tooltip } from '@adecore/ui';
+import { Button, ButtonGroup, IconButton, Spinner, Tooltip } from '@adecore/ui';
 import { formatDecimal, formatNumber, formatRounded } from '@adecore/ui/format';
 import { useNumberNotation } from '../client-context.ts';
 import type { Aggregates } from '../grid/aggregates.ts';
@@ -49,10 +49,10 @@ export function TableStatusBar({ elapsedMs, bounds, counting, selection, onCount
                         </>
                     ))}
             </span>
-            <span className="flex items-center">
+            <ButtonGroup>
                 <IconButton icon={ChevronLeft} size="sm" label={t('table.previousPage')} disabled={!bounds.hasPrevious} onClick={onPrevious} />
                 <IconButton icon={ChevronRight} size="sm" label={t('table.nextPage')} disabled={!bounds.hasNext} onClick={onNext} />
-            </span>
+            </ButtonGroup>
             <Tooltip label={t('table.queryTime')}>
                 <span className="text-text-faint tabular-nums">{t('table.elapsed', { value: formatDecimal(elapsedMs) })}</span>
             </Tooltip>