Database diagrams editor that allows you to visualize and design your DB with a single query.
TypeScript databasedbdb-migrationeditorerdmariadbmssqlmysqlpostgresqlreactreact-flowschema-migrationssqlsqlitetypescriptvisualizationxyflow
add relationships
Guy Ben-Aharon34d84375936e
diff --git a/src/context/chartdb-context/chartdb-context.tsx b/src/context/chartdb-context/chartdb-context.tsxindex f4c8866b..44248169 100644--- a/src/context/chartdb-context/chartdb-context.tsx+++ b/src/context/chartdb-context/chartdb-context.tsx@@ -20,6 +20,7 @@ export interface ChartDBContext {getTable: (id: string) => DBTable | null;removeTable: (id: string) => void;updateTable: (id: string, table: Partial<DBTable>) => void;+ updateTables: (tables: PartialExcept<DBTable, 'id'>[]) => void;// Field operationsgetField: (tableId: string, fieldId: string) => DBField | null;@@ -46,9 +47,9 @@ export interface ChartDBContext {// Relationship operationscreateRelationship: (params: {sourceTableId: string;- destinationTableId: string;+ targetTableId: string;sourceFieldId: string;- destinationFieldId: string;+ targetFieldId: string;}) => DBRelationship;addRelationship: (relationship: DBRelationship) => void;getRelationship: (id: string) => DBRelationship | null;@@ -68,6 +69,7 @@ export const chartDBContext = createContext<ChartDBContext>({setDatabaseType: emptyFn,// Table operations+ updateTables: emptyFn,createTable: emptyFn,getTable: emptyFn,addTable: emptyFn,diff --git a/src/context/chartdb-context/chartdb-provider.tsx b/src/context/chartdb-context/chartdb-provider.tsxindex beee7ad6..432dadb5 100644--- a/src/context/chartdb-context/chartdb-provider.tsx+++ b/src/context/chartdb-context/chartdb-provider.tsx@@ -1,7 +1,6 @@import React from 'react';import { DBTable } from '@/lib/domain/db-table';-import { randomHSLA } from '@/lib/utils';-import { nanoid } from 'nanoid';+import { generateId, randomHSLA } from '@/lib/utils';import { chartDBContext } from './chartdb-context';import { DatabaseType } from '@/lib/domain/database-type';import { DBField } from '@/lib/domain/db-field';@@ -25,13 +24,13 @@ export const ChartDBProvider: React.FC<React.PropsWithChildren> = ({const createTable = () => {const table: DBTable = {- id: nanoid(),+ id: generateId(),name: `table_${tables.length + 1}`,x: 0,y: 0,fields: [{- id: nanoid(),+ id: generateId(),name: 'id',type: 'bigint',unique: true,@@ -62,6 +61,15 @@ export const ChartDBProvider: React.FC<React.PropsWithChildren> = ({);};+ const updateTables = (tables: PartialExcept<DBTable, 'id'>[]) => {+ setTables((currentTables) =>+ currentTables.map((table) => {+ const updatedTable = tables.find((t) => t.id === table.id);+ return updatedTable ? { ...table, ...updatedTable } : table;+ })+ );+ };+const updateField = (tableId: string,fieldId: string,@@ -112,7 +120,7 @@ export const ChartDBProvider: React.FC<React.PropsWithChildren> = ({const createField = (tableId: string) => {const table = getTable(tableId);const field: DBField = {- id: nanoid(),+ id: generateId(),name: `field_${(table?.fields?.length ?? 0) + 1}`,type: 'bigint',unique: false,@@ -154,7 +162,7 @@ export const ChartDBProvider: React.FC<React.PropsWithChildren> = ({const createIndex = (tableId: string) => {const table = getTable(tableId);const index: DBIndex = {- id: nanoid(),+ id: generateId(),name: `index_${(table?.indexes?.length ?? 0) + 1}`,fieldIds: [],unique: false,@@ -196,21 +204,21 @@ export const ChartDBProvider: React.FC<React.PropsWithChildren> = ({const createRelationship = ({sourceTableId,- destinationTableId,+ targetTableId,sourceFieldId,- destinationFieldId,+ targetFieldId,}: {sourceTableId: string;- destinationTableId: string;+ targetTableId: string;sourceFieldId: string;- destinationFieldId: string;+ targetFieldId: string;}) => {const relationship: DBRelationship = {- id: nanoid(),+ id: generateId(),sourceTableId,- destinationTableId,+ targetTableId,sourceFieldId,- destinationFieldId,+ targetFieldId,type: 'one-to-one',createdAt: Date.now(),};@@ -252,6 +260,7 @@ export const ChartDBProvider: React.FC<React.PropsWithChildren> = ({getTable,removeTable,updateTable,+ updateTables,updateField,removeField,createField,diff --git a/src/lib/domain/db-relationship.ts b/src/lib/domain/db-relationship.tsindex f426e2c1..65b1982c 100644--- a/src/lib/domain/db-relationship.ts+++ b/src/lib/domain/db-relationship.ts@@ -1,9 +1,9 @@export interface DBRelationship {id: string;sourceTableId: string;- destinationTableId: string;+ targetTableId: string;sourceFieldId: string;- destinationFieldId: string;+ targetFieldId: string;type: RelationshipType;createdAt: number;}diff --git a/src/lib/utils.ts b/src/lib/utils.tsindex 9dae9d54..cc75278e 100644--- a/src/lib/utils.ts+++ b/src/lib/utils.ts@@ -1,6 +1,8 @@import { type ClassValue, clsx } from 'clsx';import { customAlphabet } from 'nanoid';-const nanoid = customAlphabet('1234567890', 18);++const randomId = customAlphabet('0123456789abcdefghijklmnopqrstuvwxyz-', 23);+const randonNumber = customAlphabet('1234567890', 18);import { twMerge } from 'tailwind-merge';@@ -14,7 +16,9 @@ export const convertToDecimal = (number: number) => {};export const randomHSLA = () =>- `hsla(${~~(360 * convertToDecimal(parseInt(nanoid())))}, 70%, 72%, 0.8)`;+ `hsla(${~~(360 * convertToDecimal(parseInt(randonNumber())))}, 70%, 72%, 0.8)`;// eslint-disable-next-line @typescript-eslint/no-explicit-anyexport const emptyFn = (): any => undefined;++export const generateId = () => randomId();diff --git a/src/pages/editor-page/canvas/canvas.tsx b/src/pages/editor-page/canvas/canvas.tsxindex 5eeed4f6..17ee8f55 100644--- a/src/pages/editor-page/canvas/canvas.tsx+++ b/src/pages/editor-page/canvas/canvas.tsx@@ -1,4 +1,4 @@-import React, { useCallback, useMemo } from 'react';+import React, { useCallback, useEffect, useMemo } from 'react';import {ReactFlow,useEdgesState,@@ -8,54 +8,56 @@ import {BackgroundVariant,MiniMap,Controls,- Edge,- Node,+ NodePositionChange,} from '@xyflow/react';import '@xyflow/react/dist/style.css';-import { TableNode } from './table-node';-import { TableEdge } from './table-edge';+import { TableNode, TableNodeType } from './table-node';+import { TableEdge, TableEdgeType } from './table-edge';+import { useChartDB } from '@/hooks/use-chartdb';-export interface CanvasProps {}+type AddEdgeParams = Parameters<typeof addEdge<TableEdgeType>>[0];++const initialNodes: TableNodeType[] = [];+const initialEdges: TableEdgeType[] = [];-const initialNodes: Node[] = [- {- id: '3',- type: 'table',- position: { x: 200, y: 200 },- data: { label: '3' },- zIndex: 2,- },- {- id: '1',- type: 'table',- position: { x: 400, y: 400 },- data: { label: '1' },- zIndex: 2,- },- {- id: '2',- type: 'table',- position: { x: 0, y: 0 },- data: { label: '2' },- zIndex: 2,- },- // { id: '1', position: { x: 0, y: 0 }, data: { label: '1' } },- // { id: '2', position: { x: 0, y: 100 }, data: { label: '2' } },-];-// const initialEdges = [{ id: 'e1-2', source: '1', target: '2' }];-const initialEdges: Edge[] = [];+export interface CanvasProps {}export const Canvas: React.FC<CanvasProps> = () => {+ const { tables, updateTables, createRelationship } = useChartDB();const nodeTypes = useMemo(() => ({ table: TableNode }), []);const edgeTypes = useMemo(() => ({ 'table-edge': TableEdge }), []);- const [nodes, , onNodesChange] = useNodesState(initialNodes);- const [edges, setEdges, onEdgesChange] = useEdgesState(initialEdges);+ const [nodes, setNodes, onNodesChange] =+ useNodesState<TableNodeType>(initialNodes);+ const [edges, setEdges, onEdgesChange] =+ useEdgesState<TableEdgeType>(initialEdges);++ useEffect(() => {+ setNodes(+ tables.map((table) => ({+ id: table.id,+ type: 'table',+ position: { x: table.x, y: table.y },+ data: {+ table,+ },+ }))+ );+ }, [tables, setNodes]);const onConnect = useCallback(- (params: Parameters<typeof addEdge>[0]) =>- setEdges((eds) => addEdge({ ...params, type: 'table-edge' }, eds)),- [setEdges]+ (params: AddEdgeParams) => {+ createRelationship({+ sourceTableId: params.source,+ targetTableId: params.target,+ sourceFieldId: params.sourceHandle?.split('_')?.pop() ?? '',+ targetFieldId: params.targetHandle?.split('_')?.pop() ?? '',+ });+ return setEdges((edges) =>+ addEdge<TableEdgeType>({ ...params }, edges)+ );+ },+ [setEdges, createRelationship]);return (@@ -63,7 +65,25 @@ export const Canvas: React.FC<CanvasProps> = () => {<ReactFlownodes={nodes}edges={edges}- onNodesChange={onNodesChange}+ onNodesChange={(changes) => {+ const positionChanges: NodePositionChange[] =+ changes.filter(+ (change) =>+ change.type === 'position' && !change.dragging+ ) as NodePositionChange[];++ if (positionChanges.length > 0) {+ updateTables(+ positionChanges.map((change) => ({+ id: change.id,+ x: change.position?.x,+ y: change.position?.y,+ }))+ );+ }++ return onNodesChange(changes);+ }}onEdgesChange={(changes) => {const selectionChanges = changes.filter((change) => change.type === 'select'diff --git a/src/pages/editor-page/canvas/table-edge.tsx b/src/pages/editor-page/canvas/table-edge.tsxindex 28153372..53378eae 100644--- a/src/pages/editor-page/canvas/table-edge.tsx+++ b/src/pages/editor-page/canvas/table-edge.tsx@@ -1,14 +1,23 @@import React, { useMemo } from 'react';import {BaseEdge,+ Edge,EdgeProps,getSmoothStepPath,Position,useReactFlow,} from '@xyflow/react';import { RIGHT_HANDLE_ID_PREFIX, TARGET_ID_PREFIX } from './table-node';+import { DBRelationship } from '@/lib/domain/db-relationship';-export const TableEdge: React.FC<EdgeProps> = ({+export type TableEdgeType = Edge<+ {+ relationship: DBRelationship;+ },+ 'table-edge'+>;++export const TableEdge: React.FC<EdgeProps<TableEdgeType>> = ({id,sourceX,sourceY,diff --git a/src/pages/editor-page/canvas/table-node-field.tsx b/src/pages/editor-page/canvas/table-node-field.tsxnew file mode 100644index 00000000..767688d8--- /dev/null+++ b/src/pages/editor-page/canvas/table-node-field.tsx@@ -0,0 +1,111 @@+import React, { useEffect } from 'react';+import {+ Handle,+ Position,+ useConnection,+ useReactFlow,+ useUpdateNodeInternals,+} from '@xyflow/react';+import { Button } from '@/components/button/button';+import { Trash2 } from 'lucide-react';++import { DBField } from '@/lib/domain/db-field';+import { useChartDB } from '@/hooks/use-chartdb';++export const LEFT_HANDLE_ID_PREFIX = 'left_';+export const RIGHT_HANDLE_ID_PREFIX = 'right_';+export const TARGET_ID_PREFIX = 'target_';++export interface TableNodeFieldProps {+ tableNodeId: string;+ field: DBField;+ focused: boolean;+}++export const TableNodeField: React.FC<TableNodeFieldProps> = ({+ field,+ focused,+ tableNodeId,+}) => {+ const { removeField } = useChartDB();+ const { getEdges } = useReactFlow();+ const updateNodeInternals = useUpdateNodeInternals();+ const connection = useConnection();+ const isTarget =+ connection.inProgress && connection.fromNode.id !== tableNodeId;+ const edges = getEdges();+ const numberOfEdgesToField = edges.filter(+ (edge) =>+ edge.target === tableNodeId &&+ edge.targetHandle?.endsWith(`_${field.id}`)+ ).length;++ useEffect(() => {+ updateNodeInternals(tableNodeId);+ }, [tableNodeId, updateNodeInternals, numberOfEdgesToField]);++ return (+ <div className="flex relative items-center h-8 text-sm px-3 border-t justify-between hover:bg-primary-foreground group last:rounded-b-lg">+ {!connection.inProgress && (+ <>+ <Handle+ id={`${RIGHT_HANDLE_ID_PREFIX}_${field.id}`}+ className={`!h-3 !w-3 !bg-slate-400 ${!focused ? '!invisible' : ''}`}+ position={Position.Right}+ type="source"+ />+ <Handle+ id={`${LEFT_HANDLE_ID_PREFIX}_${field.id}`}+ className={`!h-3 !w-3 !bg-slate-400 ${!focused ? '!invisible' : ''}`}+ position={Position.Left}+ type="source"+ />+ </>+ )}+ {(!connection.inProgress || isTarget) && (+ <>+ {Array.from(+ { length: numberOfEdgesToField + 1 },+ (_, index) => index+ ).map((index) => (+ <Handle+ id={`${TARGET_ID_PREFIX}${index}_${field.id}`}+ key={`${TARGET_ID_PREFIX}${index}`}+ className={`!invisible`}+ position={Position.Left}+ type="target"+ />+ ))}+ <Handle+ id={`${TARGET_ID_PREFIX}${numberOfEdgesToField}_${field.id}`}+ className={+ isTarget+ ? '!w-full !h-full !absolute !top-0 !left-0 !rounded-none !border-none !transform-none !opacity-0'+ : `!invisible`+ }+ position={Position.Left}+ type="target"+ />+ </>+ )}+ <div className="flex">{field.name}</div>+ <div className="flex">+ <div className="text-muted-foreground flex group-hover:hidden">+ {field.type}+ </div>+ <div className="flex-row hidden group-hover:flex">+ <Button+ variant="ghost"+ className="hover:bg-primary-foreground p-0 w-6 h-6"+ onClick={(e) => {+ e.stopPropagation();+ removeField(tableNodeId, field.id);+ }}+ >+ <Trash2 className="h-3.5 w-3.5 text-red-700" />+ </Button>+ </div>+ </div>+ </div>+ );+};diff --git a/src/pages/editor-page/canvas/table-node.tsx b/src/pages/editor-page/canvas/table-node.tsxindex 5916cc27..657f24b3 100644--- a/src/pages/editor-page/canvas/table-node.tsx+++ b/src/pages/editor-page/canvas/table-node.tsx@@ -1,102 +1,29 @@-import React, { useEffect } from 'react';-import { randomHSLA } from '@/lib/utils';-import {- Handle,- Position,- NodeProps,- Node,- useConnection,- useReactFlow,- useUpdateNodeInternals,-} from '@xyflow/react';+import React from 'react';+import { NodeProps, Node } from '@xyflow/react';import { Button } from '@/components/button/button';-import { Ellipsis, Table2, Trash2 } from 'lucide-react';+import { Ellipsis, Table2 } from 'lucide-react';import { Label } from '@/components/label/label';+import { DBTable } from '@/lib/domain/db-table';+import { TableNodeField } from './table-node-field';-export const LEFT_HANDLE_ID_PREFIX = 'left-handle';-export const RIGHT_HANDLE_ID_PREFIX = 'right-handle';+export const LEFT_HANDLE_ID_PREFIX = 'left_';+export const RIGHT_HANDLE_ID_PREFIX = 'right_';export const TARGET_ID_PREFIX = 'target-';-export type TableNodeProps = Node<Record<string, never>, 'table'>;+export type TableNodeType = Node<+ {+ table: DBTable;+ },+ 'table'+>;-export const TableNode: React.FC<NodeProps<TableNodeProps>> = ({+export const TableNode: React.FC<NodeProps<TableNodeType>> = ({selected,dragging,id,+ data: { table },}) => {- const { getEdges } = useReactFlow();- const updateNodeInternals = useUpdateNodeInternals();- const connection = useConnection();- const tableColor = randomHSLA();- const focused = selected && !dragging;- const isTarget = connection.inProgress && connection.fromNode.id !== id;- const edges = getEdges();- const numberOfEdges = edges.filter((edge) => edge.target === id).length;-- useEffect(() => {- updateNodeInternals(id);- }, [id, updateNodeInternals, numberOfEdges]);-- const renderColumn = () => (- <div className="flex relative items-center h-8 text-sm px-3 border-t justify-between hover:bg-primary-foreground group last:rounded-b-lg">- {!connection.inProgress && (- <>- <Handle- id={RIGHT_HANDLE_ID_PREFIX}- className={`!h-3 !w-3 !bg-slate-400 ${!focused ? '!invisible' : ''}`}- position={Position.Right}- type="source"- />- <Handle- id={LEFT_HANDLE_ID_PREFIX}- className={`!h-3 !w-3 !bg-slate-400 ${!focused ? '!invisible' : ''}`}- position={Position.Left}- type="source"- />- </>- )}- {(!connection.inProgress || isTarget) && (- <>- {Array.from(- { length: numberOfEdges + 1 },- (_, index) => index- ).map((index) => (- <Handle- id={`${TARGET_ID_PREFIX}${index}`}- key={`${TARGET_ID_PREFIX}${index}`}- className={`!invisible`}- position={Position.Left}- type="target"- />- ))}- <Handle- id={`${TARGET_ID_PREFIX}${numberOfEdges}`}- className={- isTarget- ? '!w-full !h-full !absolute !top-0 !left-0 !rounded-none !border-none !transform-none !opacity-0'- : `!invisible`- }- position={Position.Left}- type="target"- />- </>- )}- <div className="flex">id</div>- <div className="flex">- <div className="text-muted-foreground flex group-hover:hidden">- bigint- </div>- <div className="flex-row hidden group-hover:flex">- <Button- variant="ghost"- className="hover:bg-primary-foreground p-0 w-6 h-6"- >- <Trash2 className="h-3.5 w-3.5 text-red-700" />- </Button>- </div>- </div>- </div>- );+ const focused = !!selected && !dragging;return (<div@@ -104,12 +31,12 @@ export const TableNode: React.FC<NodeProps<TableNodeProps>> = ({><divclassName="h-2 rounded-t-lg"- style={{ backgroundColor: tableColor }}+ style={{ backgroundColor: table.color }}></div><div className="flex items-center h-9 bg-secondary px-2 justify-between group"><div className="flex items-center gap-1"><Table2 className="h-3.5 w-3.5 text-gray-600" />- <Label className="text-sm font-bold">table_1</Label>+ <Label className="text-sm font-bold">{table.name}</Label></div><div className="flex-row hidden group-hover:flex"><Button@@ -120,7 +47,14 @@ export const TableNode: React.FC<NodeProps<TableNodeProps>> = ({</Button></div></div>- {renderColumn()}+ {table.fields.map((field) => (+ <TableNodeField+ key={field.id}+ focused={focused}+ tableNodeId={id}+ field={field}+ />+ ))}</div>);};diff --git a/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-header/table-list-item-header.tsx b/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-header/table-list-item-header.tsxindex bcc13f92..18f9f1b9 100644--- a/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-header/table-list-item-header.tsx+++ b/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-header/table-list-item-header.tsx@@ -21,6 +21,7 @@ import {DropdownMenuSeparator,DropdownMenuTrigger,} from '@/components/dropdown-menu/dropdown-menu';+import { useReactFlow } from '@xyflow/react';export interface TableListItemHeaderProps {table: DBTable;@@ -29,6 +30,7 @@ export interface TableListItemHeaderProps {export const TableListItemHeader: React.FC<TableListItemHeaderProps> = ({table,}) => {+ const { fitView } = useReactFlow();const [editMode, setEditMode] = React.useState(false);const [tableName, setTableName] = React.useState(table.name);const inputRef = React.useRef<HTMLInputElement>(null);@@ -53,6 +55,22 @@ export const TableListItemHeader: React.FC<TableListItemHeaderProps> = ({setEditMode(true);};+ const focusOnTable = (+ event: React.MouseEvent<HTMLButtonElement, MouseEvent>+ ) => {+ event.stopPropagation();+ fitView({+ duration: 500,+ maxZoom: 1,+ minZoom: 1,+ nodes: [+ {+ id: table.id,+ },+ ],+ });+ };+const deleteTableHandler = () => {removeTable(table.id);};@@ -129,7 +147,7 @@ export const TableListItemHeader: React.FC<TableListItemHeaderProps> = ({<ListItemHeaderButton onClick={enterEditMode}><Pencil /></ListItemHeaderButton>- <ListItemHeaderButton>+ <ListItemHeaderButton onClick={focusOnTable}><CircleDotDashed /></ListItemHeaderButton></div>diff --git a/src/router.tsx b/src/router.tsxindex a8201199..d2825782 100644--- a/src/router.tsx+++ b/src/router.tsx@@ -3,13 +3,16 @@ import { RouteObject, createBrowserRouter } from 'react-router-dom';import { NotFoundPage } from './pages/not-found-page/not-found-page';import { EditorPage } from './pages/editor-page/editor-page';import { ChartDBProvider } from './context/chartdb-context/chartdb-provider';+import { ReactFlowProvider } from '@xyflow/react';const routes: RouteObject[] = [{path: '/',element: (<ChartDBProvider>- <EditorPage />+ <ReactFlowProvider>+ <EditorPage />+ </ReactFlowProvider></ChartDBProvider>),},diff --git a/src/types.d.ts b/src/types.d.tsnew file mode 100644index 00000000..d05e4b38--- /dev/null+++ b/src/types.d.ts@@ -0,0 +1,5 @@+type PartialExcept<+ ParameterType,+ ParameterField extends keyof ParameterType,+> = Pick<ParameterType, ParameterField> &+ Partial<Omit<ParameterType, ParameterField>>;