mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-15 01:12:56 +03:00

Rob Dominguez 120a9470ee docs: update cli migrations page

[DOCS-1094]: https://hasurahq.atlassian.net/browse/DOCS-1094?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10434
GitOrigin-RevId: ce6432073dd686a83a26b96d58f69553cac61c33

2023-11-07 11:12:41 +00:00

2.3 KiB

Raw Blame History

CLI Migrations

This docker image provides a method to run migrations and metadata at docker entrypoint. A temporary server is booted, with the migrations API allowed, securely through localhost. Once migrations and metadata have been applied, the server will reboot in a secure mode for inbound graphql usage.

See ./docker-entrypoint.sh

CLI Migrations
- Examples
  - Local
- Configuration

Examples

It is used in a docker file as:

FROM hasura/graphql-engine:<version>.cli-migrations-v3

CMD graphql-engine \
  --metadata-database-url $METADATA_DATABASE_URL \
  serve \
  --server-port $PORT \
  --enable-console

Local

This is covered in the documentation here: https://hasura.io/docs/latest/graphql/core/migrations/auto-apply-migrations.html The below Configuration will also be applicable.

Configuration

You may set the following environment variables to configure the way this image is run.

Migrations Directory (Optional)

Migrations are either mounted or built into the image.

If it has been stored in a directory other than the default then it can be configured using the following:

HASURA_GRAPHQL_MIGRATIONS_DIR (default=/hasura-migrations)

A path to the migrations directory.

Metadata Directory (Optional)

Metadata are either mounted or built into the image.