<!--
{
  "availability" : [

  ],
  "documentType" : "symbol",
  "framework" : "CKToolJS",
  "identifier" : "/documentation/CKToolJS/CKDBQueryFilter",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "CKTool JS"
    ],
    "preciseIdentifier" : "struct/CKDBQueryFilter"
  },
  "title" : "CKDBQueryFilter"
}
-->

# CKDBQueryFilter

An object that represents the logical conditions for determining whether a record matches the query.

```
dictionary CKDBQueryFilter {
	string? fieldName;
	CKDBRecordFieldValue fieldValue;
	CKDBQueryFilterType type;
	Double? radiusInKilometers;
};
```

## Overview

In JavaScript, this is a plain object with properties as described.

In TypeScript, this type is imported in the following way:

```javascript
import type { CKDBQueryFilter } from "@apple/cktool.database";
```

## Topics

### Instance Properties

[`attribute string? fieldName;`](/documentation/CKToolJS/CKDBQueryFilter/fieldName)

The name of a field belonging to the record type.

[`attribute CKDBRecordFieldValue fieldValue;`](/documentation/CKToolJS/CKDBQueryFilter/fieldValue)

[`attribute Double? radiusInKilometers;`](/documentation/CKToolJS/CKDBQueryFilter/radiusInKilometers)

A radius used to determine whether a field that is a location is inside a circular area.

[`attribute CKDBQueryFilterType type;`](/documentation/CKToolJS/CKDBQueryFilter/type)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)