From eeb9912d8c29c08cf345e0a9ceb733eb61a0e11f Mon Sep 17 00:00:00 2001 From: Thomas Karner Date: Sun, 10 Nov 2024 14:16:06 +0100 Subject: [PATCH] update readme and changelog --- changelog.md | 11 +++++++++-- exampleRunConfig.yaml | 1 + readme.md | 5 +++++ 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/changelog.md b/changelog.md index bb4b6f0..a2928de 100644 --- a/changelog.md +++ b/changelog.md @@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) (after version 0.0.5). +## [0.12.0] - 2024-0 +### Added +- new `--outputMode` option ([PR #63](https://github.com/KarnerTh/mermerd/pull/63)) + +### Changed +- go 1.23 is now used + ## [0.11.0] - 2024-06-16 ### Added - new `--ignoreTables` option ([PR #59](https://github.com/KarnerTh/mermerd/pull/59)) @@ -11,8 +18,6 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) (after version 0.0 ### Changed - go 1.22 is now used -### Fixed - ## [0.10.0] - 2023-11-21 ### Added - Support relationship labels ([PR #50](https://github.com/KarnerTh/mermerd/pull/50)) @@ -155,6 +160,8 @@ by `--showDescriptions enumValues` (for details see [PR #32](https://github.com/ ### Added - Initial release of mermerd +[0.12.0]: https://github.com/KarnerTh/mermerd/releases/tag/v0.12.0 + [0.11.0]: https://github.com/KarnerTh/mermerd/releases/tag/v0.11.0 [0.10.0]: https://github.com/KarnerTh/mermerd/releases/tag/v0.10.0 diff --git a/exampleRunConfig.yaml b/exampleRunConfig.yaml index a59938c..3465106 100644 --- a/exampleRunConfig.yaml +++ b/exampleRunConfig.yaml @@ -20,6 +20,7 @@ encloseWithMermaidBackticks: false debug: false omitConstraintLabels: false omitAttributeKeys: false +outputMode: stdout showDescriptions: - enumValues - columnComments diff --git a/readme.md b/readme.md index 0acabe9..c82378e 100644 --- a/readme.md +++ b/readme.md @@ -78,6 +78,7 @@ via `mermerd -h` --omitAttributeKeys omit the attribute keys (PK, FK, UK) --omitConstraintLabels omit the constraint labels -o, --outputFileName string output file name (default "result.mmd") + --outputMode OutputModeType output mode (file, stdout) (default file) --runConfig string run configuration (replaces global configuration) -s, --schema string schema that should be used --schemaPrefixSeparator string the separator that should be used between schema and table name (default ".") @@ -146,6 +147,7 @@ selectedTables: showAllConstraints: true encloseWithMermaidBackticks: true outputFileName: "my-db.mmd" +outputMode: stdout debug: true omitConstraintLabels: true omitAttributeKeys: true @@ -181,6 +183,9 @@ mermerd -c "postgresql://user:password@localhost:5432/yourDb" -s public # same as previous one, but use all available tables without interaction mermerd -c "postgresql://user:password@localhost:5432/yourDb" -s public --useAllTables +# same as previous one, but get the result in stdout instead of a file +mermerd -c "postgresql://user:password@localhost:5432/yourDb" -s public --useAllTables --outputMode stdout + # same as previous one, but use a list of tables without interaction mermerd -c "postgresql://user:password@localhost:5432/yourDb" -s public --selectedTables article,article_label