azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml

### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  id: _list_shard_mapper
  parent: com.microsoft.azure.elasticdb.shard.mapper
  children:
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.add(PointMapping)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.getLockOwnerForMapping(PointMapping)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.getMappingsForRange(Range,Shard,LookupOptions)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.ListShardMapper(ShardMapManager,ShardMap)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.lockOrUnlockMappings(PointMapping,UUID,LockOwnerIdOpType)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.lookup(Object,LookupOptions)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.markMappingOffline(PointMapping)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.markMappingOffline(PointMapping,UUID)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.markMappingOnline(PointMapping)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.markMappingOnline(PointMapping,UUID)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.openConnectionForKey(Object,String)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.openConnectionForKey(Object,String,ConnectionOptions)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.openConnectionForKeyAsync(Object,String)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.openConnectionForKeyAsync(Object,String,ConnectionOptions)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.remove(PointMapping)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.remove(PointMapping,UUID)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.tryLookup(Object,LookupOptions,ReferenceObjectHelper<PointMapping>)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.update(PointMapping,PointMappingUpdate)
  - com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.update(PointMapping,PointMappingUpdate,UUID)
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: ListShardMapper
  nameWithType: ListShardMapper
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper
  type: Class
  source:
    remote: &o0
      path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
      branch: master
      repo: https://github.com/Microsoft/elastic-db-tools-for-java
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 36
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Mapper from single keys (points) to their corresponding shards.</p>

    <p></p>    
  syntax:
    content: public class ListShardMapper extends BaseShardMapper implements IShardMapper<PointMapping, Object>
  inheritance:
  - java.lang.Object
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  inheritedMembers:
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.add(MappingT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>)
  - com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.add(MappingT)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.BaseShardMapper(ShardMapManager,ShardMap)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.DEFAULT_OWNER
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.ensureMappingBelongsToShardMap(MappingT,String,String)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.getLockOwnerForMapping(MappingT,ShardManagementErrorCategory)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.getMappingsForRange(Range,Shard,LookupOptions,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,ShardManagementErrorCategory,String)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.getShardMap()
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.getShardMapManager()
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.lockOrUnlockMappings(MappingT,UUID,LockOwnerIdOpType,ShardManagementErrorCategory)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.lookup(KeyT,LookupOptions,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,ShardManagementErrorCategory)
  - com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.lookup(ValueT,LookupOptions)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.openConnectionForKey(KeyT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,ShardManagementErrorCategory,String)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.openConnectionForKey(KeyT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,ShardManagementErrorCategory,String,ConnectionOptions)
  - com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.openConnectionForKey(ValueT,String)
  - com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.openConnectionForKey(ValueT,String,ConnectionOptions)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.openConnectionForKeyAsync(KeyT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,ShardManagementErrorCategory,String)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.openConnectionForKeyAsync(KeyT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,ShardManagementErrorCategory,String,ConnectionOptions)
  - com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.openConnectionForKeyAsync(ValueT,String)
  - com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.openConnectionForKeyAsync(ValueT,String,ConnectionOptions)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.remove(MappingT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,UUID)
  - com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.remove(MappingT,UUID)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.setStatus(MappingT,StatusT,Function<StatusT, StatusT>,Function<StatusT, UpdateT>,ActionGeneric3Param<MappingT, UpdateT, UUID, MappingT>)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.setStatus(MappingT,StatusT,Function<StatusT, StatusT>,Function<StatusT, UpdateT>,ActionGeneric3Param<MappingT, UpdateT, UUID, MappingT>,UUID)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.shardMap
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.shardMapManager
  - com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.tryLookup(ValueT,LookupOptions,ReferenceObjectHelper<MappingT>)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.update(MappingT,UpdateT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,Function<StatusT, Integer>,Function<Integer, StatusT>)
  - com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.update(MappingT,UpdateT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,Function<StatusT, Integer>,Function<Integer, StatusT>,UUID)
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.add(PointMapping)
  id: add(PointMapping)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: add(PointMapping mapping)
  nameWithType: ListShardMapper.add(PointMapping mapping)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.add(PointMapping mapping)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.add*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 182
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Adds a point mapping.</p>

    <p></p>    
  syntax:
    content: public PointMapping add(PointMapping mapping)
    parameters:
    - id: mapping
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>Mapping being added. </p>
    return:
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>The added mapping object. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.getLockOwnerForMapping(PointMapping)
  id: getLockOwnerForMapping(PointMapping)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: getLockOwnerForMapping(PointMapping mapping)
  nameWithType: ListShardMapper.getLockOwnerForMapping(PointMapping mapping)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.getLockOwnerForMapping(PointMapping mapping)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.getLockOwnerForMapping*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 307
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Gets the lock owner of a mapping.</p>

    <p></p>    
  syntax:
    content: public UUID getLockOwnerForMapping(PointMapping mapping)
    parameters:
    - id: mapping
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>The mapping </p>
    return:
      type: add9545a
      description: <p>Lock owner for the mapping. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.getMappingsForRange(Range,Shard,LookupOptions)
  id: getMappingsForRange(Range,Shard,LookupOptions)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: getMappingsForRange(Range range, Shard shard, LookupOptions lookupOptions)
  nameWithType: ListShardMapper.getMappingsForRange(Range range, Shard shard, LookupOptions lookupOptions)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.getMappingsForRange(Range range, Shard shard, LookupOptions lookupOptions)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.getMappingsForRange*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 263
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Gets all the mappings that exist within given range.</p>

    <p></p>    
  syntax:
    content: public List<PointMapping> getMappingsForRange(Range range, Shard shard, LookupOptions lookupOptions)
    parameters:
    - id: range
      type: com.microsoft.azure.elasticdb.shard.base._range
      description: <p>Optional range value, if null, we cover everything. </p>
    - id: shard
      type: com.microsoft.azure.elasticdb.shard.base._shard
      description: <p>Optional shard parameter, if null, we cover all shards. </p>
    - id: lookupOptions
      type: com.microsoft.azure.elasticdb.shard.base._lookup_options
      description: <p>Whether to use cache and/or storage for lookups. </p>
    return:
      type: 5618da2dcom.microsoft.azure.elasticdb.shard.base._point_mappinga08ddfce
      description: <p>Read-only collection of mappings that overlap with given range. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.ListShardMapper(ShardMapManager,ShardMap)
  id: ListShardMapper(ShardMapManager,ShardMap)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: ListShardMapper(ShardMapManager shardMapManager, ShardMap sm)
  nameWithType: ListShardMapper.ListShardMapper(ShardMapManager shardMapManager, ShardMap sm)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.ListShardMapper(ShardMapManager shardMapManager, ShardMap sm)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.ListShardMapper*
  type: Constructor
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 46
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>List shard mapper, which managers point mappings.</p>

    <p></p>    
  syntax:
    content: public ListShardMapper(ShardMapManager shardMapManager, ShardMap sm)
    parameters:
    - id: shardMapManager
      type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
      description: <p>Reference to ShardMapManager. </p>
    - id: sm
      type: com.microsoft.azure.elasticdb.shard.map._shard_map
      description: <p>Containing shard map. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.lockOrUnlockMappings(PointMapping,UUID,LockOwnerIdOpType)
  id: lockOrUnlockMappings(PointMapping,UUID,LockOwnerIdOpType)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: lockOrUnlockMappings(PointMapping mapping, UUID lockOwnerId, LockOwnerIdOpType lockOwnerIdOpType)
  nameWithType: ListShardMapper.lockOrUnlockMappings(PointMapping mapping, UUID lockOwnerId, LockOwnerIdOpType lockOwnerIdOpType)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.lockOrUnlockMappings(PointMapping mapping, UUID lockOwnerId, LockOwnerIdOpType lockOwnerIdOpType)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.lockOrUnlockMappings*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 321
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Locks or unlocks a given mapping or all mappings.</p>

    <p></p>    
  syntax:
    content: public void lockOrUnlockMappings(PointMapping mapping, UUID lockOwnerId, LockOwnerIdOpType lockOwnerIdOpType)
    parameters:
    - id: mapping
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>Optional mapping </p>
    - id: lockOwnerId
      type: add9545a
      description: <p>The lock owner id </p>
    - id: lockOwnerIdOpType
      type: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type
      description: <p>Operation to perform on this mapping with the given lockOwnerId </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.lookup(Object,LookupOptions)
  id: lookup(Object,LookupOptions)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: lookup(Object key, LookupOptions lookupOptions)
  nameWithType: ListShardMapper.lookup(Object key, LookupOptions lookupOptions)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.lookup(Object key, LookupOptions lookupOptions)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.lookup*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 218
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Looks up the key value and returns the corresponding mapping.</p>

    <p></p>    
  syntax:
    content: public PointMapping lookup(Object key, LookupOptions lookupOptions)
    parameters:
    - id: key
      type: "79317049"
      description: <p>Input key value. </p>
    - id: lookupOptions
      type: com.microsoft.azure.elasticdb.shard.base._lookup_options
      description: <p>Whether to use cache and/or storage for lookups. </p>
    return:
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>Mapping that contains the key value. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.markMappingOffline(PointMapping)
  id: markMappingOffline(PointMapping)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: markMappingOffline(PointMapping mapping)
  nameWithType: ListShardMapper.markMappingOffline(PointMapping mapping)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.markMappingOffline(PointMapping mapping)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.markMappingOffline*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 124
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Marks the given mapping offline.</p>

    <p></p>    
  syntax:
    content: public PointMapping markMappingOffline(PointMapping mapping)
    parameters:
    - id: mapping
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>Input point mapping. </p>
    return:
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>An offline mapping. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.markMappingOffline(PointMapping,UUID)
  id: markMappingOffline(PointMapping,UUID)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: markMappingOffline(PointMapping mapping, UUID lockOwnerId)
  nameWithType: ListShardMapper.markMappingOffline(PointMapping mapping, UUID lockOwnerId)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.markMappingOffline(PointMapping mapping, UUID lockOwnerId)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.markMappingOffline*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 137
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Marks the given mapping offline.</p>

    <p></p>    
  syntax:
    content: public PointMapping markMappingOffline(PointMapping mapping, UUID lockOwnerId)
    parameters:
    - id: mapping
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>Input point mapping. </p>
    - id: lockOwnerId
      type: add9545a
      description: <p>Lock owner id of this mapping </p>
    return:
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>An offline mapping. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.markMappingOnline(PointMapping)
  id: markMappingOnline(PointMapping)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: markMappingOnline(PointMapping mapping)
  nameWithType: ListShardMapper.markMappingOnline(PointMapping mapping)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.markMappingOnline(PointMapping mapping)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.markMappingOnline*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 153
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Marks the given mapping online.</p>

    <p></p>    
  syntax:
    content: public PointMapping markMappingOnline(PointMapping mapping)
    parameters:
    - id: mapping
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>Input point mapping. </p>
    return:
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>An online mapping. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.markMappingOnline(PointMapping,UUID)
  id: markMappingOnline(PointMapping,UUID)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: markMappingOnline(PointMapping mapping, UUID lockOwnerId)
  nameWithType: ListShardMapper.markMappingOnline(PointMapping mapping, UUID lockOwnerId)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.markMappingOnline(PointMapping mapping, UUID lockOwnerId)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.markMappingOnline*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 166
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Marks the given mapping online.</p>

    <p></p>    
  syntax:
    content: public PointMapping markMappingOnline(PointMapping mapping, UUID lockOwnerId)
    parameters:
    - id: mapping
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>Input point mapping. </p>
    - id: lockOwnerId
      type: add9545a
      description: <p>Lock owner id of this mapping </p>
    return:
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>An online mapping. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.openConnectionForKey(Object,String)
  id: openConnectionForKey(Object,String)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: openConnectionForKey(Object key, String connectionString)
  nameWithType: ListShardMapper.openConnectionForKey(Object key, String connectionString)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.openConnectionForKey(Object key, String connectionString)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.openConnectionForKey*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 61
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Given a key value, obtains a SqlConnection to the shard in the mapping that contains the key value.</p>

    <p></p>    
  syntax:
    content: public Connection openConnectionForKey(Object key, String connectionString)
    parameters:
    - id: key
      type: "79317049"
      description: <p>Input key value. </p>
    - id: connectionString
      type: "26831127"
      description: <p>Connection string with credential information, the DataSource and Database are obtained from the results of the lookup operation for key. </p>
    return:
      type: 8270ccc2
      description: <p>An opened SqlConnection. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.openConnectionForKey(Object,String,ConnectionOptions)
  id: openConnectionForKey(Object,String,ConnectionOptions)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: openConnectionForKey(Object key, String connectionString, ConnectionOptions options)
  nameWithType: ListShardMapper.openConnectionForKey(Object key, String connectionString, ConnectionOptions options)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.openConnectionForKey(Object key, String connectionString, ConnectionOptions options)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.openConnectionForKey*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 78
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Given a key value, obtains a SqlConnection to the shard in the mapping that contains the key value.</p>

    <p></p>    
  syntax:
    content: public Connection openConnectionForKey(Object key, String connectionString, ConnectionOptions options)
    parameters:
    - id: key
      type: "79317049"
      description: <p>Input key value. </p>
    - id: connectionString
      type: "26831127"
      description: <p>Connection string with credential information, the DataSource and Database are obtained from the results of the lookup operation for key. </p>
    - id: options
      type: com.microsoft.azure.elasticdb.shard.mapper._connection_options
      description: <p>Options for validation operations to perform on opened connection. </p>
    return:
      type: 8270ccc2
      description: <p>An opened SqlConnection. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.openConnectionForKeyAsync(Object,String)
  id: openConnectionForKeyAsync(Object,String)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: openConnectionForKeyAsync(Object key, String connectionString)
  nameWithType: ListShardMapper.openConnectionForKeyAsync(Object key, String connectionString)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.openConnectionForKeyAsync(Object key, String connectionString)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.openConnectionForKeyAsync*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 94
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Given a key value, asynchronously obtains a SqlConnection to the shard in the mapping that contains the key value.</p>

    <p></p>    
  syntax:
    content: public Callable<Connection> openConnectionForKeyAsync(Object key, String connectionString)
    parameters:
    - id: key
      type: "79317049"
      description: <p>Input key value. </p>
    - id: connectionString
      type: "26831127"
      description: <p>Connection string with credential information, the DataSource and Database are obtained from the results of the lookup operation for key. </p>
    return:
      type: 68f3503d
      description: <p>A Task encapsulating an opened SqlConnection. All non usage-error exceptions will be reported via the returned Task </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.openConnectionForKeyAsync(Object,String,ConnectionOptions)
  id: openConnectionForKeyAsync(Object,String,ConnectionOptions)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: openConnectionForKeyAsync(Object key, String connectionString, ConnectionOptions options)
  nameWithType: ListShardMapper.openConnectionForKeyAsync(Object key, String connectionString, ConnectionOptions options)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.openConnectionForKeyAsync(Object key, String connectionString, ConnectionOptions options)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.openConnectionForKeyAsync*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 111
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Given a key value, asynchronously obtains a SqlConnection to the shard in the mapping that contains the key value.</p>

    <p></p>    
  syntax:
    content: public Callable<Connection> openConnectionForKeyAsync(Object key, String connectionString, ConnectionOptions options)
    parameters:
    - id: key
      type: "79317049"
      description: <p>Input key value. </p>
    - id: connectionString
      type: "26831127"
      description: <p>Connection string with credential information, the DataSource and Database are obtained from the results of the lookup operation for key. </p>
    - id: options
      type: com.microsoft.azure.elasticdb.shard.mapper._connection_options
      description: <p>Options for validation operations to perform on opened connection. </p>
    return:
      type: 68f3503d
      description: <p>A Task encapsulating an opened SqlConnection. All non usage-error exceptions will be reported via the returned Task </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.remove(PointMapping)
  id: remove(PointMapping)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: remove(PointMapping mapping)
  nameWithType: ListShardMapper.remove(PointMapping mapping)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.remove(PointMapping mapping)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.remove*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 192
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Removes a point mapping.</p>

    <p></p>    
  syntax:
    content: public void remove(PointMapping mapping)
    parameters:
    - id: mapping
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>Mapping being removed. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.remove(PointMapping,UUID)
  id: remove(PointMapping,UUID)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: remove(PointMapping mapping, UUID lockOwnerId)
  nameWithType: ListShardMapper.remove(PointMapping mapping, UUID lockOwnerId)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.remove(PointMapping mapping, UUID lockOwnerId)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.remove*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 204
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Removes a point mapping.</p>

    <p></p>    
  syntax:
    content: public void remove(PointMapping mapping, UUID lockOwnerId)
    parameters:
    - id: mapping
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>Mapping being removed. </p>
    - id: lockOwnerId
      type: add9545a
      description: <p>Lock owner id of the mapping </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.tryLookup(Object,LookupOptions,ReferenceObjectHelper<PointMapping>)
  id: tryLookup(Object,LookupOptions,ReferenceObjectHelper<PointMapping>)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: tryLookup(Object key, LookupOptions lookupOptions, ReferenceObjectHelper<PointMapping> mapping)
  nameWithType: ListShardMapper.tryLookup(Object key, LookupOptions lookupOptions, ReferenceObjectHelper<PointMapping> mapping)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.tryLookup(Object key, LookupOptions lookupOptions, ReferenceObjectHelper<PointMapping> mapping)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.tryLookup*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 242
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Tries to looks up the key value and returns the corresponding mapping.</p>

    <p></p>    
  syntax:
    content: public boolean tryLookup(Object key, LookupOptions lookupOptions, ReferenceObjectHelper<PointMapping> mapping)
    parameters:
    - id: key
      type: "79317049"
      description: <p>Input key value. </p>
    - id: lookupOptions
      type: com.microsoft.azure.elasticdb.shard.base._lookup_options
      description: <p>Whether to use cache and/or storage for lookups. </p>
    - id: mapping
      type: 2695f77dcom.microsoft.azure.elasticdb.shard.base._point_mappinga08ddfce
      description: <p>Mapping that contains the key value. </p>
    return:
      type: 4fc6e284
      description: >-
        <p>

          <code>true</code> if mapping is found, <code>false</code> otherwise. </p>        
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.update(PointMapping,PointMappingUpdate)
  id: update(PointMapping,PointMappingUpdate)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: update(PointMapping currentMapping, PointMappingUpdate update)
  nameWithType: ListShardMapper.update(PointMapping currentMapping, PointMappingUpdate update)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.update(PointMapping currentMapping, PointMappingUpdate update)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.update*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 278
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Allows for update to a point mapping with the updates provided in the <em>update</em>  parameter.</p>

    <p></p>    
  syntax:
    content: public PointMapping update(PointMapping currentMapping, PointMappingUpdate update)
    parameters:
    - id: currentMapping
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>Mapping being updated. </p>
    - id: update
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping_update
      description: <p>Updated properties of the Shard. </p>
    return:
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>New instance of mapping with updated information. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.update(PointMapping,PointMappingUpdate,UUID)
  id: update(PointMapping,PointMappingUpdate,UUID)
  parent: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
  langs:
  - java
  name: update(PointMapping currentMapping, PointMappingUpdate update, UUID lockOwnerId)
  nameWithType: ListShardMapper.update(PointMapping currentMapping, PointMappingUpdate update, UUID lockOwnerId)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.update(PointMapping currentMapping, PointMappingUpdate update, UUID lockOwnerId)
  overload: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.update*
  type: Method
  source:
    remote: *o0
    path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ListShardMapper.java
    startLine: 294
  package: com.microsoft.azure.elasticdb.shard.mapper
  summary: >-
    <p>Allows for update to a point mapping with the updates provided in the <em>update</em>  parameter.</p>

    <p></p>    
  syntax:
    content: public PointMapping update(PointMapping currentMapping, PointMappingUpdate update, UUID lockOwnerId)
    parameters:
    - id: currentMapping
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>Mapping being updated. </p>
    - id: update
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping_update
      description: <p>Updated properties of the Shard. </p>
    - id: lockOwnerId
      type: add9545a
      description: <p>Lock owner id of this mapping </p>
    return:
      type: com.microsoft.azure.elasticdb.shard.base._point_mapping
      description: <p>New instance of mapping with updated information. </p>
