titor/drawDB
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add enums, types and Index

Browse Source
This commit is contained in:
Luis Carlos 2024-08-28 00:18:43 -04:00
parent 11df4fabdf
commit 3dbc60636d
2 changed files with 22 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/components/EditorHeader/ControlPanel.jsx
View File

@ -1072,6 +1072,8 @@ export default function ControlPanel({
subjectAreas: areas, subjectAreas: areas,
database: database, database: database,
title: title, title: title,
...(databases[database].hasTypes && { types: types }),
...(databases[database].hasEnums && { enums: enums }),
}); });
setExportData((prev) => ({ setExportData((prev) => ({
...prev, ...prev,

27
src/utils/exportAs/documentation.js
View File

@ -11,6 +11,10 @@ export function jsonToDocumentation(obj) {
const documentationEntities = obj.tables const documentationEntities = obj.tables
.map((table) => { .map((table) => {
let enums = "";
let indexes = table.indices.length > 0 ? table.indices.map((index) => {
return `| ${index.name} | ${index.unique ? "✅" : ""} | ${index.fields.join(", ")} |`;
}).join("\n") : "";
const fields = table.fields const fields = table.fields
.map((field) => { .map((field) => {
const fieldType = const fieldType =
@ -21,18 +25,20 @@ export function jsonToDocumentation(obj) {
field.size !== "" field.size !== ""
? "(" + field.size + ")" ? "(" + field.size + ")"
: ""); : "");
enums += (field.type === "ENUM" && field.values && field.values.length > 0) ?
`##### ${field.name}\n\n${field.values.map((index) => `- ${index}`).join("\n")}\n` : "";
return `| **${field.name}** | ${fieldType} | ${field.primary ? "🔑 PK, " : ""}` + return `| **${field.name}** | ${fieldType} | ${field.primary ? "🔑 PK, " : ""}` +
`${field.nullable ? "null " : "not null "}${field.unique ? ", unique" : ""}${field.increment?", autoincrement":""}` + `${field.nullable ? "null " : "not null "}${field.unique ? ", unique" : ""}${field.increment?", autoincrement":""}` +
`${field.default ? `, default: ${field.default}` : ""} | ` + `${field.default ? `, default: ${field.default}` : ""} | ` +
`${relationshipByField(table.id, obj.relationships, field.id)}` + `${relationshipByField(table.id, obj.relationships, field.id)}` +
` |${field.comment ? field.comment : ""} |`; ` |${field.comment ? field.comment : ""} |`;
}).join("\n"); }).join("\n");
return `### ${table.name}\n${table.comment ? table.comment : ""}\n\n` + return `### ${table.name}\n${table.comment ? table.comment : ""}\n` +
`| Name | Type | Settings | References | Note |\n` + `| Name | Type | Settings | References | Note |\n` +
`|-------------|---------------|-------------------------------|-------------------------------|--------------------------------|\n` + `|-------------|---------------|-------------------------------|-------------------------------|--------------------------------|\n` +
`${fields}\n\n`; `${fields} \n${enums.length > 0 ? "\n#### Enums\n" + enums : ""}\n` +
}).join(""); `${indexes.length > 0 ? "\n#### Indexes\n| Name | Unique | Fields |\n|------|--------|--------|\n" + indexes : ""}`;
}).join("\n\n");
function relationshipByField(table, relationships, fieldId) { function relationshipByField(table, relationships, fieldId) {
return relationships.filter(r => r.startTableId === table && r.startFieldId === fieldId) return relationships.filter(r => r.startTableId === table && r.startFieldId === fieldId)
@ -48,10 +54,17 @@ export function jsonToDocumentation(obj) {
return `- **${startTable} to ${endTable}**: ${r.cardinality}\n`; return `- **${startTable} to ${endTable}**: ${r.cardinality}\n`;
}).join("") : ""; }).join("") : "";
const documentationTypes = obj.types.map((type) => {
return `| Name | fields | Note |\n` +
`|-------------|---------------|--------------------------------|\n` +
`| ${type.name} | ${type.fields.map((field) => field.name).join(", ")} | ${type.comment ? type.comment : ""} |`;
}).join("\n");
return `# ${obj.title} documentation\n## Summary\n\n- [Introduction](#introduction)\n- [Database Type](#database-type)\n`+ return `# ${obj.title} documentation\n## Summary\n\n- [Introduction](#introduction)\n- [Database Type](#database-type)\n`+
`- [Table Structure](#table-structure)\n${documentationSummary}\n- [Relationships](#relationships)\n- [Database Diagram](#database-Diagram)\n\n`+ `- [Table Structure](#table-structure)\n${documentationSummary}\n- [Relationships](#relationships)\n- [Database Diagram](#database-Diagram)\n\n`+
`## Introduction\n\n## Database type\n\n- **Database system:** `+ `## Introduction\n\n## Database type\n\n- **Database system:** `+
`${databases[obj.database].name}\n## Table structure\n\n${documentationEntities}`+ `${databases[obj.database].name}\n## Table structure\n\n${documentationEntities}`+
`\n\n## Relationships\n\n${documentationRelationships}\n\n`+ `\n\n## Relationships\n\n${documentationRelationships}\n\n` +
`## Database Diagram\n\n\`\`\`${jsonToMermaid(obj)}\`\`\``; `## Types\n\n${documentationTypes}\n\n` +
`## Database Diagram\n\n\`\`\`mermaid\n${jsonToMermaid(obj)}\n\`\`\``;
} }