Skip to content

Conversation

@joc-a
Copy link
Contributor

@joc-a joc-a commented Dec 12, 2024

Description

Summary of the change: Deprecate functions that should be replaced by migrations

Detailed description:

  • Why: These schema-altering functions will be replaced by migrations.
  • How: Added WARNING deprecation level to the functions.

Type of Change

Please mark the relevant options with an "X":

  • Bug fix
  • New feature
  • Documentation update
  • Other - deprecation

Updates/remove existing public API methods:

  • Is breaking change

Affected databases:

  • MariaDB
  • Mysql5
  • Mysql8
  • Oracle
  • Postgres
  • SqlServer
  • H2
  • SQLite

Checklist

  • Unit tests are in place
  • The build is green (including the Detekt check)
  • All public methods affected by my PR has up to date API docs
  • Documentation for my change is up to date

Related Issues

EXPOSED-101

@joc-a joc-a marked this pull request as ready for review December 12, 2024 22:44
@joc-a joc-a requested review from e5l and obabichevjb December 12, 2024 22:45
@joc-a joc-a changed the title chore: Deprecate functions that should be replaced by migration functions chore: Deprecate functions that should be replaced by migrations Dec 12, 2024
Copy link
Member

@e5l e5l left a comment

Choose a reason for hiding this comment

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

lgtm

@bog-walk bog-walk merged commit d763e8e into main Jan 7, 2025
5 checks passed
@williamboxhall
Copy link

@joc-a is the plan to eventually delete this function, or will it stay there just deprecated?

We find this method especially useful since we have an event-sourced system, and we use this to conveniently generate our non-source-of-truth projection tables. If something we to go wrong, we wouldn't be losing data, and could rebuild these projections easily. We'd love it if this method could stay in the API so that we don't need to bring in a migration system since it fits so well for our use case.

Thank you 🙏🏻

@e5l
Copy link
Member

e5l commented Mar 3, 2025

The schema util is going to stay with all functions inside. The message is here to indicate that this function doesn't generate a migration file, and you should avoid using it in production.

@e5l e5l deleted the joc/deprecate-pre-migration-function branch March 3, 2025 05:48
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.

6 participants