Back to Graphql Engine

Hasura CLI: hasura migrate apply

docs/docs/hasura-cli/commands/hasura_migrate_apply.mdx

2.50.14.0 KB
Original Source

Hasura CLI: hasura migrate apply

Apply migrations on the database.

Synopsis

Migrations represent the modifications needed to reach the desired state of a database schema. Running this command will apply the migrations on the database.

Further reading:

bash
hasura migrate apply [flags]

Examples

bash
# Apply all migrations
hasura migrate apply

# Use with admin secret:
hasura migrate apply --admin-secret "<admin-secret>"

# Apply migrations on another Hasura instance:
hasura migrate apply --endpoint "<endpoint>"

# Mark migration as applied on the server and skip execution:
hasura migrate apply --skip-execution --version "<version>"

# Mark migrations as applied on the server and skip execution:
hasura migrate apply --skip-execution --up all

# Mark migrations as rollbacked on the server and skip execution:
hasura migrate apply --skip-execution --down all

# Apply a particular migration version only:
hasura migrate apply --version "<version>"

# Apply last 2 down migrations:
hasura migrate apply --down 2

# Apply only 2 up migrations:
hasura migrate apply --up 2

# Apply only a particular version
hasura migrate apply --type up --version "<version>"

# Apply all up migrations upto version 125, last applied is 100
hasura migrate apply --goto 125

# Apply all down migrations upto version 125, last applied is 150
hasura migrate apply --goto 125

# Rollback a particular version:
hasura migrate apply --type down --version "<version>"

# Rollback all migrations:
hasura migrate apply --down all

Options

sass
    --up string                   apply all or N up migration steps
    --down string                 apply all or N down migration steps
    --goto string                 apply migration chain up to to the version specified
    --version string              only apply this particular migration
    --skip-execution              skip executing the migration action, but mark them as applied
    --type string                 type of migration (up, down) to be used with version flag (default "up")
    --dry-run                     print the names of migrations which are going to be applied
    --all-databases               set this flag to attempt to apply migrations on all databases present on server
    --no-transaction              disable transaction for migration (env "HASURA_GRAPHQL_NO_TRANSACTION")
    --per-migration-transaction   enable per-migration transaction control; add '-- hasura:no-transaction' as the first line of a SQL file to run that migration without a transaction (not supported on MSSQL/BigQuery sources) (env "HASURA_GRAPHQL_PER_MIGRATION_TRANSACTION")
-h, --help                        help for apply

Options inherited from parent commands

sass
--admin-secret string            admin secret for Hasura GraphQL Engine (env "HASURA_GRAPHQL_ADMIN_SECRET")
--certificate-authority string   path to a cert file for the certificate authority (env "HASURA_GRAPHQL_CERTIFICATE_AUTHORITY")
--database-name string           database on which operation should be applied
--disable-interactive            disables interactive prompts (default: false) (env "HASURA_GRAPHQL_DISABLE_INTERACTIVE")
--endpoint string                http(s) endpoint for Hasura GraphQL Engine (env "HASURA_GRAPHQL_ENDPOINT")
--envfile string                 .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify       skip TLS verification and disable cert checking (default: false) (env "HASURA_GRAPHQL_INSECURE_SKIP_TLS_VERIFY")
--log-level string               log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO")
--no-color                       do not colorize output (default: false)
--project string                 directory where commands are executed (default: current dir)
--skip-update-check              skip automatic update check on command execution

SEE ALSO

Auto generated by spf13/cobra