Add databaseName and packageName properties for studio (#4683)

* add databaseName and packageName property for studio

* Add release notes

---------

Co-authored-by: AndriiSherman <[email protected]>

Author: RomanNabukhotnyi

changelogs/drizzle-kit/0.31.3.md

@@ -0,0 +1 @@
+- Internal changes to Studio context. Added `databaseName` and `packageName` properties for Studio

drizzle-kit/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "drizzle-kit",
-	"version": "0.31.2",
+	"version": "0.31.3",
 	"homepage": "https://orm.drizzle.team",
 	"keywords": [
 		"drizzle",

drizzle-kit/src/cli/connections.ts

@@ -27,6 +27,13 @@ export const preparePostgresDB = async (
 	credentials: PostgresCredentials,
 ): Promise<
 	DB & {
+		packageName:
+			| '@aws-sdk/client-rds-data'
+			| 'pglite'
+			| 'pg'
+			| 'postgres'
+			| '@vercel/postgres'
+			| '@neondatabase/serverless';
 		proxy: Proxy;
 		transactionProxy: TransactionProxy;
 		migrate: (config: string | MigrationConfig) => Promise<void>;
@@ -102,6 +109,7 @@ export const preparePostgresDB = async (
 			};
 
 			return {
+				packageName: '@aws-sdk/client-rds-data',
 				query,
 				proxy,
 				transactionProxy,
@@ -162,7 +170,7 @@ export const preparePostgresDB = async (
 				return results;
 			};
 
-			return { query, proxy, transactionProxy, migrate: migrateFn };
+			return { packageName: 'pglite', query, proxy, transactionProxy, migrate: migrateFn };
 		}
 
 		assertUnreachable(driver);
@@ -255,7 +263,7 @@ export const preparePostgresDB = async (
 			return results;
 		};
 
-		return { query, proxy, transactionProxy, migrate: migrateFn };
+		return { packageName: 'pg', query, proxy, transactionProxy, migrate: migrateFn };
 	}
 
 	if (await checkPackage('postgres')) {
@@ -313,7 +321,7 @@ export const preparePostgresDB = async (
 			return results;
 		};
 
-		return { query, proxy, transactionProxy, migrate: migrateFn };
+		return { packageName: 'postgres', query, proxy, transactionProxy, migrate: migrateFn };
 	}
 
 	if (await checkPackage('@vercel/postgres')) {
@@ -411,7 +419,7 @@ export const preparePostgresDB = async (
 			return results;
 		};
 
-		return { query, proxy, transactionProxy, migrate: migrateFn };
+		return { packageName: '@vercel/postgres', query, proxy, transactionProxy, migrate: migrateFn };
 	}
 
 	if (await checkPackage('@neondatabase/serverless')) {
@@ -511,7 +519,7 @@ export const preparePostgresDB = async (
 			return results;
 		};
 
-		return { query, proxy, transactionProxy, migrate: migrateFn };
+		return { packageName: '@neondatabase/serverless', query, proxy, transactionProxy, migrate: migrateFn };
 	}
 
 	console.error(
@@ -524,6 +532,7 @@ export const prepareGelDB = async (
 	credentials?: GelCredentials,
 ): Promise<
 	DB & {
+		packageName: 'gel';
 		proxy: Proxy;
 		transactionProxy: TransactionProxy;
 	}
@@ -593,7 +602,7 @@ To link your project, please refer https://docs.geldata.com/reference/cli/gel_in
 			return result;
 		};
 
-		return { query, proxy, transactionProxy };
+		return { packageName: 'gel', query, proxy, transactionProxy };
 	}
 
 	console.error(
@@ -629,6 +638,7 @@ export const connectToSingleStore = async (
 	it: SingleStoreCredentials,
 ): Promise<{
 	db: DB;
+	packageName: 'mysql2';
 	proxy: Proxy;
 	transactionProxy: TransactionProxy;
 	database: string;
@@ -686,6 +696,7 @@ export const connectToSingleStore = async (
 
 		return {
 			db: { query },
+			packageName: 'mysql2',
 			proxy,
 			transactionProxy,
 			database: result.database,
@@ -694,7 +705,7 @@ export const connectToSingleStore = async (
 	}
 
 	console.error(
-		"To connect to SingleStore database - please install 'singlestore' driver",
+		"To connect to SingleStore database - please install 'mysql2' driver",
 	);
 	process.exit(1);
 };
@@ -726,6 +737,7 @@ export const connectToMySQL = async (
 	it: MysqlCredentials,
 ): Promise<{
 	db: DB;
+	packageName: 'mysql2' | '@planetscale/database';
 	proxy: Proxy;
 	transactionProxy: TransactionProxy;
 	database: string;
@@ -795,6 +807,7 @@ export const connectToMySQL = async (
 
 		return {
 			db: { query },
+			packageName: 'mysql2',
 			proxy,
 			transactionProxy,
 			database: result.database,
@@ -846,6 +859,7 @@ export const connectToMySQL = async (
 
 		return {
 			db: { query },
+			packageName: '@planetscale/database',
 			proxy,
 			transactionProxy,
 			database: result.database,
@@ -905,7 +919,12 @@ export const connectToSQLite = async (
 	credentials: SqliteCredentials,
 ): Promise<
 	& SQLiteDB
-	& { migrate: (config: MigrationConfig) => Promise<void>; proxy: Proxy; transactionProxy: TransactionProxy }
+	& {
+		packageName: 'd1-http' | '@libsql/client' | 'better-sqlite3';
+		migrate: (config: MigrationConfig) => Promise<void>;
+		proxy: Proxy;
+		transactionProxy: TransactionProxy;
+	}
 > => {
 	if ('driver' in credentials) {
 		const { driver } = credentials;
@@ -1037,7 +1056,7 @@ export const connectToSQLite = async (
 				const result = await remoteBatchCallback(queries);
 				return result.rows;
 			};
-			return { ...db, proxy, transactionProxy, migrate: migrateFn };
+			return { ...db, packageName: 'd1-http', proxy, transactionProxy, migrate: migrateFn };
 		} else {
 			assertUnreachable(driver);
 		}
@@ -1101,7 +1120,7 @@ export const connectToSQLite = async (
 			return results;
 		};
 
-		return { ...db, proxy, transactionProxy, migrate: migrateFn };
+		return { ...db, packageName: '@libsql/client', proxy, transactionProxy, migrate: migrateFn };
 	}
 
 	if (await checkPackage('better-sqlite3')) {
@@ -1170,7 +1189,7 @@ export const connectToSQLite = async (
 			return results;
 		};
 
-		return { ...db, proxy, transactionProxy, migrate: migrateFn };
+		return { ...db, packageName: 'better-sqlite3', proxy, transactionProxy, migrate: migrateFn };
 	}
 
 	console.log(
@@ -1181,7 +1200,12 @@ export const connectToSQLite = async (
 
 export const connectToLibSQL = async (credentials: LibSQLCredentials): Promise<
 	& LibSQLDB
-	& { migrate: (config: MigrationConfig) => Promise<void>; proxy: Proxy; transactionProxy: TransactionProxy }
+	& {
+		packageName: '@libsql/client';
+		migrate: (config: MigrationConfig) => Promise<void>;
+		proxy: Proxy;
+		transactionProxy: TransactionProxy;
+	}
 > => {
 	if (await checkPackage('@libsql/client')) {
 		const { createClient } = await import('@libsql/client');
@@ -1245,7 +1269,7 @@ export const connectToLibSQL = async (credentials: LibSQLCredentials): Promise<
 			return results;
 		};
 
-		return { ...db, proxy, transactionProxy, migrate: migrateFn };
+		return { ...db, packageName: '@libsql/client', proxy, transactionProxy, migrate: migrateFn };
 	}
 
 	console.log(

drizzle-kit/src/serializer/studio.ts

@@ -50,7 +50,21 @@ type SchemaFile = {
 export type Setup = {
 	dbHash: string;
 	dialect: 'postgresql' | 'mysql' | 'sqlite' | 'singlestore';
+	packageName:
+		| '@aws-sdk/client-rds-data'
+		| 'pglite'
+		| 'pg'
+		| 'postgres'
+		| '@vercel/postgres'
+		| '@neondatabase/serverless'
+		| 'gel'
+		| 'mysql2'
+		| '@planetscale/database'
+		| 'd1-http'
+		| '@libsql/client'
+		| 'better-sqlite3';
 	driver?: 'aws-data-api' | 'd1-http' | 'turso' | 'pglite';
+	databaseName?: string; // for planetscale (driver remove database name from connection string)
 	proxy: Proxy;
 	transactionProxy: TransactionProxy;
 	customDefaults: CustomDefault[];
@@ -283,6 +297,7 @@ export const drizzleForPostgres = async (
 		dbHash,
 		dialect: 'postgresql',
 		driver: 'driver' in credentials ? credentials.driver : undefined,
+		packageName: db.packageName,
 		proxy: db.proxy,
 		transactionProxy: db.transactionProxy,
 		customDefaults,
@@ -299,7 +314,7 @@ export const drizzleForMySQL = async (
 	schemaFiles?: SchemaFile[],
 ): Promise<Setup> => {
 	const { connectToMySQL } = await import('../cli/connections');
-	const { proxy, transactionProxy } = await connectToMySQL(credentials);
+	const { proxy, transactionProxy, database, packageName } = await connectToMySQL(credentials);
 
 	const customDefaults = getCustomDefaults(mysqlSchema);
 
@@ -317,6 +332,8 @@ export const drizzleForMySQL = async (
 	return {
 		dbHash,
 		dialect: 'mysql',
+		packageName,
+		databaseName: database,
 		proxy,
 		transactionProxy,
 		customDefaults,
@@ -356,6 +373,7 @@ export const drizzleForSQLite = async (
 		dbHash,
 		dialect: 'sqlite',
 		driver: 'driver' in credentials ? credentials.driver : undefined,
+		packageName: sqliteDB.packageName,
 		proxy: sqliteDB.proxy,
 		transactionProxy: sqliteDB.transactionProxy,
 		customDefaults,
@@ -383,6 +401,7 @@ export const drizzleForLibSQL = async (
 		dbHash,
 		dialect: 'sqlite',
 		driver: undefined,
+		packageName: sqliteDB.packageName,
 		proxy: sqliteDB.proxy,
 		transactionProxy: sqliteDB.transactionProxy,
 		customDefaults,
@@ -399,7 +418,7 @@ export const drizzleForSingleStore = async (
 	schemaFiles?: SchemaFile[],
 ): Promise<Setup> => {
 	const { connectToSingleStore } = await import('../cli/connections');
-	const { proxy, transactionProxy } = await connectToSingleStore(credentials);
+	const { proxy, transactionProxy, database, packageName } = await connectToSingleStore(credentials);
 
 	const customDefaults = getCustomDefaults(singlestoreSchema);
 
@@ -417,6 +436,8 @@ export const drizzleForSingleStore = async (
 	return {
 		dbHash,
 		dialect: 'singlestore',
+		databaseName: database,
+		packageName,
 		proxy,
 		transactionProxy,
 		customDefaults,
@@ -580,8 +601,19 @@ export type Server = {
 };
 
 export const prepareServer = async (
-	{ dialect, driver, proxy, transactionProxy, customDefaults, schema: drizzleSchema, relations, dbHash, schemaFiles }:
-		Setup,
+	{
+		dialect,
+		driver,
+		packageName,
+		databaseName,
+		proxy,
+		transactionProxy,
+		customDefaults,
+		schema: drizzleSchema,
+		relations,
+		dbHash,
+		schemaFiles,
+	}: Setup,
 	app?: Hono,
 ): Promise<Server> => {
 	app = app !== undefined ? app : new Hono();
@@ -644,13 +676,15 @@ export const prepareServer = async (
 			}
 
 			return c.json({
-				version: '6.1',
+				version: '6.2',
 				dialect,
 				driver,
+				packageName,
 				schemaFiles,
 				customDefaults: preparedDefaults,
 				relations,
 				dbHash,
+				databaseName,
 			});
 		}