CKTool JS - "database" API Package
This package is part of the CKTool JS JavaScript client library suite and includes operations and TypeScript types related to "database".
Each operation has a corresponding function that
returns a CancellablePromise that resolves
if successful and rejects if the operation fails.
Don't use this package on its own. It is automatically pulled
in when you include @apple/cktool.database
in your package.json dependencies.
Getting Started
See Apple Developer Documentation for more details on how to get started using CKTool JS.
API Promise Mixin
DatabasePromisesApiMixin
Don't use this mixin directly. Instead, use PromisesApi
from @apple/cktool.database.
Methods
The following methods are added by the mixin.
acceptRecordAccepts a share on behalf of the current user.createAssetUploadUrlCreates a new URL for uploading assets.createRecordCreates a new record.createZoneCreates a new zone.deleteRecordDeletes a single record.deleteRecordsByQueryDeletes records matching the provided query.deleteZoneDeletes a zone.exportSchemaDownloads the container’s schema.getRecordReturns a record's details.getSessionUserReturns details for the user in current session.getZoneReturns details for a zone.getZonesReturns a collection of zones.importSchemaUploads a file that defines the new schema for the container.lookupRecordsFetches multiple records by record name.queryRecordChangesReturns records that changed since a specified sync token or since a zone was created.queryRecordsReturns a collection of records matching the provided query.resetConfigToProductionResets the container configuration to production.resetToProductionResets the schema of the environment to production.resolveRecordFetches information about records given their shortGuid properties.updateRecordUpdates an existing record.validateSchemaValidates the uploaded schema file for the container.
TypeScript Types
CKDBAssetCKDBAssetUploadUrlResponseCKDBBatchDeleteErrorCKDBChangeMetadataCKDBCreateAssetUploadUrlRequestBodyCKDBCreateRecordRequestBodyCKDBCreateZoneRequestBodyCKDBDeleteRecordsByQueryRequestBodyCKDBDeletedRecordResultCKDBErrorRecordResultCKDBExistingRecordResultCKDBForRecordCKDBLocationCKDBLookupRecordsRequestBodyCKDBLookupRecordsResponseCKDBModifyRecordRequestBodyCKDBNullableReferenceCKDBPagedBatchDeleteResponseCKDBPermissionTypeCKDBQueryCKDBQueryFilterCKDBQueryFilterTypeCKDBQueryRecordsRequestBodyCKDBQuerySortCKDBQuerySortOrderCKDBRecordCKDBRecordChangesRequestBodyCKDBRecordChangesResponseCKDBRecordFieldAssetListValueCKDBRecordFieldAssetValueCKDBRecordFieldBytesListValueCKDBRecordFieldBytesValueCKDBRecordFieldDoubleListValueCKDBRecordFieldDoubleValueCKDBRecordFieldEmptyListValueCKDBRecordFieldEncryptedBytesListValueCKDBRecordFieldEncryptedBytesValueCKDBRecordFieldEncryptedDoubleListValueCKDBRecordFieldEncryptedDoubleValueCKDBRecordFieldEncryptedInt64ListValueCKDBRecordFieldEncryptedInt64ValueCKDBRecordFieldEncryptedLocationListValueCKDBRecordFieldEncryptedLocationValueCKDBRecordFieldEncryptedStringListValueCKDBRecordFieldEncryptedStringValueCKDBRecordFieldEncryptedTimestampListValueCKDBRecordFieldEncryptedTimestampValueCKDBRecordFieldInt64ListValueCKDBRecordFieldInt64ValueCKDBRecordFieldLocationListValueCKDBRecordFieldLocationValueCKDBRecordFieldReferenceListValueCKDBRecordFieldReferenceValueCKDBRecordFieldStringListValueCKDBRecordFieldStringValueCKDBRecordFieldTimestampListValueCKDBRecordFieldTimestampValueCKDBRecordFieldValueCKDBRecordReferenceCKDBRecordReferenceActionCKDBRecordResponseCKDBRecordResultCKDBRecordsResponseCKDBResolveRecordRequestBodyCKDBResolveRecordResponseCKDBResolvedRecordCKDBSchemaImportRequestBodyCKDBSessionUserCKDBSessionUserResponseCKDBShareAcceptanceStatusCKDBShareParticipantCKDBShareParticipantTypeCKDBSharePotentialParticipantCKDBStableUrlCKDBStreamingAssetCKDBUserIdentityCKDBUserIdentityLookupInfoCKDBUserNameComponentsCKDBValidateSchemaResponseCKDBZoneCKDBZoneIdCKDBZoneResponseCKDBZonesResponse