Skip to content

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

show right import script on create diagram

Guy Ben-Aharonc6287cd51ad4
diff --git a/src/components/code-snippet/code-snippet.tsx b/src/components/code-snippet/code-snippet.tsx
index 9dc0a11b..a76f9657 100644
--- a/src/components/code-snippet/code-snippet.tsx
+++ b/src/components/code-snippet/code-snippet.tsx
@@ -6,41 +6,19 @@ import { CodeBlockProps } from 'react-code-blocks/dist/components/CodeBlock';
export interface CodeSnippetProps {
className?: string;
codeProps?: CodeBlockProps;
+ code: string;
}
export const CodeSnippet: React.FC<CodeSnippetProps> = ({
className,
codeProps,
+ code,
}) => {
return (
<div className={cn('flex flex-1', className)}>
<CopyBlock
language="sql"
- text={
- "WITH fk_info as ( \n\
- (SELECT (@fk_info:=NULL),\n\
- (SELECT (0)\n\
- FROM (SELECT kcu.table_schema,\n\
- kcu.table_name,\n\
- kcu.column_name as fk_column,\n\
- kcu.constraint_name as foreign_key_name,\n\
- kcu.referenced_table_name as reference_table,\n\
- kcu.referenced_column_name as reference_column,\n\
- CONCAT('FOREIGN KEY (', kcu.column_name, ') REFERENCES ', \n\
- kcu.referenced_table_name, '(', kcu.refssssssssssssssssssssssssssssssssserenced_column_name, ') ',\n\
- 'ON UPDATE ', rc.update_rule, \n\
- ' ON DELETE ', rc.delete_rule) AS fk_def\n\
- FROM\n\
- information_schema.key_column_usage kcu\n\
- JOIN\n\
- information_schema.referential_constraints rc\n\
- ON kcu.constraint_name = rc.constraint_name\n\
- AND kcu.table_name = rc.table_name\n\
- WHERE\n\
- kcu.referenced_table_name IS NOT NULL) as fk\n\
- WHERE table_schema LIKE IFNULL(NULL, '%')\n\
- AND table_schema = DATABASE()"
- }
+ text={code}
theme={atomOneDark}
customStyle={{
display: 'flex',
diff --git a/src/dialogs/create-diagram-dialog/create-diagram-dialog.tsx b/src/dialogs/create-diagram-dialog/create-diagram-dialog.tsx
index d4c2212e..d177c743 100644
--- a/src/dialogs/create-diagram-dialog/create-diagram-dialog.tsx
+++ b/src/dialogs/create-diagram-dialog/create-diagram-dialog.tsx
@@ -21,17 +21,22 @@ import { useNavigate } from 'react-router-dom';
import { useConfig } from '@/hooks/use-config';
import {
DatabaseMetadata,
+ isDatabaseMetadata,
loadDatabaseMetadata,
} from '@/lib/data/import-metadata/metadata-types/database-metadata';
import { generateId } from '@/lib/utils';
import { useChartDB } from '@/hooks/use-chartdb';
import { useDialog } from '@/hooks/use-dialog';
+import { importMetadataScripts } from '@/lib/data/import-metadata/scripts/scripts';
enum CreateDiagramDialogStep {
SELECT_DATABASE = 'SELECT_DATABASE',
IMPORT_DATABASE = 'IMPORT_DATABASE',
}
+const errorScriptOutputMessage =
+ 'Invalid JSON. Please correct it or contact us at [email protected] for help.';
+
export interface CreateDiagramDialogProps {
dialog: DialogProps;
}
@@ -46,6 +51,7 @@ export const CreateDiagramDialog: React.FC<CreateDiagramDialogProps> = ({
const { closeCreateDiagramDialog } = useDialog();
const { updateConfig } = useConfig();
const [scriptResult, setScriptResult] = React.useState('');
+ const [errorMessage, setErrorMessage] = React.useState('');
const [step, setStep] = React.useState<CreateDiagramDialogStep>(
CreateDiagramDialogStep.SELECT_DATABASE
);
@@ -65,10 +71,35 @@ export const CreateDiagramDialog: React.FC<CreateDiagramDialogProps> = ({
setStep(CreateDiagramDialogStep.SELECT_DATABASE);
setDatabaseType(DatabaseType.GENERIC);
setScriptResult('');
+ setErrorMessage('');
}, [dialog.open]);
+ useEffect(() => {
+ if (scriptResult.trim().length === 0) {
+ setErrorMessage('');
+ return;
+ }
+
+ try {
+ const parsedResult = JSON.parse(scriptResult);
+
+ if (isDatabaseMetadata(parsedResult)) {
+ setErrorMessage('');
+ } else {
+ setErrorMessage(errorScriptOutputMessage);
+ }
+ } catch (error) {
+ setErrorMessage(errorScriptOutputMessage);
+ }
+ }, [scriptResult]);
+
const hasExistingDiagram = (diagramId ?? '').trim().length !== 0;
+ const handleInputChange = (e: React.ChangeEvent<HTMLTextAreaElement>) => {
+ const inputValue = e.target.value;
+ setScriptResult(inputValue);
+ };
+
const createNewDiagram = useCallback(async () => {
let diagram: Diagram = {
id: generateId(),
@@ -78,7 +109,7 @@ export const CreateDiagramDialog: React.FC<CreateDiagramDialogProps> = ({
updatedAt: new Date(),
};
- if (scriptResult.trim().length !== 0) {
+ if (errorMessage.length === 0 && scriptResult.trim().length !== 0) {
const databaseMetadata: DatabaseMetadata =
loadDatabaseMetadata(scriptResult);
@@ -101,6 +132,7 @@ export const CreateDiagramDialog: React.FC<CreateDiagramDialogProps> = ({
updateConfig,
scriptResult,
diagramNumber,
+ errorMessage,
]);
const renderDatabaseOption = useCallback((type: DatabaseType) => {
@@ -174,7 +206,10 @@ export const CreateDiagramDialog: React.FC<CreateDiagramDialogProps> = ({
<p className="text-sm text-muted-foreground">
1. Run this script in your database:
</p>
- <CodeSnippet className="max-h-40 w-full" />
+ <CodeSnippet
+ className="max-h-40 w-full"
+ code={importMetadataScripts[databaseType]}
+ />
</div>
<div className="flex flex-col gap-1 h-48">
<p className="text-sm text-muted-foreground">
@@ -184,10 +219,13 @@ export const CreateDiagramDialog: React.FC<CreateDiagramDialogProps> = ({
className="flex-1 w-full p-2 text-sm bg-muted-1 rounded-md"
placeholder="Script result here..."
value={scriptResult}
- onChange={(e) =>
- setScriptResult(e.target.value)
- }
+ onChange={handleInputChange}
/>
+ {errorMessage && (
+ <p className="text-red-500 text-sm mt-2">
+ {errorMessage}
+ </p>
+ )}
</div>
</div>
);
@@ -195,10 +233,10 @@ export const CreateDiagramDialog: React.FC<CreateDiagramDialogProps> = ({
return null;
}
}, [
+ errorMessage,
step,
databaseType,
scriptResult,
- setScriptResult,
renderDatabaseOption,
setDatabaseType,
]);
@@ -274,7 +312,10 @@ export const CreateDiagramDialog: React.FC<CreateDiagramDialogProps> = ({
<Button
type="button"
variant="default"
- disabled={scriptResult.trim().length === 0}
+ disabled={
+ scriptResult.trim().length === 0 ||
+ errorMessage.length > 0
+ }
onClick={createNewDiagram}
>
Finish
@@ -292,6 +333,7 @@ export const CreateDiagramDialog: React.FC<CreateDiagramDialogProps> = ({
scriptResult,
createNewDiagram,
hasExistingDiagram,
+ errorMessage,
]);
return (
diff --git a/src/lib/data/import-metadata/metadata-types/database-metadata.ts b/src/lib/data/import-metadata/metadata-types/database-metadata.ts
index 34eded71..0f670b5f 100644
--- a/src/lib/data/import-metadata/metadata-types/database-metadata.ts
+++ b/src/lib/data/import-metadata/metadata-types/database-metadata.ts
@@ -15,6 +15,18 @@ export interface DatabaseMetadata {
version: string;
}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const isDatabaseMetadata = (obj: any): boolean => {
+ return (
+ Array.isArray(obj.fk_info) &&
+ Array.isArray(obj.pk_info) &&
+ Array.isArray(obj.columns) &&
+ Array.isArray(obj.indexes) &&
+ Array.isArray(obj.tables) &&
+ Array.isArray(obj.views)
+ );
+};
+
export function loadDatabaseMetadata(jsonString: string): DatabaseMetadata {
try {
const parsedData: DatabaseMetadata = JSON.parse(jsonString);
diff --git a/src/lib/data/import-metadata/scripts/maria-script.ts b/src/lib/data/import-metadata/scripts/maria-script.ts
index 14ecf1a3..bcf0b5df 100644
--- a/src/lib/data/import-metadata/scripts/maria-script.ts
+++ b/src/lib/data/import-metadata/scripts/maria-script.ts
@@ -1,7 +1,4 @@
-import { minimizeQuery } from './minimize-script';
-
-const rawMariaQuery = `
-WITH fk_info as (
+export const mariaDBQuery = `WITH fk_info as (
(SELECT (@fk_info:=NULL),
(SELECT (0)
FROM (SELECT kcu.table_schema,
@@ -131,4 +128,3 @@ WITH fk_info as (
'", "version": "', VERSION(), '"}') AS CHAR) AS ''
FROM fk_info, pk_info, cols, indexes, tbls, views);
`;
-export const mariaQuery = minimizeQuery(rawMariaQuery);
diff --git a/src/lib/data/import-metadata/scripts/mysql-script.ts b/src/lib/data/import-metadata/scripts/mysql-script.ts
index ee3b603b..08420bb9 100644
--- a/src/lib/data/import-metadata/scripts/mysql-script.ts
+++ b/src/lib/data/import-metadata/scripts/mysql-script.ts
@@ -1,7 +1,4 @@
-import { minimizeQuery } from './minimize-script';
-
-const rawMySQLQuery = `
-WITH fk_info as (
+export const mySQLQuery = `WITH fk_info as (
(SELECT (@fk_info:=NULL),
(SELECT (0)
FROM (SELECT kcu.table_schema,
@@ -131,4 +128,3 @@ WITH fk_info as (
'", "version": "', VERSION(), '"}') AS CHAR) AS ''
FROM fk_info, pk_info, cols, indexes, tbls, views);
`;
-export const MySQLQuery = minimizeQuery(rawMySQLQuery);
diff --git a/src/lib/data/import-metadata/scripts/postgres-script.ts b/src/lib/data/import-metadata/scripts/postgres-script.ts
index 540a3016..98ccaeba 100644
--- a/src/lib/data/import-metadata/scripts/postgres-script.ts
+++ b/src/lib/data/import-metadata/scripts/postgres-script.ts
@@ -1,7 +1,4 @@
-import { minimizeQuery } from './minimize-script';
-
-const rawPostgresQuery = `
-WITH fk_info AS (
+export const postgresQuery = `WITH fk_info AS (
select array_to_string(array_agg(CONCAT('{"schema":"', schema_name, '"',
',"table":"', table_name, '"',
',"column":"', fk_column, '"',
@@ -130,4 +127,3 @@ select CONCAT('{ "fk_info": [', coalesce(fk_metadata, ''),
'"}') as " "
from fk_info, pk_info, cols, indexes_metadata, tbls, config, views;
`;
-export const postgresQuery = minimizeQuery(rawPostgresQuery);
diff --git a/src/lib/data/import-metadata/scripts/scripts.ts b/src/lib/data/import-metadata/scripts/scripts.ts
new file mode 100644
index 00000000..5140dd1d
--- /dev/null
+++ b/src/lib/data/import-metadata/scripts/scripts.ts
@@ -0,0 +1,15 @@
+import { DatabaseType } from '@/lib/domain/database-type';
+import { postgresQuery } from './postgres-script';
+import { mySQLQuery } from './mysql-script';
+import { sqliteQuery } from './sqlite-script';
+import { sqlServerQuery } from './sqlserver-script';
+import { mariaDBQuery } from './maria-script';
+
+export const importMetadataScripts: Record<DatabaseType, string> = {
+ [DatabaseType.GENERIC]: '',
+ [DatabaseType.POSTGRESQL]: postgresQuery,
+ [DatabaseType.MYSQL]: mySQLQuery,
+ [DatabaseType.SQLITE]: sqliteQuery,
+ [DatabaseType.SQL_SERVER]: sqlServerQuery,
+ [DatabaseType.MARIADB]: mariaDBQuery,
+};
diff --git a/src/lib/data/import-metadata/scripts/sqlite-script.ts b/src/lib/data/import-metadata/scripts/sqlite-script.ts
index 8dfb9fbb..826c897f 100644
--- a/src/lib/data/import-metadata/scripts/sqlite-script.ts
+++ b/src/lib/data/import-metadata/scripts/sqlite-script.ts
@@ -1,7 +1,4 @@
-import { minimizeQuery } from './minimize-script';
-
-const rawSqliteQuery = `
-WITH fk_info AS (
+export const sqliteQuery = `WITH fk_info AS (
SELECT
json_group_array(
json_object(
@@ -158,10 +155,9 @@ replace(replace(replace(
'indexes', (SELECT indexes_metadata FROM indexes_metadata),
'tables', (SELECT tbls_metadata FROM tbls),
'views', (SELECT views_metadata FROM views),
- 'database_name', PRAGMA database_list'',
+ 'database_name', 'sqlite',
'version', sqlite_version()
),
'\\"', '"'),'"[', '['), ']"', ']'
)AS database_info;
`;
-export const SqliteQuery = minimizeQuery(rawSqliteQuery);
diff --git a/src/lib/data/import-metadata/scripts/sqlserver-script.ts b/src/lib/data/import-metadata/scripts/sqlserver-script.ts
index 56df4f5b..08446a5a 100644
--- a/src/lib/data/import-metadata/scripts/sqlserver-script.ts
+++ b/src/lib/data/import-metadata/scripts/sqlserver-script.ts
@@ -1,7 +1,4 @@
-import { minimizeQuery } from './minimize-script';
-
-const rawSqlServerQuery = `
-WITH fk_info AS (
+export const sqlServerQuery = `WITH fk_info AS (
SELECT
JSON_QUERY(
'[' + STRING_AGG(
@@ -178,4 +175,3 @@ SELECT JSON_QUERY(
', "version": ""}'
) AS full_json_result;
`;
-export const SqlServerQuery = minimizeQuery(rawSqlServerQuery);