references:
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.ListShardMapper*
  name: ListShardMapper
  nameWithType: ListShardMapper.ListShardMapper
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.ListShardMapper
  package: com.microsoft.azure.elasticdb.shard.mapper
- uid: "79317049"
  spec.java:
  - name: Object
    fullName: Object
- uid: "26831127"
  spec.java:
  - name: String
    fullName: String
- uid: 8270ccc2
  spec.java:
  - name: Connection
    fullName: Connection
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.openConnectionForKey*
  name: openConnectionForKey
  nameWithType: ListShardMapper.openConnectionForKey
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.openConnectionForKey
  package: com.microsoft.azure.elasticdb.shard.mapper
- uid: 68f3503d
  spec.java:
  - name: Callable<Connection>
    fullName: Callable<Connection>
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.openConnectionForKeyAsync*
  name: openConnectionForKeyAsync
  nameWithType: ListShardMapper.openConnectionForKeyAsync
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.openConnectionForKeyAsync
  package: com.microsoft.azure.elasticdb.shard.mapper
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.markMappingOffline*
  name: markMappingOffline
  nameWithType: ListShardMapper.markMappingOffline
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.markMappingOffline
  package: com.microsoft.azure.elasticdb.shard.mapper
- uid: add9545a
  spec.java:
  - name: UUID
    fullName: UUID
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.markMappingOnline*
  name: markMappingOnline
  nameWithType: ListShardMapper.markMappingOnline
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.markMappingOnline
  package: com.microsoft.azure.elasticdb.shard.mapper
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.add*
  name: add
  nameWithType: ListShardMapper.add
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.add
  package: com.microsoft.azure.elasticdb.shard.mapper
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.remove*
  name: remove
  nameWithType: ListShardMapper.remove
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.remove
  package: com.microsoft.azure.elasticdb.shard.mapper
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.lookup*
  name: lookup
  nameWithType: ListShardMapper.lookup
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.lookup
  package: com.microsoft.azure.elasticdb.shard.mapper
