Skip to content

Commit

Permalink
rename tuple to refTuple and valTuple to tuple
Browse files Browse the repository at this point in the history
  • Loading branch information
@koskimas
koskimas committed Jul 25, 2023
1 parent 9a7e39e commit bfc04b6
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 44 deletions.
46 changes: 22 additions & 24 deletions src/expression/expression-builder.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -488,20 +488,20 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
/**
* Creates a tuple expression.
*
* This creates a tuple using column references by default. See {@link valTuple}
* This creates a tuple using column references by default. See {@link tuple}
* if you need to create value tuples.
*
* ### Examples
*
* ```ts
* db.selectFrom('person')
* .selectAll('person')
* .where(({ eb, tuple, valTuple }) => eb(
* tuple('first_name', 'last_name'),
* .where(({ eb, refTuple, tuple }) => eb(
* refTuple('first_name', 'last_name'),
* 'in',
* [
* valTuple('Jennifer', 'Aniston'),
* valTuple('Sylvester', 'Stallone')
* tuple('Jennifer', 'Aniston'),
* tuple('Sylvester', 'Stallone')
* ]
* ))
* ```
Expand Down Expand Up @@ -529,8 +529,8 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
* ```ts
* db.selectFrom('person')
* .selectAll('person')
* .where(({ eb, tuple, selectFrom }) => eb(
* tuple('first_name', 'last_name'),
* .where(({ eb, refTuple, selectFrom }) => eb(
* refTuple('first_name', 'last_name'),
* 'in',
* selectFrom('pet')
* .select(['name', 'species'])
Expand All @@ -556,15 +556,15 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
* )
* ```
*/
tuple<
refTuple<
R1 extends ReferenceExpression<DB, TB>,
R2 extends ReferenceExpression<DB, TB>
>(
value1: R1,
value2: R2
): ExpressionWrapper<DB, TB, RefTuple2<DB, TB, R1, R2>>

tuple<
refTuple<
R1 extends ReferenceExpression<DB, TB>,
R2 extends ReferenceExpression<DB, TB>,
R3 extends ReferenceExpression<DB, TB>
Expand All @@ -574,7 +574,7 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
value3: R3
): ExpressionWrapper<DB, TB, RefTuple3<DB, TB, R1, R2, R3>>

tuple<
refTuple<
R1 extends ReferenceExpression<DB, TB>,
R2 extends ReferenceExpression<DB, TB>,
R3 extends ReferenceExpression<DB, TB>,
Expand All @@ -586,7 +586,7 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
value4: R4
): ExpressionWrapper<DB, TB, RefTuple4<DB, TB, R1, R2, R3, R4>>

