all: Rename 'copy_threshold' to 'rebuild_threshold'

Author: lutter

docs/environment-variables.md

@@ -227,14 +227,14 @@ those.
   1.1 means that the subgraph will be pruned every time it contains 10%
   more history (in blocks) than its history limit. The default value is 1.2
   and the value must be at least 1.01
-- `GRAPH_STORE_HISTORY_COPY_THRESHOLD`,
-  `GRAPH_STORE_HISTORY_DELETE_THRESHOLD`: when pruning, prune by copying the
-  entities we will keep to new tables if we estimate that we will remove
-  more than a factor of `COPY_THRESHOLD` of the deployment's history. If we
-  estimate to remove a factor between `COPY_THRESHOLD` and
-  `DELETE_THRESHOLD`, prune by deleting from the existing tables of the
+- `GRAPH_STORE_HISTORY_REBUILD_THRESHOLD`,
+  `GRAPH_STORE_HISTORY_DELETE_THRESHOLD`: when pruning, prune by copying
+  the entities we will keep to new tables if we estimate that we will
+  remove more than a factor of `REBUILD_THRESHOLD` of the deployment's
+  history. If we estimate to remove a factor between `REBUILD_THRESHOLD`
+  and `DELETE_THRESHOLD`, prune by deleting from the existing tables of the
   deployment. If we estimate to remove less than `DELETE_THRESHOLD`
   entities, do not change the table. Both settings are floats, and default
-  to 0.5 for the `COPY_THRESHOLD` and 0.05 for the `DELETE_THRESHOLD`; they
-  must be between 0 and 1, and `COPY_THRESHOLD` must be bigger than
+  to 0.5 for the `REBUILD_THRESHOLD` and 0.05 for the `DELETE_THRESHOLD`;
+  they must be between 0 and 1, and `REBUILD_THRESHOLD` must be bigger than
   `DELETE_THRESHOLD`.

graph/src/components/store/mod.rs