- uid: 2695f77dcom.microsoft.azure.elasticdb.shard.base._point_mappinga08ddfce
  spec.java:
  - name: ReferenceObjectHelper<
    fullName: ReferenceObjectHelper<
  - uid: com.microsoft.azure.elasticdb.shard.base._point_mapping
    name: PointMapping
    fullName: com.microsoft.azure.elasticdb.shard.base.PointMapping
    href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
  - name: '>'
    fullName: '>'
- uid: 4fc6e284
  spec.java:
  - name: boolean
    fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.tryLookup*
  name: tryLookup
  nameWithType: ListShardMapper.tryLookup
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.tryLookup
  package: com.microsoft.azure.elasticdb.shard.mapper
- uid: 5618da2dcom.microsoft.azure.elasticdb.shard.base._point_mappinga08ddfce
  spec.java:
  - name: List<
    fullName: List<
  - uid: com.microsoft.azure.elasticdb.shard.base._point_mapping
    name: PointMapping
    fullName: com.microsoft.azure.elasticdb.shard.base.PointMapping
    href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
  - name: '>'
    fullName: '>'
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.getMappingsForRange*
  name: getMappingsForRange
  nameWithType: ListShardMapper.getMappingsForRange
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.getMappingsForRange
  package: com.microsoft.azure.elasticdb.shard.mapper
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.update*
  name: update
  nameWithType: ListShardMapper.update
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.update
  package: com.microsoft.azure.elasticdb.shard.mapper
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.getLockOwnerForMapping*
  name: getLockOwnerForMapping
  nameWithType: ListShardMapper.getLockOwnerForMapping
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.getLockOwnerForMapping
  package: com.microsoft.azure.elasticdb.shard.mapper
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.lockOrUnlockMappings*
  name: lockOrUnlockMappings
  nameWithType: ListShardMapper.lockOrUnlockMappings
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper.lockOrUnlockMappings
  package: com.microsoft.azure.elasticdb.shard.mapper
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.add(MappingT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: add(MappingT mapping, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping)
  nameWithType: BaseShardMapper.add(MappingT mapping, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.add(MappingT mapping, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping)
  type: Method
  summary: >-
    <p>Adds a mapping to shard map. </p>

    <p></p>    
  syntax:
    content: protected final<MappingT extends IShardProvider &IMappingInfoProvider> MappingT add(MappingT mapping, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping)
    parameters:
    - id: mapping
      type: e8a622a9
      description: <p>Mapping being added. </p>
    - id: constructMapping
      type: 290a1f3acom.microsoft.azure.elasticdb.shard.mapmanager._shard_map_managerb33c76fccom.microsoft.azure.elasticdb.shard.map._shard_mapb33c76fccom.microsoft.azure.elasticdb.shard.store._store_mapping33d06176
      description: <p>Delegate to construct a mapping object. </p>
    return:
      type: b396dc83com.microsoft.azure.elasticdb.shard.base._i_shard_provider76390d34com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider60fd2f83
      description: <p>The added mapping object. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.add(MappingT)
  parent: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.yml
  name: add(MappingT mapping)
  nameWithType: IShardMapper<MappingT,ValueT>.add(MappingT mapping)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.add(MappingT mapping)
  type: Method
  summary: >-
    <p>Adds a mapping.</p>

    <p></p>    
  syntax:
    content: public MappingT add(MappingT mapping)
    parameters:
    - id: mapping
      type: e8a622a9
      description: <p>Mapping being added. </p>
    return:
      type: e8a622a9
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.BaseShardMapper(ShardMapManager,ShardMap)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: BaseShardMapper(ShardMapManager shardMapManager, ShardMap sm)
  nameWithType: BaseShardMapper.BaseShardMapper(ShardMapManager shardMapManager, ShardMap sm)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.BaseShardMapper(ShardMapManager shardMapManager, ShardMap sm)
  type: Constructor
  summary: >-
    <p>Base shard mapper, which is just a holder of some fields.</p>

    <p></p>    
  syntax:
    content: protected BaseShardMapper(ShardMapManager shardMapManager, ShardMap sm)
    parameters:
    - id: shardMapManager
      type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
      description: <p>Reference to ShardMapManager. </p>
    - id: sm
      type: com.microsoft.azure.elasticdb.shard.map._shard_map
      description: <p>Containing shard map. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.DEFAULT_OWNER
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: DEFAULT_OWNER
  nameWithType: BaseShardMapper.DEFAULT_OWNER
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.DEFAULT_OWNER
  type: Field
  syntax:
    content: protected static final UUID DEFAULT_OWNER= UUID.randomUUID()
    return:
      type: 5668214f
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.ensureMappingBelongsToShardMap(MappingT,String,String)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: ensureMappingBelongsToShardMap(MappingT mapping, String operationName, String parameterName)
  nameWithType: BaseShardMapper.ensureMappingBelongsToShardMap(MappingT mapping, String operationName, String parameterName)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.ensureMappingBelongsToShardMap(MappingT mapping, String operationName, String parameterName)
  type: Method
  summary: >-
    <p>Validates the input parameters and ensures that the mapping parameter belong to this shard map.</p>

    <p></p>    
  syntax:
    content: protected final<MappingT extends IMappingInfoProvider> void ensureMappingBelongsToShardMap(MappingT mapping, String operationName, String parameterName)
    parameters:
    - id: mapping
      type: e8a622a9
      description: <p>Mapping to be validated. </p>
    - id: operationName
      type: "26831127"
      description: <p>Operation being performed. </p>
    - id: parameterName
      type: "26831127"
      description: <p>Parameter name for mapping parameter. </p>
    return:
      type: b396dc83com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider7af52f3a
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.getLockOwnerForMapping(MappingT,ShardManagementErrorCategory)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: getLockOwnerForMapping(MappingT mapping, ShardManagementErrorCategory errorCategory)
  nameWithType: BaseShardMapper.getLockOwnerForMapping(MappingT mapping, ShardManagementErrorCategory errorCategory)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.getLockOwnerForMapping(MappingT mapping, ShardManagementErrorCategory errorCategory)
  type: Method
  summary: >-
    <p>Gets the lock owner of a mapping.</p>

    <p></p>    
  syntax:
    content: public final<MappingT extends IShardProvider &IMappingInfoProvider> UUID getLockOwnerForMapping(MappingT mapping, ShardManagementErrorCategory errorCategory)
    parameters:
    - id: mapping
      type: e8a622a9
      description: <p>The mapping </p>
    - id: errorCategory
      type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
      description: <p>Error category to use for the store operation </p>
    return:
      type: b396dc83com.microsoft.azure.elasticdb.shard.base._i_shard_provider76390d34com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider3dcbd6e4
      description: <p>Lock owner for the mapping. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.getMappingsForRange(Range,Shard,LookupOptions,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,ShardManagementErrorCategory,String)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: getMappingsForRange(Range range, Shard shard, LookupOptions lookupOptions, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String mappingType)
  nameWithType: BaseShardMapper.getMappingsForRange(Range range, Shard shard, LookupOptions lookupOptions, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String mappingType)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.getMappingsForRange(Range range, Shard shard, LookupOptions lookupOptions, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String mappingType)
  type: Method
  summary: >-
    <p>Gets all the mappings that exist within given range.</p>

    <p></p>    
  syntax:
    content: protected final<MappingT> List<MappingT> getMappingsForRange(Range range, Shard shard, LookupOptions lookupOptions, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String mappingType)
    parameters:
    - id: range
      type: com.microsoft.azure.elasticdb.shard.base._range
      description: <p>Optional range value, if null, we cover everything. </p>
    - id: shard
      type: com.microsoft.azure.elasticdb.shard.base._shard
      description: <p>Optional shard parameter, if null, we cover all shards. </p>
    - id: lookupOptions
      type: com.microsoft.azure.elasticdb.shard.base._lookup_options
      description: <p>Whether to use cache and/or storage for lookups. </p>
    - id: constructMapping
      type: 290a1f3acom.microsoft.azure.elasticdb.shard.mapmanager._shard_map_managerb33c76fccom.microsoft.azure.elasticdb.shard.map._shard_mapb33c76fccom.microsoft.azure.elasticdb.shard.store._store_mapping33d06176
      description: <p>Delegate to construct a mapping object. </p>
    - id: errorCategory
      type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
      description: <p>Category under which errors will be posted. </p>
    - id: mappingType
      type: "26831127"
      description: <p>Name of mapping type. </p>
    return:
      type: a32d3674
      description: <p>Read-only collection of mappings that overlap with given range. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.getShardMap()
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: getShardMap()
  nameWithType: BaseShardMapper.getShardMap()
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.getShardMap()
  type: Method
  syntax:
    content: protected final ShardMap getShardMap()
    return:
      type: 93de0ef9com.microsoft.azure.elasticdb.shard.map._shard_map
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.getShardMapManager()
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: getShardMapManager()
  nameWithType: BaseShardMapper.getShardMapManager()
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.getShardMapManager()
  type: Method
  syntax:
    content: protected final ShardMapManager getShardMapManager()
    return:
      type: 93de0ef9com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.lockOrUnlockMappings(MappingT,UUID,LockOwnerIdOpType,ShardManagementErrorCategory)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: lockOrUnlockMappings(MappingT mapping, UUID lockOwnerId, LockOwnerIdOpType lockOwnerIdOpType, ShardManagementErrorCategory errorCategory)
  nameWithType: BaseShardMapper.lockOrUnlockMappings(MappingT mapping, UUID lockOwnerId, LockOwnerIdOpType lockOwnerIdOpType, ShardManagementErrorCategory errorCategory)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.lockOrUnlockMappings(MappingT mapping, UUID lockOwnerId, LockOwnerIdOpType lockOwnerIdOpType, ShardManagementErrorCategory errorCategory)
  type: Method
  summary: >-
    <p>Locks or unlocks a given mapping or all mappings.</p>

    <p></p>    
  syntax:
    content: public final<MappingT extends IShardProvider &IMappingInfoProvider> void lockOrUnlockMappings(MappingT mapping, UUID lockOwnerId, LockOwnerIdOpType lockOwnerIdOpType, ShardManagementErrorCategory errorCategory)
    parameters:
    - id: mapping
      type: e8a622a9
      description: <p>Optional mapping </p>
    - id: lockOwnerId
      type: add9545a
      description: <p>The lock owner id </p>
    - id: lockOwnerIdOpType
      type: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type
      description: <p>Operation to perform on this mapping with the given lockOwnerId </p>
    - id: errorCategory
      type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
      description: <p>Error category to use for the store operation </p>
    return:
      type: b396dc83com.microsoft.azure.elasticdb.shard.base._i_shard_provider76390d34com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider7af52f3a
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.lookup(KeyT,LookupOptions,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,ShardManagementErrorCategory)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: lookup(KeyT key, LookupOptions lookupOptions, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory)
  nameWithType: BaseShardMapper.lookup(KeyT key, LookupOptions lookupOptions, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.lookup(KeyT key, LookupOptions lookupOptions, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory)
  type: Method
  summary: >-
    <p>Looks up the key value and returns the corresponding mapping. </p>

    <p></p>    
  syntax:
    content: protected final<MappingT extends IShardProvider, KeyT> MappingT lookup(KeyT key, LookupOptions lookupOptions, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory)
    parameters:
    - id: key
      type: 3590bc99
      description: <p>Input key value. </p>
    - id: lookupOptions
      type: com.microsoft.azure.elasticdb.shard.base._lookup_options
      description: <p>Whether to use cache and/or storage for lookups. </p>
    - id: constructMapping
      type: 290a1f3acom.microsoft.azure.elasticdb.shard.mapmanager._shard_map_managerb33c76fccom.microsoft.azure.elasticdb.shard.map._shard_mapb33c76fccom.microsoft.azure.elasticdb.shard.store._store_mapping33d06176
      description: <p>Delegate to construct a mapping object. </p>
    - id: errorCategory
      type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
      description: <p>Category under which errors must be thrown. </p>
    return:
      type: b396dc83com.microsoft.azure.elasticdb.shard.base._i_shard_provider3e8e438e
      description: <p>Mapping that contains the key value. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.lookup(ValueT,LookupOptions)
  parent: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.yml
  name: lookup(ValueT key, LookupOptions lookupOptions)
  nameWithType: IShardMapper<MappingT,ValueT>.lookup(ValueT key, LookupOptions lookupOptions)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.lookup(ValueT key, LookupOptions lookupOptions)
  type: Method
  summary: >-
    <p>Looks up the key value and returns the corresponding mapping.</p>

    <p></p>    
  syntax:
    content: public MappingT lookup(ValueT key, LookupOptions lookupOptions)
    parameters:
    - id: key
      type: 0fb6b535
      description: <p>Input key value. </p>
    - id: lookupOptions
      type: com.microsoft.azure.elasticdb.shard.base._lookup_options
      description: <p>Whether to use cache and/or storage for lookups. </p>
    return:
      type: e8a622a9
      description: <p>Mapping that contains the key value. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.openConnectionForKey(KeyT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,ShardManagementErrorCategory,String)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: openConnectionForKey(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString)
  nameWithType: BaseShardMapper.openConnectionForKey(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.openConnectionForKey(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString)
  type: Method
  summary: >-
    <p>Given a key value, obtains a SqlConnection to the shard in the mapping that contains the key value. </p>

    <p></p>    
  syntax:
    content: protected final<MappingT extends IShardProvider, KeyT> Connection openConnectionForKey(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString)
    parameters:
    - id: key
      type: 3590bc99
      description: <p>Input key value. </p>
    - id: constructMapping
      type: 290a1f3acom.microsoft.azure.elasticdb.shard.mapmanager._shard_map_managerb33c76fccom.microsoft.azure.elasticdb.shard.map._shard_mapb33c76fccom.microsoft.azure.elasticdb.shard.store._store_mapping33d06176
      description: <p>Delegate to construct a mapping object. </p>
    - id: errorCategory
      type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
      description: <p>Error category. </p>
    - id: connectionString
      type: "26831127"
      description: <p>Connection string with credential information, the DataSource and Database are obtained from the results of the lookup operation for key. </p>
    return:
      type: b396dc83com.microsoft.azure.elasticdb.shard.base._i_shard_provider5b9092f8
      description: <p>An opened SqlConnection. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.openConnectionForKey(KeyT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,ShardManagementErrorCategory,String,ConnectionOptions)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: openConnectionForKey(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString, ConnectionOptions options)
  nameWithType: BaseShardMapper.openConnectionForKey(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString, ConnectionOptions options)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.openConnectionForKey(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString, ConnectionOptions options)
  type: Method
  summary: >-
    <p>Given a key value, obtains a SqlConnection to the shard in the mapping that contains the key value. </p>

    <p></p>    
  syntax:
    content: protected final<MappingT extends IShardProvider, KeyT> Connection openConnectionForKey(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString, ConnectionOptions options)
    parameters:
    - id: key
      type: 3590bc99
      description: <p>Input key value. </p>
    - id: constructMapping
      type: 290a1f3acom.microsoft.azure.elasticdb.shard.mapmanager._shard_map_managerb33c76fccom.microsoft.azure.elasticdb.shard.map._shard_mapb33c76fccom.microsoft.azure.elasticdb.shard.store._store_mapping33d06176
      description: <p>Delegate to construct a mapping object. </p>
    - id: errorCategory
      type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
      description: <p>Error category. </p>
    - id: connectionString
      type: "26831127"
      description: <p>Connection string with credential information, the DataSource and Database are obtained from the results of the lookup operation for key. </p>
    - id: options
      type: com.microsoft.azure.elasticdb.shard.mapper._connection_options
      description: <p>Options for validation operations to perform on opened connection. </p>
    return:
      type: b396dc83com.microsoft.azure.elasticdb.shard.base._i_shard_provider5b9092f8
      description: <p>An opened SqlConnection. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.openConnectionForKey(ValueT,String)
  parent: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.yml
  name: openConnectionForKey(ValueT key, String connectionString)
  nameWithType: IShardMapper<MappingT,ValueT>.openConnectionForKey(ValueT key, String connectionString)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.openConnectionForKey(ValueT key, String connectionString)
  type: Method
  syntax:
    content: public Connection openConnectionForKey(ValueT key, String connectionString)
    parameters:
    - id: key
      type: 0fb6b535
    - id: connectionString
      type: "26831127"
    return:
      type: 8270ccc2
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.openConnectionForKey(ValueT,String,ConnectionOptions)
  parent: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.yml
  name: openConnectionForKey(ValueT key, String connectionString, ConnectionOptions options)
  nameWithType: IShardMapper<MappingT,ValueT>.openConnectionForKey(ValueT key, String connectionString, ConnectionOptions options)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.openConnectionForKey(ValueT key, String connectionString, ConnectionOptions options)
  type: Method
  summary: >-
    <p>Given a key value, obtains a SqlConnection to the shard in the mapping that contains the key value.</p>

    <p></p>    
  syntax:
    content: public Connection openConnectionForKey(ValueT key, String connectionString, ConnectionOptions options)
    parameters:
    - id: key
      type: 0fb6b535
      description: <p>Input key value. </p>
    - id: connectionString
      type: "26831127"
      description: <p>Connection string with credential information, the DataSource and Database are obtained from the results of the lookup operation for key. </p>
    - id: options
      type: com.microsoft.azure.elasticdb.shard.mapper._connection_options
      description: <p>Options for validation operations to perform on opened connection. </p>
    return:
      type: 8270ccc2
      description: <p>An opened SqlConnection. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.openConnectionForKeyAsync(KeyT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,ShardManagementErrorCategory,String)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: openConnectionForKeyAsync(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString)
  nameWithType: BaseShardMapper.openConnectionForKeyAsync(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.openConnectionForKeyAsync(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString)
  type: Method
  syntax:
    content: protected final<MappingT extends IShardProvider, KeyT> Callable<Connection> openConnectionForKeyAsync(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString)
    parameters:
    - id: key
      type: 3590bc99
    - id: constructMapping
      type: 290a1f3acom.microsoft.azure.elasticdb.shard.mapmanager._shard_map_managerb33c76fccom.microsoft.azure.elasticdb.shard.map._shard_mapb33c76fccom.microsoft.azure.elasticdb.shard.store._store_mapping33d06176
    - id: errorCategory
      type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
    - id: connectionString
      type: "26831127"
    return:
      type: b396dc83com.microsoft.azure.elasticdb.shard.base._i_shard_provider2efa75b7
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.openConnectionForKeyAsync(KeyT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,ShardManagementErrorCategory,String,ConnectionOptions)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: openConnectionForKeyAsync(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString, ConnectionOptions options)
  nameWithType: BaseShardMapper.openConnectionForKeyAsync(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString, ConnectionOptions options)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.openConnectionForKeyAsync(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString, ConnectionOptions options)
  type: Method
  summary: >-
    <p>Given a key value, asynchronously obtains a SqlConnection to the shard in the mapping that contains the key value. </p>

    <p></p>    
  syntax:
    content: protected final<MappingT extends IShardProvider, KeyT> Callable<Connection> openConnectionForKeyAsync(KeyT key, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, ShardManagementErrorCategory errorCategory, String connectionString, ConnectionOptions options)
    parameters:
    - id: key
      type: 3590bc99
      description: <p>Input key value. </p>
    - id: constructMapping
      type: 290a1f3acom.microsoft.azure.elasticdb.shard.mapmanager._shard_map_managerb33c76fccom.microsoft.azure.elasticdb.shard.map._shard_mapb33c76fccom.microsoft.azure.elasticdb.shard.store._store_mapping33d06176
      description: <p>Delegate to construct a mapping object. </p>
    - id: errorCategory
      type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
      description: <p>Error category. </p>
    - id: connectionString
      type: "26831127"
      description: <p>Connection string with credential information, the DataSource and Database are obtained from the results of the lookup operation for key. </p>
    - id: options
      type: com.microsoft.azure.elasticdb.shard.mapper._connection_options
      description: <p>Options for validation operations to perform on opened connection. </p>
    return:
      type: b396dc83com.microsoft.azure.elasticdb.shard.base._i_shard_provider2efa75b7
      description: <p>A task encapsulating an opened SqlConnection as the result. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.openConnectionForKeyAsync(ValueT,String)
  parent: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.yml
  name: openConnectionForKeyAsync(ValueT key, String connectionString)
  nameWithType: IShardMapper<MappingT,ValueT>.openConnectionForKeyAsync(ValueT key, String connectionString)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.openConnectionForKeyAsync(ValueT key, String connectionString)
  type: Method
  syntax:
    content: public Callable<Connection> openConnectionForKeyAsync(ValueT key, String connectionString)
    parameters:
    - id: key
      type: 0fb6b535
    - id: connectionString
      type: "26831127"
    return:
      type: 68f3503d
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.openConnectionForKeyAsync(ValueT,String,ConnectionOptions)
  parent: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.yml
  name: openConnectionForKeyAsync(ValueT key, String connectionString, ConnectionOptions options)
  nameWithType: IShardMapper<MappingT,ValueT>.openConnectionForKeyAsync(ValueT key, String connectionString, ConnectionOptions options)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.openConnectionForKeyAsync(ValueT key, String connectionString, ConnectionOptions options)
  type: Method
  summary: >-
    <p>Given a key value, asynchronously obtains a SqlConnection to the shard in the mapping that contains the key value.</p>

    <p></p>    
  syntax:
    content: public Callable<Connection> openConnectionForKeyAsync(ValueT key, String connectionString, ConnectionOptions options)
    parameters:
    - id: key
      type: 0fb6b535
      description: <p>Input key value. </p>
    - id: connectionString
      type: "26831127"
      description: <p>Connection string with credential information, the DataSource and Database are obtained from the results of the lookup operation for key. </p>
    - id: options
      type: com.microsoft.azure.elasticdb.shard.mapper._connection_options
      description: <p>Options for validation operations to perform on opened connection. </p>
    return:
      type: 68f3503d
      description: <p>An opened SqlConnection. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.remove(MappingT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,UUID)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: remove(MappingT mapping, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, UUID lockOwnerId)
  nameWithType: BaseShardMapper.remove(MappingT mapping, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, UUID lockOwnerId)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.remove(MappingT mapping, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, UUID lockOwnerId)
  type: Method
  summary: >-
    <p>Removes a mapping from shard map. </p>

    <p></p>    
  syntax:
    content: protected final<MappingT extends IShardProvider &IMappingInfoProvider> void remove(MappingT mapping, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, UUID lockOwnerId)
    parameters:
    - id: mapping
      type: e8a622a9
      description: <p>Mapping being removed. </p>
    - id: constructMapping
      type: 290a1f3acom.microsoft.azure.elasticdb.shard.mapmanager._shard_map_managerb33c76fccom.microsoft.azure.elasticdb.shard.map._shard_mapb33c76fccom.microsoft.azure.elasticdb.shard.store._store_mapping33d06176
      description: <p>Delegate to construct a mapping object. </p>
    - id: lockOwnerId
      type: add9545a
      description: <p>Lock owner id of this mapping </p>
    return:
      type: b396dc83com.microsoft.azure.elasticdb.shard.base._i_shard_provider76390d34com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider7af52f3a
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.remove(MappingT,UUID)
  parent: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.yml
  name: remove(MappingT mapping, UUID lockOwnerId)
  nameWithType: IShardMapper<MappingT,ValueT>.remove(MappingT mapping, UUID lockOwnerId)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.remove(MappingT mapping, UUID lockOwnerId)
  type: Method
  summary: >-
    <p>Removes a mapping.</p>

    <p></p>    
  syntax:
    content: public void remove(MappingT mapping, UUID lockOwnerId)
    parameters:
    - id: mapping
      type: e8a622a9
      description: <p>Mapping being removed. </p>
    - id: lockOwnerId
      type: add9545a
      description: <p>Lock owner id of the mapping </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.setStatus(MappingT,StatusT,Function<StatusT, StatusT>,Function<StatusT, UpdateT>,ActionGeneric3Param<MappingT, UpdateT, UUID, MappingT>)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: setStatus(MappingT mapping, StatusT status, Function<StatusT, StatusT> getStatus, Function<StatusT, UpdateT> createUpdate, ActionGeneric3Param<MappingT, UpdateT, UUID, MappingT> runUpdate)
  nameWithType: BaseShardMapper.setStatus(MappingT mapping, StatusT status, Function<StatusT, StatusT> getStatus, Function<StatusT, UpdateT> createUpdate, ActionGeneric3Param<MappingT, UpdateT, UUID, MappingT> runUpdate)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.setStatus(MappingT mapping, StatusT status, Function<StatusT, StatusT> getStatus, Function<StatusT, UpdateT> createUpdate, ActionGeneric3Param<MappingT, UpdateT, UUID, MappingT> runUpdate)
  type: Method
  summary: >-
    <p>Sets the status of a shard mapping </p>

    <p></p>    
  syntax:
    content: protected static static<MappingT, UpdateT, StatusT> MappingT setStatus(MappingT mapping, StatusT status, Function<StatusT, StatusT> getStatus, Function<StatusT, UpdateT> createUpdate, ActionGeneric3Param<MappingT, UpdateT, UUID, MappingT> runUpdate)
    parameters:
    - id: mapping
      type: e8a622a9
      description: <p>Mapping being added. </p>
    - id: status
      type: "6102e815"
      description: <p>Status of <em>mapping</em> mapping being added. </p>
    - id: getStatus
      type: 3f172bda
      description: <p>Delegate to construct new status from <em>status</em> input status. </p>
    - id: createUpdate
      type: 39fa7c63
      description: <p>Delegate to construct new update from new status returned by <em>getStatus</em> getStatus. </p>
    - id: runUpdate
      type: 656daaab
      description: <p>Delegate to perform update from the <em>mapping</em> input mapping and the update object returned by <em>getStatus</em> createUpdate . </p>
    return:
      type: 4ff6e6da
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.setStatus(MappingT,StatusT,Function<StatusT, StatusT>,Function<StatusT, UpdateT>,ActionGeneric3Param<MappingT, UpdateT, UUID, MappingT>,UUID)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: setStatus(MappingT mapping, StatusT status, Function<StatusT, StatusT> getStatus, Function<StatusT, UpdateT> createUpdate, ActionGeneric3Param<MappingT, UpdateT, UUID, MappingT> runUpdate, UUID lockOwnerId)
  nameWithType: BaseShardMapper.setStatus(MappingT mapping, StatusT status, Function<StatusT, StatusT> getStatus, Function<StatusT, UpdateT> createUpdate, ActionGeneric3Param<MappingT, UpdateT, UUID, MappingT> runUpdate, UUID lockOwnerId)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.setStatus(MappingT mapping, StatusT status, Function<StatusT, StatusT> getStatus, Function<StatusT, UpdateT> createUpdate, ActionGeneric3Param<MappingT, UpdateT, UUID, MappingT> runUpdate, UUID lockOwnerId)
  type: Method
  summary: >-
    <p>Sets the status of a shard mapping </p>

    <p></p>    
  syntax:
    content: protected static static<MappingT, UpdateT, StatusT> MappingT setStatus(MappingT mapping, StatusT status, Function<StatusT, StatusT> getStatus, Function<StatusT, UpdateT> createUpdate, ActionGeneric3Param<MappingT, UpdateT, UUID, MappingT> runUpdate, UUID lockOwnerId)
    parameters:
    - id: mapping
      type: e8a622a9
      description: <p>Mapping being added. </p>
    - id: status
      type: "6102e815"
      description: <p>Status of <em>mapping</em> mapping being added. </p>
    - id: getStatus
      type: 3f172bda
      description: <p>Delegate to construct new status from <em>status</em> input status. </p>
    - id: createUpdate
      type: 39fa7c63
      description: <p>Delegate to construct new update from new status returned by <em>getStatus</em> getStatus. </p>
    - id: runUpdate
      type: 656daaab
      description: <p>Delegate to perform update from the <em>mapping</em> input mapping and the update object returned by <em>getStatus</em> createUpdate . </p>
    - id: lockOwnerId
      type: add9545a
      description: <p>Lock owner id of this mapping </p>
    return:
      type: 4ff6e6da
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.shardMap
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: shardMap
  nameWithType: BaseShardMapper.shardMap
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.shardMap
  type: Field
  summary: <p>Containing shard map. </p>
  syntax:
    content: protected ShardMap shardMap
    return:
      type: com.microsoft.azure.elasticdb.shard.map._shard_map
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.shardMapManager
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: shardMapManager
  nameWithType: BaseShardMapper.shardMapManager
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.shardMapManager
  type: Field
  summary: <p>Reference to ShardMapManager. </p>
  syntax:
    content: protected ShardMapManager shardMapManager
    return:
      type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.tryLookup(ValueT,LookupOptions,ReferenceObjectHelper<MappingT>)
  parent: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.yml
  name: tryLookup(ValueT key, LookupOptions lookupOptions, ReferenceObjectHelper<MappingT> mapping)
  nameWithType: IShardMapper<MappingT,ValueT>.tryLookup(ValueT key, LookupOptions lookupOptions, ReferenceObjectHelper<MappingT> mapping)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.tryLookup(ValueT key, LookupOptions lookupOptions, ReferenceObjectHelper<MappingT> mapping)
  type: Method
  summary: >-
    <p>Tries to looks up the key value and returns the corresponding mapping.</p>

    <p></p>    
  syntax:
    content: public boolean tryLookup(ValueT key, LookupOptions lookupOptions, ReferenceObjectHelper<MappingT> mapping)
    parameters:
    - id: key
      type: 0fb6b535
      description: <p>Input key value. </p>
    - id: lookupOptions
      type: com.microsoft.azure.elasticdb.shard.base._lookup_options
      description: <p>Whether to use cache and/or storage for lookups. </p>
    - id: mapping
      type: 1d490b8c
      description: <p>Mapping that contains the key value. </p>
    return:
      type: 4fc6e284
      description: >-
        <p>

          <code>true</code> if mapping is found, <code>false</code> otherwise. </p>        
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.update(MappingT,UpdateT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,Function<StatusT, Integer>,Function<Integer, StatusT>)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: update(MappingT currentMapping, UpdateT update, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, Function<StatusT, Integer> statusAsInt, Function<Integer, StatusT> intAsStatus)
  nameWithType: BaseShardMapper.update(MappingT currentMapping, UpdateT update, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, Function<StatusT, Integer> statusAsInt, Function<Integer, StatusT> intAsStatus)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.update(MappingT currentMapping, UpdateT update, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, Function<StatusT, Integer> statusAsInt, Function<Integer, StatusT> intAsStatus)
  type: Method
  summary: >-
    <p>Allows for update to a mapping with the updates provided in the <em>update</em>  parameter.</p>

    <p></p>    
  syntax:
    content: protected final<MappingT extends IShardProvider &IMappingInfoProvider, UpdateT extends IMappingUpdate<StatusT>, StatusT> MappingT update(MappingT currentMapping, UpdateT update, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, Function<StatusT, Integer> statusAsInt, Function<Integer, StatusT> intAsStatus)
    parameters:
    - id: currentMapping
      type: e8a622a9
      description: <p>Mapping being updated. </p>
    - id: update
      type: 1c6c308f
      description: <p>Updated properties of the Shard. </p>
    - id: constructMapping
      type: 290a1f3acom.microsoft.azure.elasticdb.shard.mapmanager._shard_map_managerb33c76fccom.microsoft.azure.elasticdb.shard.map._shard_mapb33c76fccom.microsoft.azure.elasticdb.shard.store._store_mapping33d06176
      description: <p>Delegate to construct a mapping object. </p>
    - id: statusAsInt
      type: 3d63a4b2
      description: <p>Delegate to get the mapping status as an integer value. </p>
    - id: intAsStatus
      type: 6dcea5ac
      description: <p>Delegate to get the mapping status from an integer value. </p>
    return:
      type: b396dc83com.microsoft.azure.elasticdb.shard.base._i_shard_provider76390d34com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider5312cdf4com.microsoft.azure.elasticdb.shard.base._i_mapping_update4c63efdb
      description: <p>New instance of mapping with updated information. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.update(MappingT,UpdateT,ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT>,Function<StatusT, Integer>,Function<Integer, StatusT>,UUID)
  parent: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: update(MappingT currentMapping, UpdateT update, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, Function<StatusT, Integer> statusAsInt, Function<Integer, StatusT> intAsStatus, UUID lockOwnerId)
  nameWithType: BaseShardMapper.update(MappingT currentMapping, UpdateT update, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, Function<StatusT, Integer> statusAsInt, Function<Integer, StatusT> intAsStatus, UUID lockOwnerId)
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper.update(MappingT currentMapping, UpdateT update, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, Function<StatusT, Integer> statusAsInt, Function<Integer, StatusT> intAsStatus, UUID lockOwnerId)
  type: Method
  summary: >-
    <p>Allows for update to a mapping with the updates provided in the <em>update</em>  parameter.</p>

    <p></p>    
  syntax:
    content: protected final<MappingT extends IShardProvider &IMappingInfoProvider, UpdateT extends IMappingUpdate<StatusT>, StatusT> MappingT update(MappingT currentMapping, UpdateT update, ActionGeneric3Param<ShardMapManager, ShardMap, StoreMapping, MappingT> constructMapping, Function<StatusT, Integer> statusAsInt, Function<Integer, StatusT> intAsStatus, UUID lockOwnerId)
    parameters:
    - id: currentMapping
      type: e8a622a9
      description: <p>Mapping being updated. </p>
    - id: update
      type: 1c6c308f
      description: <p>Updated properties of the Shard. </p>
    - id: constructMapping
      type: 290a1f3acom.microsoft.azure.elasticdb.shard.mapmanager._shard_map_managerb33c76fccom.microsoft.azure.elasticdb.shard.map._shard_mapb33c76fccom.microsoft.azure.elasticdb.shard.store._store_mapping33d06176
      description: <p>Delegate to construct a mapping object. </p>
    - id: statusAsInt
      type: 3d63a4b2
      description: <p>Delegate to get the mapping status as an integer value. </p>
    - id: intAsStatus
      type: 6dcea5ac
      description: <p>Delegate to get the mapping status from an integer value. </p>
    - id: lockOwnerId
      type: add9545a
      description: <p>Lock owner id of this mapping </p>
    return:
      type: b396dc83com.microsoft.azure.elasticdb.shard.base._i_shard_provider76390d34com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider5312cdf4com.microsoft.azure.elasticdb.shard.base._i_mapping_update4c63efdb
      description: <p>New instance of mapping with updated information. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
  parent: com.microsoft.azure.elasticdb.shard.mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper.yml
  name: BaseShardMapper
  nameWithType: BaseShardMapper
  fullName: com.microsoft.azure.elasticdb.shard.mapper.BaseShardMapper
  type: Class
  summary: <p>Base class for keyed mappers. </p>
  syntax:
    content: public class BaseShardMapper
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
  parent: com.microsoft.azure.elasticdb.shard.mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.yml
  name: IShardMapper<MappingT,ValueT>
  nameWithType: IShardMapper<MappingT,ValueT>
  fullName: com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT,ValueT>
  type: Interface
  summary: <p>Container for a collection of keys to shards mappings. </p>
  syntax:
    content: public interface IShardMapper<MappingT extends IShardProvider,ValueT>
    typeParameters:
    - id: MappingT
      type: e8a622a9
    - id: ValueT
      type: 0fb6b535
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
  parent: com.microsoft.azure.elasticdb.shard.mapmanager
  href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager.yml
  name: ShardMapManager
  nameWithType: ShardMapManager
  fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManager
  type: Class
  summary: <p>Serves as the entry point for creation, management and lookup operations over shard maps. </p>
  syntax:
    content: public class ShardMapManager
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map
  parent: com.microsoft.azure.elasticdb.shard.map
  href: com.microsoft.azure.elasticdb.shard.map._shard_map.yml
  name: ShardMap
  nameWithType: ShardMap
  fullName: com.microsoft.azure.elasticdb.shard.map.ShardMap
  type: Class
  summary: <p>Represents a collection of shards and mappings between keys and shards in the collection. </p>
  syntax:
    content: public class ShardMap
- uid: com.microsoft.azure.elasticdb.shard.mapper._connection_options
  parent: com.microsoft.azure.elasticdb.shard.mapper
  href: com.microsoft.azure.elasticdb.shard.mapper._connection_options.yml
  name: ConnectionOptions
  nameWithType: ConnectionOptions
  fullName: com.microsoft.azure.elasticdb.shard.mapper.ConnectionOptions
  type: Enum
  syntax:
    content: public enum ConnectionOptions
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping
  parent: com.microsoft.azure.elasticdb.shard.base
  href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
  name: PointMapping
  nameWithType: PointMapping
  fullName: com.microsoft.azure.elasticdb.shard.base.PointMapping
  type: Class
  summary: <p>Represents a mapping between the singleton key value of a shardlet (a point) and a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>. </p>
  syntax:
    content: public class PointMapping
- uid: com.microsoft.azure.elasticdb.shard.base._lookup_options
  parent: com.microsoft.azure.elasticdb.shard.base
  href: com.microsoft.azure.elasticdb.shard.base._lookup_options.yml
  name: LookupOptions
  nameWithType: LookupOptions
  fullName: com.microsoft.azure.elasticdb.shard.base.LookupOptions
  type: Class
  summary: <p>Specifies where mapping lookup operations will search for mappings. </p>
  syntax:
    content: public class LookupOptions
- uid: com.microsoft.azure.elasticdb.shard.base._range
  parent: com.microsoft.azure.elasticdb.shard.base
  href: com.microsoft.azure.elasticdb.shard.base._range.yml
  name: Range
  nameWithType: Range
  fullName: com.microsoft.azure.elasticdb.shard.base.Range
  type: Class
  summary: <p>Represents a left-inclusive, right-exclusive range of values. </p>
  syntax:
    content: public class Range
- uid: com.microsoft.azure.elasticdb.shard.base._shard
  parent: com.microsoft.azure.elasticdb.shard.base
  href: com.microsoft.azure.elasticdb.shard.base._shard.yml
  name: Shard
  nameWithType: Shard
  fullName: com.microsoft.azure.elasticdb.shard.base.Shard
  type: Class
  summary: <p>Representation of a single shard. Shards are basically locators for data sources i.e. <xref uid="com.microsoft.azure.elasticdb.shard.base._shard_location" data-throw-if-not-resolved="false">ShardLocation</xref>s that have been registered with a shard map. Shards are used in mapping as targets of mappings (see <xref uid="com.microsoft.azure.elasticdb.shard.base._point_mapping" data-throw-if-not-resolved="false">PointMapping</xref> and <xref uid="com.microsoft.azure.elasticdb.shard.base._range_mapping" data-throw-if-not-resolved="false">RangeMapping</xref>). </p>
  syntax:
    content: public class Shard
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_update
  parent: com.microsoft.azure.elasticdb.shard.base
  href: com.microsoft.azure.elasticdb.shard.base._point_mapping_update.yml
  name: PointMappingUpdate
  nameWithType: PointMappingUpdate
  fullName: com.microsoft.azure.elasticdb.shard.base.PointMappingUpdate
  type: Class
  summary: <p>Represents updates to a mapping between the singleton key value of a shardlet (a point) and the shard that holds its data. Also see PointMapping&lt;KeyT&gt;. </p>
  syntax:
    content: public class PointMappingUpdate
- uid: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type
  parent: com.microsoft.azure.elasticdb.shard.base
  href: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.yml
  name: LockOwnerIdOpType
  nameWithType: LockOwnerIdOpType
  fullName: com.microsoft.azure.elasticdb.shard.base.LockOwnerIdOpType
  type: Enum
  summary: <p>Set of operations that can be performed on mappings with lockOwnerId. </p>
  syntax:
    content: public enum LockOwnerIdOpType