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.

Sign up for GitHub

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

Jump to bottom

WIP: create sqlx.toml format #3383

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from
Draft

WIP: create sqlx.toml format #3383

wants to merge 13 commits into from

Conversation

abonander
Copy link
Collaborator

@abonander abonander commented Jul 27, 2024 •
edited
Loading

Reference sqlx.toml: https://github.com/launchbadge/sqlx/blob/sqlx-toml/sqlx-core/src/config/reference.toml

Once this is implemented, I'm planning on starting an alpha release cycle for 0.9.0 so that we can test this. It's not expected to be a breaking change but it's a large enough feature that it should probably go in a new major release, and there's a few other breaking API changes waiting in the wings.

The keys listed here are just the ones I've identified as needed for an MVP. Other keys may be added later backwards-compatibly.

Bikeshedding checklist:

  • snake_case or kebab-case for keys?
  • macros.column_overrides should maybe be called macros.table_overrides instead?
    • since the next level in the key is the table name, not the column name?

Implementation checklist

  • [common]
    • database-url-var
      • support in query macros
      • support in sqlx-cli
      • test
  • [macros]
    • preferred-crates
      • date-time
        • test
      • numeric
        • test
    • table-overrides
      • test
    • type-overrides
      • test
  • [migrate]
    • table-name
      • support in migrate!()
      • support in sqlx-cli
      • test
    • migrations-dir
      • support in migrate!()
      • support in #[sqlx::test]?
      • support in sqlx-cli
      • test
    • ignored-chars
      • support in migrate!()
      • support in sqlx-cli
      • test
    • defaults
      • migration-type
        • test
      • migration-versioning
        • test

closes #121
closes #916
closes #3412

@abonander abonander mentioned this pull request Jul 27, 2024
Closed
@abonander abonander force-pushed the sqlx-toml branch 2 times, most recently from 2b7fdba to 46dd260 Compare July 28, 2024 01:51
@abonander abonander mentioned this pull request Jul 30, 2024
Closed
@abonander abonander force-pushed the sqlx-toml branch 7 times, most recently from fd557ad to 6c886f8 Compare August 2, 2024 03:41
@abonander abonander mentioned this pull request Aug 2, 2024
Open
This was referenced Aug 2, 2024
Closed
Merged
Open
Open
@abonander abonander mentioned this pull request Aug 21, 2024
Closed
This was referenced Aug 31, 2024
Open
Merged
@abonander abonander mentioned this pull request Sep 8, 2024
Closed
@abonander abonander added this to the 0.9.0 milestone Sep 9, 2024
@abonander abonander force-pushed the sqlx-toml branch 3 times, most recently from af39902 to b67a83b Compare September 9, 2024 07:24
@abonander abonander force-pushed the sqlx-toml branch 2 times, most recently from 496f631 to 6cc3ac0 Compare September 18, 2024 08:58
@abonander abonander mentioned this pull request Sep 18, 2024
Open
This was referenced Sep 20, 2024
Open
Open
@abonander
feat: create sqlx.toml format
439f064
@abonander
feat: add support for ignored_chars config to sqlx_core::migrate
bc7343f
@abonander
chore: test ignored_chars with U+FEFF (ZWNBSP/BOM)
03e8183 
https://en.wikipedia.org/wiki/Byte_order_mark
@abonander
refactor: make Config always compiled
54dbc33 
simplifies usage while still making parsing optional for less generated code
@abonander
refactor: add origin information to Column
806e7e6
@abonander
feat(macros): implement type_override and column_override from `s…
d610cfc 
…qlx.toml`
@abonander
refactor(sqlx.toml): make all keys kebab-case, create `macros.preferr…
be76596 
…ed-crates`
@abonander
feat: make macros aware of macros.preferred-crates
0b0d9c8
@abonander
feat: make sqlx-cli aware of database-url-var
5063fe7
@abonander
feat: teach macros about migrate.table-name, migrations-dir
d772fa1
@abonander
feat: teach macros about migrate.ignored-chars
3a0b051
@abonander
chore: delete unused source file sqlx-cli/src/migration.rs
4f9744e
@abonander
feat: teach sqlx-cli about migrate.defaults
c7bc128
@maxcountryman maxcountryman mentioned this pull request Oct 16, 2024
Closed
@slavakurilyak

This comment was marked as spam.

Sign in to view
@abonander abonander mentioned this pull request Oct 23, 2024
Closed
maxcountryman added a commit to maxcountryman/underway that referenced this pull request Oct 31, 2024
@maxcountryman
isolate underway migrations
9ac462c 
This is something of a hack to work around the fact that SQLx migrations
do not currently support specifying a schema under which the migrations
table will live.

Here we provide a search path throughout our migrations and in the
transaction that will run the migrations to ensure that migrations are
applied to `underway._sqlx_migrations`. Note that this assumes a
`public._sqlx_migrations` exists.

In the future we should be able to use `sqlx.toml` to address this more
robustly. That's expected as part of the `0.9.0` release of SQLx. Please
see: launchbadge/sqlx#3383

Closes #11
@maxcountryman maxcountryman mentioned this pull request Oct 31, 2024
Merged
maxcountryman added a commit to maxcountryman/underway that referenced this pull request Oct 31, 2024
@maxcountryman
isolate underway migrations
b1691ad 
This is something of a hack to work around the fact that SQLx migrations
do not currently support specifying a schema under which the migrations
table will live.

