docs: Add batch config to README copied from Meltano Hub (#234)

Copied from: https://hub.meltano.com/extractors/tap-postgres/#batch_config-encoding-compression-setting Closes #220 Co-authored-by: Derek Visch <[email protected]>
MeltanoLabs · Oct 9, 2023 · 42b2d59 · 42b2d59
1 parent da7d5b8
commit 42b2d59
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -43,6 +43,11 @@ Built with the [Meltano Singer SDK](https://sdk.meltano.com).
 | stream_map_config   | False    | None    | User-defined config values to be used within map expressions. |
 | flattening_enabled  | False    | None    | 'True' to enable schema flattening and automatically expand nested properties. |
 | flattening_max_depth| False    | None    | The max depth to flatten schemas. |
+| batch_config| False    | None    | JSON object containing information on data batching. |
+| batch_config.encoding.compression| False    | None    | Compression format to use for batch files. |
+| batch_config.encoding.format| False    | None    | Format to use for batch files. |
+| batch_config.storage.prefix| False    | None    | Prefix to use when writing batch files. |
+| batch_config.storage.root| False    | None    | Root path to use when writing batch files. |
 
 A full list of supported settings and capabilities is available by running: `tap-postgres --about`