From 0d9a83fd4db8db479f31aaae520b63673944f917 Mon Sep 17 00:00:00 2001 From: Peter Chen Date: Wed, 20 Aug 2025 12:29:01 -0400 Subject: [PATCH] fix comments --- docs/config-description.md | 6 +++--- src/data/cassandra/impl/Cluster.cpp | 6 ++++-- src/util/config/ConfigConstraints.hpp | 2 +- src/util/config/ConfigDefinition.cpp | 2 +- src/util/config/ConfigDescription.hpp | 2 +- tests/integration/data/BackendFactoryTests.cpp | 2 +- tests/integration/data/cassandra/BackendTests.cpp | 2 +- tests/unit/data/cassandra/SettingsProviderTests.cpp | 2 +- 8 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/config-description.md b/docs/config-description.md index 26d7d6e9..5e73859c 100644 --- a/docs/config-description.md +++ b/docs/config-description.md @@ -91,9 +91,9 @@ This document provides a list of all available Clio configuration properties in - **Required**: True - **Type**: string -- **Default value**: `scylladb` -- **Constraints**: The value must be one of the following: `scylladb`, `aws_keyspace`. -- **Description**: The specific database backend provider we are using. Currently we only support scylladb, or aws_keyspace. +- **Default value**: `cassandra` +- **Constraints**: The value must be one of the following: `cassandra`, `aws_keyspace`. +- **Description**: The specific database backend provider we are using. Currently we only support cassandra, or aws_keyspace. ### database.cassandra.core_connections_per_host diff --git a/src/data/cassandra/impl/Cluster.cpp b/src/data/cassandra/impl/Cluster.cpp index d3faeab0..cbdd22ab 100644 --- a/src/data/cassandra/impl/Cluster.cpp +++ b/src/data/cassandra/impl/Cluster.cpp @@ -61,8 +61,10 @@ Cluster::Cluster(Settings const& settings) : ManagedObject{cass_cluster_new(), k cass_cluster_set_request_timeout(*this, settings.requestTimeout.count()); // TODO: AWS keyspace reads should be local_one to save cost - if (auto const rc = cass_cluster_set_consistency(*this, CASS_CONSISTENCY_LOCAL_QUORUM); rc != CASS_OK) { - throw std::runtime_error(fmt::format("Error setting cassandra consistency: {}", cass_error_desc(rc))); + if (settings.provider == "aws_keyspace") { + if (auto const rc = cass_cluster_set_consistency(*this, CASS_CONSISTENCY_LOCAL_QUORUM); rc != CASS_OK) { + throw std::runtime_error(fmt::format("Error setting cassandra consistency: {}", cass_error_desc(rc))); + } } if (auto const rc = cass_cluster_set_core_connections_per_host(*this, settings.coreConnectionsPerHost); diff --git a/src/util/config/ConfigConstraints.hpp b/src/util/config/ConfigConstraints.hpp index 5cbb40fd..3ee89ee9 100644 --- a/src/util/config/ConfigConstraints.hpp +++ b/src/util/config/ConfigConstraints.hpp @@ -87,7 +87,7 @@ static constexpr std::array kPROCESSING_POLICY = {"parallel", "s /** * @brief specific values that are accepted for database provider in config. */ -static constexpr std::array kPROVIDER = {"scylladb", "aws_keyspace"}; +static constexpr std::array kPROVIDER = {"cassandra", "aws_keyspace"}; /** * @brief An interface to enforce constraints on certain values within ClioConfigDefinition. diff --git a/src/util/config/ConfigDefinition.cpp b/src/util/config/ConfigDefinition.cpp index 97f1ccc9..3b7ef1cf 100644 --- a/src/util/config/ConfigDefinition.cpp +++ b/src/util/config/ConfigDefinition.cpp @@ -280,7 +280,7 @@ getClioConfig() {"database.cassandra.password", ConfigValue{ConfigType::String}.optional()}, {"database.cassandra.certfile", ConfigValue{ConfigType::String}.optional()}, {"database.cassandra.provider", - ConfigValue{ConfigType::String}.defaultValue("scylladb").withConstraint(gValidateProvider)}, + ConfigValue{ConfigType::String}.defaultValue("cassandra").withConstraint(gValidateProvider)}, {"allow_no_etl", ConfigValue{ConfigType::Boolean}.defaultValue(false)}, {"__ng_etl", ConfigValue{ConfigType::Boolean}.defaultValue(false)}, diff --git a/src/util/config/ConfigDescription.hpp b/src/util/config/ConfigDescription.hpp index 020d44fa..b8fe40f0 100644 --- a/src/util/config/ConfigDescription.hpp +++ b/src/util/config/ConfigDescription.hpp @@ -167,7 +167,7 @@ private: KV{.key = "database.cassandra.threads", .value = "Represents the number of threads that will be used for database operations."}, KV{.key = "database.cassandra.provider", - .value = "The specific database backend provider we are using. Currently we only support scylladb, or " + .value = "The specific database backend provider we are using. Currently we only support cassandra, or " "aws_keyspace."}, KV{.key = "database.cassandra.core_connections_per_host", .value = "The number of core connections per host for the Cassandra database."}, diff --git a/tests/integration/data/BackendFactoryTests.cpp b/tests/integration/data/BackendFactoryTests.cpp index cfe2371a..46acd60b 100644 --- a/tests/integration/data/BackendFactoryTests.cpp +++ b/tests/integration/data/BackendFactoryTests.cpp @@ -53,7 +53,7 @@ protected: {"database.cassandra.secure_connect_bundle", ConfigValue{ConfigType::String}.optional()}, {"database.cassandra.port", ConfigValue{ConfigType::Integer}.optional()}, {"database.cassandra.keyspace", ConfigValue{ConfigType::String}.defaultValue(kKEYSPACE)}, - {"database.cassandra.provider", ConfigValue{ConfigType::String}.defaultValue("scylladb")}, + {"database.cassandra.provider", ConfigValue{ConfigType::String}.defaultValue("cassandra")}, {"database.cassandra.replication_factor", ConfigValue{ConfigType::Integer}.defaultValue(1)}, {"database.cassandra.table_prefix", ConfigValue{ConfigType::String}.optional()}, {"database.cassandra.max_write_requests_outstanding", ConfigValue{ConfigType::Integer}.defaultValue(10'000)}, diff --git a/tests/integration/data/cassandra/BackendTests.cpp b/tests/integration/data/cassandra/BackendTests.cpp index 1cf916b6..3e5a6ac6 100644 --- a/tests/integration/data/cassandra/BackendTests.cpp +++ b/tests/integration/data/cassandra/BackendTests.cpp @@ -93,7 +93,7 @@ protected: {"database.cassandra.port", ConfigValue{ConfigType::Integer}.optional()}, {"database.cassandra.keyspace", ConfigValue{ConfigType::String}.defaultValue(TestGlobals::instance().backendKeyspace)}, - {"database.cassandra.provider", ConfigValue{ConfigType::String}.defaultValue("scylladb")}, + {"database.cassandra.provider", ConfigValue{ConfigType::String}.defaultValue("cassandra")}, {"database.cassandra.replication_factor", ConfigValue{ConfigType::Integer}.defaultValue(1)}, {"database.cassandra.table_prefix", ConfigValue{ConfigType::String}.optional()}, {"database.cassandra.max_write_requests_outstanding", ConfigValue{ConfigType::Integer}.defaultValue(10'000)}, diff --git a/tests/unit/data/cassandra/SettingsProviderTests.cpp b/tests/unit/data/cassandra/SettingsProviderTests.cpp index 04f142b3..fa6c6d86 100644 --- a/tests/unit/data/cassandra/SettingsProviderTests.cpp +++ b/tests/unit/data/cassandra/SettingsProviderTests.cpp @@ -59,7 +59,7 @@ getParseSettingsConfig(boost::json::value val) {"database.cassandra.certificate", ConfigValue{ConfigType::String}.optional()}, {"database.cassandra.username", ConfigValue{ConfigType::String}.optional()}, {"database.cassandra.password", ConfigValue{ConfigType::String}.optional()}, - {"database.cassandra.provider", ConfigValue{ConfigType::String}.defaultValue("scylladb")}, + {"database.cassandra.provider", ConfigValue{ConfigType::String}.defaultValue("cassandra")}, {"database.cassandra.queue_size_io", ConfigValue{ConfigType::Integer}.optional()}, {"database.cassandra.write_batch_size", ConfigValue{ConfigType::Integer}.defaultValue(20)}, {"database.cassandra.connect_timeout", ConfigValue{ConfigType::Integer}.optional()},