Add tile statistics to mbtiles

Cargo.toml

@@ -16,6 +16,7 @@ actix-http = "3"
 actix-rt = "2"
 actix-web = "4"
 anyhow = "1.0"
+approx = "0.5.1"
 async-trait = "0.1"
 bit-set = "0.5.3"
 brotli = "3"
@@ -49,6 +50,7 @@ rustls-native-certs = "0.6"
 rustls-pemfile = "1"
 semver = "1"
 serde = { version = "1", features = ["derive"] }
+size_format = "1.0.2"
 serde_json = "1"
 serde_yaml = "0.9"
 spreet = { version = "0.9", default-features = false }

docs/src/52-mbtiles-stats.md

@@ -0,0 +1,20 @@
+# Get a tile statistics from MBTiles file
+
+For the concern of efficiency, you could figure out the page size and file size, tile size and  bounds(represented as WGS 84 latitude and longitude values) of covered area with `mbtiles stats` command.
+
+```shell
+mbtiles stats /path/to/my_file.mbtiles
+File: ./tests/fixtures/mbtiles/world_cities.mbtiles
+FileSize: 48.00KiB
+Schema: flat
+Page size: 4.00KiB
+|  zoom   |  count  |smallest | largest | average |  bbox   |
+|    0    |    1    | 1.08KiB | 1.08KiB |  1107B  |-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|
+```

docs/src/53-mbtiles-validation.md → docs/src/54-mbtiles-validation.md

@@ -13,9 +13,9 @@ The `validate` command will run `PRAGMA integrity_check` on the file, and will f
 The `validate` command will verify that the `tiles` table/view exists, and that it has the expected columns and indexes. It will also verify that the `metadata` table/view exists, and that it has the expected columns and indexes.
 
 ## Per-tile validation
-If the `.mbtiles` file uses [flat_with_hash](54-mbtiles-schema.md#flat-with-hash) or [normalized](54-mbtiles-schema.md#normalized) schema, the `validate` command will verify that the MD5 hash of the `tile_data` column matches the  `tile_hash` or `tile_id` columns (depending on the schema).
+If the `.mbtiles` file uses [flat_with_hash](55-mbtiles-schema.md#flat-with-hash) or [normalized](55-mbtiles-schema.md#normalized) schema, the `validate` command will verify that the MD5 hash of the `tile_data` column matches the  `tile_hash` or `tile_id` columns (depending on the schema).
 
-A typical Normalized schema generated by tools like [tilelive-copy](https://github.com/mapbox/TileLive#bintilelive-copy) use MD5 hash in the `tile_id` column. The Martin's `mbtiles` tool can use this hash to verify the content of each tile. We also define a new [flat-with-hash](54-mbtiles-schema.md#flat-with-hash) schema that stores the hash and tile data in the same table, allowing per-tile validation without the multiple table layout.
+A typical Normalized schema generated by tools like [tilelive-copy](https://github.com/mapbox/TileLive#bintilelive-copy) use MD5 hash in the `tile_id` column. The Martin's `mbtiles` tool can use this hash to verify the content of each tile. We also define a new [flat-with-hash](55-mbtiles-schema.md#flat-with-hash) schema that stores the hash and tile data in the same table, allowing per-tile validation without the multiple table layout.
 
 Per-tile validation is not available for the `flat` schema, and will be skipped.
 

docs/src/SUMMARY.md

@@ -23,7 +23,8 @@
   - [Recipes](45-recipes.md)
 - [Tools](50-tools.md)
   - [MBTiles 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](52-mbtiles-stats.md)
+  - [MBTiles Copying / Diffing](53-mbtiles-copy.md)
+  - [MBTiles Validation](54-mbtiles-validation.md)
+  - [MBTiles Schemas](55-mbtiles-schema.md)
 - [Development](60-development.md)

mbtiles/Cargo.toml

@@ -31,14 +31,16 @@ anyhow = { workspace = true, optional = true }
 clap = { workspace = true, optional = true }
 env_logger = { workspace = true, optional = true }
 serde_yaml = { workspace = true, optional = true }
+size_format.workspace = true
 tokio = { workspace = true, features = ["rt-multi-thread"], optional = true }
 
 [dev-dependencies]
 # For testing, might as well use the same async framework as the Martin itself
 actix-rt.workspace = true
+approx.workspace = true
 ctor.workspace = true
 env_logger.workspace = true
-insta = { workspace = true, features = ["toml"] }
+insta = { workspace = true, features = ["toml", "yaml"] }
 pretty_assertions.workspace = true
 rstest.workspace = true
 

mbtiles/src/bin/main.rs

@@ -26,6 +26,9 @@ enum Commands {
         /// 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 {
@@ -114,6 +117,13 @@ 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 } => {
+            let mbt = Mbtiles::new(file.as_path())?;
+            let mut conn = mbt.open_readonly().await?;
+
+            let statistics = mbt.statistics(&mut conn).await?;
+            println!("{statistics}");
+        }
     }
 
     Ok(())