ListShardMap<TKey> ListShardMap<TKey> ListShardMap<TKey> Class

Definition

Namespace:
Microsoft.Azure.SqlDatabase.ElasticScale.ShardManagement Microsoft.Azure.SqlDatabase.ElasticScale.ShardManagement Microsoft.Azure.SqlDatabase.ElasticScale.ShardManagement
Assembly:
Microsoft.Azure.SqlDatabase.ElasticScale.Client.dll

Represents a shard map of points where points are of the specified key.

public sealed class ListShardMap<TKey> : Microsoft.Azure.SqlDatabase.ElasticScale.ShardManagement.ShardMap
type ListShardMap<'Key> = class
    inherit ShardMap
    interface ICloneable<ShardMap>
    interface ICloneable<ListShardMap<'Key>>
Public NotInheritable Class ListShardMap(Of TKey)
Inherits ShardMap

Type Parameters

TKey

Key type.

Inheritance
ObjectObjectObject
ShardMapShardMapShardMap
ListShardMap<TKey>ListShardMap<TKey>ListShardMap<TKey>

Methods

Clone() Clone() Clone()

Clones the specified list shard map.
CloneCore() CloneCore() CloneCore()

Clones the current shard map instance.

(Inherited from ShardMap)
CreatePointMapping(PointMappingCreationInfo<TKey>) CreatePointMapping(PointMappingCreationInfo<TKey>) CreatePointMapping(PointMappingCreationInfo<TKey>)

Creates and adds a point mapping to ShardMap.
CreatePointMapping(TKey, Shard) CreatePointMapping(TKey, Shard) CreatePointMapping(TKey, Shard)

Creates and adds a point mapping to ShardMap.
CreateShard(ShardCreationInfo) CreateShard(ShardCreationInfo) CreateShard(ShardCreationInfo)

Creates a new shard and registers it with the shard map.

(Inherited from ShardMap)
CreateShard(ShardLocation) CreateShard(ShardLocation) CreateShard(ShardLocation)

Atomically adds a shard to ShardMap using the specified location.

(Inherited from ShardMap)
DeleteMapping(PointMapping<TKey>) DeleteMapping(PointMapping<TKey>) DeleteMapping(PointMapping<TKey>)

Removes a point mapping.
DeleteShard(Shard) DeleteShard(Shard) DeleteShard(Shard)

Removes a shard from ShardMap.

(Inherited from ShardMap)
GetMappingForKey(TKey) GetMappingForKey(TKey) GetMappingForKey(TKey)

Looks up the key value and returns the corresponding mapping.
GetMappingLockOwner(PointMapping<TKey>) GetMappingLockOwner(PointMapping<TKey>) GetMappingLockOwner(PointMapping<TKey>)

Gets the lock owner id of the specified mapping.
GetMappings() GetMappings() GetMappings()

Gets all the point mappings for the shard map.
GetMappings(Range<TKey>) GetMappings(Range<TKey>) GetMappings(Range<TKey>)

Gets all the mappings that exist within given range.
GetMappings(Range<TKey>, Shard) GetMappings(Range<TKey>, Shard) GetMappings(Range<TKey>, Shard)

Gets all the mappings that exist within given range and given shard.
GetMappings(Shard) GetMappings(Shard) GetMappings(Shard)

Gets all the mappings that exist for the given shard.
GetShard(ShardLocation) GetShard(ShardLocation) GetShard(ShardLocation)

Obtains the shard for the specified location.

(Inherited from ShardMap)
GetShards() GetShards() GetShards()

Gets all shards from the shard map.

(Inherited from ShardMap)
LockMapping(PointMapping<TKey>, MappingLockToken) LockMapping(PointMapping<TKey>, MappingLockToken) LockMapping(PointMapping<TKey>, MappingLockToken)

Locks the mapping for the specified owner The state of a locked mapping can only be modified by the lock owner.
MarkMappingOffline(PointMapping<TKey>) MarkMappingOffline(PointMapping<TKey>) MarkMappingOffline(PointMapping<TKey>)

Marks the specified mapping offline.
MarkMappingOnline(PointMapping<TKey>) MarkMappingOnline(PointMapping<TKey>) MarkMappingOnline(PointMapping<TKey>)

Marks the specified mapping online.
OpenConnectionForKey(TKey, String) OpenConnectionForKey(TKey, String) OpenConnectionForKey(TKey, String)

Opens a regular SqlConnection to the shard to which the specified key value is mapped, with Validate.
OpenConnectionForKey(TKey, String, ConnectionOptions) OpenConnectionForKey(TKey, String, ConnectionOptions) OpenConnectionForKey(TKey, String, ConnectionOptions)

