Database Metadata Workflows¶
CLI workflow¶
- Install
mdengine[db]. - Run
md-db --helpto list flags. - Provide input (Postgres, MySQL, Oracle, SQLite, Mongo, Access, Elasticsearch/OpenSearch clusters and offline JSON bundles) and output path.
- Inspect generated Markdown and sidecar assets.
API workflow¶
- Install
mdengine[db,api]. - Start uvicorn on
md_generator.dbAPI module (see Deployment). - Call sync endpoint for small payloads or job endpoint for large conversions.
- Poll job status and download artifact when complete.
Processing pipeline¶
flowchart TD
Start[Start] --> InputLoad[Load_input]
InputLoad --> Validate[Validate_options]
Validate --> Transform[Core_conversion]
Transform --> Render[Render_Markdown]
Render --> Package[Write_output_or_ZIP]
Package --> End[Complete]
Async job flow¶
Where job routes exist, background work uses in-process threads or domain job managers; results land in job workspace + download.
sequenceDiagram
participant Client
participant API
participant Worker
participant Storage
Client->>API: POST job
API->>Storage: create workspace
API->>Worker: enqueue
API-->>Client: job_id
Worker->>Storage: write artifacts
Client->>API: GET status/download
API-->>Client: ZIP or Markdown
Elasticsearch / OpenSearch export¶
- Live cluster —
--type elasticsearchwith cluster URI (or YAMLdatabase.type: elasticsearch). - Offline bundle — POST a ZIP of exported cluster JSON to
/db-to-md/run/elasticsearch(sync) or/db-to-md/job/elasticsearch(async). - Enable feature flags such as
elasticsearch_indices,elasticsearch_search_templates,elasticsearch_search_dependency_graphvia--include.
Output lands under elasticsearch/ (indices, templates, pipelines, ILM, search templates, alias graph, dependency graph).