Add blob column type to singlestore

drizzle-kit/src/introspect-singlestore.ts

@@ -30,8 +30,8 @@ const singlestoreImportsList = new Set([
 	'float',
 	'int',
 	'json',
+	'blob',
 	// TODO: add new type BSON
-	// TODO: add new type Blob
 	// TODO: add new type UUID
 	// TODO: add new type GUID
 	// TODO: add new type Vector
@@ -789,6 +789,12 @@ const column = (
 		return out;
 	}
 
+	if (lowered === 'blob') {
+		let out = `${casing(name)}: blob(${dbColumnName({ name, casing: rawCasing })})`;
+		out += defaultValue ? `.default(${mapColumnDefault(defaultValue)})` : '';
+		return out;
+	}
+
 	console.log('uknown', type);
 	return `// Warning: Can't parse ${type} from database\n\t// ${type}Type: ${type}("${name}")`;
 };

drizzle-kit/src/serializer/singlestoreSerializer.ts

@@ -129,6 +129,8 @@ export const generateSingleStoreSnapshot = (
 				} else {
 					if (typeof column.default === 'string') {
 						columnToSet.default = `'${column.default}'`;
+					} else if (typeof column.default === 'bigint') {
+						columnToSet.default = Number(column.default);
 					} else {
 						if (sqlTypeLowered === 'json') {
 							columnToSet.default = `'${JSON.stringify(column.default)}'`;
@@ -150,9 +152,6 @@ export const generateSingleStoreSnapshot = (
 							columnToSet.default = column.default;
 						}
 					}
-					// if (['blob', 'text', 'json'].includes(column.getSQLType())) {
-					// 	columnToSet.default = `(${columnToSet.default})`;
-					// }
 				}
 			}
 			columnsObject[column.name] = columnToSet;

drizzle-kit/tests/push/singlestore.test.ts

@@ -3,6 +3,7 @@ import { SQL, sql } from 'drizzle-orm';
 import {
 	bigint,
 	binary,
+	blob,
 	char,
 	date,
 	datetime,
@@ -249,6 +250,14 @@ const singlestoreSuite: DialectSuite = {
 				columnNotNull: binary('column_not_null', { length: 1 }).notNull(),
 				columnDefault: binary('column_default', { length: 12 }),
 			}),
+			allBlobs: singlestoreTable('all_blobs', {
+				bigIntSimple: blob('big_int_simple', { mode: 'bigint' }),
+				bigIntColumnNotNull: blob('big_int_column_not_null', { mode: 'bigint' }).notNull(),
+				bigIntColumnDefault: blob('big_int_column_default', { mode: 'bigint' }).default(BigInt(12)),
+				jsonSimple: blob('json_simple', { mode: 'json' }),
+				jsonColumnNotNull: blob('json_column_not_null', { mode: 'json' }).notNull(),
+				jsonColumnDefault: blob('json_column_default', { mode: 'json' }).default('{"hello":"world"}'),
+			}),
 		};
 
 		const { statements } = await diffTestSchemasPushSingleStore(
@@ -259,7 +268,6 @@ const singlestoreSuite: DialectSuite = {
 			'drizzle',
 			false,
 		);
-		console.log(statements);
 		expect(statements.length).toBe(0);
 		expect(statements).toEqual([]);
 

drizzle-orm/src/singlestore-core/columns/all.ts

@@ -1,5 +1,6 @@
 import { bigint } from './bigint.ts';
 import { binary } from './binary.ts';
+import { blob } from './blob.ts';
 import { boolean } from './boolean.ts';
 import { char } from './char.ts';
 import { customType } from './custom.ts';
@@ -25,6 +26,7 @@ import { year } from './year.ts';
 
 export function getSingleStoreColumnBuilders() {
 	return {
+		blob,
 		bigint,
 		binary,
 		boolean,

drizzle-orm/src/singlestore-core/columns/blob.ts

@@ -0,0 +1,187 @@
+import type { ColumnBuilderBaseConfig, ColumnBuilderRuntimeConfig, MakeColumnConfig } from '~/column-builder.ts';
+import type { ColumnBaseConfig } from '~/column.ts';
+import { entityKind } from '~/entity.ts';
+import type { AnySingleStoreTable } from '~/singlestore-core/table.ts';
+import { type Equal, getColumnNameAndConfig } from '~/utils.ts';
+import { SingleStoreColumn, SingleStoreColumnBuilder } from './common.ts';
+
+type BlobMode = 'buffer' | 'json' | 'bigint';
+
+export type SingleStoreBigIntBuilderInitial<TName extends string> = SingleStoreBigIntBuilder<{
+	name: TName;
+	dataType: 'bigint';
+	columnType: 'SingleStoreBigInt';
+	data: bigint;
+	driverParam: Buffer;
+	enumValues: undefined;
+}>;
+
+export class SingleStoreBigIntBuilder<T extends ColumnBuilderBaseConfig<'bigint', 'SingleStoreBigInt'>>
+	extends SingleStoreColumnBuilder<T>
+{
+	static override readonly [entityKind]: string = 'SingleStoreBigIntBuilder';
+
+	constructor(name: T['name']) {
+		super(name, 'bigint', 'SingleStoreBigInt');
+	}
+
+	/** @internal */
+	override build<TTableName extends string>(
+		table: AnySingleStoreTable<{ name: TTableName }>,
+	): SingleStoreBigInt<MakeColumnConfig<T, TTableName>> {
+		return new SingleStoreBigInt<MakeColumnConfig<T, TTableName>>(
+			table,
+			this.config as ColumnBuilderRuntimeConfig<any>,
+		);
+	}
+}
+
+export class SingleStoreBigInt<T extends ColumnBaseConfig<'bigint', 'SingleStoreBigInt'>> extends SingleStoreColumn<T> {
+	static override readonly [entityKind]: string = 'SingleStoreBigInt';
+
+	getSQLType(): string {
+		return 'blob';
+	}
+
+	override mapFromDriverValue(value: Buffer | Uint8Array): bigint {
+		if (Buffer.isBuffer(value)) {
+			return BigInt(value.toString());
+		}
+
+		return BigInt(String.fromCodePoint(...value));
+	}
+
+	override mapToDriverValue(value: bigint): string {
+		return value.toString();
+	}
+}
+
+export type SingleStoreBlobJsonBuilderInitial<TName extends string> = SingleStoreBlobJsonBuilder<{
+	name: TName;
+	dataType: 'json';
+	columnType: 'SingleStoreBlobJson';
+	data: unknown;
+	driverParam: Buffer;
+	enumValues: undefined;
+}>;
+
+export class SingleStoreBlobJsonBuilder<T extends ColumnBuilderBaseConfig<'json', 'SingleStoreBlobJson'>>
+	extends SingleStoreColumnBuilder<T>
+{
+	static override readonly [entityKind]: string = 'SingleStoreBlobJsonBuilder';
+
+	constructor(name: T['name']) {
+		super(name, 'json', 'SingleStoreBlobJson');
+	}
+
+	/** @internal */
+	override build<TTableName extends string>(
+		table: AnySingleStoreTable<{ name: TTableName }>,
+	): SingleStoreBlobJson<MakeColumnConfig<T, TTableName>> {
+		return new SingleStoreBlobJson<MakeColumnConfig<T, TTableName>>(
+			table,
+			this.config as ColumnBuilderRuntimeConfig<any>,
+		);
+	}
+}
+
+export class SingleStoreBlobJson<T extends ColumnBaseConfig<'json', 'SingleStoreBlobJson'>>
+	extends SingleStoreColumn<T>
+{
+	static override readonly [entityKind]: string = 'SingleStoreBlobJson';
+
+	getSQLType(): string {
+		return 'blob';
+	}
+
+	override mapFromDriverValue(value: Buffer | Uint8Array | ArrayBuffer): T['data'] {
+		if (Buffer.isBuffer(value)) {
+			return JSON.parse(value.toString());
+		}
+
+		// for sqlite durable objects
+		// eslint-disable-next-line no-instanceof/no-instanceof
+		if (value instanceof ArrayBuffer) {
+			const decoder = new TextDecoder();
+			return JSON.parse(decoder.decode(value));
+		}
+
+		return JSON.parse(String.fromCodePoint(...value));
+	}
+
+	override mapToDriverValue(value: T['data']): string {
+		return JSON.stringify(value);
+	}
+}
+
+export type SingleStoreBlobBufferBuilderInitial<TName extends string> = SingleStoreBlobBufferBuilder<{
+	name: TName;
+	dataType: 'buffer';
+	columnType: 'SingleStoreBlobBuffer';
+	data: Buffer;
+	driverParam: Buffer;
+	enumValues: undefined;
+}>;
+
+export class SingleStoreBlobBufferBuilder<T extends ColumnBuilderBaseConfig<'buffer', 'SingleStoreBlobBuffer'>>
+	extends SingleStoreColumnBuilder<T>
+{
+	static override readonly [entityKind]: string = 'SingleStoreBlobBufferBuilder';
+
+	constructor(name: T['name']) {
+		super(name, 'buffer', 'SingleStoreBlobBuffer');
+	}
+
+	/** @internal */
+	override build<TTableName extends string>(
+		table: AnySingleStoreTable<{ name: TTableName }>,
+	): SingleStoreBlobBuffer<MakeColumnConfig<T, TTableName>> {
+		return new SingleStoreBlobBuffer<MakeColumnConfig<T, TTableName>>(
+			table,
+			this.config as ColumnBuilderRuntimeConfig<any>,
+		);
+	}
+}
+
+export class SingleStoreBlobBuffer<T extends ColumnBaseConfig<'buffer', 'SingleStoreBlobBuffer'>>
+	extends SingleStoreColumn<T>
+{
+	static override readonly [entityKind]: string = 'SingleStoreBlobBuffer';
+
+	getSQLType(): string {
+		return 'blob';
+	}
+}
+
+export interface BlobConfig<TMode extends BlobMode = BlobMode> {
+	mode: TMode;
+}
+
+/**
+ *  It's recommended to use `text('...', { mode: 'json' })` instead of `blob` in JSON mode, because it supports JSON functions:
+ * >All JSON functions currently throw an error if any of their arguments are BLOBs because BLOBs are reserved for a future enhancement in which BLOBs will store the binary encoding for JSON.
+ *
+ * https://www.sqlite.org/json1.html
+ */
+export function blob(): SingleStoreBlobJsonBuilderInitial<''>;
+export function blob<TMode extends BlobMode = BlobMode>(
+	config?: BlobConfig<TMode>,
+): Equal<TMode, 'bigint'> extends true ? SingleStoreBigIntBuilderInitial<''>
+	: Equal<TMode, 'buffer'> extends true ? SingleStoreBlobBufferBuilderInitial<''>
+	: SingleStoreBlobJsonBuilderInitial<''>;
+export function blob<TName extends string, TMode extends BlobMode = BlobMode>(
+	name: TName,
+	config?: BlobConfig<TMode>,
+): Equal<TMode, 'bigint'> extends true ? SingleStoreBigIntBuilderInitial<TName>
+	: Equal<TMode, 'buffer'> extends true ? SingleStoreBlobBufferBuilderInitial<TName>
+	: SingleStoreBlobJsonBuilderInitial<TName>;
+export function blob(a?: string | BlobConfig, b?: BlobConfig) {
+	const { name, config } = getColumnNameAndConfig<BlobConfig | undefined>(a, b);
+	if (config?.mode === 'json') {
+		return new SingleStoreBlobJsonBuilder(name);
+	}
+	if (config?.mode === 'bigint') {
+		return new SingleStoreBigIntBuilder(name);
+	}
+	return new SingleStoreBlobBufferBuilder(name);
+}

drizzle-orm/src/singlestore-core/columns/index.ts

@@ -1,5 +1,6 @@
 export * from './bigint.ts';
 export * from './binary.ts';
+export * from './blob.ts';
 export * from './boolean.ts';
 export * from './char.ts';
 export * from './common.ts';

drizzle-orm/type-tests/singlestore/tables.ts

@@ -4,6 +4,7 @@ import { eq } from '~/expressions.ts';
 import {
 	bigint,
 	binary,
+	blob,
 	boolean,
 	char,
 	customType,
@@ -836,6 +837,9 @@ Expect<
 
 {
 	singlestoreTable('all_columns', {
+		blob: blob('blob'),
+		blob2: blob('blob2', { mode: 'bigint' }),
+		blobdef: blob('blobdef').default(0),
 		bigint: bigint('bigint', { mode: 'number' }),
 		bigint2: bigint('bigint', { mode: 'number', unsigned: true }),
 		bigintdef: bigint('bigintdef', { mode: 'number' }).default(0),
@@ -934,6 +938,9 @@ Expect<
 
 {
 	singlestoreTable('all_columns_without_name', {
+		blob: blob(),
+		blob2: blob({ mode: 'bigint' }),
+		blobdef: blob().default(0),
 		bigint: bigint({ mode: 'number' }),
 		bigint2: bigint({ mode: 'number', unsigned: true }),
 		bigintdef: bigint({ mode: 'number' }).default(0),