Functions for commands that can be ran from the command-line with lein
or the Metabase JAR. These are ran as
follows:
<metabase> <command> <options>
for example, running the migrate
command and passing it force
can be done using one of the following ways:
lein run migrate force java -jar metabase.jar migrate force
Logic below translates resolves the command itself to a function marked with ^:command
metadata and calls the
function with arguments as appropriate.
You can see what commands are available by running the command help
. This command uses the docstrings and arglists
associated with each command's entrypoint function to generate descriptions for each command.
Functions for commands that can be ran from the command-line with `lein` or the Metabase JAR. These are ran as follows: <metabase> <command> <options> for example, running the `migrate` command and passing it `force` can be done using one of the following ways: lein run migrate force java -jar metabase.jar migrate force Logic below translates resolves the command itself to a function marked with `^:command` metadata and calls the function with arguments as appropriate. You can see what commands are available by running the command `help`. This command uses the docstrings and arglists associated with each command's entrypoint function to generate descriptions for each command.
(api-documentation)
Generate a markdown file containing documentation for all API endpoints. This is written to a file called
docs/api-documentation.md
.
Generate a markdown file containing documentation for all API endpoints. This is written to a file called `docs/api-documentation.md`.
(driver-methods)
Print a list of all multimethods a available for a driver to implement. A useful reference when implementing a new driver.
Print a list of all multimethods a available for a driver to implement. A useful reference when implementing a new driver.
(help)
Show this help message listing valid Metabase commands.
Show this help message listing valid Metabase commands.
(load-from-h2)
(load-from-h2 h2-connection-string)
Transfer data from existing H2 database to the newly created MySQL or Postgres DB specified by env vars.
Transfer data from existing H2 database to the newly created MySQL or Postgres DB specified by env vars.
(migrate direction)
Run database migrations. Valid options for direction
are up
, force
, down-one
, print
, or release-locks
.
Run database migrations. Valid options for `direction` are `up`, `force`, `down-one`, `print`, or `release-locks`.
(profile)
Start Metabase the usual way and exit. Useful for profiling Metabase launch time.
Start Metabase the usual way and exit. Useful for profiling Metabase launch time.
(refresh-integration-test-db-metadata)
Re-sync the frontend integration test DB's metadata for the Sample Dataset.
Re-sync the frontend integration test DB's metadata for the Sample Dataset.
(reset-password email-address)
Reset the password for a user with email-address
.
Reset the password for a user with `email-address`.
(run-cmd cmd args)
Run cmd
with args
. This is a function above. e.g. lein run metabase migrate force
becomes
(migrate "force")
.
Run `cmd` with `args`. This is a function above. e.g. `lein run metabase migrate force` becomes `(migrate "force")`.
(version)
Print version information about Metabase and the current system.
Print version information about Metabase and the current system.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close