Skip to content

Commit 60ae6cf

Browse files
authored
chore: rename agg_tiles_hash_in_diff to agg_tiles_hash_after_apply (#1243)
This is just a documentation change - the actual value stored in the mbtiles was always `agg_tiles_hash_after_apply`, but accidentally the constant in the code was not renamed, nor were the docs updated.
1 parent db09440 commit 60ae6cf

File tree

5 files changed

+31
-14
lines changed

5 files changed

+31
-14
lines changed

docs/src/mbtiles-diff.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,16 @@
22

33
## `mbtiles diff`
44

5-
Copy command can also be used to compare two mbtiles files and generate a delta (diff) file. The diff file can be [applied](#mbtiles-apply-patch) to the `src_file.mbtiles` elsewhere, to avoid copying/transmitting the entire modified dataset. The delta file will contain all tiles that are different between the two files (modifications, insertions, and deletions as `NULL` values), for both the tile and metadata tables.
5+
Copy command can also be used to compare two mbtiles files and generate a delta (diff) file. The diff file can
6+
be [applied](#mbtiles-apply-patch) to the `src_file.mbtiles` elsewhere, to avoid copying/transmitting the entire
7+
modified dataset. The delta file will contain all tiles that are different between the two files (modifications,
8+
insertions, and deletions as `NULL` values), for both the tile and metadata tables.
69

7-
There is one exception: `agg_tiles_hash` metadata value will be renamed to `agg_tiles_hash_in_diff`, and a new `agg_tiles_hash` will be generated for the diff file itself. This is done to avoid confusion when applying the diff file to the original file, as the `agg_tiles_hash` value will be different after the diff is applied. The `apply-diff` command will automatically rename the `agg_tiles_hash_in_diff` value back to `agg_tiles_hash` when applying the diff.
10+
There is one exception: `agg_tiles_hash` metadata value will be renamed to `agg_tiles_hash_after_apply`, and a
11+
new `agg_tiles_hash` will be generated for the diff file itself. This is done to avoid confusion when applying the diff
12+
file to the original file, as the `agg_tiles_hash` value will be different after the diff is applied. The `apply-diff`
13+
command will automatically rename the `agg_tiles_hash_after_apply` value back to `agg_tiles_hash` when applying the
14+
diff.
815

916
```shell
1017
# This command will compare `file1.mbtiles` and `file2.mbtiles`, and generate a new diff file `diff.mbtiles`.
@@ -24,17 +31,27 @@ mbtiles validate file2a.mbtiles
2431

2532
## `mbtiles apply-patch`
2633

27-
Apply the diff file generated with the `mbtiles diff` command above to an MBTiles file. The diff file can be applied to the `src_file.mbtiles` that has been previously downloaded to avoid copying/transmitting the entire modified dataset again. The `src_file.mbtiles` will modified in-place. It is also possible to apply the diff file while copying the source file to a new destination file, by using the [`mbtiles copy --apply-patch`](mbtiles-copy.md#mbtiles-copy---apply-patch) command.
34+
Apply the diff file generated with the `mbtiles diff` command above to an MBTiles file. The diff file can be applied to
35+
the `src_file.mbtiles` that has been previously downloaded to avoid copying/transmitting the entire modified dataset
36+
again. The `src_file.mbtiles` will modified in-place. It is also possible to apply the diff file while copying the
37+
source file to a new destination file, by using
38+
the [`mbtiles copy --apply-patch`](mbtiles-copy.md#mbtiles-copy---apply-patch) command.
2839

29-
Note that the `agg_tiles_hash_in_diff` metadata value will be renamed to `agg_tiles_hash` when applying the diff. This is done to avoid confusion when applying the diff file to the original file, as the `agg_tiles_hash` value will be different after the diff is applied.
40+
Note that the `agg_tiles_hash_after_apply` metadata value will be renamed to `agg_tiles_hash` when applying the diff.
41+
This is done to avoid confusion when applying the diff file to the original file, as the `agg_tiles_hash` value will be
42+
different after the diff is applied.
3043

3144
```shell
3245
mbtiles apply-patch src_file.mbtiles diff_file.mbtiles
3346
```
3447

3548
#### Applying diff with SQLite
3649

37-
Another way to apply the diff is to use the `sqlite3` command line tool directly. This SQL will delete all tiles from `src_file.mbtiles` that are set to `NULL` in `diff_file.mbtiles`, and then insert or update all new tiles from `diff_file.mbtiles` into `src_file.mbtiles`, where both files are of `flat` type. The name of the diff file is passed as a query parameter to the sqlite3 command line tool, and then used in the SQL statements. Note that this does not update the `agg_tiles_hash` metadata value, so it will be incorrect after the diff is applied.
50+
Another way to apply the diff is to use the `sqlite3` command line tool directly. This SQL will delete all tiles
51+
from `src_file.mbtiles` that are set to `NULL` in `diff_file.mbtiles`, and then insert or update all new tiles
52+
from `diff_file.mbtiles` into `src_file.mbtiles`, where both files are of `flat` type. The name of the diff file is
53+
passed as a query parameter to the sqlite3 command line tool, and then used in the SQL statements. Note that this does
54+
not update the `agg_tiles_hash` metadata value, so it will be incorrect after the diff is applied.
3855

3956
```shell
4057
sqlite3 src_file.mbtiles \

mbtiles/src/copier.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ use crate::queries::{
1717
use crate::MbtType::{Flat, FlatWithHash, Normalized};
1818
use crate::{
1919
invert_y_value, reset_db_settings, CopyType, MbtError, MbtType, MbtTypeCli, Mbtiles,
20-
AGG_TILES_HASH, AGG_TILES_HASH_IN_DIFF,
20+
AGG_TILES_HASH, AGG_TILES_HASH_AFTER_APPLY,
2121
};
2222

2323
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, EnumDisplay)]
@@ -233,13 +233,13 @@ impl MbtileCopierInt {
233233
if dif.is_some() {
234234
// Insert all rows from diffDb.metadata if they do not exist or are different in sourceDb.metadata.
235235
// Also insert all names from sourceDb.metadata that do not exist in diffDb.metadata, with their value set to NULL.
236-
// Rename agg_tiles_hash to agg_tiles_hash_in_diff because agg_tiles_hash will be auto-added later
236+
// Rename agg_tiles_hash to agg_tiles_hash_after_apply because agg_tiles_hash will be auto-added later
237237
if self.options.diff_with_file.is_some() {
238238
// Include agg_tiles_hash value even if it is the same because we will still need it when applying the diff
239239
sql = format!(
240240
"
241241
INSERT {on_dupl} INTO metadata (name, value)
242-
SELECT IIF(name = '{AGG_TILES_HASH}','{AGG_TILES_HASH_IN_DIFF}', name) as name
242+
SELECT IIF(name = '{AGG_TILES_HASH}','{AGG_TILES_HASH_AFTER_APPLY}', name) as name
243243
, value
244244
FROM (
245245
SELECT COALESCE(difMD.name, srcMD.name) as name
@@ -248,14 +248,14 @@ impl MbtileCopierInt {
248248
ON srcMD.name = difMD.name
249249
WHERE srcMD.value != difMD.value OR srcMD.value ISNULL OR difMD.value ISNULL OR srcMD.name = '{AGG_TILES_HASH}'
250250
) joinedMD
251-
WHERE name != '{AGG_TILES_HASH_IN_DIFF}'"
251+
WHERE name != '{AGG_TILES_HASH_AFTER_APPLY}'"
252252
);
253253
debug!("Copying metadata, taking into account diff file with {sql}");
254254
} else {
255255
sql = format!(
256256
"
257257
INSERT {on_dupl} INTO metadata (name, value)
258-
SELECT IIF(name = '{AGG_TILES_HASH_IN_DIFF}','{AGG_TILES_HASH}', name) as name
258+
SELECT IIF(name = '{AGG_TILES_HASH_AFTER_APPLY}','{AGG_TILES_HASH}', name) as name
259259
, value
260260
FROM (
261261
SELECT COALESCE(srcMD.name, difMD.name) as name

mbtiles/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ pub use update::UpdateZoomType;
3232
mod validation;
3333
pub use validation::{
3434
calc_agg_tiles_hash, AggHashType, IntegrityCheckType, MbtType, AGG_TILES_HASH,
35-
AGG_TILES_HASH_IN_DIFF,
35+
AGG_TILES_HASH_AFTER_APPLY,
3636
};
3737

3838
/// `MBTiles` uses a TMS (Tile Map Service) scheme for its tile coordinates (inverted along the Y axis).

mbtiles/src/patcher.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use sqlx::query;
55

66
use crate::queries::detach_db;
77
use crate::MbtType::{Flat, FlatWithHash, Normalized};
8-
use crate::{MbtResult, MbtType, Mbtiles, AGG_TILES_HASH, AGG_TILES_HASH_IN_DIFF};
8+
use crate::{MbtResult, MbtType, Mbtiles, AGG_TILES_HASH, AGG_TILES_HASH_AFTER_APPLY};
99

1010
pub async fn apply_patch(base_file: PathBuf, patch_file: PathBuf) -> MbtResult<()> {
1111
let base_mbt = Mbtiles::new(base_file)?;
@@ -53,7 +53,7 @@ pub async fn apply_patch(base_file: PathBuf, patch_file: PathBuf) -> MbtResult<(
5353
query(&format!(
5454
"
5555
INSERT OR REPLACE INTO metadata (name, value)
56-
SELECT IIF(name = '{AGG_TILES_HASH_IN_DIFF}', '{AGG_TILES_HASH}', name) as name,
56+
SELECT IIF(name = '{AGG_TILES_HASH_AFTER_APPLY}', '{AGG_TILES_HASH}', name) as name,
5757
value
5858
FROM patchDb.metadata
5959
WHERE name NOTNULL AND name != '{AGG_TILES_HASH}';"

mbtiles/src/validation.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ pub const AGG_TILES_HASH: &str = "agg_tiles_hash";
2626

2727
/// Metadata key for a diff file,
2828
/// describing the eventual [`AGG_TILES_HASH`] value once the diff is applied
29-
pub const AGG_TILES_HASH_IN_DIFF: &str = "agg_tiles_hash_after_apply";
29+
pub const AGG_TILES_HASH_AFTER_APPLY: &str = "agg_tiles_hash_after_apply";
3030

3131
#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq, EnumDisplay, Serialize)]
3232
#[enum_display(case = "Kebab")]

0 commit comments

Comments
 (0)