Add blob column type to singlestore #3739
+267
−42
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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') { | ||
|
There was a problem hiding this comment. Why do we need JSON mode for blobs? We should support string and maybe buffer modes, but we can start by just mapping string data |
||
| return new SingleStoreBlobJsonBuilder(name); | ||
| } | ||
| if (config?.mode === 'bigint') { | ||
|
There was a problem hiding this comment. Why do we need BigInt mode for blobs? We should support string and maybe buffer modes, but we can start by just mapping string data |
||
| return new SingleStoreBigIntBuilder(name); | ||
| } | ||
| return new SingleStoreBlobBufferBuilder(name); | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
copy-pasted sqlite comments, should be removed