Here we provide a search path throughout our migrations and in the
transaction that will run the migrations to ensure that migrations are
applied to `underway._sqlx_migrations`. Note that this assumes a
`public._sqlx_migrations` exists.

In the future we should be able to use `sqlx.toml` to address this more
robustly. That's expected as part of the `0.9.0` release of SQLx. Please
see: launchbadge/sqlx#3383

Closes #11
maxcountryman added a commit to maxcountryman/underway that referenced this pull request Oct 31, 2024
@maxcountryman
isolate underway migrations
23343e4 
This is something of a hack to work around the fact that SQLx migrations
do not currently support specifying a schema under which the migrations
table will live.

Here we provide a search path throughout our migrations and in the
transaction that will run the migrations to ensure that migrations are
applied to `underway._sqlx_migrations`. Note that this assumes a
`public._sqlx_migrations` exists.

In the future we should be able to use `sqlx.toml` to address this more
robustly. That's expected as part of the `0.9.0` release of SQLx. Please
see: launchbadge/sqlx#3383

Closes #11
maxcountryman added a commit to maxcountryman/underway that referenced this pull request Oct 31, 2024
@maxcountryman
isolate underway migrations
fa060d4 
This is something of a hack to work around the fact that SQLx migrations
do not currently support specifying a schema under which the migrations
table will live.

Here we provide a search path throughout our migrations and in the
transaction that will run the migrations to ensure that migrations are
applied to `underway._sqlx_migrations`. Note that this assumes a
`public._sqlx_migrations` exists.

In the future we should be able to use `sqlx.toml` to address this more
robustly. That's expected as part of the `0.9.0` release of SQLx. Please
see: launchbadge/sqlx#3383

Closes #11
maxcountryman added a commit to maxcountryman/underway that referenced this pull request Oct 31, 2024
@maxcountryman
isolate underway migrations
5899a8f 
This is something of a hack to work around the fact that SQLx migrations
do not currently support specifying a schema under which the migrations
table will live.

Here we provide a search path throughout our migrations and in the
transaction that will run the migrations to ensure that migrations are
applied to `underway._sqlx_migrations`. Note that this assumes a
`public._sqlx_migrations` exists.

In the future we should be able to use `sqlx.toml` to address this more
robustly. That's expected as part of the `0.9.0` release of SQLx. Please
see: launchbadge/sqlx#3383

Closes #11
maxcountryman added a commit to maxcountryman/underway that referenced this pull request Oct 31, 2024
@maxcountryman
isolate underway migrations
95badb9 
This is something of a hack to work around the fact that SQLx migrations
do not currently support specifying a schema under which the migrations
table will live.

Here we provide a search path throughout our migrations and in the
transaction that will run the migrations to ensure that migrations are
applied to `underway._sqlx_migrations`. Note that this assumes a
`public._sqlx_migrations` exists.

In the future we should be able to use `sqlx.toml` to address this more
robustly. That's expected as part of the `0.9.0` release of SQLx. Please
see: launchbadge/sqlx#3383

Closes #11
maxcountryman added a commit to maxcountryman/underway that referenced this pull request Oct 31, 2024
@maxcountryman
isolate underway migrations
a3df409 
This is something of a hack to work around the fact that SQLx migrations
do not currently support specifying a schema under which the migrations
table will live.

Here we provide a search path throughout our migrations and in the
transaction that will run the migrations to ensure that migrations are
applied to `underway._sqlx_migrations`. Note that this assumes a
`public._sqlx_migrations` exists.

In the future we should be able to use `sqlx.toml` to address this more
robustly. That's expected as part of the `0.9.0` release of SQLx. Please
see: launchbadge/sqlx#3383

Closes #11
maxcountryman added a commit to maxcountryman/underway that referenced this pull request Oct 31, 2024
@maxcountryman
isolate underway migrations
f66a3b4 
This is something of a hack to work around the fact that SQLx migrations
do not currently support specifying a schema under which the migrations
table will live.

Here we provide a search path throughout our migrations and in the
transaction that will run the migrations to ensure that migrations are
applied to `underway._sqlx_migrations`. Note that this assumes a
`public._sqlx_migrations` exists.

In the future we should be able to use `sqlx.toml` to address this more
robustly. That's expected as part of the `0.9.0` release of SQLx. Please
see: launchbadge/sqlx#3383

Closes #11
maxcountryman added a commit to maxcountryman/underway that referenced this pull request Oct 31, 2024
@maxcountryman
isolate underway migrations (#44)
6a2f1f7 
This is something of a hack to work around the fact that SQLx migrations
do not currently support specifying a schema under which the migrations
table will live.

Here we provide a search path throughout our migrations and in the
transaction that will run the migrations to ensure that migrations are
applied to `underway._sqlx_migrations`. Note that this assumes a
`public._sqlx_migrations` exists.

In the future we should be able to use `sqlx.toml` to address this more
robustly. That's expected as part of the `0.9.0` release of SQLx. Please
see: launchbadge/sqlx#3383

Closes #11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
breaking
Projects
None yet
Milestone
0.9.0
2 participants
@abonander @slavakurilyak