Merge pull request #1385 from wprzytula/statements-unset-consistency

statements: expose API to unset (serial) consistency

Author: wprzytula

scylla/src/cluster/control_connection.rs

@@ -18,21 +18,21 @@ use crate::statement::Statement;
 pub(super) struct ControlConnection {
     conn: Arc<Connection>,
     /// The custom server-side timeout set for requests executed on the control connection.
-    overriden_serverside_timeout: Option<Duration>,
+    overridden_serverside_timeout: Option<Duration>,
 }
 
 impl ControlConnection {
     pub(super) fn new(conn: Arc<Connection>) -> Self {
         Self {
             conn,
-            overriden_serverside_timeout: None,
+            overridden_serverside_timeout: None,
         }
     }
 
     /// Sets the custom server-side timeout set for requests executed on the control connection.
-    pub(super) fn override_serverside_timeout(self, overriden_timeout: Option<Duration>) -> Self {
+    pub(super) fn override_serverside_timeout(self, overridden_timeout: Option<Duration>) -> Self {
         Self {
-            overriden_serverside_timeout: overriden_timeout,
+            overridden_serverside_timeout: overridden_timeout,
             ..self
         }
     }
@@ -49,7 +49,7 @@ impl ControlConnection {
     /// Appends the custom server-side timeout to the statement string, if such custom timeout
     /// is provided and we are connected to ScyllaDB (since custom timeouts is ScyllaDB-only feature).
     fn maybe_append_timeout_override(&self, statement: &mut Statement) {
-        if let Some(timeout) = self.overriden_serverside_timeout {
+        if let Some(timeout) = self.overridden_serverside_timeout {
             if self.is_to_scylladb() {
                 // SAFETY: io::fmt::Write impl for String is infallible.
                 write!(

scylla/src/statement/batch.rs

@@ -67,6 +67,13 @@ impl Batch {
         self.config.consistency = Some(c);
     }
 
+    /// Unsets the consistency overridden on this batch.
+    /// This means that consistency will be derived from the execution profile
+    /// (per-batch or, if absent, the default one).
+    pub fn unset_consistency(&mut self) {
+        self.config.consistency = None;
+    }
+
     /// Gets the consistency to be used when executing this batch if it is filled.
     /// If this is empty, the default_consistency of the session will be used.
     pub fn get_consistency(&self) -> Option<Consistency> {
@@ -79,6 +86,13 @@ impl Batch {
         self.config.serial_consistency = Some(sc);
     }
 
+    /// Unsets the serial consistency overridden on this batch.
+    /// This means that serial consistency will be derived from the execution profile
+    /// (per-batch or, if absent, the default one).
+    pub fn unset_serial_consistency(&mut self) {
+        self.config.serial_consistency = None;
+    }
+
     /// Gets the serial consistency to be used when executing this batch.
     /// (Ignored unless the batch is an LWT)
     pub fn get_serial_consistency(&self) -> Option<SerialConsistency> {
@@ -131,7 +145,7 @@ impl Batch {
 
     /// Get the retry policy set for the batch.
     ///
-    /// This method returns the retry policy that is **overriden** on this statement.
+    /// This method returns the retry policy that is **overridden** on this statement.
     /// In other words, it returns the retry policy set using [`Batch::set_retry_policy`].
     /// This does not take the retry policy from the set execution profile into account.
     #[inline]
@@ -150,7 +164,7 @@ impl Batch {
 
     /// Get the load balancing policy set for the batch.
     ///
-    /// This method returns the load balancing policy that is **overriden** on this statement.
+    /// This method returns the load balancing policy that is **overridden** on this statement.
     /// In other words, it returns the load balancing policy set using [`Batch::set_load_balancing_policy`].
     /// This does not take the load balancing policy from the set execution profile into account.
     #[inline]

scylla/src/statement/prepared.rs

@@ -298,6 +298,13 @@ impl PreparedStatement {
         self.config.consistency = Some(c);
     }
 
+    /// Unsets the consistency overridden on this statement.
+    /// This means that consistency will be derived from the execution profile
+    /// (per-statement or, if absent, the default one).
+    pub fn unset_consistency(&mut self) {
+        self.config.consistency = None;
+    }
+
     /// Gets the consistency to be used when executing this prepared statement if it is filled.
     /// If this is empty, the default_consistency of the session will be used.
     pub fn get_consistency(&self) -> Option<Consistency> {
@@ -310,6 +317,13 @@ impl PreparedStatement {
         self.config.serial_consistency = Some(sc);
     }
 
+    /// Unsets the serial consistency overridden on this statement.
+    /// This means that serial consistency will be derived from the execution profile
+    /// (per-statement or, if absent, the default one).
+    pub fn unset_serial_consistency(&mut self) {
+        self.config.serial_consistency = None;
+    }
+
     /// Gets the serial consistency to be used when executing this statement.
     /// (Ignored unless the statement is an LWT)
     pub fn get_serial_consistency(&self) -> Option<SerialConsistency> {
@@ -432,7 +446,7 @@ impl PreparedStatement {
 
     /// Get the retry policy set for the statement.
     ///
-    /// This method returns the retry policy that is **overriden** on this statement.
+    /// This method returns the retry policy that is **overridden** on this statement.
     /// In other words, it returns the retry policy set using [`PreparedStatement::set_retry_policy`].
     /// This does not take the retry policy from the set execution profile into account.
     #[inline]
@@ -451,7 +465,7 @@ impl PreparedStatement {
 
     /// Get the load balancing policy set for the statement.
     ///
-    /// This method returns the load balancing policy that is **overriden** on this statement.
+    /// This method returns the load balancing policy that is **overridden** on this statement.
     /// In other words, it returns the load balancing policy set using [`PreparedStatement::set_load_balancing_policy`].
     /// This does not take the load balancing policy from the set execution profile into account.
     #[inline]

scylla/src/statement/unprepared.rs

@@ -60,6 +60,13 @@ impl Statement {
         self.config.consistency = Some(c);
     }
 
+    /// Unsets the consistency overridden on this statement.
+    /// This means that consistency will be derived from the execution profile
+    /// (per-statement or, if absent, the default one).
+    pub fn unset_consistency(&mut self) {
+        self.config.consistency = None;
+    }
+
     /// Gets the consistency to be used when executing this statement if it is filled.
     /// If this is empty, the default_consistency of the session will be used.
     pub fn get_consistency(&self) -> Option<Consistency> {
@@ -72,6 +79,13 @@ impl Statement {
         self.config.serial_consistency = Some(sc);
     }
 
+    /// Unsets the serial consistency overridden on this statement.
+    /// This means that serial consistency will be derived from the execution profile
+    /// (per-statement or, if absent, the default one).
+    pub fn unset_serial_consistency(&mut self) {
+        self.config.serial_consistency = None;
+    }
+
     /// Gets the serial consistency to be used when executing this statement.
     /// (Ignored unless the statement is an LWT)
     pub fn get_serial_consistency(&self) -> Option<SerialConsistency> {
@@ -138,7 +152,7 @@ impl Statement {
 
     /// Get the retry policy set for the statement.
     ///
-    /// This method returns the retry policy that is **overriden** on this statement.
+    /// This method returns the retry policy that is **overridden** on this statement.
     /// In other words, it returns the retry policy set using [`Statement::set_retry_policy`].
     /// This does not take the retry policy from the set execution profile into account.
     #[inline]
@@ -157,7 +171,7 @@ impl Statement {
 
     /// Get the load balancing policy set for the statement.
     ///
-    /// This method returns the load balancing policy that is **overriden** on this statement.
+    /// This method returns the load balancing policy that is **overridden** on this statement.
     /// In other words, it returns the load balancing policy set using [`Statement::set_load_balancing_policy`].
     /// This does not take the load balancing policy from the set execution profile into account.
     #[inline]