tuple<
refTuple<
R1 extends ReferenceExpression<DB, TB>,
R2 extends ReferenceExpression<DB, TB>,
R3 extends ReferenceExpression<DB, TB>,
Expand All @@ -603,20 +603,20 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
/**
* Creates a value tuple expression.
*
* This creates a tuple using values by default. See {@link tuple} if you need to create
* This creates a tuple using values by default. See {@link refTuple} if you need to create
* tuples using column references.
*
* ### Examples
*
* ```ts
* db.selectFrom('person')
* .selectAll('person')
* .where(({ eb, tuple, valTuple }) => eb(
* tuple('first_name', 'last_name'),
* .where(({ eb, refTuple, tuple }) => eb(
* refTuple('first_name', 'last_name'),
* 'in',
* [
* valTuple('Jennifer', 'Aniston'),
* valTuple('Sylvester', 'Stallone')
* tuple('Jennifer', 'Aniston'),
* tuple('Sylvester', 'Stallone')
* ]
* ))
* ```
Expand All @@ -637,25 +637,25 @@ export interface ExpressionBuilder<DB, TB extends keyof DB> {
* )
* ```
*/
valTuple<V1, V2>(
tuple<V1, V2>(
value1: V1,
value2: V2
): ExpressionWrapper<DB, TB, ValTuple2<V1, V2>>

valTuple<V1, V2, V3>(
tuple<V1, V2, V3>(
value1: V1,
value2: V2,
value3: V3
): ExpressionWrapper<DB, TB, ValTuple3<V1, V2, V3>>

valTuple<V1, V2, V3, V4>(
tuple<V1, V2, V3, V4>(
value1: V1,
value2: V2,
value3: V3,
value4: V4
): ExpressionWrapper<DB, TB, ValTuple4<V1, V2, V3, V4>>

valTuple<V1, V2, V3, V4, V5>(
tuple<V1, V2, V3, V4, V5>(
value1: V1,
value2: V2,
value3: V3,
Expand Down Expand Up @@ -1139,17 +1139,15 @@ export function createExpressionBuilder<DB, TB extends keyof DB>(
return new ExpressionWrapper(parseValueExpressionOrList(value))
},

tuple(
refTuple(
...values: ReadonlyArray<ReferenceExpression<any, any>>
): ExpressionWrapper<DB, TB, any> {
return new ExpressionWrapper(
TupleNode.create(values.map(parseReferenceExpression))
)
},

valTuple(
...values: ReadonlyArray<unknown>
): ExpressionWrapper<DB, TB, any> {
tuple(...values: ReadonlyArray<unknown>): ExpressionWrapper<DB, TB, any> {
return new ExpressionWrapper(
TupleNode.create(values.map(parseValueExpression))
)
Expand Down
4 changes: 2 additions & 2 deletions src/query-builder/select-query-builder.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1432,8 +1432,8 @@ export interface SelectQueryBuilder<DB, TB extends keyof DB, O>
* const result = await db
* .selectFrom('person')
* .selectAll('person')
* .where(({ eb, tuple, selectFrom }) => eb(
* tuple('first_name', 'last_name'),
* .where(({ eb, refTuple, selectFrom }) => eb(
* refTuple('first_name', 'last_name'),
* 'in',
* selectFrom('pet')
* .select(['name', 'species'])
Expand Down
8 changes: 4 additions & 4 deletions test/node/src/where.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -460,9 +460,9 @@ for (const dialect of DIALECTS) {
.selectFrom('person')
.selectAll()
.where((eb) =>
eb(eb.tuple('first_name', 'last_name'), 'in', [
eb.valTuple('Jennifer', 'Aniston'),
eb.valTuple('Sylvester', 'Stallone'),
eb(eb.refTuple('first_name', 'last_name'), 'in', [
eb.tuple('Jennifer', 'Aniston'),
eb.tuple('Sylvester', 'Stallone'),
])
)
.orderBy('first_name asc')
Expand Down Expand Up @@ -504,7 +504,7 @@ for (const dialect of DIALECTS) {
.selectAll()
.where((eb) =>
eb(
eb.tuple('first_name', 'last_name'),
eb.refTuple('first_name', 'last_name'),
'in',
eb
.selectFrom('person as p2')
Expand Down
28 changes: 14 additions & 14 deletions test/typings/test-d/expression.test-d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -225,18 +225,18 @@ async function textExpressionBuilderAny(
function testExpressionBuilderTuple(db: Kysely<Database>) {
db.selectFrom('person')
.selectAll()
.where(({ eb, tuple, valTuple }) =>
eb(tuple('first_name', 'last_name'), 'in', [
valTuple('Jennifer', 'Aniston'),
valTuple('Sylvester', 'Stallone'),
.where(({ eb, refTuple, tuple }) =>
eb(refTuple('first_name', 'last_name'), 'in', [
tuple('Jennifer', 'Aniston'),
tuple('Sylvester', 'Stallone'),
])
)

db.selectFrom('person')
.selectAll()
.where(({ eb, tuple, selectFrom }) =>
.where(({ eb, refTuple, selectFrom }) =>
eb(
tuple('first_name', 'last_name'),
refTuple('first_name', 'last_name'),
'in',
selectFrom('person')
.select(['first_name', 'last_name'])
Expand All @@ -248,10 +248,10 @@ function testExpressionBuilderTuple(db: Kysely<Database>) {
expectError(
db
.selectFrom('person')
.where(({ eb, tuple, valTuple }) =>
eb(tuple('first_name', 'last_name'), 'in', [
valTuple('Jennifer', 'Aniston'),
valTuple('Sylvester', 1),
.where(({ eb, refTuple, tuple }) =>
eb(refTuple('first_name', 'last_name'), 'in', [
tuple('Jennifer', 'Aniston'),
tuple('Sylvester', 1),
])
)
)
Expand All @@ -260,10 +260,10 @@ function testExpressionBuilderTuple(db: Kysely<Database>) {
expectError(
db
.selectFrom('person')
.where(({ eb, tuple, valTuple }) =>
eb(tuple('first_name', 'last_name'), 'in', [
valTuple('Jennifer', 'Aniston', 'Extra'),
valTuple('Sylvester', 'Stallone'),
.where(({ eb, refTuple, tuple }) =>
eb(refTuple('first_name', 'last_name'), 'in', [
tuple('Jennifer', 'Aniston', 'Extra'),
tuple('Sylvester', 'Stallone'),
])
)
)
Expand Down

0 comments on commit bfc04b6

Please sign in to comment.