forked from drizzle-team/drizzle-orm
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a574989
commit 3f844c4
Showing
4 changed files
with
228 additions
and
2 deletions.
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
195 changes: 195 additions & 0 deletions
195
drizzle-orm/src/singlestore-core/query-builders/branch.ts
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,195 @@ | ||
| import { entityKind } from '~/entity.ts'; | ||
| import { DrizzleError } from '~/errors.ts'; | ||
| import { QueryPromise } from '~/query-promise.ts'; | ||
| import type { SingleStoreDialect } from '~/singlestore-core/dialect.ts'; | ||
| import type { | ||
| AnySingleStoreQueryResultHKT, | ||
| PreparedQueryHKTBase, | ||
| PreparedQueryKind, | ||
| SingleStorePreparedQueryConfig, | ||
| SingleStoreQueryResultHKT, | ||
| SingleStoreQueryResultKind, | ||
| SingleStoreSession, | ||
| } from '~/singlestore-core/session.ts'; | ||
| import type { Query, SQL, SQLWrapper } from '~/sql/sql.ts'; | ||
|
|
||
| export type SingleStoreBranchWithout< | ||
| T extends AnySingleStoreBranchBase, | ||
| TDynamic extends boolean, | ||
| K extends keyof T & string, | ||
| > = TDynamic extends true ? T | ||
| : Omit< | ||
| SingleStoreBranchBase< | ||
| T['_']['database'], | ||
| T['_']['queryResult'], | ||
| T['_']['preparedQueryHKT'], | ||
| TDynamic, | ||
| T['_']['excludedMethods'] | K | ||
| >, | ||
| T['_']['excludedMethods'] | K | ||
| >; | ||
|
|
||
| export type SingleStoreBranch< | ||
| TDatabase extends string = string, | ||
| TQueryResult extends SingleStoreQueryResultHKT = AnySingleStoreQueryResultHKT, | ||
| TPreparedQueryHKT extends PreparedQueryHKTBase = PreparedQueryHKTBase, | ||
| > = SingleStoreBranchBase<TDatabase, TQueryResult, TPreparedQueryHKT, true, never>; | ||
|
|
||
| export interface SingleStoreBranchConfig { | ||
| milestone?: string | undefined; | ||
| time?: Date | undefined; | ||
| database: string; | ||
| databaseAlias: string; | ||
| fromWorkspaceGroup?: string | undefined; | ||
| readOnly?: boolean | undefined; | ||
| } | ||
|
|
||
| export type SingleStoreBranchPrepare<T extends AnySingleStoreBranchBase> = PreparedQueryKind< | ||
| T['_']['preparedQueryHKT'], | ||
| SingleStorePreparedQueryConfig & { | ||
| execute: SingleStoreQueryResultKind<T['_']['queryResult'], never>; | ||
| iterator: never; | ||
| }, | ||
| true | ||
| >; | ||
|
|
||
| type SingleStoreBranchDynamic<T extends AnySingleStoreBranchBase> = SingleStoreBranch< | ||
| T['_']['database'], | ||
| T['_']['queryResult'], | ||
| T['_']['preparedQueryHKT'] | ||
| >; | ||
|
|
||
| type AnySingleStoreBranchBase = SingleStoreBranchBase<any, any, any, any, any>; | ||
|
|
||
| export interface SingleStoreBranchBase< | ||
| TDatabase extends string, | ||
| TQueryResult extends SingleStoreQueryResultHKT, | ||
| TPreparedQueryHKT extends PreparedQueryHKTBase, | ||
| TDynamic extends boolean = false, | ||
| TExcludedMethods extends string = never, | ||
| > extends QueryPromise<SingleStoreQueryResultKind<TQueryResult, never>> { | ||
| readonly _: { | ||
| readonly database: TDatabase; | ||
| readonly queryResult: TQueryResult; | ||
| readonly preparedQueryHKT: TPreparedQueryHKT; | ||
| readonly dynamic: TDynamic; | ||
| readonly excludedMethods: TExcludedMethods; | ||
| }; | ||
| } | ||
|
|
||
| export class SingleStoreBranchBase< | ||
| TDatabase extends string, | ||
| TQueryResult extends SingleStoreQueryResultHKT, | ||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
| TPreparedQueryHKT extends PreparedQueryHKTBase, | ||
| TDynamic extends boolean = false, | ||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
| TExcludedMethods extends string = never, | ||
| > extends QueryPromise<SingleStoreQueryResultKind<TQueryResult, never>> implements SQLWrapper { | ||
| static readonly [entityKind]: string = 'SingleStoreBranch'; | ||
|
|
||
| private config: SingleStoreBranchConfig; | ||
|
|
||
| constructor( | ||
| private database: TDatabase, | ||
| private branchName: string, | ||
| private session: SingleStoreSession, | ||
| private dialect: SingleStoreDialect, | ||
| ) { | ||
| super(); | ||
| this.config = { database, databaseAlias: branchName }; | ||
| } | ||
|
|
||
| /** | ||
| * Adds a `where` clause to the query. | ||
| * | ||
| * Calling this method will delete only those rows that fulfill a specified condition. | ||
| * | ||
| * See docs: {@link https://orm.drizzle.team/docs/delete} | ||
| * | ||
| * @param where the `where` clause. | ||
| * | ||
| * @example | ||
| * You can use conditional operators and `sql function` to filter the rows to be deleted. | ||
| * | ||
| * ```ts | ||
| * // Attach all cars with green color | ||
| * db.delete(cars).where(eq(cars.color, 'green')); | ||
| * // or | ||
| * db.delete(cars).where(sql`${cars.color} = 'green'`) | ||
| * ``` | ||
| * | ||
| * You can logically combine conditional operators with `and()` and `or()` operators: | ||
| * | ||
| * ```ts | ||
| * // Attach all BMW cars with a green color | ||
| * db.delete(cars).where(and(eq(cars.color, 'green'), eq(cars.brand, 'BMW'))); | ||
| * | ||
| * // Attach all cars with the green or blue color | ||
| * db.delete(cars).where(or(eq(cars.color, 'green'), eq(cars.color, 'blue'))); | ||
| * ``` | ||
| */ | ||
| // TODO(singlestore): docs | ||
| atMilestone(milestone: string): SingleStoreBranchWithout<this, TDynamic, 'atMilestone'> { | ||
| if (this.config.time) { | ||
| throw new DrizzleError({ message: 'Cannot set both time and milestone' }); | ||
| } | ||
| this.config.milestone = milestone; | ||
| return this as any; | ||
| } | ||
|
|
||
| // TODO(singlestore): docs | ||
| atTime(time: Date): SingleStoreBranchWithout<this, TDynamic, 'atTime'> { | ||
| if (this.config.milestone) { | ||
| throw new DrizzleError({ message: 'Cannot set both time and milestone' }); | ||
| } | ||
| this.config.time = time; | ||
| return this as any; | ||
| } | ||
|
|
||
| // TODO(singlestore): docs | ||
| fromWorkspaceGroup(groupID: string): SingleStoreBranchWithout<this, TDynamic, 'fromWorkspaceGroup'> { | ||
| this.config.fromWorkspaceGroup = groupID; | ||
| return this as any; | ||
| } | ||
|
|
||
| // TODO(singlestore): docs | ||
| readOnly(): SingleStoreBranchWithout<this, TDynamic, 'readOnly'> { | ||
| this.config.readOnly = true; | ||
| return this as any; | ||
| } | ||
|
|
||
| /** @internal */ | ||
| getSQL(): SQL { | ||
| return this.dialect.buildBranchQuery(this.config); | ||
| } | ||
|
|
||
| toSQL(): Query { | ||
| const { typings: _typings, ...rest } = this.dialect.sqlToQuery(this.getSQL()); | ||
| return rest; | ||
| } | ||
|
|
||
| prepare(): SingleStoreBranchPrepare<this> { | ||
| return this.session.prepareQuery( | ||
| this.dialect.sqlToQuery(this.getSQL()), | ||
| undefined, | ||
| ) as SingleStoreBranchPrepare<this>; | ||
| } | ||
|
|
||
| override execute: ReturnType<this['prepare']>['execute'] = (placeholderValues) => { | ||
| return this.prepare().execute(placeholderValues); | ||
| }; | ||
|
|
||
| private createIterator = (): ReturnType<this['prepare']>['iterator'] => { | ||
| const self = this; | ||
| return async function*(placeholderValues) { | ||
| yield* self.prepare().iterator(placeholderValues); | ||
| }; | ||
| }; | ||
|
|
||
| iterator = this.createIterator(); | ||
|
|
||
| $dynamic(): SingleStoreBranchDynamic<this> { | ||
| return this as any; | ||
| } | ||
| } |