lamindb_setup.core.InstanceSettings#
- class lamindb_setup.core.InstanceSettings(id, owner, name, storage, local_storage=False, uid=None, db=None, schema=None, git_repo=None)#
Bases:
object
Instance settings.
Attributes
- db str#
Database connection string (URI).
- dialect Literal['sqlite', 'postgresql']#
SQL dialect.
- git_repo Optional[str]#
Sync transforms with scripts in git repository.
Provide the full git repo URL.
- id UUID#
The internal instance id.
- is_remote bool#
Boolean indicating if an instance has no local component.
- local_storage StorageSettings#
Default local storage.
Warning: Only enable if you’re sure you want to use the more complicated storage mode across local & cloud locations.
As an admin, enable via:
ln.setup.settings.instance.local_storage = local_root
.If enabled, you’ll save artifacts to a default local storage location.
Upon passing
upload=True
inartifact.save(upload=True)
, you upload the artifact to the default cloud storage location.
- name str#
Instance name.
- owner str#
Instance owner. A user or organization account handle.
- schema Set[str]#
Schema modules in addition to core schema.
- slug str#
Unique semantic identifier of form
"{account_handle}/{instance_name}"
.
- storage StorageSettings#
Low-level access to storage location.
- uid Optional[str]#
The user-facing instance id.