Couchbase .NET SDK __CB_SDK_VERSION__

Show / Hide Table of Contents

Interface ICouchbaseCollectionManager

Namespace: Couchbase.Management.Collections
Assembly: Couchbase.NetClient.dll
Syntax
public interface ICouchbaseCollectionManager
Remarks

Volatile

Methods

View Source

CreateCollectionAsync(CollectionSpec, CreateCollectionOptions?)

Declaration
[Obsolete("Use the overload with CreateCollectionSettings instead.")]
Task CreateCollectionAsync(CollectionSpec spec, CreateCollectionOptions? options = null)
Parameters
Type Name Description
CollectionSpec spec
CreateCollectionOptions options
Returns
Type Description
Task
View Source

CreateCollectionAsync(string, string, CreateCollectionSettings, CreateCollectionOptions?)

Declaration
Task CreateCollectionAsync(string scopeName, string collectionName, CreateCollectionSettings settings, CreateCollectionOptions? options = null)
Parameters
Type Name Description
string scopeName
string collectionName
CreateCollectionSettings settings
CreateCollectionOptions options
Returns
Type Description
Task
View Source

CreateScopeAsync(ScopeSpec, CreateScopeOptions?)

Declaration
[Obsolete("Use other overloaded CreateScopeAsync method that does not take a ScopeSpec instead.")]
Task CreateScopeAsync(ScopeSpec spec, CreateScopeOptions? options = null)
Parameters
Type Name Description
ScopeSpec spec
CreateScopeOptions options
Returns
Type Description
Task
View Source

CreateScopeAsync(string, CreateScopeOptions?)

Declaration
Task CreateScopeAsync(string scopeName, CreateScopeOptions? options = null)
Parameters
Type Name Description
string scopeName
CreateScopeOptions options
Returns
Type Description
Task
View Source

DropCollectionAsync(CollectionSpec, DropCollectionOptions?)

Declaration
[Obsolete("Use the overload that takes scope and collection names instead.")]
Task DropCollectionAsync(CollectionSpec spec, DropCollectionOptions? options = null)
Parameters
Type Name Description
CollectionSpec spec
DropCollectionOptions options
Returns
Type Description
Task
View Source

DropCollectionAsync(string, string, DropCollectionOptions?)

Declaration
Task DropCollectionAsync(string scopeName, string collectionName, DropCollectionOptions? options = null)
Parameters
Type Name Description
string scopeName
string collectionName
DropCollectionOptions options
Returns
Type Description
Task
View Source

DropScopeAsync(string, DropScopeOptions?)

Declaration
Task DropScopeAsync(string scopeName, DropScopeOptions? options = null)
Parameters
Type Name Description
string scopeName
DropScopeOptions options
Returns
Type Description
Task
View Source

GetAllScopesAsync(GetAllScopesOptions?)

Declaration
Task<IEnumerable<ScopeSpec>> GetAllScopesAsync(GetAllScopesOptions? options = null)
Parameters
Type Name Description
GetAllScopesOptions options
Returns
Type Description
Task<IEnumerable<ScopeSpec>>
View Source

GetScopeAsync(string, GetScopeOptions?)

Declaration
[Obsolete("Use GetAllScopesAsync instead.")]
Task<ScopeSpec> GetScopeAsync(string scopeName, GetScopeOptions? options = null)
Parameters
Type Name Description
string scopeName
GetScopeOptions options
Returns
Type Description
Task<ScopeSpec>
View Source

UpdateCollectionAsync(string, string, UpdateCollectionSettings, UpdateCollectionOptions?)

Declaration
Task UpdateCollectionAsync(string scopeName, string collectionName, UpdateCollectionSettings settings, UpdateCollectionOptions? options = null)
Parameters
Type Name Description
string scopeName
string collectionName
UpdateCollectionSettings settings
UpdateCollectionOptions options
Returns
Type Description
Task

Extension Methods

CollectionManagerExtensions.CreateCollectionAsync(ICouchbaseCollectionManager, CollectionSpec)
CollectionManagerExtensions.CreateCollectionAsync(ICouchbaseCollectionManager, CollectionSpec, Action<CreateCollectionOptions>)
CollectionManagerExtensions.CreateCollectionAsync(ICouchbaseCollectionManager, string, string, CreateCollectionSettings, Action<CreateCollectionOptions>)
CollectionManagerExtensions.CreateScopeAsync(ICouchbaseCollectionManager, ScopeSpec)
CollectionManagerExtensions.CreateScopeAsync(ICouchbaseCollectionManager, ScopeSpec, Action<CreateScopeOptions>)
CollectionManagerExtensions.CreateScopeAsync(ICouchbaseCollectionManager, string)
CollectionManagerExtensions.CreateScopeAsync(ICouchbaseCollectionManager, string, Action<CreateScopeOptions>)
CollectionManagerExtensions.DropCollectionAsync(ICouchbaseCollectionManager, CollectionSpec)
CollectionManagerExtensions.DropCollectionAsync(ICouchbaseCollectionManager, CollectionSpec, Action<DropCollectionOptions>)
CollectionManagerExtensions.DropCollectionAsync(ICouchbaseCollectionManager, string, string, Action<DropCollectionOptions>)
CollectionManagerExtensions.DropScopeAsync(ICouchbaseCollectionManager, string)
CollectionManagerExtensions.DropScopeAsync(ICouchbaseCollectionManager, string, Action<DropScopeOptions>)
CollectionManagerExtensions.GetAllScopesAsync(ICouchbaseCollectionManager)
CollectionManagerExtensions.GetAllScopesAsync(ICouchbaseCollectionManager, Action<GetAllScopesOptions>)
CollectionManagerExtensions.GetScopeAsync(ICouchbaseCollectionManager, string)
CollectionManagerExtensions.GetScopeAsync(ICouchbaseCollectionManager, string, Action<GetScopeOptions>)
  • View Source
In this article
Back to top Copyright © 2020 Couchbase, Inc. All rights reserved.