lamindb.connect
¶
- lamindb.connect(instance=None, **kwargs)¶
Connect the default database.
Alternatively, to use a database client, create a
DBobject.- Parameters:
instance (
str|None, default:None) – Pass a slug (account/name) or URL (https://lamin.ai/account/name). IfNone, looks for an environment variableLAMIN_CURRENT_INSTANCEto get the database instance identifier. If it doesn’t find this variable, it connects to the database that was connected withlamin connectthrough the CLI.- Return type:
str|tuple|None
See also
To set a default database for auto-connection in your environment via the CLI, see here.