GetCollectionPropertiesResponse Properties |
The GetCollectionPropertiesResponse type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CacheEnabled | |
| Code |
The HTTP status code.
|
| DoCompact |
Deprecated.
Whether or not the collection is compacted.
This option is meaningful for the MMFiles storage engine only.
|
| Error |
Indicates whether an error occurred (false in this case).
|
| GloballyUniqueId | |
| Id | |
| IsSystem |
If true then the collection data is kept in-memory only and not made persistent.
|
| IsVolatile |
Deprecated.
If true then the collection data is kept in-memory only and not made persistent.
This option is meaningful for the MMFiles storage engine only.
|
| JournalSize |
The maximal size of a journal or datafile in bytes.
This option is meaningful for the MMFiles storage engine only.
|
| KeyOptions |
Additional options for key generation.
|
| Name |
The name of the collection.
|
| NumberOfShards |
In a cluster, this value determines the number of shards
created for the collection. In a single server setup, this option is meaningless.
|
| ObjectId | |
| ReplicationFactor |
In a cluster, this attribute determines how many copies
of each shard are kept on different DB-Servers.
(Enterprise Edition only)
|
| ShardingStrategy |
This attribute specifies the name of the sharding strategy used for the collection.
|
| ShardKeys |
In a cluster, this attribute determines
which document attributes are used to determine the target shard for documents.
This option is meaningless in a single server setup.
|
| Status | |
| StatusString | |
| Type |
The type of the collection.
|
| WaitForSync |
If true then the data is synchronized to disk before returning
from a document create, update, replace or removal operation.
(default: false)
|
See Also