Interface IWithShardKey

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent.MongoCollection.Update

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

The stage of the mongo collection update allowing to set shard keys.

public interface IWithShardKey

Methods

WithShardKey(string)

Specifies a shard key with default partition kind "Hash".

IUpdate WithShardKey(string shardKey)

Parameters

shardKey string

The shard key.

Returns

IUpdate

The next stage of the update.

WithShardKey(string, string)

Specifies a shard key.

IUpdate WithShardKey(string shardKey, string partitionKind)

Parameters

shardKey string

The shard key.

partitionKind string

The partition kind, only support "Hash" partition kind in api-version 2019-08-01.

Returns

IUpdate

The next stage of the update.

WithShardKeys(IDictionary<string, string>)

Appends all shard keys to current shard keys.

IUpdate WithShardKeys(IDictionary<string, string> shardKeys)

Parameters

shardKeys IDictionary<string, string>

The shard keys needs appending.

Returns

IUpdate

The next stage of the update.

WithoutShardKey(string)

Removes a shard key.

IUpdate WithoutShardKey(string shardKey)

Parameters

shardKey string

The shard key.

Returns

IUpdate

The next stage of the update.

WithoutShardKeys()

Removes all shard keys.

IUpdate WithoutShardKeys()

Returns

IUpdate

The next stage of the update.