Interface ICollectionQueryIndexManager
This interface contains the means for managing collection-level indexes used for queries.
Namespace: Couchbase.Management.Query
Assembly: Couchbase.NetClient.dll
Syntax
public interface ICollectionQueryIndexManagerMethods
View SourceBuildDeferredIndexesAsync(BuildDeferredQueryIndexOptions)
Build Deferred builds all indexes which are currently in deferred state.
Declaration
Task BuildDeferredIndexesAsync(BuildDeferredQueryIndexOptions options)Parameters
| Type | Name | Description |
|---|---|---|
| BuildDeferredQueryIndexOptions | options | Any optional parameters. |
Returns
| Type | Description |
|---|---|
| Task | A Task for awaiting. |
CreateIndexAsync(string, IEnumerable<string>, CreateQueryIndexOptions)
Creates a new index.
Declaration
Task CreateIndexAsync(string indexName, IEnumerable<string> fields, CreateQueryIndexOptions options)Parameters
| Type | Name | Description |
|---|---|---|
| string | indexName | The name of the index. |
| IEnumerable<string> | fields | The fields to create the index over. |
| CreateQueryIndexOptions | options | Any optional parameters. |
Returns
| Type | Description |
|---|---|
| Task | A Task for awaiting. |
CreatePrimaryIndexAsync(CreatePrimaryQueryIndexOptions)
Creates a new primary index on the bucket in scope.
Declaration
Task CreatePrimaryIndexAsync(CreatePrimaryQueryIndexOptions options)Parameters
| Type | Name | Description |
|---|---|---|
| CreatePrimaryQueryIndexOptions | options | Any optional fields. |
Returns
| Type | Description |
|---|---|
| Task | A Task for awaiting. |
DropIndexAsync(string, DropQueryIndexOptions)
Drops an index.
Declaration
Task DropIndexAsync(string indexName, DropQueryIndexOptions options)Parameters
| Type | Name | Description |
|---|---|---|
| string | indexName | The name of the index to drop. |
| DropQueryIndexOptions | options | Any optional parameters. |
Returns
| Type | Description |
|---|---|
| Task | A Task for awaiting. |
DropPrimaryIndexAsync(DropPrimaryQueryIndexOptions)
Drops a primary index.
Declaration
Task DropPrimaryIndexAsync(DropPrimaryQueryIndexOptions options)Parameters
| Type | Name | Description |
|---|---|---|
| DropPrimaryQueryIndexOptions | options | Any optional parameters. |
Returns
| Type | Description |
|---|---|
| Task | A Task for awaiting. |
GetAllIndexesAsync(GetAllQueryIndexOptions)
Fetches all indexes from the server for the given bucket (limiting to scope/collection if applicable).
Declaration
Task<IEnumerable<QueryIndex>> GetAllIndexesAsync(GetAllQueryIndexOptions options)Parameters
| Type | Name | Description |
|---|---|---|
| GetAllQueryIndexOptions | options | The operational to specify. |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<QueryIndex>> | A IEnumerable<T> with the results of the query. |
WatchIndexesAsync(IEnumerable<string>, TimeSpan, WatchQueryIndexOptions)
An internal collection reference for the query_context.
Declaration
Task WatchIndexesAsync(IEnumerable<string> indexNames, TimeSpan duration, WatchQueryIndexOptions options)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<string> | indexNames | The names of the indexes to watch. |
| TimeSpan | duration | The time allowed for the operation to be terminated. |
| WatchQueryIndexOptions | options | Any optional parameters. |
Returns
| Type | Description |
|---|---|
| Task | A Task for awaiting. |