diff --git a/docs/poetry.lock b/docs/poetry.lock index c00397d..b692350 100644 --- a/docs/poetry.lock +++ b/docs/poetry.lock @@ -49,14 +49,14 @@ dev = ["backports.zoneinfo ; python_version < \"3.9\"", "freezegun (>=1.0,<2.0)" [[package]] name = "beartype" -version = "0.22.7" +version = "0.22.8" description = "Unbearably fast near-real-time pure-Python runtime-static type-checker." optional = false python-versions = ">=3.10" groups = ["main"] files = [ - {file = "beartype-0.22.7-py3-none-any.whl", hash = "sha256:e13430ac07c61fa4bc54d375970438aeb9aa47a482c529a6f438ce52e18e6f50"}, - {file = "beartype-0.22.7.tar.gz", hash = "sha256:c7269855b71e32b7c9f0fc662baade752eb525107266e053338c2f6e8873826b"}, + {file = "beartype-0.22.8-py3-none-any.whl", hash = "sha256:b832882d04e41a4097bab9f63e6992bc6de58c414ee84cba9b45b67314f5ab2e"}, + {file = "beartype-0.22.8.tar.gz", hash = "sha256:b19b21c9359722ee3f7cc433f063b3e13997b27ae8226551ea5062e621f61165"}, ] [package.extras] diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst index fb8227c..2f39ec4 100644 --- a/docs/source/configuration.rst +++ b/docs/source/configuration.rst @@ -327,6 +327,8 @@ The optional ``renames`` property lists the item columns to rename along the mig to: # ... other columns to rename +.. _config-savepoints: + ---------- Savepoints ---------- @@ -364,6 +366,8 @@ The ``validation`` field and its properties are mandatory only when the applicat # What difference in ms should we allow between timestamps? timestampMsTolerance: 0 +.. _aws-authentication: + ------------------ AWS Authentication ------------------ diff --git a/docs/source/migrate-from-cassandra-or-parquet.rst b/docs/source/migrate-from-cassandra-or-parquet.rst index 65bccef..f043b8e 100644 --- a/docs/source/migrate-from-cassandra-or-parquet.rst +++ b/docs/source/migrate-from-cassandra-or-parquet.rst @@ -2,7 +2,7 @@ Migrate from Apache Cassandra or from a Parquet File ==================================================== -This page explains how to fill the ``source`` and ``target`` properties of the `configuration file `_ to migrate data: +This page explains how to fill the ``source`` and ``target`` properties of the :doc:`configuration file ` to migrate data: - from Apache Cassandra, ScyllaDB, or from a `Parquet `_ file, - to Apache Cassandra or ScyllaDB. @@ -124,7 +124,7 @@ In case the object is not public in the S3 bucket, you can provide the AWS crede Where ```` and ```` should be replaced with your actual AWS access key and secret key. -The Migrator also supports advanced AWS authentication options such as using `AssumeRole `_. Please read the `configuration reference `__ for more details. +The Migrator also supports advanced AWS authentication options such as using `AssumeRole `_. Please read the :ref:`configuration reference ` for more details. --------------------------- Configuring the Destination diff --git a/docs/source/migrate-from-dynamodb.rst b/docs/source/migrate-from-dynamodb.rst index f7116c8..ae005e3 100644 --- a/docs/source/migrate-from-dynamodb.rst +++ b/docs/source/migrate-from-dynamodb.rst @@ -2,7 +2,7 @@ Migrate from DynamoDB ===================== -This page explains how to fill the ``source`` and ``target`` properties of the `configuration file <../configuration>`_ to migrate data: +This page explains how to fill the ``source`` and ``target`` properties of the :doc:`configuration file ` to migrate data: - from a DynamoDB table, a ScyllaDB Alternator table, or a `DynamoDB S3 export `_, - to a DynamoDB table or a ScyllaDB Alternator table. @@ -57,7 +57,7 @@ In practice, your source database (DynamoDB or Alternator) may require authentic Where ```` and ```` should be replaced with your actual AWS access key and secret key. -The Migrator also supports advanced AWS authentication options such as using `AssumeRole `_. Please read the `configuration reference `__ for more details. +The Migrator also supports advanced AWS authentication options such as using `AssumeRole `_. Please read the :ref:`configuration reference ` for more details. Last, you can provide the following optional properties: @@ -150,7 +150,7 @@ Additionally, you can provide the following optional properties: Where ````, ````, ````, ````, and ```` should be replaced with your specific values. -The Migrator also supports advanced AWS authentication options such as using `AssumeRole `_. Please read the `configuration reference `__ for more details. +The Migrator also supports advanced AWS authentication options such as using `AssumeRole `_. Please read the :ref:`configuration reference ` for more details. --------------------------- Configuring the Destination @@ -209,4 +209,4 @@ Additionally, you can also set the following optional properties: Where ````, ````, ````, ````, and ```` are replaced with your specific values. -The Migrator also supports advanced AWS authentication options such as using `AssumeRole `_. Please read the `configuration reference `__ for more details. +The Migrator also supports advanced AWS authentication options such as using `AssumeRole `_. Please read the :ref:`configuration reference ` for more details. diff --git a/docs/source/resume-interrupted-migration.rst b/docs/source/resume-interrupted-migration.rst index 248ae55..fd1a0f0 100644 --- a/docs/source/resume-interrupted-migration.rst +++ b/docs/source/resume-interrupted-migration.rst @@ -8,6 +8,6 @@ If, for some reason, the migration is interrupted (e.g., because of a networking Savepoints are configuration files that contain information about the already migrated items, which can be skipped when the migration is resumed. The savepoint files are automatically generated during the migration. To use a savepoint, start a migration using it as configuration file. -You can control the savepoints location and the interval at which they are generated in the configuration file under the top-level property ``savepoints``. See `the corresponding section of the configuration reference `__. +You can control the savepoints location and the interval at which they are generated in the configuration file under the top-level property ``savepoints``. See the corresponding section of the configuration reference :ref:`configuration reference ` . During the migration, the savepoints are generated with file names like ``savepoint_xxx.yaml``, where ``xxx`` is a timestamp looking like ``1234567890``. To resume a migration, start a new migration with the latest savepoint as configuration file.