diff --git a/changes/3850.doc.md b/changes/3850.doc.md new file mode 100644 index 0000000000..ff5564792b --- /dev/null +++ b/changes/3850.doc.md @@ -0,0 +1 @@ +Document the removal of `LRUStoreCache` in the v3 migration guide, and point to the experimental `zarr.experimental.cache_store.CacheStore` as its replacement. diff --git a/docs/user-guide/v3_migration.md b/docs/user-guide/v3_migration.md index 4d97963be2..0e65649650 100644 --- a/docs/user-guide/v3_migration.md +++ b/docs/user-guide/v3_migration.md @@ -165,6 +165,13 @@ The following stores have been renamed or changed: | `DirectoryStore` | [`zarr.storage.LocalStore`][] | | `FSStore` | [`zarr.storage.FsspecStore`][] | | `TempStore` | Use [`tempfile.TemporaryDirectory`][] with [`LocalStore`][zarr.storage.LocalStore] | +| `LRUStoreCache` | [`zarr.experimental.cache_store.CacheStore`][] (experimental) | + +`LRUStoreCache` has no stable equivalent in Zarr-Python 3. The experimental +[`CacheStore`](experimental.md#cachestore) wraps a store and caches its contents in a second +store, evicting the least recently used entries once `max_size` is reached. For remote data read +through [`FsspecStore`][zarr.storage.FsspecStore], fsspec's caching filesystems +(`fsspec.implementations.cached`, e.g. a `simplecache::s3://...` URL) are another option. A number of deprecated stores were also removed. See [issue #1274](https://github.com/zarr-developers/zarr-python/issues/1274) for more details on the removal of these stores.