Merge pull request #4173 from drizzle-team/beta

Beta

Author: AndriiSherman

changelogs/drizzle-kit/0.30.5.md

@@ -0,0 +1,30 @@
+# New Features 
+
+## Added `Gel` dialect support and `gel-js` client support
+
+Drizzle is getting a new `Gel` dialect with its own types and Gel-specific logic. In this first iteration, almost all query-building features have been copied from the `PostgreSQL` dialect since Gel is fully PostgreSQL-compatible. The only change in this iteration is the data types. The Gel dialect has a different set of available data types, and all mappings for these types have been designed to avoid any extra conversions on Drizzle's side. This means you will insert and select exactly the same data as supported by the Gel protocol.
+
+Drizzle + Gel integration will work only through `drizzle-kit pull`. Drizzle won't support `generate`, `migrate`, or `push` features in this case. Instead, drizzle-kit is used solely to pull the Drizzle schema from the Gel database, which can then be used in your `drizzle-orm` queries.
+
+The Gel + Drizzle workflow:
+
+1. Use the `gel` CLI to manage your schema.
+2. Use the `gel` CLI to generate and apply migrations to the database.
+3. Use drizzle-kit to pull the Gel database schema into a Drizzle schema.
+4. Use drizzle-orm with gel-js to query the Gel database.
+
+On the drizzle-kit side you can now use `dialect: "gel"`
+
+```ts
+// drizzle.config.ts
+import { defineConfig } from 'drizzle-kit';
+
+export default defineConfig({
+  dialect: 'gel',
+});
+```
+
+For a complete Get Started tutorial you can use our new guides:
+
+- [Get Started with Drizzle and Gel in a new project](https://orm.drizzle.team/docs/get-started/gel-new)
+- [Get Started with Drizzle and Gel in a existing project](https://orm.drizzle.team/docs/get-started/gel-existing)

changelogs/drizzle-orm/0.40.0.md

@@ -0,0 +1,43 @@
+# New Features 
+
+## Added `Gel` dialect support and `gel-js` client support
+
+Drizzle is getting a new `Gel` dialect with its own types and Gel-specific logic. In this first iteration, almost all query-building features have been copied from the `PostgreSQL` dialect since Gel is fully PostgreSQL-compatible. The only change in this iteration is the data types. The Gel dialect has a different set of available data types, and all mappings for these types have been designed to avoid any extra conversions on Drizzle's side. This means you will insert and select exactly the same data as supported by the Gel protocol.
+
+Drizzle + Gel integration will work only through `drizzle-kit pull`. Drizzle won't support `generate`, `migrate`, or `push` features in this case. Instead, drizzle-kit is used solely to pull the Drizzle schema from the Gel database, which can then be used in your `drizzle-orm` queries.
+
+The Gel + Drizzle workflow:
+
+1. Use the `gel` CLI to manage your schema.
+2. Use the `gel` CLI to generate and apply migrations to the database.
+3. Use drizzle-kit to pull the Gel database schema into a Drizzle schema.
+4. Use drizzle-orm with gel-js to query the Gel database.
+
+Here is a small example of how to connect to Gel using Drizzle:
+
+```typescript copy
+// Make sure to install the 'gel' package 
+import { drizzle } from "drizzle-orm/gel";
+import { createClient } from "gel";
+
+const gelClient = createClient();
+const db = drizzle({ client: gelClient });
+
+const result = await db.execute('select 1');
+```
+
+On the drizzle-kit side you can now use `dialect: "gel"`
+
+```ts
+// drizzle.config.ts
+import { defineConfig } from 'drizzle-kit';
+
+export default defineConfig({
+  dialect: 'gel',
+});
+```
+
+For a complete Get Started tutorial you can use our new guides:
+
+- [Get Started with Drizzle and Gel in a new project](https://orm.drizzle.team/docs/get-started/gel-new)
+- [Get Started with Drizzle and Gel in a existing project](https://orm.drizzle.team/docs/get-started/gel-existing)

drizzle-kit/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "drizzle-kit",
-	"version": "0.30.4",
+	"version": "0.30.5",
 	"homepage": "https://orm.drizzle.team",
 	"keywords": [
 		"drizzle",
@@ -46,7 +46,8 @@
 		"@drizzle-team/brocli": "^0.10.2",
 		"@esbuild-kit/esm-loader": "^2.5.5",
 		"esbuild": "^0.19.7",
-		"esbuild-register": "^3.5.0"
+		"esbuild-register": "^3.5.0",
+		"gel": "^2.0.0"
 	},
 	"devDependencies": {
 		"@arethetypeswrong/cli": "^0.15.3",
@@ -114,7 +115,7 @@
 		"wrangler": "^3.22.1",
 		"ws": "^8.16.0",
 		"zod": "^3.20.2",
-		"zx": "^7.2.2"
+		"zx": "^8.3.2"
 	},
 	"exports": {
 		".": {

drizzle-kit/src/cli/commands/introspect.ts

@@ -4,12 +4,15 @@ import { render, renderWithTask } from 'hanji';
 import { Minimatch } from 'minimatch';
 import { join } from 'path';
 import { plural, singular } from 'pluralize';
+import { GelSchema } from 'src/serializer/gelSchema';
 import { drySingleStore, SingleStoreSchema, squashSingleStoreScheme } from 'src/serializer/singlestoreSchema';
 import { assertUnreachable, originUUID } from '../../global';
+import { schemaToTypeScript as gelSchemaToTypeScript } from '../../introspect-gel';
 import { schemaToTypeScript as mysqlSchemaToTypeScript } from '../../introspect-mysql';
 import { paramNameFor, schemaToTypeScript as postgresSchemaToTypeScript } from '../../introspect-pg';
 import { schemaToTypeScript as singlestoreSchemaToTypeScript } from '../../introspect-singlestore';
 import { schemaToTypeScript as sqliteSchemaToTypeScript } from '../../introspect-sqlite';
+import { fromDatabase as fromGelDatabase } from '../../serializer/gelSerializer';
 import { dryMySql, MySqlSchema, squashMysqlScheme } from '../../serializer/mysqlSchema';
 import { fromDatabase as fromMysqlDatabase } from '../../serializer/mysqlSerializer';
 import { dryPg, type PgSchema, squashPgScheme } from '../../serializer/pgSchema';
@@ -27,6 +30,7 @@ import {
 import { prepareOutFolder } from '../../utils';
 import { Entities } from '../validations/cli';
 import type { Casing, Prefix } from '../validations/common';
+import { GelCredentials } from '../validations/gel';
 import { LibSQLCredentials } from '../validations/libsql';
 import type { MysqlCredentials } from '../validations/mysql';
 import type { PostgresCredentials } from '../validations/postgres';
@@ -174,6 +178,132 @@ export const introspectPostgres = async (
 	process.exit(0);
 };
 
+export const introspectGel = async (
+	casing: Casing,
+	out: string,
+	breakpoints: boolean,
+	credentials: GelCredentials | undefined,
+	tablesFilter: string[],
+	schemasFilter: string[],
+	prefix: Prefix,
+	entities: Entities,
+) => {
+	const { prepareGelDB } = await import('../connections');
+	const db = await prepareGelDB(credentials);
+
+	const matchers = tablesFilter.map((it) => {
+		return new Minimatch(it);
+	});
+
+	const filter = (tableName: string) => {
+		if (matchers.length === 0) return true;
+
+		let flags: boolean[] = [];
+
+		for (let matcher of matchers) {
+			if (matcher.negate) {
+				if (!matcher.match(tableName)) {
+					flags.push(false);
+				}
+			}
+
+			if (matcher.match(tableName)) {
+				flags.push(true);
+			}
+		}
+
+		if (flags.length > 0) {
+			return flags.every(Boolean);
+		}
+		return false;
+	};
+
+	const progress = new IntrospectProgress(true);
+
+	const res = await renderWithTask(
+		progress,
+		fromGelDatabase(
+			db,
+			filter,
+			schemasFilter,
+			entities,
+			(stage, count, status) => {
+				progress.update(stage, count, status);
+			},
+		),
+	);
+
+	const schema = { id: originUUID, prevId: '', ...res } as GelSchema;
+	const ts = gelSchemaToTypeScript(schema, casing);
+	const relationsTs = relationsToTypeScript(schema, casing);
+	const { internal, ...schemaWithoutInternals } = schema;
+
+	const schemaFile = join(out, 'schema.ts');
+	writeFileSync(schemaFile, ts.file);
+	const relationsFile = join(out, 'relations.ts');
+	writeFileSync(relationsFile, relationsTs.file);
+	console.log();
+
+	// const { snapshots, journal } = prepareOutFolder(out, 'gel');
+
+	// if (snapshots.length === 0) {
+	// 	const { sqlStatements, _meta } = await applyGelSnapshotsDiff(
+	// 		squashGelScheme(dryGel),
+	// 		squashGelScheme(schema),
+	// 		schemasResolver,
+	// 		enumsResolver,
+	// 		sequencesResolver,
+	// 		policyResolver,
+	// 		indPolicyResolver,
+	// 		roleResolver,
+	// 		tablesResolver,
+	// 		columnsResolver,
+	// 		viewsResolver,
+	// 		dryPg,
+	// 		schema,
+	// 	);
+
+	// 	writeResult({
+	// 		cur: schema,
+	// 		sqlStatements,
+	// 		journal,
+	// 		_meta,
+	// 		outFolder: out,
+	// 		breakpoints,
+	// 		type: 'introspect',
+	// 		prefixMode: prefix,
+	// 	});
+	// } else {
+	// 	render(
+	// 		`[${
+	// 			chalk.blue(
+	// 				'i',
+	// 			)
+	// 		}] No SQL generated, you already have migrations in project`,
+	// 	);
+	// }
+
+	render(
+		`[${
+			chalk.green(
+				'✓',
+			)
+		}] Your schema file is ready ➜ ${chalk.bold.underline.blue(schemaFile)} 🚀`,
+	);
+	render(
+		`[${
+			chalk.green(
+				'✓',
+			)
+		}] Your relations file is ready ➜ ${
+			chalk.bold.underline.blue(
+				relationsFile,
+			)
+		} 🚀`,
+	);
+	process.exit(0);
+};
+
 export const introspectMysql = async (
 	casing: Casing,
 	out: string,