wdevs/relspecgo
5
0
Fork 0
Code Issues 7 Pull Requests Actions Packages Releases 83 Wiki Activity

docs: clarify format example coverage

Browse Source
This commit is contained in:
SG Command
2026-10-03 05:09:00 +02:00
parent 54041228c9
commit 519ee4f6eb
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/FORMAT_EXAMPLES.md
+6 -5
View File
@@ -1,9 +1,10 @@
# Format Usage Examples
Examples for `relspec convert` covering every reader and writer format. The
"Writers" and "Readers" sections below were run against `examples/test_schema.dbml`.
The cross-format and live-database examples were not run; they follow the flags
shown in `relspec convert --help`.
Examples for `relspec convert` covering the file-based reader and writer
formats. The "Writers" and "Readers" sections below were run against
`examples/test_schema.dbml`. The cross-format and live-database examples were
not run; they follow the flags shown in `relspec convert --help` and require
matching input files or reachable databases.
Any reader can be combined with any writer: pick `--from`/`--from-path` for the
source and `--to`/`--to-path` for the target. Add `--silent` to suppress progress
@@ -38,7 +39,7 @@ Notes:
`--flatten-schema` for other formats if the target has no schema support.
- `dctx` supports a single schema only; use `--schema <name>` to select one.
## Readers: every format back to DBML
## Readers: file-based formats into DBML (or JSON where noted)
```bash
relspec convert --from json --from-path schema.json --to dbml --to-path out.dbml