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:
login Log into LaminHub.
init Init a LaminDB instance.
load Load an instance for auto-connection.
info Show user, settings & instance info.
close Close an existing instance.
delete Delete an instance.
logout Logout.
get Query an entity.
save Save file or folder.
cache Manage cache.
set Update settings.
migrate Manage migrations.
schema View schema.
lamin login¶
Log into LaminHub.
Upon logging in the first time, you need to pass your API key via:
lamin login myemail@acme.com --key YOUR_API_KEY
You’ll find your API key on LaminHub in the top right corner under “Settings”.
After this, you can either use lamin login myhandle
or lamin login myemail@acme.com
You can also call this without arguments:
lamin login
You will be prompted for your Beta API key unless you set an environment variable LAMIN_API_KEY
.
Usage: lamin login [OPTIONS] [USER]
Options:
--key TEXT The API key.
--help Show this message and exit.
lamin init¶
Init a LaminDB instance.
Usage: lamin init [OPTIONS]
Options:
--storage TEXT Local directory, 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 The instance name.
--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 info¶
Show user, settings & instance info.
Usage: lamin info [OPTIONS]
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 delete¶
Delete an instance.
Usage: lamin delete [OPTIONS] INSTANCE
Options:
--force Do not ask for confirmation.
--help Show this message and exit.
lamin logout¶
Logout.
Usage: lamin logout [OPTIONS]
Options:
--help Show this message and exit.
lamin get¶
Query an entity.
Pass a lamin.ai URL, ‘artifact’, or ‘transform’, for example:
lamin get https://lamin.ai/account/instance/artifact/e2G7k9EVul4JbfsEYAy5
lamin get artifact --key mydatasets/mytable.parquet
lamin get artifact --uid e2G7k9EVul4JbfsEYAy5
lamin get transform --key analysis.ipynb
lamin get transform --uid Vul4JbfsEYAy5
Usage: lamin get [OPTIONS] ENTITY
Options:
--uid TEXT Filter by creator
--key TEXT The key for the entity
--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 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 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 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.
lamin schema¶
View schema.
Usage: lamin schema [OPTIONS] {view}
Options:
--help Show this message and exit.