Skip to content

Commit

Permalink
Added note about refresh and POSIX behavior (#648)
Browse files Browse the repository at this point in the history

Co-authored-by: Martin Durant <[email protected]>
  • Loading branch information
rickmcgeer and martindurant authored Nov 18, 2024
1 parent 7b9ef9c commit 7e96e66
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion gcsfs/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,14 @@ class GCSFileSystem(asyn.AsyncFileSystem):
GCSFileSystem maintains a per-implied-directory cache of object listings and
fulfills all object information and listing requests from cache. This implied, for example, that objects
created via other processes *will not* be visible to the GCSFileSystem until the cache
refreshed. Calls to GCSFileSystem.open and calls to GCSFile are not effected by this cache.
refreshed. Calls to GCSFileSystem.open and calls to GCSFile are not affected by this cache.
Note that directory listings are cached by default, because fetching those listings can be expensive. This is
contrary to local filesystem behaviour. The cache will be cleared if writing from this instance, but it can
become stale and return incorrect results if the storage is written to from another process/machine.
If you anticipate this possibility, you can set the use_listings_cache and listings_expiry_time arguments
to configure the caching, call `.invalidate_cache()` when required, or pass `refresh=True` to the
various listing methods.
In the default case the cache is never expired. This may be controlled via the ``cache_timeout``
GCSFileSystem parameter or via explicit calls to ``GCSFileSystem.invalidate_cache``.
Expand Down

0 comments on commit 7e96e66

Please sign in to comment.