lamindb.setup.core.StorageSettings

class lamindb.setup.core.StorageSettings(root, region=None, uid=None, uuid=None, instance_id=None, access_token=None)

Bases: object

Settings for a given storage location (local or cloud).

Attributes

property cache_dir: UPath

Cache root, a local directory to cache cloud files.

property id: int

Storage id in current instance.

property is_on_hub: bool

Is this instance on the hub.

Only works if user has access to the instance.

property record: Any

Storage record in the current instance.

property region: str | None

Storage region.

property root: UPath

Root storage location.

property root_as_str: str

Formatted root string.

property type: Literal['local', 's3', 'gs', 'hf', 'http', 'https']

AWS S3 vs. Google Cloud vs. local.

Returns the protocol as a string: “local”, “s3”, “gs”, “http”, “https”.

property type_is_cloud: bool

True if storage_root is in cloud, False otherwise.

property uid: str | None

Storage id.

Methods

cloud_to_local(filepath, cache_key=None, **kwargs)

Local (or local cache) filepath from filepath.

Return type:

UPath

cloud_to_local_no_update(filepath, cache_key=None)

Return type:

UPath

key_to_filepath(filekey)

Cloud or local filepath from filekey.

Return type:

UPath

local_filepath(filekey)

Local (cache) filepath from filekey.

Return type:

UPath