Data Store

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system
binaryStorageProviderType string No The type identifier for the binary storage provider that backs this data store
datastoreId string Yes The ID of the data store
datastoreTypeId string Yes The data store type identifier
description string No A description of the data store
enableAuthorities boolean true No Whether to check access control rights for principals against this data store
locked boolean Yes Whether the data store is presently locked. If the data store is locked, then write operations against it will block.
lockedBy string No The principal that holds the lock (if the data store is locked)
maxsize number No The maximum allowed allocation size (on disk) of the data store in bytes. If this size of the data store exceeds this value, write operations will fail. A value of -1 indicates that there is no upper limit.
objectcount number No The number of objects stored within the data store. This includes system-maintained objects. This value is updated periodically and may not be precise at the moment it is read.
size number Yes The last-recorded allocation size (on disk) of the data store in bytes. This value is updated periodically and may not be precise at the moment it is read.
statisticsDate object No Records the time when statistics were last run against the data store. Statistics are run periodically to calculate the data store size and object allocations.
statisticsDirty boolean Yes Whether writes have occurred against this data store since the last time statistics were run. This signals to the system that statistics need to be collected at the next available opportunity.
title string No The title of the data store

Schema


{
  "type": "object",
  "extends": "document",
  "description": "Data Store",
  "properties": {
    "title": {
      "type": "string",
      "description": "The title of the data store"
    },
    "description": {
      "type": "string",
      "description": "A description of the data store"
    },
    "datastoreId": {
      "type": "string",
      "readonly": true,
      "description": "The ID of the data store"
    },
    "datastoreTypeId": {
      "type": "string",
      "readonly": true,
      "description": "The data store type identifier"
    },
    "enableAuthorities": {
      "type": "boolean",
      "description": "Whether to check access control rights for principals against this data store",
      "default": true
    },
    "size": {
      "type": "number",
      "readonly": true,
      "description": "The last-recorded allocation size (on disk) of the data store in bytes. This value is updated periodically and may not be precise at the moment it is read."
    },
    "maxsize": {
      "type": "number",
      "description": "The maximum allowed allocation size (on disk) of the data store in bytes. If this size of the data store exceeds this value, write operations will fail. A value of -1 indicates that there is no upper limit."
    },
    "objectcount": {
      "type": "number",
      "description": "The number of objects stored within the data store. This includes system-maintained objects. This value is updated periodically and may not be precise at the moment it is read."
    },
    "locked": {
      "type": "boolean",
      "readonly": true,
      "description": "Whether the data store is presently locked. If the data store is locked, then write operations against it will block."
    },
    "lockedBy": {
      "type": "string",
      "description": "The principal that holds the lock (if the data store is locked)"
    },
    "statisticsDate": {
      "type": "object",
      "description": "Records the time when statistics were last run against the data store. Statistics are run periodically to calculate the data store size and object allocations."
    },
    "statisticsDirty": {
      "type": "boolean",
      "readonly": true,
      "description": "Whether writes have occurred against this data store since the last time statistics were run. This signals to the system that statistics need to be collected at the next available opportunity."
    },
    "binaryStorageProviderType": {
      "type": "string",
      "description": "The type identifier for the binary storage provider that backs this data store"
    },
    "_doc": null,
    "_system": null
  },
  "id": "datastore"
}