drizzle-orm icon indicating copy to clipboard operation
drizzle-orm copied to clipboard

[FEATURE]:Support multiple branch development ?

Open abcfy2 opened this issue 2 years ago • 1 comments

Describe what you want

When we develop on different branches, will cause migrate sql lost when merge.

This because of the sql:

Query: CREATE SCHEMA IF NOT EXISTS "drizzle"
Query: 
			CREATE TABLE IF NOT EXISTS "drizzle"."__drizzle_migrations" (
				id SERIAL PRIMARY KEY,
				hash text NOT NULL,
				created_at bigint
			)
		
Query: select id, hash, created_at from "drizzle"."__drizzle_migrations" order by created_at desc limit 1
Query: begin
Query: commit

When I generate migrate sql on different branches, will cause conflict. See the final result:

❯ tree drizzle
drizzle
├── 0000_calm_talos.sql
├── 0001_reflective_malice.sql
├── 0002_careful_northstar.sql
├── 0003_blushing_martin_li.sql
├── 0004_bumpy_katie_power.sql
├── 0004_even_cyclops.sql
├── 0006_luxuriant_bloodscream.sql
└── meta
    ├── 0000_snapshot.json
    ├── 0001_snapshot.json
    ├── 0002_snapshot.json
    ├── 0003_snapshot.json
    ├── 0004_snapshot.json
    ├── 0006_snapshot.json
    └── _journal.json

2 directories, 14 files

You can see there're 2 0004_ sqls here.

So if 0004_even_cyclops.sql first migrate, then merge branch with file 0004_bumpy_katie_power.sql, will cause 0004_bumpy_katie_power.sql never execute, this because the sql of migrate:

select id, hash, created_at from "drizzle"."__drizzle_migrations" order by created_at desc limit 1

I hope you can support multiple branches development. Thanks.

abcfy2 avatar Sep 14 '23 03:09 abcfy2

Hi, any updates on that? How should we work with migrations if multiple developers are working in various branches and creating migrations?

croshim avatar Aug 06 '24 16:08 croshim

Any updates here? I've run into this a few times in my project and the biggest problem in my experience is conflicts in the snapshots and journals. They are really hard to reconcile in git because of unique keys and you end up with duplicate migrations because of it. Even just a "squash" and "fake" to make cleanup work after a bunch of churn would be a good starting point. I'm not sure if prior art is helpful, but Django ORM is incredible at reconciling branches of migrations.

kevinob11 avatar Dec 04 '24 19:12 kevinob11

To avoid multi-branch migration issues, I use a dedicated branch, "drizzle-migration".

And in our package.json script, I use commands such has this:

"check-branch": "node src/lib/check-branch.mjs",
"migrations:pull-dev": "pnpm run check-branch --branchName=drizzle-migration --command=\"npx drizzle-kit pull --config=drizzle-dev.config.ts\""

simon5454 avatar Apr 04 '25 01:04 simon5454

Bumping this issue. This is a pretty critical component to being able to use drizzle on larger teams.

JacobReynolds avatar May 06 '25 14:05 JacobReynolds

Hey everyone!

I've created this message to send in a batch to all opened issues we have, just because there are a lot of them and I want to update all of you with our current work, why issues are not responded to, and the amount of work that has been done by our team over ~8 months.

I saw a lot of issues with suggestions on how to fix something while we were not responding – so thanks everyone. Also, thanks to everyone patiently waiting for a response from us and continuing to use Drizzle!

We currently have 4 major branches with a lot of work done. Each branch was handled by different devs and teams to make sure we could make all the changes in parallel.


First branch is drizzle-kit rewrite

All of the work can be found on the alternation-engine branch. Here is a PR with the work done: https://github.com/drizzle-team/drizzle-orm/pull/4439

As you can see, it has 167k added lines of code and 67k removed, which means we've completely rewritten the drizzle-kit alternation engine, the way we handle diffs for each dialect, together with expanding our test suite from 600 tests to ~9k test units for all different types of actions you can do with kit. More importantly, we changed the migration folder structure and made commutative migrations, so you won't face complex conflicts on migrations when working in a team.

What's left here:

  • We are finishing handling defaults for Postgres, the last being geometry (yes, we fixed the srid issue here as well).
  • We are finishing commutative migrations for all dialects.
  • We are finishing up the command, so the migration flow will be as simple as drizzle-kit up for you.

Where it brings us:

  • We are getting drizzle-kit into a new good shape where we can call it [email protected]!

Timeline:

  • We need ~2 weeks to finish all of the above and send this branch to beta for testing.

Second big branch is a complex one with several HUGE updates

  • Bringing Relational Queries v2 finally live. We've done a lot of work here to actually make it faster than RQBv1 and much better from a DX point of view. But in implementing it, we had to make another big rewrite, so we completely rewrote the drizzle-orm type system, which made it much simpler and improved type performance by ~21.4x:
(types instantiations for 3300 lines production drizzle schema + 990 lines relations)

TS v5.8.3: 728.8k -> 34.1k
TS v5.9.2: 553.7k -> 25.4k

You can read more about it here.

What's left here:

Where it brings us:

  • We are getting drizzle-orm into a new good shape where we can call it [email protected]!

Breaking changes:

  • We will have them, but we will have open channels for everyone building on top of drizzle types, so we can guide you through all the changes.

Third branch is adding support for CockroachDB and MSSQL dialects

Support for them is already in the alternation-engine branch and will be available together with the drizzle-kit rewrite.

Summary

All of the work we are doing is crucial and should be done sooner rather than later. We've received a lot of feedback and worked really hard to find the best strategies and decisions for API, DX, architecture, etc., so we can confidently mark it as v1 and be sure we can improve it and remain flexible for all the features you are asking for, while becoming even better for everyone building on top of the drizzle API as well.

We didn't want to stay with some legacy decisions and solutions we had, and instead wanted to shape Drizzle in a way that will be best looking ahead to 2025–2026 trends (v1 will get proper effect support, etc.).

We believe that all of the effort we've put in will boost Drizzle and benefit everyone using it.

Thanks everyone, as we said, we are here to stay for a long time to build a great tool together!

Timelines

We are hoping to get v1 for drizzle in beta this fall and same timeline for latest. Right after that we can go through all of the issues and PRs and resond everyone. v1 for drizzle should close ~70% of all the bug tickets we have, so on beta release we will start marking them as closed!

AndriiSherman avatar Aug 30 '25 18:08 AndriiSherman