@apple/cktool.api.database
Advanced tools
Readme
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.
See Apple Developer Documentation for more details on how to get started using CKTool JS.
DatabasePromisesApiMixin
Don't use this mixin directly. Instead, use PromisesApi
from @apple/cktool.database.
The following methods are added by the mixin.
acceptRecord
Accepts a share on behalf of the current user.createAssetUploadUrl
Creates a new URL for uploading assets.createRecord
Creates a new record.createZone
Creates a new zone.deleteRecord
Deletes a single record.deleteRecordsByQuery
Deletes records matching the provided query.deleteZone
Deletes a zone.exportSchema
Downloads the container’s schema.getRecord
Returns a record's details.getSessionUser
Returns details for the user in current session.getZone
Returns details for a zone.getZones
Returns a collection of zones.importSchema
Uploads a file that defines the new schema for the container.lookupRecords
Fetches multiple records by record name.queryRecordChanges
Returns records that changed since a specified sync token or since a zone was created.queryRecords
Returns a collection of records matching the provided query.resetConfigToProduction
Resets the container configuration to production.resetToProduction
Resets the schema of the environment to production.resolveRecord
Fetches information about records given their shortGuid properties.updateRecord
Updates an existing record.validateSchema
Validates the uploaded schema file for the container.CKDBAssetCKDBAssetUploadUrlResponseCKDBBatchDeleteErrorCKDBChangeMetadataCKDBCreateAssetUploadUrlRequestBodyCKDBCreateRecordRequestBodyCKDBCreateZoneRequestBodyCKDBDeleteRecordsByQueryRequestBodyCKDBDeletedRecordResultCKDBErrorRecordResultCKDBExistingRecordResultCKDBForRecordCKDBLocationCKDBLookupRecordsRequestBodyCKDBLookupRecordsResponseCKDBModifyRecordRequestBodyCKDBNullableReferenceCKDBPagedBatchDeleteResponseCKDBPermissionTypeCKDBQueryCKDBQueryFilterCKDBQueryFilterTypeCKDBQueryRecordsRequestBodyCKDBQuerySortCKDBQuerySortOrderCKDBRecordCKDBRecordChangesRequestBodyCKDBRecordChangesResponseCKDBRecordFieldAssetListValueCKDBRecordFieldAssetValueCKDBRecordFieldBytesListValueCKDBRecordFieldBytesValueCKDBRecordFieldDoubleListValueCKDBRecordFieldDoubleValueCKDBRecordFieldEmptyListValueCKDBRecordFieldEncryptedBytesListValueCKDBRecordFieldEncryptedBytesValueCKDBRecordFieldEncryptedDoubleListValueCKDBRecordFieldEncryptedDoubleValueCKDBRecordFieldEncryptedInt64ListValueCKDBRecordFieldEncryptedInt64ValueCKDBRecordFieldEncryptedLocationListValueCKDBRecordFieldEncryptedLocationValueCKDBRecordFieldEncryptedStringListValueCKDBRecordFieldEncryptedStringValueCKDBRecordFieldEncryptedTimestampListValueCKDBRecordFieldEncryptedTimestampValueCKDBRecordFieldInt64ListValueCKDBRecordFieldInt64ValueCKDBRecordFieldLocationListValueCKDBRecordFieldLocationValueCKDBRecordFieldReferenceListValueCKDBRecordFieldReferenceValueCKDBRecordFieldStringListValueCKDBRecordFieldStringValueCKDBRecordFieldTimestampListValueCKDBRecordFieldTimestampValueCKDBRecordFieldValueCKDBRecordReferenceCKDBRecordReferenceActionCKDBRecordResponseCKDBRecordResultCKDBRecordsResponseCKDBResolveRecordRequestBodyCKDBResolveRecordResponseCKDBResolvedRecordCKDBSchemaImportRequestBodyCKDBSessionUserCKDBSessionUserResponseCKDBShareAcceptanceStatusCKDBShareParticipantCKDBShareParticipantTypeCKDBSharePotentialParticipantCKDBStableUrlCKDBStreamingAssetCKDBUserIdentityCKDBUserIdentityLookupInfoCKDBUserNameComponentsCKDBValidateSchemaResponseCKDBZoneCKDBZoneIdCKDBZoneResponseCKDBZonesResponseFAQs
Apple CKTool JS 'database' API
The npm package @apple/cktool.api.database receives a total of 57 weekly downloads. As such, @apple/cktool.api.database popularity was classified as not popular.
We found that @apple/cktool.api.database demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 9 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.