lamindb.setup.core.InstanceSettings

class lamindb.setup.core.InstanceSettings(id, owner, name, storage, keep_artifacts_local=False, uid=None, db=None, modules=None, git_repo=None, is_on_hub=None, api_url=None, schema_id=None, _locker_user=None)

Bases: object

Instance settings.

Attributes

property db: str

Database connection string (URI).

property dialect: Literal['sqlite', 'postgresql']

SQL dialect.

property git_repo: str | None

Sync transforms with scripts in git repository.

Provide the full git repo URL.

property is_on_hub: bool

Is this instance on the hub?

Can only reliably establish if user has access to the instance. Will return False in case the instance isn’t found.

property is_remote: bool

Boolean indicating if an instance has no local component.

property keep_artifacts_local: bool

Default to keeping artifacts local.

Enable this optional setting for cloud instances on lamin.ai.

Guide: Keep artifacts local in a cloud instance

property modules: set[str]

The set of modules that defines the database schema.

The core schema contained in lamindb is not included in this set.

property name: str

Instance name.

property owner: str

Instance owner. A user or organization account handle.

property slug: str

Unique semantic identifier of form "{account_handle}/{instance_name}".

property storage: StorageSettings

Default storage.

For a cloud instance, this is cloud storage. For a local instance, this is a local directory.

property storage_local: StorageSettings

An additional local default storage.

Is only available if keep_artifacts_local is enabled.

Guide: Keep artifacts local in a cloud instance

property uid: str

The user-facing instance id.