Opens a regular SqlConnection to the shard to which the specified key value is mapped.
OpenConnectionForKey<TKey>(TKey, String) OpenConnectionForKey<TKey>(TKey, String) OpenConnectionForKey<TKey>(TKey, String)

Opens a regular SqlConnection to the shard to which the specified key value is mapped, with Validate.

(Inherited from ShardMap)
OpenConnectionForKey<TKey>(TKey, String, ConnectionOptions) OpenConnectionForKey<TKey>(TKey, String, ConnectionOptions) OpenConnectionForKey<TKey>(TKey, String, ConnectionOptions)

Opens a regular SqlConnection to the shard to which the specified key value is mapped.

(Inherited from ShardMap)
OpenConnectionForKeyAsync(TKey, String) OpenConnectionForKeyAsync(TKey, String) OpenConnectionForKeyAsync(TKey, String)

Asynchronously opens a regular SqlConnection to the shard to which the specified key value is mapped, with Validate.
OpenConnectionForKeyAsync(TKey, String, ConnectionOptions) OpenConnectionForKeyAsync(TKey, String, ConnectionOptions) OpenConnectionForKeyAsync(TKey, String, ConnectionOptions)

Asynchronously opens a regular SqlConnection to the shard to which the specified key value is mapped.
OpenConnectionForKeyAsync<TKey>(TKey, String) OpenConnectionForKeyAsync<TKey>(TKey, String) OpenConnectionForKeyAsync<TKey>(TKey, String)

Asynchronously opens a regular SqlConnection to the shard to which the specified key value is mapped, with Validate.

(Inherited from ShardMap)
OpenConnectionForKeyAsync<TKey>(TKey, String, ConnectionOptions) OpenConnectionForKeyAsync<TKey>(TKey, String, ConnectionOptions) OpenConnectionForKeyAsync<TKey>(TKey, String, ConnectionOptions)

Asynchronously opens a regular SqlConnection to the shard to which the specified key value is mapped.

(Inherited from ShardMap)
ToString() ToString() ToString()

Converts the object to its string representation.

(Inherited from ShardMap)
TryGetMappingForKey(TKey, PointMapping<TKey>) TryGetMappingForKey(TKey, PointMapping<TKey>) TryGetMappingForKey(TKey, PointMapping<TKey>)

Tries to looks up the key value and place the corresponding mapping in pointMapping.
TryGetShard(ShardLocation, Shard) TryGetShard(ShardLocation, Shard) TryGetShard(ShardLocation, Shard)

Tries to obtains the shard for the specified location.

(Inherited from ShardMap)
UnlockMapping(MappingLockToken) UnlockMapping(MappingLockToken) UnlockMapping(MappingLockToken)

Unlocks all mappings in this map that belong to the given MappingLockToken
UnlockMapping(PointMapping<TKey>, MappingLockToken) UnlockMapping(PointMapping<TKey>, MappingLockToken) UnlockMapping(PointMapping<TKey>, MappingLockToken)

Unlocks the specified mapping
UpdateMapping(PointMapping<TKey>, PointMappingUpdate) UpdateMapping(PointMapping<TKey>, PointMappingUpdate) UpdateMapping(PointMapping<TKey>, PointMappingUpdate)

Updates a PointMapping<TKey> with the updates provided in the update parameter.
UpdateMapping(PointMapping<TKey>, PointMappingUpdate, MappingLockToken) UpdateMapping(PointMapping<TKey>, PointMappingUpdate, MappingLockToken) UpdateMapping(PointMapping<TKey>, PointMappingUpdate, MappingLockToken)

Updates a point mapping with the changes provided in the update parameter.

Properties

KeyType KeyType KeyType

Shard map key type.

(Inherited from ShardMap)
MapType MapType MapType

Shard map type.

(Inherited from ShardMap)
Name Name Name

Shard map name.

(Inherited from ShardMap)

Extension Methods

IsDefined(Object) IsDefined(Object) IsDefined(Object)

Determines if a certain property is defined or not.
IsNull(Object) IsNull(Object) IsNull(Object)

Determines if a certain property is null or not.
IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object)

Determines if a certain property is of premitive JSON type.
AsListShardMap<TKey>(ShardMap) AsListShardMap<TKey>(ShardMap) AsListShardMap<TKey>(ShardMap)

Downcasts to ListShardMap of TKey.
AsRangeShardMap<TKey>(ShardMap) AsRangeShardMap<TKey>(ShardMap) AsRangeShardMap<TKey>(ShardMap)

Downcasts to RangeShardMap of TKey.

Applies to