Class PartitionKeyBuilder

Namespace

Microsoft.Azure.Cosmos

Assembly

Microsoft.Azure.Cosmos.Client.dll

Represents a partition key value list in the Azure Cosmos DB service.

public sealed class PartitionKeyBuilder

Inheritance

object

PartitionKeyBuilder

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

CosmosLinqExtensions.DocumentId(object)

CosmosLinqExtensions.IsArray(object)

CosmosLinqExtensions.IsBool(object)

CosmosLinqExtensions.IsDefined(object)

CosmosLinqExtensions.IsNull(object)

CosmosLinqExtensions.IsNumber(object)

CosmosLinqExtensions.IsObject(object)

CosmosLinqExtensions.IsPrimitive(object)

CosmosLinqExtensions.IsString(object)

CosmosLinqExtensions.RegexMatch(object, string, string)

CosmosLinqExtensions.RegexMatch(object, string)

Constructors

PartitionKeyBuilder()

Creates a new partition key value list object.

public PartitionKeyBuilder()

Methods

Add(bool)

Adds a partition key value of type bool to the list.

public PartitionKeyBuilder Add(bool val)

Parameters

val bool

The value of type bool to be used as partition key.

Returns

PartitionKeyBuilder

An instance of PartitionKeyBuilder to use.

Add(double)

Adds a partition key value of type double to the list.

public PartitionKeyBuilder Add(double val)

Parameters

val double

The value of type double to be used as partition key.

Returns

PartitionKeyBuilder

An instance of PartitionKeyBuilder to use.

Add(string)

Adds a partition key value of type string to the list.

public PartitionKeyBuilder Add(string val)

Parameters

val string

The value of type string to be used as partition key.

Returns

PartitionKeyBuilder

An instance of PartitionKeyBuilder to use.

AddNoneType()

Adds a None partition key value.

public PartitionKeyBuilder AddNoneType()

Returns

PartitionKeyBuilder

An instance of PartitionKeyBuilder to use.

AddNullValue()

Adds a partition key value which is null

public PartitionKeyBuilder AddNullValue()

Returns

PartitionKeyBuilder

An instance of PartitionKeyBuilder to use.

Build()

Builds a new instance of the PartitionKey with the specified Partition Key values.

public PartitionKey Build()

Returns

PartitionKey

An instance of PartitionKey