Inspecting and Editing an iCloud Container’s Schema
Review and edit the schema for your app’s container using the CloudKit Database app.
Overview
Use the CloudKit Database app to verify existing record types, create new record types, edit fields, add search indexes, and delete unpublished record types.
To manage a schema’s record types, open the CloudKit Database app and select your app’s container.
Inspect Record Types
If you create a record programmatically through just-in-time schema creation, use the CloudKit Database app to verify that the record type appears in the schema with the name and fields you expect.
To view the fields for a record type:
Select Record Types in the CloudKit Database app Schema section for your app’s container.
On the main screen, select a record type. The app displays the field names and the field types for the record type you select. You can then add, modify, and remove unpublished fields.
[Image]
For more information about just-in-time schema creation, see the Save initial records to iCloud section of Designing and Creating a CloudKit Database.
Enable querying for your record type
When designing and debugging your database, you might find it useful to search for records with a particular record type. To enable searching for records by type, you must first add an index to a field on your record type.
When you create a record programmatically, iCloud creates a recordName metadata field in the corresponding record type. You add a QUERYABLE index to this field to enable searching for records by type in the CloudKit Database app and in code.
To enable querying:
From the CloudKit Database app schema management page for your app’s container, select Indexes from the Schema section in the navigation menu on the left.
To view or remove exisiting indexes, select a field name in the Indexes panel.
To add an index, click the plus icon at the top of the Indexes panel.
Set Record Type to the desired record type.
Enter a name for the new index.
Set Type to QUERYABLE.
Choose the field to index.
Click Add. The new index appears in Indexes main panel, and you can search for records using that field.
[Image]
Create a record type
In addition to creating record types programmatically using just-in-time schema creation, you can create new record types directly in the CloudKit Database app.
To create a new record type:
From the CloudKit Database app schema management page for your app’s container, select Record Types from the Schema section on the left.
Click the click the plus icon at the top of the Record Types panel provide a name and description for the new record type in the fields that appear.
Click the Create Record Type button. CloudKit adds the new record type to the schema.
To add a field, click the Add button next to Record Fields, enter a field name and description, and select a field type from the menu.
To delete a field, choose Delete in the option’s menu of that field’s row. You can’t delete fields that are in a production schema.
Click Save Changes. CloudKit adds the new fields to the schema.
[Image]
Delete a record type
You can delete a record type only in the development environment and only when that record type isn’t in production. Deleting a record type also deletes any corresponding records from the database.
To delete a record type:
From the CloudKit Database App schema management page for your app’s container, select Record Types from the Schema section on the left.
In the Record Types panel, select the record type to delete.
When that type’s details appear, click the Delete button. You can’t delete record types that are part of a production schema.
Confirm that you want to delete the record type. CloudKit removes the record type and any corresponding records from the container.
[Image]