Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
julienrf committed Jul 13, 2024
1 parent fc64920 commit e79a02c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/source/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 </validate>`.
The ``validation`` field and its properties are mandatory only when the application is executed in :doc:`validation mode </validate>`.

.. code-block:: yaml
Expand Down
2 changes: 2 additions & 0 deletions docs/source/rename-columns.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit e79a02c

Please sign in to comment.