WIP: URLs: DataStax -> ScyllaDB docs

wprzytula · wprzytula · commit 5aeb383f0ee1 · 2025-08-14T14:11:38.000+02:00
diff --git a/README.md b/README.md
@@ -137,7 +137,7 @@ int main() {
 ___
 
 The driver inherits almost all the features of C/C++ and Rust drivers, such as:
- * [Asynchronous API](http://datastax.github.io/cpp-driver/topics/#futures)
+ * [Asynchronous API](https://cpp-rust-driver.docs.scylladb.com/stable/topics/#futures)
  * Shard-aware routing
  * Simple, Prepared and Batch statements
  * Query paging
@@ -146,9 +146,9 @@ The driver inherits almost all the features of C/C++ and Rust drivers, such as:
  * Retry policies
  * SSL
  * Authentication
- * [Tuples](http://datastax.github.io/cpp-driver/topics/basics/data-types/tuples/) and [UDTs](http://datastax.github.io/cpp-driver/topics/basics/data-types/user-defined-types/)
- * [Nested collections](http://datastax.github.io/cpp-driver/topics/basics/binding-parameters/#nested-collections)
- * [Data types](http://datastax.github.io/cpp-driver/topics/basics/data-types/)
+ * [Tuples](https://cpp-rust-driver.docs.scylladb.com/stable/topics/basics/data-types/tuples/) and [UDTs](http://https://cpp-rust-driver.docs.scylladb.com/stable/topics/basics/data-types/user-defined-types/)
+ * [Nested collections](https://cpp-rust-driver.docs.scylladb.com/stable/topics/basics/binding-parameters/#nested-collections)
+ * [Data types](https://cpp-rust-driver.docs.scylladb.com/stable/topics/basics/data-types/)
  * Schema metadata (keyspace metadata, materialized views, etc.)
 
 # Limitations
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -187,8 +187,9 @@ def setup(sphinx):
     )
 
     # Workaround to replace DataStax links
+    # FIXME(David Garcia) - Make this workaround work correctly.
     replacements = [
-        {"http://datastax.github.io/cpp-driver/api/cassandra.h/": "https://cpp-rust-driver.docs.scylladb.com/" + smv_latest_version + "/api"},
+        {"https://cpp-rust-driver.docs.scylladb.com/stable/api/cassandra.h/": "https://cpp-rust-driver.docs.scylladb.com/" + smv_latest_version + "/api"},
         {"http://datastax.github.io/cpp-driver": "https://cpp-rust-driver.docs.scylladb.com/" + smv_latest_version},
         {"http://docs.datastax.com/en/developer/cpp-driver/latest": "https://cpp-rust-driver.docs.scylladb.com/" + smv_latest_version},
     ]
diff --git a/docs/source/topics/configuration/performance-tips.md b/docs/source/topics/configuration/performance-tips.md
@@ -39,7 +39,7 @@ to wait for one or more nodes to respond back to the coordinator node before a
 request can complete. In multi-datacenter configurations, consistency levels such as
 `EACH_QUORUM` can cause a request to wait for replication across a slower cross
 datacenter network link.  More information about setting the consistency level
-can be found [here](http://datastax.github.io/cpp-driver/topics/basics/consistency/).
+can be found [here](https://cpp-rust-driver.docs.scylladb.com/stable/topics/basics/consistency/).
 
 ## Driver Tuning
 
@@ -87,6 +87,6 @@ recommended that your application decrease this value if computationally
 expensive or long-running future callbacks are used (via
 `cass_future_set_callback()`), otherwise this can be left unchanged.
 
-[token-aware]: https://cpp-rust-driver.docs.scylladb.com/stable/topics/configuration/load_balancing#latency-aware-routing
-[latency-aware]: https://cpp-rust-driver.docs.scylladb.com/stable/topics/configuration/load_balancing#token-aware-routing
-[paging]: https://cpp-rust-driver.docs.scylladb.com/stable/topics/basics/handling_results#paging
+[token-aware]: https://cpp-rust-driver.docs.scylladb.com/stable/topics/configuration/load-balancing#latency-aware-routing
+[latency-aware]: https://cpp-rust-driver.docs.scylladb.com/stable/topics/configuration/load-balancing#token-aware-routing
+[paging]: https://cpp-rust-driver.docs.scylladb.com/stable/topics/basics/handling-results#paging
diff --git a/docs/source/topics/configuration/retry-policies.md b/docs/source/topics/configuration/retry-policies.md
@@ -141,9 +141,9 @@ cass_retry_policy_free(logging_policy);
 
 cass_cluster_free(cluster);
 ```
-[`cass_cluster_set_retry_policy()`]: http://datastax.github.io/cpp-driver/api/struct.CassCluster#cass-cluster-set-retry-policy
-[`cass_statement_set_retry_policy()`]: http://datastax.github.io/cpp-driver/api/struct.CassStatement#cass-statement-set-retry-policy
-[`cass_statement_set_is_idempotent()`]: http://datastax.github.io/cpp-driver/api/struct.CassStatement#cass-statement-set-is-idempotent
-[`cass_batch_set_retry_policy()`]: http://datastax.github.io/cpp-driver/api/struct.CassBatch#cass-batch-set-retry-policy
-[`cass_batch_set_is_idempotent()`]: http://datastax.github.io/cpp-driver/api/struct.CassBatch#cass-batch-set-is-idempotent
-[`CASS_LOG_INFO`]: http://datastax.github.io/cpp-driver/api/cassandra.h#cass-log-level
+[`cass_cluster_set_retry_policy()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassCluster#cass-cluster-set-retry-policy
+[`cass_statement_set_retry_policy()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassStatement#cass-statement-set-retry-policy
+[`cass_statement_set_is_idempotent()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassStatement#cass-statement-set-is-idempotent
+[`cass_batch_set_retry_policy()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassBatch#cass-batch-set-retry-policy
+[`cass_batch_set_is_idempotent()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassBatch#cass-batch-set-is-idempotent
+[`CASS_LOG_INFO`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/cassandra.h#cass-log-level
diff --git a/docs/source/topics/observability/metrics.md b/docs/source/topics/observability/metrics.md
@@ -38,8 +38,8 @@ a request fails to get a timely response.
 Connection timeouts occur when the process of establishing new connections is
 unresponsive.
 
-[`cass_session_get_metrics()`]: http://datastax.github.io/cpp-driver/api/struct.CassSession#1ab3773670c98c00290bad48a6df0f9eae
-[`CassMetrics`]: http://datastax.github.io/cpp-driver/api/struct.CassMetrics
-[`requests`]: http://datastax.github.io/cpp-driver/api/struct.CassMetrics#attribute-requests
-[`stats`]: http://datastax.github.io/cpp-driver/api/struct.CassMetrics#attribute-stats
-[`errors`]: http://datastax.github.io/cpp-driver/api/struct.CassMetrics#attribute-errors
+[`cass_session_get_metrics()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassSession#1ab3773670c98c00290bad48a6df0f9eae
+[`CassMetrics`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassMetrics
+[`requests`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassMetrics#attribute-requests
+[`stats`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassMetrics#attribute-stats
+[`errors`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassMetrics#attribute-errors
diff --git a/docs/source/topics/security/tls.md b/docs/source/topics/security/tls.md
@@ -59,7 +59,7 @@ The following [guide](http://www.datastax.com/documentation/cassandra/2.1/cassan
 
 ## Setting up the C/C++ Driver to Use TLS
 
-A [`CassSsl`](http://datastax.github.io/cpp-driver/api/struct.CassSsl) object is required and must be configured:
+A [`CassSsl`](https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassSsl) object is required and must be configured:
 
 ```c
 #include <cassandra.h>
diff --git a/docs/source/topics/testing.md b/docs/source/topics/testing.md
@@ -116,4 +116,4 @@ Here are some of the items being scheduled for future enhancements.
 - Updates to CCM Bridge
  - Allow files to be copied over SSH established connection
 
-[build procedures]: http://datastax.github.io/cpp-driver/topics/building#test-dependencies-and-building-tests-not-required
+[build procedures]: https://cpp-rust-driver.docs.scylladb.com/stable/topics/building#test-dependencies-and-building-tests-not-required
diff --git a/docs/source/topics/using/binding-parameters.md b/docs/source/topics/using/binding-parameters.md
@@ -36,7 +36,7 @@ Calling `cass_statement_reset_parameters()` will unbind (or resize) a statement'
 
 ## Constructing Collections
 
-Collections are supported using [`CassCollection`](http://datastax.github.io/cpp-driver/api/struct.CassCollection) objects; supporting `list`, `map` and `set` ScyllaDB/Cassandra types. The code below shows how to construct a `list` collection; however, a set can be constructed in a very similar way. The only difference is the type `CASS_COLLECTION_TYPE_SET` is used to create the collection instead of `CASS_COLLECTION_TYPE_LIST`.
+Collections are supported using [`CassCollection`](https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassCollection) objects; supporting `list`, `map` and `set` ScyllaDB/Cassandra types types. The code below shows how to construct a `list` collection; however, a set can be constructed in a very similar way. The only difference is the type `CASS_COLLECTION_TYPE_SET` is used to create the collection instead of `CASS_COLLECTION_TYPE_LIST`.
 
 **Important**: Values appended to the collection can be freed immediately afterward because the values are copied.
 
@@ -85,4 +85,4 @@ cass_collection_free(map);
 A collection can be added to another collection using [`cass_collection_append_collection()`].
 
 [`cass_collection_append_collection()`]:
-http://datastax.github.io/cpp-driver/api/struct.CassCollection#cass-collection-append-collection
+https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassCollection#cass-collection-append-collection
diff --git a/docs/source/topics/using/client-side-timestamps.md b/docs/source/topics/using/client-side-timestamps.md
@@ -61,5 +61,5 @@ cass_batch_set_timestamp(batch, 123456789);
 /* Add statements to batch */
 ```
 
-[`CassStatement`]: http://datastax.github.io/cpp-driver/api/struct.CassStatement/
-[`CassBatch`]: http://datastax.github.io/cpp-driver/api/struct.CassBatch/
+[`CassStatement`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassStatement/
+[`CassBatch`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassBatch/
diff --git a/docs/source/topics/using/consistency.md b/docs/source/topics/using/consistency.md
@@ -82,7 +82,7 @@ application. Descriptions for each read/write consistency level can be found
 
 ## Setting Consistency Level
 
-A ['CassStatement'](http://datastax.github.io/cpp-driver/api/struct.CassFuture/) object
+A ['CassStatement'](https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassFuture/) object
 can have its consistency level altered at anytime before the statement is
 executed by the session.
 
diff --git a/docs/source/topics/using/data-types/index.md b/docs/source/topics/using/data-types/index.md
@@ -214,16 +214,16 @@ cass_tuple_free(address);
 cass_collection_free(phone_numbers);
 ```
 
-[`CassDataType`]: http://datastax.github.io/cpp-driver/api/struct.CassDataType
-[`CassUserType`]: http://datastax.github.io/cpp-driver/api/struct.CassUserType
-[`CassPrepared`]: http://datastax.github.io/cpp-driver/api/struct.CassPrepared
-[`CassResult`]: http://datastax.github.io/cpp-driver/api/struct.CassResult
-[`CassValue`]: http://datastax.github.io/cpp-driver/api/struct.CassValue
-[`CassSchemaMeta`]: http://datastax.github.io/cpp-driver/api/struct.CassSchemaMeta
-[`cass_user_type_new_from_data_type()`]: http://datastax.github.io/cpp-driver/api/struct.CassUserType#cass-user-type-new-from-data-type
-[`cass_result_column_data_type()`]: http://datastax.github.io/cpp-driver/api/struct.CassResult#cass-result-column-data-type
-[`cass_prepared_parameter_data_type()`]: http://datastax.github.io/cpp-driver/api/struct.CassPrepared#cass-prepared-parameter-data-type
-[`cass_value_data_type()`]: http://datastax.github.io/cpp-driver/api/struct.CassValue#cass-value-data-type
+[`CassDataType`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassDataType
+[`CassUserType`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassUserType
+[`CassPrepared`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassPrepared
+[`CassResult`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassResult
+[`CassValue`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassValue
+[`CassSchemaMeta`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassSchemaMeta
+[`cass_user_type_new_from_data_type()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassUserType#cass-user-type-new-from-data-type
+[`cass_result_column_data_type()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassResult#cass-result-column-data-type
+[`cass_prepared_parameter_data_type()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassPrepared#cass-prepared-parameter-data-type
+[`cass_value_data_type()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassValue#cass-value-data-type
 
 ```{eval-rst}
 .. toctree::
diff --git a/docs/source/topics/using/data-types/tuples.md b/docs/source/topics/using/data-types/tuples.md
@@ -90,6 +90,6 @@ void iterate_tuple(const CassRow* row) {
 }
 ```
 
-[`CassTuple`]: http://datastax.github.io/cpp-driver/api/struct.CassTuple
-[`CassUserType`]: http://datastax.github.io/cpp-driver/api/struct.CassUserType
-[`cass_tuple_set_*()`]: http://datastax.github.io/cpp-driver/api/struct.CassTuple#cass-tuple-set-null
+[`CassTuple`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassTuple
+[`CassUserType`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassUserType
+[`cass_tuple_set_*()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassTuple#cass-tuple-set-null
diff --git a/docs/source/topics/using/data-types/user-defined-types.md b/docs/source/topics/using/data-types/user-defined-types.md
@@ -90,7 +90,7 @@ void iterate_udt(const CassRow* row) {
   cass_iterator_free(udt_iterator);
 }
 ```
-[`CassSchemaMeta`]: http://datastax.github.io/cpp-driver/api/struct.CassSchemaMeta
-[`CassUserType`]: http://datastax.github.io/cpp-driver/api/struct.CassUserType
-[`CassDataType`]: http://datastax.github.io/cpp-driver/api/struct.CassDataType
-[`cass_session_get_schema()`]: http://datastax.github.io/cpp-driver/api/struct.CassSession#cass-session-get-schema
+[`CassSchemaMeta`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassSchemaMeta
+[`CassUserType`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassUserType
+[`CassDataType`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassDataType
+[`cass_session_get_schema()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassSession#cass-session-get-schema
diff --git a/docs/source/topics/using/data-types/uuids.md b/docs/source/topics/using/data-types/uuids.md
@@ -63,5 +63,5 @@ cass_uint8_t version = cass_uuid_version(uuid);
 char uuid_str[CASS_UUID_STRING_LENGTH];
 cass_uuid_string(uuid, uuid_str);
 ```
-[`cass_uuid_timestamp()`]: http://datastax.github.io/cpp-driver/api/struct.CassUuid#1a3980467a0bb6642054ecf37d49aebf1a
-[`CassUuidGen`]: http://datastax.github.io/cpp-driver/api/struct.CassUuidGen
+[`cass_uuid_timestamp()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassUuid#1a3980467a0bb6642054ecf37d49aebf1a
+[`CassUuidGen`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassUuidGen
diff --git a/docs/source/topics/using/handling-results.md b/docs/source/topics/using/handling-results.md
@@ -1,6 +1,6 @@
 # Handling Results
 
-The [`CassResult`](http://datastax.github.io/cpp-driver/api/struct.CassResult) object
+The [`CassResult`](https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassResult) object
 is typically returned for `SELECT` statements. For mutations (`INSERT`, `UPDATE`,
 and `DELETE`) only a status code will be present and can be accessed using
 `cass_future_error_code()`. However, when using lightweight transactions a
@@ -28,7 +28,7 @@ void process_result(CassFuture* future) {
 
 The result object represents a collection of rows. The first row, if present,
 can be obtained using `cass_result_first_row()`. Multiple rows are accessed
-using a [`CassIterator`](http://datastax.github.io/cpp-driver/api/struct.CassIterator)
+using a [`CassIterator`](https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassIterator)
 object. After a row has been retrieved, the column value(s) can be accessed from
 a row by either index or by name. The iterator object can also be used with
 enumerated column values.
@@ -51,7 +51,7 @@ void process_first_row_by_name(const CassResult* result) {
 }
 ```
 
-Once the [`CassValue`](http://datastax.github.io/cpp-driver/api/struct.CassValue)
+Once the [`CassValue`](https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassValue)
 has been obtained from the column, the actual value can be retrieved and
 assigned into the proper datatype.
 
@@ -130,7 +130,7 @@ void iterator_over_map_value(CassFuture* future) {
 ## Paging
 
 Large result sets can be divided into multiple pages automatically. The
-[`CassResult`](http://datastax.github.io/cpp-driver/api/struct.CassResult) object
+[`CassResult`](https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassResult) object
 keeps track of the pagination state for the sequence of paging queries. When
 paging through the result set, the result object is checked to see if more pages
 exist where it is then attached to the statement before re-executing the query
@@ -186,6 +186,6 @@ accessed using [`cass_result_paging_state()`] and added to a statement using
 untrusted environments. That paging state could be spoofed and potentially used
 to gain access to other data.
 
-[`cass_statement_set_paging_state()`]: http://datastax.github.io/cpp-driver/api/struct.CassStatement#cass-statement-set-paging-state
-[`cass_result_paging_state()`]: http://datastax.github.io/cpp-driver/api/struct.CassResult#cass-result-paging-state
-[`cass_statement_set_paging_state_token()`]: http://datastax.github.io/cpp-driver/api/struct.CassStatement#cass-statement-set-paging-state-token
+[`cass_statement_set_paging_state()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassStatement#cass-statement-set-paging-state
+[`cass_result_paging_state()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassResult#cass-result-paging-state
+[`cass_statement_set_paging_state_token()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassStatement#cass-statement-set-paging-state-token
diff --git a/docs/source/topics/using/schema-metadata.md b/docs/source/topics/using/schema-metadata.md
@@ -58,4 +58,4 @@ cass_cluster_set_use_schema(cluster, cass_false);
 
 cass_cluster_free(cluster);
 ```
-[`cass_session_get_schema_meta()`]: http://datastax.github.io/cpp-driver/api/struct.CassSession#cass-session-get-schema-meta
+[`cass_session_get_schema_meta()`]: https://cpp-rust-driver.docs.scylladb.com/stable/api/struct.CassSession#cass-session-get-schema-meta

Original file line number	Diff line number	Diff line change
`@@ -187,8 +187,9 @@ def setup(sphinx):`
`187`	`187`	`)`
`188`	`188`
`189`	`189`	`# Workaround to replace DataStax links`
	`190`	`+ # FIXME(David Garcia) - Make this workaround work correctly.`
`190`	`191`	`replacements = [`
`191`		`- {"http://datastax.github.io/cpp-driver/api/cassandra.h/": "https://cpp-rust-driver.docs.scylladb.com/" + smv_latest_version + "/api"},`
	`192`	`+ {"https://cpp-rust-driver.docs.scylladb.com/stable/api/cassandra.h/": "https://cpp-rust-driver.docs.scylladb.com/" + smv_latest_version + "/api"},`
`192`	`193`	`{"http://datastax.github.io/cpp-driver": "https://cpp-rust-driver.docs.scylladb.com/" + smv_latest_version},`
`193`	`194`	`{"http://docs.datastax.com/en/developer/cpp-driver/latest": "https://cpp-rust-driver.docs.scylladb.com/" + smv_latest_version},`
`194`	`195`	`]`