[BUG]: Drizzle doesn't use the schema part of a database connection URL
What version of drizzle-orm are you using?
0.31.0
What version of drizzle-kit are you using?
0.22.1
Describe the Bug
I have the following DATABASE_URL in my .env file:
DATABASE_URL=postgresql://x:x@localhost:5433/x?schema=x
When I'm trying to run
npx drizzle-kit introspect
it incorrectly uses the public schema of my database (which is empty).
I tried using --schemaFilter which I thought would solve this problem but I received a very lengthy Zod error instead of a human-readable error message. This blocks any further progress WRT to migrating to Drizzle as I can't generate the Drizzle types.
I checked and there is also no option to set a schema in the Drizzle config.
Expected behavior
Either url should be used correctly or I should be able to pass a schema field in the Config.
Environment & setup
VS Code / pnpm / the usual suspects
I've also tried using introspect with --schemaFilter argument, but I always get
path: [ 'schemaFilter' ], message: 'Invalid input'
I've tried --schemaFilter ["tables"] --schemaFilter 'tables' --schemaFilter "tables" and a few others, but none worked.
How could I filter on schema when doing introspect?
Edit: part of the error message:
"code": "invalid_type",
"expected": "string",
"received": "boolean",
"path": [
"schemaFilter"
],
"message": "Expected string, received boolean"
Edit (2): I see that you can define "schemaFilter: 'tables'," in the config file, that seems to work. The CLI still seems to be bugged.
up. Hoping this gets addressed soon I encounter the same issue, I'm forced to use public schema for the project I'm working on.
Specifying the schema in the DB URL intentionally doesn't do anything. The fact that schemasFilter throws an error is an issue though.
For postgres you need to use the following syntax:
postgres://<username>:<password>@<host>:<port>/<db>?search_path=<schema>
But what I would recommend is using schemaFilter: [<schema>] in the drizzle config and leaving ?search_path=<schema> out of the connection URL.
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
sridissue 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 upfor 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:
- We have 1 issue with TS that is already in progress of being fixed. The issue and Post about fixing.
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!