lamindb.setup.init

lamindb.setup.init(*, storage='.', name=None, db=None, modules=None, **kwargs)

Init a LaminDB instance.

Parameters:

  • storage (lamindb.core.types.UPathStr, default: '.') – A local or remote folder ('s3://...' or 'gs://...'). Defaults to current working directory.

  • name (str | None, default: None) – Instance name. If not passed, it will equal the folder name passed to storage.

  • db (PostgresDsn | None, default: None) – Database connection URL. Defaults to None, which implies an SQLite file in the storage location.

  • modules (str | None, default: None) – Comma-separated string of schema modules.

  • **kwargs – Keyword arguments for low-level control.

Return type:

None