Rename which to where

README.md

@@ -88,7 +88,7 @@ setupWorker(
   // Retrieve a single user from the database by ID.
   rest.get('/user/:userId', (req, res, ctx) => {
     const user = db.user.findFirst({
-      which: {
+      where: {
         id: {
           equals: req.params.userId,
         },
@@ -141,7 +141,7 @@ Returns the first entity that satisfies the given query.
 
 ```js
 const user = db.user.findFirst({
-  which: {
+  where: {
     id: {
       equals: 'abc-123',
     },
@@ -155,7 +155,7 @@ Returns all the entities that satisfy the given query.
 
 ```js
 const users = db.user.findMany({
-  which: {
+  where: {
     followersCount: {
       gte: 1000,
     },
@@ -178,7 +178,7 @@ Can accept an optional query argument to filter the records before counting them
 
 ```js
 db.user.count({
-  which: {
+  where: {
     role: {
       equals: 'reader',
     },
@@ -201,7 +201,7 @@ Updates the first entity that matches the query.
 ```js
 const updatedUser = db.user.update({
   // Query for the entity to modify.
-  which: {
+  where: {
     id: {
       equals: 'abc-123',
     },
@@ -226,7 +226,7 @@ Updates multiple entities that match the query.
 ```js
 const updatedUsers = db.user.updateMany({
   // Query for the entity to modify.
-  which: {
+  where: {
     id: {
       in: ['abc-123', 'def-456'],
     },
@@ -245,7 +245,7 @@ Deletes the entity that satisfies the given query.
 
 ```js
 const deletedUser = db.user.delete({
-  which: {
+  where: {
     followersCount: {
       equals: 0,
     },
@@ -259,7 +259,7 @@ Deletes multiple entities that match the query.
 
 ```js
 const deletedUsers = db.user.deleteMany({
-  which: {
+  where: {
     followersCount: {
       lt: 10,
     },
@@ -323,13 +323,13 @@ setupWorker(...db.user.toHandlers('graphql'))
 
 The following GraphQL queries and mutations are generated:
 
-- `user(which: UserQueryInput): User`, returns a user matching the query.
-- `users(which: UserQueryInput, cursor: ID, skip: Int, take: Int): [User!]`, returns all users matching the query (supports [pagination](#pagination)).
+- `user(where: UserQueryInput): User`, returns a user matching the query.
+- `users(where: UserQueryInput, cursor: ID, skip: Int, take: Int): [User!]`, returns all users matching the query (supports [pagination](#pagination)).
 - `createUser(data: UserInput!): User!`, creates a new user.
-- `updateUser(which: UserQueryInput!, data: UserInput!): User!`, updates a user.
-- `updateUsers(which: UserQueryInput!, data: UserInput!): [User!]`, updates multiple users.
-- `deleteUser(which: UserQueryInput!): User!`, deletes a user.
-- `deleteUsers(which: UserQueryInput!): [User!]`, deletes multiple users.
+- `updateUser(where: UserQueryInput!, data: UserInput!): User!`, updates a user.
+- `updateUsers(where: UserQueryInput!, data: UserInput!): [User!]`, updates multiple users.
+- `deleteUser(where: UserQueryInput!): User!`, deletes a user.
+- `deleteUsers(where: UserQueryInput!): [User!]`, deletes multiple users.
 
 > Notice how some operation names contain the plural model name to emphasize that they work on a collection of entities.
 
@@ -411,7 +411,7 @@ const db = factory({
 // Returns the list of `post` entities
 // that satisfy the given query.
 const popularPosts = db.post.findMany({
-  which: {
+  where: {
     likes: {
       gte: 1000,
     },
@@ -440,7 +440,7 @@ db.user.create({ id: 'abc-123' })
 // This will throw an exception, because there are
 // no "user" entities matching this query.
 db.user.findFirst({
-  which: {
+  where: {
     id: {
       equals: 'def-456',
     },
@@ -585,7 +585,7 @@ const db = factory({
 })
 
 db.post.findMany({
-  which: {
+  where: {
     category: {
       equals: 'Science',
     },
@@ -609,7 +609,7 @@ const db = factory({
 })
 
 const firstPage = db.post.findMany({
-  which: {
+  where: {
     category: {
       equals: 'Science',
     },
@@ -619,7 +619,7 @@ const firstPage = db.post.findMany({
 })
 
 const secondPage = db.post.findMany({
-  which: {
+  where: {
     category: {
       equals: 'Science',
     },

src/db/drop.ts

@@ -3,7 +3,7 @@ import { factory } from '../factory'
 export function drop(db: ReturnType<typeof factory>): void {
   Object.values(db).forEach((model) => {
     model.deleteMany({
-      which: {},
+      where: {},
     })
   })
 }

src/factory.ts

@@ -108,7 +108,7 @@ function createModelApi<
       invariant(
         query.strict && !firstResult,
         `Failed to execute "findFirst" on the "${modelName}" model: no entity found matching the query "${JSON.stringify(
-          query.which,
+          query.where,
         )}".`,
         new OperationError(OperationErrorType.EntityNotFound),
       )
@@ -121,7 +121,7 @@ function createModelApi<
       invariant(
         query.strict && results.length === 0,
         `Failed to execute "findMany" on the "${modelName}" model: no entities found matching the query "${JSON.stringify(
-          query.which,
+          query.where,
         )}".`,
         new OperationError(OperationErrorType.EntityNotFound),
       )
@@ -138,7 +138,7 @@ function createModelApi<
         invariant(
           strict,
           `Failed to execute "update" on the "${modelName}" model: no entity found matching the query "${JSON.stringify(
-            query.which,
+            query.where,
           )}".`,
           new OperationError(OperationErrorType.EntityNotFound),
         )
@@ -173,7 +173,7 @@ function createModelApi<
         invariant(
           strict,
           `Failed to execute "updateMany" on the "${modelName}" model: no entities found matching the query "${JSON.stringify(
-            query.which,
+            query.where,
           )}".`,
           new OperationError(OperationErrorType.EntityNotFound),
         )
@@ -191,7 +191,7 @@ function createModelApi<
           invariant(
             db.has(modelName, nextRecord[prevRecord.__primaryKey]),
             `Failed to execute "updateMany" on the "${modelName}" model: no entities found matching the query "${JSON.stringify(
-              query.which,
+              query.where,
             )}".`,
             new OperationError(OperationErrorType.EntityNotFound),
           )
@@ -210,7 +210,7 @@ function createModelApi<
         invariant(
           strict,
           `Failed to execute "delete" on the "${modelName}" model: no entity found matching the query "${JSON.stringify(
-            query.which,
+            query.where,
           )}".`,
           new OperationError(OperationErrorType.EntityNotFound),
         )
@@ -228,7 +228,7 @@ function createModelApi<
         invariant(
           strict,
           `Failed to execute "deleteMany" on the "${modelName}" model: no entities found matching the query "${JSON.stringify(
-            query.which,
+            query.where,
           )}".`,
           new OperationError(OperationErrorType.EntityNotFound),
         )

src/model/defineRelationalProperties.ts

@@ -35,7 +35,7 @@ export function defineRelationalProperties(
         entity.__type,
         entity.__primaryKey,
         {
-          which: {
+          where: {
             [property]: {
               [firstRef.__primaryKey]: {
                 in: relation.refs.map((ref) => ref.__nodeId),
@@ -75,7 +75,7 @@ export function defineRelationalProperties(
                 entityRef.__type,
                 entityRef.__primaryKey,
                 {
-                  which: {
+                  where: {
                     [entityRef.__primaryKey]: {
                       equals: entityRef.__nodeId,
                     },

src/model/generateGraphQLHandlers.ts

@@ -119,7 +119,7 @@ export function declarationToFields(
       types.inputFields[key] = { type: valueType }
 
       // Query input fields describe a type that is used
-      // as a "which" query, with its comparator function types.
+      // as a "where" query, with its comparator function types.
       types.queryInputFields[key] = { type: queryType }
 
       return types
@@ -175,25 +175,25 @@ export function generateGraphQLHandlers<
         [modelName]: {
           type: EntityType,
           args: {
-            which: { type: EntityQueryInputType },
+            where: { type: EntityQueryInputType },
           },
           resolve(_, args) {
-            return model.findFirst({ which: args.which })
+            return model.findFirst({ where: args.where })
           },
         },
         // Get all entities.
         [pluralModelName]: {
           type: new GraphQLList(EntityType),
           args: {
             ...paginationArgs,
-            which: { type: EntityQueryInputType },
+            where: { type: EntityQueryInputType },
           },
           resolve(_, args) {
             const shouldQuery = Object.keys(args).length > 0
 
             return shouldQuery
               ? model.findMany({
-                  which: args.which,
+                  where: args.where,
                   skip: args.skip,
                   take: args.take,
                   cursor: args.cursor,
@@ -220,12 +220,12 @@ export function generateGraphQLHandlers<
         [`update${capitalModelName}`]: {
           type: EntityType,
           args: {
-            which: { type: EntityQueryInputType },
+            where: { type: EntityQueryInputType },
             data: { type: EntityInputType },
           },
           resolve(_, args) {
             return model.update({
-              which: args.which,
+              where: args.where,
               data: args.data,
             })
           },
@@ -234,12 +234,12 @@ export function generateGraphQLHandlers<
         [`update${capitalize(pluralModelName)}`]: {
           type: new GraphQLList(EntityType),
           args: {
-            which: { type: EntityQueryInputType },
+            where: { type: EntityQueryInputType },
             data: { type: EntityInputType },
           },
           resolve(_, args) {
             return model.updateMany({
-              which: args.which,
+              where: args.where,
               data: args.data,
             })
           },
@@ -248,20 +248,20 @@ export function generateGraphQLHandlers<
         [`delete${capitalModelName}`]: {
           type: EntityType,
           args: {
-            which: { type: EntityQueryInputType },
+            where: { type: EntityQueryInputType },
           },
           resolve(_, args) {
-            return model.delete({ which: args.which })
+            return model.delete({ where: args.where })
           },
         },
         // Delete multiple entities.
         [`delete${capitalize(pluralModelName)}`]: {
           type: new GraphQLList(EntityType),
           args: {
-            which: { type: EntityQueryInputType },
+            where: { type: EntityQueryInputType },
           },
           resolve(_, args) {
-            return model.deleteMany({ which: args.which })
+            return model.deleteMany({ where: args.where })
           },
         },
       },

src/model/generateRestHandlers.ts

@@ -10,7 +10,7 @@ import { GetQueryFor } from '../query/queryTypes'
 import { OperationErrorType, OperationError } from '../errors/OperationError'
 import { removeInternalProperties } from '../utils/removeInternalProperties'
 
-interface WeakQuerySelectorWhich<KeyType extends PrimaryKeyType> {
+interface WeakQuerySelectorWhere<KeyType extends PrimaryKeyType> {
   [key: string]: Partial<GetQueryFor<KeyType>>
 }
 
@@ -82,7 +82,7 @@ export function generateRestHandlers<
         const skip = parseInt(rawSkip ?? '0', 10)
         const take = rawTake == null ? rawTake : parseInt(rawTake, 10)
 
-        let options = { which: {} }
+        let options = { where: {} }
 
         if (take && !isNaN(take) && !isNaN(skip)) {
           options = Object.assign(options, { take, skip })
@@ -103,14 +103,14 @@ export function generateRestHandlers<
         RequestParams<PrimaryKeyType>
       >((req, res, ctx) => {
         const id = req.params[primaryKey]
-        const which: WeakQuerySelectorWhich<typeof primaryKey> = {
+        const where: WeakQuerySelectorWhere<typeof primaryKey> = {
           [primaryKey]: {
             equals: id,
           },
         }
         const entity = model.findFirst({
           strict: true,
-          which: which as any,
+          where: where as any,
         })
 
         return res(ctx.json(removeInternalProperties(entity)))
@@ -133,14 +133,14 @@ export function generateRestHandlers<
         RequestParams<PrimaryKeyType>
       >((req, res, ctx) => {
         const id = req.params[primaryKey]
-        const which: WeakQuerySelectorWhich<typeof primaryKey> = {
+        const where: WeakQuerySelectorWhere<typeof primaryKey> = {
           [primaryKey]: {
             equals: id,
           },
         }
         const updatedEntity = model.update({
           strict: true,
-          which: which as any,
+          where: where as any,
           data: req.body,
         })!
 
@@ -154,14 +154,14 @@ export function generateRestHandlers<
         RequestParams<PrimaryKeyType>
       >((req, res, ctx) => {
         const id = req.params[primaryKey]
-        const which: WeakQuerySelectorWhich<typeof primaryKey> = {
+        const where: WeakQuerySelectorWhere<typeof primaryKey> = {
           [primaryKey]: {
             equals: id,
           },
         }
         const deletedEntity = model.delete({
           strict: true,
-          which: which as any,
+          where: where as any,
         })!
 
         return res(ctx.json(removeInternalProperties(deletedEntity)))