@jerrythomas/dbd-dbml
v2.0.6
Published
DBML conversion and publishing utilities for DBD.
Maintainers
Readme
@jerrythomas/dbd-dbml
DBML conversion and publishing utilities for dbd. Converts DDL scripts into DBML format for use with dbdocs.io.
Features
- Convert DDL to DBML via @dbml/core
- Schema-qualified table name handling
- DDL cleanup (comments, indexes, unsupported statements)
- Project block generation for dbdocs
Usage
import { generateDBML, convertToDBML } from '@jerrythomas/dbd-dbml'
// Generate DBML from a collection of entities
const dbml = generateDBML(entities, projectName)
// Convert a single DDL string
const result = convertToDBML(ddlString)API
generateDBML(entities, projectName)— generate full DBML document from entitiesconvertToDBML(ddl)— convert DDL string to DBMLcleanupDDLForDBML(ddl)— strip unsupported SQL for DBML conversionbuildProjectBlock(name)— generate DBML project blockqualifyTableNames(ddl, schema)— add schema prefixes to table namesbuildTableLookup(entities)/buildTableReplacements(lookup)/applyTableReplacements(dbml, replacements)
License
MIT
