lamin
¶
For a guide, see: Install & setup.
Configure LaminDB and perform simple actions.
Usage: lamin [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
cache Manage cache.
close Close an existing instance.
delete Delete an instance.
get Get an object from a lamin.ai URL.
info Show user, settings & instance info.
init Init a lamindb instance.
load Load an instance for auto-connection.
login Login using a user email address or handle.
logout Logout.
migrate Manage migrations.
register Register an instance on the hub.
save Save file or folder.
schema View schema.
set Update settings.
lamin info¶
Show user, settings & instance info.
Usage: lamin info [OPTIONS]
Options:
--help Show this message and exit.
lamin init¶
Init a lamindb instance.
Usage: lamin init [OPTIONS]
Options:
--storage TEXT local dir, s3://bucket_name, gs://bucket_name
--db TEXT postgres database connection URL, do not pass for SQLite
--schema TEXT comma-separated string of schema modules
--name TEXT instance name
--help Show this message and exit.
lamin login¶
Login using a user email address or handle.
Examples: lamin login marge
or lamin login marge@acme.com
Usage: lamin login [OPTIONS] USER
Options:
--key TEXT API key
--password TEXT legacy password
--help Show this message and exit.
lamin logout¶
Logout.
Usage: lamin logout [OPTIONS]
Options:
--help Show this message and exit.
lamin load¶
Load an instance for auto-connection.
IDENTIFIER
is either a slug (account/instance
) or a URL
(https://lamin.ai/account/instance
).
Usage: lamin load [OPTIONS] IDENTIFIER
Options:
--db TEXT Update database URL.
--storage TEXT Update storage while loading.
--help Show this message and exit.
lamin delete¶
Delete an instance.
Usage: lamin delete [OPTIONS] INSTANCE
Options:
--force Do not ask for confirmation.
--help Show this message and exit.
lamin set¶
Update settings.
auto-connect
→auto_connect
private-django-api
→private_django_api
Usage: lamin set [OPTIONS] {auto-connect|private-django-api} VALUE
Options:
--help Show this message and exit.
lamin close¶
Close an existing instance.
Is the opposite of loading an instance.
Usage: lamin close [OPTIONS]
Options:
--help Show this message and exit.
lamin schema¶
View schema.
Usage: lamin schema [OPTIONS] {view}
Options:
--help Show this message and exit.
lamin save¶
Save file or folder.
Usage: lamin save [OPTIONS] FILEPATH
Options:
--key TEXT
--description TEXT
--help Show this message and exit.
lamin get¶
Get an object from a lamin.ai URL.
Usage: lamin get [OPTIONS] URL
Options:
--help Show this message and exit.
lamin cache¶
Manage cache.
Usage: lamin cache [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
clear Clear the cache directory.
get Get the cache directory.
set Set the cache directory.
lamin cache set¶
Set the cache directory.
Usage: lamin cache set [OPTIONS] CACHE_DIR
Options:
--help Show this message and exit.
lamin cache clear¶
Clear the cache directory.
Usage: lamin cache clear [OPTIONS]
Options:
--help Show this message and exit.
lamin cache get¶
Get the cache directory.
Usage: lamin cache get [OPTIONS]
Options:
--help Show this message and exit.
lamin migrate¶
Manage migrations.
Usage: lamin migrate [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
create Create a new migration.
deploy Deploy migrations.
squash Squash migrations.
lamin migrate create¶
Create a new migration.
Usage: lamin migrate create [OPTIONS]
Options:
--help Show this message and exit.
lamin migrate deploy¶
Deploy migrations.
Usage: lamin migrate deploy [OPTIONS]
Options:
--help Show this message and exit.
lamin migrate squash¶
Squash migrations.
Usage: lamin migrate squash [OPTIONS]
Options:
--package-name TEXT
--end-number TEXT
--start-number TEXT
--help Show this message and exit.