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

cache_dir UPath

Cache root, a local directory to cache cloud files.

id int

Storage id in current instance.

is_on_hub bool

Is this instance on the hub.

Only works if user has access to the instance.

record Any

Storage record in current instance.

region str | None

Storage region.

root UPath

Root storage location.

root_as_str str

Formatted root string.

type Literal['local', 's3', 'gs']

AWS S3 vs. Google Cloud vs. local.

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

type_is_cloud bool

True if storage_root is in cloud, False otherwise.

uid str | None

Storage id.

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