---
title: performQuery
framework: CloudKit JS
role: symbol
role_heading: Instance Method
platforms: [cloudkit js 1.0+]
path: cloudkitjs/cloudkit.database/performquery
---

# performQuery

Fetches records by using a query.

## Declaration

```data
Promise<CloudKit.QueryResponse, CloudKit.CKError> performQuery(
	CloudKit.Query|CloudKit.QueryResponse query,
	optional Object options
);
```

## Parameters

- `query`: Either a doc://com.apple.cloudkitjs/documentation/CloudKitJS/CloudKit.Query dictionary or a doc://com.apple.cloudkitjs/documentation/CloudKitJS/CloudKit.QueryResponse object describing the matching criteria.
- `options`: A dictionary containing options to use when fetching records. Possible dictionary keys are: | | | | | | |

## Return Value

Return Value A Promise object that resolves to a CloudKit.QueryResponse object if the operation succeeds; otherwise, a CKError object.

## Discussion

Discussion To fetch records that match some criteria, create a CloudKit.Query dictionary. var query = {     recordType: 'Artwork',     filterBy: [{         comparator: 'EQUALS',         fieldName: 'address',         fieldValue: { value: 'Fort Bragg, CA' }     }] } Execute the query using the performQuery method. To get the records that were fetched, use the records property in the CloudKit.QueryResponse class. Otherwise, handle any errors appropriately. database.performQuery(query).then(function(response) {     if (response.hasErrors) {         // Insert error handling         throw response.errors[0];     } else {         // Insert successfully fetched record code     } }); Creating Queries That Search by Location You can fetch records whose Location field lies within a circular region by specifying the center and radius of a circle in a CloudKit.Query dictionary. The Location field specified in the query must be indexed for the fetch to succeed. var query = {     recordType: 'Artwork',     filterBy: [{         fieldName: 'location',         distance: 100000,         fieldValue: {            latitude: 37.7749300,            longitude: -122.4194200        }     }] }; Execute this query using the performQuery method. Handling Large Numbers of Results If the results of a fetch exceeds the maximum number of records allowed in a response, perform the fetch again until all the records are fetched. You can also specify the results limit when performing a query. To set a results limit, pass a dictionary as the options parameter to the performQuery method. In the dictionary, set the resultsLimit key to the number of records you want to fetch for each operation. If the moreComing property of the response object is true, the results exceeded the limit and you should perform the fetch operation again until moreComing is false. The next time you perform the operation, pass the response object to the performQuery method. The response object contains the fetch options you passed the first time you called the method. For example, perform a query limiting the results to 10 records until all records matching the query are fetched. database.performQuery(query, { resultsLimit: 10 }).then(function(response) {     if (response.hasErrors) {         // Insert error handling         throw response.errors[0];     } else {         // Insert successfully fetched record code         if(response.moreComing) {             return database.performQuery(response);         }     } }); For the maximum number of records in a response and other data limits, see Data Size Limits in CloudKit Web Services Reference.

## See Also

### Accessing Records

- [saveRecords](cloudkitjs/cloudkit.database/saverecords.md)
- [fetchRecords](cloudkitjs/cloudkit.database/fetchrecords.md)
- [deleteRecords](cloudkitjs/cloudkit.database/deleterecords.md)
- [newRecordsBatch](cloudkitjs/cloudkit.database/newrecordsbatch.md)