From e79a02c0299bdb9e7d82fa076c9edf6a029ccb4b Mon Sep 17 00:00:00 2001 From: Julien Richard-Foy Date: Sat, 13 Jul 2024 14:59:05 +0200 Subject: [PATCH] Update documentation --- docs/source/configuration.rst | 10 +++++----- docs/source/rename-columns.rst | 2 ++ 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst index 0ffca0d6..ad188854 100644 --- a/docs/source/configuration.rst +++ b/docs/source/configuration.rst @@ -26,16 +26,16 @@ The configuration file requires the following top-level properties (ie, with no # Target configuration target: # ... - # Columns to rename + # Optional - Columns to rename renames: # ... # Savepoints configuration savepoints: # ... - # Validator configuration + # Validator configuration. Required only if the app is executed in validation mode. validation: # ... - # Used internally + # Optional- Used internally skipTokenRanges: [] These top-level properties are documented in the following sections (except ``skipTokenRanges``, which is used internally). @@ -319,7 +319,7 @@ DynamoDB Target Renames ------- -The ``renames`` property lists the item columns to rename along the migration. To not rename any columns, use the empty array ``renames: []``. +The optional ``renames`` property lists the item columns to rename along the migration. .. code-block:: yaml @@ -347,7 +347,7 @@ When migrating data over CQL-compatible storages, the migrator is able to resume Validation ---------- -The properties of the ``validation`` field are used only when the application is executed in :doc:`validation mode `. +The ``validation`` field and its properties are mandatory only when the application is executed in :doc:`validation mode `. .. code-block:: yaml diff --git a/docs/source/rename-columns.rst b/docs/source/rename-columns.rst index 22f0fee9..bf7ce0b3 100644 --- a/docs/source/rename-columns.rst +++ b/docs/source/rename-columns.rst @@ -13,3 +13,5 @@ Indicate in the migration configuration which columns to rename with the ``renam to: bar - from: xxx to: yyy + +To not perform any renames, leave out the ``renames`` property from the configuration file.