Interface ISearchIndexManager

Namespace: Couchbase.Management.Search
Assembly: Couchbase.NetClient.dll
Syntax
public interface ISearchIndexManager

Methods

View Source

AllowQueryingAsync(string, AllowQueryingSearchIndexOptions?, IScope?)

Declaration
Task AllowQueryingAsync(string indexName, AllowQueryingSearchIndexOptions? options = null, IScope? scope = null)
Parameters
Type Name Description
string indexName
AllowQueryingSearchIndexOptions options
IScope scope
Returns
Type Description
Task
View Source

DisallowQueryingAsync(string, DisallowQueryingSearchIndexOptions?, IScope?)

Declaration
Task DisallowQueryingAsync(string indexName, DisallowQueryingSearchIndexOptions? options = null, IScope? scope = null)
Parameters
Type Name Description
string indexName
DisallowQueryingSearchIndexOptions options
IScope scope
Returns
Type Description
Task
View Source

DropIndexAsync(string, DropSearchIndexOptions?, IScope?)

Declaration
Task DropIndexAsync(string indexName, DropSearchIndexOptions? options = null, IScope? scope = null)
Parameters
Type Name Description
string indexName
DropSearchIndexOptions options
IScope scope
Returns
Type Description
Task
View Source

FreezePlanAsync(string, FreezePlanSearchIndexOptions?, IScope?)

Declaration
Task FreezePlanAsync(string indexName, FreezePlanSearchIndexOptions? options = null, IScope? scope = null)
Parameters
Type Name Description
string indexName
FreezePlanSearchIndexOptions options
IScope scope
Returns
Type Description
Task
View Source

GetAllIndexesAsync(GetAllSearchIndexesOptions?, IScope?)

Declaration
Task<IEnumerable<SearchIndex>> GetAllIndexesAsync(GetAllSearchIndexesOptions? options = null, IScope? scope = null)
Parameters
Type Name Description
GetAllSearchIndexesOptions options
IScope scope
Returns
Type Description
Task<IEnumerable<SearchIndex>>
View Source

GetIndexAsync(string, GetSearchIndexOptions?, IScope?)

Declaration
Task<SearchIndex> GetIndexAsync(string indexName, GetSearchIndexOptions? options = null, IScope? scope = null)
Parameters
Type Name Description
string indexName
GetSearchIndexOptions options
IScope scope
Returns
Type Description
Task<SearchIndex>
View Source

GetIndexedDocumentsCountAsync(string, GetSearchIndexDocumentCountOptions?, IScope?)

Declaration
Task<int> GetIndexedDocumentsCountAsync(string indexName, GetSearchIndexDocumentCountOptions? options = null, IScope? scope = null)
Parameters
Type Name Description
string indexName
GetSearchIndexDocumentCountOptions options
IScope scope
Returns
Type Description
Task<int>
View Source

PauseIngestAsync(string, PauseIngestSearchIndexOptions?, IScope?)

Declaration
Task PauseIngestAsync(string indexName, PauseIngestSearchIndexOptions? options = null, IScope? scope = null)
Parameters
Type Name Description
string indexName
PauseIngestSearchIndexOptions options
IScope scope
Returns
Type Description
Task
View Source

ResumeIngestAsync(string, ResumeIngestSearchIndexOptions?, IScope?)

Declaration
Task ResumeIngestAsync(string indexName, ResumeIngestSearchIndexOptions? options = null, IScope? scope = null)
Parameters
Type Name Description
string indexName
ResumeIngestSearchIndexOptions options
IScope scope
Returns
Type Description
Task
View Source

UnfreezePlanAsync(string, UnfreezePlanSearchIndexOptions?, IScope?)

Declaration
Task UnfreezePlanAsync(string indexName, UnfreezePlanSearchIndexOptions? options = null, IScope? scope = null)
Parameters
Type Name Description
string indexName
UnfreezePlanSearchIndexOptions options
IScope scope
Returns
Type Description
Task
View Source

UpsertIndexAsync(SearchIndex, UpsertSearchIndexOptions?, IScope?)

Declaration
Task UpsertIndexAsync(SearchIndex indexDefinition, UpsertSearchIndexOptions? options = null, IScope? scope = null)
Parameters
Type Name Description
SearchIndex indexDefinition
UpsertSearchIndexOptions options
IScope scope
Returns
Type Description
Task

Extension Methods