Reference#

Setup & configure LaminDB.

Every function in the API has a matching command in the lamin CLI.

Typically, you’ll want to use the CLI rather than this API.

Guide: Install & setup.

Setup:

login(user, *[, key, password])

Log in user.

logout()

init(*, storage[, name, db, schema, _test])

Create and load a LaminDB instance.

load(identifier, *[, db, storage, ...])

Load existing instance.

close([mute])

Close existing instance.

delete(instance_name[, force])

Delete an instance.

More instance operations:

info()

Log information about current instance & user.

set()

Set properties of current instance.

migrate()

Manage migrations.

register([_test])

Register an instance on the hub.

Settings:

settings()

Settings.

Developer API.

dev

Developer API.

django(command[, package_name])

Manage migrations.