Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

db: fix consistency to reflect the change from migrationsTable to table #2171

Merged

Conversation

mirko-pira
Copy link
Contributor

The change aims to simplify and make the configuration more intuitive, eliminating ambiguity and improving property naming consistency.

📝 docs(db): update configuration.md and config.d.ts to reflect the change from migrationsTable to table

💡 refactor(schema.js): remove migrationsTable from the migrations object and add table with description and default value The migrationsTable property in the PlatformaticDB interface and the migrationsTable field in the migrations object have been renamed to table to improve consistency and clarity. The table property now represents the table created to track the schema version. The documentation and type definitions have been updated accordingly.

🔎 Use-case:
In scenarios prior to the update, developers configured the database migration tracking by specifying the migrationsTable property in the migration configuration object. This approach does not work. The configuration requires using the table attribute within the migrations object to define the name of the migrations table.

…ange from migrationsTable to table

💡 refactor(schema.js): remove migrationsTable from the migrations object and add table with description and default value
The `migrationsTable` property in the `PlatformaticDB` interface and the `migrationsTable` field in the `migrations` object have been renamed to `table` to improve consistency and clarity. The `table` property now represents the table created to track the schema version. The documentation and type definitions have been updated accordingly.
…ange from migrationsTable to table

💡 refactor(schema.js): remove migrationsTable from the migrations object and add table with description and default value
The `migrationsTable` property in the `PlatformaticDB` interface and the `migrationsTable` field in the `migrations` object have been renamed to `table` to improve consistency and clarity. The `table` property now represents the table created to track the schema version. The documentation and type definitions have been updated accordingly.

Signed-off-by: Mirko Pira <mp@mirkodev.com>
…thub.com/mirko-pira/platformatic into fix/improve-consistency-migrations-table

Signed-off-by: Mirko Pira <mp@mirkodev.com>
@mcollina
Copy link
Member

Good spot! Can you fix the DCO (instructions by clicking on details).

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

…thub.com/mirko-pira/platformatic into fix/improve-consistency-migrations-table

DCO Remediation Commit for Mirko Pira <mp@mirkodev.com>

I, Mirko Pira <mp@mirkodev.com>, hereby add my Signed-off-by to this commit: e611bea

Signed-off-by: Mirko Pira <mp@mirkodev.com>
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@mcollina mcollina merged commit 26e6057 into platformatic:main Feb 29, 2024
90 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants