lamindb_setup.core.InstanceSettings¶

class lamindb_setup.core.InstanceSettings(id, owner, name, storage, keep_artifacts_local=False, uid=None, db=None, schema=None, git_repo=None, is_on_hub=None)¶

Bases: object

Instance settings.

Attributes¶

db¶: Database connection string (URI).

dialect¶: SQL dialect.

git_repo¶

Sync transforms with scripts in git repository.

Provide the full git repo URL.

is_on_hub¶

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.

is_remote¶: Boolean indicating if an instance has no local component.

keep_artifacts_local¶

Default to keeping artifacts local.

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

Guide: faq/keep-artifacts-local

name¶: Instance name.

owner¶: Instance owner. A user or organization account handle.

schema¶: Schema modules in addition to core schema.

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

storage¶

Default storage.

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

storage_local¶

An additional local default storage.

Is only available if keep_artifacts_local is enabled.

Guide: faq/keep-artifacts-local

uid¶: The user-facing instance id.

lamindb_setup.core.InstanceSettings¶

Attributes¶

Methods¶