mbtiles summary tool cleanup (#1000)

After some thinking, it seems `mbtiles summary` (aliased as `mbtiles info`) would be a bit better than stats. I renamed and adjusted documentation, consolidating it in one doc page. Other changes: * use file system's file size, reporting 'unknown' if needed * report page count * moved bbox computation into a separate function * inlined a number of things for readability
maplibre · Nov 13, 2023 · 021cddc · 021cddc
1 parent 0398336
commit 021cddc
Show file tree

Hide file tree

Showing 10 changed files with 203 additions and 135 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/docs/src/51-mbtiles-meta.md b/docs/src/51-mbtiles-meta.md
@@ -1,4 +1,24 @@
-# `mbtiles` Metadata Access
+# MBTiles information and metadata
+
+## summary
+Use `mbtiles summary` to get a summary of the contents of an MBTiles file. The command will print a table with the number of tiles per zoom level, the size of the smallest and largest tiles, and the average size of tiles at each zoom level. The command will also print the bounding box of the covered area per zoom level.
+
+```shell
+File: tests/fixtures/mbtiles/world_cities.mbtiles
+Schema: flat
+File size: 48.00KiB
+Page size: 4.00KiB
+Page count: 12
+|  Zoom   |  Count  |Smallest | Largest | Average |  BBox   |
+|        0|        1|  1.08KiB|  1.08KiB|  1.08KiB|-179.99999997494382,-85.05112877764508,180.00000015460688,85.05112879314403|
+|        1|        4|     160B|     650B|     366B|-179.99999997494382,-85.05112877764508,180.00000015460688,85.05112879314403|
+|        2|        7|     137B|     495B|     239B|-179.99999997494382,-66.51326042021836,180.00000015460688,66.51326049182072|
+|        3|       17|      67B|     246B|     134B|-134.99999995874995,-40.9798980140281,180.00000015460688,66.51326049182072|
+|        4|       38|      64B|     175B|      86B|-134.99999995874995,-40.9798980140281,180.00000015460688,66.51326049182072|
+|        5|       57|      64B|     107B|      72B|-123.74999995470151,-40.9798980140281,180.00000015460688,61.60639642757953|
+|        6|       72|      64B|      97B|      68B|-123.74999995470151,-40.9798980140281,180.00000015460688,61.60639642757953|
+|      all|      196|      64B|   1.0KiB|      96B|
+```
 
 ## meta-all
 Print all metadata values to stdout, as well as the results of tile detection. The format of the values printed is not stable, and should only be used for visual inspection.

diff --git a/docs/src/55-mbtiles-stats.md b/docs/src/55-mbtiles-stats.md
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -22,9 +22,8 @@
   - [Using with Mapbox](44-using-with-mapbox.md)
   - [Recipes](45-recipes.md)
 - [Tools](50-tools.md)
-  - [MBTiles Metadata](51-mbtiles-meta.md)
+  - [MBTiles Info and Metadata](51-mbtiles-meta.md)
   - [MBTiles Copying / Diffing](52-mbtiles-copy.md)
   - [MBTiles Validation](53-mbtiles-validation.md)
   - [MBTiles Schemas](54-mbtiles-schema.md)
-  - [MBTiles statistics](55-mbtiles-stats.md)
 - [Development](60-development.md)
diff --git a/...4c2714b57d964b06c0b06d4e44076773b37c.json → ...29d96dd1288005f47872c6a79b5bbf1ca8de.json b/...4c2714b57d964b06c0b06d4e44076773b37c.json → ...29d96dd1288005f47872c6a79b5bbf1ca8de.json
diff --git a/mbtiles/src/bin/main.rs b/mbtiles/src/bin/main.rs
@@ -20,15 +20,15 @@ pub struct Args {
 
 #[derive(Subcommand, PartialEq, Eq, Debug)]
 enum Commands {
+    /// Show MBTiels file summary statistics
+    #[command(name = "summary", alias = "info")]
+    Summary { file: PathBuf },
     /// Prints all values in the metadata table in a free-style, unstable YAML format
     #[command(name = "meta-all")]
     MetaAll {
         /// MBTiles file to read from
         file: PathBuf,
     },
-    /// Gets tile statistics from MBTiels file
-    #[command(name = "stats")]
-    Stats { file: PathBuf },
     /// Gets a single value from the MBTiles metadata table.
     #[command(name = "meta-get")]
     MetaGetValue {
@@ -117,12 +117,10 @@ async fn main_int() -> anyhow::Result<()> {
             let mbt = Mbtiles::new(file.as_path())?;
             mbt.validate(integrity_check, update_agg_tiles_hash).await?;
         }
-        Commands::Stats { file } => {
+        Commands::Summary { file } => {
             let mbt = Mbtiles::new(file.as_path())?;
             let mut conn = mbt.open_readonly().await?;
-
-            let statistics = mbt.statistics(&mut conn).await?;
-            println!("{statistics}");
+            println!("{}", mbt.summary(&mut conn).await?);
         }
     }