`lamin`¶

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.
  logout      Log out of LaminHub.
  init        Init an instance.
  connect     Connect to an instance.
  disconnect  Disconnect from an instance.
  info        Show info about current instance.
  delete      Delete an entity.
  load        Load a file or folder.
  get         Query metadata about an entity.
  save        Save a file or folder.
  settings    Manage settings.
  cache       Manage cache.
  migrate     Manage database schema migrations.

lamin login¶

Log into LaminHub.

lamin login prompts for your API key unless you set it via environment variable LAMIN_API_KEY.

You can create your API key in your account settings on LaminHub (top right corner).

After authenticating once, you can re-authenticate and switch between accounts via lamin login myhandle.

Usage: lamin login [OPTIONS] [USER]

Options:
  --key TEXT  The legacy API key.
  --help      Show this message and exit.

lamin logout¶

Log out of LaminHub.

Usage: lamin logout [OPTIONS]

Options:
  --help  Show this message and exit.

lamin init¶

Init an 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.
  --modules TEXT  Comma-separated string of schema modules.
  --name TEXT     The instance name.
  --schema TEXT   [DEPRECATED] Use --modules instead.
  --help          Show this message and exit.

lamin connect¶

Connect to an instance.

Pass a slug (account/name) or URL (https://lamin.ai/account/name).

lamin connect switches auto_connect to True so that you auto-connect in a Python session upon importing lamindb.

Usage: lamin connect [OPTIONS] INSTANCE

Options:
  --help  Show this message and exit.

lamin disconnect¶

Disconnect from an instance.

Is the opposite of connecting to an instance.

Usage: lamin disconnect [OPTIONS]

Options:
  --help  Show this message and exit.

lamin info¶

Show info about current instance.

Usage: lamin info [OPTIONS]

Options:
  --schema  View database schema.
  --help    Show this message and exit.

lamin delete¶

Delete an entity.

Currently only supports instance deletion.

Usage: lamin delete [OPTIONS] INSTANCE

Options:
  --force  Do not ask for confirmation.
  --help   Show this message and exit.

lamin load¶

Load a file or folder.

Pass a URL, artifact, or transform. For example:

lamin load https://lamin.ai/account/instance/artifact/e2G7k9EVul4JbfsEYAy5
lamin load artifact --key mydatasets/mytable.parquet
lamin load artifact --uid e2G7k9EVul4JbfsEYAy5
lamin load transform --key analysis.ipynb
lamin load transform --uid Vul4JbfsEYAy5
lamin load transform --uid Vul4JbfsEYAy5 --with-env

Usage: lamin load [OPTIONS] ENTITY

Options:
  --uid TEXT  The uid for the entity.
  --key TEXT  The key for the entity.
  --with-env  Also return the environment for a tranform.
  --help      Show this message and exit.

lamin get¶

Query metadata about an entity.

Currently only works for artifact & transform and behaves like lamin load.

Usage: lamin get [OPTIONS] ENTITY

Options:
  --uid TEXT  The uid for the entity.
  --key TEXT  The key for the entity.
  --with-env  Also return the environment for a tranform.
  --help      Show this message and exit.

lamin save¶

Save a file or folder.

Defaults to saving .py and .ipynb as Transform and other file types and folders as Artifact.

You can save a .py or .ipynb file as an Artifact by passing --registry artifact.

Usage: lamin save [OPTIONS] FILEPATH

Options:
  --key TEXT
  --description TEXT
  --registry TEXT
  --help              Show this message and exit.

lamin settings¶

Manage settings.

Call without subcommands and options to show settings.

Usage: lamin settings [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  set  Update settings.

Update settings.

auto-connect → auto_connect
private-django-api → private_django_api

Usage: lamin settings set [OPTIONS] {auto-connect|private-django-api} VALUE

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.

Set the cache directory.

Usage: lamin cache set [OPTIONS] CACHE_DIR

Options:
  --help  Show this message and exit.

Clear the cache directory.

Usage: lamin cache clear [OPTIONS]

Options:
  --help  Show this message and exit.

Get the cache directory.

Usage: lamin cache get [OPTIONS]

Options:
  --help  Show this message and exit.

lamin migrate¶

Manage database schema 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.

Create a new migration.

Usage: lamin migrate create [OPTIONS]

Options:
  --help  Show this message and exit.

Deploy migrations.

Usage: lamin migrate deploy [OPTIONS]

Options:
  --help  Show this message and exit.

Squash migrations.

Usage: lamin migrate squash [OPTIONS]

Options:
  --package-name TEXT
  --end-number TEXT
  --start-number TEXT
  --help               Show this message and exit.

lamin¶