lamindb_setup.core.StorageSettings#

class lamindb_setup.core.StorageSettings(root, region=None, uid=None, uuid=None, access_token=None)#

Bases: object

Manage cloud or local storage settings.

Attributes

cache_dir UPath#

Cache root, a local directory to cache cloud files.

id int#

Storage id.

is_cloud bool#

True if storage_root is in cloud, False otherwise.

record Any#

Storage record.

region Optional#

Storage region.

root UPath#

Root storage location.

root_as_str str#

Formatted root string.

type str#

AWS S3 vs. Google Cloud vs. local vs. the other protocols.

Returns the protocol.

uid Optional#

Storage id.

uuid Optional#

Storage uuid.

Methods

cloud_to_local(filepath, **kwargs)#

Local (cache) filepath from filepath.

Return type:

UPath

cloud_to_local_no_update(filepath)#
Return type:

UPath

key_to_filepath(filekey)#

Cloud or local filepath from filekey.

Return type:

UPath

local_filepath(filekey)#

Local (cache) filepath from filekey: local(filepath(…)).

Return type:

UPath