@sqlrooms/schema-tree

React components for rendering DuckDB database/schema/table/column trees in SQLRooms apps.

Installation

npm install @sqlrooms/schema-tree @sqlrooms/duckdb @sqlrooms/ui

What this package provides

• TableSchemaTree for rendering full schema hierarchies
• node components (DatabaseTreeNode, SchemaTreeNode, TableTreeNode, ColumnTreeNode)
• TreeNodeActionsMenu for context-style node actions
• defaultRenderTableSchemaNode for quick customization

Basic usage

import {TableSchemaTree} from '@sqlrooms/schema-tree';
import {useRoomStore} from './store';

export function SchemaExplorer() {
  const schemaTrees = useRoomStore((state) => state.db.schemaTrees ?? []);

  if (!schemaTrees.length) {
    return <div className="p-2 text-sm">No schema loaded yet.</div>;
  }

  return (
    <TableSchemaTree
      className="h-full"
      schemaTrees={schemaTrees}
      skipSingleDatabaseOrSchema
    />
  );
}

Custom node rendering

import {DbSchemaNode} from '@sqlrooms/duckdb';
import {defaultRenderTableSchemaNode, TableSchemaTree} from '@sqlrooms/schema-tree';

const renderNode = (node: DbSchemaNode, isOpen: boolean) => (
  <div className={isOpen ? 'opacity-100' : 'opacity-90'}>
    {defaultRenderTableSchemaNode(node)}
  </div>
);

<TableSchemaTree schemaTrees={schemaTrees} renderNode={renderNode} />;

Notes

• schemaTrees comes from the DuckDB slice (state.db.schemaTrees).
• Call state.db.refreshTableSchemas() after table changes to keep the tree up to date.
• This package is used by SQLRooms SQL editor table-structure panels.

Variables

• TableSchemaTree
• ColumnTreeNode
• DatabaseTreeNode
• SchemaTreeNode
• TableTreeNode
• TreeNodeActionsMenu
• TreeNodeActionsMenuItem

Functions

• defaultRenderTableSchemaNode
• BaseTreeNode
• defaultRenderTableNodeMenuItems