How can I use Drizzle Studio with Cloudflare D1 in local environment (connect to D1 local instance)

[JH365]

I am using Drizzle and Cloudflare D1 in my project and I like Drizzle a lot. And while I was trying Drizzle Studio, I found it connected to live database instead of local dev environment. I'd like to know if there is a way to connect to D1 local instance?

[rusintez]

Gm @JH365,

please check this excerpt of drizzle-kit code for hints :P

// src/orm-extenstions/d1-driver/wrangler-client.ts
var wrangler_client_exports = {};
__export(wrangler_client_exports, {
  execute: () => execute
});
async function execute(query, configPath, dbName) {
  try {
    const response = await $`NO_D1_WARNING=true wrangler d1 execute ${dbName} --config=${configPath} --command=${query} --json`;
    return { results: JSON.parse(response.stdout)[0].results };
  } catch (e) {
    try {
      await $`NO_D1_WARNING=true wrangler d1 execute ${dbName} --config=${configPath} --command=${query}`;
    } catch (e1) {
      throw new Error(e1.stdout);
    }
    throw e;
  }
}

[jwhits]

I am having the same issue, and I still don't get how I can pass the --local flag

[ProximaB]

I have the same problem.
We should probably address this by enabling the passing of additional options to the Drizzle-Kit Studio cli.
drizzle-kit studio --local
This adjustment could have a broader impact and would create some assumptions on how to develop similar features. But to postpone that, without going outside d1-driver context we could just extend d1 config definition. Till you decide if/how you want to handle this kind of cases.

{
    driver: "d1";
    dbCredentials: {
        wranglerConfigPath: string;
        dbName: string;
        local:bool
    };
}

[flexchar]

Looking at this code snippet, one could simply append dbName with --local

[OJFord]

Code injection as a feature, nice 😅

[flexchar]

Is there a clear consensus on how this should be addressed now? :)

[ProximaB]

Unfortunately drizzle-kit is not open sourced. I wasn't aware of that.
There is already posted similar issue with workaround from November last year.

const localConfig = {
  schema: "./schema/db/index.ts",
  driver: "better-sqlite",
  dbCredentials: {
    url: process.env.DB_URL!,
  },
} satisfies Config;

export default process.env.NODE_ENV === "production" ? cloudflareConfig : localConfig;

drizzle-team/drizzle-kit-mirror#242

[flexchar]

Have you experienced Mapping SQL input into an array of statements error bubbling from Wrangler when trying to use Drizzle Studio?

[ajzbc]

Came up with a similar temp solution

{
  "scripts": {
    "db:studio": "cross-env LOCAL_DB_PATH=$(find .wrangler/state/v3/d1/miniflare-D1DatabaseObject -type f -name '*.sqlite' -print -quit) drizzle-kit studio"
  }
}

Instead of specifying the sqlite file path, just grabbing the path of the *.sqlite file in .wrangler/state/v3/d1/miniflare-D1DatabaseObject

import type { Config } from 'drizzle-kit';

export default process.env.LOCAL_DB_PATH
	? ({
			schema: './src/db/schema.ts',
			driver: 'better-sqlite',
			dbCredentials: {
				url: process.env.LOCAL_DB_PATH!
			}
		} satisfies Config)
	: ({
			schema: './src/db/schema.ts',
			out: './drizzle',
			driver: 'd1',
			dbCredentials: {
				wranglerConfigPath: 'wrangler.toml',
				dbName: 'NAME'
			}
		} satisfies Config);

Haven't been able to get it working with the remote D1 db though drizzle-team/drizzle-kit-mirror#289

[clibequilibrium]

Joining the thread to get it working on Windows.

Create start-studio.ps1 with this content

$env:DB_URL=(Get-ChildItem .wrangler\state\v3\d1\miniflare-D1DatabaseObject\*.sqlite).FullName
drizzle-kit studio

drizzle.config.ts

export default {
	schema: './src/lib/server/schema.ts',
	out: './migrations',
	driver: 'better-sqlite',
	dbCredentials: {
		url: process.env.DB_URL!
	}
} satisfies Config;

package.json

  "scripts": {
    "db:studio": "powershell -ExecutionPolicy Bypass -File start-studio.ps1",
  },

Repeat the same steps for unix environment or use cross-env

[carloslato]

Thanks, work for me in windows but with a little modification to prevent duplication of string db route

$env:LOCAL_DB_PATH = ((Get-ChildItem .wrangler\state\v3\d1\miniflare-D1DatabaseObject*.sqlite | Select-Object -First 1).FullName)

[third774]

Thanks for sharing the tips, y'all! Here's the solution I came up with piecing everything together. I'm overall pretty happy with it since I can use Drizzle Studio with my local db, the preview db (for pages previews), and the prod db.

https://kevinkipp.com/blog/going-full-stack-on-astro-with-cloudflare-d1-and-drizzle/

[KyGuy2002]

I found what I think is generating this, looks like its a hash based on the db name.
https://gist.github.com/KyGuy2002/1c70a5129042f1b037c56fe0b70b066e

[KyGuy2002]

Ok, yea so it uses the binding as the "name", that means that the actual name or UUID of the database is not involved.
Heres a nodejs script that will convert a binding to a hash:
https://gist.github.com/KyGuy2002/8ff7313f2c5bf00d7375dec1ebbef807

If using the default "DB" binding, the filename will always be "e7352547963de7050bd7d94658afc4fe78b61811b7815da12d90be8e863abf4d.sqlite"

[chiubaca]

@third774 thanks for your write up! so handy. Would it be possible for you to include an example of what your .env file looks like? ty! 🙏🏼

[third774]

@chiubaca I don't have a .env file! Everything is in the wrangler.toml file and auth is handled by wrangler.

[chiubaca]

ah i see... gotcha. Thanks for the clarification!