Make name field in migration JSON optional
#744
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If the migration JSON does not specify a `name` field, the migration name will be set to the base filename without the extension.
Ensure that using a migration file without the `name` field will use the filename as the migration name.
It's ok to generate migrations without names now.
557c6d5 to
11f02d2
Compare
kvch
approved these changes
Mar 25, 2025
andrew-farries
added a commit
that referenced
this pull request
May 21, 2025
Remove support for specifying a `name` field in migration files:
```yaml
name: 01_some_migration # <-- no longer supported
operations:
- create_table:
name: products
columns:
- name: id
type: serial
pk: true
- name: name
type: varchar(255)
```
The migration filename is the source of truth for the migration name.
The `name` field was made optional and its use discouraged in the
documentation in #744. This PR removes support for it entirely.
⚠️ **Warning**
**This is a breaking change:** migration files that set the `name` field
will not be runnable by `pgroll` until the `name` field is removed.
Because of #812 `pgroll pull` and
`pgroll migrate` will still work with migration histories that contain
migrations with `name` fields.
The easiest way to remove the `name` fields from all migrations in the
history is to `pgroll pull` the migration history; this will serialize
all migrations in the remote history, removing the any `name` fields.
---
Closes #715 and #850
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Make the
namefield in a migration JSON file optional.If a
nameis not provided, the migration filename (minus the.jsonsuffix) is used as the migration name.{ "name": "02_create_another_table", <-- no longer required "operations": [ { "create_table": { "name": "products", "columns": [ { "name": "id", "type": "serial", "pk": true }, { "name": "name", "type": "varchar(255)", "unique": true }, { "name": "price", "type": "decimal(10,2)" } ] } } ] }The
--nameflag topgroll convertis also changed to default to empty (rather than the current timestamp) as part of this change.Closes #715