@@ -1270,12 +1270,12 @@ pub struct PruneRequest {
     pub final_block: BlockNumber,
     /// The latest block, i.e., the subgraph head
     pub latest_block: BlockNumber,
-    /// Use the copy strategy when removing more than this fraction of
-    /// history. Initialized from `ENV_VARS.store.copy_threshold`, but can
-    /// be modified after construction
-    pub copy_threshold: f64,
+    /// Use the rebuild strategy when removing more than this fraction of
+    /// history. Initialized from `ENV_VARS.store.rebuild_threshold`, but
+    /// can be modified after construction
+    pub rebuild_threshold: f64,
     /// Use the delete strategy when removing more than this fraction of
-    /// history but less than `copy_threshold`. Initialized from
+    /// history but less than `rebuild_threshold`. Initialized from
     /// `ENV_VARS.store.delete_threshold`, but can be modified after
     /// construction
     pub delete_threshold: f64,
@@ -1293,11 +1293,11 @@ impl PruneRequest {
         first_block: BlockNumber,
         latest_block: BlockNumber,
     ) -> Result<Self, StoreError> {
-        let copy_threshold = ENV_VARS.store.copy_threshold;
+        let rebuild_threshold = ENV_VARS.store.rebuild_threshold;
         let delete_threshold = ENV_VARS.store.delete_threshold;
-        if copy_threshold < 0.0 || copy_threshold > 1.0 {
+        if rebuild_threshold < 0.0 || rebuild_threshold > 1.0 {
             return Err(constraint_violation!(
-                "the copy threshold must be between 0 and 1 but is {copy_threshold}"
+                "the copy threshold must be between 0 and 1 but is {rebuild_threshold}"
             ));
         }
         if delete_threshold < 0.0 || delete_threshold > 1.0 {
@@ -1331,19 +1331,20 @@ impl PruneRequest {
             earliest_block,
             final_block,
             latest_block,
-            copy_threshold,
+            rebuild_threshold,
             delete_threshold,
         })
     }
 
     /// Determine what strategy to use for pruning
     ///
-    /// We are pruning `history_pct` of the blocks from a table that has a ratio
-    /// of `version_ratio` entities to versions. If we are removing more than
-    /// `copy_threshold` percent of the versions, we prune by copying, and if we
-    /// are removing more than `delete_threshold` percent of the versions, we
-    /// prune by deleting. If we would remove less than `delete_threshold`
-    /// percent of the versions, we don't prune.
+    /// We are pruning `history_pct` of the blocks from a table that has a
+    /// ratio of `version_ratio` entities to versions. If we are removing
+    /// more than `rebuild_threshold` percent of the versions, we prune by
+    /// rebuilding, and if we are removing more than `delete_threshold`
+    /// percent of the versions, we prune by deleting. If we would remove
+    /// less than `delete_threshold` percent of the versions, we don't
+    /// prune.
     pub fn strategy(&self, stats: &VersionStats) -> Option<PruningStrategy> {
         // If the deployment doesn't have enough history to cover the reorg
         // threshold, do not prune
@@ -1356,7 +1357,7 @@ impl PruneRequest {
         // that `history_pct` will tell us how much of that data pruning
         // will remove.
         let removal_ratio = self.history_pct(stats) * (1.0 - stats.ratio);
-        if removal_ratio >= self.copy_threshold {
+        if removal_ratio >= self.rebuild_threshold {
             Some(PruningStrategy::Rebuild)
         } else if removal_ratio >= self.delete_threshold {
             Some(PruningStrategy::Delete)

graph/src/env/store.rs

@@ -85,11 +85,11 @@ pub struct EnvVarsStore {
     pub batch_target_duration: Duration,
 
     /// Prune tables where we will remove at least this fraction of entity
-    /// versions by copying. Set by `GRAPH_STORE_HISTORY_COPY_THRESHOLD`.
-    /// The default is 0.5
-    pub copy_threshold: f64,
+    /// versions by rebuilding the table. Set by
+    /// `GRAPH_STORE_HISTORY_REBUILD_THRESHOLD`. The default is 0.5
+    pub rebuild_threshold: f64,
     /// Prune tables where we will remove at least this fraction of entity
-    /// versions, but fewer than `copy_threshold`, by deleting. Set by
+    /// versions, but fewer than `rebuild_threshold`, by deleting. Set by
     /// `GRAPH_STORE_HISTORY_DELETE_THRESHOLD`. The default is 0.05
     pub delete_threshold: f64,
     /// How much history a subgraph with limited history can accumulate
@@ -134,7 +134,7 @@ impl From<InnerStore> for EnvVarsStore {
             connection_idle_timeout: Duration::from_secs(x.connection_idle_timeout_in_secs),
             write_queue_size: x.write_queue_size,
             batch_target_duration: Duration::from_secs(x.batch_target_duration_in_secs),
-            copy_threshold: x.copy_threshold.0,
+            rebuild_threshold: x.rebuild_threshold.0,
             delete_threshold: x.delete_threshold.0,
             history_slack_factor: x.history_slack_factor.0,
         }
@@ -180,8 +180,8 @@ pub struct InnerStore {
     write_queue_size: usize,
     #[envconfig(from = "GRAPH_STORE_BATCH_TARGET_DURATION", default = "180")]
     batch_target_duration_in_secs: u64,
-    #[envconfig(from = "GRAPH_STORE_HISTORY_COPY_THRESHOLD", default = "0.5")]
-    copy_threshold: ZeroToOneF64,
+    #[envconfig(from = "GRAPH_STORE_HISTORY_REBUILD_THRESHOLD", default = "0.5")]
+    rebuild_threshold: ZeroToOneF64,
     #[envconfig(from = "GRAPH_STORE_HISTORY_DELETE_THRESHOLD", default = "0.05")]
     delete_threshold: ZeroToOneF64,
     #[envconfig(from = "GRAPH_STORE_HISTORY_SLACK_FACTOR", default = "1.2")]

node/src/bin/manager.rs

@@ -253,12 +253,12 @@ pub enum Command {
     Prune {
         /// The deployment to prune (see `help info`)
         deployment: DeploymentSearch,
-        /// Prune by copying when removing more than this fraction of
-        /// history. Defaults to GRAPH_STORE_HISTORY_COPY_THRESHOLD
+        /// Prune by rebuilding tables when removing more than this fraction
+        /// of history. Defaults to GRAPH_STORE_HISTORY_REBUILD_THRESHOLD
         #[clap(long, short)]
-        copy_threshold: Option<f64>,
+        rebuild_threshold: Option<f64>,
         /// Prune by deleting when removing more than this fraction of
-        /// history but less than copy_threshold. Defaults to
+        /// history but less than rebuild_threshold. Defaults to
         /// GRAPH_STORE_HISTORY_DELETE_THRESHOLD
         #[clap(long, short)]
         delete_threshold: Option<f64>,
@@ -1390,7 +1390,7 @@ async fn main() -> anyhow::Result<()> {
         Prune {
             deployment,
             history,
-            copy_threshold,
+            rebuild_threshold,
             delete_threshold,
             once,
         } => {
@@ -1400,7 +1400,7 @@ async fn main() -> anyhow::Result<()> {
                 primary_pool,
                 deployment,
                 history,
-                copy_threshold,
+                rebuild_threshold,
                 delete_threshold,
                 once,
             )

node/src/manager/commands/prune.rs

@@ -161,7 +161,7 @@ pub async fn run(
     primary_pool: ConnectionPool,
     search: DeploymentSearch,
     history: usize,
-    copy_threshold: Option<f64>,
+    rebuild_threshold: Option<f64>,
     delete_threshold: Option<f64>,
     once: bool,
 ) -> Result<(), anyhow::Error> {
@@ -198,8 +198,8 @@ pub async fn run(
         status.earliest_block_number,
         latest,
     )?;
-    if let Some(copy_threshold) = copy_threshold {
-        req.copy_threshold = copy_threshold;
+    if let Some(rebuild_threshold) = rebuild_threshold {
+        req.rebuild_threshold = rebuild_threshold;
     }
     if let Some(delete_threshold) = delete_threshold {
         req.delete_threshold = delete_threshold;

store/postgres/tests/graft.rs

@@ -613,11 +613,11 @@ fn prune() {
             // Change the thresholds so that we select the desired strategy
             match strategy {
                 PruningStrategy::Rebuild => {
-                    req.copy_threshold = 0.0;
+                    req.rebuild_threshold = 0.0;
                     req.delete_threshold = 0.0;
                 }
                 PruningStrategy::Delete => {
-                    req.copy_threshold = 1.0;
+                    req.rebuild_threshold = 1.0;
                     req.delete_threshold = 0.0;
                 }
             }