lamindb_setup.core.InstanceSettings#

class lamindb_setup.core.InstanceSettings(id, owner, name, storage, uid=None, db=None, schema=None)#

Bases: object

Instance settings.

Attributes

db str#

Database connection string (URI).

dialect Literal#

SQL dialect.

id UUID#

The internal instance id.

identifier str#

Unique semantic identifier.

is_remote bool#

Boolean indicating if an instance has no local component.

name str#

Instance name.

owner str#

Instance owner. A user or organization account handle.

schema Set#

Schema modules in addition to core schema.

session property#
slug str#

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

storage StorageSettings#

Low-level access to storage location.

uid Optional#

The user-facing instance id.