rename bounds to auto-bounds

maplibre · Oct 22, 2023 · b938430 · b938430
1 parent e3151b9
commit b938430
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 17 deletions.
diff --git a/debian/config.yaml b/debian/config.yaml
@@ -14,7 +14,7 @@ worker_processes: 8
 #   default_srid: 4326
 #   pool_size: 20
 #   max_feature_count: 1000
-#   bounds: skip
+#   auto_bounds: skip
 
 # pmtiles:
 #   paths:

diff --git a/docs/src/config-file.md b/docs/src/config-file.md
@@ -51,7 +51,7 @@ postgres:
   # 'calc' - compute table geometry bounds on startup.
   # 'quick' - same as 'calc', but the calculation will be aborted if it takes more than 5 seconds.
   # 'skip' - do not compute table geometry bounds on startup.
-  bounds: skip
+  auto_bounds: skip
 
   # Enable automatic discovery of tables and functions.
   # You may set this to `false` to disable.

diff --git a/docs/src/run-with-cli.md b/docs/src/run-with-cli.md
@@ -28,7 +28,7 @@ Options:
   -W, --workers <WORKERS>
           Number of web server workers
 
-  -b, --bounds <BOUNDS>
+  -b, --auto-bounds <BOUNDS>
           Specify how bounds should be computed for the spatial PG tables. [DEFAULT: quick]
 
           Possible values:

diff --git a/martin/src/args/pg.rs b/martin/src/args/pg.rs
@@ -30,7 +30,7 @@ pub enum BoundsCalcType {
 pub struct PgArgs {
     /// Specify how bounds should be computed for the spatial PG tables. [DEFAULT: quick]
     #[arg(short = 'b', long)]
-    pub bounds: Option<BoundsCalcType>,
+    pub auto_bounds: Option<BoundsCalcType>,
     /// Loads trusted root certificates from a file. The file should contain a sequence of PEM-formatted CA certificates.
     #[arg(long)]
     pub ca_root_file: Option<std::path::PathBuf>,
@@ -60,7 +60,7 @@ impl PgArgs {
                 connection_string: Some(s),
                 ssl_certificates: certs.clone(),
                 default_srid,
-                bounds: self.bounds,
+                auto_bounds: self.auto_bounds,
                 max_feature_count: self.max_feature_count,
                 pool_size: self.pool_size,
                 auto_publish: OptBoolObj::NoValue,

diff --git a/martin/src/pg/config.rs b/martin/src/pg/config.rs
@@ -44,7 +44,7 @@ pub struct PgConfig {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub default_srid: Option<i32>,
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub bounds: Option<BoundsCalcType>,
+    pub auto_bounds: Option<BoundsCalcType>,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub max_feature_count: Option<usize>,
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -130,8 +130,8 @@ impl PgConfig {
             // warn only if default bounds timeout has already passed
             DEFAULT_BOUNDS_TIMEOUT.add(Duration::from_secs(1)),
             || {
-                if pg.bounds() == BoundsCalcType::Skip {
-                    warn!("Discovering tables in PostgreSQL database '{}' is taking too long. Make sure your table geo columns have a GIS index, or use '--bounds skip' CLI/config to skip bbox calculation.", pg.get_id());
+                if pg.auto_bounds() == BoundsCalcType::Skip {
+                    warn!("Discovering tables in PostgreSQL database '{}' is taking too long. Make sure your table geo columns have a GIS index, or use '--auto-bounds skip' CLI/config to skip bbox calculation.", pg.get_id());
                 } else {
                     warn!("Discovering tables in PostgreSQL database '{}' is taking too long. Bounds calculation is already disabled. You may need to tune your database.", pg.get_id());
                 }

diff --git a/martin/src/pg/configurator.rs b/martin/src/pg/configurator.rs
@@ -60,7 +60,7 @@ pub struct PgBuilderTables {
 pub struct PgBuilder {
     pool: PgPool,
     default_srid: Option<i32>,
-    bounds: BoundsCalcType,
+    auto_bounds: BoundsCalcType,
     max_feature_count: Option<usize>,
     auto_functions: Option<PgBuilderFuncs>,
     auto_tables: Option<PgBuilderTables>,
@@ -98,7 +98,7 @@ impl PgBuilder {
         Ok(Self {
             pool,
             default_srid: config.default_srid,
-            bounds: config.bounds.unwrap_or_default(),
+            auto_bounds: config.auto_bounds.unwrap_or_default(),
             max_feature_count: config.max_feature_count,
             id_resolver,
             tables: config.tables.clone().unwrap_or_default(),
@@ -108,8 +108,8 @@ impl PgBuilder {
         })
     }
 
-    pub fn bounds(&self) -> BoundsCalcType {
-        self.bounds
+    pub fn auto_bounds(&self) -> BoundsCalcType {
+        self.auto_bounds
     }
 
     pub fn get_id(&self) -> &str {
@@ -161,7 +161,7 @@ impl PgBuilder {
                 id2,
                 merged_inf,
                 self.pool.clone(),
-                self.bounds,
+                self.auto_bounds,
                 self.max_feature_count,
             ));
         }
@@ -207,7 +207,7 @@ impl PgBuilder {
                             id2,
                             db_inf,
                             self.pool.clone(),
-                            self.bounds,
+                            self.auto_bounds,
                             self.max_feature_count,
                         ));
                     }

diff --git a/martin/src/pg/table_source.rs b/martin/src/pg/table_source.rs
@@ -120,7 +120,7 @@ pub async fn table_to_query(
                         info.bounds = bounds?;
                     } else {
                         warn!(
-                            "Timeout computing {} bounds for {id}, aborting query. Use --bounds=calc to wait until complete, or check the table for missing indices.",
+                            "Timeout computing {} bounds for {id}, aborting query. Use --auto-bounds=calc to wait until complete, or check the table for missing indices.",
                             info.format_id(),
                         );
                     }

diff --git a/tests/expected/generated_config.yaml b/tests/expected/generated_config.yaml
@@ -1,7 +1,7 @@
 listen_addresses: localhost:3111
 postgres:
   default_srid: 900913
-  bounds: calc
+  auto_bounds: calc
   auto_publish: true
   tables:
     MixPoints:

diff --git a/tests/test.sh b/tests/test.sh
@@ -153,7 +153,7 @@ echo "Test auto configured Martin"
 TEST_OUT_DIR="$(dirname "$0")/output/auto"
 mkdir -p "$TEST_OUT_DIR"
 
-ARG=(--default-srid 900913 --bounds calc --save-config "$(dirname "$0")/output/generated_config.yaml" tests/fixtures/mbtiles tests/fixtures/pmtiles)
+ARG=(--default-srid 900913 --auto-bounds calc --save-config "$(dirname "$0")/output/generated_config.yaml" tests/fixtures/mbtiles tests/fixtures/pmtiles)
 set -x
 $MARTIN_BIN "${ARG[@]}" 2>&1 | tee "${TMP_DIR}/test_log_1.txt" &
 PROCESS_ID=`jobs -p`