Skip to content

Commit

Permalink
schema/apply: update inputs and doc for URL (#241)
Browse files Browse the repository at this point in the history
  • Loading branch information
giautm committed Sep 24, 2024
1 parent e8b9e79 commit 3568c22
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ Apply migrations to a database.

All inputs are optional as they may be specified in the Atlas configuration file.

* `url` - The URL of the target database. For example: `mysql://root:pass@localhost:3306/dev`.
* `url` - The URL of the target database. For example: `mysql://root:pass@localhost:3306/prod`.
* `dir` - The URL of the migration directory to apply. For example: `atlas://dir-name` for cloud
based directories or `file://migrations` for local ones.
* `config` - The URL of the Atlas configuration file. By default, Atlas will look for a file
Expand Down Expand Up @@ -346,6 +346,7 @@ Apply a declarative migrations to a database.
#### Inputs

* `to` - The URL(s) of the desired schema state.
* `url` - The URL of the target database. For example: `mysql://root:pass@localhost:3306/prod`.
* `plan` - Optional plan file to use for applying the migrations. For example: `atlas://<schema>/plans/<id>`.
* `dry-run` - Print SQL (and optional analysis) without executing it. Either `true` or `false`. Defaults to `false`.
* `auto-approve` - Automatically approve and apply changes. Either `true` or `false`. Defaults to `false`.
Expand Down
4 changes: 4 additions & 0 deletions schema/apply/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ inputs:
description: |
URL(s) of the desired schema state.
required: false
url:
description: |
The URL of the target database to apply changes to. For example: `mysql://root:pass@localhost:3306/prod`.
required: false
plan:
description: The plan to apply. For example, `atlas://<schema>/plans/<id>`.
required: false
Expand Down

0 comments on commit 3568c22

Please sign in to comment.