ListShardMap<TKey> Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a shard map of points where points are of the specified key.
public sealed class ListShardMap<TKey> : Microsoft.Azure.SqlDatabase.ElasticScale.ShardManagement.ShardMaptype ListShardMap<'Key> = class
inherit ShardMap
interface ICloneable<ShardMap>
interface ICloneable<ListShardMap<'Key>>Public NotInheritable Class ListShardMap(Of TKey)
Inherits ShardMapType Parameters
- TKey
Key type.
- Inheritance
Properties
| KeyType |
Shard map key type. (Inherited from ShardMap) |
| MapType |
Shard map type. (Inherited from ShardMap) |
| Name |
Shard map name. (Inherited from ShardMap) |
Methods
| Clone() |
Clones the specified list shard map. |
| CloneCore() |
Clones the current shard map instance. (Inherited from ShardMap) |
| CreatePointMapping(PointMappingCreationInfo<TKey>) |
Creates and adds a point mapping to ShardMap. |
| CreatePointMapping(TKey, Shard) |
Creates and adds a point mapping to ShardMap. |
| CreateShard(ShardCreationInfo) |
Creates a new shard and registers it with the shard map. (Inherited from ShardMap) |
| CreateShard(ShardLocation) |
Atomically adds a shard to ShardMap using the specified location. (Inherited from ShardMap) |
| DeleteMapping(PointMapping<TKey>) |
Removes a point mapping. |
| DeleteShard(Shard) |
Removes a shard from ShardMap. (Inherited from ShardMap) |
| GetMappingForKey(TKey) |
Looks up the key value and returns the corresponding mapping. |
| GetMappingLockOwner(PointMapping<TKey>) |
Gets the lock owner id of the specified mapping. |
| GetMappings() |
Gets all the point mappings for the shard map. |
| GetMappings(Range<TKey>) |
Gets all the mappings that exist within given range. |
| GetMappings(Range<TKey>, Shard) |
Gets all the mappings that exist within given range and given shard. |
| GetMappings(Shard) |
Gets all the mappings that exist for the given shard. |
| GetShard(ShardLocation) |
Obtains the shard for the specified location. (Inherited from ShardMap) |
| GetShards() |
Gets all shards from the shard map. (Inherited from ShardMap) |
| 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>) |
Marks the specified mapping offline. |
| MarkMappingOnline(PointMapping<TKey>) |
Marks the specified mapping online. |
| OpenConnectionForKey(TKey, String) |
Opens a regular System.Data.SqlClient.SqlConnection to the shard to which the specified key value is mapped, with Validate. |
| OpenConnectionForKey(TKey, String, ConnectionOptions) |
Opens a regular System.Data.SqlClient.SqlConnection to the shard to which the specified key value is mapped. |
| OpenConnectionForKey<TKey>(TKey, String) |
Opens a regular System.Data.SqlClient.SqlConnection to the shard to which the specified key value is mapped, with Validate. (Inherited from ShardMap) |
| OpenConnectionForKey<TKey>(TKey, String, ConnectionOptions) |
Opens a regular System.Data.SqlClient.SqlConnection to the shard to which the specified key value is mapped. (Inherited from ShardMap) |
| OpenConnectionForKeyAsync(TKey, String) |
Asynchronously opens a regular System.Data.SqlClient.SqlConnection to the shard to which the specified key value is mapped, with Validate. |
| OpenConnectionForKeyAsync(TKey, String, ConnectionOptions) |
Asynchronously opens a regular System.Data.SqlClient.SqlConnection to the shard to which the specified key value is mapped. |
| OpenConnectionForKeyAsync<TKey>(TKey, String) |
Asynchronously opens a regular System.Data.SqlClient.SqlConnection to the shard to which the specified key value is mapped, with Validate. (Inherited from ShardMap) |
| OpenConnectionForKeyAsync<TKey>(TKey, String, ConnectionOptions) |
Asynchronously opens a regular System.Data.SqlClient.SqlConnection to the shard to which the specified key value is mapped. (Inherited from ShardMap) |
| ToString() |
Converts the object to its string representation. (Inherited from ShardMap) |
| TryGetMappingForKey(TKey, PointMapping<TKey>) |
Tries to looks up the key value and place the corresponding mapping in |
| TryGetShard(ShardLocation, Shard) |
Tries to obtains the shard for the specified location. (Inherited from ShardMap) |
| UnlockMapping(MappingLockToken) |
Unlocks all mappings in this map that belong to the given MappingLockToken |
| UnlockMapping(PointMapping<TKey>, MappingLockToken) |
Unlocks the specified mapping |
| UpdateMapping(PointMapping<TKey>, PointMappingUpdate) |
Updates a PointMapping<TKey> with the updates provided in
the |
| UpdateMapping(PointMapping<TKey>, PointMappingUpdate, MappingLockToken) |
Updates a point mapping with the changes provided in
the |
Extension Methods
| AsListShardMap<TKey>(ShardMap) |
Downcasts to ListShardMap of TKey. |
| AsRangeShardMap<TKey>(ShardMap) |
Downcasts to RangeShardMap of TKey. |