diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc new file mode 100644 index 00000000..a522b3b2 --- /dev/null +++ b/modules/ROOT/nav.adoc @@ -0,0 +1,44 @@ +* Zero Downtime Migration +** xref:introduction.adoc[] +** xref:components.adoc[] +** xref:preliminary-steps.adoc[] +*** xref:feasibility-checklists.adoc[] +*** xref:deployment-infrastructure.adoc[] +*** xref:create-target.adoc[] +*** xref:rollback.adoc[] +//phase 1 +** xref:phase1.adoc[] +*** xref:setup-ansible-playbooks.adoc[] +*** xref:deploy-proxy-monitoring.adoc[] +*** xref:tls.adoc[] +*** xref:connect-clients-to-proxy.adoc[] +*** xref:metrics.adoc[] +*** xref:manage-proxy-instances.adoc[] +//phase 2 +** xref:migrate-and-validate-data.adoc[] +*** xref:cassandra-data-migrator.adoc[] +*** https://docs.datastax.com/en/dsbulk/overview/dsbulk-about.html[DSBulk Loader] +//phase 3 +** xref:enable-async-dual-reads.adoc[] +//phase 4 +** xref:change-read-routing.adoc[] +//phase 5 +** xref:connect-clients-to-target.adoc[] + +** Troubleshooting +*** xref:troubleshooting.adoc[] +*** xref:troubleshooting-tips.adoc[] +*** xref:troubleshooting-scenarios.adoc[] + +** xref:faqs.adoc[] + +** xref:glossary.adoc[] + +** xref:contributions.adoc[] + +** xref:release-notes.adoc[] + +* {cstar-data-migrator} +** xref:cdm-overview.adoc[] +** xref:cdm-steps.adoc[Migrate data] +** xref:cdm-parameters.adoc[Parameters] diff --git a/modules/ROOT/pages/cassandra-data-migrator.adoc b/modules/ROOT/pages/cassandra-data-migrator.adoc index 3f8cba33..5ac7c323 100644 --- a/modules/ROOT/pages/cassandra-data-migrator.adoc +++ b/modules/ROOT/pages/cassandra-data-migrator.adoc @@ -1,730 +1,96 @@ = {cstar-data-migrator} -Use {cstar-data-migrator} to migrate and validate tables between Origin and Target Cassandra clusters, with available logging and reconciliation support. +Use {cstar-data-migrator} to migrate and validate tables between origin and target Cassandra clusters, with available logging and reconciliation support. -[[cdm-prereqs]] +[[cdm-prerequisites]] == {cstar-data-migrator} prerequisites -* Install or switch to Java 11. -The Spark binaries are compiled with this version of Java. -* Install https://archive.apache.org/dist/spark/spark-3.5.1/[Spark 3.5.1] on a single VM (no cluster necessary) where you want to run this job. -* Optionally, install https://maven.apache.org/download.cgi[Maven] 3.9.x if you want to build the JAR for local development. - -You can install Apache Spark by running the following commands: - -[source,bash] ----- -wget https://archive.apache.org/dist/spark/spark-3.5.1/spark-3.5.1-bin-hadoop3-scala2.13.tgz - -tar -xvzf spark-3.5.1-bin-hadoop3-scala2.13.tgz ----- +include::partial$cdm-prerequisites.adoc[] [[cdm-install-as-container]] == Install {cstar-data-migrator} as a Container -Get the latest image that includes all dependencies from https://hub.docker.com/r/datastax/cassandra-data-migrator[DockerHub]. - -All migration tools (`cassandra-data-migrator` + `dsbulk` + `cqlsh`) are available in the `/assets/` folder of the container. +include::partial$cdm-install-as-container.adoc[] [[cdm-install-as-jar]] == Install {cstar-data-migrator} as a JAR file -Download the *latest* JAR file from the {cstar-data-migrator} https://github.com/datastax/cassandra-data-migrator/packages/1832128[GitHub repo]. -image:https://img.shields.io/github/v/release/datastax/cassandra-data-migrator?color=green[Latest release] - -[NOTE] -==== -Version 4.x of {cstar-data-migrator} is not backward-compatible with `*.properties` files created in previous versions, and package names have changed. -If you're starting new, we recommended that you use the latest released version. -==== +include::partial$cdm-install-as-jar.adoc[] [[cdm-build-jar-local]] == Build {cstar-data-migrator} JAR for local development (optional) -Optionally, you can build the {cstar-data-migrator} JAR for local development. (You'll need https://maven.apache.org/download.cgi[Maven] 3.9.x.) +include::partial$cdm-build-jar-local.adoc[] -Example: +[[cdm-steps]] +== Use {cstar-data-migrator} -[source,bash] ----- -cd ~/github -git clone git@github.com:datastax/cassandra-data-migrator.git -cd cassandra-data-migrator -mvn clean package ----- +include::partial$use-cdm-migrator.adoc[] -The fat jar (`cassandra-data-migrator-x.y.z.jar`) file should be present now in the `target` folder. +[[cdm-validation-steps]] +== Use {cstar-data-migrator} steps in validation mode -[[cdm-steps]] -== {cstar-data-migrator} steps - -1. Configure for your environment the `cdm*.properties` file that's provided in the {cstar-data-migrator} https://github.com/datastax/cassandra-data-migrator/tree/main/src/resources[GitHub repo]. -The file can have any name. -It does not need to be `cdm.properties` or `cdm-detailed.properties`. -In both versions, only the parameters that aren't commented out will be processed by the `spark-submit` job. -Other parameter values use defaults or are ignored. -See the descriptions and defaults in each file. -Refer to: - * The simplified sample properties configuration, https://github.com/datastax/cassandra-data-migrator/blob/main/src/resources/cdm.properties[cdm.properties]. - This file contains only those parameters that are commonly configured. - * The complete sample properties configuration, https://github.com/datastax/cassandra-data-migrator/blob/main/src/resources/cdm-detailed.properties[cdm-detailed.properties], for the full set of configurable settings. - -2. Place the properties file that you elected to use and customize where it can be accessed while running the job via `spark-submit`. - -3. Run the job using `spark-submit` command: - -[source,bash] ----- -./spark-submit --properties-file cdm.properties \ ---conf spark.cdm.schema.origin.keyspaceTable="." \ ---master "local[*]" --driver-memory 25G --executor-memory 25G \ ---class com.datastax.cdm.job.Migrate cassandra-data-migrator-x.y.z.jar &> logfile_name_$(date +%Y%m%d_%H_%M).txt ----- - -[TIP] -==== -* Above command generates a log file `logfile_name_*.txt` to avoid log output on the console. -* Update the memory options (driver & executor memory) based on your use-case -==== +include::partial$cdm-validation-steps.adoc[] -[[cdm-validation-steps]] -== {cstar-data-migrator} steps in validation mode - -To run your migration job with {cstar-data-migrator} in **data validation mode**, use class option `--class com.datastax.cdm.job.DiffData`. -Example: - -[source,bash] ----- -./spark-submit --properties-file cdm.properties \ ---conf spark.cdm.schema.origin.keyspaceTable="." \ ---master "local[*]" --driver-memory 25G --executor-memory 25G \ ---class com.datastax.cdm.job.DiffData cassandra-data-migrator-x.y.z.jar &> logfile_name_$(date +%Y%m%d_%H_%M).txt ----- - -The {cstar-data-migrator} validation job will report differences as `ERROR` entries in the log file. -Example: - -[source,bash] ----- -23/04/06 08:43:06 ERROR DiffJobSession: Mismatch row found for key: [key3] Mismatch: Target Index: 1 Origin: valueC Target: value999) -23/04/06 08:43:06 ERROR DiffJobSession: Corrected mismatch row in target: [key3] -23/04/06 08:43:06 ERROR DiffJobSession: Missing target row found for key: [key2] -23/04/06 08:43:06 ERROR DiffJobSession: Inserted missing row in target: [key2] ----- - -[TIP] -==== -To get the list of missing or mismatched records, grep for all `ERROR` entries in the log files. -Differences noted in the log file are listed by primary-key values. -==== - -You can also run the {cstar-data-migrator} validation job in an **AutoCorrect** mode. This mode can: - -* Add any missing records from Origin to Target. -* Update any mismatched records between Origin and Target; this action makes Target the same as Origin. - -To enable or disable this feature, use one or both of the following settings in your `*.properties` configuration file. - -[source,properties] ----- -spark.cdm.autocorrect.missing false|true -spark.cdm.autocorrect.mismatch false|true ----- - -[IMPORTANT] -==== -The {cstar-data-migrator} validation job will never delete records from Target. -The job only adds or updates data on Target. -==== - -[[cdm--partition-ranges]] -== Migrating or validating specific partition ranges - -You can also use {cstar-data-migrator} to migrate or validate specific partition ranges, by using a **partition-file** with the name `./._partitions.csv`. -Use the following format in the CSV file, in the current folder as input. -Example: - -[source,csv] ----- --507900353496146534,-107285462027022883 --506781526266485690,1506166634797362039 -2637884402540451982,4638499294009575633 -798869613692279889,8699484505161403540 ----- - -Each line in the CSV represents a partition-range (`min,max`). - -Alternatively, you can also pass the partition-file via a command-line parameter. -Example: - -[source,bash] ----- -./spark-submit --properties-file cdm.properties \ - --conf spark.cdm.schema.origin.keyspaceTable="." \ - --conf spark.cdm.tokenRange.partitionFile="//" \ - --master "local[*]" --driver-memory 25G --executor-memory 25G \ - --class com.datastax.cdm.job. cassandra-data-migrator-x.y.z.jar &> logfile_name_$(date +%Y%m%d_%H_%M).txt ----- - -This mode is specifically useful to processes a subset of partition-ranges that may have failed during a previous run. - -[NOTE] -==== -A file named `./._partitions.csv` is auto-generated by the migration & validation jobs, in the format shown above. -The file contains any failed partition ranges. -No file is created if there were no failed partitions. -You can use the CSV as input to process any failed partition in a subsequent run. -==== +[[cdm-partition-ranges]] +== Migrate or validate specific partition ranges + +include::partial$cdm-partition-ranges.adoc[] [[cdm-guardrail-checks]] == Perform large-field guardrail violation checks -Use {cstar-data-migrator} to identify large fields from a table that may break your cluster guardrails. -For example, {astra_db} has a 10MB limit for a single large field. -Specify `--class com.datastax.cdm.job.GuardrailCheck` on the command. -Example: +include::partial$cdm-guardrail-checks.adoc[] -[source,bash] ----- -./spark-submit --properties-file cdm.properties \ ---conf spark.cdm.schema.origin.keyspaceTable="." \ ---conf spark.cdm.feature.guardrail.colSizeInKB=10000 \ ---master "local[*]" --driver-memory 25G --executor-memory 25G \ ---class com.datastax.cdm.job.GuardrailCheck cassandra-data-migrator-4.x.x.jar &> logfile_name_$(date +%Y%m%d_%H_%M).txt ----- [[cdm-reference]] -== {cstar-data-migrator} reference - -* xref:#cdm-connection-params[Common connection parameters for Origin and Target] -* xref:#cdm-origin-schema-params[Origin schema parameters] -* xref:#cdm-target-schema-params[Target schema parameter] -* xref:#cdm-auto-correction-params[Auto-correction parameters] -* xref:#cdm-performance-operations-params[Performance and operations parameters] -* xref:#cdm-transformation-params[Transformation parameters] -* xref:#cdm-cassandra-filter-params[Cassandra filter parameters] -* xref:#cdm-java-filter-params[Java filter parameters] -* xref:#cdm-constant-column-feature-params[Constant column feature parameters] -* xref:#cdm-explode-map-feature-params[Explode map feature parameters] -* xref:#cdm-guardrail-feature-params[Guardrail feature parameters] -* xref:#cdm-tls-ssl-connection-params[TLS (SSL) connection parameters] - -[[cdm-connection-params]] -=== Common connection parameters for Origin and Target - -[cols="5,2,4"] -|=== -|Property | Default | Notes - -| `spark.cdm.connect.origin.host` -| `localhost` -| Hostname/IP address of the cluster. -May be a comma-separated list, and can follow the `:` convention. - -| `spark.cdm.connect.origin.port` -| `9042` -| Port number to use if not specified on `spark.cdm.connect.origin.host`. - -| `spark.cdm.connect.origin.scb` -| (Not set) -| Secure Connect Bundle, used to connect to an Astra DB database. -Example: `file:///aaa/bbb/scb-enterprise.zip`. - -| `spark.cdm.connect.origin.username` -| `cassandra` -| Username (or `client_id` value) used to authenticate. - -| `spark.cdm.connect.origin.password` -| `cassandra` -| Password (or `client_secret` value) used to authenticate. - -| `spark.cdm.connect.target.host` -| `localhost` -| Hostname/IP address of the cluster. -May be a comma-separated list, and can follow the `:` convention. - -| `spark.cdm.connect.target.port` -| `9042` -| Port number to use if not specified on `spark.cdm.connect.origin.host`. - -| `spark.cdm.connect.target.scb` -| (Not set) -| Secure Connect Bundle, used to connect to an Astra DB database. -Default is not set. -Example if set: `file:///aaa/bbb/my-scb.zip`. - -| `spark.cdm.connect.target.username` -| `cassandra` -| Username (or `client_id` value) used to authenticate. - -| `spark.cdm.connect.origin.password` -| `cassandra` -| Password (or `client_secret` value) used to authenticate. +== {cstar-data-migrator} references -|=== +=== Common connection parameters for Origin and Target +include::partial$common-connection-parameters.adoc[] -[[cdm-origin-schema-params]] === Origin schema parameters -[cols="3,1,5a"] -|=== -|Property | Default | Notes - -| `spark.cdm.schema.origin.keyspaceTable` -| -| Required - the `.` of the table to be migrated. -Table must exist in Origin. - -| `spark.cdm.schema.origin.column.ttl.automatic` -| `true` -| Default is `true`, unless `spark.cdm.schema.origin.column.ttl.names` is specified. -When `true`, the Time To Live (TTL) of the Target record will be determined by finding the maximum TTL of all Origin columns that can have TTL set (which excludes partition key, clustering key, collections/UDT/tuple, and frozen columns). -When `false`, and `spark.cdm.schema.origin.column.ttl.names` is not set, the Target record will have the TTL determined by the Target table configuration. - -| `spark.cdm.schema.origin.column.ttl.names` -| -| Default is empty, meaning the names will be determined automatically if `spark.cdm.schema.origin.column.ttl.automatic` is set. -Specify a subset of eligible columns that are used to calculate the TTL of the Target record. - -| `spark.cdm.schema.origin.column.writetime.automatic` -| `true` -| Default is `true`, unless `spark.cdm.schema.origin.column.writetime.names` is specified. -When `true`, the `WRITETIME` of the Target record will be determined by finding the maximum `WRITETIME` of all Origin columns that can have `WRITETIME` set (which excludes partition key, clustering key, collections/UDT/tuple, and frozen columns). -When `false`, and `spark.cdm.schema.origin.column.writetime.names` is not set, the Target record will have the `WRITETIME` determined by the Target table configuration. -[NOTE] -==== -The `spark.cdm.transform.custom.writetime` property, if set, would override `spark.cdm.schema.origin.column.writetime`. -==== - -| `spark.cdm.schema.origin.column.writetime.names` -| -| Default is empty, meaning the names will be determined automatically if `spark.cdm.schema.origin.column.writetime.automatic` is set. -Otherwise, specify a subset of eligible columns that are used to calculate the WRITETIME of the Target record. -Example: `data_col1,data_col2,...` - -| `spark.cdm.schema.origin.column.names.to.target` -| -| Default is empty. -If column names are changed between Origin and Target, then this mapped list provides a mechanism to associate the two. -The format is `:`. -The list is comma-separated. -You only need to list renamed columns. - -|=== - -[NOTE] -==== -For optimization reasons, {cstar-data-migrator} does not migrate TTL and writetime at the field-level. -Instead, {cstar-data-migrator} finds the field with the highest TTL, and the field with the highest writetime within an Origin table row, and uses those values on the entire Target table row. -==== - -[[cdm-target-schema-params]] -=== Target schema parameter - -[cols="3,1,2"] -|=== -|Property | Default | Notes - -| `spark.cdm.schema.target.keyspaceTable` -| Equals the value of `spark.cdm.schema.origin.keyspaceTable` -| This parameter is commented out. -It's the `.` of the table to be migrated into the Target. -Table must exist in Target. - -|=== - - -[[cdm-auto-correction-params]] -=== Auto-correction parameters - -Auto-correction parameters allow {cstar-data-migrator} to correct data differences found between Origin and Target when you run the `DiffData` program. -Typically, these are run disabled (for "what if" migration testing), which will generate a list of data discrepancies. -The reasons for these discrepancies can then be investigated, and if necessary the parameters below can be enabled. - -For information about invoking `DiffData` in a {cstar-data-migrator} command, see xref:#cdm-validation-steps[{cstar-data-migrator} steps in validation mode] in this topic. - -[cols="2,2,3a"] -|=== -|Property | Default | Notes - -| `spark.cdm.autocorrect.missing` -| `false` -| When `true`, data that is missing in Target but is found in Origin will be re-migrated to Target. +include::partial$origin-schema-parameters.adoc[] -| `spark.cdm.autocorrect.mismatch` -| `false` -| When `true`, data that is different between Origin and Target will be reconciled. -[NOTE] -==== -The `TIMESTAMP` of records may have an effect. -If the `WRITETIME` of the Origin record (determined with `.writetime.names`) is earlier than the `WRITETIME` of the Target record, the change will not appear in Target. -This comparative state may be particularly challenging to troubleshoot if individual columns (cells) have been modified in Target. -==== +=== Target schema parameters -| `spark.cdm.autocorrect.missing.counter` -| `false` -| Commented out. -By default, Counter tables are not copied when missing, unless explicitly set. +include::partial$target-schema-parameters.adoc[] -| `spark.tokenrange.partitionFile` -| `./._partitions.csv` -| Commented out. -This CSV file is used as input, as well as output when applicable. -If the file exists, only the partition ranges in this file will be migrated or validated. -Similarly, if exceptions occur while migrating or validating, partition ranges with exceptions will be logged to this file. - -|=== +=== Auto-correction parameters +include::partial$auto-correction-parameters.adoc[] -[[cdm-performance-operations-params]] === Performance and operations parameters -Performance and operations parameters that can affect migration throughput, error handling, and similar concerns. - -[cols="4,1,3"] -|=== -|Property | Default | Notes - -| `spark.cdm.perfops.numParts` -| `10000` -| In standard operation, the full token range (-2^63 .. 2^63-1) is divided into a number of parts, which will be parallel-processed. -You should aim for each part to comprise a total of ≈1-10GB of data to migrate. -During initial testing, you may want this to be a small number (such as `1`). - -| `spark.cdm.perfops.batchSize` -| `5` -| When writing to Target, this comprises the number of records that will be put into an `UNLOGGED` batch. -{cstar-data-migrator} will tend to work on the same partition at a time. -Thus if your partition sizes are larger, this number may be increased. -If the `spark.cdm.perfops.batchSize` would mean that more than 1 partition is often contained in a batch, reduce this parameter's value. -Ideally < 1% of batches have more than 1 partition. - -| `spark.cdm.perfops.ratelimit.origin` -| `20000` -| Concurrent number of operations across all parallel threads from Origin. -This value may be adjusted up (or down), depending on the amount of data and the processing capacity of the Origin cluster. - -| `spark.cdm.perfops.ratelimit.target` -| `40000` -| Concurrent number of operations across all parallel threads from Target. -This may be adjusted up (or down), depending on the amount of data and the processing capacity of the Target cluster. - -| `spark.cdm.perfops.consistency.read` -| `LOCAL_QUORUM` -| Commented out. -Read consistency from Origin, and also from Target when records are read for comparison purposes. -The consistency parameters may be one of: `ANY`, `ONE`, `TWO`, `THREE`, `QUORUM`, `LOCAL_ONE`, `EACH_QUORUM`, `LOCAL_QUORUM`, `SERIAL`, `LOCAL_SERIAL`, `ALL`. - -| `spark.cdm.perfops.consistency.write` -| `LOCAL_QUORUM` -| Commented out. -Write consistency to Target. -The consistency parameters may be one of: `ANY`, `ONE`, `TWO`, `THREE`, `QUORUM`, `LOCAL_ONE`, `EACH_QUORUM`, `LOCAL_QUORUM`, `SERIAL`, `LOCAL_SERIAL`, `ALL`. - -| `spark.cdm.perfops.printStatsAfter` -| `100000` -| Commented out. -Number of rows of processing after which a progress log entry will be made. - -| `spark.cdm.perfops.fetchSizeInRows` -| `1000` -| Commented out. -This parameter affects the frequency of reads from Origin, and also the frequency of flushes to Target. - -| `spark.cdm.perfops.errorLimit` -| `0` -| Commented out. -Controls how many errors a thread may encounter during `MigrateData` and `DiffData` operations before failing. -Recommendation: set this parameter to a non-zero value **only when not doing** a mutation-type operation, such as when you're running `DiffData` without `.autocorrect`. - -|=== - - -[[cdm-transformation-params]] -=== Transformation parameters - -Parameters to perform schema transformations between Origin and Target. - -By default, these parameters are commented out. +include::partial$performance-and-operations-parameters.adoc[] -[cols="2,1,4a"] -|=== -|Property | Default | Notes - -| `spark.cdm.transform.missing.key.ts.replace.value` -| `1685577600000` -| Timestamp value in milliseconds. -Partition and clustering columns cannot have null values, but if these are added as part of a schema transformation between Origin and Target, it is possible that the Origin side is null. -In this case, the `Migrate` data operation would fail. -This parameter allows a crude constant value to be used in its place, separate from the Constant values feature. - -| `spark.cdm.transform.custom.writetime` -| `0` -| Default is 0 (disabled). -Timestamp value in microseconds to use as the `WRITETIME` for the Target record. -This is useful when the `WRITETIME` of the record in Origin cannot be determined (such as when the only non-key columns are collections). -This parameter allows a crude constant value to be used in its place, and overrides `spark.cdm.schema.origin.column.writetime.names`. - -| `spark.cdm.transform.custom.writetime.incrementBy` -| `0` -| Default is `0`. -This is useful when you have a List that is not frozen, and you are updating this via the autocorrect feature. -Lists are not idempotent, and subsequent UPSERTs would add duplicates to the list. - -| `spark.cdm.transform.codecs` -| -| Default is empty. -A comma-separated list of additional codecs to enable. - - * `INT_STRING` : int stored in a String. - * `DOUBLE_STRING` : double stored in a String. - * `BIGINT_STRING` : bigint stored in a String. - * `DECIMAL_STRING` : decimal stored in a String. - * `TIMESTAMP_STRING_MILLIS` : timestamp stored in a String, as Epoch milliseconds. - * `TIMESTAMP_STRING_FORMAT` : timestamp stored in a String, with a custom format. - -[NOTE] -==== -Where there are multiple type pair options, such as with `TIMESTAMP_STRING_*`, only one can be configured at a time with the `spark.cdm.transform.codecs` parameter. -==== - -| `spark.cdm.transform.codecs.timestamp.string.format` -| `yyyyMMddHHmmss` -| Configuration for `CQL_TIMESTAMP_TO_STRING_FORMAT` codec. -Default format is `yyyyMMddHHmmss`; `DateTimeFormatter.ofPattern(formatString)` - - -| `spark.cdm.transform.codecs.timestamp.string.zone` -| `UTC` -| Default is `UTC`. -Must be in `ZoneRulesProvider.getAvailableZoneIds()`. - -|=== +=== Transformation parameters +include::partial$transformation-parameters.adoc[] -[[cdm-cassandra-filter-params]] === Cassandra filter parameters -Cassandra filters are applied on the coordinator node. -Note that, depending on the filter, the coordinator node may need to do a lot more work than is normal, notably because {cstar-data-migrator} specifies `ALLOW FILTERING`. +include::partial$cassandra-filter-parameters.adoc[] -By default, these parameters are commented out. - -[cols="3,1,3"] -|=== -|Property | Default | Notes - -| `spark.cdm.filter.cassandra.partition.min` -| `-9223372036854775808` -| Default is `0` (when using `RandomPartitioner`) and `-9223372036854775808` (-2^63) otherwise. -Lower partition bound (inclusive). - -| `spark.cdm.filter.cassandra.partition.max` -| `9223372036854775807` -| Default is `2^127-1` (when using `RandomPartitioner`) and `9223372036854775807` (2^63-1) otherwise. -Upper partition bound (inclusive). - -| `spark.cdm.filter.cassandra.whereCondition` -| -| CQL added to the `WHERE` clause of `SELECT` statements from Origin. - -|=== - - -[[cdm-java-filter-params]] === Java filter parameters -Java filters are applied on the client node. -Data must be pulled from the Origin cluster and then filtered. -However, this option may have a lower impact on the production cluster than xref:cdm-cassandra-filter-params[Cassandra filters]. -Java filters put load onto the {cstar-data-migrator} processing node, by sending more data from Cassandra. -Cassandra filters put load on the Cassandra nodes, notably because {cstar-data-migrator} specifies `ALLOW FILTERING`, which could cause the coordinator node to perform a lot more work. - -By default, these parameters are commented out. - -[cols="2,1,4"] -|=== -|Property | Default | Notes - -| `spark.cdm.filter.java.token.percent` -| `100` -| Percent (between 1 and 100) of the token in each Split that will be migrated. -This property is used to do a wide and random sampling of the data. -The percentage value is applied to each split. -Invalid percentages will be treated as 100. - -| `spark.cdm.filter.java.writetime.min` -| `0` -| The lowest (inclusive) writetime values to be migrated. -Using the `spark.cdm.filter.java.writetime.min` and `spark.cdm.filter.java.writetime.max` thresholds, {cstar-data-migrator} can filter records based on their writetimes. -The maximum writetime of the columns configured at `spark.cdm.schema.origin.column.writetime.names` will be compared to the `.min` and `.max` thresholds, which must be in **microseconds since the epoch**. -If the `spark.cdm.schema.origin.column.writetime.names` are not specified, or the thresholds are null or otherwise invalid, the filter will be ignored. -Note that `spark.cdm.s.perfops.batchSize` will be ignored when this filter is in place; a value of 1 will be used instead. - -| `spark.cdm.filter.java.writetime.max` -| `9223372036854775807` -| The highest (inclusive) writetime values to be migrated. -Maximum timestamp of the columns specified by `spark.cdm.schema.origin.column.writetime.names`; if that property is not specified, or is for some reason null, the filter is ignored. - -| `spark.cdm.filter.java.column.name` -| -| Filter rows based on matching a configured value. -With `spark.cdm.filter.java.column.name`, specify the column name against which the `spark.cdm.filter.java.column.value` is compared. -Must be on the column list specified at `spark.cdm.schema.origin.column.names`. -The column value will be converted to a String, trimmed of whitespace on both ends, and compared. - -| `spark.cdm.filter.java.column.value` -| -| String value to use as comparison. -Whitespace on the ends of `spark.cdm.filter.java.column.value` will be trimmed. -|=== - - -[[cdm-constant-column-feature-params]] -=== Constant column feature parameters - -The constant columns feature allows you to add constant columns to the target table. -If used, the `spark.cdm.feature.constantColumns.names`, `spark.cdm.feature.constantColumns.types`, and `spark.cdm.feature.constantColumns.values` lists must all be the same length. - -By default, these parameters are commented out. - -[cols="2,1,3"] -|=== -|Property | Default | Notes +include::partial$java-filter-parameters.adoc[] -| `spark.cdm.feature.constantColumns.names` -| -| A comma-separated list of column names, such as `const1,const2`. - -| `spark.cdm.feature.constantColumns.type` -| -| A comma-separated list of column types. - -| `spark.cdm.feature.constantColumns.values` -| -| A comma-separated list of hard-coded values. -Each value should be provided as you would use on the `CQLSH` command line. -Examples: `'abcd'` for a string; `1234` for an int, and so on. - -| `spark.cdm.feature.constantColumns.splitRegex` -| `,` -| Defaults to comma, but can be any regex character that works with `String.split(regex)`; this option is needed because some type values contain commas, such as in lists, maps, and sets. - -|=== +=== Constant column feature parameters +include::partial$constant-column-feature-parameters.adoc[] -[[cdm-explode-map-feature-params]] === Explode map feature parameters -The explode map feature allows you convert an Origin table Map into multiple Target table records. - -By default, these parameters are commented out. - -[cols="3,3"] -|=== -|Property | Notes - -| `spark.cdm.feature.explodeMap.origin.name` -| The name of the map column, such as `my_map`. -Must be defined on `spark.cdm.schema.origin.column.names`, and the corresponding type on `spark.cdm.schema.origin.column.types` must be a map. - -| `spark.cdm.feature.explodeMap.origin.name.key` -| The name of the column on the Target table that will hold the map key, such as `my_map_key`. -This key must be present on the Target primary key `spark.cdm.schema.target.column.id.names`. - -| `spark.cdm.feature.explodeMap.origin.value` -| The name of the column on the Target table that will hold the map value, such as `my_map_value`. -|=== - +include::partial$explode-map-feature-parameters.adoc[] -[[cdm-guardrail-feature-params]] === Guardrail feature parameter -The guardrail feature manages records that exceed guardrail checks. -The Guardrail job will generate a report; other jobs will skip records that exceed the guardrail limit. +include::partial$guardrail-feature-parameters.adoc[] -By default, these parameters are commented out. - -[cols="3,1,3"] -|=== -|Property | Default | Notes - -| `spark.cdm.feature.guardrail.colSizeInKB` -| `0` -| The `0` default means the guardrail check is not done. -If set, table records with one or more fields that exceed the column size in kB will be flagged. -Note this is kB (base 10), not kiB (base 2). - -|=== - - -[[cdm-tls-ssl-connection-params]] === TLS (SSL) connection parameters -TLS (SSL) connection parameters, if configured, for Origin and Target. -Note that a secure connect bundle (SCB) embeds these details. - -By default, these parameters are commented out. - -[cols="3,3,3"] -|=== -|Property | Default | Notes - -| `spark.cdm.connect.origin.tls.enabled` -| `false` -| If TLS is used, set to `true`. - -| `spark.cdm.connect.origin.tls.trustStore.path` -| -| Path to the Java truststore file. - -| `spark.cdm.connect.origin.tls.trustStore.password` -| -| Password needed to open the truststore. - -| `spark.cdm.connect.origin.tls.trustStore.type` -| `JKS` -| - -| `spark.cdm.connect.origin.tls.keyStore.path` -| -| Path to the Java keystore file. - -| `spark.cdm.connect.origin.tls.keyStore.password` -| -| Password needed to open the keystore. - -| `spark.cdm.connect.origin.tls.enabledAlgorithms` -| `TLS_RSA_WITH_AES_128_CBC_SHA`,`TLS_RSA_WITH_AES_256_CBC_SHA` -| - -| `spark.cdm.connect.target.tls.enabled` -| `false` -| If TLS is used, set to `true`. - -| `spark.cdm.connect.target.tls.trustStore.path` -| -| Path to the Java truststore file. - -| `spark.cdm.connect.target.tls.trustStore.password` -| -| Password needed to open the truststore. - -| `spark.cdm.connect.target.tls.trustStore.type` -| `JKS` -| - -| `spark.cdm.connect.target.tls.keyStore.path` -| -| Path to the Java keystore file. - -| `spark.cdm.connect.target.tls.keyStore.password` -| -| Password needed to open the keystore. - -| `spark.cdm.connect.target.tls.enabledAlgorithms` -| `TLS_RSA_WITH_AES_128_CBC_SHA`,`TLS_RSA_WITH_AES_256_CBC_SHA` -| +include::partial$tls-ssl-connection-parameters.adoc[] -|=== \ No newline at end of file diff --git a/modules/ROOT/pages/cdm-overview.adoc b/modules/ROOT/pages/cdm-overview.adoc new file mode 100644 index 00000000..efac866c --- /dev/null +++ b/modules/ROOT/pages/cdm-overview.adoc @@ -0,0 +1,25 @@ += Overview + +Cassandra Data Migrator (CDM) is a tool designed for migrating and validating data between origin and target Apache Cassandra-compatible clusters. It facilitates the transfer of data, creating multiple jobs at once that can access the Cassandra cluster concurrently. This tool is also useful when dealing with large datasets and requires careful configuration to balance performance impact and migration speed. + +The information below explains how to get started with CDM. Review your prerequisites and decide between the two installation options: as a container or as a JAR file. + +[[cdm-prerequisites]] +== {cstar-data-migrator} prerequisites + +include::partial$cdm-prerequisites.adoc[] + +== {cstar-data-migrator} installation methods + +Both installation methods require attention to version compatibility, especially with the `cdm.properties` files. +Both environments also use `spark-submit` to run the jobs. + +[[cdm-install-as-container]] +=== Install {cstar-data-migrator} as a Container + +include::partial$cdm-install-as-container.adoc[] + +[[cdm-install-as-jar]] +=== Install {cstar-data-migrator} as a JAR file + +include::partial$cdm-install-as-jar.adoc[] diff --git a/modules/ROOT/pages/cdm-parameters.adoc b/modules/ROOT/pages/cdm-parameters.adoc new file mode 100644 index 00000000..3a1d8e52 --- /dev/null +++ b/modules/ROOT/pages/cdm-parameters.adoc @@ -0,0 +1,70 @@ += {cstar-data-migrator} parameters + +Each parameter below offers a different connection. Review each option to determine what is best for your organization. + +[[cdm-connection-params]] +== Common connection parameters for origin and target + +include::partial$common-connection-parameters.adoc[] + +[[cdm-origin-schema-params]] +== Origin schema parameters + +include::partial$origin-schema-parameters.adoc[] + +[[cdm-target-schema-params]] +== Target schema parameter + +include::partial$target-schema-parameters.adoc[] + +[[cdm-auto-correction-params]] +== Auto-correction parameters + +include::partial$auto-correction-parameters.adoc[] + + +[[cdm-performance-operations-params]] +== Performance and operations parameters + +include::partial$performance-and-operations-parameters.adoc[] + + +[[cdm-transformation-params]] +== Transformation parameters + +include::partial$transformation-parameters.adoc[] + + +[[cdm-cassandra-filter-params]] +== Cassandra filter parameters + +include::partial$cassandra-filter-parameters.adoc[] + + +[[cdm-java-filter-params]] +== Java filter parameters + +include::partial$java-filter-parameters.adoc[] + + +[[cdm-constant-column-feature-params]] +== Constant column feature parameters + +include::partial$constant-column-feature-parameters.adoc[] + + +[[cdm-explode-map-feature-params]] +== Explode map feature parameters + +include::partial$explode-map-feature-parameters.adoc[] + + +[[cdm-guardrail-feature-params]] +== Guardrail feature parameter + +include::partial$guardrail-feature-parameters.adoc[] + +[[cdm-tls-ssl-connection-params]] +== TLS (SSL) connection parameters + +include::partial$tls-ssl-connection-parameters.adoc[] \ No newline at end of file diff --git a/modules/ROOT/pages/cdm-steps.adoc b/modules/ROOT/pages/cdm-steps.adoc new file mode 100644 index 00000000..6b020eff --- /dev/null +++ b/modules/ROOT/pages/cdm-steps.adoc @@ -0,0 +1,23 @@ += {cstar-data-migrator} + +Use {cstar-data-migrator} to migrate and validate tables between the origin and target Cassandra clusters, with available logging and reconciliation support. + +[[cdm-steps]] +== Use {cstar-data-migrator} + +include::partial$use-cdm-migrator.adoc[] + +[[cdm-validation-steps]] +== Use {cstar-data-migrator} steps in validation mode + +include::partial$cdm-validation-steps.adoc[] + +[[cdm--partition-ranges]] +== Migrate or validate specific partition ranges + +include::partial$cdm-partition-ranges.adoc[] + +[[cdm-guardrail-checks]] +== Perform large-field guardrail violation checks + +include::partial$cdm-guardrail-checks.adoc[] diff --git a/modules/ROOT/partials/auto-correction-parameters.adoc b/modules/ROOT/partials/auto-correction-parameters.adoc new file mode 100644 index 00000000..f7b7a68e --- /dev/null +++ b/modules/ROOT/partials/auto-correction-parameters.adoc @@ -0,0 +1,37 @@ +Auto-correction parameters allow {cstar-data-migrator} to correct data differences found between the origin and target clusters when you run the `DiffData` program. +Typically, these parameters are run-disabled for "what if" migration testing, and generate a list of data discrepancies. +The reasons for these discrepancies can then be investigated, and if necessary the parameters below can be enabled. + +For information about invoking `DiffData` in a {cstar-data-migrator} command, see https://docs.datastax.com/en/data-migration/cdm.html#cdm-validation-steps[{cstar-data-migrator} steps in validation mode]. + +[cols="2,2,3a"] +|=== +|Property | Default | Notes + +| `spark.cdm.autocorrect.missing` +| `false` +| When `true`, data that is missing in the target cluster but is found in the origin cluster is re-migrated to the target cluster. + +| `spark.cdm.autocorrect.mismatch` +| `false` +| When `true`, data that is different between the origin and target clusters is reconciled. +[NOTE] +==== +The `TIMESTAMP` of records may have an effect. +If the `WRITETIME` of the origin record that is determined with `.writetime.names` is earlier than the `WRITETIME` of the target record, the change does appear in the target cluster. +This comparative state may be particularly challenging to troubleshoot if individual columns or cells have been modified in the target cluster. +==== + +| `spark.cdm.autocorrect.missing.counter` +| `false` +| Commented out. +By default, counter tables are not copied when missing, unless explicitly set. + +| `spark.tokenrange.partitionFile` +| `./._partitions.csv` +| Commented out. +This CSV file is used as input, as well as output, when applicable. +If the file exists, only the partition ranges in this file are migrated or validated. +Similarly, if exceptions occur while migrating or validating, partition ranges with exceptions are logged to this file. + +|=== \ No newline at end of file diff --git a/modules/ROOT/partials/cassandra-filter-parameters.adoc b/modules/ROOT/partials/cassandra-filter-parameters.adoc new file mode 100644 index 00000000..f9c46c88 --- /dev/null +++ b/modules/ROOT/partials/cassandra-filter-parameters.adoc @@ -0,0 +1,24 @@ +Cassandra filters are applied on the coordinator node. +Depending on the filter, the coordinator node may need to do a lot more work than is normal, notably because {cstar-data-migrator} specifies `ALLOW FILTERING`. + +By default, these parameters are commented out. + +[cols="3,1,3"] +|=== +|Property | Default | Notes + +| `spark.cdm.filter.cassandra.partition.min` +| `-9223372036854775808` +| Default is `0` when using `RandomPartitioner` and `-9223372036854775808` or -2^63 otherwise. +Lower partition bound of the range is inclusive. + +| `spark.cdm.filter.cassandra.partition.max` +| `9223372036854775807` +| Default is `2^127-1` when using `RandomPartitioner` and `9223372036854775807` or 2^63-1 otherwise. +Upper partition bound of the range is inclusive. + +| `spark.cdm.filter.cassandra.whereCondition` +| +| CQL added to the `WHERE` clause of `SELECT` statements from the origin cluster. + +|=== \ No newline at end of file diff --git a/modules/ROOT/partials/cdm-build-jar-local.adoc b/modules/ROOT/partials/cdm-build-jar-local.adoc new file mode 100644 index 00000000..a4c7f6f6 --- /dev/null +++ b/modules/ROOT/partials/cdm-build-jar-local.adoc @@ -0,0 +1,13 @@ +Optionally, you can build the {cstar-data-migrator} JAR for local development. You'll need https://maven.apache.org/download.cgi[Maven] 3.9.x. + +Example: + +[source,bash] +---- +cd ~/github +git clone git@github.com:datastax/cassandra-data-migrator.git +cd cassandra-data-migrator +mvn clean package +---- + +The fat jar file, `cassandra-data-migrator-x.y.z.jar`, should be present now in the `target` folder. \ No newline at end of file diff --git a/modules/ROOT/partials/cdm-guardrail-checks.adoc b/modules/ROOT/partials/cdm-guardrail-checks.adoc new file mode 100644 index 00000000..b83d372b --- /dev/null +++ b/modules/ROOT/partials/cdm-guardrail-checks.adoc @@ -0,0 +1,13 @@ +Use {cstar-data-migrator} to identify large fields from a table that may break your https://docs.datastax.com/en/astra-db-serverless/cql/cassandra-guardrails.html[cluster guardrails]. +For example, {astra_db} has a 10MB limit for a single large field. +Specify `--class com.datastax.cdm.job.GuardrailCheck` on the command. +Example: + +[source,bash] +---- +./spark-submit --properties-file cdm.properties \ +--conf spark.cdm.schema.origin.keyspaceTable="." \ +--conf spark.cdm.feature.guardrail.colSizeInKB=10000 \ +--master "local[*]" --driver-memory 25G --executor-memory 25G \ +--class com.datastax.cdm.job.GuardrailCheck cassandra-data-migrator-4.x.x.jar &> logfile_name_$(date +%Y%m%d_%H_%M).txt +---- diff --git a/modules/ROOT/partials/cdm-install-as-container.adoc b/modules/ROOT/partials/cdm-install-as-container.adoc new file mode 100644 index 00000000..27825330 --- /dev/null +++ b/modules/ROOT/partials/cdm-install-as-container.adoc @@ -0,0 +1,3 @@ +Get the latest image that includes all dependencies from https://hub.docker.com/r/datastax/cassandra-data-migrator[DockerHub]. + +All migration tools, `cassandra-data-migrator` and `dsbulk` and `cqlsh`, are available in the `/assets/` folder of the container. \ No newline at end of file diff --git a/modules/ROOT/partials/cdm-install-as-jar.adoc b/modules/ROOT/partials/cdm-install-as-jar.adoc new file mode 100644 index 00000000..eb60f9b2 --- /dev/null +++ b/modules/ROOT/partials/cdm-install-as-jar.adoc @@ -0,0 +1,8 @@ +Download the *latest* JAR file from the {cstar-data-migrator} https://github.com/datastax/cassandra-data-migrator/packages/1832128[GitHub repo]. +image:https://img.shields.io/github/v/release/datastax/cassandra-data-migrator?color=green[Latest release] + +[NOTE] +==== +Version 4.x of {cstar-data-migrator} is not backward-compatible with `*.properties` files created in previous versions, and package names have changed. +If you're starting new, use the latest released version if possible. +==== diff --git a/modules/ROOT/partials/cdm-partition-ranges.adoc b/modules/ROOT/partials/cdm-partition-ranges.adoc new file mode 100644 index 00000000..121f1566 --- /dev/null +++ b/modules/ROOT/partials/cdm-partition-ranges.adoc @@ -0,0 +1,35 @@ +You can also use {cstar-data-migrator} to migrate or validate specific partition ranges. Use a **partition-file** with the name `./._partitions.csv`. +Use the following format in the CSV file, in the current folder as input. +Example: + +[source,csv] +---- +-507900353496146534,-107285462027022883 +-506781526266485690,1506166634797362039 +2637884402540451982,4638499294009575633 +798869613692279889,8699484505161403540 +---- + +Each line in the CSV represents a partition-range (`min,max`). + +Alternatively, you can also pass the partition-file with a command-line parameter. +Example: + +[source,bash] +---- +./spark-submit --properties-file cdm.properties \ + --conf spark.cdm.schema.origin.keyspaceTable="." \ + --conf spark.cdm.tokenrange.partitionFile.input="//" \ + --master "local[*]" --driver-memory 25G --executor-memory 25G \ + --class com.datastax.cdm.job. cassandra-data-migrator-x.y.z.jar &> logfile_name_$(date +%Y%m%d_%H_%M).txt +---- + +This mode is specifically useful to process a subset of partition-ranges that may have failed during a previous run. + +[NOTE] +==== +In the format shown above, the migration and validation jobs autogenerate a file named `./._partitions.csv`. +The file contains any failed partition ranges. +No file is created if there were no failed partitions. +You can use the CSV as input to process any failed partition in a subsequent run. +==== \ No newline at end of file diff --git a/modules/ROOT/partials/cdm-prerequisites.adoc b/modules/ROOT/partials/cdm-prerequisites.adoc new file mode 100644 index 00000000..a8d39bbd --- /dev/null +++ b/modules/ROOT/partials/cdm-prerequisites.adoc @@ -0,0 +1,16 @@ +Read the prerequisites below before using the Cassandra Data Migrator. + +* Install or switch to Java 11. +The Spark binaries are compiled with this version of Java. +* Select a single VM to run this job and install https://archive.apache.org/dist/spark/spark-3.5.1/[Spark 3.5.1] there. +No cluster is necessary. +* Optionally, install https://maven.apache.org/download.cgi[Maven] 3.9.x if you want to build the JAR for local development. + +Run the following commands to install Apache Spark: + +[source,bash] +---- +wget https://archive.apache.org/dist/spark/spark-3.5.1/spark-3.5.1-bin-hadoop3-scala2.13.tgz + +tar -xvzf spark-3.5.1-bin-hadoop3-scala2.13.tgz +---- diff --git a/modules/ROOT/partials/cdm-validation-steps.adoc b/modules/ROOT/partials/cdm-validation-steps.adoc new file mode 100644 index 00000000..050ae467 --- /dev/null +++ b/modules/ROOT/partials/cdm-validation-steps.adoc @@ -0,0 +1,46 @@ +To run your migration job with {cstar-data-migrator} in **data validation mode**, use class option `--class com.datastax.cdm.job.DiffData`. +Example: + +[source,bash] +---- +./spark-submit --properties-file cdm.properties \ +--conf spark.cdm.schema.origin.keyspaceTable="." \ +--master "local[*]" --driver-memory 25G --executor-memory 25G \ +--class com.datastax.cdm.job.DiffData cassandra-data-migrator-x.y.z.jar &> logfile_name_$(date +%Y%m%d_%H_%M).txt +---- + +The {cstar-data-migrator} validation job reports differences as `ERROR` entries in the log file. +Example: + +[source,bash] +---- +23/04/06 08:43:06 ERROR DiffJobSession: Mismatch row found for key: [key3] Mismatch: Target Index: 1 Origin: valueC Target: value999) +23/04/06 08:43:06 ERROR DiffJobSession: Corrected mismatch row in target: [key3] +23/04/06 08:43:06 ERROR DiffJobSession: Missing target row found for key: [key2] +23/04/06 08:43:06 ERROR DiffJobSession: Inserted missing row in target: [key2] +---- + +[TIP] +==== +To get the list of missing or mismatched records, grep for all `ERROR` entries in the log files. +Differences noted in the log file are listed by primary-key values. +==== + +You can also run the {cstar-data-migrator} validation job in an **AutoCorrect** mode, which can: + +* Add any missing records from the origin to target cluster. +* Update any mismatched records between the origin and target clusters; this action makes the target cluster the same as the origin cluster. + +To enable or disable this feature, use one or both of the following settings in your `*.properties` configuration file. + +[source,properties] +---- +spark.cdm.autocorrect.missing false|true +spark.cdm.autocorrect.mismatch false|true +---- + +[IMPORTANT] +==== +The {cstar-data-migrator} validation job never deletes records from the target cluster. +The job only adds or updates data on the target cluster. +==== \ No newline at end of file diff --git a/modules/ROOT/partials/common-connection-parameters.adoc b/modules/ROOT/partials/common-connection-parameters.adoc new file mode 100644 index 00000000..4bba0002 --- /dev/null +++ b/modules/ROOT/partials/common-connection-parameters.adoc @@ -0,0 +1,50 @@ +[cols="5,2,4"] +|=== +|Property | Default | Notes + +| `spark.cdm.connect.origin.host` +| `localhost` +| Hostname/IP address of the cluster. +May be a comma-separated list, and can follow the `:` convention. + +| `spark.cdm.connect.origin.port` +| `9042` +| Port number to use if not specified on `spark.cdm.connect.origin.host`. + +| `spark.cdm.connect.origin.scb` +| (Not set) +| Secure Connect Bundle, used to connect to an Astra DB database. +Example: `file:///aaa/bbb/scb-enterprise.zip`. + +| `spark.cdm.connect.origin.username` +| `cassandra` +| Username (or `client_id` value) used to authenticate. + +| `spark.cdm.connect.origin.password` +| `cassandra` +| Password (or `client_secret` value) used to authenticate. + +| `spark.cdm.connect.target.host` +| `localhost` +| Hostname/IP address of the cluster. +May be a comma-separated list, and can follow the `:` convention. + +| `spark.cdm.connect.target.port` +| `9042` +| Port number to use if not specified on `spark.cdm.connect.origin.host`. + +| `spark.cdm.connect.target.scb` +| (Not set) +| Secure Connect Bundle, used to connect to an Astra DB database. +Default is not set. +Example if set: `file:///aaa/bbb/my-scb.zip`. + +| `spark.cdm.connect.target.username` +| `cassandra` +| Username (or `client_id` value) used to authenticate. + +| `spark.cdm.connect.origin.password` +| `cassandra` +| Password (or `client_secret` value) used to authenticate. + +|=== \ No newline at end of file diff --git a/modules/ROOT/partials/constant-column-feature-parameters.adoc b/modules/ROOT/partials/constant-column-feature-parameters.adoc new file mode 100644 index 00000000..3098cc92 --- /dev/null +++ b/modules/ROOT/partials/constant-column-feature-parameters.adoc @@ -0,0 +1,29 @@ +The constant columns feature allows you to add constant columns to the target table. +If used, the `spark.cdm.feature.constantColumns.names`, `spark.cdm.feature.constantColumns.types`, and `spark.cdm.feature.constantColumns.values` lists must all be the same length. + +By default, these parameters are commented out. + +[cols="2,1,3"] +|=== +|Property | Default | Notes + +| `spark.cdm.feature.constantColumns.names` +| +| A comma-separated list of column names, such as `const1,const2`. + +| `spark.cdm.feature.constantColumns.type` +| +| A comma-separated list of column types. + +| `spark.cdm.feature.constantColumns.values` +| +| A comma-separated list of hard-coded values. +Each value should be provided as you would use on the `CQLSH` command line. +Examples: `'abcd'` for a string; `1234` for an int, and so on. + +| `spark.cdm.feature.constantColumns.splitRegex` +| `,` +| Defaults to comma, but can be any regex character that works with `String.split(regex)`. +This option is needed because some data values contain commas, such as in lists, maps, and sets. + +|=== \ No newline at end of file diff --git a/modules/ROOT/partials/explode-map-feature-parameters.adoc b/modules/ROOT/partials/explode-map-feature-parameters.adoc new file mode 100644 index 00000000..f88880f0 --- /dev/null +++ b/modules/ROOT/partials/explode-map-feature-parameters.adoc @@ -0,0 +1,19 @@ +The explode map feature allows you convert an origin table map into multiple target table records. + +By default, these parameters are commented out. + +[cols="3,3"] +|=== +|Property | Notes + +| `spark.cdm.feature.explodeMap.origin.name` +| The name of the map column, such as `my_map`. +Must be defined on `spark.cdm.schema.origin.column.names`, and the corresponding type on `spark.cdm.schema.origin.column.types` must be a map. + +| `spark.cdm.feature.explodeMap.origin.name.key` +| The name of the column on the target table that holds the map key, such as `my_map_key`. +This key must be present on the target primary key `spark.cdm.schema.target.column.id.names`. + +| `spark.cdm.feature.explodeMap.origin.value` +| The name of the column on the target table that holds the map value, such as `my_map_value`. +|=== \ No newline at end of file diff --git a/modules/ROOT/partials/guardrail-feature-parameters.adoc b/modules/ROOT/partials/guardrail-feature-parameters.adoc new file mode 100644 index 00000000..7c4b31ab --- /dev/null +++ b/modules/ROOT/partials/guardrail-feature-parameters.adoc @@ -0,0 +1,16 @@ +The guardrail feature manages records that exceed guardrail checks. +The guardrail job generates a report; other jobs skip records that exceed the guardrail limit. + +By default, these parameters are commented out. + +[cols="3,1,3"] +|=== +|Property | Default | Notes + +| `spark.cdm.feature.guardrail.colSizeInKB` +| `0` +| The `0` default means the guardrail check is not done. +If set, table records with one or more fields that exceed the column size in kB are flagged. +Note this is kB which is base 10, not kiB which is base 2. + +|=== diff --git a/modules/ROOT/partials/java-filter-parameters.adoc b/modules/ROOT/partials/java-filter-parameters.adoc new file mode 100644 index 00000000..329a6c95 --- /dev/null +++ b/modules/ROOT/partials/java-filter-parameters.adoc @@ -0,0 +1,46 @@ +Java filters are applied on the client node. +Data must be pulled from the origin cluster and then filtered. +However, this option may have a lower impact on the production cluster than xref:cdm-cassandra-filter-params[Cassandra filters]. +Java filters put a load onto the {cstar-data-migrator} processing node. +They send more data from Cassandra. +Cassandra filters put a load on the Cassandra nodes because {cstar-data-migrator} specifies `ALLOW FILTERING`, which could cause the coordinator node to perform a lot more work. + +By default, these parameters are commented out. + +[cols="2,1,4"] +|=== +|Property | Default | Notes + +| `spark.cdm.filter.java.token.percent` +| `100` +| Between 1 and 100 percent of the token in each split that is migrated. +This property is used to do a wide and random sampling of the data. +The percentage value is applied to each split. +Invalid percentages are treated as 100. + +| `spark.cdm.filter.java.writetime.min` +| `0` +| The lowest (inclusive) writetime values to be migrated. +Using the `spark.cdm.filter.java.writetime.min` and `spark.cdm.filter.java.writetime.max` thresholds, {cstar-data-migrator} can filter records based on their writetimes. +The maximum writetime of the columns configured at `spark.cdm.schema.origin.column.writetime.names` are compared to the `.min` and `.max` thresholds, which must be in **microseconds since the epoch**. +If the `spark.cdm.schema.origin.column.writetime.names` are not specified or the thresholds are null or otherwise invalid, the filter is ignored. +Note that `spark.cdm.s.perfops.batchSize` is ignored when this filter is in place; a value of 1 is used instead. + +| `spark.cdm.filter.java.writetime.max` +| `9223372036854775807` +| The highest (inclusive) writetime values to be migrated. +The `spark.cdm.schema.origin.column.writetime.names` specifies the maximum timestamp of the columns. +If that property is not specified or is for some reason null, the filter is ignored. + +| `spark.cdm.filter.java.column.name` +| +| Filter rows based on matching a configured value. +With `spark.cdm.filter.java.column.name`, specify the column name against which the `spark.cdm.filter.java.column.value` is compared. +Must be on the column list specified at `spark.cdm.schema.origin.column.names`. +The column value is converted to a string, trimmed of whitespace on both ends, and compared. + +| `spark.cdm.filter.java.column.value` +| +| String value to use as comparison. +The whitespace on the ends of `spark.cdm.filter.java.column.value` is trimmed. +|=== \ No newline at end of file diff --git a/modules/ROOT/partials/origin-schema-parameters.adoc b/modules/ROOT/partials/origin-schema-parameters.adoc new file mode 100644 index 00000000..360a3b2f --- /dev/null +++ b/modules/ROOT/partials/origin-schema-parameters.adoc @@ -0,0 +1,54 @@ +[cols="3,1,5a"] +|=== +|Property | Default | Notes + +| `spark.cdm.schema.origin.keyspaceTable` +| +| Required - the `.` of the table to be migrated. +Table must exist in the origin cluster. + +| `spark.cdm.schema.origin.column.ttl.automatic` +| `true` +| Default is `true`, unless `spark.cdm.schema.origin.column.ttl.names` is specified. +When `true`, determine the Time To Live (TTL) of the target record. +Find the maximum TTL of all origin columns that can have TTL set. This excludes partition key, clustering key, collections/UDT/tuple, and frozen columns. +When `false`, and `spark.cdm.schema.origin.column.ttl.names` is not set, the target record has the target table configuration determine the TTL. + +| `spark.cdm.schema.origin.column.ttl.names` +| +| Default is empty, meaning the names are determined automatically if `spark.cdm.schema.origin.column.ttl.automatic` is set. +Specify a subset of eligible columns that are used to calculate the TTL of the target record. + +| `spark.cdm.schema.origin.column.writetime.automatic` +| `true` +| Default is `true`, unless `spark.cdm.schema.origin.column.writetime.names` is specified. +When `true`, determine the `WRITETIME` of the target record. +Find the maximum `WRITETIME` of all origin columns that can have `WRITETIME` set. This excludes partition key, clustering key, collections/UDT/tuple, and frozen columns. +When `false`, and `spark.cdm.schema.origin.column.writetime.names` is not set, the target table configuration determines the target record's `WRITETIME`. + +[NOTE] +==== +The `spark.cdm.transform.custom.writetime` property, if set, overrides `spark.cdm.schema.origin.column.writetime`. +==== + +| `spark.cdm.schema.origin.column.writetime.names` +| +| Default is empty, meaning the names are determined automatically if `spark.cdm.schema.origin.column.writetime.automatic` is set. +Otherwise, specify a subset of eligible columns that are used to calculate the WRITETIME of the target record. +Example: `data_col1,data_col2,...` + +| `spark.cdm.schema.origin.column.names.to.target` +| +| Default is empty. +If column names are changed between the origin and target clusters, then this mapped list provides a mechanism to associate the two. +The format is `:`. +The list is comma separated. +You only need to list renamed columns. + +|=== + +[NOTE] +==== +For optimization reasons, {cstar-data-migrator} does not migrate TTL and writetime at the field level. +Instead, {cstar-data-migrator} finds the field with the highest TTL and the field with the highest writetime within an origin table row, and uses those values on the entire target table row. +==== \ No newline at end of file diff --git a/modules/ROOT/partials/performance-and-operations-parameters.adoc b/modules/ROOT/partials/performance-and-operations-parameters.adoc new file mode 100644 index 00000000..45277759 --- /dev/null +++ b/modules/ROOT/partials/performance-and-operations-parameters.adoc @@ -0,0 +1,59 @@ +Performance and operations parameters that can affect migration throughput, error handling, and similar concerns. + +[cols="4,1,3"] +|=== +|Property | Default | Notes + +| `spark.cdm.perfops.numParts` +| `10000` +| In standard operation, the full token range of -2^63 to 2^63-1 is divided into a number of parts, which are parallel processed. +You should aim for each part to comprise a total of ≈1-10GB of data to migrate. +During initial testing, you may want this to be a small number, such as `1`. + +| `spark.cdm.perfops.batchSize` +| `5` +| When writing to the target cluster, this comprises the number of records that are put into an `UNLOGGED` batch. +{cstar-data-migrator} tends to work on the same partition at a time. +If your partition sizes are larger, this number may be increased. +If the `spark.cdm.perfops.batchSize` would mean that more than 1 partition is often contained in a batch, reduce this parameter's value. +Ideally < 1% of batches have more than 1 partition. + +| `spark.cdm.perfops.ratelimit.origin` +| `20000` +| Concurrent number of operations across all parallel threads from the origin cluster. +This value may be adjusted up or down, depending on the amount of data and the processing capacity of the origin cluster. + +| `spark.cdm.perfops.ratelimit.target` +| `40000` +| Concurrent number of operations across all parallel threads from the target cluster. +This may be adjusted up or down, depending on the amount of data and the processing capacity of the target cluster. + +| `spark.cdm.perfops.consistency.read` +| `LOCAL_QUORUM` +| Commented out. +Read consistency from the origin cluster and from the target cluster when records are read for comparison purposes. +The consistency parameters may be one of: `ANY`, `ONE`, `TWO`, `THREE`, `QUORUM`, `LOCAL_ONE`, `EACH_QUORUM`, `LOCAL_QUORUM`, `SERIAL`, `LOCAL_SERIAL`, `ALL`. + +| `spark.cdm.perfops.consistency.write` +| `LOCAL_QUORUM` +| Commented out. +Write consistency to the target cluster. +The consistency parameters may be one of: `ANY`, `ONE`, `TWO`, `THREE`, `QUORUM`, `LOCAL_ONE`, `EACH_QUORUM`, `LOCAL_QUORUM`, `SERIAL`, `LOCAL_SERIAL`, `ALL`. + +| `spark.cdm.perfops.printStatsAfter` +| `100000` +| Commented out. +Number of rows of processing after which a progress log entry is made. + +| `spark.cdm.perfops.fetchSizeInRows` +| `1000` +| Commented out. +This parameter affects the frequency of reads from the origin cluster and the frequency of flushes to the target cluster. + +| `spark.cdm.perfops.errorLimit` +| `0` +| Commented out. +Controls how many errors a thread may encounter during `MigrateData` and `DiffData` operations before failing. +Recommendation: set this parameter to a non-zero value **only when not doing** a mutation-type operation, such as when you're running `DiffData` without `.autocorrect`. + +|=== \ No newline at end of file diff --git a/modules/ROOT/partials/target-schema-parameters.adoc b/modules/ROOT/partials/target-schema-parameters.adoc new file mode 100644 index 00000000..62a1f610 --- /dev/null +++ b/modules/ROOT/partials/target-schema-parameters.adoc @@ -0,0 +1,11 @@ +[cols="3,1,2"] +|=== +|Property | Default | Notes + +| `spark.cdm.schema.target.keyspaceTable` +| Equals the value of `spark.cdm.schema.origin.keyspaceTable` +| This parameter is commented out. +It's the `.` of the table to be migrated into the target. +Table must exist in the target cluster. + +|=== \ No newline at end of file diff --git a/modules/ROOT/partials/tls-ssl-connection-parameters.adoc b/modules/ROOT/partials/tls-ssl-connection-parameters.adoc new file mode 100644 index 00000000..985092d9 --- /dev/null +++ b/modules/ROOT/partials/tls-ssl-connection-parameters.adoc @@ -0,0 +1,66 @@ +These are TLS (SSL) connection parameters, if configured, for the origin and target clusters. +Note that a secure connect bundle (SCB) embeds these details. + +By default, these parameters are commented out. + +[cols="3,3,3"] +|=== +|Property | Default | Notes + +| `spark.cdm.connect.origin.tls.enabled` +| `false` +| If TLS is used, set to `true`. + +| `spark.cdm.connect.origin.tls.trustStore.path` +| +| Path to the Java truststore file. + +| `spark.cdm.connect.origin.tls.trustStore.password` +| +| Password needed to open the truststore. + +| `spark.cdm.connect.origin.tls.trustStore.type` +| `JKS` +| + +| `spark.cdm.connect.origin.tls.keyStore.path` +| +| Path to the Java keystore file. + +| `spark.cdm.connect.origin.tls.keyStore.password` +| +| Password needed to open the keystore. + +| `spark.cdm.connect.origin.tls.enabledAlgorithms` +| `TLS_RSA_WITH_AES_128_CBC_SHA`,`TLS_RSA_WITH_AES_256_CBC_SHA` +| + +| `spark.cdm.connect.target.tls.enabled` +| `false` +| If TLS is used, set to `true`. + +| `spark.cdm.connect.target.tls.trustStore.path` +| +| Path to the Java truststore file. + +| `spark.cdm.connect.target.tls.trustStore.password` +| +| Password needed to open the truststore. + +| `spark.cdm.connect.target.tls.trustStore.type` +| `JKS` +| + +| `spark.cdm.connect.target.tls.keyStore.path` +| +| Path to the Java keystore file. + +| `spark.cdm.connect.target.tls.keyStore.password` +| +| Password needed to open the keystore. + +| `spark.cdm.connect.target.tls.enabledAlgorithms` +| `TLS_RSA_WITH_AES_128_CBC_SHA`,`TLS_RSA_WITH_AES_256_CBC_SHA` +| + +|=== \ No newline at end of file diff --git a/modules/ROOT/partials/transformation-parameters.adoc b/modules/ROOT/partials/transformation-parameters.adoc new file mode 100644 index 00000000..d8ff2f18 --- /dev/null +++ b/modules/ROOT/partials/transformation-parameters.adoc @@ -0,0 +1,58 @@ +Parameters to perform schema transformations between the origin and target clusters. + +By default, these parameters are commented out. + +[cols="2,1,4a"] +|=== +|Property | Default | Notes + +| `spark.cdm.transform.missing.key.ts.replace.value` +| `1685577600000` +| Timestamp value in milliseconds. +Partition and clustering columns cannot have null values. +If they are added as part of a schema transformation between the origin and target clusters, it is possible that the origin side is null. +In this case, the `Migrate` data operation fails. +This parameter allows a crude constant value to be used in its place that is separate from the constant values feature. + +| `spark.cdm.transform.custom.writetime` +| `0` +| Default is 0 (disabled). +Timestamp value in microseconds to use as the `WRITETIME` for the target record. +This is useful when the `WRITETIME` of the record in the origin cluster cannot be determined. Such an example is when the only non-key columns are collections. +This parameter allows a crude constant value to be used in its place and overrides `spark.cdm.schema.origin.column.writetime.names`. + +| `spark.cdm.transform.custom.writetime.incrementBy` +| `0` +| Default is `0`. +This is useful when you have a list that is not frozen and you are updating this using the autocorrect feature. +Lists are not idempotent, and subsequent UPSERTs add duplicates to the list. + +| `spark.cdm.transform.codecs` +| +| Default is empty. +A comma-separated list of additional codecs to enable. + + * `INT_STRING` : int stored in a string. + * `DOUBLE_STRING` : double stored in a string. + * `BIGINT_STRING` : bigint stored in a string. + * `DECIMAL_STRING` : decimal stored in a string. + * `TIMESTAMP_STRING_MILLIS` : timestamp stored in a string, as Epoch milliseconds. + * `TIMESTAMP_STRING_FORMAT` : timestamp stored in a string with a custom format. + +[NOTE] +==== +Where there are multiple type pair options, such as with `TIMESTAMP_STRING_*`, only one can be configured at a time with the `spark.cdm.transform.codecs` parameter. +==== + +| `spark.cdm.transform.codecs.timestamp.string.format` +| `yyyyMMddHHmmss` +| Configuration for `CQL_TIMESTAMP_TO_STRING_FORMAT` codec. +Default format is `yyyyMMddHHmmss`; `DateTimeFormatter.ofPattern(formatString)` + + +| `spark.cdm.transform.codecs.timestamp.string.zone` +| `UTC` +| Default is `UTC`. +Must be in `ZoneRulesProvider.getAvailableZoneIds()`. + +|=== \ No newline at end of file diff --git a/modules/ROOT/partials/use-cdm-migrator.adoc b/modules/ROOT/partials/use-cdm-migrator.adoc new file mode 100644 index 00000000..e5513d51 --- /dev/null +++ b/modules/ROOT/partials/use-cdm-migrator.adoc @@ -0,0 +1,28 @@ +. Configure for your environment the `cdm*.properties` file that's provided in the {cstar-data-migrator} https://github.com/datastax/cassandra-data-migrator/tree/main/src/resources[GitHub repo]. +The file can have any name. +It does not need to be `cdm.properties` or `cdm-detailed.properties`. +In both versions, the `spark-submit` job processes only the parameters that aren't commented out. +Other parameter values use defaults or are ignored. +See the descriptions and defaults in each file. +For more information, see the following: + * The simplified sample properties configuration, https://github.com/datastax/cassandra-data-migrator/blob/main/src/resources/cdm.properties[cdm.properties]. + This file contains only those parameters that are commonly configured. + * The complete sample properties configuration, https://github.com/datastax/cassandra-data-migrator/blob/main/src/resources/cdm-detailed.properties[cdm-detailed.properties], for the full set of configurable settings. + +. Place the properties file that you elected to use and customize where it can be accessed while running the job using `spark-submit`. + +. Run the job using `spark-submit` command: + +[source,bash] +---- +./spark-submit --properties-file cdm.properties \ +--conf spark.cdm.schema.origin.keyspaceTable="." \ +--master "local[*]" --driver-memory 25G --executor-memory 25G \ +--class com.datastax.cdm.job.Migrate cassandra-data-migrator-x.y.z.jar &> logfile_name_$(date +%Y%m%d_%H_%M).txt +---- + +[TIP] +==== +* The command generates a log file `logfile_name_*.txt` to prevent log output on the console. +* Update the memory options, driver and executor memory, based on your use case. +==== \ No newline at end of file