IndexingPolicy
Class
Definition
Represents the indexing policy configuration for a collection in the Azure DocumentDB database service.
public sealed class IndexingPolicy : Microsoft.Azure.Documents.JsonSerializable, ICloneable
- Inheritance
- Implements
Inherited Members
Microsoft.Azure.Documents.JsonSerializable
Remarks
Indexing policies can used to configure which properties (JSON paths) are included/excluded, whether the index is updated consistently or offline (lazy), automatic vs. opt-in per-document, as well as the precision and type of index per path.
Refer to
Constructors
| IndexingPolicy() |
Initializes a new instance of the IndexingPolicy class for the Azure DocumentDB database service. |
| IndexingPolicy(Index[]) |
Initializes a new instance of the IndexingPolicy class with the specified set of indexes as default index specifications for the root path for the Azure DocumentDB database service. |
Properties
| Automatic |
Gets or sets a value that indicates whether automatic indexing is enabled for a collection in the Azure DocumentDB database service. |
| ExcludedPaths |
Gets or sets the collection containing ExcludedPath objects in the Azure DocumentDB database service. |
| IncludedPaths |
Gets or sets the collection containing IncludedPath objects in the Azure DocumentDB database service. |
| IndexingMode |
Gets or sets the indexing mode (consistent or lazy) in the Azure DocumentDB database service. |
Methods
| Clone() |
Performs a deep copy of the indexing policy for the Azure DocumentDB database service. |
Extension Methods
| IsDefined(Object) | |
| IsNull(Object) | |
| IsPrimitive(Object) |