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.
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.
If it has been stored in a directory other than the default then it can be configured using the following:
-
HASURA_GRAPHQL_METADATA_DIR(default=/hasura-metadata)A path to the metadata directory.
GraphQL Server (Optional)
Optional configuration for the server which boots during migrations.
-
HASURA_GRAPHQL_MIGRATIONS_SERVER_PORT(default=9691)Specify the port running the graphql server during execution of the migration script. It is advised that you do not specify a PORT that may be open e.g. 80/443 and the default should rarely require changing.
-
HASURA_GRAPHQL_MIGRATIONS_SERVER_TIMEOUT(default=30s)Specify the server timeout threshold.