Skip to main content

datacontract export mermaid

Export a data contract to Mermaid diagram.

datacontract export mermaid [OPTIONS] [LOCATION]
ArgumentDefaultDescription
[LOCATION]datacontract.yamlThe location (url or path) of the data contract yaml.
OptionDefaultDescription
--outputFile path where the exported data will be saved. If not provided, it will be printed to stdout.
--serverThe server name to export.
--schema-nameallWhich schema to export, e.g., orders, or all for all schemas (default).
--json-schemaThe location (url or path) of the ODCS JSON Schema.
--inline-references / --no-inline-references--inline-referencesResolve external references (currently: authoritativeDefinitions[type in {definition, semantics}]) in the contract and inline the fetched content from the configured entropy-data host.
--debug / --no-debugEnable debug logging
datacontract export mermaid datacontract.yaml --output diagram.mmd

Guide: Export: Mermaid.