<!--
{
  "availability" : [

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

# CKDBZone

An object that represents a CloudKit database zone.

```
dictionary CKDBZone {
	string zoneName;
	string canonicalName;
	string zoneType;
	boolean isDefaultZone;
	boolean? isSharable;
	boolean? isEligibleForZoneShare;
	boolean? isEligibleForHierarchicalShare;
	string? ownerRecordName;
	string? changeToken;
	boolean atomic;
};
```

## Overview

A zone is a logical separation of records within a single database. Features are often associated with an entire zone. For example, a zone may be optionally shared from one user to another.

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

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

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

## Topics

### Instance Properties

[`attribute boolean atomic;`](/documentation/CKToolJS/CKDBZone/atomic)

A Boolean value that indicates whether a zone allows atomic changes of multiple records.

[`attribute string canonicalName;`](/documentation/CKToolJS/CKDBZone/canonicalName)

The unique identifier for a zone within a database.

[`attribute string? changeToken;`](/documentation/CKToolJS/CKDBZone/changeToken)

The client change token for the zone.

[`attribute boolean isDefaultZone;`](/documentation/CKToolJS/CKDBZone/isDefaultZone)

A Boolean value that indicates whether the zone is a default zone.

[`attribute boolean? isEligibleForHierarchicalShare;`](/documentation/CKToolJS/CKDBZone/isEligibleForHierarchicalShare)

A Boolean value that indicates whether zone is eligible for Hierarchical Share.

[`attribute boolean? isEligibleForZoneShare;`](/documentation/CKToolJS/CKDBZone/isEligibleForZoneShare)

A Boolean value that indicates whether zone is eligible for Zone Share.

[`attribute boolean? isSharable;`](/documentation/CKToolJS/CKDBZone/isSharable)

A Boolean value that indicates whether records in this zone can be shared.

[`attribute string? ownerRecordName;`](/documentation/CKToolJS/CKDBZone/ownerRecordName)

The owner of the zone.

[`attribute string zoneName;`](/documentation/CKToolJS/CKDBZone/zoneName)

The name that identifies the record zone.

[`attribute string zoneType;`](/documentation/CKToolJS/CKDBZone/zoneType)

The type for the zone.

---

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)