Skip to content

Database diagrams editor that allows you to visualize and design your DB with a single query.

add comments to fields & tables

Guy Ben-Aharon80948fdd7c97
diff --git a/src/context/storage-context/storage-provider.tsx b/src/context/storage-context/storage-provider.tsx
index 408b2951..39fdfd4f 100644
--- a/src/context/storage-context/storage-provider.tsx
+++ b/src/context/storage-context/storage-provider.tsx
@@ -64,6 +64,16 @@ export const StorageProvider: React.FC<React.PropsWithChildren> = ({
config: '++id, defaultDiagramId',
});
+ db.version(4).stores({
+ diagrams:
+ '++id, name, databaseType, databaseEdition, createdAt, updatedAt',
+ db_tables:
+ '++id, diagramId, name, x, y, fields, indexes, color, createdAt, width, comment',
+ db_relationships:
+ '++id, diagramId, name, sourceTableId, targetTableId, sourceFieldId, targetFieldId, type, createdAt',
+ config: '++id, defaultDiagramId',
+ });
+
db.on('ready', async () => {
const config = await getConfig();
diff --git a/src/i18n/locales/en.ts b/src/i18n/locales/en.ts
index 298ade04..adcd8233 100644
--- a/src/i18n/locales/en.ts
+++ b/src/i18n/locales/en.ts
@@ -58,6 +58,8 @@ export const en: ResourceLanguage = {
nullable: 'Nullable?',
primary_key: 'Primary Key',
indexes: 'Indexes',
+ comments: 'Comments',
+ no_comments: 'No comments',
add_field: 'Add Field',
add_index: 'Add Index',
index_select_fields: 'Select fields',
@@ -66,6 +68,8 @@ export const en: ResourceLanguage = {
field_actions: {
title: 'Field Attributes',
unique: 'Unique',
+ comments: 'Comments',
+ no_comments: 'No comments',
delete_field: 'Delete Field',
},
index_actions: {
diff --git a/src/lib/domain/db-field.ts b/src/lib/domain/db-field.ts
index 6def9fad..b77e9c3b 100644
--- a/src/lib/domain/db-field.ts
+++ b/src/lib/domain/db-field.ts
@@ -13,4 +13,5 @@ export interface DBField {
scale?: number;
default?: string;
collation?: string;
+ comments?: string;
}
diff --git a/src/lib/domain/db-table.ts b/src/lib/domain/db-table.ts
index cd0c45e0..e0e5bf21 100644
--- a/src/lib/domain/db-table.ts
+++ b/src/lib/domain/db-table.ts
@@ -20,6 +20,7 @@ export interface DBTable {
isView: boolean;
createdAt: number;
width?: number;
+ comments?: string;
}
export const createTablesFromMetadata = ({
diff --git a/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-field/table-field.tsx b/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-field/table-field.tsx
index a6c6870c..c685bbde 100644
--- a/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-field/table-field.tsx
+++ b/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-field/table-field.tsx
@@ -23,6 +23,7 @@ import {
import { Label } from '@/components/label/label';
import { Checkbox } from '@/components/checkbox/checkbox';
import { useTranslation } from 'react-i18next';
+import { Textarea } from '@/components/textarea/textarea';
export interface TableFieldProps {
field: DBField;
@@ -152,24 +153,48 @@ export const TableField: React.FC<TableFieldProps> = ({
)}
</div>
<Separator orientation="horizontal" />
- <div className="flex items-center justify-between">
- <Label
- htmlFor="width"
- className="text-gray-700"
- >
- {t(
- 'side_panel.tables_section.table.field_actions.unique'
- )}
- </Label>
- <Checkbox
- checked={field.unique}
- disabled={field.primaryKey}
- onCheckedChange={(value) =>
- updateField({
- unique: !!value,
- })
- }
- />
+ <div className="flex flex-col gap-3">
+ <div className="flex items-center justify-between">
+ <Label
+ htmlFor="width"
+ className="text-gray-700"
+ >
+ {t(
+ 'side_panel.tables_section.table.field_actions.unique'
+ )}
+ </Label>
+ <Checkbox
+ checked={field.unique}
+ disabled={field.primaryKey}
+ onCheckedChange={(value) =>
+ updateField({
+ unique: !!value,
+ })
+ }
+ />
+ </div>
+ <div className="flex flex-col gap-2">
+ <Label
+ htmlFor="width"
+ className="text-gray-700"
+ >
+ {t(
+ 'side_panel.tables_section.table.field_actions.comments'
+ )}
+ </Label>
+ <Textarea
+ value={field.comments}
+ onChange={(e) =>
+ updateField({
+ comments: e.target.value,
+ })
+ }
+ placeholder={t(
+ 'side_panel.tables_section.table.field_actions.no_comments'
+ )}
+ className="w-full rounded-md bg-muted text-sm"
+ />
+ </div>
</div>
<Separator orientation="horizontal" />
<Button
diff --git a/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-list-item-content.tsx b/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-list-item-content.tsx
index 85c264fc..250667e6 100644
--- a/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-list-item-content.tsx
+++ b/src/pages/editor-page/side-panel/tables-section/table-list/table-list-item/table-list-item-content/table-list-item-content.tsx
@@ -1,5 +1,5 @@
import React from 'react';
-import { Plus, FileType2, FileKey2 } from 'lucide-react';
+import { Plus, FileType2, FileKey2, MessageCircleMore } from 'lucide-react';
import { Button } from '@/components/button/button';
import {
Accordion,
@@ -15,6 +15,7 @@ import { TableField } from './table-field/table-field';
import { TableIndex } from './table-index/table-index';
import { DBIndex } from '@/lib/domain/db-index';
import { useTranslation } from 'react-i18next';
+import { Textarea } from '@/components/textarea/textarea';
type AccordionItemValue = 'fields' | 'indexes';
@@ -32,6 +33,7 @@ export const TableListItemContent: React.FC<TableListItemContentProps> = ({
createIndex,
removeIndex,
updateIndex,
+ updateTable,
} = useChartDB();
const { t } = useTranslation();
const { color } = table;
@@ -109,7 +111,7 @@ export const TableListItemContent: React.FC<TableListItemContentProps> = ({
</AccordionContent>
</AccordionItem>
- <AccordionItem value="indexes" className="border-y-0">
+ <AccordionItem value="indexes" className="mb-2 border-y-0">
<AccordionTrigger
iconPosition="right"
className="group flex flex-1 p-0 px-2 py-1 text-xs text-slate-600 hover:bg-secondary"
@@ -152,6 +154,35 @@ export const TableListItemContent: React.FC<TableListItemContentProps> = ({
))}
</AccordionContent>
</AccordionItem>
+
+ <AccordionItem value="comments" className="border-y-0">
+ <AccordionTrigger
+ iconPosition="right"
+ className="group flex flex-1 p-0 px-2 py-1 text-xs text-slate-600 hover:bg-secondary"
+ asChild
+ >
+ <div className="flex flex-1 items-center justify-between">
+ <div className="flex flex-row items-center gap-1">
+ <MessageCircleMore className="size-4" />
+ {t('side_panel.tables_section.table.comments')}
+ </div>
+ </div>
+ </AccordionTrigger>
+ <AccordionContent className="pb-0 pt-1">
+ <Textarea
+ value={table.comments}
+ onChange={(e) =>
+ updateTable(table.id, {
+ comments: e.target.value,
+ })
+ }
+ placeholder={t(
+ 'side_panel.tables_section.table.no_comments'
+ )}
+ className="w-full rounded-md bg-muted text-sm focus-visible:ring-0"
+ />
+ </AccordionContent>
+ </AccordionItem>
</Accordion>
<Separator className="" />
<div className="flex flex-1 items-center justify-between">