com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.yml

### YamlMime:JavaType
constructors:
- fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.MultiShardConnection(ArrayList<Pair<ShardLocation, Connection>> shardConnections)
  name: MultiShardConnection(ArrayList<Pair<ShardLocation, Connection>> shardConnections)
  nameWithType: MultiShardConnection.MultiShardConnection(ArrayList<Pair<ShardLocation, Connection>> shardConnections)
  parameters:
  - description: <p>Connections to the shards </p>
    name: shardConnections
    type: ArrayList&lt;Pair&lt;<xref href="com.microsoft.azure.elasticdb.shard.base.ShardLocation?alt=com.microsoft.azure.elasticdb.shard.base.ShardLocation&text=ShardLocation" data-throw-if-not-resolved="False"/>, Connection&gt;&gt;
  summary: >-
    <p>Creates an instance of this class. TEST ONLY</p>

    <p></p>
  syntax: public MultiShardConnection(ArrayList<Pair<ShardLocation, Connection>> shardConnections)
  uid: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.MultiShardConnection(ArrayList<Pair<ShardLocation, Connection>>)
- fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.MultiShardConnection(String connectionString, Shard... shards)
  name: MultiShardConnection(String connectionString, Shard... shards)
  nameWithType: MultiShardConnection.MultiShardConnection(String connectionString, Shard... shards)
  parameters:
  - description: <p>These credentials will be used to connect to the Shards. The same credentials are used on all shards. Therefore, all shards need to provide the appropriate permissions for these credentials to execute the command. </p>
    name: connectionString
    type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
  - description: <p>The collection of Shards used for this connection instances.</p>
    name: shards
    type: <xref href="Shard...?alt=Shard...&text=Shard..." data-throw-if-not-resolved="False"/>
  summary: >-
    <p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection" data-throw-if-not-resolved="false" data-raw-source="MultiShardConnection"></xref> class.</p>

    <p>

    Multiple Active Result Sets (MARS) are not supported and are disabled for any processing at the shards. </p>
  syntax: public MultiShardConnection(String connectionString, Shard... shards)
  uid: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.MultiShardConnection(String,Shard...)
- fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.MultiShardConnection(String connectionString, ShardLocation... shardLocations)
  name: MultiShardConnection(String connectionString, ShardLocation... shardLocations)
  nameWithType: MultiShardConnection.MultiShardConnection(String connectionString, ShardLocation... shardLocations)
  parameters:
  - description: <p>These credentials will be used to connect to the Shards. The same credentials are used on all shards. Therefore, all shards need to provide the appropriate permissions for these credentials to execute the command.</p>
    name: connectionString
    type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
  - description: <p>The collection of ShardLocations used for this connection instances. </p>
    name: shardLocations
    type: <xref href="ShardLocation...?alt=ShardLocation...&text=ShardLocation..." data-throw-if-not-resolved="False"/>
  summary: >-
    <p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection" data-throw-if-not-resolved="false" data-raw-source="MultiShardConnection"></xref> class.</p>

    <p>

    Multiple Active Result Sets (MARS) are not supported and are disabled for any processing at the shards. </p>
  syntax: public MultiShardConnection(String connectionString, ShardLocation... shardLocations)
  uid: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.MultiShardConnection(String,ShardLocation...)
fields:
- field:
    type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
  fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.ApplicationNameSuffix
  name: ApplicationNameSuffix
  nameWithType: MultiShardConnection.ApplicationNameSuffix
  summary: <p>The suffix to append to each shard's ApplicationName. Will help with server-side telemetry. </p>
  syntax: public static String ApplicationNameSuffix= "ESC_MSQv" + GlobalConstants.MultiShardQueryVersionInfo
  uid: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.ApplicationNameSuffix
inheritances:
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
- <xref href="AutoCloseable" data-throw-if-not-resolved="False"/>
methods:
- fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.close()
  name: close()
  nameWithType: MultiShardConnection.close()
  summary: <p>Releases all resources used by this object. </p>
  syntax: public void close()
  uid: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.close()
- fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.closeOpenConnections()
  name: closeOpenConnections()
  nameWithType: MultiShardConnection.closeOpenConnections()
  summary: <p>Closes any open connections to shards. Does a best-effort close and doesn't throw. </p>
  syntax: public void closeOpenConnections()
  uid: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.closeOpenConnections()
- fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.createCommand()
  name: createCommand()
  nameWithType: MultiShardConnection.createCommand()
  returns:
    description: <p>the <xref uid="com.microsoft.azure.elasticdb.query.multishard.MultiShardStatement" data-throw-if-not-resolved="false" data-raw-source="MultiShardStatement"></xref> with CommandText set to null. </p>
    type: <xref href="com.microsoft.azure.elasticdb.query.multishard.MultiShardStatement?alt=com.microsoft.azure.elasticdb.query.multishard.MultiShardStatement&text=MultiShardStatement" data-throw-if-not-resolved="False"/>
  summary: >-
    <p>Creates and returns a <xref uid="com.microsoft.azure.elasticdb.query.multishard.MultiShardStatement" data-throw-if-not-resolved="false" data-raw-source="MultiShardStatement"></xref> object. The <xref uid="com.microsoft.azure.elasticdb.query.multishard.MultiShardStatement" data-throw-if-not-resolved="false" data-raw-source="MultiShardStatement"></xref> object can then be used to execute a command against all shards specified in the connection.</p>

    <p></p>
  syntax: public MultiShardStatement createCommand()
  uid: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.createCommand()
- fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getConnectionString()
  name: getConnectionString()
  nameWithType: MultiShardConnection.getConnectionString()
  returns:
    type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
  summary: <p>Gets the connection string associated with this connection. </p>
  syntax: public String getConnectionString()
  uid: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getConnectionString()
- fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getShardConnections()
  name: getShardConnections()
  nameWithType: MultiShardConnection.getShardConnections()
  returns:
    type: List&lt;Pair&lt;<xref href="com.microsoft.azure.elasticdb.shard.base.ShardLocation?alt=com.microsoft.azure.elasticdb.shard.base.ShardLocation&text=ShardLocation" data-throw-if-not-resolved="False"/>, Connection&gt;&gt;
  summary: <p>Gets the collection of ShardLocations and Connections associated with this connection. </p>
  syntax: public List<Pair<ShardLocation, Connection>> getShardConnections()
  uid: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getShardConnections()
- fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getShardLocations()
  name: getShardLocations()
  nameWithType: MultiShardConnection.getShardLocations()
  returns:
    type: List&lt;<xref href="com.microsoft.azure.elasticdb.shard.base.ShardLocation?alt=com.microsoft.azure.elasticdb.shard.base.ShardLocation&text=ShardLocation" data-throw-if-not-resolved="False"/>&gt;
  summary: <p>Gets the collection of ShardLocations associated with this connection. </p>
  syntax: public List<ShardLocation> getShardLocations()
  uid: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getShardLocations()
- fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getShards()
  name: getShards()
  nameWithType: MultiShardConnection.getShards()
  returns:
    type: List&lt;<xref href="com.microsoft.azure.elasticdb.shard.base.Shard?alt=com.microsoft.azure.elasticdb.shard.base.Shard&text=Shard" data-throw-if-not-resolved="False"/>&gt;
  summary: <p>Gets the collection of Shards associated with this connection. </p>
  syntax: public List<Shard> getShards()
  uid: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getShards()
- fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.isClosed()
  name: isClosed()
  nameWithType: MultiShardConnection.isClosed()
  returns:
    description: <p>true if open, false if closed. </p>
    type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
  summary: >-
    <p>Check if connection is closed or not.</p>

    <p></p>
  syntax: public boolean isClosed()
  uid: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.isClosed()
nameWithType: MultiShardConnection
syntax: public class MultiShardConnection
type: class
uid: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection
name: MultiShardConnection
package: com.microsoft.azure.elasticdb.query.multishard
summary: '<p>Represents a connection to a set of shards and provides the ability to process queries across the shard set. Purpose: Creates connections to the given set of shards and governs their lifetime Notes: This class is NOT thread-safe. </p>'
metadata: {}