This commit is contained in:
OpenPublishBuild 2017-11-28 08:40:27 +00:00
Родитель ec512bb28e
Коммит 97e139599a
167 изменённых файлов: 56951 добавлений и 5602 удалений

Просмотреть файл

@ -0,0 +1,450 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff
id: _exponential_backoff
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
children:
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.ExponentialBackoff()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.ExponentialBackoff(int,Duration,Duration,Duration)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.ExponentialBackoff(String,int,Duration,Duration,Duration)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.ExponentialBackoff(String,int,Duration,Duration,Duration,boolean)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.getShouldRetry()
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.yml
langs:
- java
name: ExponentialBackoff
nameWithType: ExponentialBackoff
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ExponentialBackoff
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/ExponentialBackoff.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/ExponentialBackoff.java
startLine: 18
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>A retry strategy with backoff parameters for calculating the exponential delay between retries. </p>
syntax: &o1
content: public class ExponentialBackoff extends RetryStrategy
inheritance:
- java.lang.Object
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
inheritedMembers:
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_BACKOFF
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_FIRST_FAST_RETRY
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MAX_BACKOFF
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MIN_BACKOFF
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INCREMENT
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultExponential()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultFixed()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultProgressive()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getFastFirstRetry()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getName()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getNoRetry()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.RetryStrategy(String,boolean)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.setFastFirstRetry(boolean)
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.ExponentialBackoff()
id: ExponentialBackoff()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.yml
langs:
- java
name: ExponentialBackoff()
nameWithType: ExponentialBackoff.ExponentialBackoff()
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ExponentialBackoff.ExponentialBackoff()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.ExponentialBackoff*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/ExponentialBackoff.java
startLine: 28
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff" data-throw-if-not-resolved="false">ExponentialBackoff</xref> class. </p>
syntax:
content: public ExponentialBackoff()
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.ExponentialBackoff(int,Duration,Duration,Duration)
id: ExponentialBackoff(int,Duration,Duration,Duration)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.yml
langs:
- java
name: ExponentialBackoff(int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff)
nameWithType: ExponentialBackoff.ExponentialBackoff(int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ExponentialBackoff.ExponentialBackoff(int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.ExponentialBackoff*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/ExponentialBackoff.java
startLine: 44
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff" data-throw-if-not-resolved="false">ExponentialBackoff</xref> class with the specified retry settings.</p>
<p></p>
syntax:
content: public ExponentialBackoff(int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff)
parameters:
- id: retryCount
type: f75371fa
description: <p>The maximum number of retry attempts. </p>
- id: minBackoff
type: e02a2de0
description: <p>The minimum backoff time </p>
- id: maxBackoff
type: e02a2de0
description: <p>The maximum backoff time. </p>
- id: deltaBackoff
type: e02a2de0
description: <p>The value that will be used to calculate a random delta in the exponential delay between retries. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.ExponentialBackoff(String,int,Duration,Duration,Duration)
id: ExponentialBackoff(String,int,Duration,Duration,Duration)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.yml
langs:
- java
name: ExponentialBackoff(String name, int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff)
nameWithType: ExponentialBackoff.ExponentialBackoff(String name, int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ExponentialBackoff.ExponentialBackoff(String name, int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.ExponentialBackoff*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/ExponentialBackoff.java
startLine: 65
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff" data-throw-if-not-resolved="false">ExponentialBackoff</xref> class with the specified name and retry settings.</p>
<p></p>
syntax:
content: public ExponentialBackoff(String name, int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff)
parameters:
- id: name
type: "26831127"
description: <p>The name of the retry strategy. </p>
- id: retryCount
type: f75371fa
description: <p>The maximum number of retry attempts. </p>
- id: minBackoff
type: e02a2de0
description: <p>The minimum backoff time </p>
- id: maxBackoff
type: e02a2de0
description: <p>The maximum backoff time. </p>
- id: deltaBackoff
type: e02a2de0
description: <p>The value that will be used to calculate a random delta in the exponential delay between retries. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.ExponentialBackoff(String,int,Duration,Duration,Duration,boolean)
id: ExponentialBackoff(String,int,Duration,Duration,Duration,boolean)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.yml
langs:
- java
name: ExponentialBackoff(String name, int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff, boolean firstFastRetry)
nameWithType: ExponentialBackoff.ExponentialBackoff(String name, int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff, boolean firstFastRetry)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ExponentialBackoff.ExponentialBackoff(String name, int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff, boolean firstFastRetry)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.ExponentialBackoff*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/ExponentialBackoff.java
startLine: 90
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff" data-throw-if-not-resolved="false">ExponentialBackoff</xref> class with the specified name, retry settings, and fast retry option.</p>
<p></p>
syntax:
content: public ExponentialBackoff(String name, int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff, boolean firstFastRetry)
parameters:
- id: name
type: "26831127"
description: <p>The name of the retry strategy. </p>
- id: retryCount
type: f75371fa
description: <p>The maximum number of retry attempts. </p>
- id: minBackoff
type: e02a2de0
description: <p>The minimum backoff time </p>
- id: maxBackoff
type: e02a2de0
description: <p>The maximum backoff time. </p>
- id: deltaBackoff
type: e02a2de0
description: <p>The value that will be used to calculate a random delta in the exponential delay between retries. </p>
- id: firstFastRetry
type: 4fc6e284
description: <p>true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.getShouldRetry()
id: getShouldRetry()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.yml
langs:
- java
name: getShouldRetry()
nameWithType: ExponentialBackoff.getShouldRetry()
fullName: ShouldRetry com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ExponentialBackoff.getShouldRetry()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.getShouldRetry*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/ExponentialBackoff.java
startLine: 115
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Returns the corresponding <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry" data-throw-if-not-resolved="false">ShouldRetry</xref> delegate.</p>
<p></p>
syntax:
content: public ShouldRetry getShouldRetry()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry
description: <p>The <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry" data-throw-if-not-resolved="false">ShouldRetry</xref> delegate. </p>
references:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.ExponentialBackoff*
name: ExponentialBackoff
nameWithType: ExponentialBackoff.ExponentialBackoff
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ExponentialBackoff.ExponentialBackoff
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: e02a2de0
spec.java:
- name: Duration
fullName: Duration
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.getShouldRetry*
name: getShouldRetry
nameWithType: ExponentialBackoff.getShouldRetry
fullName: ShouldRetry com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ExponentialBackoff.getShouldRetry
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_CLIENT_BACKOFF
nameWithType: RetryStrategy.DEFAULT_CLIENT_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_BACKOFF
type: Field
summary: <p>Represents the default amount of time used when calculating a random delta in the exponential delay between retries. </p>
syntax:
content: public static final Duration DEFAULT_CLIENT_BACKOFF= Duration.ofSeconds(10)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_CLIENT_RETRY_COUNT
nameWithType: RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT
fullName: final int com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT
type: Field
summary: <p>#region Public members </p><p>Represents the default number of retry attempts. </p>
syntax:
content: public static final int DEFAULT_CLIENT_RETRY_COUNT= 10
return:
type: cd225469
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_FIRST_FAST_RETRY
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_FIRST_FAST_RETRY
nameWithType: RetryStrategy.DEFAULT_FIRST_FAST_RETRY
fullName: final boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_FIRST_FAST_RETRY
type: Field
summary: <p>Represents the default flag indicating whether the first retry attempt will be made immediately, whereas subsequent retries will remain subject to the retry interval. </p>
syntax:
content: public static final boolean DEFAULT_FIRST_FAST_RETRY= true
return:
type: 4dda0764
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MAX_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_MAX_BACKOFF
nameWithType: RetryStrategy.DEFAULT_MAX_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MAX_BACKOFF
type: Field
summary: <p>Represents the default maximum amount of time used when calculating the exponential delay between retries. </p>
syntax:
content: public static final Duration DEFAULT_MAX_BACKOFF= Duration.ofSeconds(30)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MIN_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_MIN_BACKOFF
nameWithType: RetryStrategy.DEFAULT_MIN_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MIN_BACKOFF
type: Field
summary: <p>Represents the default minimum amount of time used when calculating the exponential delay between retries. </p>
syntax:
content: public static final Duration DEFAULT_MIN_BACKOFF= Duration.ofSeconds(1)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INCREMENT
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_RETRY_INCREMENT
nameWithType: RetryStrategy.DEFAULT_RETRY_INCREMENT
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INCREMENT
type: Field
summary: <p>Represents the default time increment between retry attempts in the progressive delay policy. </p>
syntax:
content: public static final Duration DEFAULT_RETRY_INCREMENT= Duration.ofSeconds(1)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_RETRY_INTERVAL
nameWithType: RetryStrategy.DEFAULT_RETRY_INTERVAL
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INTERVAL
type: Field
summary: <p>Represents the default interval between retries. </p>
syntax:
content: public static final Duration DEFAULT_RETRY_INTERVAL= Duration.ofSeconds(1)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultExponential()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getDefaultExponential()
nameWithType: RetryStrategy.getDefaultExponential()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultExponential()
type: Method
summary: <p>Returns a default policy that implements a random exponential retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT</xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MIN_BACKOFF" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_MIN_BACKOFF</xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MAX_BACKOFF" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_MAX_BACKOFF</xref>, and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_BACKOFF" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_BACKOFF</xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryStrategy getDefaultExponential()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultFixed()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getDefaultFixed()
nameWithType: RetryStrategy.getDefaultFixed()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultFixed()
type: Method
summary: <p>Returns a default policy that implements a fixed retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT</xref> and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_RETRY_INTERVAL</xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryStrategy getDefaultFixed()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultProgressive()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getDefaultProgressive()
nameWithType: RetryStrategy.getDefaultProgressive()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultProgressive()
type: Method
summary: <p>Returns a default policy that implements a progressive retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT</xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_RETRY_INTERVAL</xref>, and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INCREMENT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_RETRY_INCREMENT</xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryStrategy getDefaultProgressive()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getFastFirstRetry()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getFastFirstRetry()
nameWithType: RetryStrategy.getFastFirstRetry()
fullName: final boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getFastFirstRetry()
type: Method
syntax:
content: public final boolean getFastFirstRetry()
return:
type: 4dda0764
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getName()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getName()
nameWithType: RetryStrategy.getName()
fullName: final String com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getName()
type: Method
syntax:
content: public final String getName()
return:
type: 3d93591e
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getNoRetry()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getNoRetry()
nameWithType: RetryStrategy.getNoRetry()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getNoRetry()
type: Method
summary: <p>Returns a default policy that performs no retries, but invokes the action only once. </p>
syntax:
content: public static RetryStrategy getNoRetry()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.RetryStrategy(String,boolean)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: RetryStrategy(String name, boolean firstFastRetry)
nameWithType: RetryStrategy.RetryStrategy(String name, boolean firstFastRetry)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.RetryStrategy(String name, boolean firstFastRetry)
type: Constructor
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy" data-throw-if-not-resolved="false">RetryStrategy</xref> class.</p>
<p></p>
syntax:
content: protected RetryStrategy(String name, boolean firstFastRetry)
parameters:
- id: name
type: "26831127"
description: <p>The name of the retry strategy. </p>
- id: firstFastRetry
type: 4fc6e284
description: <p>true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.setFastFirstRetry(boolean)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: setFastFirstRetry(boolean value)
nameWithType: RetryStrategy.setFastFirstRetry(boolean value)
fullName: final void com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.setFastFirstRetry(boolean value)
type: Method
syntax:
content: public final void setFastFirstRetry(boolean value)
parameters:
- id: value
type: 4fc6e284
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: RetryStrategy
nameWithType: RetryStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy
type: Class
summary: <p>Represents a retry strategy that determines the number of retry attempts and the interval between retries. </p>
syntax:
content: public class RetryStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.yml
name: ExponentialBackoff
nameWithType: ExponentialBackoff
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ExponentialBackoff
type: Class
summary: <p>A retry strategy with backoff parameters for calculating the exponential delay between retries. </p>
syntax: *o1
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry.yml
name: ShouldRetry
nameWithType: ShouldRetry
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ShouldRetry
type: Interface
summary: <p>Defines a callback delegate that will be invoked whenever a retry condition is encountered. </p>
syntax:
content: public interface ShouldRetry

Просмотреть файл

@ -0,0 +1,459 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval
id: _fixed_interval
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
children:
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval(int)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval(int,Duration)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval(String,int,Duration)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval(String,int,Duration,boolean)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.getShouldRetry()
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.yml
langs:
- java
name: FixedInterval
nameWithType: FixedInterval
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.FixedInterval
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/FixedInterval.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/FixedInterval.java
startLine: 17
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Represents a retry strategy with a specified number of retry attempts and a default, fixed time interval between retries. </p>
syntax: &o1
content: public class FixedInterval extends RetryStrategy
inheritance:
- java.lang.Object
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
inheritedMembers:
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_BACKOFF
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_FIRST_FAST_RETRY
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MAX_BACKOFF
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MIN_BACKOFF
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INCREMENT
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultExponential()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultFixed()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultProgressive()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getFastFirstRetry()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getName()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getNoRetry()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.RetryStrategy(String,boolean)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.setFastFirstRetry(boolean)
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval()
id: FixedInterval()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.yml
langs:
- java
name: FixedInterval()
nameWithType: FixedInterval.FixedInterval()
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.FixedInterval.FixedInterval()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/FixedInterval.java
startLine: 25
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval" data-throw-if-not-resolved="false">FixedInterval</xref> class. </p>
syntax:
content: public FixedInterval()
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval(int)
id: FixedInterval(int)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.yml
langs:
- java
name: FixedInterval(int retryCount)
nameWithType: FixedInterval.FixedInterval(int retryCount)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.FixedInterval.FixedInterval(int retryCount)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/FixedInterval.java
startLine: 35
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval" data-throw-if-not-resolved="false">FixedInterval</xref> class with the specified number of retry attempts.</p>
<p></p>
syntax:
content: public FixedInterval(int retryCount)
parameters:
- id: retryCount
type: f75371fa
description: <p>The number of retry attempts. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval(int,Duration)
id: FixedInterval(int,Duration)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.yml
langs:
- java
name: FixedInterval(int retryCount, Duration retryInterval)
nameWithType: FixedInterval.FixedInterval(int retryCount, Duration retryInterval)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.FixedInterval.FixedInterval(int retryCount, Duration retryInterval)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/FixedInterval.java
startLine: 47
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval" data-throw-if-not-resolved="false">FixedInterval</xref> class with the specified number of retry attempts and time interval.</p>
<p></p>
syntax:
content: public FixedInterval(int retryCount, Duration retryInterval)
parameters:
- id: retryCount
type: f75371fa
description: <p>The number of retry attempts. </p>
- id: retryInterval
type: e02a2de0
description: <p>The time interval between retries. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval(String,int,Duration)
id: FixedInterval(String,int,Duration)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.yml
langs:
- java
name: FixedInterval(String name, int retryCount, Duration retryInterval)
nameWithType: FixedInterval.FixedInterval(String name, int retryCount, Duration retryInterval)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.FixedInterval.FixedInterval(String name, int retryCount, Duration retryInterval)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/FixedInterval.java
startLine: 63
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval" data-throw-if-not-resolved="false">FixedInterval</xref> class with the specified number of retry attempts, time interval, and retry strategy.</p>
<p></p>
syntax:
content: public FixedInterval(String name, int retryCount, Duration retryInterval)
parameters:
- id: name
type: "26831127"
description: <p>The retry strategy name. </p>
- id: retryCount
type: f75371fa
description: <p>The number of retry attempts. </p>
- id: retryInterval
type: e02a2de0
description: <p>The time interval between retries. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval(String,int,Duration,boolean)
id: FixedInterval(String,int,Duration,boolean)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.yml
langs:
- java
name: FixedInterval(String name, int retryCount, Duration retryInterval, boolean firstFastRetry)
nameWithType: FixedInterval.FixedInterval(String name, int retryCount, Duration retryInterval, boolean firstFastRetry)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.FixedInterval.FixedInterval(String name, int retryCount, Duration retryInterval, boolean firstFastRetry)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/FixedInterval.java
startLine: 83
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval" data-throw-if-not-resolved="false">FixedInterval</xref> class with the specified number of retry attempts, time interval, retry strategy, and fast start option.</p>
<p></p>
syntax:
content: public FixedInterval(String name, int retryCount, Duration retryInterval, boolean firstFastRetry)
parameters:
- id: name
type: "26831127"
description: <p>The retry strategy name. </p>
- id: retryCount
type: f75371fa
description: <p>The number of retry attempts. </p>
- id: retryInterval
type: e02a2de0
description: <p>The time interval between retries. </p>
- id: firstFastRetry
type: 4fc6e284
description: <p>true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.getShouldRetry()
id: getShouldRetry()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.yml
langs:
- java
name: getShouldRetry()
nameWithType: FixedInterval.getShouldRetry()
fullName: ShouldRetry com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.FixedInterval.getShouldRetry()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.getShouldRetry*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/FixedInterval.java
startLine: 101
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Returns the corresponding <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry" data-throw-if-not-resolved="false">ShouldRetry</xref> delegate.</p>
<p></p>
syntax:
content: public ShouldRetry getShouldRetry()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry
description: <p>The <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry" data-throw-if-not-resolved="false">ShouldRetry</xref> delegate. </p>
references:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.FixedInterval*
name: FixedInterval
nameWithType: FixedInterval.FixedInterval
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.FixedInterval.FixedInterval
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: e02a2de0
spec.java:
- name: Duration
fullName: Duration
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.getShouldRetry*
name: getShouldRetry
nameWithType: FixedInterval.getShouldRetry
fullName: ShouldRetry com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.FixedInterval.getShouldRetry
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_CLIENT_BACKOFF
nameWithType: RetryStrategy.DEFAULT_CLIENT_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_BACKOFF
type: Field
summary: <p>Represents the default amount of time used when calculating a random delta in the exponential delay between retries. </p>
syntax:
content: public static final Duration DEFAULT_CLIENT_BACKOFF= Duration.ofSeconds(10)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_CLIENT_RETRY_COUNT
nameWithType: RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT
fullName: final int com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT
type: Field
summary: <p>#region Public members </p><p>Represents the default number of retry attempts. </p>
syntax:
content: public static final int DEFAULT_CLIENT_RETRY_COUNT= 10
return:
type: cd225469
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_FIRST_FAST_RETRY
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_FIRST_FAST_RETRY
nameWithType: RetryStrategy.DEFAULT_FIRST_FAST_RETRY
fullName: final boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_FIRST_FAST_RETRY
type: Field
summary: <p>Represents the default flag indicating whether the first retry attempt will be made immediately, whereas subsequent retries will remain subject to the retry interval. </p>
syntax:
content: public static final boolean DEFAULT_FIRST_FAST_RETRY= true
return:
type: 4dda0764
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MAX_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_MAX_BACKOFF
nameWithType: RetryStrategy.DEFAULT_MAX_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MAX_BACKOFF
type: Field
summary: <p>Represents the default maximum amount of time used when calculating the exponential delay between retries. </p>
syntax:
content: public static final Duration DEFAULT_MAX_BACKOFF= Duration.ofSeconds(30)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MIN_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_MIN_BACKOFF
nameWithType: RetryStrategy.DEFAULT_MIN_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MIN_BACKOFF
type: Field
summary: <p>Represents the default minimum amount of time used when calculating the exponential delay between retries. </p>
syntax:
content: public static final Duration DEFAULT_MIN_BACKOFF= Duration.ofSeconds(1)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INCREMENT
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_RETRY_INCREMENT
nameWithType: RetryStrategy.DEFAULT_RETRY_INCREMENT
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INCREMENT
type: Field
summary: <p>Represents the default time increment between retry attempts in the progressive delay policy. </p>
syntax:
content: public static final Duration DEFAULT_RETRY_INCREMENT= Duration.ofSeconds(1)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_RETRY_INTERVAL
nameWithType: RetryStrategy.DEFAULT_RETRY_INTERVAL
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INTERVAL
type: Field
summary: <p>Represents the default interval between retries. </p>
syntax:
content: public static final Duration DEFAULT_RETRY_INTERVAL= Duration.ofSeconds(1)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultExponential()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getDefaultExponential()
nameWithType: RetryStrategy.getDefaultExponential()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultExponential()
type: Method
summary: <p>Returns a default policy that implements a random exponential retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT</xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MIN_BACKOFF" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_MIN_BACKOFF</xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MAX_BACKOFF" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_MAX_BACKOFF</xref>, and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_BACKOFF" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_BACKOFF</xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryStrategy getDefaultExponential()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultFixed()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getDefaultFixed()
nameWithType: RetryStrategy.getDefaultFixed()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultFixed()
type: Method
summary: <p>Returns a default policy that implements a fixed retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT</xref> and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_RETRY_INTERVAL</xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryStrategy getDefaultFixed()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultProgressive()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getDefaultProgressive()
nameWithType: RetryStrategy.getDefaultProgressive()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultProgressive()
type: Method
summary: <p>Returns a default policy that implements a progressive retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT</xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_RETRY_INTERVAL</xref>, and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INCREMENT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_RETRY_INCREMENT</xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryStrategy getDefaultProgressive()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getFastFirstRetry()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getFastFirstRetry()
nameWithType: RetryStrategy.getFastFirstRetry()
fullName: final boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getFastFirstRetry()
type: Method
syntax:
content: public final boolean getFastFirstRetry()
return:
type: 4dda0764
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getName()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getName()
nameWithType: RetryStrategy.getName()
fullName: final String com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getName()
type: Method
syntax:
content: public final String getName()
return:
type: 3d93591e
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getNoRetry()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getNoRetry()
nameWithType: RetryStrategy.getNoRetry()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getNoRetry()
type: Method
summary: <p>Returns a default policy that performs no retries, but invokes the action only once. </p>
syntax:
content: public static RetryStrategy getNoRetry()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.RetryStrategy(String,boolean)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: RetryStrategy(String name, boolean firstFastRetry)
nameWithType: RetryStrategy.RetryStrategy(String name, boolean firstFastRetry)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.RetryStrategy(String name, boolean firstFastRetry)
type: Constructor
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy" data-throw-if-not-resolved="false">RetryStrategy</xref> class.</p>
<p></p>
syntax:
content: protected RetryStrategy(String name, boolean firstFastRetry)
parameters:
- id: name
type: "26831127"
description: <p>The name of the retry strategy. </p>
- id: firstFastRetry
type: 4fc6e284
description: <p>true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.setFastFirstRetry(boolean)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: setFastFirstRetry(boolean value)
nameWithType: RetryStrategy.setFastFirstRetry(boolean value)
fullName: final void com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.setFastFirstRetry(boolean value)
type: Method
syntax:
content: public final void setFastFirstRetry(boolean value)
parameters:
- id: value
type: 4fc6e284
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: RetryStrategy
nameWithType: RetryStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy
type: Class
summary: <p>Represents a retry strategy that determines the number of retry attempts and the interval between retries. </p>
syntax:
content: public class RetryStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.yml
name: FixedInterval
nameWithType: FixedInterval
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.FixedInterval
type: Class
summary: <p>Represents a retry strategy with a specified number of retry attempts and a default, fixed time interval between retries. </p>
syntax: *o1
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry.yml
name: ShouldRetry
nameWithType: ShouldRetry
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ShouldRetry
type: Interface
summary: <p>Defines a callback delegate that will be invoked whenever a retry condition is encountered. </p>
syntax:
content: public interface ShouldRetry

Просмотреть файл

@ -0,0 +1,230 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard
id: _guard
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
children:
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotGreaterThan(double,double,String)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotNegativeValue(int,String)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotNegativeValue(long,String)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotNull(Object,String)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotNullOrEmptyString(String,String)
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.yml
langs:
- java
name: Guard
nameWithType: Guard
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Guard
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/Guard.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/Guard.java
startLine: 17
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Implements the common guard methods. </p>
syntax:
content: public class Guard
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotGreaterThan(double,double,String)
id: argumentNotGreaterThan(double,double,String)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.yml
langs:
- java
name: argumentNotGreaterThan(double argumentValue, double ceilingValue, String argumentName)
nameWithType: Guard.argumentNotGreaterThan(double argumentValue, double ceilingValue, String argumentName)
fullName: static void com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Guard.argumentNotGreaterThan(double argumentValue, double ceilingValue, String argumentName)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotGreaterThan*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/Guard.java
startLine: 99
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Checks an argument to ensure that its value doesn't exceed the specified ceiling baseline.</p>
<p></p>
syntax:
content: public static void argumentNotGreaterThan(double argumentValue, double ceilingValue, String argumentName)
parameters:
- id: argumentValue
type: a07dcde8
description: <p>The Double value of the argument. </p>
- id: ceilingValue
type: a07dcde8
description: <p>The Double ceiling value of the argument. </p>
- id: argumentName
type: "26831127"
description: <p>The name of the argument for diagnostic purposes. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotNegativeValue(int,String)
id: argumentNotNegativeValue(int,String)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.yml
langs:
- java
name: argumentNotNegativeValue(int argumentValue, String argumentName)
nameWithType: Guard.argumentNotNegativeValue(int argumentValue, String argumentName)
fullName: static void com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Guard.argumentNotNegativeValue(int argumentValue, String argumentName)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotNegativeValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/Guard.java
startLine: 67
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Checks an argument to ensure that its 32-bit signed value isn't negative.</p>
<p></p>
syntax:
content: public static void argumentNotNegativeValue(int argumentValue, String argumentName)
parameters:
- id: argumentValue
type: f75371fa
description: <p>The Integer value of the argument. </p>
- id: argumentName
type: "26831127"
description: <p>The name of the argument for diagnostic purposes. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotNegativeValue(long,String)
id: argumentNotNegativeValue(long,String)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.yml
langs:
- java
name: argumentNotNegativeValue(long argumentValue, String argumentName)
nameWithType: Guard.argumentNotNegativeValue(long argumentValue, String argumentName)
fullName: static void com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Guard.argumentNotNegativeValue(long argumentValue, String argumentName)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotNegativeValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/Guard.java
startLine: 82
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Checks an argument to ensure that its 64-bit signed value isn't negative.</p>
<p></p>
syntax:
content: public static void argumentNotNegativeValue(long argumentValue, String argumentName)
parameters:
- id: argumentValue
type: 0364520f
description: <p>The Long value of the argument. </p>
- id: argumentName
type: "26831127"
description: <p>The name of the argument for diagnostic purposes. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotNull(Object,String)
id: argumentNotNull(Object,String)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.yml
langs:
- java
name: argumentNotNull(Object argumentValue, String argumentName)
nameWithType: Guard.argumentNotNull(Object argumentValue, String argumentName)
fullName: static boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Guard.argumentNotNull(Object argumentValue, String argumentName)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotNull*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/Guard.java
startLine: 50
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Checks an argument to ensure that it isn't null.</p>
<p></p>
syntax:
content: public static boolean argumentNotNull(Object argumentValue, String argumentName)
parameters:
- id: argumentValue
type: "79317049"
description: <p>The argument value to check. </p>
- id: argumentName
type: "26831127"
description: <p>The name of the argument. </p>
return:
type: 4fc6e284
description: <p>The return value should be ignored. It is intended to be used only when validating arguments during instance creation (for example, when calling the base constructor). </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotNullOrEmptyString(String,String)
id: argumentNotNullOrEmptyString(String,String)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.yml
langs:
- java
name: argumentNotNullOrEmptyString(String argumentValue, String argumentName)
nameWithType: Guard.argumentNotNullOrEmptyString(String argumentValue, String argumentName)
fullName: static boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Guard.argumentNotNullOrEmptyString(String argumentValue, String argumentName)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotNullOrEmptyString*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/Guard.java
startLine: 29
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Checks a string argument to ensure that it isn't null or empty.</p>
<p></p>
syntax:
content: public static boolean argumentNotNullOrEmptyString(String argumentValue, String argumentName)
parameters:
- id: argumentValue
type: "26831127"
description: <p>The argument value to check. </p>
- id: argumentName
type: "26831127"
description: <p>The name of the argument. </p>
return:
type: 4fc6e284
description: <p>The return value should be ignored. It is intended to be used only when validating arguments during instance creation (for example, when calling the base constructor). </p>
references:
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotNullOrEmptyString*
name: argumentNotNullOrEmptyString
nameWithType: Guard.argumentNotNullOrEmptyString
fullName: static boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Guard.argumentNotNullOrEmptyString
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: "79317049"
spec.java:
- name: Object
fullName: Object
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotNull*
name: argumentNotNull
nameWithType: Guard.argumentNotNull
fullName: static boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Guard.argumentNotNull
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotNegativeValue*
name: argumentNotNegativeValue
nameWithType: Guard.argumentNotNegativeValue
fullName: static void com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Guard.argumentNotNegativeValue
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: 0364520f
spec.java:
- name: long
fullName: long
- uid: a07dcde8
spec.java:
- name: double
fullName: double
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.argumentNotGreaterThan*
name: argumentNotGreaterThan
nameWithType: Guard.argumentNotGreaterThan
fullName: static void com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Guard.argumentNotGreaterThan
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling

Просмотреть файл

@ -0,0 +1,441 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental
id: _incremental
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
children:
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.getShouldRetry()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.Incremental()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.Incremental(int,Duration,Duration)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.Incremental(String,int,Duration,Duration)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.Incremental(String,int,Duration,Duration,boolean)
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.yml
langs:
- java
name: Incremental
nameWithType: Incremental
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Incremental
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/Incremental.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/Incremental.java
startLine: 17
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>A retry strategy with a specified number of retry attempts and an incremental time interval between retries. </p>
syntax: &o1
content: public class Incremental extends RetryStrategy
inheritance:
- java.lang.Object
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
inheritedMembers:
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_BACKOFF
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_FIRST_FAST_RETRY
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MAX_BACKOFF
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MIN_BACKOFF
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INCREMENT
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultExponential()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultFixed()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultProgressive()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getFastFirstRetry()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getName()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getNoRetry()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.RetryStrategy(String,boolean)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.setFastFirstRetry(boolean)
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.getShouldRetry()
id: getShouldRetry()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.yml
langs:
- java
name: getShouldRetry()
nameWithType: Incremental.getShouldRetry()
fullName: ShouldRetry com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Incremental.getShouldRetry()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.getShouldRetry*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/Incremental.java
startLine: 102
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Returns the corresponding <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry" data-throw-if-not-resolved="false">ShouldRetry</xref> delegate.</p>
<p></p>
syntax:
content: public ShouldRetry getShouldRetry()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry
description: <p>The <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry" data-throw-if-not-resolved="false">ShouldRetry</xref> delegate. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.Incremental()
id: Incremental()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.yml
langs:
- java
name: Incremental()
nameWithType: Incremental.Incremental()
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Incremental.Incremental()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.Incremental*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/Incremental.java
startLine: 26
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental" data-throw-if-not-resolved="false">Incremental</xref> class. </p>
syntax:
content: public Incremental()
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.Incremental(int,Duration,Duration)
id: Incremental(int,Duration,Duration)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.yml
langs:
- java
name: Incremental(int retryCount, Duration initialInterval, Duration increment)
nameWithType: Incremental.Incremental(int retryCount, Duration initialInterval, Duration increment)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Incremental.Incremental(int retryCount, Duration initialInterval, Duration increment)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.Incremental*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/Incremental.java
startLine: 40
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental" data-throw-if-not-resolved="false">Incremental</xref> class with the specified retry settings.</p>
<p></p>
syntax:
content: public Incremental(int retryCount, Duration initialInterval, Duration increment)
parameters:
- id: retryCount
type: f75371fa
description: <p>The number of retry attempts. </p>
- id: initialInterval
type: e02a2de0
description: <p>The initial interval that will apply for the first retry. </p>
- id: increment
type: e02a2de0
description: <p>The incremental time value that will be used to calculate the progressive delay between retries. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.Incremental(String,int,Duration,Duration)
id: Incremental(String,int,Duration,Duration)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.yml
langs:
- java
name: Incremental(String name, int retryCount, Duration initialInterval, Duration increment)
nameWithType: Incremental.Incremental(String name, int retryCount, Duration initialInterval, Duration increment)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Incremental.Incremental(String name, int retryCount, Duration initialInterval, Duration increment)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.Incremental*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/Incremental.java
startLine: 58
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental" data-throw-if-not-resolved="false">Incremental</xref> class with the specified name and retry settings.</p>
<p></p>
syntax:
content: public Incremental(String name, int retryCount, Duration initialInterval, Duration increment)
parameters:
- id: name
type: "26831127"
description: <p>The retry strategy name. </p>
- id: retryCount
type: f75371fa
description: <p>The number of retry attempts. </p>
- id: initialInterval
type: e02a2de0
description: <p>The initial interval that will apply for the first retry. </p>
- id: increment
type: e02a2de0
description: <p>The incremental time value that will be used to calculate the progressive delay between retries. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.Incremental(String,int,Duration,Duration,boolean)
id: Incremental(String,int,Duration,Duration,boolean)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.yml
langs:
- java
name: Incremental(String name, int retryCount, Duration initialInterval, Duration increment, boolean firstFastRetry)
nameWithType: Incremental.Incremental(String name, int retryCount, Duration initialInterval, Duration increment, boolean firstFastRetry)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Incremental.Incremental(String name, int retryCount, Duration initialInterval, Duration increment, boolean firstFastRetry)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.Incremental*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/Incremental.java
startLine: 81
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental" data-throw-if-not-resolved="false">Incremental</xref> class with the specified number of retry attempts, time interval, retry strategy, and fast start option.</p>
<p></p>
syntax:
content: public Incremental(String name, int retryCount, Duration initialInterval, Duration increment, boolean firstFastRetry)
parameters:
- id: name
type: "26831127"
description: <p>The retry strategy name. </p>
- id: retryCount
type: f75371fa
description: <p>The number of retry attempts. </p>
- id: initialInterval
type: e02a2de0
description: <p>The initial interval that will apply for the first retry. </p>
- id: increment
type: e02a2de0
description: <p>The incremental time value that will be used to calculate the progressive delay between retries. </p>
- id: firstFastRetry
type: 4fc6e284
description: <p>true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval. </p>
references:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.Incremental*
name: Incremental
nameWithType: Incremental.Incremental
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Incremental.Incremental
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: e02a2de0
spec.java:
- name: Duration
fullName: Duration
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.getShouldRetry*
name: getShouldRetry
nameWithType: Incremental.getShouldRetry
fullName: ShouldRetry com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Incremental.getShouldRetry
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_CLIENT_BACKOFF
nameWithType: RetryStrategy.DEFAULT_CLIENT_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_BACKOFF
type: Field
summary: <p>Represents the default amount of time used when calculating a random delta in the exponential delay between retries. </p>
syntax:
content: public static final Duration DEFAULT_CLIENT_BACKOFF= Duration.ofSeconds(10)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_CLIENT_RETRY_COUNT
nameWithType: RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT
fullName: final int com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT
type: Field
summary: <p>#region Public members </p><p>Represents the default number of retry attempts. </p>
syntax:
content: public static final int DEFAULT_CLIENT_RETRY_COUNT= 10
return:
type: cd225469
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_FIRST_FAST_RETRY
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_FIRST_FAST_RETRY
nameWithType: RetryStrategy.DEFAULT_FIRST_FAST_RETRY
fullName: final boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_FIRST_FAST_RETRY
type: Field
summary: <p>Represents the default flag indicating whether the first retry attempt will be made immediately, whereas subsequent retries will remain subject to the retry interval. </p>
syntax:
content: public static final boolean DEFAULT_FIRST_FAST_RETRY= true
return:
type: 4dda0764
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MAX_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_MAX_BACKOFF
nameWithType: RetryStrategy.DEFAULT_MAX_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MAX_BACKOFF
type: Field
summary: <p>Represents the default maximum amount of time used when calculating the exponential delay between retries. </p>
syntax:
content: public static final Duration DEFAULT_MAX_BACKOFF= Duration.ofSeconds(30)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MIN_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_MIN_BACKOFF
nameWithType: RetryStrategy.DEFAULT_MIN_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MIN_BACKOFF
type: Field
summary: <p>Represents the default minimum amount of time used when calculating the exponential delay between retries. </p>
syntax:
content: public static final Duration DEFAULT_MIN_BACKOFF= Duration.ofSeconds(1)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INCREMENT
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_RETRY_INCREMENT
nameWithType: RetryStrategy.DEFAULT_RETRY_INCREMENT
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INCREMENT
type: Field
summary: <p>Represents the default time increment between retry attempts in the progressive delay policy. </p>
syntax:
content: public static final Duration DEFAULT_RETRY_INCREMENT= Duration.ofSeconds(1)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_RETRY_INTERVAL
nameWithType: RetryStrategy.DEFAULT_RETRY_INTERVAL
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INTERVAL
type: Field
summary: <p>Represents the default interval between retries. </p>
syntax:
content: public static final Duration DEFAULT_RETRY_INTERVAL= Duration.ofSeconds(1)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultExponential()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getDefaultExponential()
nameWithType: RetryStrategy.getDefaultExponential()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultExponential()
type: Method
summary: <p>Returns a default policy that implements a random exponential retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT</xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MIN_BACKOFF" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_MIN_BACKOFF</xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MAX_BACKOFF" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_MAX_BACKOFF</xref>, and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_BACKOFF" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_BACKOFF</xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryStrategy getDefaultExponential()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultFixed()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getDefaultFixed()
nameWithType: RetryStrategy.getDefaultFixed()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultFixed()
type: Method
summary: <p>Returns a default policy that implements a fixed retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT</xref> and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_RETRY_INTERVAL</xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryStrategy getDefaultFixed()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultProgressive()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getDefaultProgressive()
nameWithType: RetryStrategy.getDefaultProgressive()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultProgressive()
type: Method
summary: <p>Returns a default policy that implements a progressive retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT</xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_RETRY_INTERVAL</xref>, and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INCREMENT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_RETRY_INCREMENT</xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryStrategy getDefaultProgressive()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getFastFirstRetry()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getFastFirstRetry()
nameWithType: RetryStrategy.getFastFirstRetry()
fullName: final boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getFastFirstRetry()
type: Method
syntax:
content: public final boolean getFastFirstRetry()
return:
type: 4dda0764
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getName()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getName()
nameWithType: RetryStrategy.getName()
fullName: final String com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getName()
type: Method
syntax:
content: public final String getName()
return:
type: 3d93591e
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getNoRetry()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getNoRetry()
nameWithType: RetryStrategy.getNoRetry()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getNoRetry()
type: Method
summary: <p>Returns a default policy that performs no retries, but invokes the action only once. </p>
syntax:
content: public static RetryStrategy getNoRetry()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.RetryStrategy(String,boolean)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: RetryStrategy(String name, boolean firstFastRetry)
nameWithType: RetryStrategy.RetryStrategy(String name, boolean firstFastRetry)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.RetryStrategy(String name, boolean firstFastRetry)
type: Constructor
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy" data-throw-if-not-resolved="false">RetryStrategy</xref> class.</p>
<p></p>
syntax:
content: protected RetryStrategy(String name, boolean firstFastRetry)
parameters:
- id: name
type: "26831127"
description: <p>The name of the retry strategy. </p>
- id: firstFastRetry
type: 4fc6e284
description: <p>true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.setFastFirstRetry(boolean)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: setFastFirstRetry(boolean value)
nameWithType: RetryStrategy.setFastFirstRetry(boolean value)
fullName: final void com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.setFastFirstRetry(boolean value)
type: Method
syntax:
content: public final void setFastFirstRetry(boolean value)
parameters:
- id: value
type: 4fc6e284
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: RetryStrategy
nameWithType: RetryStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy
type: Class
summary: <p>Represents a retry strategy that determines the number of retry attempts and the interval between retries. </p>
syntax:
content: public class RetryStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.yml
name: Incremental
nameWithType: Incremental
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Incremental
type: Class
summary: <p>A retry strategy with a specified number of retry attempts and an incremental time interval between retries. </p>
syntax: *o1
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry.yml
name: ShouldRetry
nameWithType: ShouldRetry
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ShouldRetry
type: Interface
summary: <p>Defines a callback delegate that will be invoked whenever a retry condition is encountered. </p>
syntax:
content: public interface ShouldRetry

Просмотреть файл

@ -0,0 +1,125 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
id: _retry_behavior
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
children:
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.getDefaultRetryBehavior()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.getTransientErrorDetector()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.RetryBehavior(Function<Exception, Boolean>)
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.yml
langs:
- java
name: RetryBehavior
nameWithType: RetryBehavior
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryBehavior
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryBehavior.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryBehavior.java
startLine: 17
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Defines the retry behavior to use for detecting transient errors. </p>
syntax: &o1
content: public class RetryBehavior
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.getDefaultRetryBehavior()
id: getDefaultRetryBehavior()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.yml
langs:
- java
name: getDefaultRetryBehavior()
nameWithType: RetryBehavior.getDefaultRetryBehavior()
fullName: static RetryBehavior com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryBehavior.getDefaultRetryBehavior()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.getDefaultRetryBehavior*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryBehavior.java
startLine: 43
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Gets the default retry behavior. The default retry behavior has a built-in set of exceptions that are considered transient. You may create and use a custom <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior" data-throw-if-not-resolved="false">RetryBehavior</xref> object in order to treat additional exceptions as transient. </p>
syntax:
content: public static RetryBehavior getDefaultRetryBehavior()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.getTransientErrorDetector()
id: getTransientErrorDetector()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.yml
langs:
- java
name: getTransientErrorDetector()
nameWithType: RetryBehavior.getTransientErrorDetector()
fullName: Function<Exception, Boolean> com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryBehavior.getTransientErrorDetector()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.getTransientErrorDetector*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryBehavior.java
startLine: 47
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
syntax:
content: public Function<Exception, Boolean> getTransientErrorDetector()
return:
type: 4554f0ed
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.RetryBehavior(Function<Exception, Boolean>)
id: RetryBehavior(Function<Exception, Boolean>)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.yml
langs:
- java
name: RetryBehavior(Function<Exception, Boolean> transientErrorDetector)
nameWithType: RetryBehavior.RetryBehavior(Function<Exception, Boolean> transientErrorDetector)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryBehavior.RetryBehavior(Function<Exception, Boolean> transientErrorDetector)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.RetryBehavior*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryBehavior.java
startLine: 35
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes an instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior" data-throw-if-not-resolved="false">RetryBehavior</xref> class.</p>
<p></p>
syntax:
content: public RetryBehavior(Function<Exception, Boolean> transientErrorDetector)
parameters:
- id: transientErrorDetector
type: 4554f0ed
description: <p>Function that detects transient errors given an exception. The function needs to return true for an exception that should be treated as transient. </p>
references:
- uid: 4554f0ed
spec.java:
- name: Function<Exception, Boolean>
fullName: Function<Exception, Boolean>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.RetryBehavior*
name: RetryBehavior
nameWithType: RetryBehavior.RetryBehavior
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryBehavior.RetryBehavior
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.getTransientErrorDetector*
name: getTransientErrorDetector
nameWithType: RetryBehavior.getTransientErrorDetector
fullName: Function<Exception, Boolean> com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryBehavior.getTransientErrorDetector
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.getDefaultRetryBehavior*
name: getDefaultRetryBehavior
nameWithType: RetryBehavior.getDefaultRetryBehavior
fullName: static RetryBehavior com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryBehavior.getDefaultRetryBehavior
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.yml
name: RetryBehavior
nameWithType: RetryBehavior
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryBehavior
type: Class
summary: <p>Defines the retry behavior to use for detecting transient errors. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,861 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
id: _retry_policy
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
children:
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.executeAction(Callable<ResultT>)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.executeAction(Runnable)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultExponential()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultFixed()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultProgressive()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultRetryPolicy()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDeltaBackOff()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getErrorDetectionStrategy()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getExponentialRetryStrategy()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getMaxBackOff()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getMinBackOff()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getNoRetry()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getRetryCount()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getRetryStrategy()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.retrying
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy(int,Duration,Duration,Duration)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy(ITransientErrorDetectionStrategy,int)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy(ITransientErrorDetectionStrategy,int,Duration,Duration)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy(ITransientErrorDetectionStrategy,int,Duration,Duration,Duration)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy(ITransientErrorDetectionStrategy,int,Duration)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy(ITransientErrorDetectionStrategy,RetryStrategy)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.toString()
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: RetryPolicy
nameWithType: RetryPolicy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 20
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Provides the base implementation of the retry mechanism for unreliable actions and transient conditions. </p>
syntax: &o1
content: public class RetryPolicy
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.executeAction(Callable<ResultT>)
id: executeAction(Callable<ResultT>)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: executeAction(Callable<ResultT> callable)
nameWithType: RetryPolicy.executeAction(Callable<ResultT> callable)
fullName: public<ResultT> ResultT com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.executeAction(Callable<ResultT> callable)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.executeAction*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 304
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Repetitively executes the specified action while it satisfies the current retry policy. </p>
<p></p>
syntax:
content: public <ResultT> ResultT executeAction(Callable<ResultT> callable)
parameters:
- id: callable
type: 685fbee1
description: <p>A delegate that represents the executable action that returns the result of type <em>ResultT</em> . </p>
return:
type: fcca2e12
description: <p>The result from the action. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.executeAction(Runnable)
id: executeAction(Runnable)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: executeAction(Runnable action)
nameWithType: RetryPolicy.executeAction(Runnable action)
fullName: void com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.executeAction(Runnable action)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.executeAction*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 287
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Repetitively executes the specified action while it satisfies the current retry policy.</p>
<p></p>
syntax:
content: public void executeAction(Runnable action)
parameters:
- id: action
type: 2b8852ea
description: <p>A delegate that represents the executable action that doesn't return any results. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultExponential()
id: getDefaultExponential()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: getDefaultExponential()
nameWithType: RetryPolicy.getDefaultExponential()
fullName: static RetryPolicy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getDefaultExponential()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultExponential*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 211
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Returns a default policy that implements a random exponential retry interval configured with the default <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval" data-throw-if-not-resolved="false">FixedInterval</xref> retry strategy. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryPolicy getDefaultExponential()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultFixed()
id: getDefaultFixed()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: getDefaultFixed()
nameWithType: RetryPolicy.getDefaultFixed()
fullName: static RetryPolicy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getDefaultFixed()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultFixed*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 195
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Returns a default policy that implements a fixed retry interval configured with the default <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval" data-throw-if-not-resolved="false">FixedInterval</xref> retry strategy. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryPolicy getDefaultFixed()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultProgressive()
id: getDefaultProgressive()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: getDefaultProgressive()
nameWithType: RetryPolicy.getDefaultProgressive()
fullName: static RetryPolicy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getDefaultProgressive()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultProgressive*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 203
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Returns a default policy that implements a progressive retry interval configured with the default <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental" data-throw-if-not-resolved="false">Incremental</xref> retry strategy. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryPolicy getDefaultProgressive()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultRetryPolicy()
id: getDefaultRetryPolicy()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: getDefaultRetryPolicy()
nameWithType: RetryPolicy.getDefaultRetryPolicy()
fullName: static RetryPolicy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getDefaultRetryPolicy()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultRetryPolicy*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 180
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Gets the default retry policy. 5 retries at 1 second intervals. </p>
syntax:
content: public static RetryPolicy getDefaultRetryPolicy()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDeltaBackOff()
id: getDeltaBackOff()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: getDeltaBackOff()
nameWithType: RetryPolicy.getDeltaBackOff()
fullName: Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getDeltaBackOff()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDeltaBackOff*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 239
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
syntax:
content: public Duration getDeltaBackOff()
return:
type: e02a2de0
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getErrorDetectionStrategy()
id: getErrorDetectionStrategy()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: getErrorDetectionStrategy()
nameWithType: RetryPolicy.getErrorDetectionStrategy()
fullName: final ITransientErrorDetectionStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getErrorDetectionStrategy()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getErrorDetectionStrategy*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 273
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
syntax:
content: public final ITransientErrorDetectionStrategy getErrorDetectionStrategy()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getExponentialRetryStrategy()
id: getExponentialRetryStrategy()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: getExponentialRetryStrategy()
nameWithType: RetryPolicy.getExponentialRetryStrategy()
fullName: RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getExponentialRetryStrategy()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getExponentialRetryStrategy*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 252
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Marshals this instance into the TFH library <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy" data-throw-if-not-resolved="false">RetryStrategy</xref> type.</p>
<p></p>
syntax:
content: public RetryStrategy getExponentialRetryStrategy()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
description: <p>The <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy" data-throw-if-not-resolved="false">RetryStrategy</xref></p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getMaxBackOff()
id: getMaxBackOff()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: getMaxBackOff()
nameWithType: RetryPolicy.getMaxBackOff()
fullName: Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getMaxBackOff()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getMaxBackOff*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 231
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
syntax:
content: public Duration getMaxBackOff()
return:
type: e02a2de0
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getMinBackOff()
id: getMinBackOff()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: getMinBackOff()
nameWithType: RetryPolicy.getMinBackOff()
fullName: Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getMinBackOff()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getMinBackOff*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 223
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
syntax:
content: public Duration getMinBackOff()
return:
type: e02a2de0
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getNoRetry()
id: getNoRetry()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: getNoRetry()
nameWithType: RetryPolicy.getNoRetry()
fullName: static RetryPolicy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getNoRetry()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getNoRetry*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 187
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Returns a default policy that performs no retries, but invokes the action only once. </p>
syntax:
content: public static RetryPolicy getNoRetry()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getRetryCount()
id: getRetryCount()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: getRetryCount()
nameWithType: RetryPolicy.getRetryCount()
fullName: int com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getRetryCount()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getRetryCount*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 215
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
syntax:
content: public int getRetryCount()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getRetryStrategy()
id: getRetryStrategy()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: getRetryStrategy()
nameWithType: RetryPolicy.getRetryStrategy()
fullName: final RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getRetryStrategy()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getRetryStrategy*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 265
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
syntax:
content: public final RetryStrategy getRetryStrategy()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.retrying
id: retrying
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: retrying
nameWithType: RetryPolicy.retrying
fullName: Event<EventHandler<RetryingEventArgs>> com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.retrying
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 34
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>An instance of a callback delegate that will be invoked whenever a retry condition is encountered. </p>
syntax:
content: public Event<EventHandler<RetryingEventArgs>> retrying
return:
type: 70d811d7com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_argse7daa122
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy(int,Duration,Duration,Duration)
id: RetryPolicy(int,Duration,Duration,Duration)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: RetryPolicy(int retryCount, Duration minBackOff, Duration maxBackOff, Duration deltaBackOff)
nameWithType: RetryPolicy.RetryPolicy(int retryCount, Duration minBackOff, Duration maxBackOff, Duration deltaBackOff)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.RetryPolicy(int retryCount, Duration minBackOff, Duration maxBackOff, Duration deltaBackOff)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 73
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes an instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy" data-throw-if-not-resolved="false">RetryPolicy</xref> class.</p>
<p></p>
syntax:
content: public RetryPolicy(int retryCount, Duration minBackOff, Duration maxBackOff, Duration deltaBackOff)
parameters:
- id: retryCount
type: f75371fa
description: <p>The number of retry attempts. </p>
- id: minBackOff
type: e02a2de0
description: <p>Minimum backoff time for exponential backoff policy. </p>
- id: maxBackOff
type: e02a2de0
description: <p>Maximum backoff time for exponential backoff policy. </p>
- id: deltaBackOff
type: e02a2de0
description: <p>Delta backoff time for exponential backoff policy. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy(ITransientErrorDetectionStrategy,int)
id: RetryPolicy(ITransientErrorDetectionStrategy,int)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount)
nameWithType: RetryPolicy.RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 112
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy" data-throw-if-not-resolved="false">RetryPolicy</xref> class with the specified number of retry attempts and default fixed time interval between retries.</p>
<p></p>
syntax:
content: public RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount)
parameters:
- id: errorDetectionStrategy
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
description: <p>The <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746" data-throw-if-not-resolved="false">ITransientErrorDetectionStrategy</xref> that is responsible for detecting transient conditions. </p>
- id: retryCount
type: f75371fa
description: <p>The number of retry attempts. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy(ITransientErrorDetectionStrategy,int,Duration,Duration)
id: RetryPolicy(ITransientErrorDetectionStrategy,int,Duration,Duration)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount, Duration initialInterval, Duration increment)
nameWithType: RetryPolicy.RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount, Duration initialInterval, Duration increment)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount, Duration initialInterval, Duration increment)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 170
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy" data-throw-if-not-resolved="false">RetryPolicy</xref> class with the specified number of retry attempts and parameters defining the progressive delay between retries.</p>
<p></p>
syntax:
content: public RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount, Duration initialInterval, Duration increment)
parameters:
- id: errorDetectionStrategy
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
description: <p>The <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746" data-throw-if-not-resolved="false">ITransientErrorDetectionStrategy</xref> that is responsible for detecting transient conditions. </p>
- id: retryCount
type: f75371fa
description: <p>The number of retry attempts. </p>
- id: initialInterval
type: e02a2de0
description: <p>The initial interval that will apply for the first retry. </p>
- id: increment
type: e02a2de0
description: <p>The incremental time value that will be used to calculate the progressive delay between retries. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy(ITransientErrorDetectionStrategy,int,Duration,Duration,Duration)
id: RetryPolicy(ITransientErrorDetectionStrategy,int,Duration,Duration,Duration)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff)
nameWithType: RetryPolicy.RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 149
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy" data-throw-if-not-resolved="false">RetryPolicy</xref> class with the specified number of retry attempts and backoff parameters for calculating the exponential delay between retries.</p>
<p></p>
syntax:
content: public RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount, Duration minBackoff, Duration maxBackoff, Duration deltaBackoff)
parameters:
- id: errorDetectionStrategy
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
description: <p>The <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746" data-throw-if-not-resolved="false">ITransientErrorDetectionStrategy</xref> that is responsible for detecting transient conditions. </p>
- id: retryCount
type: f75371fa
description: <p>The number of retry attempts. </p>
- id: minBackoff
type: e02a2de0
description: <p>The minimum backoff time. </p>
- id: maxBackoff
type: e02a2de0
description: <p>The maximum backoff time. </p>
- id: deltaBackoff
type: e02a2de0
description: <p>The time value that will be used to calculate a random delta in the exponential delay between retries. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy(ITransientErrorDetectionStrategy,int,Duration)
id: RetryPolicy(ITransientErrorDetectionStrategy,int,Duration)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount, Duration retryInterval)
nameWithType: RetryPolicy.RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount, Duration retryInterval)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount, Duration retryInterval)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 128
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy" data-throw-if-not-resolved="false">RetryPolicy</xref> class with the specified number of retry attempts and fixed time interval between retries.</p>
<p></p>
syntax:
content: public RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, int retryCount, Duration retryInterval)
parameters:
- id: errorDetectionStrategy
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
description: <p>The <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746" data-throw-if-not-resolved="false">ITransientErrorDetectionStrategy</xref> that is responsible for detecting transient conditions. </p>
- id: retryCount
type: f75371fa
description: <p>The number of retry attempts. </p>
- id: retryInterval
type: e02a2de0
description: <p>The interval between retries. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy(ITransientErrorDetectionStrategy,RetryStrategy)
id: RetryPolicy(ITransientErrorDetectionStrategy,RetryStrategy)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, RetryStrategy retryStrategy)
nameWithType: RetryPolicy.RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, RetryStrategy retryStrategy)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, RetryStrategy retryStrategy)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 93
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy" data-throw-if-not-resolved="false">RetryPolicy</xref> class with the specified number of retry attempts and parameters defining the progressive delay between retries.</p>
<p></p>
syntax:
content: public RetryPolicy(ITransientErrorDetectionStrategy errorDetectionStrategy, RetryStrategy retryStrategy)
parameters:
- id: errorDetectionStrategy
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
description: <p>The <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746" data-throw-if-not-resolved="false">ITransientErrorDetectionStrategy</xref> that is responsible for detecting transient conditions. </p>
- id: retryStrategy
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
description: <p>The strategy to use for this retry policy. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.toString()
id: toString()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
langs:
- java
name: toString()
nameWithType: RetryPolicy.toString()
fullName: String com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.toString()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.toString*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryPolicy.java
startLine: 260
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>String representation of <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy" data-throw-if-not-resolved="false">RetryPolicy</xref>. </p>
syntax:
content: public String toString()
return:
type: "26831127"
references:
- uid: 70d811d7com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_argse7daa122
spec.java:
- name: Event<EventHandler<
fullName: Event<EventHandler<
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args
name: RetryingEventArgs
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.yml
- name: '>>'
fullName: '>>'
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: e02a2de0
spec.java:
- name: Duration
fullName: Duration
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.RetryPolicy*
name: RetryPolicy
nameWithType: RetryPolicy.RetryPolicy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.RetryPolicy
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getRetryCount*
name: getRetryCount
nameWithType: RetryPolicy.getRetryCount
fullName: int com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getRetryCount
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getMinBackOff*
name: getMinBackOff
nameWithType: RetryPolicy.getMinBackOff
fullName: Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getMinBackOff
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getMaxBackOff*
name: getMaxBackOff
nameWithType: RetryPolicy.getMaxBackOff
fullName: Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getMaxBackOff
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDeltaBackOff*
name: getDeltaBackOff
nameWithType: RetryPolicy.getDeltaBackOff
fullName: Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getDeltaBackOff
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getExponentialRetryStrategy*
name: getExponentialRetryStrategy
nameWithType: RetryPolicy.getExponentialRetryStrategy
fullName: RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getExponentialRetryStrategy
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.toString*
name: toString
nameWithType: RetryPolicy.toString
fullName: String com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.toString
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: 93de0ef9com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
name: RetryStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getRetryStrategy*
name: getRetryStrategy
nameWithType: RetryPolicy.getRetryStrategy
fullName: final RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getRetryStrategy
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: 93de0ef9com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
name: ITransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ITransientErrorDetectionStrategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.yml
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getErrorDetectionStrategy*
name: getErrorDetectionStrategy
nameWithType: RetryPolicy.getErrorDetectionStrategy
fullName: final ITransientErrorDetectionStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getErrorDetectionStrategy
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: 2b8852ea
spec.java:
- name: Runnable
fullName: Runnable
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.executeAction*
name: executeAction
nameWithType: RetryPolicy.executeAction
fullName: void com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.executeAction
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: 685fbee1
spec.java:
- name: Callable<ResultT>
fullName: Callable<ResultT>
- uid: fcca2e12
spec.java:
- name: <ResultT> ResultT
fullName: <ResultT> ResultT
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultRetryPolicy*
name: getDefaultRetryPolicy
nameWithType: RetryPolicy.getDefaultRetryPolicy
fullName: static RetryPolicy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getDefaultRetryPolicy
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getNoRetry*
name: getNoRetry
nameWithType: RetryPolicy.getNoRetry
fullName: static RetryPolicy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getNoRetry
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultFixed*
name: getDefaultFixed
nameWithType: RetryPolicy.getDefaultFixed
fullName: static RetryPolicy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getDefaultFixed
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultProgressive*
name: getDefaultProgressive
nameWithType: RetryPolicy.getDefaultProgressive
fullName: static RetryPolicy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getDefaultProgressive
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultExponential*
name: getDefaultExponential
nameWithType: RetryPolicy.getDefaultExponential
fullName: static RetryPolicy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getDefaultExponential
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
name: RetryPolicy
nameWithType: RetryPolicy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy
type: Class
summary: <p>Provides the base implementation of the retry mechanism for unreliable actions and transient conditions. </p>
syntax: *o1
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MIN_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_MIN_BACKOFF
nameWithType: RetryStrategy.DEFAULT_MIN_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MIN_BACKOFF
type: Field
summary: <p>Represents the default minimum amount of time used when calculating the exponential delay between retries. </p>
syntax:
content: public static final Duration DEFAULT_MIN_BACKOFF= Duration.ofSeconds(1)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MAX_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_MAX_BACKOFF
nameWithType: RetryStrategy.DEFAULT_MAX_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MAX_BACKOFF
type: Field
summary: <p>Represents the default maximum amount of time used when calculating the exponential delay between retries. </p>
syntax:
content: public static final Duration DEFAULT_MAX_BACKOFF= Duration.ofSeconds(30)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_CLIENT_BACKOFF
nameWithType: RetryStrategy.DEFAULT_CLIENT_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_BACKOFF
type: Field
summary: <p>Represents the default amount of time used when calculating a random delta in the exponential delay between retries. </p>
syntax:
content: public static final Duration DEFAULT_CLIENT_BACKOFF= Duration.ofSeconds(10)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getNoRetry()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getNoRetry()
nameWithType: RetryStrategy.getNoRetry()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getNoRetry()
type: Method
summary: <p>Returns a default policy that performs no retries, but invokes the action only once. </p>
syntax:
content: public static RetryStrategy getNoRetry()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultFixed()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getDefaultFixed()
nameWithType: RetryStrategy.getDefaultFixed()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultFixed()
type: Method
summary: <p>Returns a default policy that implements a fixed retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT</xref> and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_RETRY_INTERVAL</xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryStrategy getDefaultFixed()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultProgressive()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getDefaultProgressive()
nameWithType: RetryStrategy.getDefaultProgressive()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultProgressive()
type: Method
summary: <p>Returns a default policy that implements a progressive retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT</xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_RETRY_INTERVAL</xref>, and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INCREMENT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_RETRY_INCREMENT</xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryStrategy getDefaultProgressive()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultExponential()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: getDefaultExponential()
nameWithType: RetryStrategy.getDefaultExponential()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultExponential()
type: Method
summary: <p>Returns a default policy that implements a random exponential retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT</xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MIN_BACKOFF" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_MIN_BACKOFF</xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MAX_BACKOFF" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_MAX_BACKOFF</xref>, and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_BACKOFF" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_BACKOFF</xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryStrategy getDefaultExponential()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.yml
name: RetryingEventArgs
nameWithType: RetryingEventArgs
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs
type: Class
summary: <p>Shard management retrying event arguments. </p>
syntax:
content: public class RetryingEventArgs
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: RetryStrategy
nameWithType: RetryStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy
type: Class
summary: <p>Represents a retry strategy that determines the number of retry attempts and the interval between retries. </p>
syntax:
content: public class RetryStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.yml
name: ITransientErrorDetectionStrategy
nameWithType: ITransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ITransientErrorDetectionStrategy
type: Interface
summary: <p>Defines an interface that must be implemented by custom components responsible for detecting specific transient conditions. </p>
syntax:
content: public interface ITransientErrorDetectionStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.yml
name: FixedInterval
nameWithType: FixedInterval
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.FixedInterval
type: Class
summary: <p>Represents a retry strategy with a specified number of retry attempts and a default, fixed time interval between retries. </p>
syntax:
content: public class FixedInterval extends RetryStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.yml
name: Incremental
nameWithType: Incremental
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Incremental
type: Class
summary: <p>A retry strategy with a specified number of retry attempts and an incremental time interval between retries. </p>
syntax:
content: public class Incremental extends RetryStrategy

Просмотреть файл

@ -0,0 +1,568 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
id: _retry_strategy
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
children:
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_BACKOFF
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_FIRST_FAST_RETRY
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MAX_BACKOFF
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MIN_BACKOFF
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INCREMENT
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultExponential()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultFixed()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultProgressive()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getFastFirstRetry()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getName()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getNoRetry()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getShouldRetry()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.RetryStrategy(String,boolean)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.setFastFirstRetry(boolean)
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: RetryStrategy
nameWithType: RetryStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 15
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Represents a retry strategy that determines the number of retry attempts and the interval between retries. </p>
syntax: &o1
content: public class RetryStrategy
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_BACKOFF
id: DEFAULT_CLIENT_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: DEFAULT_CLIENT_BACKOFF
nameWithType: RetryStrategy.DEFAULT_CLIENT_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_BACKOFF
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 26
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Represents the default amount of time used when calculating a random delta in the exponential delay between retries. </p>
syntax: &o7
content: public static final Duration DEFAULT_CLIENT_BACKOFF= Duration.ofSeconds(10)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT
id: DEFAULT_CLIENT_RETRY_COUNT
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: DEFAULT_CLIENT_RETRY_COUNT
nameWithType: RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT
fullName: final int com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 21
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>#region Public members </p><p>Represents the default number of retry attempts. </p>
syntax: &o3
content: public static final int DEFAULT_CLIENT_RETRY_COUNT= 10
return:
type: cd225469
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_FIRST_FAST_RETRY
id: DEFAULT_FIRST_FAST_RETRY
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: DEFAULT_FIRST_FAST_RETRY
nameWithType: RetryStrategy.DEFAULT_FIRST_FAST_RETRY
fullName: final boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_FIRST_FAST_RETRY
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 52
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Represents the default flag indicating whether the first retry attempt will be made immediately, whereas subsequent retries will remain subject to the retry interval. </p>
syntax:
content: public static final boolean DEFAULT_FIRST_FAST_RETRY= true
return:
type: 4dda0764
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MAX_BACKOFF
id: DEFAULT_MAX_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: DEFAULT_MAX_BACKOFF
nameWithType: RetryStrategy.DEFAULT_MAX_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MAX_BACKOFF
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 31
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Represents the default maximum amount of time used when calculating the exponential delay between retries. </p>
syntax: &o6
content: public static final Duration DEFAULT_MAX_BACKOFF= Duration.ofSeconds(30)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MIN_BACKOFF
id: DEFAULT_MIN_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: DEFAULT_MIN_BACKOFF
nameWithType: RetryStrategy.DEFAULT_MIN_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MIN_BACKOFF
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 36
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Represents the default minimum amount of time used when calculating the exponential delay between retries. </p>
syntax: &o5
content: public static final Duration DEFAULT_MIN_BACKOFF= Duration.ofSeconds(1)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INCREMENT
id: DEFAULT_RETRY_INCREMENT
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: DEFAULT_RETRY_INCREMENT
nameWithType: RetryStrategy.DEFAULT_RETRY_INCREMENT
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INCREMENT
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 46
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Represents the default time increment between retry attempts in the progressive delay policy. </p>
syntax: &o4
content: public static final Duration DEFAULT_RETRY_INCREMENT= Duration.ofSeconds(1)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL
id: DEFAULT_RETRY_INTERVAL
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: DEFAULT_RETRY_INTERVAL
nameWithType: RetryStrategy.DEFAULT_RETRY_INTERVAL
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INTERVAL
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 41
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Represents the default interval between retries. </p>
syntax: &o2
content: public static final Duration DEFAULT_RETRY_INTERVAL= Duration.ofSeconds(1)
return:
type: 89ac7c4d
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultExponential()
id: getDefaultExponential()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: getDefaultExponential()
nameWithType: RetryStrategy.getDefaultExponential()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultExponential()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultExponential*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 116
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Returns a default policy that implements a random exponential retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT</xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MIN_BACKOFF" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_MIN_BACKOFF</xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MAX_BACKOFF" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_MAX_BACKOFF</xref>, and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_BACKOFF" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_BACKOFF</xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryStrategy getDefaultExponential()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultFixed()
id: getDefaultFixed()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: getDefaultFixed()
nameWithType: RetryStrategy.getDefaultFixed()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultFixed()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultFixed*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 97
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Returns a default policy that implements a fixed retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT</xref> and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_RETRY_INTERVAL</xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryStrategy getDefaultFixed()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultProgressive()
id: getDefaultProgressive()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: getDefaultProgressive()
nameWithType: RetryStrategy.getDefaultProgressive()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultProgressive()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultProgressive*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 106
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Returns a default policy that implements a progressive retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT</xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_RETRY_INTERVAL</xref>, and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INCREMENT" data-throw-if-not-resolved="false">RetryStrategy.DEFAULT_RETRY_INCREMENT</xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax:
content: public static RetryStrategy getDefaultProgressive()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getFastFirstRetry()
id: getFastFirstRetry()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: getFastFirstRetry()
nameWithType: RetryStrategy.getFastFirstRetry()
fullName: final boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getFastFirstRetry()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getFastFirstRetry*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 120
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
syntax:
content: public final boolean getFastFirstRetry()
return:
type: 4dda0764
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getName()
id: getName()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: getName()
nameWithType: RetryStrategy.getName()
fullName: final String com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getName()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getName*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 128
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
syntax:
content: public final String getName()
return:
type: 3d93591e
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getNoRetry()
id: getNoRetry()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: getNoRetry()
nameWithType: RetryStrategy.getNoRetry()
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getNoRetry()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getNoRetry*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 89
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Returns a default policy that performs no retries, but invokes the action only once. </p>
syntax:
content: public static RetryStrategy getNoRetry()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getShouldRetry()
id: getShouldRetry()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: getShouldRetry()
nameWithType: RetryStrategy.getShouldRetry()
fullName: abstract ShouldRetry com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getShouldRetry()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getShouldRetry*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 141
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Returns the corresponding <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry" data-throw-if-not-resolved="false">ShouldRetry</xref> delegate.</p>
<p></p>
syntax:
content: public abstract ShouldRetry getShouldRetry()
return:
type: 13c86962com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry
description: <p>The <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry" data-throw-if-not-resolved="false">ShouldRetry</xref> delegate. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.RetryStrategy(String,boolean)
id: RetryStrategy(String,boolean)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: RetryStrategy(String name, boolean firstFastRetry)
nameWithType: RetryStrategy.RetryStrategy(String name, boolean firstFastRetry)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.RetryStrategy(String name, boolean firstFastRetry)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.RetryStrategy*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 80
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy" data-throw-if-not-resolved="false">RetryStrategy</xref> class.</p>
<p></p>
syntax:
content: protected RetryStrategy(String name, boolean firstFastRetry)
parameters:
- id: name
type: "26831127"
description: <p>The name of the retry strategy. </p>
- id: firstFastRetry
type: 4fc6e284
description: <p>true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.setFastFirstRetry(boolean)
id: setFastFirstRetry(boolean)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
langs:
- java
name: setFastFirstRetry(boolean value)
nameWithType: RetryStrategy.setFastFirstRetry(boolean value)
fullName: final void com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.setFastFirstRetry(boolean value)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.setFastFirstRetry*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryStrategy.java
startLine: 124
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
syntax:
content: public final void setFastFirstRetry(boolean value)
parameters:
- id: value
type: 4fc6e284
return:
type: 3f6357ce
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: 89ac7c4d
spec.java:
- name: final Duration
fullName: final Duration
- uid: 4dda0764
spec.java:
- name: final boolean
fullName: final boolean
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.RetryStrategy*
name: RetryStrategy
nameWithType: RetryStrategy.RetryStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.RetryStrategy
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getNoRetry*
name: getNoRetry
nameWithType: RetryStrategy.getNoRetry
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getNoRetry
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultFixed*
name: getDefaultFixed
nameWithType: RetryStrategy.getDefaultFixed
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultFixed
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultProgressive*
name: getDefaultProgressive
nameWithType: RetryStrategy.getDefaultProgressive
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultProgressive
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getDefaultExponential*
name: getDefaultExponential
nameWithType: RetryStrategy.getDefaultExponential
fullName: static RetryStrategy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultExponential
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getFastFirstRetry*
name: getFastFirstRetry
nameWithType: RetryStrategy.getFastFirstRetry
fullName: final boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getFastFirstRetry
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: 3f6357ce
spec.java:
- name: final void
fullName: final void
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.setFastFirstRetry*
name: setFastFirstRetry
nameWithType: RetryStrategy.setFastFirstRetry
fullName: final void com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.setFastFirstRetry
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: 3d93591e
spec.java:
- name: final String
fullName: final String
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getName*
name: getName
nameWithType: RetryStrategy.getName
fullName: final String com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getName
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: 13c86962com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry
spec.java:
- name: 'abstract '
fullName: 'abstract '
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry
name: ShouldRetry
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ShouldRetry
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry.yml
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.getShouldRetry*
name: getShouldRetry
nameWithType: RetryStrategy.getShouldRetry
fullName: abstract ShouldRetry com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getShouldRetry
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.yml
name: ExponentialBackoff
nameWithType: ExponentialBackoff
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ExponentialBackoff
type: Class
summary: <p>A retry strategy with backoff parameters for calculating the exponential delay between retries. </p>
syntax:
content: public class ExponentialBackoff extends RetryStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.yml
name: FixedInterval
nameWithType: FixedInterval
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.FixedInterval
type: Class
summary: <p>Represents a retry strategy with a specified number of retry attempts and a default, fixed time interval between retries. </p>
syntax:
content: public class FixedInterval extends RetryStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.yml
name: Incremental
nameWithType: Incremental
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Incremental
type: Class
summary: <p>A retry strategy with a specified number of retry attempts and an incremental time interval between retries. </p>
syntax:
content: public class Incremental extends RetryStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: RetryStrategy
nameWithType: RetryStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy
type: Class
summary: <p>Represents a retry strategy that determines the number of retry attempts and the interval between retries. </p>
syntax: *o1
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INTERVAL
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_RETRY_INTERVAL
nameWithType: RetryStrategy.DEFAULT_RETRY_INTERVAL
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INTERVAL
type: Field
summary: <p>Represents the default interval between retries. </p>
syntax: *o2
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_RETRY_COUNT
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_CLIENT_RETRY_COUNT
nameWithType: RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT
fullName: final int com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT
type: Field
summary: <p>#region Public members </p><p>Represents the default number of retry attempts. </p>
syntax: *o3
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_RETRY_INCREMENT
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_RETRY_INCREMENT
nameWithType: RetryStrategy.DEFAULT_RETRY_INCREMENT
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INCREMENT
type: Field
summary: <p>Represents the default time increment between retry attempts in the progressive delay policy. </p>
syntax: *o4
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MIN_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_MIN_BACKOFF
nameWithType: RetryStrategy.DEFAULT_MIN_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MIN_BACKOFF
type: Field
summary: <p>Represents the default minimum amount of time used when calculating the exponential delay between retries. </p>
syntax: *o5
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_MAX_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_MAX_BACKOFF
nameWithType: RetryStrategy.DEFAULT_MAX_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MAX_BACKOFF
type: Field
summary: <p>Represents the default maximum amount of time used when calculating the exponential delay between retries. </p>
syntax: *o6
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.DEFAULT_CLIENT_BACKOFF
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: DEFAULT_CLIENT_BACKOFF
nameWithType: RetryStrategy.DEFAULT_CLIENT_BACKOFF
fullName: final Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_BACKOFF
type: Field
summary: <p>Represents the default amount of time used when calculating a random delta in the exponential delay between retries. </p>
syntax: *o7
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry.yml
name: ShouldRetry
nameWithType: ShouldRetry
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ShouldRetry
type: Interface
summary: <p>Defines a callback delegate that will be invoked whenever a retry condition is encountered. </p>
syntax:
content: public interface ShouldRetry

Просмотреть файл

@ -0,0 +1,207 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args
id: _retrying_event_args
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
children:
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.getCurrentRetryCount()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.getDelay()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.getLastException()
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.RetryingEventArgs(int,Duration,RuntimeException)
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.RetryingEventArgs(RetryingEventArgs)
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.yml
langs:
- java
name: RetryingEventArgs
nameWithType: RetryingEventArgs
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryingEventArgs.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryingEventArgs.java
startLine: 17
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Shard management retrying event arguments. </p>
syntax: &o1
content: public class RetryingEventArgs
inheritance:
- java.lang.Object
- EventArgs
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.getCurrentRetryCount()
id: getCurrentRetryCount()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.yml
langs:
- java
name: getCurrentRetryCount()
nameWithType: RetryingEventArgs.getCurrentRetryCount()
fullName: int com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs.getCurrentRetryCount()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.getCurrentRetryCount*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryingEventArgs.java
startLine: 62
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
syntax:
content: public int getCurrentRetryCount()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.getDelay()
id: getDelay()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.yml
langs:
- java
name: getDelay()
nameWithType: RetryingEventArgs.getDelay()
fullName: Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs.getDelay()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.getDelay*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryingEventArgs.java
startLine: 70
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
syntax:
content: public Duration getDelay()
return:
type: e02a2de0
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.getLastException()
id: getLastException()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.yml
langs:
- java
name: getLastException()
nameWithType: RetryingEventArgs.getLastException()
fullName: RuntimeException com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs.getLastException()
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.getLastException*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryingEventArgs.java
startLine: 78
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
syntax:
content: public RuntimeException getLastException()
return:
type: 9b2a4515
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.RetryingEventArgs(int,Duration,RuntimeException)
id: RetryingEventArgs(int,Duration,RuntimeException)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.yml
langs:
- java
name: RetryingEventArgs(int retryCount, Duration delay, RuntimeException ex)
nameWithType: RetryingEventArgs.RetryingEventArgs(int retryCount, Duration delay, RuntimeException ex)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs.RetryingEventArgs(int retryCount, Duration delay, RuntimeException ex)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.RetryingEventArgs*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryingEventArgs.java
startLine: 54
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args" data-throw-if-not-resolved="false">RetryingEventArgs</xref> class.</p>
<p></p>
syntax:
content: public RetryingEventArgs(int retryCount, Duration delay, RuntimeException ex)
parameters:
- id: retryCount
type: f75371fa
description: <p>The current retry attempt count. </p>
- id: delay
type: e02a2de0
description: <p>The delay that indicates how long the current thread will be suspended before the next iteration is invoked. </p>
- id: ex
type: 9b2a4515
description: <p>The exception that caused the retry conditions to occur. </p>
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.RetryingEventArgs(RetryingEventArgs)
id: RetryingEventArgs(RetryingEventArgs)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.yml
langs:
- java
name: RetryingEventArgs(RetryingEventArgs arg)
nameWithType: RetryingEventArgs.RetryingEventArgs(RetryingEventArgs arg)
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs.RetryingEventArgs(RetryingEventArgs arg)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.RetryingEventArgs*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/RetryingEventArgs.java
startLine: 38
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Initializes new instance of <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args" data-throw-if-not-resolved="false">RetryingEventArgs</xref> class.</p>
<p></p>
syntax:
content: public RetryingEventArgs(RetryingEventArgs arg)
parameters:
- id: arg
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args" data-throw-if-not-resolved="false">RetryingEventArgs</xref> from <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.retrying" data-throw-if-not-resolved="false">RetryPolicy.retrying</xref> event. </p>
references:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.RetryingEventArgs*
name: RetryingEventArgs
nameWithType: RetryingEventArgs.RetryingEventArgs
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs.RetryingEventArgs
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: e02a2de0
spec.java:
- name: Duration
fullName: Duration
- uid: 9b2a4515
spec.java:
- name: RuntimeException
fullName: RuntimeException
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.getCurrentRetryCount*
name: getCurrentRetryCount
nameWithType: RetryingEventArgs.getCurrentRetryCount
fullName: int com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs.getCurrentRetryCount
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.getDelay*
name: getDelay
nameWithType: RetryingEventArgs.getDelay
fullName: Duration com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs.getDelay
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.getLastException*
name: getLastException
nameWithType: RetryingEventArgs.getLastException
fullName: RuntimeException com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs.getLastException
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.yml
name: RetryingEventArgs
nameWithType: RetryingEventArgs
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs
type: Class
summary: <p>Shard management retrying event arguments. </p>
syntax: *o1
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.retrying
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
name: retrying
nameWithType: RetryPolicy.retrying
fullName: Event<EventHandler<RetryingEventArgs>> com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.retrying
type: Field
summary: <p>An instance of a callback delegate that will be invoked whenever a retry condition is encountered. </p>
syntax:
content: public Event<EventHandler<RetryingEventArgs>> retrying
return:
type: 70d811d7com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_argse7daa122

Просмотреть файл

@ -0,0 +1,82 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry
id: _should_retry
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
children:
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry.invoke(int,RuntimeException,ReferenceObjectHelper<Duration>)
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry.yml
langs:
- java
name: ShouldRetry
nameWithType: ShouldRetry
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ShouldRetry
type: Interface
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/ShouldRetry.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/ShouldRetry.java
startLine: 18
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Defines a callback delegate that will be invoked whenever a retry condition is encountered. </p>
syntax:
content: public interface ShouldRetry
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry.invoke(int,RuntimeException,ReferenceObjectHelper<Duration>)
id: invoke(int,RuntimeException,ReferenceObjectHelper<Duration>)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry.yml
langs:
- java
name: invoke(int retryCount, RuntimeException lastException, ReferenceObjectHelper<Duration> delay)
nameWithType: ShouldRetry.invoke(int retryCount, RuntimeException lastException, ReferenceObjectHelper<Duration> delay)
fullName: boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ShouldRetry.invoke(int retryCount, RuntimeException lastException, ReferenceObjectHelper<Duration> delay)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry.invoke*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/ShouldRetry.java
startLine: 31
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Defines a callback delegate that will be invoked whenever a retry condition is encountered.</p>
<p></p>
syntax:
content: public boolean invoke(int retryCount, RuntimeException lastException, ReferenceObjectHelper<Duration> delay)
parameters:
- id: retryCount
type: f75371fa
description: <p>The current retry attempt count. </p>
- id: lastException
type: 9b2a4515
description: <p>The exception that caused the retry conditions to occur. </p>
- id: delay
type: cebb71d5
description: <p>The delay that indicates how long the current thread will be suspended before the next iteration is invoked. </p>
return:
type: 4fc6e284
description: <p>if a retry is allowed; otherwise, . </p>
references:
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: 9b2a4515
spec.java:
- name: RuntimeException
fullName: RuntimeException
- uid: cebb71d5
spec.java:
- name: ReferenceObjectHelper<Duration>
fullName: ReferenceObjectHelper<Duration>
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry.invoke*
name: invoke
nameWithType: ShouldRetry.invoke
fullName: boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ShouldRetry.invoke
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling

Просмотреть файл

@ -0,0 +1,102 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc
id: _sql216bcdbcbaf03a3eed450c739065f1fc
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
children:
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc.isTransient(Exception)
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc.yml
langs:
- java
name: SqlDatabaseTransientErrorDetectionStrategy
nameWithType: SqlDatabaseTransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.SqlDatabaseTransientErrorDetectionStrategy
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/SqlDatabaseTransientErrorDetectionStrategy.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/SqlDatabaseTransientErrorDetectionStrategy.java
startLine: 20
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Provides the transient error detection logic for transient faults that are specific to SQL Database. </p>
syntax:
content: public class SqlDatabaseTransientErrorDetectionStrategy implements ITransientErrorDetectionStrategy
inheritance:
- java.lang.Object
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc.isTransient(Exception)
id: isTransient(Exception)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc.yml
langs:
- java
name: isTransient(Exception ex)
nameWithType: SqlDatabaseTransientErrorDetectionStrategy.isTransient(Exception ex)
fullName: boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.SqlDatabaseTransientErrorDetectionStrategy.isTransient(Exception ex)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc.isTransient*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/SqlDatabaseTransientErrorDetectionStrategy.java
startLine: 30
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Determines whether the specified exception represents a transient failure that can be compensated by a retry.</p>
<p></p>
syntax:
content: public boolean isTransient(Exception ex)
parameters:
- id: ex
type: 8a99d4b0
description: <p>The exception object to be verified. </p>
return:
type: 4fc6e284
description: <p>true if the specified exception is considered as transient; otherwise, false. </p>
overridden: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.isTransient(Exception)
references:
- uid: 8a99d4b0
spec.java:
- name: Exception
fullName: Exception
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc.isTransient*
name: isTransient
nameWithType: SqlDatabaseTransientErrorDetectionStrategy.isTransient
fullName: boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.SqlDatabaseTransientErrorDetectionStrategy.isTransient
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.yml
name: ITransientErrorDetectionStrategy
nameWithType: ITransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ITransientErrorDetectionStrategy
type: Interface
summary: <p>Defines an interface that must be implemented by custom components responsible for detecting specific transient conditions. </p>
syntax:
content: public interface ITransientErrorDetectionStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.isTransient(Exception)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.yml
name: isTransient(Exception ex)
nameWithType: ITransientErrorDetectionStrategy.isTransient(Exception ex)
fullName: boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ITransientErrorDetectionStrategy.isTransient(Exception ex)
type: Method
summary: >-
<p>Determines whether the specified exception represents a transient failure that can be compensated by a retry.</p>
<p></p>
syntax:
content: public boolean isTransient(Exception ex)
parameters:
- id: ex
type: 8a99d4b0
description: <p>The exception object to be verified. </p>
return:
type: 4fc6e284
description: <p>true if the specified exception is considered as transient; otherwise, false. </p>

Просмотреть файл

@ -0,0 +1,158 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
id: ff40c226a7d228847951c8c201a34746
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
children:
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.isTransient(Exception)
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.yml
langs:
- java
name: ITransientErrorDetectionStrategy
nameWithType: ITransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ITransientErrorDetectionStrategy
type: Interface
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/ITransientErrorDetectionStrategy.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/ITransientErrorDetectionStrategy.java
startLine: 13
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Defines an interface that must be implemented by custom components responsible for detecting specific transient conditions. </p>
syntax:
content: public interface ITransientErrorDetectionStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.isTransient(Exception)
id: isTransient(Exception)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.yml
langs:
- java
name: isTransient(Exception ex)
nameWithType: ITransientErrorDetectionStrategy.isTransient(Exception ex)
fullName: boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ITransientErrorDetectionStrategy.isTransient(Exception ex)
overload: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.isTransient*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/ITransientErrorDetectionStrategy.java
startLine: 22
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: >-
<p>Determines whether the specified exception represents a transient failure that can be compensated by a retry.</p>
<p></p>
syntax:
content: public boolean isTransient(Exception ex)
parameters:
- id: ex
type: 8a99d4b0
description: <p>The exception object to be verified. </p>
return:
type: 4fc6e284
description: <p>true if the specified exception is considered as transient; otherwise, false. </p>
references:
- uid: 8a99d4b0
spec.java:
- name: Exception
fullName: Exception
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.isTransient*
name: isTransient
nameWithType: ITransientErrorDetectionStrategy.isTransient
fullName: boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ITransientErrorDetectionStrategy.isTransient
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc.yml
name: SqlDatabaseTransientErrorDetectionStrategy
nameWithType: SqlDatabaseTransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.SqlDatabaseTransientErrorDetectionStrategy
type: Class
summary: <p>Provides the transient error detection logic for transient faults that are specific to SQL Database. </p>
syntax:
content: public class SqlDatabaseTransientErrorDetectionStrategy
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy
parent: com.microsoft.azure.elasticdb.query.multishard
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy.yml
name: MultiShardQueryTransientErrorDetectionStrategy
nameWithType: MultiShardQueryTransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardQueryTransientErrorDetectionStrategy
type: Class
summary: <p>Provides the transient error detection logic for transient faults that are specific to cross shard query. </p>
syntax:
content: public class MultiShardQueryTransientErrorDetectionStrategy
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy.yml
name: ShardManagementTransientErrorDetectionStrategy
nameWithType: ShardManagementTransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementTransientErrorDetectionStrategy
type: Class
summary: <p>Provides the transient error detection logic for transient faults that are specific to Shard map manager. </p>
syntax:
content: public class ShardManagementTransientErrorDetectionStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc.isTransient(Exception)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc.yml
name: isTransient(Exception ex)
nameWithType: SqlDatabaseTransientErrorDetectionStrategy.isTransient(Exception ex)
fullName: boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.SqlDatabaseTransientErrorDetectionStrategy.isTransient(Exception ex)
type: Method
summary: >-
<p>Determines whether the specified exception represents a transient failure that can be compensated by a retry.</p>
<p></p>
syntax:
content: public boolean isTransient(Exception ex)
parameters:
- id: ex
type: 8a99d4b0
description: <p>The exception object to be verified. </p>
return:
type: 4fc6e284
description: <p>true if the specified exception is considered as transient; otherwise, false. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy.isTransient(Exception)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy.yml
name: isTransient(Exception ex)
nameWithType: ShardManagementTransientErrorDetectionStrategy.isTransient(Exception ex)
fullName: boolean com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementTransientErrorDetectionStrategy.isTransient(Exception ex)
type: Method
summary: >-
<p>Determines whether the specified exception represents a transient failure that can be compensated by a retry.</p>
<p></p>
syntax:
content: public boolean isTransient(Exception ex)
parameters:
- id: ex
type: 8a99d4b0
description: <p>The exception object to be verified. </p>
return:
type: 4fc6e284
description: <p>true if the specified exception is considered as transient; otherwise, false. </p>
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy.isTransient(Exception)
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy.yml
name: isTransient(Exception ex)
nameWithType: MultiShardQueryTransientErrorDetectionStrategy.isTransient(Exception ex)
fullName: boolean com.microsoft.azure.elasticdb.query.multishard.MultiShardQueryTransientErrorDetectionStrategy.isTransient(Exception ex)
type: Method
summary: >-
<p>Determines whether the specified exception represents a transient failure that can be compensated by a retry.</p>
<p></p>
syntax:
content: public boolean isTransient(Exception ex)
parameters:
- id: ex
type: 8a99d4b0
description: <p>The exception object to be verified. </p>
return:
type: 4fc6e284
description: <p>true if the specified exception is considered as transient; otherwise, false. </p>

Просмотреть файл

@ -0,0 +1,142 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
id: transientfaulthandling
children:
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.yml
langs:
- java
name: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
nameWithType: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
type: Namespace
source:
remote:
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/ExponentialBackoff.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/core/commons/transientfaulthandling/ExponentialBackoff.java
syntax:
content: package com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
references:
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._exponential_backoff.yml
name: ExponentialBackoff
nameWithType: ExponentialBackoff
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ExponentialBackoff
type: Class
summary: <p>A retry strategy with backoff parameters for calculating the exponential delay between retries. </p>
syntax:
content: public class ExponentialBackoff extends RetryStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._fixed_interval.yml
name: FixedInterval
nameWithType: FixedInterval
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.FixedInterval
type: Class
summary: <p>Represents a retry strategy with a specified number of retry attempts and a default, fixed time interval between retries. </p>
syntax:
content: public class FixedInterval extends RetryStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._guard.yml
name: Guard
nameWithType: Guard
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Guard
type: Class
summary: <p>Implements the common guard methods. </p>
syntax:
content: public class Guard
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._incremental.yml
name: Incremental
nameWithType: Incremental
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.Incremental
type: Class
summary: <p>A retry strategy with a specified number of retry attempts and an incremental time interval between retries. </p>
syntax:
content: public class Incremental extends RetryStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.yml
name: ITransientErrorDetectionStrategy
nameWithType: ITransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ITransientErrorDetectionStrategy
type: Interface
summary: <p>Defines an interface that must be implemented by custom components responsible for detecting specific transient conditions. </p>
syntax:
content: public interface ITransientErrorDetectionStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.yml
name: RetryBehavior
nameWithType: RetryBehavior
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryBehavior
type: Class
summary: <p>Defines the retry behavior to use for detecting transient errors. </p>
syntax:
content: public class RetryBehavior
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.yml
name: RetryingEventArgs
nameWithType: RetryingEventArgs
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs
type: Class
summary: <p>Shard management retrying event arguments. </p>
syntax:
content: public class RetryingEventArgs
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
name: RetryPolicy
nameWithType: RetryPolicy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy
type: Class
summary: <p>Provides the base implementation of the retry mechanism for unreliable actions and transient conditions. </p>
syntax:
content: public class RetryPolicy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_strategy.yml
name: RetryStrategy
nameWithType: RetryStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy
type: Class
summary: <p>Represents a retry strategy that determines the number of retry attempts and the interval between retries. </p>
syntax:
content: public class RetryStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._should_retry.yml
name: ShouldRetry
nameWithType: ShouldRetry
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ShouldRetry
type: Interface
summary: <p>Defines a callback delegate that will be invoked whenever a retry condition is encountered. </p>
syntax:
content: public interface ShouldRetry
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc.yml
name: SqlDatabaseTransientErrorDetectionStrategy
nameWithType: SqlDatabaseTransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.SqlDatabaseTransientErrorDetectionStrategy
type: Class
summary: <p>Provides the transient error detection logic for transient faults that are specific to SQL Database. </p>
syntax:
content: public class SqlDatabaseTransientErrorDetectionStrategy implements ITransientErrorDetectionStrategy

Просмотреть файл

@ -0,0 +1,280 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception
id: _multi_shard_aggregate_exception
parent: com.microsoft.azure.elasticdb.query.exception
children:
- com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.getInnerExceptions()
- com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException()
- com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException(Exception)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException(List<Exception>)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException(String)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException(String,Exception)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException(String,List<Exception>)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.toString()
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.yml
langs:
- java
name: MultiShardAggregateException
nameWithType: MultiShardAggregateException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardAggregateException
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardAggregateException.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardAggregateException.java
startLine: 21
package: com.microsoft.azure.elasticdb.query.exception
summary: '<p>Represents one or more Exception errors that occurred when executing a query across a shard set. The InnerExceptions field collects these exceptions and one can iterate through the InnerExceptions for further inspection or processing. Purpose: Public type that communicates errors that occurred across multiple shards </p>'
syntax: &o1
content: public class MultiShardAggregateException
inheritance:
- java.lang.Object
- Exception
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.getInnerExceptions()
id: getInnerExceptions()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.yml
langs:
- java
name: getInnerExceptions()
nameWithType: MultiShardAggregateException.getInnerExceptions()
fullName: final List<Exception> com.microsoft.azure.elasticdb.query.exception.MultiShardAggregateException.getInnerExceptions()
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.getInnerExceptions*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardAggregateException.java
startLine: 108
package: com.microsoft.azure.elasticdb.query.exception
summary: <p>Gets a read-only collection of the Exception instances that caused the current exception. </p>
syntax:
content: public final List<Exception> getInnerExceptions()
return:
type: dd4ca536
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException()
id: MultiShardAggregateException()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.yml
langs:
- java
name: MultiShardAggregateException()
nameWithType: MultiShardAggregateException.MultiShardAggregateException()
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardAggregateException.MultiShardAggregateException()
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardAggregateException.java
startLine: 28
package: com.microsoft.azure.elasticdb.query.exception
summary: <p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception" data-throw-if-not-resolved="false">MultiShardAggregateException</xref> class. </p>
syntax:
content: public MultiShardAggregateException()
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException(Exception)
id: MultiShardAggregateException(Exception)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.yml
langs:
- java
name: MultiShardAggregateException(Exception innerException)
nameWithType: MultiShardAggregateException.MultiShardAggregateException(Exception innerException)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardAggregateException.MultiShardAggregateException(Exception innerException)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardAggregateException.java
startLine: 50
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception" data-throw-if-not-resolved="false">MultiShardAggregateException</xref> class.</p>
<p></p>
syntax:
content: public MultiShardAggregateException(Exception innerException)
parameters:
- id: innerException
type: 8a99d4b0
description: <p>The Exception that caused the current exception </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException(List<Exception>)
id: MultiShardAggregateException(List<Exception>)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.yml
langs:
- java
name: MultiShardAggregateException(List<Exception> innerExceptions)
nameWithType: MultiShardAggregateException.MultiShardAggregateException(List<Exception> innerExceptions)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardAggregateException.MultiShardAggregateException(List<Exception> innerExceptions)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardAggregateException.java
startLine: 77
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception" data-throw-if-not-resolved="false">MultiShardAggregateException</xref> class.</p>
<p></p>
syntax:
content: public MultiShardAggregateException(List<Exception> innerExceptions)
parameters:
- id: innerExceptions
type: 5c5d6e37
description: <p>A list of Exception that caused the current exception </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException(String)
id: MultiShardAggregateException(String)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.yml
langs:
- java
name: MultiShardAggregateException(String message)
nameWithType: MultiShardAggregateException.MultiShardAggregateException(String message)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardAggregateException.MultiShardAggregateException(String message)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardAggregateException.java
startLine: 38
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception" data-throw-if-not-resolved="false">MultiShardAggregateException</xref> class.</p>
<p></p>
syntax:
content: public MultiShardAggregateException(String message)
parameters:
- id: message
type: "26831127"
description: <p>The error message that explains the reason for the exception </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException(String,Exception)
id: MultiShardAggregateException(String,Exception)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.yml
langs:
- java
name: MultiShardAggregateException(String message, Exception innerException)
nameWithType: MultiShardAggregateException.MultiShardAggregateException(String message, Exception innerException)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardAggregateException.MultiShardAggregateException(String message, Exception innerException)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardAggregateException.java
startLine: 62
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception" data-throw-if-not-resolved="false">MultiShardAggregateException</xref> class.</p>
<p></p>
syntax:
content: public MultiShardAggregateException(String message, Exception innerException)
parameters:
- id: message
type: "26831127"
description: <p>The error message that explains the reason for the exception </p>
- id: innerException
type: 8a99d4b0
description: <p>A list of Exception that caused the current exception </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException(String,List<Exception>)
id: MultiShardAggregateException(String,List<Exception>)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.yml
langs:
- java
name: MultiShardAggregateException(String message, List<Exception> innerExceptions)
nameWithType: MultiShardAggregateException.MultiShardAggregateException(String message, List<Exception> innerExceptions)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardAggregateException.MultiShardAggregateException(String message, List<Exception> innerExceptions)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardAggregateException.java
startLine: 91
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception" data-throw-if-not-resolved="false">MultiShardAggregateException</xref> class.</p>
<p></p>
syntax:
content: public MultiShardAggregateException(String message, List<Exception> innerExceptions)
parameters:
- id: message
type: "26831127"
description: <p>The error message that explains the reason for the exception </p>
- id: innerExceptions
type: 5c5d6e37
description: <p>A list of Exception that caused the current exception </p>
exceptions:
- type: 3c87bd19
description: <p>The <em>innerExceptions</em> is null </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.toString()
id: toString()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.yml
langs:
- java
name: toString()
nameWithType: MultiShardAggregateException.toString()
fullName: String com.microsoft.azure.elasticdb.query.exception.MultiShardAggregateException.toString()
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.toString*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardAggregateException.java
startLine: 117
package: com.microsoft.azure.elasticdb.query.exception
summary: <p>Provides a string representation of this exception including its inner exceptions. </p>
syntax:
content: public String toString()
return:
type: "26831127"
references:
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.MultiShardAggregateException*
name: MultiShardAggregateException
nameWithType: MultiShardAggregateException.MultiShardAggregateException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardAggregateException.MultiShardAggregateException
package: com.microsoft.azure.elasticdb.query.exception
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: 8a99d4b0
spec.java:
- name: Exception
fullName: Exception
- uid: 5c5d6e37
spec.java:
- name: List<Exception>
fullName: List<Exception>
- uid: 3c87bd19
spec.java:
- name: IllegalArgumentException
fullName: IllegalArgumentException
- uid: dd4ca536
spec.java:
- name: final List<Exception>
fullName: final List<Exception>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.getInnerExceptions*
name: getInnerExceptions
nameWithType: MultiShardAggregateException.getInnerExceptions
fullName: final List<Exception> com.microsoft.azure.elasticdb.query.exception.MultiShardAggregateException.getInnerExceptions
package: com.microsoft.azure.elasticdb.query.exception
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.toString*
name: toString
nameWithType: MultiShardAggregateException.toString
fullName: String com.microsoft.azure.elasticdb.query.exception.MultiShardAggregateException.toString
package: com.microsoft.azure.elasticdb.query.exception
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.yml
name: MultiShardAggregateException
nameWithType: MultiShardAggregateException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardAggregateException
type: Class
summary: '<p>Represents one or more Exception errors that occurred when executing a query across a shard set. The InnerExceptions field collects these exceptions and one can iterate through the InnerExceptions for further inspection or processing. Purpose: Public type that communicates errors that occurred across multiple shards </p>'
syntax: *o1

Просмотреть файл

@ -0,0 +1,350 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
id: _multi_shard_exception
parent: com.microsoft.azure.elasticdb.query.exception
children:
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.getShardLocation()
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException()
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,Exception)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,String)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,String,Exception)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(String)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(String,Exception)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.toString()
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
langs:
- java
name: MultiShardException
nameWithType: MultiShardException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardException.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardException.java
startLine: 28
package: com.microsoft.azure.elasticdb.query.exception
summary: "<p>DEVNOTE: Encapsulate SMM ShardLocation type for now since Shard isn't Serializable Support for serialization of ShardLocation is in the works. A <xref uid=\"com.microsoft.azure.elasticdb.query.exception._multi_shard_exception\" data-throw-if-not-resolved=\"false\">MultiShardException</xref> represents an exception that occurred when performing operations against a shard. It provides information about both the identity of the shard and the exception that occurred. Depending on the nature of the exception, one can try re-running the multi-shard query, execute a separate query targeted directly at the shard(s) on that yielded the exception, or lastly execute the query manually against the shard using a common tool such as SSMS. </p>"
syntax: &o1
content: public class MultiShardException
inheritance:
- java.lang.Object
- Exception
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.getShardLocation()
id: getShardLocation()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
langs:
- java
name: getShardLocation()
nameWithType: MultiShardException.getShardLocation()
fullName: final ShardLocation com.microsoft.azure.elasticdb.query.exception.MultiShardException.getShardLocation()
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.getShardLocation*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardException.java
startLine: 130
package: com.microsoft.azure.elasticdb.query.exception
summary: <p>The shard associated with this exception. </p>
syntax:
content: public final ShardLocation getShardLocation()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.base._shard_location
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException()
id: MultiShardException()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
langs:
- java
name: MultiShardException()
nameWithType: MultiShardException.MultiShardException()
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException()
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardException.java
startLine: 35
package: com.microsoft.azure.elasticdb.query.exception
summary: <p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class. </p>
syntax:
content: public MultiShardException()
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation)
id: MultiShardException(ShardLocation)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
langs:
- java
name: MultiShardException(ShardLocation shardLocation)
nameWithType: MultiShardException.MultiShardException(ShardLocation shardLocation)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(ShardLocation shardLocation)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardException.java
startLine: 69
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified shard location.</p>
<p></p>
syntax:
content: public MultiShardException(ShardLocation shardLocation)
parameters:
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>specifies the location of the shard where the exception occurred. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,Exception)
id: MultiShardException(ShardLocation,Exception)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
langs:
- java
name: MultiShardException(ShardLocation shardLocation, Exception inner)
nameWithType: MultiShardException.MultiShardException(ShardLocation shardLocation, Exception inner)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(ShardLocation shardLocation, Exception inner)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardException.java
startLine: 94
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified shard location and exception.</p>
<p></p>
syntax:
content: public MultiShardException(ShardLocation shardLocation, Exception inner)
parameters:
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>specifies the location of the shard where the exception occurred. </p>
- id: inner
type: 8a99d4b0
description: <p>specifies the exception encountered at the shard. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,String)
id: MultiShardException(ShardLocation,String)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
langs:
- java
name: MultiShardException(ShardLocation shardLocation, String message)
nameWithType: MultiShardException.MultiShardException(ShardLocation shardLocation, String message)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(ShardLocation shardLocation, String message)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardException.java
startLine: 81
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified shard location and error message.</p>
<p></p>
syntax:
content: public MultiShardException(ShardLocation shardLocation, String message)
parameters:
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>specifies the location of the shard where the exception occurred. </p>
- id: message
type: "26831127"
description: <p>specifies the message that explains the reason for the exception. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,String,Exception)
id: MultiShardException(ShardLocation,String,Exception)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
langs:
- java
name: MultiShardException(ShardLocation shardLocation, String message, Exception inner)
nameWithType: MultiShardException.MultiShardException(ShardLocation shardLocation, String message, Exception inner)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(ShardLocation shardLocation, String message, Exception inner)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardException.java
startLine: 112
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified shard location, error message and exception encountered.</p>
<p></p>
syntax:
content: public MultiShardException(ShardLocation shardLocation, String message, Exception inner)
parameters:
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>specifies the location of the shard where the exception occurred. </p>
- id: message
type: "26831127"
description: <p>specifies the message that explains the reason for the exception. </p>
- id: inner
type: 8a99d4b0
description: <p>specifies the exception encountered at the shard. </p>
exceptions:
- type: 3c87bd19
description: <p>The <em>shardLocation</em> is null </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(String)
id: MultiShardException(String)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
langs:
- java
name: MultiShardException(String message)
nameWithType: MultiShardException.MultiShardException(String message)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(String message)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardException.java
startLine: 45
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified error message.</p>
<p></p>
syntax:
content: public MultiShardException(String message)
parameters:
- id: message
type: "26831127"
description: <p>specifies the exception encountered at the shard. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(String,Exception)
id: MultiShardException(String,Exception)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
langs:
- java
name: MultiShardException(String message, Exception innerException)
nameWithType: MultiShardException.MultiShardException(String message, Exception innerException)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(String message, Exception innerException)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardException.java
startLine: 58
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified error message and the reference to the inner exception that is the cause of this exception.</p>
<p></p>
syntax:
content: public MultiShardException(String message, Exception innerException)
parameters:
- id: message
type: "26831127"
description: <p>specifies the message that explains the reason for the exception. </p>
- id: innerException
type: 8a99d4b0
description: <p>specifies the exception encountered at the shard. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.toString()
id: toString()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
langs:
- java
name: toString()
nameWithType: MultiShardException.toString()
fullName: String com.microsoft.azure.elasticdb.query.exception.MultiShardException.toString()
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.toString*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardException.java
startLine: 140
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Creates and returns a string representation of the current <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref>.</p>
<p></p>
syntax:
content: public String toString()
return:
type: "26831127"
description: <p>String representation of the current exception. </p>
references:
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException*
name: MultiShardException
nameWithType: MultiShardException.MultiShardException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException
package: com.microsoft.azure.elasticdb.query.exception
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: 8a99d4b0
spec.java:
- name: Exception
fullName: Exception
- uid: 3c87bd19
spec.java:
- name: IllegalArgumentException
fullName: IllegalArgumentException
- uid: 93de0ef9com.microsoft.azure.elasticdb.shard.base._shard_location
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
name: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.getShardLocation*
name: getShardLocation
nameWithType: MultiShardException.getShardLocation
fullName: final ShardLocation com.microsoft.azure.elasticdb.query.exception.MultiShardException.getShardLocation
package: com.microsoft.azure.elasticdb.query.exception
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.toString*
name: toString
nameWithType: MultiShardException.toString
fullName: String com.microsoft.azure.elasticdb.query.exception.MultiShardException.toString
package: com.microsoft.azure.elasticdb.query.exception
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.yml
name: MultiShardPartialReadException
nameWithType: MultiShardPartialReadException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardPartialReadException
type: Class
summary: '<p>The MultiShardResultSet throws this exception when an exception has been hit reading data from one of the underlying shards. This indicates that not all rows have been successfully retrieved from the targeted shard(s). Users can then take the steps necessary to decide whether to re-run the query, or whether to continue working with the rows that have already been retrieved. This exception is only thrown with the partial results policy. Purpose: Custom exception to throw when the MultiShardResultSet hits an exception during a next() call to one of the underlying ResultSets. When that happens all we know is that we were not able to read all the results from that shard, so we need to notify the user somehow. </p>'
syntax:
content: public class MultiShardPartialReadException
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.yml
name: MultiShardSchemaMismatchException
nameWithType: MultiShardSchemaMismatchException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardSchemaMismatchException
type: Class
summary: '<p>Custom exception thrown when the schema on at least one of the shards participating in the overall query does not conform to the expected schema for the multi-shard query as a whole. Purpose: Custom exception to throw when the schema from a ResultSet from a given shard does not conform to the expected schema for the fanout query as a whole. </p>'
syntax:
content: public class MultiShardSchemaMismatchException
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
name: ShardLocation
nameWithType: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
type: Class
summary: <p>Represents the location of a shard in terms of its server name and database name. This is used to manage connections to the shard and to support other operations on shards. As opposed to a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>, a shard location is not registered with the shard map. </p>
syntax:
content: public class ShardLocation
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException
nameWithType: MultiShardException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException
type: Class
summary: "<p>DEVNOTE: Encapsulate SMM ShardLocation type for now since Shard isn't Serializable Support for serialization of ShardLocation is in the works. A <xref uid=\"com.microsoft.azure.elasticdb.query.exception._multi_shard_exception\" data-throw-if-not-resolved=\"false\">MultiShardException</xref> represents an exception that occurred when performing operations against a shard. It provides information about both the identity of the shard and the exception that occurred. Depending on the nature of the exception, one can try re-running the multi-shard query, execute a separate query targeted directly at the shard(s) on that yielded the exception, or lastly execute the query manually against the shard using a common tool such as SSMS. </p>"
syntax: *o1

Просмотреть файл

@ -0,0 +1,339 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception
id: _multi_shard_partial_read_exception
parent: com.microsoft.azure.elasticdb.query.exception
children:
- com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.MultiShardPartialReadException()
- com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.MultiShardPartialReadException(ShardLocation,String,RuntimeException)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.MultiShardPartialReadException(String)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.MultiShardPartialReadException(String,RuntimeException)
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.yml
langs:
- java
name: MultiShardPartialReadException
nameWithType: MultiShardPartialReadException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardPartialReadException
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardPartialReadException.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardPartialReadException.java
startLine: 21
package: com.microsoft.azure.elasticdb.query.exception
summary: '<p>The MultiShardResultSet throws this exception when an exception has been hit reading data from one of the underlying shards. This indicates that not all rows have been successfully retrieved from the targeted shard(s). Users can then take the steps necessary to decide whether to re-run the query, or whether to continue working with the rows that have already been retrieved. This exception is only thrown with the partial results policy. Purpose: Custom exception to throw when the MultiShardResultSet hits an exception during a next() call to one of the underlying ResultSets. When that happens all we know is that we were not able to read all the results from that shard, so we need to notify the user somehow. </p>'
syntax: &o1
content: public class MultiShardPartialReadException extends MultiShardException
inheritance:
- java.lang.Object
- Exception
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
inheritedMembers:
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.getShardLocation()
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException()
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(String)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(String,Exception)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,String)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,Exception)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,String,Exception)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.toString()
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.MultiShardPartialReadException()
id: MultiShardPartialReadException()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.yml
langs:
- java
name: MultiShardPartialReadException()
nameWithType: MultiShardPartialReadException.MultiShardPartialReadException()
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardPartialReadException.MultiShardPartialReadException()
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.MultiShardPartialReadException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardPartialReadException.java
startLine: 56
package: com.microsoft.azure.elasticdb.query.exception
summary: <p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception" data-throw-if-not-resolved="false">MultiShardPartialReadException</xref> class. </p>
syntax:
content: public MultiShardPartialReadException()
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.MultiShardPartialReadException(ShardLocation,String,RuntimeException)
id: MultiShardPartialReadException(ShardLocation,String,RuntimeException)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.yml
langs:
- java
name: MultiShardPartialReadException(ShardLocation shardLocation, String message, RuntimeException inner)
nameWithType: MultiShardPartialReadException.MultiShardPartialReadException(ShardLocation shardLocation, String message, RuntimeException inner)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardPartialReadException.MultiShardPartialReadException(ShardLocation shardLocation, String message, RuntimeException inner)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.MultiShardPartialReadException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardPartialReadException.java
startLine: 23
package: com.microsoft.azure.elasticdb.query.exception
syntax:
content: public MultiShardPartialReadException(ShardLocation shardLocation, String message, RuntimeException inner)
parameters:
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
- id: message
type: "26831127"
- id: inner
type: 9b2a4515
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.MultiShardPartialReadException(String)
id: MultiShardPartialReadException(String)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.yml
langs:
- java
name: MultiShardPartialReadException(String message)
nameWithType: MultiShardPartialReadException.MultiShardPartialReadException(String message)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardPartialReadException.MultiShardPartialReadException(String message)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.MultiShardPartialReadException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardPartialReadException.java
startLine: 49
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception" data-throw-if-not-resolved="false">MultiShardPartialReadException</xref> class with the specified error message.</p>
<p></p>
syntax:
content: public MultiShardPartialReadException(String message)
parameters:
- id: message
type: "26831127"
description: <p>specifies the message that explains the reason for the exception. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.MultiShardPartialReadException(String,RuntimeException)
id: MultiShardPartialReadException(String,RuntimeException)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.yml
langs:
- java
name: MultiShardPartialReadException(String message, RuntimeException innerException)
nameWithType: MultiShardPartialReadException.MultiShardPartialReadException(String message, RuntimeException innerException)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardPartialReadException.MultiShardPartialReadException(String message, RuntimeException innerException)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.MultiShardPartialReadException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardPartialReadException.java
startLine: 38
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception" data-throw-if-not-resolved="false">MultiShardPartialReadException</xref> class with the specified error message and reference to the inner exception causing the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception" data-throw-if-not-resolved="false">MultiShardPartialReadException</xref>.</p>
<p></p>
syntax:
content: public MultiShardPartialReadException(String message, RuntimeException innerException)
parameters:
- id: message
type: "26831127"
description: <p>specifies the message that explains the reason for the exception. </p>
- id: innerException
type: 9b2a4515
description: <p>specifies the exception encountered at the shard. </p>
references:
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: 9b2a4515
spec.java:
- name: RuntimeException
fullName: RuntimeException
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.MultiShardPartialReadException*
name: MultiShardPartialReadException
nameWithType: MultiShardPartialReadException.MultiShardPartialReadException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardPartialReadException.MultiShardPartialReadException
package: com.microsoft.azure.elasticdb.query.exception
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.getShardLocation()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: getShardLocation()
nameWithType: MultiShardException.getShardLocation()
fullName: final ShardLocation com.microsoft.azure.elasticdb.query.exception.MultiShardException.getShardLocation()
type: Method
summary: <p>The shard associated with this exception. </p>
syntax:
content: public final ShardLocation getShardLocation()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.base._shard_location
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException()
nameWithType: MultiShardException.MultiShardException()
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException()
type: Constructor
summary: <p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class. </p>
syntax:
content: public MultiShardException()
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(String)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException(String message)
nameWithType: MultiShardException.MultiShardException(String message)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(String message)
type: Constructor
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified error message.</p>
<p></p>
syntax:
content: public MultiShardException(String message)
parameters:
- id: message
type: "26831127"
description: <p>specifies the exception encountered at the shard. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(String,Exception)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException(String message, Exception innerException)
nameWithType: MultiShardException.MultiShardException(String message, Exception innerException)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(String message, Exception innerException)
type: Constructor
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified error message and the reference to the inner exception that is the cause of this exception.</p>
<p></p>
syntax:
content: public MultiShardException(String message, Exception innerException)
parameters:
- id: message
type: "26831127"
description: <p>specifies the message that explains the reason for the exception. </p>
- id: innerException
type: 8a99d4b0
description: <p>specifies the exception encountered at the shard. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException(ShardLocation shardLocation)
nameWithType: MultiShardException.MultiShardException(ShardLocation shardLocation)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(ShardLocation shardLocation)
type: Constructor
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified shard location.</p>
<p></p>
syntax:
content: public MultiShardException(ShardLocation shardLocation)
parameters:
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>specifies the location of the shard where the exception occurred. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,String)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException(ShardLocation shardLocation, String message)
nameWithType: MultiShardException.MultiShardException(ShardLocation shardLocation, String message)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(ShardLocation shardLocation, String message)
type: Constructor
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified shard location and error message.</p>
<p></p>
syntax:
content: public MultiShardException(ShardLocation shardLocation, String message)
parameters:
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>specifies the location of the shard where the exception occurred. </p>
- id: message
type: "26831127"
description: <p>specifies the message that explains the reason for the exception. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,Exception)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException(ShardLocation shardLocation, Exception inner)
nameWithType: MultiShardException.MultiShardException(ShardLocation shardLocation, Exception inner)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(ShardLocation shardLocation, Exception inner)
type: Constructor
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified shard location and exception.</p>
<p></p>
syntax:
content: public MultiShardException(ShardLocation shardLocation, Exception inner)
parameters:
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>specifies the location of the shard where the exception occurred. </p>
- id: inner
type: 8a99d4b0
description: <p>specifies the exception encountered at the shard. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,String,Exception)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException(ShardLocation shardLocation, String message, Exception inner)
nameWithType: MultiShardException.MultiShardException(ShardLocation shardLocation, String message, Exception inner)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(ShardLocation shardLocation, String message, Exception inner)
type: Constructor
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified shard location, error message and exception encountered.</p>
<p></p>
syntax:
content: public MultiShardException(ShardLocation shardLocation, String message, Exception inner)
parameters:
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>specifies the location of the shard where the exception occurred. </p>
- id: message
type: "26831127"
description: <p>specifies the message that explains the reason for the exception. </p>
- id: inner
type: 8a99d4b0
description: <p>specifies the exception encountered at the shard. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.toString()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: toString()
nameWithType: MultiShardException.toString()
fullName: String com.microsoft.azure.elasticdb.query.exception.MultiShardException.toString()
type: Method
summary: >-
<p>Creates and returns a string representation of the current <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref>.</p>
<p></p>
syntax:
content: public String toString()
return:
type: "26831127"
description: <p>String representation of the current exception. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException
nameWithType: MultiShardException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException
type: Class
summary: "<p>DEVNOTE: Encapsulate SMM ShardLocation type for now since Shard isn't Serializable Support for serialization of ShardLocation is in the works. A <xref uid=\"com.microsoft.azure.elasticdb.query.exception._multi_shard_exception\" data-throw-if-not-resolved=\"false\">MultiShardException</xref> represents an exception that occurred when performing operations against a shard. It provides information about both the identity of the shard and the exception that occurred. Depending on the nature of the exception, one can try re-running the multi-shard query, execute a separate query targeted directly at the shard(s) on that yielded the exception, or lastly execute the query manually against the shard using a common tool such as SSMS. </p>"
syntax:
content: public class MultiShardException
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
name: ShardLocation
nameWithType: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
type: Class
summary: <p>Represents the location of a shard in terms of its server name and database name. This is used to manage connections to the shard and to support other operations on shards. As opposed to a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>, a shard location is not registered with the shard map. </p>
syntax:
content: public class ShardLocation
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.yml
name: MultiShardPartialReadException
nameWithType: MultiShardPartialReadException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardPartialReadException
type: Class
summary: '<p>The MultiShardResultSet throws this exception when an exception has been hit reading data from one of the underlying shards. This indicates that not all rows have been successfully retrieved from the targeted shard(s). Users can then take the steps necessary to decide whether to re-run the query, or whether to continue working with the rows that have already been retrieved. This exception is only thrown with the partial results policy. Purpose: Custom exception to throw when the MultiShardResultSet hits an exception during a next() call to one of the underlying ResultSets. When that happens all we know is that we were not able to read all the results from that shard, so we need to notify the user somehow. </p>'
syntax: *o1

Просмотреть файл

@ -0,0 +1,127 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception
id: _multi_shard_result_set_closed_exception
parent: com.microsoft.azure.elasticdb.query.exception
children:
- com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.MultiShardResultSetClosedException()
- com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.MultiShardResultSetClosedException(String)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.MultiShardResultSetClosedException(String,RuntimeException)
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.yml
langs:
- java
name: MultiShardResultSetClosedException
nameWithType: MultiShardResultSetClosedException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardResultSetClosedException
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardResultSetClosedException.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardResultSetClosedException.java
startLine: 16
package: com.microsoft.azure.elasticdb.query.exception
summary: '<p>Custom exception to throw when the MultiShardResultSet is closed and the user attempts to perform an operation on the closed reader. Purpose: Custom exception to throw when the MultiShardResultSet is closed and the user attempts to perform some operation. </p>'
syntax: &o1
content: public class MultiShardResultSetClosedException
inheritance:
- java.lang.Object
- RuntimeException
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.MultiShardResultSetClosedException()
id: MultiShardResultSetClosedException()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.yml
langs:
- java
name: MultiShardResultSetClosedException()
nameWithType: MultiShardResultSetClosedException.MultiShardResultSetClosedException()
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardResultSetClosedException.MultiShardResultSetClosedException()
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.MultiShardResultSetClosedException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardResultSetClosedException.java
startLine: 45
package: com.microsoft.azure.elasticdb.query.exception
summary: <p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception" data-throw-if-not-resolved="false">MultiShardResultSetClosedException</xref> class. </p>
syntax:
content: public MultiShardResultSetClosedException()
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.MultiShardResultSetClosedException(String)
id: MultiShardResultSetClosedException(String)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.yml
langs:
- java
name: MultiShardResultSetClosedException(String message)
nameWithType: MultiShardResultSetClosedException.MultiShardResultSetClosedException(String message)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardResultSetClosedException.MultiShardResultSetClosedException(String message)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.MultiShardResultSetClosedException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardResultSetClosedException.java
startLine: 38
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception" data-throw-if-not-resolved="false">MultiShardResultSetClosedException</xref> class with a specified error message.</p>
<p></p>
syntax:
content: public MultiShardResultSetClosedException(String message)
parameters:
- id: message
type: "26831127"
description: <p>The message that describes the error. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.MultiShardResultSetClosedException(String,RuntimeException)
id: MultiShardResultSetClosedException(String,RuntimeException)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.yml
langs:
- java
name: MultiShardResultSetClosedException(String message, RuntimeException innerException)
nameWithType: MultiShardResultSetClosedException.MultiShardResultSetClosedException(String message, RuntimeException innerException)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardResultSetClosedException.MultiShardResultSetClosedException(String message, RuntimeException innerException)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.MultiShardResultSetClosedException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardResultSetClosedException.java
startLine: 27
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the MultiShardReaderClosedException class with a specified error message and a reference to the inner exception that is the cause of this exception.</p>
<p></p>
syntax:
content: public MultiShardResultSetClosedException(String message, RuntimeException innerException)
parameters:
- id: message
type: "26831127"
description: <p>The error message that explains the reason for the exception. </p>
- id: innerException
type: 9b2a4515
description: <p>The exception that is the cause of the current exception, or a null reference if no inner exception is specified. </p>
references:
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: 9b2a4515
spec.java:
- name: RuntimeException
fullName: RuntimeException
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.MultiShardResultSetClosedException*
name: MultiShardResultSetClosedException
nameWithType: MultiShardResultSetClosedException.MultiShardResultSetClosedException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardResultSetClosedException.MultiShardResultSetClosedException
package: com.microsoft.azure.elasticdb.query.exception
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.yml
name: MultiShardResultSetClosedException
nameWithType: MultiShardResultSetClosedException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardResultSetClosedException
type: Class
summary: '<p>Custom exception to throw when the MultiShardResultSet is closed and the user attempts to perform an operation on the closed reader. Purpose: Custom exception to throw when the MultiShardResultSet is closed and the user attempts to perform some operation. </p>'
syntax: *o1

Просмотреть файл

@ -0,0 +1,127 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception
id: _multi_shard_result_set_internal_exception
parent: com.microsoft.azure.elasticdb.query.exception
children:
- com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.MultiShardResultSetInternalException()
- com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.MultiShardResultSetInternalException(String)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.MultiShardResultSetInternalException(String,RuntimeException)
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.yml
langs:
- java
name: MultiShardResultSetInternalException
nameWithType: MultiShardResultSetInternalException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardResultSetInternalException
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardResultSetInternalException.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardResultSetInternalException.java
startLine: 17
package: com.microsoft.azure.elasticdb.query.exception
summary: '<p>Custom exception that is thrown when the MultiShardResultSet is in an invalid state. If you experience this exception repeatedly, please contact Microsoft Customer Support. Purpose: Custom exception to throw when the MultiShardResultSet is in an invalid state. This error should not make it out to the user. </p>'
syntax: &o1
content: public class MultiShardResultSetInternalException
inheritance:
- java.lang.Object
- RuntimeException
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.MultiShardResultSetInternalException()
id: MultiShardResultSetInternalException()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.yml
langs:
- java
name: MultiShardResultSetInternalException()
nameWithType: MultiShardResultSetInternalException.MultiShardResultSetInternalException()
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardResultSetInternalException.MultiShardResultSetInternalException()
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.MultiShardResultSetInternalException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardResultSetInternalException.java
startLine: 22
package: com.microsoft.azure.elasticdb.query.exception
summary: <p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception" data-throw-if-not-resolved="false">MultiShardResultSetInternalException</xref> class. </p>
syntax:
content: public MultiShardResultSetInternalException()
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.MultiShardResultSetInternalException(String)
id: MultiShardResultSetInternalException(String)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.yml
langs:
- java
name: MultiShardResultSetInternalException(String message)
nameWithType: MultiShardResultSetInternalException.MultiShardResultSetInternalException(String message)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardResultSetInternalException.MultiShardResultSetInternalException(String message)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.MultiShardResultSetInternalException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardResultSetInternalException.java
startLine: 32
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception" data-throw-if-not-resolved="false">MultiShardResultSetInternalException</xref> class with a specified error message.</p>
<p></p>
syntax:
content: public MultiShardResultSetInternalException(String message)
parameters:
- id: message
type: "26831127"
description: <p>The message that describes the error. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.MultiShardResultSetInternalException(String,RuntimeException)
id: MultiShardResultSetInternalException(String,RuntimeException)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.yml
langs:
- java
name: MultiShardResultSetInternalException(String message, RuntimeException innerException)
nameWithType: MultiShardResultSetInternalException.MultiShardResultSetInternalException(String message, RuntimeException innerException)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardResultSetInternalException.MultiShardResultSetInternalException(String message, RuntimeException innerException)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.MultiShardResultSetInternalException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardResultSetInternalException.java
startLine: 44
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception" data-throw-if-not-resolved="false">MultiShardResultSetInternalException</xref> class with a message and an inner exception.</p>
<p></p>
syntax:
content: public MultiShardResultSetInternalException(String message, RuntimeException innerException)
parameters:
- id: message
type: "26831127"
description: <p>The message to encapsulate in the exception. </p>
- id: innerException
type: 9b2a4515
description: <p>The underlying exception that causes this exception. </p>
references:
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.MultiShardResultSetInternalException*
name: MultiShardResultSetInternalException
nameWithType: MultiShardResultSetInternalException.MultiShardResultSetInternalException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardResultSetInternalException.MultiShardResultSetInternalException
package: com.microsoft.azure.elasticdb.query.exception
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: 9b2a4515
spec.java:
- name: RuntimeException
fullName: RuntimeException
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.yml
name: MultiShardResultSetInternalException
nameWithType: MultiShardResultSetInternalException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardResultSetInternalException
type: Class
summary: '<p>Custom exception that is thrown when the MultiShardResultSet is in an invalid state. If you experience this exception repeatedly, please contact Microsoft Customer Support. Purpose: Custom exception to throw when the MultiShardResultSet is in an invalid state. This error should not make it out to the user. </p>'
syntax: *o1

Просмотреть файл

@ -0,0 +1,337 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception
id: _multi_shard_schema_mismatch_exception
parent: com.microsoft.azure.elasticdb.query.exception
children:
- com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.MultiShardSchemaMismatchException()
- com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.MultiShardSchemaMismatchException(ShardLocation,String)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.MultiShardSchemaMismatchException(String)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.MultiShardSchemaMismatchException(String,RuntimeException)
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.yml
langs:
- java
name: MultiShardSchemaMismatchException
nameWithType: MultiShardSchemaMismatchException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardSchemaMismatchException
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardSchemaMismatchException.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardSchemaMismatchException.java
startLine: 19
package: com.microsoft.azure.elasticdb.query.exception
summary: '<p>Custom exception thrown when the schema on at least one of the shards participating in the overall query does not conform to the expected schema for the multi-shard query as a whole. Purpose: Custom exception to throw when the schema from a ResultSet from a given shard does not conform to the expected schema for the fanout query as a whole. </p>'
syntax: &o1
content: public class MultiShardSchemaMismatchException extends MultiShardException
inheritance:
- java.lang.Object
- Exception
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
inheritedMembers:
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.getShardLocation()
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException()
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(String)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(String,Exception)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,String)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,Exception)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,String,Exception)
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.toString()
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.MultiShardSchemaMismatchException()
id: MultiShardSchemaMismatchException()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.yml
langs:
- java
name: MultiShardSchemaMismatchException()
nameWithType: MultiShardSchemaMismatchException.MultiShardSchemaMismatchException()
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardSchemaMismatchException.MultiShardSchemaMismatchException()
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.MultiShardSchemaMismatchException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardSchemaMismatchException.java
startLine: 53
package: com.microsoft.azure.elasticdb.query.exception
summary: <p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception" data-throw-if-not-resolved="false">MultiShardSchemaMismatchException</xref> class. </p>
syntax:
content: public MultiShardSchemaMismatchException()
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.MultiShardSchemaMismatchException(ShardLocation,String)
id: MultiShardSchemaMismatchException(ShardLocation,String)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.yml
langs:
- java
name: MultiShardSchemaMismatchException(ShardLocation shardLocation, String message)
nameWithType: MultiShardSchemaMismatchException.MultiShardSchemaMismatchException(ShardLocation shardLocation, String message)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardSchemaMismatchException.MultiShardSchemaMismatchException(ShardLocation shardLocation, String message)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.MultiShardSchemaMismatchException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardSchemaMismatchException.java
startLine: 21
package: com.microsoft.azure.elasticdb.query.exception
syntax:
content: public MultiShardSchemaMismatchException(ShardLocation shardLocation, String message)
parameters:
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
- id: message
type: "26831127"
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.MultiShardSchemaMismatchException(String)
id: MultiShardSchemaMismatchException(String)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.yml
langs:
- java
name: MultiShardSchemaMismatchException(String message)
nameWithType: MultiShardSchemaMismatchException.MultiShardSchemaMismatchException(String message)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardSchemaMismatchException.MultiShardSchemaMismatchException(String message)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.MultiShardSchemaMismatchException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardSchemaMismatchException.java
startLine: 46
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception" data-throw-if-not-resolved="false">MultiShardSchemaMismatchException</xref> class with the specified error message.</p>
<p></p>
syntax:
content: public MultiShardSchemaMismatchException(String message)
parameters:
- id: message
type: "26831127"
description: <p>specifies the message that explains the reason for the exception. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.MultiShardSchemaMismatchException(String,RuntimeException)
id: MultiShardSchemaMismatchException(String,RuntimeException)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.yml
langs:
- java
name: MultiShardSchemaMismatchException(String message, RuntimeException innerException)
nameWithType: MultiShardSchemaMismatchException.MultiShardSchemaMismatchException(String message, RuntimeException innerException)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardSchemaMismatchException.MultiShardSchemaMismatchException(String message, RuntimeException innerException)
overload: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.MultiShardSchemaMismatchException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardSchemaMismatchException.java
startLine: 35
package: com.microsoft.azure.elasticdb.query.exception
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception" data-throw-if-not-resolved="false">MultiShardSchemaMismatchException</xref> class with the specified error message and the reference to the inner exception that is the cause of this exception.</p>
<p></p>
syntax:
content: public MultiShardSchemaMismatchException(String message, RuntimeException innerException)
parameters:
- id: message
type: "26831127"
description: <p>specifies the message that explains the reason for the exception. </p>
- id: innerException
type: 9b2a4515
description: <p>specifies the exception encountered at the shard. </p>
references:
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.MultiShardSchemaMismatchException*
name: MultiShardSchemaMismatchException
nameWithType: MultiShardSchemaMismatchException.MultiShardSchemaMismatchException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardSchemaMismatchException.MultiShardSchemaMismatchException
package: com.microsoft.azure.elasticdb.query.exception
- uid: 9b2a4515
spec.java:
- name: RuntimeException
fullName: RuntimeException
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.getShardLocation()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: getShardLocation()
nameWithType: MultiShardException.getShardLocation()
fullName: final ShardLocation com.microsoft.azure.elasticdb.query.exception.MultiShardException.getShardLocation()
type: Method
summary: <p>The shard associated with this exception. </p>
syntax:
content: public final ShardLocation getShardLocation()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.base._shard_location
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException()
nameWithType: MultiShardException.MultiShardException()
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException()
type: Constructor
summary: <p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class. </p>
syntax:
content: public MultiShardException()
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(String)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException(String message)
nameWithType: MultiShardException.MultiShardException(String message)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(String message)
type: Constructor
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified error message.</p>
<p></p>
syntax:
content: public MultiShardException(String message)
parameters:
- id: message
type: "26831127"
description: <p>specifies the exception encountered at the shard. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(String,Exception)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException(String message, Exception innerException)
nameWithType: MultiShardException.MultiShardException(String message, Exception innerException)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(String message, Exception innerException)
type: Constructor
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified error message and the reference to the inner exception that is the cause of this exception.</p>
<p></p>
syntax:
content: public MultiShardException(String message, Exception innerException)
parameters:
- id: message
type: "26831127"
description: <p>specifies the message that explains the reason for the exception. </p>
- id: innerException
type: 8a99d4b0
description: <p>specifies the exception encountered at the shard. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException(ShardLocation shardLocation)
nameWithType: MultiShardException.MultiShardException(ShardLocation shardLocation)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(ShardLocation shardLocation)
type: Constructor
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified shard location.</p>
<p></p>
syntax:
content: public MultiShardException(ShardLocation shardLocation)
parameters:
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>specifies the location of the shard where the exception occurred. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,String)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException(ShardLocation shardLocation, String message)
nameWithType: MultiShardException.MultiShardException(ShardLocation shardLocation, String message)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(ShardLocation shardLocation, String message)
type: Constructor
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified shard location and error message.</p>
<p></p>
syntax:
content: public MultiShardException(ShardLocation shardLocation, String message)
parameters:
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>specifies the location of the shard where the exception occurred. </p>
- id: message
type: "26831127"
description: <p>specifies the message that explains the reason for the exception. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,Exception)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException(ShardLocation shardLocation, Exception inner)
nameWithType: MultiShardException.MultiShardException(ShardLocation shardLocation, Exception inner)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(ShardLocation shardLocation, Exception inner)
type: Constructor
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified shard location and exception.</p>
<p></p>
syntax:
content: public MultiShardException(ShardLocation shardLocation, Exception inner)
parameters:
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>specifies the location of the shard where the exception occurred. </p>
- id: inner
type: 8a99d4b0
description: <p>specifies the exception encountered at the shard. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.MultiShardException(ShardLocation,String,Exception)
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException(ShardLocation shardLocation, String message, Exception inner)
nameWithType: MultiShardException.MultiShardException(ShardLocation shardLocation, String message, Exception inner)
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException.MultiShardException(ShardLocation shardLocation, String message, Exception inner)
type: Constructor
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref> class with the specified shard location, error message and exception encountered.</p>
<p></p>
syntax:
content: public MultiShardException(ShardLocation shardLocation, String message, Exception inner)
parameters:
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>specifies the location of the shard where the exception occurred. </p>
- id: message
type: "26831127"
description: <p>specifies the message that explains the reason for the exception. </p>
- id: inner
type: 8a99d4b0
description: <p>specifies the exception encountered at the shard. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.toString()
parent: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: toString()
nameWithType: MultiShardException.toString()
fullName: String com.microsoft.azure.elasticdb.query.exception.MultiShardException.toString()
type: Method
summary: >-
<p>Creates and returns a string representation of the current <xref uid="com.microsoft.azure.elasticdb.query.exception._multi_shard_exception" data-throw-if-not-resolved="false">MultiShardException</xref>.</p>
<p></p>
syntax:
content: public String toString()
return:
type: "26831127"
description: <p>String representation of the current exception. </p>
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException
nameWithType: MultiShardException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException
type: Class
summary: "<p>DEVNOTE: Encapsulate SMM ShardLocation type for now since Shard isn't Serializable Support for serialization of ShardLocation is in the works. A <xref uid=\"com.microsoft.azure.elasticdb.query.exception._multi_shard_exception\" data-throw-if-not-resolved=\"false\">MultiShardException</xref> represents an exception that occurred when performing operations against a shard. It provides information about both the identity of the shard and the exception that occurred. Depending on the nature of the exception, one can try re-running the multi-shard query, execute a separate query targeted directly at the shard(s) on that yielded the exception, or lastly execute the query manually against the shard using a common tool such as SSMS. </p>"
syntax:
content: public class MultiShardException
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
name: ShardLocation
nameWithType: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
type: Class
summary: <p>Represents the location of a shard in terms of its server name and database name. This is used to manage connections to the shard and to support other operations on shards. As opposed to a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>, a shard location is not registered with the shard map. </p>
syntax:
content: public class ShardLocation
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.yml
name: MultiShardSchemaMismatchException
nameWithType: MultiShardSchemaMismatchException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardSchemaMismatchException
type: Class
summary: '<p>Custom exception thrown when the schema on at least one of the shards participating in the overall query does not conform to the expected schema for the multi-shard query as a whole. Purpose: Custom exception to throw when the schema from a ResultSet from a given shard does not conform to the expected schema for the fanout query as a whole. </p>'
syntax: *o1

Просмотреть файл

@ -0,0 +1,87 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.exception
id: exception
children:
- com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception
- com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
- com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception
- com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception
- com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception
- com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception
href: com.microsoft.azure.elasticdb.query.exception.yml
langs:
- java
name: com.microsoft.azure.elasticdb.query.exception
nameWithType: com.microsoft.azure.elasticdb.query.exception
fullName: com.microsoft.azure.elasticdb.query.exception
type: Namespace
source:
remote:
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardAggregateException.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/exception/MultiShardAggregateException.java
syntax:
content: package com.microsoft.azure.elasticdb.query.exception
references:
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_aggregate_exception.yml
name: MultiShardAggregateException
nameWithType: MultiShardAggregateException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardAggregateException
type: Class
summary: '<p>Represents one or more Exception errors that occurred when executing a query across a shard set. The InnerExceptions field collects these exceptions and one can iterate through the InnerExceptions for further inspection or processing. Purpose: Public type that communicates errors that occurred across multiple shards </p>'
syntax:
content: public class MultiShardAggregateException
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException
nameWithType: MultiShardException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException
type: Class
summary: "<p>DEVNOTE: Encapsulate SMM ShardLocation type for now since Shard isn't Serializable Support for serialization of ShardLocation is in the works. A <xref uid=\"com.microsoft.azure.elasticdb.query.exception._multi_shard_exception\" data-throw-if-not-resolved=\"false\">MultiShardException</xref> represents an exception that occurred when performing operations against a shard. It provides information about both the identity of the shard and the exception that occurred. Depending on the nature of the exception, one can try re-running the multi-shard query, execute a separate query targeted directly at the shard(s) on that yielded the exception, or lastly execute the query manually against the shard using a common tool such as SSMS. </p>"
syntax:
content: public class MultiShardException
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_partial_read_exception.yml
name: MultiShardPartialReadException
nameWithType: MultiShardPartialReadException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardPartialReadException
type: Class
summary: '<p>The MultiShardResultSet throws this exception when an exception has been hit reading data from one of the underlying shards. This indicates that not all rows have been successfully retrieved from the targeted shard(s). Users can then take the steps necessary to decide whether to re-run the query, or whether to continue working with the rows that have already been retrieved. This exception is only thrown with the partial results policy. Purpose: Custom exception to throw when the MultiShardResultSet hits an exception during a next() call to one of the underlying ResultSets. When that happens all we know is that we were not able to read all the results from that shard, so we need to notify the user somehow. </p>'
syntax:
content: public class MultiShardPartialReadException extends MultiShardException
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_closed_exception.yml
name: MultiShardResultSetClosedException
nameWithType: MultiShardResultSetClosedException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardResultSetClosedException
type: Class
summary: '<p>Custom exception to throw when the MultiShardResultSet is closed and the user attempts to perform an operation on the closed reader. Purpose: Custom exception to throw when the MultiShardResultSet is closed and the user attempts to perform some operation. </p>'
syntax:
content: public class MultiShardResultSetClosedException
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_result_set_internal_exception.yml
name: MultiShardResultSetInternalException
nameWithType: MultiShardResultSetInternalException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardResultSetInternalException
type: Class
summary: '<p>Custom exception that is thrown when the MultiShardResultSet is in an invalid state. If you experience this exception repeatedly, please contact Microsoft Customer Support. Purpose: Custom exception to throw when the MultiShardResultSet is in an invalid state. This error should not make it out to the user. </p>'
syntax:
content: public class MultiShardResultSetInternalException
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_schema_mismatch_exception.yml
name: MultiShardSchemaMismatchException
nameWithType: MultiShardSchemaMismatchException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardSchemaMismatchException
type: Class
summary: '<p>Custom exception thrown when the schema on at least one of the shards participating in the overall query does not conform to the expected schema for the multi-shard query as a whole. Purpose: Custom exception to throw when the schema from a ResultSet from a given shard does not conform to the expected schema for the fanout query as a whole. </p>'
syntax:
content: public class MultiShardSchemaMismatchException extends MultiShardException

Просмотреть файл

@ -0,0 +1,298 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior
id: _command_behavior
parent: com.microsoft.azure.elasticdb.query.logging
children:
- com.microsoft.azure.elasticdb.query.logging._command_behavior.CloseConnection
- com.microsoft.azure.elasticdb.query.logging._command_behavior.CommandBehavior(int)
- com.microsoft.azure.elasticdb.query.logging._command_behavior.Default
- com.microsoft.azure.elasticdb.query.logging._command_behavior.forValue(int)
- com.microsoft.azure.elasticdb.query.logging._command_behavior.getValue()
- com.microsoft.azure.elasticdb.query.logging._command_behavior.KeyInfo
- com.microsoft.azure.elasticdb.query.logging._command_behavior.SchemaOnly
- com.microsoft.azure.elasticdb.query.logging._command_behavior.SequentialAccess
- com.microsoft.azure.elasticdb.query.logging._command_behavior.SingleResult
- com.microsoft.azure.elasticdb.query.logging._command_behavior.SingleRow
- com.microsoft.azure.elasticdb.query.logging._command_behavior.SIZE
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
langs:
- java
name: CommandBehavior
nameWithType: CommandBehavior
fullName: com.microsoft.azure.elasticdb.query.logging.CommandBehavior
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/CommandBehavior.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/CommandBehavior.java
startLine: 5
package: com.microsoft.azure.elasticdb.query.logging
summary: '<p>Summary: Provides a description of the results of the query and its effect on the database. </p>'
syntax: &o1
content: public enum CommandBehavior
inheritance:
- java.lang.Object
- java.lang.Enum<CommandBehavior>
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.CloseConnection
id: CloseConnection
parent: com.microsoft.azure.elasticdb.query.logging._command_behavior
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
langs:
- java
name: CloseConnection
nameWithType: CommandBehavior.CloseConnection
fullName: com.microsoft.azure.elasticdb.query.logging.CommandBehavior.CloseConnection
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/CommandBehavior.java
startLine: 48
package: com.microsoft.azure.elasticdb.query.logging
summary: <p>When the command is executed, the associated Connection object is closed when the associated ResultSet object is closed. </p>
syntax:
content: public CloseConnection=(32)
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.CommandBehavior(int)
id: CommandBehavior(int)
parent: com.microsoft.azure.elasticdb.query.logging._command_behavior
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
langs:
- java
name: CommandBehavior(int value)
nameWithType: CommandBehavior.CommandBehavior(int value)
fullName: com.microsoft.azure.elasticdb.query.logging.CommandBehavior.CommandBehavior(int value)
overload: com.microsoft.azure.elasticdb.query.logging._command_behavior.CommandBehavior*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/CommandBehavior.java
startLine: 54
package: com.microsoft.azure.elasticdb.query.logging
syntax:
content: public CommandBehavior(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.Default
id: Default
parent: com.microsoft.azure.elasticdb.query.logging._command_behavior
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
langs:
- java
name: Default
nameWithType: CommandBehavior.Default
fullName: com.microsoft.azure.elasticdb.query.logging.CommandBehavior.Default
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/CommandBehavior.java
startLine: 11
package: com.microsoft.azure.elasticdb.query.logging
summary: <p>The query may return multiple result sets. Execution of the query may affect the database state. Default sets no <xref uid="com.microsoft.azure.elasticdb.query.logging._command_behavior" data-throw-if-not-resolved="false">CommandBehavior</xref> flags, so calling executeQuery(<xref uid="com.microsoft.azure.elasticdb.query.logging._command_behavior.Default" data-throw-if-not-resolved="false">CommandBehavior.Default</xref>) is functionally equivalent to calling executeQuery(). </p>
syntax: &o2
content: public Default=(0)
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.query.logging._command_behavior
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
langs:
- java
name: forValue(int value)
nameWithType: CommandBehavior.forValue(int value)
fullName: static CommandBehavior com.microsoft.azure.elasticdb.query.logging.CommandBehavior.forValue(int value)
overload: com.microsoft.azure.elasticdb.query.logging._command_behavior.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/CommandBehavior.java
startLine: 70
package: com.microsoft.azure.elasticdb.query.logging
syntax:
content: public static CommandBehavior forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.query.logging._command_behavior
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.query.logging._command_behavior
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
langs:
- java
name: getValue()
nameWithType: CommandBehavior.getValue()
fullName: int com.microsoft.azure.elasticdb.query.logging.CommandBehavior.getValue()
overload: com.microsoft.azure.elasticdb.query.logging._command_behavior.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/CommandBehavior.java
startLine: 74
package: com.microsoft.azure.elasticdb.query.logging
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.KeyInfo
id: KeyInfo
parent: com.microsoft.azure.elasticdb.query.logging._command_behavior
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
langs:
- java
name: KeyInfo
nameWithType: CommandBehavior.KeyInfo
fullName: com.microsoft.azure.elasticdb.query.logging.CommandBehavior.KeyInfo
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/CommandBehavior.java
startLine: 27
package: com.microsoft.azure.elasticdb.query.logging
summary: <p>The query returns column and primary key information. </p>
syntax:
content: public KeyInfo=(4)
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.SchemaOnly
id: SchemaOnly
parent: com.microsoft.azure.elasticdb.query.logging._command_behavior
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
langs:
- java
name: SchemaOnly
nameWithType: CommandBehavior.SchemaOnly
fullName: com.microsoft.azure.elasticdb.query.logging.CommandBehavior.SchemaOnly
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/CommandBehavior.java
startLine: 22
package: com.microsoft.azure.elasticdb.query.logging
summary: <p>The query returns column information only. When using <xref uid="com.microsoft.azure.elasticdb.query.logging._command_behavior.SchemaOnly" data-throw-if-not-resolved="false">CommandBehavior.SchemaOnly</xref>, the .NET Framework Data Provider for SQL Server precedes the statement being executed with SET FMTONLY ON. </p>
syntax: &o3
content: public SchemaOnly=(2)
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.SequentialAccess
id: SequentialAccess
parent: com.microsoft.azure.elasticdb.query.logging._command_behavior
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
langs:
- java
name: SequentialAccess
nameWithType: CommandBehavior.SequentialAccess
fullName: com.microsoft.azure.elasticdb.query.logging.CommandBehavior.SequentialAccess
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/CommandBehavior.java
startLine: 43
package: com.microsoft.azure.elasticdb.query.logging
summary: <p>Provides a way for the ResultSet to handle rows that contain columns with large binary values. Rather than loading the entire row, SequentialAccess enables the ResultSet to load data as a stream. You can then use the GetBytes or GetChars method to specify a byte location to start the read operation, and a limited buffer size for the data being returned. </p>
syntax:
content: public SequentialAccess=(16)
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.SingleResult
id: SingleResult
parent: com.microsoft.azure.elasticdb.query.logging._command_behavior
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
langs:
- java
name: SingleResult
nameWithType: CommandBehavior.SingleResult
fullName: com.microsoft.azure.elasticdb.query.logging.CommandBehavior.SingleResult
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/CommandBehavior.java
startLine: 16
package: com.microsoft.azure.elasticdb.query.logging
summary: <p>The query returns a single result set. </p>
syntax:
content: public SingleResult=(1)
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.SingleRow
id: SingleRow
parent: com.microsoft.azure.elasticdb.query.logging._command_behavior
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
langs:
- java
name: SingleRow
nameWithType: CommandBehavior.SingleRow
fullName: com.microsoft.azure.elasticdb.query.logging.CommandBehavior.SingleRow
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/CommandBehavior.java
startLine: 36
package: com.microsoft.azure.elasticdb.query.logging
summary: <p>The query is expected to return a single row of the first result set. Execution of the query may affect the database state. Some .NET Framework data providers may, but are not required to, use this information to optimize the performance of the command. It is possible to specify SingleRow when executing queries that are expected to return multiple result sets. In that case, where both a multi-result set SQL query and single row are specified, the result returned will contain only the first row of the first result set. The other result sets of the query will not be returned. </p>
syntax:
content: public SingleRow=(8)
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.query.logging._command_behavior
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
langs:
- java
name: SIZE
nameWithType: CommandBehavior.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.query.logging.CommandBehavior.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/CommandBehavior.java
startLine: 50
package: com.microsoft.azure.elasticdb.query.logging
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.CommandBehavior*
name: CommandBehavior
nameWithType: CommandBehavior.CommandBehavior
fullName: com.microsoft.azure.elasticdb.query.logging.CommandBehavior.CommandBehavior
package: com.microsoft.azure.elasticdb.query.logging
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.getValue*
name: getValue
nameWithType: CommandBehavior.getValue
fullName: int com.microsoft.azure.elasticdb.query.logging.CommandBehavior.getValue
package: com.microsoft.azure.elasticdb.query.logging
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.forValue*
name: forValue
nameWithType: CommandBehavior.forValue
fullName: static CommandBehavior com.microsoft.azure.elasticdb.query.logging.CommandBehavior.forValue
package: com.microsoft.azure.elasticdb.query.logging
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior
parent: com.microsoft.azure.elasticdb.query.logging
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
name: CommandBehavior
nameWithType: CommandBehavior
fullName: com.microsoft.azure.elasticdb.query.logging.CommandBehavior
type: Enum
summary: '<p>Summary: Provides a description of the results of the query and its effect on the database. </p>'
syntax: *o1
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.Default
parent: com.microsoft.azure.elasticdb.query.logging._command_behavior
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
name: Default
nameWithType: CommandBehavior.Default
fullName: com.microsoft.azure.elasticdb.query.logging.CommandBehavior.Default
type: Field
summary: <p>The query may return multiple result sets. Execution of the query may affect the database state. Default sets no <xref uid="com.microsoft.azure.elasticdb.query.logging._command_behavior" data-throw-if-not-resolved="false">CommandBehavior</xref> flags, so calling executeQuery(<xref uid="com.microsoft.azure.elasticdb.query.logging._command_behavior.Default" data-throw-if-not-resolved="false">CommandBehavior.Default</xref>) is functionally equivalent to calling executeQuery(). </p>
syntax: *o2
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior.SchemaOnly
parent: com.microsoft.azure.elasticdb.query.logging._command_behavior
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
name: SchemaOnly
nameWithType: CommandBehavior.SchemaOnly
fullName: com.microsoft.azure.elasticdb.query.logging.CommandBehavior.SchemaOnly
type: Field
summary: <p>The query returns column information only. When using <xref uid="com.microsoft.azure.elasticdb.query.logging._command_behavior.SchemaOnly" data-throw-if-not-resolved="false">CommandBehavior.SchemaOnly</xref>, the .NET Framework Data Provider for SQL Server precedes the statement being executed with SET FMTONLY ON. </p>
syntax: *o3

Просмотреть файл

@ -0,0 +1,185 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options
id: _multi_shard_execution_options
parent: com.microsoft.azure.elasticdb.query.logging
children:
- com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.forValue(int)
- com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.getValue()
- com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.IncludeShardNameColumn
- com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.MultiShardExecutionOptions(int)
- com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.None
- com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.SIZE
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.yml
langs:
- java
name: MultiShardExecutionOptions
nameWithType: MultiShardExecutionOptions
fullName: com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionOptions
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionOptions.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionOptions.java
startLine: 13
package: com.microsoft.azure.elasticdb.query.logging
summary: <p>Defines the available options when executing commands against multiple shards. This enumeration has a flags attribute. </p>
syntax: &o1
content: public enum MultiShardExecutionOptions
inheritance:
- java.lang.Object
- java.lang.Enum<MultiShardExecutionOptions>
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.yml
langs:
- java
name: forValue(int value)
nameWithType: MultiShardExecutionOptions.forValue(int value)
fullName: static MultiShardExecutionOptions com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionOptions.forValue(int value)
overload: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionOptions.java
startLine: 44
package: com.microsoft.azure.elasticdb.query.logging
syntax:
content: public static MultiShardExecutionOptions forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.yml
langs:
- java
name: getValue()
nameWithType: MultiShardExecutionOptions.getValue()
fullName: int com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionOptions.getValue()
overload: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionOptions.java
startLine: 48
package: com.microsoft.azure.elasticdb.query.logging
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.IncludeShardNameColumn
id: IncludeShardNameColumn
parent: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.yml
langs:
- java
name: IncludeShardNameColumn
nameWithType: MultiShardExecutionOptions.IncludeShardNameColumn
fullName: com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionOptions.IncludeShardNameColumn
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionOptions.java
startLine: 22
package: com.microsoft.azure.elasticdb.query.logging
summary: <p>Whether the $ShardName pseudo column should be included in the result-sets. </p>
syntax:
content: public IncludeShardNameColumn=(1)
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.MultiShardExecutionOptions(int)
id: MultiShardExecutionOptions(int)
parent: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.yml
langs:
- java
name: MultiShardExecutionOptions(int value)
nameWithType: MultiShardExecutionOptions.MultiShardExecutionOptions(int value)
fullName: com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionOptions.MultiShardExecutionOptions(int value)
overload: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.MultiShardExecutionOptions*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionOptions.java
startLine: 28
package: com.microsoft.azure.elasticdb.query.logging
syntax:
content: public MultiShardExecutionOptions(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.None
id: None
parent: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.yml
langs:
- java
name: None
nameWithType: MultiShardExecutionOptions.None
fullName: com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionOptions.None
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionOptions.java
startLine: 17
package: com.microsoft.azure.elasticdb.query.logging
summary: <p>, Execute without any options enabled. </p>
syntax:
content: public None=(0)
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.yml
langs:
- java
name: SIZE
nameWithType: MultiShardExecutionOptions.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionOptions.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionOptions.java
startLine: 24
package: com.microsoft.azure.elasticdb.query.logging
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.MultiShardExecutionOptions*
name: MultiShardExecutionOptions
nameWithType: MultiShardExecutionOptions.MultiShardExecutionOptions
fullName: com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionOptions.MultiShardExecutionOptions
package: com.microsoft.azure.elasticdb.query.logging
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.getValue*
name: getValue
nameWithType: MultiShardExecutionOptions.getValue
fullName: int com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionOptions.getValue
package: com.microsoft.azure.elasticdb.query.logging
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.forValue*
name: forValue
nameWithType: MultiShardExecutionOptions.forValue
fullName: static MultiShardExecutionOptions com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionOptions.forValue
package: com.microsoft.azure.elasticdb.query.logging
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options
parent: com.microsoft.azure.elasticdb.query.logging
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.yml
name: MultiShardExecutionOptions
nameWithType: MultiShardExecutionOptions
fullName: com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionOptions
type: Enum
summary: <p>Defines the available options when executing commands against multiple shards. This enumeration has a flags attribute. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,185 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy
id: _multi_shard_execution_policy
parent: com.microsoft.azure.elasticdb.query.logging
children:
- com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.CompleteResults
- com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.forValue(int)
- com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.getValue()
- com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.MultiShardExecutionPolicy(int)
- com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.PartialResults
- com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.SIZE
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.yml
langs:
- java
name: MultiShardExecutionPolicy
nameWithType: MultiShardExecutionPolicy
fullName: com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionPolicy
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionPolicy.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionPolicy.java
startLine: 14
package: com.microsoft.azure.elasticdb.query.logging
summary: '<p>Defines the possible query execution policies. Purpose: Defines the possible query execution policies Suppression rationale: "Multi" is the spelling we want here. </p>'
syntax: &o1
content: public enum MultiShardExecutionPolicy
inheritance:
- java.lang.Object
- java.lang.Enum<MultiShardExecutionPolicy>
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.CompleteResults
id: CompleteResults
parent: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.yml
langs:
- java
name: CompleteResults
nameWithType: MultiShardExecutionPolicy.CompleteResults
fullName: com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionPolicy.CompleteResults
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionPolicy.java
startLine: 19
package: com.microsoft.azure.elasticdb.query.logging
summary: <p>With the complete results execution policy an unsuccessful execution against any shard leads to all results being discarded and an exception being thrown either by the ExecuteReader method on the command or the Read method on the reader. </p>
syntax:
content: public CompleteResults=(0)
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.yml
langs:
- java
name: forValue(int value)
nameWithType: MultiShardExecutionPolicy.forValue(int value)
fullName: static MultiShardExecutionPolicy com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionPolicy.forValue(int value)
overload: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionPolicy.java
startLine: 48
package: com.microsoft.azure.elasticdb.query.logging
syntax:
content: public static MultiShardExecutionPolicy forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.yml
langs:
- java
name: getValue()
nameWithType: MultiShardExecutionPolicy.getValue()
fullName: int com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionPolicy.getValue()
overload: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionPolicy.java
startLine: 52
package: com.microsoft.azure.elasticdb.query.logging
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.MultiShardExecutionPolicy(int)
id: MultiShardExecutionPolicy(int)
parent: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.yml
langs:
- java
name: MultiShardExecutionPolicy(int value)
nameWithType: MultiShardExecutionPolicy.MultiShardExecutionPolicy(int value)
fullName: com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionPolicy.MultiShardExecutionPolicy(int value)
overload: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.MultiShardExecutionPolicy*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionPolicy.java
startLine: 32
package: com.microsoft.azure.elasticdb.query.logging
syntax:
content: public MultiShardExecutionPolicy(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.PartialResults
id: PartialResults
parent: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.yml
langs:
- java
name: PartialResults
nameWithType: MultiShardExecutionPolicy.PartialResults
fullName: com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionPolicy.PartialResults
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionPolicy.java
startLine: 26
package: com.microsoft.azure.elasticdb.query.logging
summary: <p>A best-effort execution policy that, unlike CompleteResults, tolerates unsuccessful command execution on some (but not all) shards and returns the results of the successful commands. Any errors encountered are returned to the user along with the partial results. The caller can inspect exceptions encountered during execution through the MultiShardAggregateException property of MultiShardResultSet. </p>
syntax:
content: public PartialResults=(1)
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.yml
langs:
- java
name: SIZE
nameWithType: MultiShardExecutionPolicy.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionPolicy.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/MultiShardExecutionPolicy.java
startLine: 28
package: com.microsoft.azure.elasticdb.query.logging
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.MultiShardExecutionPolicy*
name: MultiShardExecutionPolicy
nameWithType: MultiShardExecutionPolicy.MultiShardExecutionPolicy
fullName: com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionPolicy.MultiShardExecutionPolicy
package: com.microsoft.azure.elasticdb.query.logging
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.getValue*
name: getValue
nameWithType: MultiShardExecutionPolicy.getValue
fullName: int com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionPolicy.getValue
package: com.microsoft.azure.elasticdb.query.logging
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.forValue*
name: forValue
nameWithType: MultiShardExecutionPolicy.forValue
fullName: static MultiShardExecutionPolicy com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionPolicy.forValue
package: com.microsoft.azure.elasticdb.query.logging
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy
parent: com.microsoft.azure.elasticdb.query.logging
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.yml
name: MultiShardExecutionPolicy
nameWithType: MultiShardExecutionPolicy
fullName: com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionPolicy
type: Enum
summary: '<p>Defines the possible query execution policies. Purpose: Defines the possible query execution policies Suppression rationale: "Multi" is the spelling we want here. </p>'
syntax: *o1

Просмотреть файл

@ -0,0 +1,54 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.logging
id: logging
children:
- com.microsoft.azure.elasticdb.query.logging._command_behavior
- com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options
- com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy
href: com.microsoft.azure.elasticdb.query.logging.yml
langs:
- java
name: com.microsoft.azure.elasticdb.query.logging
nameWithType: com.microsoft.azure.elasticdb.query.logging
fullName: com.microsoft.azure.elasticdb.query.logging
type: Namespace
source:
remote:
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/CommandBehavior.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/logging/CommandBehavior.java
syntax:
content: package com.microsoft.azure.elasticdb.query.logging
references:
- uid: com.microsoft.azure.elasticdb.query.logging._command_behavior
parent: com.microsoft.azure.elasticdb.query.logging
href: com.microsoft.azure.elasticdb.query.logging._command_behavior.yml
name: CommandBehavior
nameWithType: CommandBehavior
fullName: com.microsoft.azure.elasticdb.query.logging.CommandBehavior
type: Enum
summary: '<p>Summary: Provides a description of the results of the query and its effect on the database. </p>'
syntax:
content: public enum CommandBehavior
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options
parent: com.microsoft.azure.elasticdb.query.logging
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_options.yml
name: MultiShardExecutionOptions
nameWithType: MultiShardExecutionOptions
fullName: com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionOptions
type: Enum
summary: <p>Defines the available options when executing commands against multiple shards. This enumeration has a flags attribute. </p>
syntax:
content: public enum MultiShardExecutionOptions
- uid: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy
parent: com.microsoft.azure.elasticdb.query.logging
href: com.microsoft.azure.elasticdb.query.logging._multi_shard_execution_policy.yml
name: MultiShardExecutionPolicy
nameWithType: MultiShardExecutionPolicy
fullName: com.microsoft.azure.elasticdb.query.logging.MultiShardExecutionPolicy
type: Enum
summary: '<p>Defines the possible query execution policies. Purpose: Defines the possible query execution policies Suppression rationale: "Multi" is the spelling we want here. </p>'
syntax:
content: public enum MultiShardExecutionPolicy

Просмотреть файл

@ -0,0 +1,51 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.multishard._global_constants
id: _global_constants
parent: com.microsoft.azure.elasticdb.query.multishard
children:
- com.microsoft.azure.elasticdb.query.multishard._global_constants.MultiShardQueryVersionInfo
href: com.microsoft.azure.elasticdb.query.multishard._global_constants.yml
langs:
- java
name: GlobalConstants
nameWithType: GlobalConstants
fullName: com.microsoft.azure.elasticdb.query.multishard.GlobalConstants
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/GlobalConstants.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/GlobalConstants.java
startLine: 10
package: com.microsoft.azure.elasticdb.query.multishard
syntax:
content: public class GlobalConstants
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.query.multishard._global_constants.MultiShardQueryVersionInfo
id: MultiShardQueryVersionInfo
parent: com.microsoft.azure.elasticdb.query.multishard._global_constants
href: com.microsoft.azure.elasticdb.query.multishard._global_constants.yml
langs:
- java
name: MultiShardQueryVersionInfo
nameWithType: GlobalConstants.MultiShardQueryVersionInfo
fullName: String com.microsoft.azure.elasticdb.query.multishard.GlobalConstants.MultiShardQueryVersionInfo
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/GlobalConstants.java
startLine: 15
package: com.microsoft.azure.elasticdb.query.multishard
summary: <p>Version information for Microsoft.Azure.SqlDatabase.ElasticScale.Query code. </p>
syntax:
content: public static String MultiShardQueryVersionInfo= "1.0.0.0"
return:
type: "26831127"
references:
- uid: "26831127"
spec.java:
- name: String
fullName: String

Просмотреть файл

@ -0,0 +1,430 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
id: _labeled_result_set
parent: com.microsoft.azure.elasticdb.query.multishard
children:
- com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.close()
- com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getConnection()
- com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getException()
- com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getResultSet()
- com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getShardLabel()
- com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getShardLocation()
- com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getStatement()
- com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.LabeledResultSet(MultiShardException,ShardLocation,Statement)
- com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.LabeledResultSet(ResultSet,ShardLocation,Statement)
- com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.LabeledResultSet(ShardLocation,Statement)
- com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.setShardLabel(String)
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
langs:
- java
name: LabeledResultSet
nameWithType: LabeledResultSet
fullName: com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/LabeledResultSet.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/LabeledResultSet.java
startLine: 24
package: com.microsoft.azure.elasticdb.query.multishard
summary: '<p>Simple, immutable class for affiliating a ResultSet with additional information related to the reader (e.g. Statement, shard, exceptions encountered etc) Useful when grabbing ResultSets asynchronously. Purpose: Convenience class that holds a ResultSet along with a string label for the shard that the data underlying the ResultSet came from. Notes: This is useful for keeping the ResultSet and the label together when executing asynchronously. </p>'
syntax: &o1
content: public class LabeledResultSet
inheritance:
- java.lang.Object
- AutoCloseable
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.close()
id: close()
parent: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
langs:
- java
name: close()
nameWithType: LabeledResultSet.close()
fullName: final void com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.close()
overload: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.close*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/LabeledResultSet.java
startLine: 157
package: com.microsoft.azure.elasticdb.query.multishard
summary: <p>AutoClosable Implementation. </p>
syntax:
content: public final void close()
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getConnection()
id: getConnection()
parent: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
langs:
- java
name: getConnection()
nameWithType: LabeledResultSet.getConnection()
fullName: final Connection com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.getConnection()
overload: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getConnection*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/LabeledResultSet.java
startLine: 146
package: com.microsoft.azure.elasticdb.query.multishard
summary: <p>The Connection associated with this reader. </p>
syntax:
content: public final Connection getConnection()
return:
type: a327c162
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getException()
id: getException()
parent: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
langs:
- java
name: getException()
nameWithType: LabeledResultSet.getException()
fullName: final MultiShardException com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.getException()
overload: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getException*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/LabeledResultSet.java
startLine: 135
package: com.microsoft.azure.elasticdb.query.multishard
syntax:
content: public final MultiShardException getException()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getResultSet()
id: getResultSet()
parent: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
langs:
- java
name: getResultSet()
nameWithType: LabeledResultSet.getResultSet()
fullName: final ResultSet com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.getResultSet()
overload: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getResultSet*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/LabeledResultSet.java
startLine: 139
package: com.microsoft.azure.elasticdb.query.multishard
syntax:
content: public final ResultSet getResultSet()
return:
type: 11dc1d3a
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getShardLabel()
id: getShardLabel()
parent: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
langs:
- java
name: getShardLabel()
nameWithType: LabeledResultSet.getShardLabel()
fullName: final String com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.getShardLabel()
overload: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getShardLabel*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/LabeledResultSet.java
startLine: 127
package: com.microsoft.azure.elasticdb.query.multishard
syntax:
content: public final String getShardLabel()
return:
type: 3d93591e
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getShardLocation()
id: getShardLocation()
parent: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
langs:
- java
name: getShardLocation()
nameWithType: LabeledResultSet.getShardLocation()
fullName: final ShardLocation com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.getShardLocation()
overload: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getShardLocation*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/LabeledResultSet.java
startLine: 123
package: com.microsoft.azure.elasticdb.query.multishard
syntax:
content: public final ShardLocation getShardLocation()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.base._shard_location
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getStatement()
id: getStatement()
parent: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
langs:
- java
name: getStatement()
nameWithType: LabeledResultSet.getStatement()
fullName: final Statement com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.getStatement()
overload: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getStatement*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/LabeledResultSet.java
startLine: 150
package: com.microsoft.azure.elasticdb.query.multishard
syntax:
content: public final Statement getStatement()
return:
type: 054ea17a
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.LabeledResultSet(MultiShardException,ShardLocation,Statement)
id: LabeledResultSet(MultiShardException,ShardLocation,Statement)
parent: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
langs:
- java
name: LabeledResultSet(MultiShardException exception, ShardLocation shardLocation, Statement statement)
nameWithType: LabeledResultSet.LabeledResultSet(MultiShardException exception, ShardLocation shardLocation, Statement statement)
fullName: com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.LabeledResultSet(MultiShardException exception, ShardLocation shardLocation, Statement statement)
overload: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.LabeledResultSet*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/LabeledResultSet.java
startLine: 88
package: com.microsoft.azure.elasticdb.query.multishard
summary: >-
<p>Simple constructor to set up an immutable <xref uid="com.microsoft.azure.elasticdb.query.multishard._labeled_result_set" data-throw-if-not-resolved="false">LabeledResultSet</xref> object.</p>
<p></p>
syntax:
content: public LabeledResultSet(MultiShardException exception, ShardLocation shardLocation, Statement statement)
parameters:
- id: exception
type: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>The Shard this reader belongs to </p>
- id: statement
type: 9efdf62a
description: <p>The statement object that produced the reader. </p>
exceptions:
- type: 3c87bd19
description: <p>If either of the arguments is null. </p>
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.LabeledResultSet(ResultSet,ShardLocation,Statement)
id: LabeledResultSet(ResultSet,ShardLocation,Statement)
parent: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
langs:
- java
name: LabeledResultSet(ResultSet resultSet, ShardLocation shardLocation, Statement statement)
nameWithType: LabeledResultSet.LabeledResultSet(ResultSet resultSet, ShardLocation shardLocation, Statement statement)
fullName: com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.LabeledResultSet(ResultSet resultSet, ShardLocation shardLocation, Statement statement)
overload: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.LabeledResultSet*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/LabeledResultSet.java
startLine: 67
package: com.microsoft.azure.elasticdb.query.multishard
summary: >-
<p>Simple constructor to set up an immutable <xref uid="com.microsoft.azure.elasticdb.query.multishard._labeled_result_set" data-throw-if-not-resolved="false">LabeledResultSet</xref> object.</p>
<p></p>
syntax:
content: public LabeledResultSet(ResultSet resultSet, ShardLocation shardLocation, Statement statement)
parameters:
- id: resultSet
type: af343675
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>The Shard this reader belongs to </p>
- id: statement
type: 9efdf62a
description: <p>The statement object that produced the reader. </p>
exceptions:
- type: 3c87bd19
description: <p>If either of the arguments is null. </p>
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.LabeledResultSet(ShardLocation,Statement)
id: LabeledResultSet(ShardLocation,Statement)
parent: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
langs:
- java
name: LabeledResultSet(ShardLocation shardLocation, Statement statement)
nameWithType: LabeledResultSet.LabeledResultSet(ShardLocation shardLocation, Statement statement)
fullName: com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.LabeledResultSet(ShardLocation shardLocation, Statement statement)
overload: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.LabeledResultSet*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/LabeledResultSet.java
startLine: 109
package: com.microsoft.azure.elasticdb.query.multishard
summary: >-
<p>Simple constructor to set up an immutable <xref uid="com.microsoft.azure.elasticdb.query.multishard._labeled_result_set" data-throw-if-not-resolved="false">LabeledResultSet</xref> object.</p>
<p></p>
syntax:
content: public LabeledResultSet(ShardLocation shardLocation, Statement statement)
parameters:
- id: shardLocation
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>The Shard this reader belongs to </p>
- id: statement
type: 9efdf62a
description: <p>The statement object that produced the reader. </p>
exceptions:
- type: 3c87bd19
description: <p>If either of the arguments is null. </p>
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.setShardLabel(String)
id: setShardLabel(String)
parent: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
langs:
- java
name: setShardLabel(String value)
nameWithType: LabeledResultSet.setShardLabel(String value)
fullName: final void com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.setShardLabel(String value)
overload: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.setShardLabel*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/LabeledResultSet.java
startLine: 131
package: com.microsoft.azure.elasticdb.query.multishard
syntax:
content: public final void setShardLabel(String value)
parameters:
- id: value
type: "26831127"
return:
type: 3f6357ce
references:
- uid: 3c87bd19
spec.java:
- name: IllegalArgumentException
fullName: IllegalArgumentException
- uid: af343675
spec.java:
- name: ResultSet
fullName: ResultSet
- uid: 9efdf62a
spec.java:
- name: Statement
fullName: Statement
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.LabeledResultSet*
name: LabeledResultSet
nameWithType: LabeledResultSet.LabeledResultSet
fullName: com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.LabeledResultSet
package: com.microsoft.azure.elasticdb.query.multishard
- uid: 93de0ef9com.microsoft.azure.elasticdb.shard.base._shard_location
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
name: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getShardLocation*
name: getShardLocation
nameWithType: LabeledResultSet.getShardLocation
fullName: final ShardLocation com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.getShardLocation
package: com.microsoft.azure.elasticdb.query.multishard
- uid: 3d93591e
spec.java:
- name: final String
fullName: final String
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getShardLabel*
name: getShardLabel
nameWithType: LabeledResultSet.getShardLabel
fullName: final String com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.getShardLabel
package: com.microsoft.azure.elasticdb.query.multishard
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: 3f6357ce
spec.java:
- name: final void
fullName: final void
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.setShardLabel*
name: setShardLabel
nameWithType: LabeledResultSet.setShardLabel
fullName: final void com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.setShardLabel
package: com.microsoft.azure.elasticdb.query.multishard
- uid: 93de0ef9com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
name: MultiShardException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getException*
name: getException
nameWithType: LabeledResultSet.getException
fullName: final MultiShardException com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.getException
package: com.microsoft.azure.elasticdb.query.multishard
- uid: 11dc1d3a
spec.java:
- name: final ResultSet
fullName: final ResultSet
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getResultSet*
name: getResultSet
nameWithType: LabeledResultSet.getResultSet
fullName: final ResultSet com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.getResultSet
package: com.microsoft.azure.elasticdb.query.multishard
- uid: a327c162
spec.java:
- name: final Connection
fullName: final Connection
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getConnection*
name: getConnection
nameWithType: LabeledResultSet.getConnection
fullName: final Connection com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.getConnection
package: com.microsoft.azure.elasticdb.query.multishard
- uid: 054ea17a
spec.java:
- name: final Statement
fullName: final Statement
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.getStatement*
name: getStatement
nameWithType: LabeledResultSet.getStatement
fullName: final Statement com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.getStatement
package: com.microsoft.azure.elasticdb.query.multishard
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.close*
name: close
nameWithType: LabeledResultSet.close
fullName: final void com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet.close
package: com.microsoft.azure.elasticdb.query.multishard
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
name: ShardLocation
nameWithType: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
type: Class
summary: <p>Represents the location of a shard in terms of its server name and database name. This is used to manage connections to the shard and to support other operations on shards. As opposed to a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>, a shard location is not registered with the shard map. </p>
syntax:
content: public class ShardLocation
- uid: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception
parent: com.microsoft.azure.elasticdb.query.exception
href: com.microsoft.azure.elasticdb.query.exception._multi_shard_exception.yml
name: MultiShardException
nameWithType: MultiShardException
fullName: com.microsoft.azure.elasticdb.query.exception.MultiShardException
type: Class
summary: "<p>DEVNOTE: Encapsulate SMM ShardLocation type for now since Shard isn't Serializable Support for serialization of ShardLocation is in the works. A <xref uid=\"com.microsoft.azure.elasticdb.query.exception._multi_shard_exception\" data-throw-if-not-resolved=\"false\">MultiShardException</xref> represents an exception that occurred when performing operations against a shard. It provides information about both the identity of the shard and the exception that occurred. Depending on the nature of the exception, one can try re-running the multi-shard query, execute a separate query targeted directly at the shard(s) on that yielded the exception, or lastly execute the query manually against the shard using a common tool such as SSMS. </p>"
syntax:
content: public class MultiShardException
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
parent: com.microsoft.azure.elasticdb.query.multishard
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
name: LabeledResultSet
nameWithType: LabeledResultSet
fullName: com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet
type: Class
summary: '<p>Simple, immutable class for affiliating a ResultSet with additional information related to the reader (e.g. Statement, shard, exceptions encountered etc) Useful when grabbing ResultSets asynchronously. Purpose: Convenience class that holds a ResultSet along with a string label for the shard that the data underlying the ResultSet came from. Notes: This is useful for keeping the ResultSet and the label together when executing asynchronously. </p>'
syntax: *o1

Просмотреть файл

@ -0,0 +1,464 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
id: _multi_shard_connection
parent: com.microsoft.azure.elasticdb.query.multishard
children:
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.ApplicationNameSuffix
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.close()
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.closeOpenConnections()
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.createCommand()
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getConnectionString()
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getShardConnections()
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getShardLocations()
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getShards()
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.isClosed()
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.MultiShardConnection(ArrayList<Pair<ShardLocation, Connection>>)
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.MultiShardConnection(String,Shard...)
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.MultiShardConnection(String,ShardLocation...)
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.yml
langs:
- java
name: MultiShardConnection
nameWithType: MultiShardConnection
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardConnection.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardConnection.java
startLine: 34
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>'
syntax: &o1
content: public class MultiShardConnection
inheritance:
- java.lang.Object
- AutoCloseable
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.ApplicationNameSuffix
id: ApplicationNameSuffix
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.yml
langs:
- java
name: ApplicationNameSuffix
nameWithType: MultiShardConnection.ApplicationNameSuffix
fullName: String com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.ApplicationNameSuffix
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardConnection.java
startLine: 41
package: com.microsoft.azure.elasticdb.query.multishard
summary: <p>The suffix to append to each shard's ApplicationName. Will help with server-side telemetry. </p>
syntax:
content: public static String ApplicationNameSuffix= "ESC_MSQv" + GlobalConstants.MultiShardQueryVersionInfo
return:
type: "26831127"
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.close()
id: close()
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.yml
langs:
- java
name: close()
nameWithType: MultiShardConnection.close()
fullName: void com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.close()
overload: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.close*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardConnection.java
startLine: 225
package: com.microsoft.azure.elasticdb.query.multishard
summary: <p>Releases all resources used by this object. </p>
syntax:
content: public void close()
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.closeOpenConnections()
id: closeOpenConnections()
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.yml
langs:
- java
name: closeOpenConnections()
nameWithType: MultiShardConnection.closeOpenConnections()
fullName: void com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.closeOpenConnections()
overload: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.closeOpenConnections*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardConnection.java
startLine: 248
package: com.microsoft.azure.elasticdb.query.multishard
summary: <p>Closes any open connections to shards. Does a best-effort close and doesn't throw. </p>
syntax:
content: public void closeOpenConnections()
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.createCommand()
id: createCommand()
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.yml
langs:
- java
name: createCommand()
nameWithType: MultiShardConnection.createCommand()
fullName: MultiShardStatement com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.createCommand()
overload: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.createCommand*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardConnection.java
startLine: 218
package: com.microsoft.azure.elasticdb.query.multishard
summary: >-
<p>Creates and returns a <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement" data-throw-if-not-resolved="false">MultiShardStatement</xref> object. The <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement" data-throw-if-not-resolved="false">MultiShardStatement</xref> object can then be used to execute a command against all shards specified in the connection.</p>
<p></p>
syntax:
content: public MultiShardStatement createCommand()
return:
type: com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement
description: <p>the <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement" data-throw-if-not-resolved="false">MultiShardStatement</xref> with CommandText set to null. </p>
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getConnectionString()
id: getConnectionString()
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.yml
langs:
- java
name: getConnectionString()
nameWithType: MultiShardConnection.getConnectionString()
fullName: String com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getConnectionString()
overload: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getConnectionString*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardConnection.java
startLine: 208
package: com.microsoft.azure.elasticdb.query.multishard
summary: <p>Gets the connection string associated with this connection. </p>
syntax:
content: public String getConnectionString()
return:
type: "26831127"
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getShardConnections()
id: getShardConnections()
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.yml
langs:
- java
name: getShardConnections()
nameWithType: MultiShardConnection.getShardConnections()
fullName: List<Pair<ShardLocation, Connection>> com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getShardConnections()
overload: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getShardConnections*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardConnection.java
startLine: 201
package: com.microsoft.azure.elasticdb.query.multishard
summary: <p>Gets the collection of ShardLocations and Connections associated with this connection. </p>
syntax:
content: public List<Pair<ShardLocation, Connection>> getShardConnections()
return:
type: 9d0a8d03com.microsoft.azure.elasticdb.shard.base._shard_locationab796af5
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getShardLocations()
id: getShardLocations()
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.yml
langs:
- java
name: getShardLocations()
nameWithType: MultiShardConnection.getShardLocations()
fullName: List<ShardLocation> com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getShardLocations()
overload: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getShardLocations*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardConnection.java
startLine: 194
package: com.microsoft.azure.elasticdb.query.multishard
summary: <p>Gets the collection of ShardLocations associated with this connection. </p>
syntax:
content: public List<ShardLocation> getShardLocations()
return:
type: 5618da2dcom.microsoft.azure.elasticdb.shard.base._shard_locationa08ddfce
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getShards()
id: getShards()
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.yml
langs:
- java
name: getShards()
nameWithType: MultiShardConnection.getShards()
fullName: List<Shard> com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getShards()
overload: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getShards*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardConnection.java
startLine: 187
package: com.microsoft.azure.elasticdb.query.multishard
summary: <p>Gets the collection of Shards associated with this connection. </p>
syntax:
content: public List<Shard> getShards()
return:
type: 5618da2dcom.microsoft.azure.elasticdb.shard.base._sharda08ddfce
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.isClosed()
id: isClosed()
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.yml
langs:
- java
name: isClosed()
nameWithType: MultiShardConnection.isClosed()
fullName: boolean com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.isClosed()
overload: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.isClosed*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardConnection.java
startLine: 266
package: com.microsoft.azure.elasticdb.query.multishard
summary: >-
<p>Check if connection is closed or not.</p>
<p></p>
syntax:
content: public boolean isClosed()
return:
type: 4fc6e284
description: <p>true if open, false if closed. </p>
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.MultiShardConnection(ArrayList<Pair<ShardLocation, Connection>>)
id: MultiShardConnection(ArrayList<Pair<ShardLocation, Connection>>)
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.yml
langs:
- java
name: MultiShardConnection(ArrayList<Pair<ShardLocation, Connection>> shardConnections)
nameWithType: MultiShardConnection.MultiShardConnection(ArrayList<Pair<ShardLocation, Connection>> shardConnections)
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.MultiShardConnection(ArrayList<Pair<ShardLocation, Connection>> shardConnections)
overload: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.MultiShardConnection*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardConnection.java
startLine: 141
package: com.microsoft.azure.elasticdb.query.multishard
summary: >-
<p>Creates an instance of this class. TEST ONLY</p>
<p></p>
syntax:
content: public MultiShardConnection(ArrayList<Pair<ShardLocation, Connection>> shardConnections)
parameters:
- id: shardConnections
type: fd6186a7com.microsoft.azure.elasticdb.shard.base._shard_locationab796af5
description: <p>Connections to the shards </p>
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.MultiShardConnection(String,Shard...)
id: )
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.yml
langs:
- java
name: MultiShardConnection(String connectionString, Shard... shards)
nameWithType: MultiShardConnection.MultiShardConnection(String connectionString, Shard... shards)
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.MultiShardConnection(String connectionString, Shard... shards)
overload: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.MultiShardConnection*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardConnection.java
startLine: 69
package: com.microsoft.azure.elasticdb.query.multishard
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection" data-throw-if-not-resolved="false">MultiShardConnection</xref> class.</p>
<p>
<verbatim> Multiple Active Result Sets (MARS) are not supported and are disabled for any processing at the shards.</verbatim>
</p>
syntax:
content: public MultiShardConnection(String connectionString, Shard... shards)
parameters:
- id: connectionString
type: "26831127"
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>
- id: shards
type: e4c77887
description: <p>The collection of Shards used for this connection instances.</p>
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.MultiShardConnection(String,ShardLocation...)
id: )
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.yml
langs:
- java
name: MultiShardConnection(String connectionString, ShardLocation... shardLocations)
nameWithType: MultiShardConnection.MultiShardConnection(String connectionString, ShardLocation... shardLocations)
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.MultiShardConnection(String connectionString, ShardLocation... shardLocations)
overload: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.MultiShardConnection*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardConnection.java
startLine: 107
package: com.microsoft.azure.elasticdb.query.multishard
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection" data-throw-if-not-resolved="false">MultiShardConnection</xref> class.</p>
<p>
<verbatim> Multiple Active Result Sets (MARS) are not supported and are disabled for any processing at the shards.</verbatim>
</p>
syntax:
content: public MultiShardConnection(String connectionString, ShardLocation... shardLocations)
parameters:
- id: connectionString
type: "26831127"
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>
- id: shardLocations
type: c7c96d33
description: <p>The collection of ShardLocations used for this connection instances. </p>
references:
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: e4c77887
spec.java:
- name: Shard...
fullName: Shard...
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.MultiShardConnection*
name: MultiShardConnection
nameWithType: MultiShardConnection.MultiShardConnection
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.MultiShardConnection
package: com.microsoft.azure.elasticdb.query.multishard
- uid: c7c96d33
spec.java:
- name: ShardLocation...
fullName: ShardLocation...
- uid: fd6186a7com.microsoft.azure.elasticdb.shard.base._shard_locationab796af5
spec.java:
- name: ArrayList<Pair<
fullName: ArrayList<Pair<
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
name: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
- name: ', Connection>>'
fullName: ', Connection>>'
- uid: 5618da2dcom.microsoft.azure.elasticdb.shard.base._sharda08ddfce
spec.java:
- name: List<
fullName: List<
- uid: com.microsoft.azure.elasticdb.shard.base._shard
name: Shard
fullName: com.microsoft.azure.elasticdb.shard.base.Shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getShards*
name: getShards
nameWithType: MultiShardConnection.getShards
fullName: List<Shard> com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getShards
package: com.microsoft.azure.elasticdb.query.multishard
- uid: 5618da2dcom.microsoft.azure.elasticdb.shard.base._shard_locationa08ddfce
spec.java:
- name: List<
fullName: List<
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
name: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getShardLocations*
name: getShardLocations
nameWithType: MultiShardConnection.getShardLocations
fullName: List<ShardLocation> com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getShardLocations
package: com.microsoft.azure.elasticdb.query.multishard
- uid: 9d0a8d03com.microsoft.azure.elasticdb.shard.base._shard_locationab796af5
spec.java:
- name: List<Pair<
fullName: List<Pair<
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
name: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
- name: ', Connection>>'
fullName: ', Connection>>'
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getShardConnections*
name: getShardConnections
nameWithType: MultiShardConnection.getShardConnections
fullName: List<Pair<ShardLocation, Connection>> com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getShardConnections
package: com.microsoft.azure.elasticdb.query.multishard
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.getConnectionString*
name: getConnectionString
nameWithType: MultiShardConnection.getConnectionString
fullName: String com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.getConnectionString
package: com.microsoft.azure.elasticdb.query.multishard
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.createCommand*
name: createCommand
nameWithType: MultiShardConnection.createCommand
fullName: MultiShardStatement com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.createCommand
package: com.microsoft.azure.elasticdb.query.multishard
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.close*
name: close
nameWithType: MultiShardConnection.close
fullName: void com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.close
package: com.microsoft.azure.elasticdb.query.multishard
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.closeOpenConnections*
name: closeOpenConnections
nameWithType: MultiShardConnection.closeOpenConnections
fullName: void com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.closeOpenConnections
package: com.microsoft.azure.elasticdb.query.multishard
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.isClosed*
name: isClosed
nameWithType: MultiShardConnection.isClosed
fullName: boolean com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection.isClosed
package: com.microsoft.azure.elasticdb.query.multishard
- 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._shard_location
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
name: ShardLocation
nameWithType: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
type: Class
summary: <p>Represents the location of a shard in terms of its server name and database name. This is used to manage connections to the shard and to support other operations on shards. As opposed to a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>, a shard location is not registered with the shard map. </p>
syntax:
content: public class ShardLocation
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
parent: com.microsoft.azure.elasticdb.query.multishard
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.yml
name: MultiShardConnection
nameWithType: MultiShardConnection
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection
type: Class
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>'
syntax: *o1
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement
parent: com.microsoft.azure.elasticdb.query.multishard
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement.yml
name: MultiShardStatement
nameWithType: MultiShardStatement
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardStatement
type: Class
summary: '<p>Complements the <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection" data-throw-if-not-resolved="false">MultiShardConnection</xref> with a command object similar to the triad of Connection, Statement, and ResultSet. The <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement" data-throw-if-not-resolved="false">MultiShardStatement</xref> takes a T-SQL command statement as its input and executes the command across its collection of shards specified by its corresponding <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection" data-throw-if-not-resolved="false">MultiShardConnection</xref>. The results from processing the <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement" data-throw-if-not-resolved="false">MultiShardStatement</xref> are made available through the execute methods and the <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_result_set" data-throw-if-not-resolved="false">MultiShardResultSet</xref>. Purpose: Complements the <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection" data-throw-if-not-resolved="false">MultiShardConnection</xref> and abstracts away the work of running a given command against multiple shards Notes: This class is NOT thread-safe. Since the Sync API internally invokes the async API, connections to shards with connection string property "context connection = true" are not supported. Transaction semantics are not supported. </p>'
syntax:
content: public class MultiShardStatement

Просмотреть файл

@ -0,0 +1,154 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy
id: _multi_shard_query_transient_error_detection_strategy
parent: com.microsoft.azure.elasticdb.query.multishard
children:
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy.isTransient(Exception)
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy.MultiShardQueryTransientErrorDetectionStrategy(RetryBehavior)
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy.yml
langs:
- java
name: MultiShardQueryTransientErrorDetectionStrategy
nameWithType: MultiShardQueryTransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardQueryTransientErrorDetectionStrategy
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardQueryTransientErrorDetectionStrategy.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardQueryTransientErrorDetectionStrategy.java
startLine: 19
package: com.microsoft.azure.elasticdb.query.multishard
summary: <p>Provides the transient error detection logic for transient faults that are specific to cross shard query. </p>
syntax:
content: public class MultiShardQueryTransientErrorDetectionStrategy implements ITransientErrorDetectionStrategy
inheritance:
- java.lang.Object
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy.isTransient(Exception)
id: isTransient(Exception)
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy.yml
langs:
- java
name: isTransient(Exception ex)
nameWithType: MultiShardQueryTransientErrorDetectionStrategy.isTransient(Exception ex)
fullName: boolean com.microsoft.azure.elasticdb.query.multishard.MultiShardQueryTransientErrorDetectionStrategy.isTransient(Exception ex)
overload: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy.isTransient*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardQueryTransientErrorDetectionStrategy.java
startLine: 50
package: com.microsoft.azure.elasticdb.query.multishard
summary: >-
<p>Determines whether the specified exception represents a transient failure that can be compensated by a retry.</p>
<p></p>
syntax:
content: public boolean isTransient(Exception ex)
parameters:
- id: ex
type: 8a99d4b0
description: <p>The exception object to be verified. </p>
return:
type: 4fc6e284
description: <p>true if the specified exception is considered as transient; otherwise, false. </p>
overridden: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.isTransient(Exception)
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy.MultiShardQueryTransientErrorDetectionStrategy(RetryBehavior)
id: MultiShardQueryTransientErrorDetectionStrategy(RetryBehavior)
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy.yml
langs:
- java
name: MultiShardQueryTransientErrorDetectionStrategy(RetryBehavior retryBehavior)
nameWithType: MultiShardQueryTransientErrorDetectionStrategy.MultiShardQueryTransientErrorDetectionStrategy(RetryBehavior retryBehavior)
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardQueryTransientErrorDetectionStrategy.MultiShardQueryTransientErrorDetectionStrategy(RetryBehavior retryBehavior)
overload: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy.MultiShardQueryTransientErrorDetectionStrategy*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardQueryTransientErrorDetectionStrategy.java
startLine: 37
package: com.microsoft.azure.elasticdb.query.multishard
summary: >-
<p>Creates a new instance of transient error detection strategy for Shard map manager.</p>
<p></p>
syntax:
content: public MultiShardQueryTransientErrorDetectionStrategy(RetryBehavior retryBehavior)
parameters:
- id: retryBehavior
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
description: <p>Behavior for detecting transient errors. </p>
references:
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy.MultiShardQueryTransientErrorDetectionStrategy*
name: MultiShardQueryTransientErrorDetectionStrategy
nameWithType: MultiShardQueryTransientErrorDetectionStrategy.MultiShardQueryTransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardQueryTransientErrorDetectionStrategy.MultiShardQueryTransientErrorDetectionStrategy
package: com.microsoft.azure.elasticdb.query.multishard
- uid: 8a99d4b0
spec.java:
- name: Exception
fullName: Exception
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy.isTransient*
name: isTransient
nameWithType: MultiShardQueryTransientErrorDetectionStrategy.isTransient
fullName: boolean com.microsoft.azure.elasticdb.query.multishard.MultiShardQueryTransientErrorDetectionStrategy.isTransient
package: com.microsoft.azure.elasticdb.query.multishard
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.yml
name: ITransientErrorDetectionStrategy
nameWithType: ITransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ITransientErrorDetectionStrategy
type: Interface
summary: <p>Defines an interface that must be implemented by custom components responsible for detecting specific transient conditions. </p>
syntax:
content: public interface ITransientErrorDetectionStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._sql216bcdbcbaf03a3eed450c739065f1fc.yml
name: SqlDatabaseTransientErrorDetectionStrategy
nameWithType: SqlDatabaseTransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.SqlDatabaseTransientErrorDetectionStrategy
type: Class
summary: <p>Provides the transient error detection logic for transient faults that are specific to SQL Database. </p>
syntax:
content: public class SqlDatabaseTransientErrorDetectionStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.yml
name: RetryBehavior
nameWithType: RetryBehavior
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryBehavior
type: Class
summary: <p>Defines the retry behavior to use for detecting transient errors. </p>
syntax:
content: public class RetryBehavior
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.isTransient(Exception)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.yml
name: isTransient(Exception ex)
nameWithType: ITransientErrorDetectionStrategy.isTransient(Exception ex)
fullName: boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ITransientErrorDetectionStrategy.isTransient(Exception ex)
type: Method
summary: >-
<p>Determines whether the specified exception represents a transient failure that can be compensated by a retry.</p>
<p></p>
syntax:
content: public boolean isTransient(Exception ex)
parameters:
- id: ex
type: 8a99d4b0
description: <p>The exception object to be verified. </p>
return:
type: 4fc6e284
description: <p>true if the specified exception is considered as transient; otherwise, false. </p>

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -0,0 +1,123 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils
id: _multi_shard_utils
parent: com.microsoft.azure.elasticdb.query.multishard
children:
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils.getSqlCommandRetryPolicy(RetryPolicy,RetryBehavior)
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils.getSqlConnectionRetryPolicy(RetryPolicy,RetryBehavior)
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils.yml
langs:
- java
name: MultiShardUtils
nameWithType: MultiShardUtils
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardUtils
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardUtils.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardUtils.java
startLine: 16
package: com.microsoft.azure.elasticdb.query.multishard
summary: '<p>Purpose: Various utilities used by other classes in this project. </p>'
syntax:
content: public class MultiShardUtils
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils.getSqlCommandRetryPolicy(RetryPolicy,RetryBehavior)
id: getSqlCommandRetryPolicy(RetryPolicy,RetryBehavior)
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils.yml
langs:
- java
name: getSqlCommandRetryPolicy(RetryPolicy retryPolicyPerShard, RetryBehavior retryBehavior)
nameWithType: MultiShardUtils.getSqlCommandRetryPolicy(RetryPolicy retryPolicyPerShard, RetryBehavior retryBehavior)
fullName: static RetryPolicy com.microsoft.azure.elasticdb.query.multishard.MultiShardUtils.getSqlCommandRetryPolicy(RetryPolicy retryPolicyPerShard, RetryBehavior retryBehavior)
overload: com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils.getSqlCommandRetryPolicy*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardUtils.java
startLine: 42
package: com.microsoft.azure.elasticdb.query.multishard
summary: >-
<p>The retry policy to use when executing commands against sql databases</p>
<p></p>
syntax:
content: public static RetryPolicy getSqlCommandRetryPolicy(RetryPolicy retryPolicyPerShard, RetryBehavior retryBehavior)
parameters:
- id: retryPolicyPerShard
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
description: <p>An instance of the RetryPolicy class </p>
- id: retryBehavior
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
description: <p>Behavior to use for detecting transient faults. </p>
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
description: <p>An instance of the RetryPolicy class </p>
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils.getSqlConnectionRetryPolicy(RetryPolicy,RetryBehavior)
id: getSqlConnectionRetryPolicy(RetryPolicy,RetryBehavior)
parent: com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils.yml
langs:
- java
name: getSqlConnectionRetryPolicy(RetryPolicy retryPolicyPerShard, RetryBehavior retryBehavior)
nameWithType: MultiShardUtils.getSqlConnectionRetryPolicy(RetryPolicy retryPolicyPerShard, RetryBehavior retryBehavior)
fullName: static RetryPolicy com.microsoft.azure.elasticdb.query.multishard.MultiShardUtils.getSqlConnectionRetryPolicy(RetryPolicy retryPolicyPerShard, RetryBehavior retryBehavior)
overload: com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils.getSqlConnectionRetryPolicy*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/MultiShardUtils.java
startLine: 28
package: com.microsoft.azure.elasticdb.query.multishard
summary: >-
<p>The retry policy to use when connecting to sql databases</p>
<p></p>
syntax:
content: public static RetryPolicy getSqlConnectionRetryPolicy(RetryPolicy retryPolicyPerShard, RetryBehavior retryBehavior)
parameters:
- id: retryPolicyPerShard
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
description: <p>An instance of the RetryPolicy class </p>
- id: retryBehavior
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
description: <p>Behavior to use for detecting transient faults. </p>
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
description: <p>An instance of the RetryPolicy class Separate method from the one below because we might allow for custom retry strategies in the near future </p>
references:
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils.getSqlConnectionRetryPolicy*
name: getSqlConnectionRetryPolicy
nameWithType: MultiShardUtils.getSqlConnectionRetryPolicy
fullName: static RetryPolicy com.microsoft.azure.elasticdb.query.multishard.MultiShardUtils.getSqlConnectionRetryPolicy
package: com.microsoft.azure.elasticdb.query.multishard
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils.getSqlCommandRetryPolicy*
name: getSqlCommandRetryPolicy
nameWithType: MultiShardUtils.getSqlCommandRetryPolicy
fullName: static RetryPolicy com.microsoft.azure.elasticdb.query.multishard.MultiShardUtils.getSqlCommandRetryPolicy
package: com.microsoft.azure.elasticdb.query.multishard
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
name: RetryPolicy
nameWithType: RetryPolicy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy
type: Class
summary: <p>Provides the base implementation of the retry mechanism for unreliable actions and transient conditions. </p>
syntax:
content: public class RetryPolicy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.yml
name: RetryBehavior
nameWithType: RetryBehavior
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryBehavior
type: Class
summary: <p>Defines the retry behavior to use for detecting transient errors. </p>
syntax:
content: public class RetryBehavior

Просмотреть файл

@ -0,0 +1,251 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args
id: _shard_execution_event_args
parent: com.microsoft.azure.elasticdb.query.multishard
children:
- com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.getException()
- com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.getReader()
- com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.getShardLocation()
- com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.setException(Exception)
- com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.setReader(LabeledResultSet)
- com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.setShardLocation(ShardLocation)
href: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.yml
langs:
- java
name: ShardExecutionEventArgs
nameWithType: ShardExecutionEventArgs
fullName: com.microsoft.azure.elasticdb.query.multishard.ShardExecutionEventArgs
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/ShardExecutionEventArgs.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/ShardExecutionEventArgs.java
startLine: 16
package: com.microsoft.azure.elasticdb.query.multishard
summary: <p>Input to be passed to per-shard event handlers. </p>
syntax:
content: public class ShardExecutionEventArgs
inheritance:
- java.lang.Object
- EventArgs
- uid: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.getException()
id: getException()
parent: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args
href: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.yml
langs:
- java
name: getException()
nameWithType: ShardExecutionEventArgs.getException()
fullName: final Exception com.microsoft.azure.elasticdb.query.multishard.ShardExecutionEventArgs.getException()
overload: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.getException*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/ShardExecutionEventArgs.java
startLine: 31
package: com.microsoft.azure.elasticdb.query.multishard
syntax:
content: public final Exception getException()
return:
type: 0e0204bc
- uid: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.getReader()
id: getReader()
parent: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args
href: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.yml
langs:
- java
name: getReader()
nameWithType: ShardExecutionEventArgs.getReader()
fullName: final LabeledResultSet com.microsoft.azure.elasticdb.query.multishard.ShardExecutionEventArgs.getReader()
overload: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.getReader*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/ShardExecutionEventArgs.java
startLine: 47
package: com.microsoft.azure.elasticdb.query.multishard
syntax:
content: public final LabeledResultSet getReader()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
- uid: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.getShardLocation()
id: getShardLocation()
parent: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args
href: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.yml
langs:
- java
name: getShardLocation()
nameWithType: ShardExecutionEventArgs.getShardLocation()
fullName: final ShardLocation com.microsoft.azure.elasticdb.query.multishard.ShardExecutionEventArgs.getShardLocation()
overload: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.getShardLocation*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/ShardExecutionEventArgs.java
startLine: 39
package: com.microsoft.azure.elasticdb.query.multishard
syntax:
content: public final ShardLocation getShardLocation()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.base._shard_location
- uid: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.setException(Exception)
id: setException(Exception)
parent: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args
href: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.yml
langs:
- java
name: setException(Exception value)
nameWithType: ShardExecutionEventArgs.setException(Exception value)
fullName: final void com.microsoft.azure.elasticdb.query.multishard.ShardExecutionEventArgs.setException(Exception value)
overload: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.setException*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/ShardExecutionEventArgs.java
startLine: 35
package: com.microsoft.azure.elasticdb.query.multishard
syntax:
content: public final void setException(Exception value)
parameters:
- id: value
type: 8a99d4b0
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.setReader(LabeledResultSet)
id: setReader(LabeledResultSet)
parent: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args
href: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.yml
langs:
- java
name: setReader(LabeledResultSet value)
nameWithType: ShardExecutionEventArgs.setReader(LabeledResultSet value)
fullName: final void com.microsoft.azure.elasticdb.query.multishard.ShardExecutionEventArgs.setReader(LabeledResultSet value)
overload: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.setReader*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/ShardExecutionEventArgs.java
startLine: 51
package: com.microsoft.azure.elasticdb.query.multishard
syntax:
content: public final void setReader(LabeledResultSet value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.setShardLocation(ShardLocation)
id: setShardLocation(ShardLocation)
parent: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args
href: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.yml
langs:
- java
name: setShardLocation(ShardLocation value)
nameWithType: ShardExecutionEventArgs.setShardLocation(ShardLocation value)
fullName: final void com.microsoft.azure.elasticdb.query.multishard.ShardExecutionEventArgs.setShardLocation(ShardLocation value)
overload: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.setShardLocation*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/ShardExecutionEventArgs.java
startLine: 43
package: com.microsoft.azure.elasticdb.query.multishard
syntax:
content: public final void setShardLocation(ShardLocation value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.base._shard_location
return:
type: 3f6357ce
references:
- uid: 0e0204bc
spec.java:
- name: final Exception
fullName: final Exception
- uid: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.getException*
name: getException
nameWithType: ShardExecutionEventArgs.getException
fullName: final Exception com.microsoft.azure.elasticdb.query.multishard.ShardExecutionEventArgs.getException
package: com.microsoft.azure.elasticdb.query.multishard
- uid: 8a99d4b0
spec.java:
- name: Exception
fullName: Exception
- uid: 3f6357ce
spec.java:
- name: final void
fullName: final void
- uid: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.setException*
name: setException
nameWithType: ShardExecutionEventArgs.setException
fullName: final void com.microsoft.azure.elasticdb.query.multishard.ShardExecutionEventArgs.setException
package: com.microsoft.azure.elasticdb.query.multishard
- uid: 93de0ef9com.microsoft.azure.elasticdb.shard.base._shard_location
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
name: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
- uid: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.getShardLocation*
name: getShardLocation
nameWithType: ShardExecutionEventArgs.getShardLocation
fullName: final ShardLocation com.microsoft.azure.elasticdb.query.multishard.ShardExecutionEventArgs.getShardLocation
package: com.microsoft.azure.elasticdb.query.multishard
- uid: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.setShardLocation*
name: setShardLocation
nameWithType: ShardExecutionEventArgs.setShardLocation
fullName: final void com.microsoft.azure.elasticdb.query.multishard.ShardExecutionEventArgs.setShardLocation
package: com.microsoft.azure.elasticdb.query.multishard
- uid: 93de0ef9com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
name: LabeledResultSet
fullName: com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
- uid: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.getReader*
name: getReader
nameWithType: ShardExecutionEventArgs.getReader
fullName: final LabeledResultSet com.microsoft.azure.elasticdb.query.multishard.ShardExecutionEventArgs.getReader
package: com.microsoft.azure.elasticdb.query.multishard
- uid: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.setReader*
name: setReader
nameWithType: ShardExecutionEventArgs.setReader
fullName: final void com.microsoft.azure.elasticdb.query.multishard.ShardExecutionEventArgs.setReader
package: com.microsoft.azure.elasticdb.query.multishard
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
name: ShardLocation
nameWithType: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
type: Class
summary: <p>Represents the location of a shard in terms of its server name and database name. This is used to manage connections to the shard and to support other operations on shards. As opposed to a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>, a shard location is not registered with the shard map. </p>
syntax:
content: public class ShardLocation
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement
parent: com.microsoft.azure.elasticdb.query.multishard
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement.yml
name: MultiShardStatement
nameWithType: MultiShardStatement
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardStatement
type: Class
summary: '<p>Complements the <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection" data-throw-if-not-resolved="false">MultiShardConnection</xref> with a command object similar to the triad of Connection, Statement, and ResultSet. The <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement" data-throw-if-not-resolved="false">MultiShardStatement</xref> takes a T-SQL command statement as its input and executes the command across its collection of shards specified by its corresponding <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection" data-throw-if-not-resolved="false">MultiShardConnection</xref>. The results from processing the <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement" data-throw-if-not-resolved="false">MultiShardStatement</xref> are made available through the execute methods and the <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_result_set" data-throw-if-not-resolved="false">MultiShardResultSet</xref>. Purpose: Complements the <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection" data-throw-if-not-resolved="false">MultiShardConnection</xref> and abstracts away the work of running a given command against multiple shards Notes: This class is NOT thread-safe. Since the Sync API internally invokes the async API, connections to shards with connection string property "context connection = true" are not supported. Transaction semantics are not supported. </p>'
syntax:
content: public class MultiShardStatement
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
parent: com.microsoft.azure.elasticdb.query.multishard
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
name: LabeledResultSet
nameWithType: LabeledResultSet
fullName: com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet
type: Class
summary: '<p>Simple, immutable class for affiliating a ResultSet with additional information related to the reader (e.g. Statement, shard, exceptions encountered etc) Useful when grabbing ResultSets asynchronously. Purpose: Convenience class that holds a ResultSet along with a string label for the shard that the data underlying the ResultSet came from. Notes: This is useful for keeping the ResultSet and the label together when executing asynchronously. </p>'
syntax:
content: public class LabeledResultSet

Просмотреть файл

@ -0,0 +1,107 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.query.multishard
id: multishard
children:
- com.microsoft.azure.elasticdb.query.multishard._global_constants
- com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_result_set
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement
- com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils
- com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args
href: com.microsoft.azure.elasticdb.query.multishard.yml
langs:
- java
name: com.microsoft.azure.elasticdb.query.multishard
nameWithType: com.microsoft.azure.elasticdb.query.multishard
fullName: com.microsoft.azure.elasticdb.query.multishard
type: Namespace
source:
remote:
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/GlobalConstants.java
branch: master
repo: https://github.com/Microsoft/elastic-db-tools-for-java
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/query/multishard/GlobalConstants.java
syntax:
content: package com.microsoft.azure.elasticdb.query.multishard
references:
- uid: com.microsoft.azure.elasticdb.query.multishard._global_constants
parent: com.microsoft.azure.elasticdb.query.multishard
href: com.microsoft.azure.elasticdb.query.multishard._global_constants.yml
name: GlobalConstants
nameWithType: GlobalConstants
fullName: com.microsoft.azure.elasticdb.query.multishard.GlobalConstants
type: Class
syntax:
content: public class GlobalConstants
- uid: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set
parent: com.microsoft.azure.elasticdb.query.multishard
href: com.microsoft.azure.elasticdb.query.multishard._labeled_result_set.yml
name: LabeledResultSet
nameWithType: LabeledResultSet
fullName: com.microsoft.azure.elasticdb.query.multishard.LabeledResultSet
type: Class
summary: '<p>Simple, immutable class for affiliating a ResultSet with additional information related to the reader (e.g. Statement, shard, exceptions encountered etc) Useful when grabbing ResultSets asynchronously. Purpose: Convenience class that holds a ResultSet along with a string label for the shard that the data underlying the ResultSet came from. Notes: This is useful for keeping the ResultSet and the label together when executing asynchronously. </p>'
syntax:
content: public class LabeledResultSet
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection
parent: com.microsoft.azure.elasticdb.query.multishard
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection.yml
name: MultiShardConnection
nameWithType: MultiShardConnection
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardConnection
type: Class
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>'
syntax:
content: public class MultiShardConnection
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy
parent: com.microsoft.azure.elasticdb.query.multishard
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_query_transient_error_detection_strategy.yml
name: MultiShardQueryTransientErrorDetectionStrategy
nameWithType: MultiShardQueryTransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardQueryTransientErrorDetectionStrategy
type: Class
summary: <p>Provides the transient error detection logic for transient faults that are specific to cross shard query. </p>
syntax:
content: public class MultiShardQueryTransientErrorDetectionStrategy implements ITransientErrorDetectionStrategy
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_result_set
parent: com.microsoft.azure.elasticdb.query.multishard
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_result_set.yml
name: MultiShardResultSet
nameWithType: MultiShardResultSet
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardResultSet
type: Class
syntax:
content: public class MultiShardResultSet
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement
parent: com.microsoft.azure.elasticdb.query.multishard
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement.yml
name: MultiShardStatement
nameWithType: MultiShardStatement
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardStatement
type: Class
summary: '<p>Complements the <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection" data-throw-if-not-resolved="false">MultiShardConnection</xref> with a command object similar to the triad of Connection, Statement, and ResultSet. The <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement" data-throw-if-not-resolved="false">MultiShardStatement</xref> takes a T-SQL command statement as its input and executes the command across its collection of shards specified by its corresponding <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection" data-throw-if-not-resolved="false">MultiShardConnection</xref>. The results from processing the <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_statement" data-throw-if-not-resolved="false">MultiShardStatement</xref> are made available through the execute methods and the <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_result_set" data-throw-if-not-resolved="false">MultiShardResultSet</xref>. Purpose: Complements the <xref uid="com.microsoft.azure.elasticdb.query.multishard._multi_shard_connection" data-throw-if-not-resolved="false">MultiShardConnection</xref> and abstracts away the work of running a given command against multiple shards Notes: This class is NOT thread-safe. Since the Sync API internally invokes the async API, connections to shards with connection string property "context connection = true" are not supported. Transaction semantics are not supported. </p>'
syntax:
content: public class MultiShardStatement
- uid: com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils
parent: com.microsoft.azure.elasticdb.query.multishard
href: com.microsoft.azure.elasticdb.query.multishard._multi_shard_utils.yml
name: MultiShardUtils
nameWithType: MultiShardUtils
fullName: com.microsoft.azure.elasticdb.query.multishard.MultiShardUtils
type: Class
summary: '<p>Purpose: Various utilities used by other classes in this project. </p>'
syntax:
content: public class MultiShardUtils
- uid: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args
parent: com.microsoft.azure.elasticdb.query.multishard
href: com.microsoft.azure.elasticdb.query.multishard._shard_execution_event_args.yml
name: ShardExecutionEventArgs
nameWithType: ShardExecutionEventArgs
fullName: com.microsoft.azure.elasticdb.query.multishard.ShardExecutionEventArgs
type: Class
summary: <p>Input to be passed to per-shard event handlers. </p>
syntax:
content: public class ShardExecutionEventArgs

Просмотреть файл

@ -0,0 +1,383 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
id: _base_mapping_update
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getShard()
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getStatus()
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isAnyPropertySet(MappingUpdatedProperties)
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isBeingTakenOffline(StatusT,StatusT)
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isMappingBeingTakenOffline(StatusT)
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setShard(Shard)
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setStatus(StatusT)
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
langs:
- java
name: BaseMappingUpdate<StatusT>
nameWithType: BaseMappingUpdate<StatusT>
fullName: com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/BaseMappingUpdate.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/base/BaseMappingUpdate.java
startLine: 15
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Base class for updates to mappings from shardlets to shards. </p>
syntax:
content: public class BaseMappingUpdate<StatusT> implements IMappingUpdate<StatusT>
typeParameters:
- type: "6102e815"
inheritance:
- java.lang.Object
- com.microsoft.azure.elasticdb.shard.base._i_mapping_update
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getShard()
id: getShard()
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
langs:
- java
name: getShard()
nameWithType: BaseMappingUpdate<StatusT>.getShard()
fullName: final Shard com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.getShard()
overload: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/BaseMappingUpdate.java
startLine: 51
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Gets the <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> property. </p>
syntax:
content: public final Shard getShard()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.base._shard
overridden: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.getShard()
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getStatus()
id: getStatus()
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
langs:
- java
name: getStatus()
nameWithType: BaseMappingUpdate<StatusT>.getStatus()
fullName: final StatusT com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.getStatus()
overload: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getStatus*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/BaseMappingUpdate.java
startLine: 35
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Gets the Status property. </p>
syntax:
content: public final StatusT getStatus()
return:
type: 8514b11a
overridden: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.getStatus()
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isAnyPropertySet(MappingUpdatedProperties)
id: isAnyPropertySet(MappingUpdatedProperties)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
langs:
- java
name: isAnyPropertySet(MappingUpdatedProperties properties)
nameWithType: BaseMappingUpdate<StatusT>.isAnyPropertySet(MappingUpdatedProperties properties)
fullName: final boolean com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.isAnyPropertySet(MappingUpdatedProperties properties)
overload: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isAnyPropertySet*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/BaseMappingUpdate.java
startLine: 72
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Checks if any property is set in the given bitmap.</p>
<p></p>
syntax:
content: public final boolean isAnyPropertySet(MappingUpdatedProperties properties)
parameters:
- id: properties
type: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
description: <p>Properties bitmap. </p>
return:
type: 4dda0764
description: <p>True if any of the properties is set, false otherwise. </p>
overridden: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.isAnyPropertySet(MappingUpdatedProperties)
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isBeingTakenOffline(StatusT,StatusT)
id: isBeingTakenOffline(StatusT,StatusT)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
langs:
- java
name: isBeingTakenOffline(StatusT originalStatus, StatusT updatedStatus)
nameWithType: BaseMappingUpdate<StatusT>.isBeingTakenOffline(StatusT originalStatus, StatusT updatedStatus)
fullName: abstract boolean com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.isBeingTakenOffline(StatusT originalStatus, StatusT updatedStatus)
overload: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isBeingTakenOffline*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/BaseMappingUpdate.java
startLine: 97
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Detects if the current mapping is being taken offline.</p>
<p></p>
syntax:
content: protected abstract boolean isBeingTakenOffline(StatusT originalStatus, StatusT updatedStatus)
parameters:
- id: originalStatus
type: "6102e815"
description: <p>Original status. </p>
- id: updatedStatus
type: "6102e815"
description: <p>Updated status. </p>
return:
type: 352efe7b
description: <p>Detects in the derived types if the mapping is being taken offline. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isMappingBeingTakenOffline(StatusT)
id: isMappingBeingTakenOffline(StatusT)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
langs:
- java
name: isMappingBeingTakenOffline(StatusT originalStatus)
nameWithType: BaseMappingUpdate<StatusT>.isMappingBeingTakenOffline(StatusT originalStatus)
fullName: final boolean com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.isMappingBeingTakenOffline(StatusT originalStatus)
overload: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isMappingBeingTakenOffline*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/BaseMappingUpdate.java
startLine: 83
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Checks if the mapping is being taken offline.</p>
<p></p>
syntax:
content: public final boolean isMappingBeingTakenOffline(StatusT originalStatus)
parameters:
- id: originalStatus
type: "6102e815"
description: <p>Original status. </p>
return:
type: 4dda0764
description: <p>True of the update will take the mapping offline. </p>
overridden: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.isMappingBeingTakenOffline(StatusT)
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setShard(Shard)
id: setShard(Shard)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
langs:
- java
name: setShard(Shard value)
nameWithType: BaseMappingUpdate<StatusT>.setShard(Shard value)
fullName: final void com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.setShard(Shard value)
overload: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/BaseMappingUpdate.java
startLine: 58
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Sets the <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> property. </p>
syntax:
content: public final void setShard(Shard value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.base._shard
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setStatus(StatusT)
id: setStatus(StatusT)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
langs:
- java
name: setStatus(StatusT value)
nameWithType: BaseMappingUpdate<StatusT>.setStatus(StatusT value)
fullName: final void com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.setStatus(StatusT value)
overload: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setStatus*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/BaseMappingUpdate.java
startLine: 42
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Sets the Status property. </p>
syntax:
content: public final void setStatus(StatusT value)
parameters:
- id: value
type: "6102e815"
return:
type: 3f6357ce
references:
- uid: "6102e815"
spec.java:
- name: StatusT
fullName: StatusT
- uid: 8514b11a
spec.java:
- name: final StatusT
fullName: final StatusT
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getStatus*
name: getStatus
nameWithType: BaseMappingUpdate<StatusT>.getStatus
fullName: final StatusT com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.getStatus
package: com.microsoft.azure.elasticdb.shard.base
- uid: 3f6357ce
spec.java:
- name: final void
fullName: final void
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setStatus*
name: setStatus
nameWithType: BaseMappingUpdate<StatusT>.setStatus
fullName: final void com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.setStatus
package: com.microsoft.azure.elasticdb.shard.base
- uid: 93de0ef9com.microsoft.azure.elasticdb.shard.base._shard
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.shard.base._shard
name: Shard
fullName: com.microsoft.azure.elasticdb.shard.base.Shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getShard*
name: getShard
nameWithType: BaseMappingUpdate<StatusT>.getShard
fullName: final Shard com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.getShard
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setShard*
name: setShard
nameWithType: BaseMappingUpdate<StatusT>.setShard
fullName: final void com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.setShard
package: com.microsoft.azure.elasticdb.shard.base
- uid: 4dda0764
spec.java:
- name: final boolean
fullName: final boolean
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isAnyPropertySet*
name: isAnyPropertySet
nameWithType: BaseMappingUpdate<StatusT>.isAnyPropertySet
fullName: final boolean com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.isAnyPropertySet
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isMappingBeingTakenOffline*
name: isMappingBeingTakenOffline
nameWithType: BaseMappingUpdate<StatusT>.isMappingBeingTakenOffline
fullName: final boolean com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.isMappingBeingTakenOffline
package: com.microsoft.azure.elasticdb.shard.base
- uid: 352efe7b
spec.java:
- name: abstract boolean
fullName: abstract boolean
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isBeingTakenOffline*
name: isBeingTakenOffline
nameWithType: BaseMappingUpdate<StatusT>.isBeingTakenOffline
fullName: abstract boolean com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.isBeingTakenOffline
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_update
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.yml
name: IMappingUpdate<StatusT>
nameWithType: IMappingUpdate<StatusT>
fullName: com.microsoft.azure.elasticdb.shard.base.IMappingUpdate<StatusT>
type: Interface
summary: <p>Common interface for point/range mapping updates. </p>
syntax:
content: public interface IMappingUpdate<StatusT>
typeParameters:
- type: "6102e815"
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.yml
name: MappingUpdatedProperties
nameWithType: MappingUpdatedProperties
fullName: com.microsoft.azure.elasticdb.shard.base.MappingUpdatedProperties
type: Enum
summary: <p>Records the updated properties for a mapping update object. </p>
syntax:
content: public enum MappingUpdatedProperties
- 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._i_mapping_update.getStatus()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.yml
name: getStatus()
nameWithType: IMappingUpdate<StatusT>.getStatus()
fullName: StatusT com.microsoft.azure.elasticdb.shard.base.IMappingUpdate<StatusT>.getStatus()
type: Method
summary: <p>Status property. </p>
syntax:
content: public StatusT getStatus()
return:
type: "6102e815"
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.getShard()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.yml
name: getShard()
nameWithType: IMappingUpdate<StatusT>.getShard()
fullName: Shard com.microsoft.azure.elasticdb.shard.base.IMappingUpdate<StatusT>.getShard()
type: Method
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> property. </p>
syntax:
content: public Shard getShard()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.isAnyPropertySet(MappingUpdatedProperties)
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.yml
name: isAnyPropertySet(MappingUpdatedProperties properties)
nameWithType: IMappingUpdate<StatusT>.isAnyPropertySet(MappingUpdatedProperties properties)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.IMappingUpdate<StatusT>.isAnyPropertySet(MappingUpdatedProperties properties)
type: Method
summary: >-
<p>Checks if any property is set in the given bitmap.</p>
<p></p>
syntax:
content: public boolean isAnyPropertySet(MappingUpdatedProperties properties)
parameters:
- id: properties
type: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
description: <p>Properties bitmap. </p>
return:
type: 4fc6e284
description: <p>True if any of the properties is set, false otherwise. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.isMappingBeingTakenOffline(StatusT)
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.yml
name: isMappingBeingTakenOffline(StatusT originalStatus)
nameWithType: IMappingUpdate<StatusT>.isMappingBeingTakenOffline(StatusT originalStatus)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.IMappingUpdate<StatusT>.isMappingBeingTakenOffline(StatusT originalStatus)
type: Method
summary: >-
<p>Checks if the mapping is being taken offline.</p>
<p></p>
syntax:
content: public boolean isMappingBeingTakenOffline(StatusT originalStatus)
parameters:
- id: originalStatus
type: "6102e815"
description: <p>Original status. </p>
return:
type: 4fc6e284
description: <p>True of the update will take the mapping offline. </p>

Просмотреть файл

@ -0,0 +1,351 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
id: _i_mapping_info_provider
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getKind()
- com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapId()
- com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapManager()
- com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getStoreMapping()
- com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getTypeName()
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
langs:
- java
name: IMappingInfoProvider
nameWithType: IMappingInfoProvider
fullName: com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider
type: Interface
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IMappingInfoProvider.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/base/IMappingInfoProvider.java
startLine: 18
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Interface that represents capability to provide information relevant to Add/Remove/Update operations for a mapping object. </p>
syntax:
content: public interface IMappingInfoProvider
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getKind()
id: getKind()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
langs:
- java
name: getKind()
nameWithType: IMappingInfoProvider.getKind()
fullName: MappingKind com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getKind()
overload: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getKind*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IMappingInfoProvider.java
startLine: 38
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Type of the mapping. </p>
syntax:
content: public MappingKind getKind()
return:
type: com.microsoft.azure.elasticdb.shard.base._mapping_kind
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapId()
id: getShardMapId()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
langs:
- java
name: getShardMapId()
nameWithType: IMappingInfoProvider.getShardMapId()
fullName: UUID com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getShardMapId()
overload: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapId*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IMappingInfoProvider.java
startLine: 28
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> map associated with the mapping. </p>
syntax:
content: public UUID getShardMapId()
return:
type: add9545a
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapManager()
id: getShardMapManager()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
langs:
- java
name: getShardMapManager()
nameWithType: IMappingInfoProvider.getShardMapManager()
fullName: ShardMapManager com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getShardMapManager()
overload: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IMappingInfoProvider.java
startLine: 23
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>ShardMapManager for the object. </p>
syntax:
content: public ShardMapManager getShardMapManager()
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getStoreMapping()
id: getStoreMapping()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
langs:
- java
name: getStoreMapping()
nameWithType: IMappingInfoProvider.getStoreMapping()
fullName: StoreMapping com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getStoreMapping()
overload: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getStoreMapping*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IMappingInfoProvider.java
startLine: 33
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Storage representation of the mapping. </p>
syntax:
content: public StoreMapping getStoreMapping()
return:
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getTypeName()
id: getTypeName()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
langs:
- java
name: getTypeName()
nameWithType: IMappingInfoProvider.getTypeName()
fullName: String com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getTypeName()
overload: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getTypeName*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IMappingInfoProvider.java
startLine: 43
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Mapping type, useful for diagnostics. </p>
syntax:
content: public String getTypeName()
return:
type: "26831127"
references:
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapManager*
name: getShardMapManager
nameWithType: IMappingInfoProvider.getShardMapManager
fullName: ShardMapManager com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getShardMapManager
package: com.microsoft.azure.elasticdb.shard.base
- uid: add9545a
spec.java:
- name: UUID
fullName: UUID
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapId*
name: getShardMapId
nameWithType: IMappingInfoProvider.getShardMapId
fullName: UUID com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getShardMapId
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getStoreMapping*
name: getStoreMapping
nameWithType: IMappingInfoProvider.getStoreMapping
fullName: StoreMapping com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getStoreMapping
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getKind*
name: getKind
nameWithType: IMappingInfoProvider.getKind
fullName: MappingKind com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getKind
package: com.microsoft.azure.elasticdb.shard.base
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getTypeName*
name: getTypeName
nameWithType: IMappingInfoProvider.getTypeName
fullName: String com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getTypeName
package: com.microsoft.azure.elasticdb.shard.base
- 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._range_mapping
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
name: RangeMapping
nameWithType: RangeMapping
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping
type: Class
summary: <p>Represents a mapping between a range of key values and a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>. </p>
syntax:
content: public class RangeMapping
- 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.base._point_mapping.getShardMapManager()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
name: getShardMapManager()
nameWithType: PointMapping.getShardMapManager()
fullName: ShardMapManager com.microsoft.azure.elasticdb.shard.base.PointMapping.getShardMapManager()
type: Method
summary: <p>ShardMapManager for the object. </p>
syntax:
content: public ShardMapManager getShardMapManager()
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getShardMapManager()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
name: getShardMapManager()
nameWithType: RangeMapping.getShardMapManager()
fullName: ShardMapManager com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShardMapManager()
type: Method
summary: <p>ShardMapManager for the object. </p>
syntax:
content: public ShardMapManager getShardMapManager()
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getShardMapId()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
name: getShardMapId()
nameWithType: PointMapping.getShardMapId()
fullName: UUID com.microsoft.azure.elasticdb.shard.base.PointMapping.getShardMapId()
type: Method
summary: <p>Identify of the ShardMap this shard belongs to. </p>
syntax:
content: public UUID getShardMapId()
return:
type: add9545a
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getShardMapId()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
name: getShardMapId()
nameWithType: RangeMapping.getShardMapId()
fullName: UUID com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShardMapId()
type: Method
summary: <p>Identify of the ShardMap this shard belongs to. </p>
syntax:
content: public UUID getShardMapId()
return:
type: add9545a
- 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.store._store_mapping
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_mapping.yml
name: StoreMapping
nameWithType: StoreMapping
fullName: com.microsoft.azure.elasticdb.shard.store.StoreMapping
type: Class
summary: <p>Storage representation of a mapping b/w key ranges and shards. </p>
syntax:
content: public class StoreMapping
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getStoreMapping()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
name: getStoreMapping()
nameWithType: PointMapping.getStoreMapping()
fullName: StoreMapping com.microsoft.azure.elasticdb.shard.base.PointMapping.getStoreMapping()
type: Method
summary: <p>Storage representation of the mapping. </p>
syntax:
content: public StoreMapping getStoreMapping()
return:
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getStoreMapping()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
name: getStoreMapping()
nameWithType: RangeMapping.getStoreMapping()
fullName: StoreMapping com.microsoft.azure.elasticdb.shard.base.RangeMapping.getStoreMapping()
type: Method
summary: <p>Storage representation of the mapping. </p>
syntax:
content: public StoreMapping getStoreMapping()
return:
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_kind
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_kind.yml
name: MappingKind
nameWithType: MappingKind
fullName: com.microsoft.azure.elasticdb.shard.base.MappingKind
type: Enum
summary: <p>Types of supported mappings. </p>
syntax:
content: public enum MappingKind
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getKind()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
name: getKind()
nameWithType: PointMapping.getKind()
fullName: MappingKind com.microsoft.azure.elasticdb.shard.base.PointMapping.getKind()
type: Method
summary: <p>Type of the mapping. </p>
syntax:
content: public MappingKind getKind()
return:
type: com.microsoft.azure.elasticdb.shard.base._mapping_kind
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getKind()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
name: getKind()
nameWithType: RangeMapping.getKind()
fullName: MappingKind com.microsoft.azure.elasticdb.shard.base.RangeMapping.getKind()
type: Method
summary: <p>Type of the mapping. </p>
syntax:
content: public MappingKind getKind()
return:
type: com.microsoft.azure.elasticdb.shard.base._mapping_kind
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getTypeName()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
name: getTypeName()
nameWithType: PointMapping.getTypeName()
fullName: String com.microsoft.azure.elasticdb.shard.base.PointMapping.getTypeName()
type: Method
summary: <p>Mapping type, useful for diagnostics. </p>
syntax:
content: public String getTypeName()
return:
type: "26831127"
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getTypeName()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
name: getTypeName()
nameWithType: RangeMapping.getTypeName()
fullName: String com.microsoft.azure.elasticdb.shard.base.RangeMapping.getTypeName()
type: Method
summary: <p>Mapping type, useful for diagnostics. </p>
syntax:
content: public String getTypeName()
return:
type: "26831127"

Просмотреть файл

@ -0,0 +1,258 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_update
id: _i_mapping_update
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._i_mapping_update.getShard()
- com.microsoft.azure.elasticdb.shard.base._i_mapping_update.getStatus()
- com.microsoft.azure.elasticdb.shard.base._i_mapping_update.isAnyPropertySet(MappingUpdatedProperties)
- com.microsoft.azure.elasticdb.shard.base._i_mapping_update.isMappingBeingTakenOffline(StatusT)
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.yml
langs:
- java
name: IMappingUpdate<StatusT>
nameWithType: IMappingUpdate<StatusT>
fullName: com.microsoft.azure.elasticdb.shard.base.IMappingUpdate<StatusT>
type: Interface
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IMappingUpdate.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/base/IMappingUpdate.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Common interface for point/range mapping updates. </p>
syntax:
content: public interface IMappingUpdate<StatusT>
typeParameters:
- type: "6102e815"
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.getShard()
id: getShard()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.yml
langs:
- java
name: getShard()
nameWithType: IMappingUpdate<StatusT>.getShard()
fullName: Shard com.microsoft.azure.elasticdb.shard.base.IMappingUpdate<StatusT>.getShard()
overload: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.getShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IMappingUpdate.java
startLine: 23
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> property. </p>
syntax:
content: public Shard getShard()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.getStatus()
id: getStatus()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.yml
langs:
- java
name: getStatus()
nameWithType: IMappingUpdate<StatusT>.getStatus()
fullName: StatusT com.microsoft.azure.elasticdb.shard.base.IMappingUpdate<StatusT>.getStatus()
overload: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.getStatus*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IMappingUpdate.java
startLine: 18
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Status property. </p>
syntax:
content: public StatusT getStatus()
return:
type: "6102e815"
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.isAnyPropertySet(MappingUpdatedProperties)
id: isAnyPropertySet(MappingUpdatedProperties)
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.yml
langs:
- java
name: isAnyPropertySet(MappingUpdatedProperties properties)
nameWithType: IMappingUpdate<StatusT>.isAnyPropertySet(MappingUpdatedProperties properties)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.IMappingUpdate<StatusT>.isAnyPropertySet(MappingUpdatedProperties properties)
overload: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.isAnyPropertySet*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IMappingUpdate.java
startLine: 32
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Checks if any property is set in the given bitmap.</p>
<p></p>
syntax:
content: public boolean isAnyPropertySet(MappingUpdatedProperties properties)
parameters:
- id: properties
type: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
description: <p>Properties bitmap. </p>
return:
type: 4fc6e284
description: <p>True if any of the properties is set, false otherwise. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.isMappingBeingTakenOffline(StatusT)
id: isMappingBeingTakenOffline(StatusT)
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.yml
langs:
- java
name: isMappingBeingTakenOffline(StatusT originalStatus)
nameWithType: IMappingUpdate<StatusT>.isMappingBeingTakenOffline(StatusT originalStatus)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.IMappingUpdate<StatusT>.isMappingBeingTakenOffline(StatusT originalStatus)
overload: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.isMappingBeingTakenOffline*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IMappingUpdate.java
startLine: 41
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Checks if the mapping is being taken offline.</p>
<p></p>
syntax:
content: public boolean isMappingBeingTakenOffline(StatusT originalStatus)
parameters:
- id: originalStatus
type: "6102e815"
description: <p>Original status. </p>
return:
type: 4fc6e284
description: <p>True of the update will take the mapping offline. </p>
references:
- uid: "6102e815"
spec.java:
- name: StatusT
fullName: StatusT
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.getStatus*
name: getStatus
nameWithType: IMappingUpdate<StatusT>.getStatus
fullName: StatusT com.microsoft.azure.elasticdb.shard.base.IMappingUpdate<StatusT>.getStatus
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.getShard*
name: getShard
nameWithType: IMappingUpdate<StatusT>.getShard
fullName: Shard com.microsoft.azure.elasticdb.shard.base.IMappingUpdate<StatusT>.getShard
package: com.microsoft.azure.elasticdb.shard.base
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.isAnyPropertySet*
name: isAnyPropertySet
nameWithType: IMappingUpdate<StatusT>.isAnyPropertySet
fullName: boolean com.microsoft.azure.elasticdb.shard.base.IMappingUpdate<StatusT>.isAnyPropertySet
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.isMappingBeingTakenOffline*
name: isMappingBeingTakenOffline
nameWithType: IMappingUpdate<StatusT>.isMappingBeingTakenOffline
fullName: boolean com.microsoft.azure.elasticdb.shard.base.IMappingUpdate<StatusT>.isMappingBeingTakenOffline
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: BaseMappingUpdate<StatusT>
nameWithType: BaseMappingUpdate<StatusT>
fullName: com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>
type: Class
summary: <p>Base class for updates to mappings from shardlets to shards. </p>
syntax:
content: public class BaseMappingUpdate<StatusT> implements IMappingUpdate<StatusT>
typeParameters:
- type: "6102e815"
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getStatus()
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: getStatus()
nameWithType: BaseMappingUpdate<StatusT>.getStatus()
fullName: final StatusT com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.getStatus()
type: Method
summary: <p>Gets the Status property. </p>
syntax:
content: public final StatusT getStatus()
return:
type: 8514b11a
- 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._base_mapping_update.getShard()
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: getShard()
nameWithType: BaseMappingUpdate<StatusT>.getShard()
fullName: final Shard com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.getShard()
type: Method
summary: <p>Gets the <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> property. </p>
syntax:
content: public final Shard getShard()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.base._shard
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isAnyPropertySet(MappingUpdatedProperties)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: isAnyPropertySet(MappingUpdatedProperties properties)
nameWithType: BaseMappingUpdate<StatusT>.isAnyPropertySet(MappingUpdatedProperties properties)
fullName: final boolean com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.isAnyPropertySet(MappingUpdatedProperties properties)
type: Method
summary: >-
<p>Checks if any property is set in the given bitmap.</p>
<p></p>
syntax:
content: public final boolean isAnyPropertySet(MappingUpdatedProperties properties)
parameters:
- id: properties
type: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
description: <p>Properties bitmap. </p>
return:
type: 4dda0764
description: <p>True if any of the properties is set, false otherwise. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.yml
name: MappingUpdatedProperties
nameWithType: MappingUpdatedProperties
fullName: com.microsoft.azure.elasticdb.shard.base.MappingUpdatedProperties
type: Enum
summary: <p>Records the updated properties for a mapping update object. </p>
syntax:
content: public enum MappingUpdatedProperties
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isMappingBeingTakenOffline(StatusT)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: isMappingBeingTakenOffline(StatusT originalStatus)
nameWithType: BaseMappingUpdate<StatusT>.isMappingBeingTakenOffline(StatusT originalStatus)
fullName: final boolean com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.isMappingBeingTakenOffline(StatusT originalStatus)
type: Method
summary: >-
<p>Checks if the mapping is being taken offline.</p>
<p></p>
syntax:
content: public final boolean isMappingBeingTakenOffline(StatusT originalStatus)
parameters:
- id: originalStatus
type: "6102e815"
description: <p>Original status. </p>
return:
type: 4dda0764
description: <p>True of the update will take the mapping offline. </p>

Просмотреть файл

@ -0,0 +1,195 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._i_shard_provider
id: _i_shard_provider
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._i_shard_provider.getShardInfo()
- com.microsoft.azure.elasticdb.shard.base._i_shard_provider.getValue()
- com.microsoft.azure.elasticdb.shard.base._i_shard_provider.validate(StoreShardMap,Connection)
- com.microsoft.azure.elasticdb.shard.base._i_shard_provider.validateAsync(StoreShardMap,Connection)
href: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.yml
langs:
- java
name: IShardProvider<ValueT>
nameWithType: IShardProvider<ValueT>
fullName: com.microsoft.azure.elasticdb.shard.base.IShardProvider<ValueT>
type: Interface
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IShardProvider.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/base/IShardProvider.java
startLine: 18
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Represents capabilities to provide a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> along with an associated value. </p>
syntax:
content: public interface IShardProvider<ValueT>
typeParameters:
- type: 0fb6b535
- uid: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.getShardInfo()
id: getShardInfo()
parent: com.microsoft.azure.elasticdb.shard.base._i_shard_provider
href: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.yml
langs:
- java
name: getShardInfo()
nameWithType: IShardProvider<ValueT>.getShardInfo()
fullName: Shard com.microsoft.azure.elasticdb.shard.base.IShardProvider<ValueT>.getShardInfo()
overload: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.getShardInfo*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IShardProvider.java
startLine: 23
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> for the ShardProvider object. </p>
syntax:
content: public Shard getShardInfo()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard
- uid: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.base._i_shard_provider
href: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.yml
langs:
- java
name: getValue()
nameWithType: IShardProvider<ValueT>.getValue()
fullName: ValueT com.microsoft.azure.elasticdb.shard.base.IShardProvider<ValueT>.getValue()
overload: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IShardProvider.java
startLine: 28
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Value corresponding to the <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>. Represents traits of the <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> object provided by the ShardInfo property. </p>
syntax:
content: public ValueT getValue()
return:
type: 0fb6b535
- uid: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.validate(StoreShardMap,Connection)
id: validate(StoreShardMap,Connection)
parent: com.microsoft.azure.elasticdb.shard.base._i_shard_provider
href: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.yml
langs:
- java
name: validate(StoreShardMap shardMap, Connection conn)
nameWithType: IShardProvider<ValueT>.validate(StoreShardMap shardMap, Connection conn)
fullName: void com.microsoft.azure.elasticdb.shard.base.IShardProvider<ValueT>.validate(StoreShardMap shardMap, Connection conn)
overload: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.validate*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IShardProvider.java
startLine: 38
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Performs validation that the local representation is as up-to-date as the representation on the backing data store.</p>
<p></p>
syntax:
content: public void validate(StoreShardMap shardMap, Connection conn)
parameters:
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> map to which the shard provider belongs. </p>
- id: conn
type: 8270ccc2
description: <p>Connection used for validation. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.validateAsync(StoreShardMap,Connection)
id: validateAsync(StoreShardMap,Connection)
parent: com.microsoft.azure.elasticdb.shard.base._i_shard_provider
href: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.yml
langs:
- java
name: validateAsync(StoreShardMap shardMap, Connection conn)
nameWithType: IShardProvider<ValueT>.validateAsync(StoreShardMap shardMap, Connection conn)
fullName: Callable com.microsoft.azure.elasticdb.shard.base.IShardProvider<ValueT>.validateAsync(StoreShardMap shardMap, Connection conn)
overload: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.validateAsync*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/IShardProvider.java
startLine: 50
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Asynchronously performs validation that the local representation is as up-to-date as the representation on the backing data store.</p>
<p></p>
syntax:
content: public Callable validateAsync(StoreShardMap shardMap, Connection conn)
parameters:
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> map to which the shard provider belongs. </p>
- id: conn
type: 8270ccc2
description: <p>Connection used for validation. </p>
return:
type: b2e5ac79
description: <p>A task to await validation completion </p>
references:
- uid: 0fb6b535
spec.java:
- name: ValueT
fullName: ValueT
- uid: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.getShardInfo*
name: getShardInfo
nameWithType: IShardProvider<ValueT>.getShardInfo
fullName: Shard com.microsoft.azure.elasticdb.shard.base.IShardProvider<ValueT>.getShardInfo
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.getValue*
name: getValue
nameWithType: IShardProvider<ValueT>.getValue
fullName: ValueT com.microsoft.azure.elasticdb.shard.base.IShardProvider<ValueT>.getValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: 8270ccc2
spec.java:
- name: Connection
fullName: Connection
- uid: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.validate*
name: validate
nameWithType: IShardProvider<ValueT>.validate
fullName: void com.microsoft.azure.elasticdb.shard.base.IShardProvider<ValueT>.validate
package: com.microsoft.azure.elasticdb.shard.base
- uid: b2e5ac79
spec.java:
- name: Callable
fullName: Callable
- uid: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.validateAsync*
name: validateAsync
nameWithType: IShardProvider<ValueT>.validateAsync
fullName: Callable com.microsoft.azure.elasticdb.shard.base.IShardProvider<ValueT>.validateAsync
package: com.microsoft.azure.elasticdb.shard.base
- 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.store._store_shard_map
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_shard_map.yml
name: StoreShardMap
nameWithType: StoreShardMap
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShardMap
type: Class
summary: <p>Store representation of a shard map. </p>
syntax:
content: public class StoreShardMap

Просмотреть файл

@ -0,0 +1,223 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type
id: _lock_owner_id_op_type
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.forValue(int)
- com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.getValue()
- com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.Lock
- com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.LockOwnerIdOpType(int)
- com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.SIZE
- com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.UnlockAllMappings
- com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.UnlockAllMappingsForId
- com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.UnlockMappingForId
href: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.yml
langs:
- java
name: LockOwnerIdOpType
nameWithType: LockOwnerIdOpType
fullName: com.microsoft.azure.elasticdb.shard.base.LockOwnerIdOpType
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LockOwnerIdOpType.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/base/LockOwnerIdOpType.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Set of operations that can be performed on mappings with lockOwnerId. </p>
syntax: &o1
content: public enum LockOwnerIdOpType
inheritance:
- java.lang.Object
- java.lang.Enum<LockOwnerIdOpType>
- uid: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type
href: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.yml
langs:
- java
name: forValue(int value)
nameWithType: LockOwnerIdOpType.forValue(int value)
fullName: static LockOwnerIdOpType com.microsoft.azure.elasticdb.shard.base.LockOwnerIdOpType.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LockOwnerIdOpType.java
startLine: 54
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static LockOwnerIdOpType forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type
- uid: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type
href: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.yml
langs:
- java
name: getValue()
nameWithType: LockOwnerIdOpType.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.base.LockOwnerIdOpType.getValue()
overload: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LockOwnerIdOpType.java
startLine: 58
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.Lock
id: Lock
parent: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type
href: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.yml
langs:
- java
name: Lock
nameWithType: LockOwnerIdOpType.Lock
fullName: com.microsoft.azure.elasticdb.shard.base.LockOwnerIdOpType.Lock
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LockOwnerIdOpType.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Lock the range mapping with the given lockOwnerId. </p>
syntax:
content: public Lock=(0)
- uid: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.LockOwnerIdOpType(int)
id: LockOwnerIdOpType(int)
parent: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type
href: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.yml
langs:
- java
name: LockOwnerIdOpType(int value)
nameWithType: LockOwnerIdOpType.LockOwnerIdOpType(int value)
fullName: com.microsoft.azure.elasticdb.shard.base.LockOwnerIdOpType.LockOwnerIdOpType(int value)
overload: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.LockOwnerIdOpType*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LockOwnerIdOpType.java
startLine: 38
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public LockOwnerIdOpType(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type
href: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.yml
langs:
- java
name: SIZE
nameWithType: LockOwnerIdOpType.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.base.LockOwnerIdOpType.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LockOwnerIdOpType.java
startLine: 34
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
- uid: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.UnlockAllMappings
id: UnlockAllMappings
parent: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type
href: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.yml
langs:
- java
name: UnlockAllMappings
nameWithType: LockOwnerIdOpType.UnlockAllMappings
fullName: com.microsoft.azure.elasticdb.shard.base.LockOwnerIdOpType.UnlockAllMappings
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LockOwnerIdOpType.java
startLine: 32
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Unlock all locked range mappings. </p>
syntax:
content: public UnlockAllMappings=(3)
- uid: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.UnlockAllMappingsForId
id: UnlockAllMappingsForId
parent: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type
href: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.yml
langs:
- java
name: UnlockAllMappingsForId
nameWithType: LockOwnerIdOpType.UnlockAllMappingsForId
fullName: com.microsoft.azure.elasticdb.shard.base.LockOwnerIdOpType.UnlockAllMappingsForId
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LockOwnerIdOpType.java
startLine: 27
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Unlock all the range mappings that have the given lockOwnerId. </p>
syntax:
content: public UnlockAllMappingsForId=(2)
- uid: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.UnlockMappingForId
id: UnlockMappingForId
parent: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type
href: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.yml
langs:
- java
name: UnlockMappingForId
nameWithType: LockOwnerIdOpType.UnlockMappingForId
fullName: com.microsoft.azure.elasticdb.shard.base.LockOwnerIdOpType.UnlockMappingForId
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LockOwnerIdOpType.java
startLine: 22
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Unlock the range mapping that has the given lockOwnerId. </p>
syntax:
content: public UnlockMappingForId=(1)
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.LockOwnerIdOpType*
name: LockOwnerIdOpType
nameWithType: LockOwnerIdOpType.LockOwnerIdOpType
fullName: com.microsoft.azure.elasticdb.shard.base.LockOwnerIdOpType.LockOwnerIdOpType
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.getValue*
name: getValue
nameWithType: LockOwnerIdOpType.getValue
fullName: int com.microsoft.azure.elasticdb.shard.base.LockOwnerIdOpType.getValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type.forValue*
name: forValue
nameWithType: LockOwnerIdOpType.forValue
fullName: static LockOwnerIdOpType com.microsoft.azure.elasticdb.shard.base.LockOwnerIdOpType.forValue
package: com.microsoft.azure.elasticdb.shard.base
- 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: *o1

Просмотреть файл

@ -0,0 +1,196 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._lookup_options
id: _lookup_options
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._lookup_options.forValue(int)
- com.microsoft.azure.elasticdb.shard.base._lookup_options.getValue()
- com.microsoft.azure.elasticdb.shard.base._lookup_options.LOOKUP_IN_CACHE
- com.microsoft.azure.elasticdb.shard.base._lookup_options.LOOKUP_IN_STORE
- com.microsoft.azure.elasticdb.shard.base._lookup_options.NONE
- com.microsoft.azure.elasticdb.shard.base._lookup_options.SIZE
href: com.microsoft.azure.elasticdb.shard.base._lookup_options.yml
langs:
- java
name: LookupOptions
nameWithType: LookupOptions
fullName: com.microsoft.azure.elasticdb.shard.base.LookupOptions
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LookupOptions.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/base/LookupOptions.java
startLine: 15
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Specifies where mapping lookup operations will search for mappings. </p>
syntax: &o1
content: public class LookupOptions
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.base._lookup_options.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.base._lookup_options
href: com.microsoft.azure.elasticdb.shard.base._lookup_options.yml
langs:
- java
name: forValue(int value)
nameWithType: LookupOptions.forValue(int value)
fullName: static LookupOptions com.microsoft.azure.elasticdb.shard.base.LookupOptions.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.base._lookup_options.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LookupOptions.java
startLine: 62
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Lookup Options for an Integer Value.</p>
<p></p>
syntax:
content: public static LookupOptions forValue(int value)
parameters:
- id: value
type: f75371fa
description: <p>Input integer value </p>
return:
type: com.microsoft.azure.elasticdb.shard.base._lookup_options
description: <p>Lookup Option </p>
- uid: com.microsoft.azure.elasticdb.shard.base._lookup_options.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.base._lookup_options
href: com.microsoft.azure.elasticdb.shard.base._lookup_options.yml
langs:
- java
name: getValue()
nameWithType: LookupOptions.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.base.LookupOptions.getValue()
overload: com.microsoft.azure.elasticdb.shard.base._lookup_options.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LookupOptions.java
startLine: 74
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._lookup_options.LOOKUP_IN_CACHE
id: LOOKUP_IN_CACHE
parent: com.microsoft.azure.elasticdb.shard.base._lookup_options
href: com.microsoft.azure.elasticdb.shard.base._lookup_options.yml
langs:
- java
name: LOOKUP_IN_CACHE
nameWithType: LookupOptions.LOOKUP_IN_CACHE
fullName: final LookupOptions com.microsoft.azure.elasticdb.shard.base.LookupOptions.LOOKUP_IN_CACHE
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LookupOptions.java
startLine: 25
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Attempt to lookup in the local cache. If LookupInCache and LookupInStore are both specified, the cache will be searched first, then the store. </p>
syntax:
content: public static final LookupOptions LOOKUP_IN_CACHE= new LookupOptions(1)
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.base._lookup_options
- uid: com.microsoft.azure.elasticdb.shard.base._lookup_options.LOOKUP_IN_STORE
id: LOOKUP_IN_STORE
parent: com.microsoft.azure.elasticdb.shard.base._lookup_options
href: com.microsoft.azure.elasticdb.shard.base._lookup_options.yml
langs:
- java
name: LOOKUP_IN_STORE
nameWithType: LookupOptions.LOOKUP_IN_STORE
fullName: final LookupOptions com.microsoft.azure.elasticdb.shard.base.LookupOptions.LOOKUP_IN_STORE
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LookupOptions.java
startLine: 31
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Attempt to lookup in the global shard map store. If LookupInCache and LookupInStore are both specified, the cache will be searched first, then the store. </p>
syntax:
content: public static final LookupOptions LOOKUP_IN_STORE= new LookupOptions(1 <<2)
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.base._lookup_options
- uid: com.microsoft.azure.elasticdb.shard.base._lookup_options.NONE
id: NONE
parent: com.microsoft.azure.elasticdb.shard.base._lookup_options
href: com.microsoft.azure.elasticdb.shard.base._lookup_options.yml
langs:
- java
name: NONE
nameWithType: LookupOptions.NONE
fullName: final LookupOptions com.microsoft.azure.elasticdb.shard.base.LookupOptions.NONE
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LookupOptions.java
startLine: 20
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Default invalid kind of lookup options. </p>
syntax:
content: public static final LookupOptions NONE= new LookupOptions(0)
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.base._lookup_options
- uid: com.microsoft.azure.elasticdb.shard.base._lookup_options.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.base._lookup_options
href: com.microsoft.azure.elasticdb.shard.base._lookup_options.yml
langs:
- java
name: SIZE
nameWithType: LookupOptions.SIZE
fullName: final int com.microsoft.azure.elasticdb.shard.base.LookupOptions.SIZE
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/LookupOptions.java
startLine: 33
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
references:
- uid: 93de0ef9com.microsoft.azure.elasticdb.shard.base._lookup_options
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.shard.base._lookup_options
name: LookupOptions
fullName: com.microsoft.azure.elasticdb.shard.base.LookupOptions
href: com.microsoft.azure.elasticdb.shard.base._lookup_options.yml
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.base._lookup_options.forValue*
name: forValue
nameWithType: LookupOptions.forValue
fullName: static LookupOptions com.microsoft.azure.elasticdb.shard.base.LookupOptions.forValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._lookup_options.getValue*
name: getValue
nameWithType: LookupOptions.getValue
fullName: int com.microsoft.azure.elasticdb.shard.base.LookupOptions.getValue
package: com.microsoft.azure.elasticdb.shard.base
- 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: *o1

Просмотреть файл

@ -0,0 +1,183 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_kind
id: _mapping_kind
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._mapping_kind.forValue(int)
- com.microsoft.azure.elasticdb.shard.base._mapping_kind.getValue()
- com.microsoft.azure.elasticdb.shard.base._mapping_kind.MappingKind(int)
- com.microsoft.azure.elasticdb.shard.base._mapping_kind.PointMapping
- com.microsoft.azure.elasticdb.shard.base._mapping_kind.RangeMapping
- com.microsoft.azure.elasticdb.shard.base._mapping_kind.SIZE
href: com.microsoft.azure.elasticdb.shard.base._mapping_kind.yml
langs:
- java
name: MappingKind
nameWithType: MappingKind
fullName: com.microsoft.azure.elasticdb.shard.base.MappingKind
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingKind.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/base/MappingKind.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Types of supported mappings. </p>
syntax: &o1
content: public enum MappingKind
inheritance:
- java.lang.Object
- java.lang.Enum<MappingKind>
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_kind.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.base._mapping_kind
href: com.microsoft.azure.elasticdb.shard.base._mapping_kind.yml
langs:
- java
name: forValue(int value)
nameWithType: MappingKind.forValue(int value)
fullName: static MappingKind com.microsoft.azure.elasticdb.shard.base.MappingKind.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.base._mapping_kind.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingKind.java
startLine: 37
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static MappingKind forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.base._mapping_kind
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_kind.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.base._mapping_kind
href: com.microsoft.azure.elasticdb.shard.base._mapping_kind.yml
langs:
- java
name: getValue()
nameWithType: MappingKind.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.base.MappingKind.getValue()
overload: com.microsoft.azure.elasticdb.shard.base._mapping_kind.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingKind.java
startLine: 41
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_kind.MappingKind(int)
id: MappingKind(int)
parent: com.microsoft.azure.elasticdb.shard.base._mapping_kind
href: com.microsoft.azure.elasticdb.shard.base._mapping_kind.yml
langs:
- java
name: MappingKind(int value)
nameWithType: MappingKind.MappingKind(int value)
fullName: com.microsoft.azure.elasticdb.shard.base.MappingKind.MappingKind(int value)
overload: com.microsoft.azure.elasticdb.shard.base._mapping_kind.MappingKind*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingKind.java
startLine: 21
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public MappingKind(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_kind.PointMapping
id: PointMapping
parent: com.microsoft.azure.elasticdb.shard.base._mapping_kind
href: com.microsoft.azure.elasticdb.shard.base._mapping_kind.yml
langs:
- java
name: PointMapping
nameWithType: MappingKind.PointMapping
fullName: com.microsoft.azure.elasticdb.shard.base.MappingKind.PointMapping
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingKind.java
startLine: 14
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public PointMapping=(0)
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_kind.RangeMapping
id: RangeMapping
parent: com.microsoft.azure.elasticdb.shard.base._mapping_kind
href: com.microsoft.azure.elasticdb.shard.base._mapping_kind.yml
langs:
- java
name: RangeMapping
nameWithType: MappingKind.RangeMapping
fullName: com.microsoft.azure.elasticdb.shard.base.MappingKind.RangeMapping
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingKind.java
startLine: 15
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public RangeMapping=(1)
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_kind.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.base._mapping_kind
href: com.microsoft.azure.elasticdb.shard.base._mapping_kind.yml
langs:
- java
name: SIZE
nameWithType: MappingKind.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.base.MappingKind.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingKind.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_kind.MappingKind*
name: MappingKind
nameWithType: MappingKind.MappingKind
fullName: com.microsoft.azure.elasticdb.shard.base.MappingKind.MappingKind
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_kind.getValue*
name: getValue
nameWithType: MappingKind.getValue
fullName: int com.microsoft.azure.elasticdb.shard.base.MappingKind.getValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_kind.forValue*
name: forValue
nameWithType: MappingKind.forValue
fullName: static MappingKind com.microsoft.azure.elasticdb.shard.base.MappingKind.forValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_kind
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_kind.yml
name: MappingKind
nameWithType: MappingKind
fullName: com.microsoft.azure.elasticdb.shard.base.MappingKind
type: Enum
summary: <p>Types of supported mappings. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,389 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
id: _mapping_lock_token
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.create()
- com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.equals(MappingLockToken)
- com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.equals(Object)
- com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.ForceUnlock
- com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.getLockOwnerId()
- com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.hashCode()
- com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.MappingLockToken(UUID)
- com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.NoLock
- com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.opEquality(MappingLockToken,MappingLockToken)
- com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.opInequality(MappingLockToken,MappingLockToken)
- com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.setLockOwnerId(UUID)
href: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.yml
langs:
- java
name: MappingLockToken
nameWithType: MappingLockToken
fullName: com.microsoft.azure.elasticdb.shard.base.MappingLockToken
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingLockToken.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/base/MappingLockToken.java
startLine: 15
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Public type that represents the owner of a lock held on a mapping. This class is immutable. </p>
syntax: &o1
content: public class MappingLockToken
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.create()
id: create()
parent: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
href: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.yml
langs:
- java
name: create()
nameWithType: MappingLockToken.create()
fullName: static MappingLockToken com.microsoft.azure.elasticdb.shard.base.MappingLockToken.create()
overload: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.create*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingLockToken.java
startLine: 44
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Creates an instance of <xref uid="com.microsoft.azure.elasticdb.shard.base._mapping_lock_token" data-throw-if-not-resolved="false">MappingLockToken</xref>.</p>
<p></p>
syntax:
content: public static MappingLockToken create()
return:
type: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
description: <p>An instance of <xref uid="com.microsoft.azure.elasticdb.shard.base._mapping_lock_token" data-throw-if-not-resolved="false">MappingLockToken</xref></p>
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.equals(MappingLockToken)
id: equals(MappingLockToken)
parent: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
href: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.yml
langs:
- java
name: equals(MappingLockToken other)
nameWithType: MappingLockToken.equals(MappingLockToken other)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.MappingLockToken.equals(MappingLockToken other)
overload: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingLockToken.java
startLine: 101
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Compares two instances of <xref uid="com.microsoft.azure.elasticdb.shard.base._mapping_lock_token" data-throw-if-not-resolved="false">MappingLockToken</xref> to see if they have the same owner.</p>
<p></p>
syntax:
content: public boolean equals(MappingLockToken other)
parameters:
- id: other
type: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
return:
type: 4fc6e284
description: <p>True if they both belong to the same lock owner </p>
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.equals(Object)
id: equals(Object)
parent: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
href: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.yml
langs:
- java
name: equals(Object obj)
nameWithType: MappingLockToken.equals(Object obj)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.MappingLockToken.equals(Object obj)
overload: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingLockToken.java
startLine: 92
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Determines whether the specified object is equal to the current object.</p>
<p></p>
syntax:
content: public boolean equals(Object obj)
parameters:
- id: obj
type: "79317049"
description: <p>The object to compare with the current object. </p>
return:
type: 4fc6e284
description: <p>True if the specified object is equal to the current object; otherwise, false. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.ForceUnlock
id: ForceUnlock
parent: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
href: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.yml
langs:
- java
name: ForceUnlock
nameWithType: MappingLockToken.ForceUnlock
fullName: final MappingLockToken com.microsoft.azure.elasticdb.shard.base.MappingLockToken.ForceUnlock
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingLockToken.java
startLine: 25
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Token that can be used to force an unlock on any locked mapping. </p>
syntax:
content: public static final MappingLockToken ForceUnlock= new MappingLockToken(UUID.fromString("FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF"))
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.getLockOwnerId()
id: getLockOwnerId()
parent: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
href: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.yml
langs:
- java
name: getLockOwnerId()
nameWithType: MappingLockToken.getLockOwnerId()
fullName: UUID com.microsoft.azure.elasticdb.shard.base.MappingLockToken.getLockOwnerId()
overload: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.getLockOwnerId*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingLockToken.java
startLine: 76
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public UUID getLockOwnerId()
return:
type: add9545a
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.hashCode()
id: hashCode()
parent: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
href: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.yml
langs:
- java
name: hashCode()
nameWithType: MappingLockToken.hashCode()
fullName: int com.microsoft.azure.elasticdb.shard.base.MappingLockToken.hashCode()
overload: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.hashCode*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingLockToken.java
startLine: 111
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Calculates the hash code for this instance.</p>
<p></p>
syntax:
content: public int hashCode()
return:
type: f75371fa
description: <p>Hash code for the object. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.MappingLockToken(UUID)
id: MappingLockToken(UUID)
parent: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
href: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.yml
langs:
- java
name: MappingLockToken(UUID lockOwnerId)
nameWithType: MappingLockToken.MappingLockToken(UUID lockOwnerId)
fullName: com.microsoft.azure.elasticdb.shard.base.MappingLockToken.MappingLockToken(UUID lockOwnerId)
overload: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.MappingLockToken*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingLockToken.java
startLine: 35
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Instantiates an instance of <xref uid="com.microsoft.azure.elasticdb.shard.base._mapping_lock_token" data-throw-if-not-resolved="false">MappingLockToken</xref> with the given lock owner id.</p>
<p></p>
syntax:
content: public MappingLockToken(UUID lockOwnerId)
parameters:
- id: lockOwnerId
type: add9545a
description: <p>The lock owner id </p>
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.NoLock
id: NoLock
parent: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
href: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.yml
langs:
- java
name: NoLock
nameWithType: MappingLockToken.NoLock
fullName: final MappingLockToken com.microsoft.azure.elasticdb.shard.base.MappingLockToken.NoLock
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingLockToken.java
startLine: 20
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Token representing the default state where the mapping isn't locked. </p>
syntax:
content: public static final MappingLockToken NoLock= new MappingLockToken(new UUID(0L, 0L))
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.opEquality(MappingLockToken,MappingLockToken)
id: opEquality(MappingLockToken,MappingLockToken)
parent: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
href: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.yml
langs:
- java
name: opEquality(MappingLockToken leftMappingLockToken, MappingLockToken rightMappingLockToken)
nameWithType: MappingLockToken.opEquality(MappingLockToken leftMappingLockToken, MappingLockToken rightMappingLockToken)
fullName: static boolean com.microsoft.azure.elasticdb.shard.base.MappingLockToken.opEquality(MappingLockToken leftMappingLockToken, MappingLockToken rightMappingLockToken)
overload: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.opEquality*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingLockToken.java
startLine: 57
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Equality operator.</p>
<p></p>
syntax:
content: public static boolean opEquality(MappingLockToken leftMappingLockToken, MappingLockToken rightMappingLockToken)
parameters:
- id: leftMappingLockToken
type: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
description: <p>An instance of <xref uid="com.microsoft.azure.elasticdb.shard.base._mapping_lock_token" data-throw-if-not-resolved="false">MappingLockToken</xref></p>
- id: rightMappingLockToken
type: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
description: <p>An instance of <xref uid="com.microsoft.azure.elasticdb.shard.base._mapping_lock_token" data-throw-if-not-resolved="false">MappingLockToken</xref></p>
return:
type: 4fc6e284
description: <p>True if both belong to the same lock owner </p>
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.opInequality(MappingLockToken,MappingLockToken)
id: opInequality(MappingLockToken,MappingLockToken)
parent: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
href: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.yml
langs:
- java
name: opInequality(MappingLockToken leftMappingLockToken, MappingLockToken rightMappingLockToken)
nameWithType: MappingLockToken.opInequality(MappingLockToken leftMappingLockToken, MappingLockToken rightMappingLockToken)
fullName: static boolean com.microsoft.azure.elasticdb.shard.base.MappingLockToken.opInequality(MappingLockToken leftMappingLockToken, MappingLockToken rightMappingLockToken)
overload: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.opInequality*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingLockToken.java
startLine: 71
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Inequality operator.</p>
<p></p>
syntax:
content: public static boolean opInequality(MappingLockToken leftMappingLockToken, MappingLockToken rightMappingLockToken)
parameters:
- id: leftMappingLockToken
type: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
description: <p>An instance of <xref uid="com.microsoft.azure.elasticdb.shard.base._mapping_lock_token" data-throw-if-not-resolved="false">MappingLockToken</xref></p>
- id: rightMappingLockToken
type: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
description: <p>An instance of <xref uid="com.microsoft.azure.elasticdb.shard.base._mapping_lock_token" data-throw-if-not-resolved="false">MappingLockToken</xref></p>
return:
type: 4fc6e284
description: <p>True if both belong to the same lock owner </p>
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.setLockOwnerId(UUID)
id: setLockOwnerId(UUID)
parent: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
href: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.yml
langs:
- java
name: setLockOwnerId(UUID value)
nameWithType: MappingLockToken.setLockOwnerId(UUID value)
fullName: void com.microsoft.azure.elasticdb.shard.base.MappingLockToken.setLockOwnerId(UUID value)
overload: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.setLockOwnerId*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingLockToken.java
startLine: 80
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public void setLockOwnerId(UUID value)
parameters:
- id: value
type: add9545a
references:
- uid: 93de0ef9com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
name: MappingLockToken
fullName: com.microsoft.azure.elasticdb.shard.base.MappingLockToken
href: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.yml
- uid: add9545a
spec.java:
- name: UUID
fullName: UUID
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.MappingLockToken*
name: MappingLockToken
nameWithType: MappingLockToken.MappingLockToken
fullName: com.microsoft.azure.elasticdb.shard.base.MappingLockToken.MappingLockToken
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.getLockOwnerId*
name: getLockOwnerId
nameWithType: MappingLockToken.getLockOwnerId
fullName: UUID com.microsoft.azure.elasticdb.shard.base.MappingLockToken.getLockOwnerId
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.setLockOwnerId*
name: setLockOwnerId
nameWithType: MappingLockToken.setLockOwnerId
fullName: void com.microsoft.azure.elasticdb.shard.base.MappingLockToken.setLockOwnerId
package: com.microsoft.azure.elasticdb.shard.base
- uid: "79317049"
spec.java:
- name: Object
fullName: Object
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.equals*
name: equals
nameWithType: MappingLockToken.equals
fullName: boolean com.microsoft.azure.elasticdb.shard.base.MappingLockToken.equals
package: com.microsoft.azure.elasticdb.shard.base
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.hashCode*
name: hashCode
nameWithType: MappingLockToken.hashCode
fullName: int com.microsoft.azure.elasticdb.shard.base.MappingLockToken.hashCode
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.create*
name: create
nameWithType: MappingLockToken.create
fullName: static MappingLockToken com.microsoft.azure.elasticdb.shard.base.MappingLockToken.create
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.opEquality*
name: opEquality
nameWithType: MappingLockToken.opEquality
fullName: static boolean com.microsoft.azure.elasticdb.shard.base.MappingLockToken.opEquality
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.opInequality*
name: opInequality
nameWithType: MappingLockToken.opInequality
fullName: static boolean com.microsoft.azure.elasticdb.shard.base.MappingLockToken.opInequality
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.yml
name: MappingLockToken
nameWithType: MappingLockToken
fullName: com.microsoft.azure.elasticdb.shard.base.MappingLockToken
type: Class
summary: <p>Public type that represents the owner of a lock held on a mapping. This class is immutable. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,185 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_status
id: _mapping_status
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._mapping_status.forValue(int)
- com.microsoft.azure.elasticdb.shard.base._mapping_status.getValue()
- com.microsoft.azure.elasticdb.shard.base._mapping_status.MappingStatus(int)
- com.microsoft.azure.elasticdb.shard.base._mapping_status.Offline
- com.microsoft.azure.elasticdb.shard.base._mapping_status.Online
- com.microsoft.azure.elasticdb.shard.base._mapping_status.SIZE
href: com.microsoft.azure.elasticdb.shard.base._mapping_status.yml
langs:
- java
name: MappingStatus
nameWithType: MappingStatus
fullName: com.microsoft.azure.elasticdb.shard.base.MappingStatus
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingStatus.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/base/MappingStatus.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Status of a mapping. </p>
syntax: &o1
content: public enum MappingStatus
inheritance:
- java.lang.Object
- java.lang.Enum<MappingStatus>
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_status.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.base._mapping_status
href: com.microsoft.azure.elasticdb.shard.base._mapping_status.yml
langs:
- java
name: forValue(int value)
nameWithType: MappingStatus.forValue(int value)
fullName: static MappingStatus com.microsoft.azure.elasticdb.shard.base.MappingStatus.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.base._mapping_status.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingStatus.java
startLine: 44
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static MappingStatus forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.base._mapping_status
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_status.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.base._mapping_status
href: com.microsoft.azure.elasticdb.shard.base._mapping_status.yml
langs:
- java
name: getValue()
nameWithType: MappingStatus.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.base.MappingStatus.getValue()
overload: com.microsoft.azure.elasticdb.shard.base._mapping_status.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingStatus.java
startLine: 48
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_status.MappingStatus(int)
id: MappingStatus(int)
parent: com.microsoft.azure.elasticdb.shard.base._mapping_status
href: com.microsoft.azure.elasticdb.shard.base._mapping_status.yml
langs:
- java
name: MappingStatus(int value)
nameWithType: MappingStatus.MappingStatus(int value)
fullName: com.microsoft.azure.elasticdb.shard.base.MappingStatus.MappingStatus(int value)
overload: com.microsoft.azure.elasticdb.shard.base._mapping_status.MappingStatus*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingStatus.java
startLine: 28
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public MappingStatus(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_status.Offline
id: Offline
parent: com.microsoft.azure.elasticdb.shard.base._mapping_status
href: com.microsoft.azure.elasticdb.shard.base._mapping_status.yml
langs:
- java
name: Offline
nameWithType: MappingStatus.Offline
fullName: com.microsoft.azure.elasticdb.shard.base.MappingStatus.Offline
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingStatus.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Mapping is Offline. </p>
syntax:
content: public Offline=(0)
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_status.Online
id: Online
parent: com.microsoft.azure.elasticdb.shard.base._mapping_status
href: com.microsoft.azure.elasticdb.shard.base._mapping_status.yml
langs:
- java
name: Online
nameWithType: MappingStatus.Online
fullName: com.microsoft.azure.elasticdb.shard.base.MappingStatus.Online
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingStatus.java
startLine: 22
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Mapping is Online. </p>
syntax:
content: public Online=(1)
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_status.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.base._mapping_status
href: com.microsoft.azure.elasticdb.shard.base._mapping_status.yml
langs:
- java
name: SIZE
nameWithType: MappingStatus.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.base.MappingStatus.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingStatus.java
startLine: 24
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_status.MappingStatus*
name: MappingStatus
nameWithType: MappingStatus.MappingStatus
fullName: com.microsoft.azure.elasticdb.shard.base.MappingStatus.MappingStatus
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_status.getValue*
name: getValue
nameWithType: MappingStatus.getValue
fullName: int com.microsoft.azure.elasticdb.shard.base.MappingStatus.getValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_status.forValue*
name: forValue
nameWithType: MappingStatus.forValue
fullName: static MappingStatus com.microsoft.azure.elasticdb.shard.base.MappingStatus.forValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_status
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_status.yml
name: MappingStatus
nameWithType: MappingStatus
fullName: com.microsoft.azure.elasticdb.shard.base.MappingStatus
type: Enum
summary: <p>Status of a mapping. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,201 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
id: _mapping_updated_properties
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.All
- com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.forValue(int)
- com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.getValue()
- com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.MappingUpdatedProperties(int)
- com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.Shard
- com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.SIZE
- com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.Status
href: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.yml
langs:
- java
name: MappingUpdatedProperties
nameWithType: MappingUpdatedProperties
fullName: com.microsoft.azure.elasticdb.shard.base.MappingUpdatedProperties
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingUpdatedProperties.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/base/MappingUpdatedProperties.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Records the updated properties for a mapping update object. </p>
syntax: &o1
content: public enum MappingUpdatedProperties
inheritance:
- java.lang.Object
- java.lang.Enum<MappingUpdatedProperties>
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.All
id: All
parent: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
href: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.yml
langs:
- java
name: All
nameWithType: MappingUpdatedProperties.All
fullName: com.microsoft.azure.elasticdb.shard.base.MappingUpdatedProperties.All
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingUpdatedProperties.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public All=(1 | 2)
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
href: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.yml
langs:
- java
name: forValue(int value)
nameWithType: MappingUpdatedProperties.forValue(int value)
fullName: static MappingUpdatedProperties com.microsoft.azure.elasticdb.shard.base.MappingUpdatedProperties.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingUpdatedProperties.java
startLine: 39
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static MappingUpdatedProperties forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
href: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.yml
langs:
- java
name: getValue()
nameWithType: MappingUpdatedProperties.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.base.MappingUpdatedProperties.getValue()
overload: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingUpdatedProperties.java
startLine: 43
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.MappingUpdatedProperties(int)
id: MappingUpdatedProperties(int)
parent: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
href: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.yml
langs:
- java
name: MappingUpdatedProperties(int value)
nameWithType: MappingUpdatedProperties.MappingUpdatedProperties(int value)
fullName: com.microsoft.azure.elasticdb.shard.base.MappingUpdatedProperties.MappingUpdatedProperties(int value)
overload: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.MappingUpdatedProperties*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingUpdatedProperties.java
startLine: 23
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public MappingUpdatedProperties(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.Shard
id: Shard
parent: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
href: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.yml
langs:
- java
name: Shard
nameWithType: MappingUpdatedProperties.Shard
fullName: com.microsoft.azure.elasticdb.shard.base.MappingUpdatedProperties.Shard
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingUpdatedProperties.java
startLine: 16
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public Shard=(2)
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
href: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.yml
langs:
- java
name: SIZE
nameWithType: MappingUpdatedProperties.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.base.MappingUpdatedProperties.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingUpdatedProperties.java
startLine: 19
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.Status
id: Status
parent: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
href: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.yml
langs:
- java
name: Status
nameWithType: MappingUpdatedProperties.Status
fullName: com.microsoft.azure.elasticdb.shard.base.MappingUpdatedProperties.Status
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/MappingUpdatedProperties.java
startLine: 14
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public Status=(1)
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.MappingUpdatedProperties*
name: MappingUpdatedProperties
nameWithType: MappingUpdatedProperties.MappingUpdatedProperties
fullName: com.microsoft.azure.elasticdb.shard.base.MappingUpdatedProperties.MappingUpdatedProperties
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.getValue*
name: getValue
nameWithType: MappingUpdatedProperties.getValue
fullName: int com.microsoft.azure.elasticdb.shard.base.MappingUpdatedProperties.getValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.forValue*
name: forValue
nameWithType: MappingUpdatedProperties.forValue
fullName: static MappingUpdatedProperties com.microsoft.azure.elasticdb.shard.base.MappingUpdatedProperties.forValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.yml
name: MappingUpdatedProperties
nameWithType: MappingUpdatedProperties
fullName: com.microsoft.azure.elasticdb.shard.base.MappingUpdatedProperties
type: Enum
summary: <p>Records the updated properties for a mapping update object. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,875 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping
id: _point_mapping
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._point_mapping.clone()
- com.microsoft.azure.elasticdb.shard.base._point_mapping.equals(Object)
- com.microsoft.azure.elasticdb.shard.base._point_mapping.getId()
- com.microsoft.azure.elasticdb.shard.base._point_mapping.getKey()
- com.microsoft.azure.elasticdb.shard.base._point_mapping.getKind()
- com.microsoft.azure.elasticdb.shard.base._point_mapping.getShard()
- com.microsoft.azure.elasticdb.shard.base._point_mapping.getShardInfo()
- com.microsoft.azure.elasticdb.shard.base._point_mapping.getShardMapId()
- com.microsoft.azure.elasticdb.shard.base._point_mapping.getShardMapManager()
- com.microsoft.azure.elasticdb.shard.base._point_mapping.getStatus()
- com.microsoft.azure.elasticdb.shard.base._point_mapping.getStoreMapping()
- com.microsoft.azure.elasticdb.shard.base._point_mapping.getTypeName()
- com.microsoft.azure.elasticdb.shard.base._point_mapping.getValue()
- com.microsoft.azure.elasticdb.shard.base._point_mapping.hashCode()
- com.microsoft.azure.elasticdb.shard.base._point_mapping.PointMapping(ShardMapManager,PointMappingCreationInfo)
- com.microsoft.azure.elasticdb.shard.base._point_mapping.PointMapping(ShardMapManager,ShardMap,StoreMapping)
- com.microsoft.azure.elasticdb.shard.base._point_mapping.setKey(ShardKey)
- com.microsoft.azure.elasticdb.shard.base._point_mapping.setManager(ShardMapManager)
- com.microsoft.azure.elasticdb.shard.base._point_mapping.toString()
- com.microsoft.azure.elasticdb.shard.base._point_mapping.validate(StoreShardMap,Connection)
- com.microsoft.azure.elasticdb.shard.base._point_mapping.validateAsync(StoreShardMap,Connection)
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: PointMapping
nameWithType: PointMapping
fullName: com.microsoft.azure.elasticdb.shard.base.PointMapping
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.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/base/PointMapping.java
startLine: 32
package: com.microsoft.azure.elasticdb.shard.base
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: &o1
content: public class PointMapping implements IShardProvider<Object>,IMappingInfoProvider
inheritance:
- java.lang.Object
- com.microsoft.azure.elasticdb.shard.base._i_shard_provider
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.clone()
id: clone()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: clone()
nameWithType: PointMapping.clone()
fullName: PointMapping com.microsoft.azure.elasticdb.shard.base.PointMapping.clone()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.clone*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 283
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Clones the instance.</p>
<p></p>
syntax:
content: public PointMapping clone()
return:
type: com.microsoft.azure.elasticdb.shard.base._point_mapping
description: <p>clone of the instance. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.equals(Object)
id: equals(Object)
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: equals(Object obj)
nameWithType: PointMapping.equals(Object obj)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.PointMapping.equals(Object obj)
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 193
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Determines whether the specified object is equal to the current object.</p>
<p></p>
syntax:
content: public boolean equals(Object obj)
parameters:
- id: obj
type: "79317049"
description: <p>The object to compare with the current object. </p>
return:
type: 4fc6e284
description: <p>True if the specified object is equal to the current object; otherwise, false. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getId()
id: getId()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: getId()
nameWithType: PointMapping.getId()
fullName: UUID com.microsoft.azure.elasticdb.shard.base.PointMapping.getId()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.getId*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 148
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Identity of the mapping. </p>
syntax:
content: public UUID getId()
return:
type: add9545a
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getKey()
id: getKey()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: getKey()
nameWithType: PointMapping.getKey()
fullName: ShardKey com.microsoft.azure.elasticdb.shard.base.PointMapping.getKey()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.getKey*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 137
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public ShardKey getKey()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard_key
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getKind()
id: getKind()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: getKind()
nameWithType: PointMapping.getKind()
fullName: MappingKind com.microsoft.azure.elasticdb.shard.base.PointMapping.getKind()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.getKind*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 290
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Type of the mapping. </p>
syntax:
content: public MappingKind getKind()
return:
type: com.microsoft.azure.elasticdb.shard.base._mapping_kind
overridden: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getKind()
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getShard()
id: getShard()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: getShard()
nameWithType: PointMapping.getShard()
fullName: Shard com.microsoft.azure.elasticdb.shard.base.PointMapping.getShard()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.getShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 125
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Gets <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> that contains the key value. </p>
syntax:
content: public Shard getShard()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getShardInfo()
id: getShardInfo()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: getShardInfo()
nameWithType: PointMapping.getShardInfo()
fullName: Shard com.microsoft.azure.elasticdb.shard.base.PointMapping.getShardInfo()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.getShardInfo*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 214
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> that contains the key value. </p>
syntax:
content: public Shard getShardInfo()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getShardMapId()
id: getShardMapId()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: getShardMapId()
nameWithType: PointMapping.getShardMapId()
fullName: UUID com.microsoft.azure.elasticdb.shard.base.PointMapping.getShardMapId()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.getShardMapId*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 155
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Identify of the ShardMap this shard belongs to. </p>
syntax:
content: public UUID getShardMapId()
return:
type: add9545a
overridden: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapId()
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getShardMapManager()
id: getShardMapManager()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: getShardMapManager()
nameWithType: PointMapping.getShardMapManager()
fullName: ShardMapManager com.microsoft.azure.elasticdb.shard.base.PointMapping.getShardMapManager()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.getShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 159
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>ShardMapManager for the object. </p>
syntax:
content: public ShardMapManager getShardMapManager()
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
overridden: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapManager()
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getStatus()
id: getStatus()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: getStatus()
nameWithType: PointMapping.getStatus()
fullName: MappingStatus com.microsoft.azure.elasticdb.shard.base.PointMapping.getStatus()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.getStatus*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 115
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Gets Status of the mapping. </p>
syntax:
content: public MappingStatus getStatus()
return:
type: com.microsoft.azure.elasticdb.shard.base._mapping_status
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getStoreMapping()
id: getStoreMapping()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: getStoreMapping()
nameWithType: PointMapping.getStoreMapping()
fullName: StoreMapping com.microsoft.azure.elasticdb.shard.base.PointMapping.getStoreMapping()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.getStoreMapping*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 167
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Storage representation of the mapping. </p>
syntax:
content: public StoreMapping getStoreMapping()
return:
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
overridden: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getStoreMapping()
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getTypeName()
id: getTypeName()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: getTypeName()
nameWithType: PointMapping.getTypeName()
fullName: String com.microsoft.azure.elasticdb.shard.base.PointMapping.getTypeName()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.getTypeName*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 297
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Mapping type, useful for diagnostics. </p>
syntax:
content: public String getTypeName()
return:
type: "26831127"
overridden: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getTypeName()
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: getValue()
nameWithType: PointMapping.getValue()
fullName: Object com.microsoft.azure.elasticdb.shard.base.PointMapping.getValue()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 129
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public Object getValue()
return:
type: "79317049"
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.hashCode()
id: hashCode()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: hashCode()
nameWithType: PointMapping.hashCode()
fullName: int com.microsoft.azure.elasticdb.shard.base.PointMapping.hashCode()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.hashCode*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 207
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Calculates the hash code for this instance.</p>
<p></p>
syntax:
content: public int hashCode()
return:
type: f75371fa
description: <p>Hash code for the object. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.PointMapping(ShardMapManager,PointMappingCreationInfo)
id: PointMapping(ShardMapManager,PointMappingCreationInfo)
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: PointMapping(ShardMapManager shardMapManager, PointMappingCreationInfo creationInfo)
nameWithType: PointMapping.PointMapping(ShardMapManager shardMapManager, PointMappingCreationInfo creationInfo)
fullName: com.microsoft.azure.elasticdb.shard.base.PointMapping.PointMapping(ShardMapManager shardMapManager, PointMappingCreationInfo creationInfo)
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.PointMapping*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 69
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Constructs a point mapping given mapping creation arguments.</p>
<p></p>
syntax:
content: public PointMapping(ShardMapManager shardMapManager, PointMappingCreationInfo creationInfo)
parameters:
- id: shardMapManager
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>Owning ShardMapManager. </p>
- id: creationInfo
type: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info
description: <p>Mapping creation information. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.PointMapping(ShardMapManager,ShardMap,StoreMapping)
id: PointMapping(ShardMapManager,ShardMap,StoreMapping)
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: PointMapping(ShardMapManager shardMapManager, ShardMap shardMap, StoreMapping mapping)
nameWithType: PointMapping.PointMapping(ShardMapManager shardMapManager, ShardMap shardMap, StoreMapping mapping)
fullName: com.microsoft.azure.elasticdb.shard.base.PointMapping.PointMapping(ShardMapManager shardMapManager, ShardMap shardMap, StoreMapping mapping)
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.PointMapping*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 96
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Internal constructor used for deserialization from store representation of the mapping object.</p>
<p></p>
syntax:
content: public PointMapping(ShardMapManager shardMapManager, ShardMap shardMap, StoreMapping mapping)
parameters:
- id: shardMapManager
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>Owning ShardMapManager. </p>
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.map._shard_map
description: <p>Owning shard map. </p>
- id: mapping
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
description: <p>Storage representation of the mapping. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.setKey(ShardKey)
id: setKey(ShardKey)
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: setKey(ShardKey value)
nameWithType: PointMapping.setKey(ShardKey value)
fullName: void com.microsoft.azure.elasticdb.shard.base.PointMapping.setKey(ShardKey value)
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.setKey*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 141
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public void setKey(ShardKey value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.base._shard_key
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.setManager(ShardMapManager)
id: setManager(ShardMapManager)
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: setManager(ShardMapManager value)
nameWithType: PointMapping.setManager(ShardMapManager value)
fullName: void com.microsoft.azure.elasticdb.shard.base.PointMapping.setManager(ShardMapManager value)
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.setManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 163
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public void setManager(ShardMapManager value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.toString()
id: toString()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: toString()
nameWithType: PointMapping.toString()
fullName: String com.microsoft.azure.elasticdb.shard.base.PointMapping.toString()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.toString*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 181
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Converts the object to its string representation.</p>
<p></p>
syntax:
content: public String toString()
return:
type: "26831127"
description: <p>String representation of the object. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.validate(StoreShardMap,Connection)
id: validate(StoreShardMap,Connection)
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: validate(StoreShardMap shardMap, Connection conn)
nameWithType: PointMapping.validate(StoreShardMap shardMap, Connection conn)
fullName: void com.microsoft.azure.elasticdb.shard.base.PointMapping.validate(StoreShardMap shardMap, Connection conn)
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.validate*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 227
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Performs validation that the local representation is as up-to-date as the representation on the backing data store.</p>
<p></p>
syntax:
content: public void validate(StoreShardMap shardMap, Connection conn)
parameters:
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> map to which the shard provider belongs. </p>
- id: conn
type: 8270ccc2
description: <p>Connection used for validation. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.validateAsync(StoreShardMap,Connection)
id: validateAsync(StoreShardMap,Connection)
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping
href: com.microsoft.azure.elasticdb.shard.base._point_mapping.yml
langs:
- java
name: validateAsync(StoreShardMap shardMap, Connection conn)
nameWithType: PointMapping.validateAsync(StoreShardMap shardMap, Connection conn)
fullName: Callable com.microsoft.azure.elasticdb.shard.base.PointMapping.validateAsync(StoreShardMap shardMap, Connection conn)
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping.validateAsync*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMapping.java
startLine: 256
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Asynchronously performs validation that the local representation is as up-to-date as the representation on the backing data store.</p>
<p></p>
syntax:
content: public Callable validateAsync(StoreShardMap shardMap, Connection conn)
parameters:
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> map to which the shard provider belongs. </p>
- id: conn
type: 8270ccc2
description: <p>Connection used for validation. </p>
return:
type: b2e5ac79
description: <p>A task to await validation completion </p>
references:
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.PointMapping*
name: PointMapping
nameWithType: PointMapping.PointMapping
fullName: com.microsoft.azure.elasticdb.shard.base.PointMapping.PointMapping
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getStatus*
name: getStatus
nameWithType: PointMapping.getStatus
fullName: MappingStatus com.microsoft.azure.elasticdb.shard.base.PointMapping.getStatus
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getShard*
name: getShard
nameWithType: PointMapping.getShard
fullName: Shard com.microsoft.azure.elasticdb.shard.base.PointMapping.getShard
package: com.microsoft.azure.elasticdb.shard.base
- uid: "79317049"
spec.java:
- name: Object
fullName: Object
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getValue*
name: getValue
nameWithType: PointMapping.getValue
fullName: Object com.microsoft.azure.elasticdb.shard.base.PointMapping.getValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getKey*
name: getKey
nameWithType: PointMapping.getKey
fullName: ShardKey com.microsoft.azure.elasticdb.shard.base.PointMapping.getKey
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.setKey*
name: setKey
nameWithType: PointMapping.setKey
fullName: void com.microsoft.azure.elasticdb.shard.base.PointMapping.setKey
package: com.microsoft.azure.elasticdb.shard.base
- uid: add9545a
spec.java:
- name: UUID
fullName: UUID
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getId*
name: getId
nameWithType: PointMapping.getId
fullName: UUID com.microsoft.azure.elasticdb.shard.base.PointMapping.getId
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getShardMapId*
name: getShardMapId
nameWithType: PointMapping.getShardMapId
fullName: UUID com.microsoft.azure.elasticdb.shard.base.PointMapping.getShardMapId
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getShardMapManager*
name: getShardMapManager
nameWithType: PointMapping.getShardMapManager
fullName: ShardMapManager com.microsoft.azure.elasticdb.shard.base.PointMapping.getShardMapManager
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.setManager*
name: setManager
nameWithType: PointMapping.setManager
fullName: void com.microsoft.azure.elasticdb.shard.base.PointMapping.setManager
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getStoreMapping*
name: getStoreMapping
nameWithType: PointMapping.getStoreMapping
fullName: StoreMapping com.microsoft.azure.elasticdb.shard.base.PointMapping.getStoreMapping
package: com.microsoft.azure.elasticdb.shard.base
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.toString*
name: toString
nameWithType: PointMapping.toString
fullName: String com.microsoft.azure.elasticdb.shard.base.PointMapping.toString
package: com.microsoft.azure.elasticdb.shard.base
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.equals*
name: equals
nameWithType: PointMapping.equals
fullName: boolean com.microsoft.azure.elasticdb.shard.base.PointMapping.equals
package: com.microsoft.azure.elasticdb.shard.base
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.hashCode*
name: hashCode
nameWithType: PointMapping.hashCode
fullName: int com.microsoft.azure.elasticdb.shard.base.PointMapping.hashCode
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getShardInfo*
name: getShardInfo
nameWithType: PointMapping.getShardInfo
fullName: Shard com.microsoft.azure.elasticdb.shard.base.PointMapping.getShardInfo
package: com.microsoft.azure.elasticdb.shard.base
- uid: 8270ccc2
spec.java:
- name: Connection
fullName: Connection
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.validate*
name: validate
nameWithType: PointMapping.validate
fullName: void com.microsoft.azure.elasticdb.shard.base.PointMapping.validate
package: com.microsoft.azure.elasticdb.shard.base
- uid: b2e5ac79
spec.java:
- name: Callable
fullName: Callable
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.validateAsync*
name: validateAsync
nameWithType: PointMapping.validateAsync
fullName: Callable com.microsoft.azure.elasticdb.shard.base.PointMapping.validateAsync
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.clone*
name: clone
nameWithType: PointMapping.clone
fullName: PointMapping com.microsoft.azure.elasticdb.shard.base.PointMapping.clone
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getKind*
name: getKind
nameWithType: PointMapping.getKind
fullName: MappingKind com.microsoft.azure.elasticdb.shard.base.PointMapping.getKind
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping.getTypeName*
name: getTypeName
nameWithType: PointMapping.getTypeName
fullName: String com.microsoft.azure.elasticdb.shard.base.PointMapping.getTypeName
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._i_shard_provider
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.yml
name: IShardProvider<ValueT>
nameWithType: IShardProvider<ValueT>
fullName: com.microsoft.azure.elasticdb.shard.base.IShardProvider<ValueT>
type: Interface
summary: <p>Represents capabilities to provide a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> along with an associated value. </p>
syntax:
content: public interface IShardProvider<ValueT>
typeParameters:
- type: 0fb6b535
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
name: IMappingInfoProvider
nameWithType: IMappingInfoProvider
fullName: com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider
type: Interface
summary: <p>Interface that represents capability to provide information relevant to Add/Remove/Update operations for a mapping object. </p>
syntax:
content: public interface IMappingInfoProvider
- 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._shard_key
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_key.yml
name: ShardKey
nameWithType: ShardKey
fullName: com.microsoft.azure.elasticdb.shard.base.ShardKey
type: Class
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> key value. Wraps the type and value and allows normalization/denormalization for serialization. </p>
syntax:
content: public class ShardKey
- 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.store._store_mapping
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_mapping.yml
name: StoreMapping
nameWithType: StoreMapping
fullName: com.microsoft.azure.elasticdb.shard.store.StoreMapping
type: Class
summary: <p>Storage representation of a mapping b/w key ranges and shards. </p>
syntax:
content: public class StoreMapping
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.yml
name: PointMappingCreationInfo
nameWithType: PointMappingCreationInfo
fullName: com.microsoft.azure.elasticdb.shard.base.PointMappingCreationInfo
type: Class
summary: <p>Arguments used to create a <xref uid="com.microsoft.azure.elasticdb.shard.base._point_mapping" data-throw-if-not-resolved="false">PointMapping</xref>. </p>
syntax:
content: public class PointMappingCreationInfo
- 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.base._mapping_status
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_status.yml
name: MappingStatus
nameWithType: MappingStatus
fullName: com.microsoft.azure.elasticdb.shard.base.MappingStatus
type: Enum
summary: <p>Status of a mapping. </p>
syntax:
content: public enum MappingStatus
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapId()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
name: getShardMapId()
nameWithType: IMappingInfoProvider.getShardMapId()
fullName: UUID com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getShardMapId()
type: Method
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> map associated with the mapping. </p>
syntax:
content: public UUID getShardMapId()
return:
type: add9545a
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapManager()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
name: getShardMapManager()
nameWithType: IMappingInfoProvider.getShardMapManager()
fullName: ShardMapManager com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getShardMapManager()
type: Method
summary: <p>ShardMapManager for the object. </p>
syntax:
content: public ShardMapManager getShardMapManager()
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getStoreMapping()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
name: getStoreMapping()
nameWithType: IMappingInfoProvider.getStoreMapping()
fullName: StoreMapping com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getStoreMapping()
type: Method
summary: <p>Storage representation of the mapping. </p>
syntax:
content: public StoreMapping getStoreMapping()
return:
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
- uid: com.microsoft.azure.elasticdb.shard.store._store_shard_map
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_shard_map.yml
name: StoreShardMap
nameWithType: StoreShardMap
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShardMap
type: Class
summary: <p>Store representation of a shard map. </p>
syntax:
content: public class StoreShardMap
- 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: *o1
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_kind
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_kind.yml
name: MappingKind
nameWithType: MappingKind
fullName: com.microsoft.azure.elasticdb.shard.base.MappingKind
type: Enum
summary: <p>Types of supported mappings. </p>
syntax:
content: public enum MappingKind
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getKind()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
name: getKind()
nameWithType: IMappingInfoProvider.getKind()
fullName: MappingKind com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getKind()
type: Method
summary: <p>Type of the mapping. </p>
syntax:
content: public MappingKind getKind()
return:
type: com.microsoft.azure.elasticdb.shard.base._mapping_kind
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getTypeName()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
name: getTypeName()
nameWithType: IMappingInfoProvider.getTypeName()
fullName: String com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getTypeName()
type: Method
summary: <p>Mapping type, useful for diagnostics. </p>
syntax:
content: public String getTypeName()
return:
type: "26831127"

Просмотреть файл

@ -0,0 +1,246 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info
id: _point_mapping_creation_info
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getKey()
- com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getShard()
- com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getStatus()
- com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getValue()
- com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.PointMappingCreationInfo(Object,Shard,MappingStatus)
- com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.setKey(ShardKey)
href: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.yml
langs:
- java
name: PointMappingCreationInfo
nameWithType: PointMappingCreationInfo
fullName: com.microsoft.azure.elasticdb.shard.base.PointMappingCreationInfo
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMappingCreationInfo.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/base/PointMappingCreationInfo.java
startLine: 15
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Arguments used to create a <xref uid="com.microsoft.azure.elasticdb.shard.base._point_mapping" data-throw-if-not-resolved="false">PointMapping</xref>. </p>
syntax:
content: public class PointMappingCreationInfo
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getKey()
id: getKey()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info
href: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.yml
langs:
- java
name: getKey()
nameWithType: PointMappingCreationInfo.getKey()
fullName: ShardKey com.microsoft.azure.elasticdb.shard.base.PointMappingCreationInfo.getKey()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getKey*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMappingCreationInfo.java
startLine: 82
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public ShardKey getKey()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard_key
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getShard()
id: getShard()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info
href: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.yml
langs:
- java
name: getShard()
nameWithType: PointMappingCreationInfo.getShard()
fullName: Shard com.microsoft.azure.elasticdb.shard.base.PointMappingCreationInfo.getShard()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMappingCreationInfo.java
startLine: 66
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public Shard getShard()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getStatus()
id: getStatus()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info
href: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.yml
langs:
- java
name: getStatus()
nameWithType: PointMappingCreationInfo.getStatus()
fullName: MappingStatus com.microsoft.azure.elasticdb.shard.base.PointMappingCreationInfo.getStatus()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getStatus*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMappingCreationInfo.java
startLine: 74
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public MappingStatus getStatus()
return:
type: com.microsoft.azure.elasticdb.shard.base._mapping_status
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info
href: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.yml
langs:
- java
name: getValue()
nameWithType: PointMappingCreationInfo.getValue()
fullName: Object com.microsoft.azure.elasticdb.shard.base.PointMappingCreationInfo.getValue()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMappingCreationInfo.java
startLine: 58
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public Object getValue()
return:
type: "79317049"
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.PointMappingCreationInfo(Object,Shard,MappingStatus)
id: PointMappingCreationInfo(Object,Shard,MappingStatus)
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info
href: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.yml
langs:
- java
name: PointMappingCreationInfo(Object point, Shard shard, MappingStatus status)
nameWithType: PointMappingCreationInfo.PointMappingCreationInfo(Object point, Shard shard, MappingStatus status)
fullName: com.microsoft.azure.elasticdb.shard.base.PointMappingCreationInfo.PointMappingCreationInfo(Object point, Shard shard, MappingStatus status)
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.PointMappingCreationInfo*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMappingCreationInfo.java
startLine: 47
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Arguments used to create a point mapping.</p>
<p></p>
syntax:
content: public PointMappingCreationInfo(Object point, Shard shard, MappingStatus status)
parameters:
- id: point
type: "79317049"
description: <p>Point value being mapped. </p>
- id: shard
type: com.microsoft.azure.elasticdb.shard.base._shard
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> used as the mapping target. </p>
- id: status
type: com.microsoft.azure.elasticdb.shard.base._mapping_status
description: <p>Status of the mapping. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.setKey(ShardKey)
id: setKey(ShardKey)
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info
href: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.yml
langs:
- java
name: setKey(ShardKey value)
nameWithType: PointMappingCreationInfo.setKey(ShardKey value)
fullName: void com.microsoft.azure.elasticdb.shard.base.PointMappingCreationInfo.setKey(ShardKey value)
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.setKey*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMappingCreationInfo.java
startLine: 86
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public void setKey(ShardKey value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.base._shard_key
references:
- uid: "79317049"
spec.java:
- name: Object
fullName: Object
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.PointMappingCreationInfo*
name: PointMappingCreationInfo
nameWithType: PointMappingCreationInfo.PointMappingCreationInfo
fullName: com.microsoft.azure.elasticdb.shard.base.PointMappingCreationInfo.PointMappingCreationInfo
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getValue*
name: getValue
nameWithType: PointMappingCreationInfo.getValue
fullName: Object com.microsoft.azure.elasticdb.shard.base.PointMappingCreationInfo.getValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getShard*
name: getShard
nameWithType: PointMappingCreationInfo.getShard
fullName: Shard com.microsoft.azure.elasticdb.shard.base.PointMappingCreationInfo.getShard
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getStatus*
name: getStatus
nameWithType: PointMappingCreationInfo.getStatus
fullName: MappingStatus com.microsoft.azure.elasticdb.shard.base.PointMappingCreationInfo.getStatus
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.getKey*
name: getKey
nameWithType: PointMappingCreationInfo.getKey
fullName: ShardKey com.microsoft.azure.elasticdb.shard.base.PointMappingCreationInfo.getKey
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.setKey*
name: setKey
nameWithType: PointMappingCreationInfo.setKey
fullName: void com.microsoft.azure.elasticdb.shard.base.PointMappingCreationInfo.setKey
package: com.microsoft.azure.elasticdb.shard.base
- 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._mapping_status
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_status.yml
name: MappingStatus
nameWithType: MappingStatus
fullName: com.microsoft.azure.elasticdb.shard.base.MappingStatus
type: Enum
summary: <p>Status of a mapping. </p>
syntax:
content: public enum MappingStatus
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_key.yml
name: ShardKey
nameWithType: ShardKey
fullName: com.microsoft.azure.elasticdb.shard.base.ShardKey
type: Class
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> key value. Wraps the type and value and allows normalization/denormalization for serialization. </p>
syntax:
content: public class ShardKey
- 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 implements IShardProvider<Object>,IMappingInfoProvider

Просмотреть файл

@ -0,0 +1,242 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_update
id: _point_mapping_update
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._point_mapping_update.isBeingTakenOffline(MappingStatus,MappingStatus)
- com.microsoft.azure.elasticdb.shard.base._point_mapping_update.PointMappingUpdate()
href: com.microsoft.azure.elasticdb.shard.base._point_mapping_update.yml
langs:
- java
name: PointMappingUpdate
nameWithType: PointMappingUpdate
fullName: com.microsoft.azure.elasticdb.shard.base.PointMappingUpdate
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMappingUpdate.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/base/PointMappingUpdate.java
startLine: 14
package: com.microsoft.azure.elasticdb.shard.base
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 extends BaseMappingUpdate<MappingStatus>
inheritance:
- java.lang.Object
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update
inheritedMembers:
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getShard()
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getStatus()
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isAnyPropertySet(MappingUpdatedProperties)
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isBeingTakenOffline(StatusT,StatusT)
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isMappingBeingTakenOffline(StatusT)
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setShard(Shard)
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setStatus(StatusT)
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_update.isBeingTakenOffline(MappingStatus,MappingStatus)
id: isBeingTakenOffline(MappingStatus,MappingStatus)
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._point_mapping_update.yml
langs:
- java
name: isBeingTakenOffline(MappingStatus originalStatus, MappingStatus updatedStatus)
nameWithType: PointMappingUpdate.isBeingTakenOffline(MappingStatus originalStatus, MappingStatus updatedStatus)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.PointMappingUpdate.isBeingTakenOffline(MappingStatus originalStatus, MappingStatus updatedStatus)
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping_update.isBeingTakenOffline*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMappingUpdate.java
startLine: 33
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Detects if the current mapping is being taken offline.</p>
<p></p>
syntax:
content: protected boolean isBeingTakenOffline(MappingStatus originalStatus, MappingStatus updatedStatus)
parameters:
- id: originalStatus
type: com.microsoft.azure.elasticdb.shard.base._mapping_status
description: <p>Original status. </p>
- id: updatedStatus
type: com.microsoft.azure.elasticdb.shard.base._mapping_status
description: <p>Updated status. </p>
return:
type: 4fc6e284
description: <p>Detects in the derived types if the mapping is being taken offline. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_update.PointMappingUpdate()
id: PointMappingUpdate()
parent: com.microsoft.azure.elasticdb.shard.base._point_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._point_mapping_update.yml
langs:
- java
name: PointMappingUpdate()
nameWithType: PointMappingUpdate.PointMappingUpdate()
fullName: com.microsoft.azure.elasticdb.shard.base.PointMappingUpdate.PointMappingUpdate()
overload: com.microsoft.azure.elasticdb.shard.base._point_mapping_update.PointMappingUpdate*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/PointMappingUpdate.java
startLine: 19
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Instantiates a new point mapping update object. </p>
syntax:
content: public PointMappingUpdate()
references:
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_update.PointMappingUpdate*
name: PointMappingUpdate
nameWithType: PointMappingUpdate.PointMappingUpdate
fullName: com.microsoft.azure.elasticdb.shard.base.PointMappingUpdate.PointMappingUpdate
package: com.microsoft.azure.elasticdb.shard.base
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_update.isBeingTakenOffline*
name: isBeingTakenOffline
nameWithType: PointMappingUpdate.isBeingTakenOffline
fullName: boolean com.microsoft.azure.elasticdb.shard.base.PointMappingUpdate.isBeingTakenOffline
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getShard()
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: getShard()
nameWithType: BaseMappingUpdate<StatusT>.getShard()
fullName: final Shard com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.getShard()
type: Method
summary: <p>Gets the <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> property. </p>
syntax:
content: public final Shard getShard()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.base._shard
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getStatus()
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: getStatus()
nameWithType: BaseMappingUpdate<StatusT>.getStatus()
fullName: final StatusT com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.getStatus()
type: Method
summary: <p>Gets the Status property. </p>
syntax:
content: public final StatusT getStatus()
return:
type: 8514b11a
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isAnyPropertySet(MappingUpdatedProperties)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: isAnyPropertySet(MappingUpdatedProperties properties)
nameWithType: BaseMappingUpdate<StatusT>.isAnyPropertySet(MappingUpdatedProperties properties)
fullName: final boolean com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.isAnyPropertySet(MappingUpdatedProperties properties)
type: Method
summary: >-
<p>Checks if any property is set in the given bitmap.</p>
<p></p>
syntax:
content: public final boolean isAnyPropertySet(MappingUpdatedProperties properties)
parameters:
- id: properties
type: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
description: <p>Properties bitmap. </p>
return:
type: 4dda0764
description: <p>True if any of the properties is set, false otherwise. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isBeingTakenOffline(StatusT,StatusT)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: isBeingTakenOffline(StatusT originalStatus, StatusT updatedStatus)
nameWithType: BaseMappingUpdate<StatusT>.isBeingTakenOffline(StatusT originalStatus, StatusT updatedStatus)
fullName: abstract boolean com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.isBeingTakenOffline(StatusT originalStatus, StatusT updatedStatus)
type: Method
summary: >-
<p>Detects if the current mapping is being taken offline.</p>
<p></p>
syntax:
content: protected abstract boolean isBeingTakenOffline(StatusT originalStatus, StatusT updatedStatus)
parameters:
- id: originalStatus
type: "6102e815"
description: <p>Original status. </p>
- id: updatedStatus
type: "6102e815"
description: <p>Updated status. </p>
return:
type: 352efe7b
description: <p>Detects in the derived types if the mapping is being taken offline. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isMappingBeingTakenOffline(StatusT)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: isMappingBeingTakenOffline(StatusT originalStatus)
nameWithType: BaseMappingUpdate<StatusT>.isMappingBeingTakenOffline(StatusT originalStatus)
fullName: final boolean com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.isMappingBeingTakenOffline(StatusT originalStatus)
type: Method
summary: >-
<p>Checks if the mapping is being taken offline.</p>
<p></p>
syntax:
content: public final boolean isMappingBeingTakenOffline(StatusT originalStatus)
parameters:
- id: originalStatus
type: "6102e815"
description: <p>Original status. </p>
return:
type: 4dda0764
description: <p>True of the update will take the mapping offline. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setShard(Shard)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: setShard(Shard value)
nameWithType: BaseMappingUpdate<StatusT>.setShard(Shard value)
fullName: final void com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.setShard(Shard value)
type: Method
summary: <p>Sets the <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> property. </p>
syntax:
content: public final void setShard(Shard value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.base._shard
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setStatus(StatusT)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: setStatus(StatusT value)
nameWithType: BaseMappingUpdate<StatusT>.setStatus(StatusT value)
fullName: final void com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.setStatus(StatusT value)
type: Method
summary: <p>Sets the Status property. </p>
syntax:
content: public final void setStatus(StatusT value)
parameters:
- id: value
type: "6102e815"
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: BaseMappingUpdate<StatusT>
nameWithType: BaseMappingUpdate<StatusT>
fullName: com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>
type: Class
summary: <p>Base class for updates to mappings from shardlets to shards. </p>
syntax:
content: public class BaseMappingUpdate<StatusT> implements IMappingUpdate<StatusT>
typeParameters:
- type: "6102e815"
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_status
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_status.yml
name: MappingStatus
nameWithType: MappingStatus
fullName: com.microsoft.azure.elasticdb.shard.base.MappingStatus
type: Enum
summary: <p>Status of a mapping. </p>
syntax:
content: public enum MappingStatus

Просмотреть файл

@ -0,0 +1,358 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._range
id: _range
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._range.equals(Object)
- com.microsoft.azure.elasticdb.shard.base._range.equals(Range)
- com.microsoft.azure.elasticdb.shard.base._range.getHigh()
- com.microsoft.azure.elasticdb.shard.base._range.getLow()
- com.microsoft.azure.elasticdb.shard.base._range.getShardRange()
- com.microsoft.azure.elasticdb.shard.base._range.hashCode()
- com.microsoft.azure.elasticdb.shard.base._range.isHighMax()
- com.microsoft.azure.elasticdb.shard.base._range.Range(Object)
- com.microsoft.azure.elasticdb.shard.base._range.Range(Object,Object)
- com.microsoft.azure.elasticdb.shard.base._range.toString()
href: com.microsoft.azure.elasticdb.shard.base._range.yml
langs:
- java
name: Range
nameWithType: Range
fullName: com.microsoft.azure.elasticdb.shard.base.Range
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Range.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/base/Range.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Represents a left-inclusive, right-exclusive range of values. </p>
syntax: &o1
content: public class Range
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.base._range.equals(Object)
id: equals(Object)
parent: com.microsoft.azure.elasticdb.shard.base._range
href: com.microsoft.azure.elasticdb.shard.base._range.yml
langs:
- java
name: equals(Object obj)
nameWithType: Range.equals(Object obj)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.Range.equals(Object obj)
overload: com.microsoft.azure.elasticdb.shard.base._range.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Range.java
startLine: 110
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Determines whether the specified object is equal to the current object.</p>
<p></p>
syntax:
content: public boolean equals(Object obj)
parameters:
- id: obj
type: "79317049"
description: <p>The object to compare with the current object. </p>
return:
type: 4fc6e284
description: <p>True if the specified object is equal to the current object; otherwise, false. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._range.equals(Range)
id: equals(Range)
parent: com.microsoft.azure.elasticdb.shard.base._range
href: com.microsoft.azure.elasticdb.shard.base._range.yml
langs:
- java
name: equals(Range other)
nameWithType: Range.equals(Range other)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.Range.equals(Range other)
overload: com.microsoft.azure.elasticdb.shard.base._range.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Range.java
startLine: 121
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Performs equality comparison with another <xref uid="com.microsoft.azure.elasticdb.shard.base._range" data-throw-if-not-resolved="false">Range</xref>.</p>
<p></p>
syntax:
content: public boolean equals(Range other)
parameters:
- id: other
type: com.microsoft.azure.elasticdb.shard.base._range
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._range" data-throw-if-not-resolved="false">Range</xref> to compare with. </p>
return:
type: 4fc6e284
description: <p>True if same <xref uid="com.microsoft.azure.elasticdb.shard.base._range" data-throw-if-not-resolved="false">Range</xref>, false otherwise. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._range.getHigh()
id: getHigh()
parent: com.microsoft.azure.elasticdb.shard.base._range
href: com.microsoft.azure.elasticdb.shard.base._range.yml
langs:
- java
name: getHigh()
nameWithType: Range.getHigh()
fullName: Object com.microsoft.azure.elasticdb.shard.base.Range.getHigh()
overload: com.microsoft.azure.elasticdb.shard.base._range.getHigh*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Range.java
startLine: 70
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public Object getHigh()
return:
type: "79317049"
- uid: com.microsoft.azure.elasticdb.shard.base._range.getLow()
id: getLow()
parent: com.microsoft.azure.elasticdb.shard.base._range
href: com.microsoft.azure.elasticdb.shard.base._range.yml
langs:
- java
name: getLow()
nameWithType: Range.getLow()
fullName: Object com.microsoft.azure.elasticdb.shard.base.Range.getLow()
overload: com.microsoft.azure.elasticdb.shard.base._range.getLow*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Range.java
startLine: 66
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public Object getLow()
return:
type: "79317049"
- uid: com.microsoft.azure.elasticdb.shard.base._range.getShardRange()
id: getShardRange()
parent: com.microsoft.azure.elasticdb.shard.base._range
href: com.microsoft.azure.elasticdb.shard.base._range.yml
langs:
- java
name: getShardRange()
nameWithType: Range.getShardRange()
fullName: ShardRange com.microsoft.azure.elasticdb.shard.base.Range.getShardRange()
overload: com.microsoft.azure.elasticdb.shard.base._range.getShardRange*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Range.java
startLine: 62
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public ShardRange getShardRange()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard_range
- uid: com.microsoft.azure.elasticdb.shard.base._range.hashCode()
id: hashCode()
parent: com.microsoft.azure.elasticdb.shard.base._range
href: com.microsoft.azure.elasticdb.shard.base._range.yml
langs:
- java
name: hashCode()
nameWithType: Range.hashCode()
fullName: int com.microsoft.azure.elasticdb.shard.base.Range.hashCode()
overload: com.microsoft.azure.elasticdb.shard.base._range.hashCode*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Range.java
startLine: 98
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Calculates the hash code for this instance.</p>
<p></p>
syntax:
content: public int hashCode()
return:
type: f75371fa
description: <p>Hash code for the object. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._range.isHighMax()
id: isHighMax()
parent: com.microsoft.azure.elasticdb.shard.base._range
href: com.microsoft.azure.elasticdb.shard.base._range.yml
langs:
- java
name: isHighMax()
nameWithType: Range.isHighMax()
fullName: boolean com.microsoft.azure.elasticdb.shard.base.Range.isHighMax()
overload: com.microsoft.azure.elasticdb.shard.base._range.isHighMax*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Range.java
startLine: 74
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public boolean isHighMax()
return:
type: 4fc6e284
- uid: com.microsoft.azure.elasticdb.shard.base._range.Range(Object)
id: Range(Object)
parent: com.microsoft.azure.elasticdb.shard.base._range
href: com.microsoft.azure.elasticdb.shard.base._range.yml
langs:
- java
name: Range(Object low)
nameWithType: Range.Range(Object low)
fullName: com.microsoft.azure.elasticdb.shard.base.Range.Range(Object low)
overload: com.microsoft.azure.elasticdb.shard.base._range.Range*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Range.java
startLine: 55
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Constructs range based on its low boundary value. The low boundary value is set to the one specified in <em>low</em> while the high boundary value is set to maximum possible value i.e. +infinity.</p>
<p></p>
syntax:
content: public Range(Object low)
parameters:
- id: low
type: "79317049"
description: <p>Low boundary value (inclusive). </p>
- uid: com.microsoft.azure.elasticdb.shard.base._range.Range(Object,Object)
id: Range(Object,Object)
parent: com.microsoft.azure.elasticdb.shard.base._range
href: com.microsoft.azure.elasticdb.shard.base._range.yml
langs:
- java
name: Range(Object low, Object high)
nameWithType: Range.Range(Object low, Object high)
fullName: com.microsoft.azure.elasticdb.shard.base.Range.Range(Object low, Object high)
overload: com.microsoft.azure.elasticdb.shard.base._range.Range*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Range.java
startLine: 40
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Constructs range based on its low and high boundary values.</p>
<p></p>
syntax:
content: public Range(Object low, Object high)
parameters:
- id: low
type: "79317049"
description: <p>Low boundary value (inclusive). </p>
- id: high
type: "79317049"
description: <p>High boundary value (exclusive). </p>
- uid: com.microsoft.azure.elasticdb.shard.base._range.toString()
id: toString()
parent: com.microsoft.azure.elasticdb.shard.base._range
href: com.microsoft.azure.elasticdb.shard.base._range.yml
langs:
- java
name: toString()
nameWithType: Range.toString()
fullName: String com.microsoft.azure.elasticdb.shard.base.Range.toString()
overload: com.microsoft.azure.elasticdb.shard.base._range.toString*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Range.java
startLine: 88
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Converts the object to its string representation.</p>
<p></p>
syntax:
content: public String toString()
return:
type: "26831127"
description: <p>String representation of the object. </p>
references:
- uid: "79317049"
spec.java:
- name: Object
fullName: Object
- uid: com.microsoft.azure.elasticdb.shard.base._range.Range*
name: Range
nameWithType: Range.Range
fullName: com.microsoft.azure.elasticdb.shard.base.Range.Range
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range.getShardRange*
name: getShardRange
nameWithType: Range.getShardRange
fullName: ShardRange com.microsoft.azure.elasticdb.shard.base.Range.getShardRange
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range.getLow*
name: getLow
nameWithType: Range.getLow
fullName: Object com.microsoft.azure.elasticdb.shard.base.Range.getLow
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range.getHigh*
name: getHigh
nameWithType: Range.getHigh
fullName: Object com.microsoft.azure.elasticdb.shard.base.Range.getHigh
package: com.microsoft.azure.elasticdb.shard.base
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.base._range.isHighMax*
name: isHighMax
nameWithType: Range.isHighMax
fullName: boolean com.microsoft.azure.elasticdb.shard.base.Range.isHighMax
package: com.microsoft.azure.elasticdb.shard.base
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: com.microsoft.azure.elasticdb.shard.base._range.toString*
name: toString
nameWithType: Range.toString
fullName: String com.microsoft.azure.elasticdb.shard.base.Range.toString
package: com.microsoft.azure.elasticdb.shard.base
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.base._range.hashCode*
name: hashCode
nameWithType: Range.hashCode
fullName: int com.microsoft.azure.elasticdb.shard.base.Range.hashCode
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range.equals*
name: equals
nameWithType: Range.equals
fullName: boolean com.microsoft.azure.elasticdb.shard.base.Range.equals
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_range
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_range.yml
name: ShardRange
nameWithType: ShardRange
fullName: com.microsoft.azure.elasticdb.shard.base.ShardRange
type: Class
summary: <p>A range of shard keys between a low key and a high key. The low key is inclusive (part of the range) while the high key is exclusive (not part of the range). The <xref uid="com.microsoft.azure.elasticdb.shard.base._shard_range" data-throw-if-not-resolved="false">ShardRange</xref> class is immutable. </p>
syntax:
content: public class ShardRange
- 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: *o1

Просмотреть файл

@ -0,0 +1,882 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping
id: _range_mapping
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._range_mapping.clone()
- com.microsoft.azure.elasticdb.shard.base._range_mapping.equals(Object)
- com.microsoft.azure.elasticdb.shard.base._range_mapping.getId()
- com.microsoft.azure.elasticdb.shard.base._range_mapping.getKind()
- com.microsoft.azure.elasticdb.shard.base._range_mapping.getRange()
- com.microsoft.azure.elasticdb.shard.base._range_mapping.getShard()
- com.microsoft.azure.elasticdb.shard.base._range_mapping.getShardInfo()
- com.microsoft.azure.elasticdb.shard.base._range_mapping.getShardMapId()
- com.microsoft.azure.elasticdb.shard.base._range_mapping.getShardMapManager()
- com.microsoft.azure.elasticdb.shard.base._range_mapping.getStatus()
- com.microsoft.azure.elasticdb.shard.base._range_mapping.getStoreMapping()
- com.microsoft.azure.elasticdb.shard.base._range_mapping.getTypeName()
- com.microsoft.azure.elasticdb.shard.base._range_mapping.getValue()
- com.microsoft.azure.elasticdb.shard.base._range_mapping.hashCode()
- com.microsoft.azure.elasticdb.shard.base._range_mapping.RangeMapping(ShardMapManager,RangeMappingCreationInfo)
- com.microsoft.azure.elasticdb.shard.base._range_mapping.RangeMapping(ShardMapManager,ShardMap,StoreMapping)
- com.microsoft.azure.elasticdb.shard.base._range_mapping.setRange(ShardRange)
- com.microsoft.azure.elasticdb.shard.base._range_mapping.setShardMapManager(ShardMapManager)
- com.microsoft.azure.elasticdb.shard.base._range_mapping.toString()
- com.microsoft.azure.elasticdb.shard.base._range_mapping.validate(StoreShardMap,Connection)
- com.microsoft.azure.elasticdb.shard.base._range_mapping.validateAsync(StoreShardMap,Connection)
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: RangeMapping
nameWithType: RangeMapping
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.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/base/RangeMapping.java
startLine: 31
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Represents a mapping between a range of key values and a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>. </p>
syntax: &o1
content: public class RangeMapping implements IShardProvider<Range>,IMappingInfoProvider
inheritance:
- java.lang.Object
- com.microsoft.azure.elasticdb.shard.base._i_shard_provider
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.clone()
id: clone()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: clone()
nameWithType: RangeMapping.clone()
fullName: RangeMapping com.microsoft.azure.elasticdb.shard.base.RangeMapping.clone()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.clone*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 293
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Clones the instance which implements the interface.</p>
<p></p>
syntax:
content: public RangeMapping clone()
return:
type: com.microsoft.azure.elasticdb.shard.base._range_mapping
description: <p>clone of the instance. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.equals(Object)
id: equals(Object)
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: equals(Object obj)
nameWithType: RangeMapping.equals(Object obj)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.RangeMapping.equals(Object obj)
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 198
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Determines whether the specified object is equal to the current object.</p>
<p></p>
syntax:
content: public boolean equals(Object obj)
parameters:
- id: obj
type: "79317049"
description: <p>The object to compare with the current object. </p>
return:
type: 4fc6e284
description: <p>True if the specified object is equal to the current object; otherwise, false. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getId()
id: getId()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: getId()
nameWithType: RangeMapping.getId()
fullName: UUID com.microsoft.azure.elasticdb.shard.base.RangeMapping.getId()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.getId*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 153
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Identity of the mapping. </p>
syntax:
content: public UUID getId()
return:
type: add9545a
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getKind()
id: getKind()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: getKind()
nameWithType: RangeMapping.getKind()
fullName: MappingKind com.microsoft.azure.elasticdb.shard.base.RangeMapping.getKind()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.getKind*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 300
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Type of the mapping. </p>
syntax:
content: public MappingKind getKind()
return:
type: com.microsoft.azure.elasticdb.shard.base._mapping_kind
overridden: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getKind()
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getRange()
id: getRange()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: getRange()
nameWithType: RangeMapping.getRange()
fullName: ShardRange com.microsoft.azure.elasticdb.shard.base.RangeMapping.getRange()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.getRange*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 142
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public ShardRange getRange()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard_range
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getShard()
id: getShard()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: getShard()
nameWithType: RangeMapping.getShard()
fullName: Shard com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShard()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.getShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 130
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Gets <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> that contains the range of values. </p>
syntax:
content: public Shard getShard()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getShardInfo()
id: getShardInfo()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: getShardInfo()
nameWithType: RangeMapping.getShardInfo()
fullName: Shard com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShardInfo()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.getShardInfo*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 223
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> that contains the range of values. </p>
syntax:
content: public Shard getShardInfo()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getShardMapId()
id: getShardMapId()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: getShardMapId()
nameWithType: RangeMapping.getShardMapId()
fullName: UUID com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShardMapId()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.getShardMapId*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 160
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Identify of the ShardMap this shard belongs to. </p>
syntax:
content: public UUID getShardMapId()
return:
type: add9545a
overridden: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapId()
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getShardMapManager()
id: getShardMapManager()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: getShardMapManager()
nameWithType: RangeMapping.getShardMapManager()
fullName: ShardMapManager com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShardMapManager()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.getShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 164
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>ShardMapManager for the object. </p>
syntax:
content: public ShardMapManager getShardMapManager()
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
overridden: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapManager()
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getStatus()
id: getStatus()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: getStatus()
nameWithType: RangeMapping.getStatus()
fullName: MappingStatus com.microsoft.azure.elasticdb.shard.base.RangeMapping.getStatus()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.getStatus*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 120
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Gets the <xref uid="com.microsoft.azure.elasticdb.shard.base._mapping_status" data-throw-if-not-resolved="false">MappingStatus</xref> of the mapping. </p>
syntax:
content: public MappingStatus getStatus()
return:
type: com.microsoft.azure.elasticdb.shard.base._mapping_status
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getStoreMapping()
id: getStoreMapping()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: getStoreMapping()
nameWithType: RangeMapping.getStoreMapping()
fullName: StoreMapping com.microsoft.azure.elasticdb.shard.base.RangeMapping.getStoreMapping()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.getStoreMapping*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 172
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Storage representation of the mapping. </p>
syntax:
content: public StoreMapping getStoreMapping()
return:
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
overridden: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getStoreMapping()
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getTypeName()
id: getTypeName()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: getTypeName()
nameWithType: RangeMapping.getTypeName()
fullName: String com.microsoft.azure.elasticdb.shard.base.RangeMapping.getTypeName()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.getTypeName*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 307
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Mapping type, useful for diagnostics. </p>
syntax:
content: public String getTypeName()
return:
type: "26831127"
overridden: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getTypeName()
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: getValue()
nameWithType: RangeMapping.getValue()
fullName: Range com.microsoft.azure.elasticdb.shard.base.RangeMapping.getValue()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 134
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public Range getValue()
return:
type: com.microsoft.azure.elasticdb.shard.base._range
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.hashCode()
id: hashCode()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: hashCode()
nameWithType: RangeMapping.hashCode()
fullName: int com.microsoft.azure.elasticdb.shard.base.RangeMapping.hashCode()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.hashCode*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 216
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Calculates the hash code for this instance.</p>
<p></p>
syntax:
content: public int hashCode()
return:
type: f75371fa
description: <p>Hash code for the object. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.RangeMapping(ShardMapManager,RangeMappingCreationInfo)
id: RangeMapping(ShardMapManager,RangeMappingCreationInfo)
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: RangeMapping(ShardMapManager shardMapManager, RangeMappingCreationInfo creationInfo)
nameWithType: RangeMapping.RangeMapping(ShardMapManager shardMapManager, RangeMappingCreationInfo creationInfo)
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.RangeMapping(ShardMapManager shardMapManager, RangeMappingCreationInfo creationInfo)
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.RangeMapping*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 68
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Constructs a range mapping given mapping creation arguments.</p>
<p></p>
syntax:
content: public RangeMapping(ShardMapManager shardMapManager, RangeMappingCreationInfo creationInfo)
parameters:
- id: shardMapManager
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>Owning ShardMapManager. </p>
- id: creationInfo
type: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info
description: <p>Mapping creation information. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.RangeMapping(ShardMapManager,ShardMap,StoreMapping)
id: RangeMapping(ShardMapManager,ShardMap,StoreMapping)
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: RangeMapping(ShardMapManager shardMapManager, ShardMap shardMap, StoreMapping mapping)
nameWithType: RangeMapping.RangeMapping(ShardMapManager shardMapManager, ShardMap shardMap, StoreMapping mapping)
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.RangeMapping(ShardMapManager shardMapManager, ShardMap shardMap, StoreMapping mapping)
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.RangeMapping*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 94
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Internal constructor used for deserialization from store representation of the mapping object.</p>
<p></p>
syntax:
content: public RangeMapping(ShardMapManager shardMapManager, ShardMap shardMap, StoreMapping mapping)
parameters:
- id: shardMapManager
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>Owning ShardMapManager. </p>
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.map._shard_map
description: <p>Owning shard map. </p>
- id: mapping
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
description: <p>Storage representation of the mapping. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.setRange(ShardRange)
id: setRange(ShardRange)
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: setRange(ShardRange value)
nameWithType: RangeMapping.setRange(ShardRange value)
fullName: void com.microsoft.azure.elasticdb.shard.base.RangeMapping.setRange(ShardRange value)
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.setRange*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 146
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public void setRange(ShardRange value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.base._shard_range
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.setShardMapManager(ShardMapManager)
id: setShardMapManager(ShardMapManager)
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: setShardMapManager(ShardMapManager value)
nameWithType: RangeMapping.setShardMapManager(ShardMapManager value)
fullName: void com.microsoft.azure.elasticdb.shard.base.RangeMapping.setShardMapManager(ShardMapManager value)
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.setShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 168
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public void setShardMapManager(ShardMapManager value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.toString()
id: toString()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: toString()
nameWithType: RangeMapping.toString()
fullName: String com.microsoft.azure.elasticdb.shard.base.RangeMapping.toString()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.toString*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 186
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Converts the object to its string representation.</p>
<p></p>
syntax:
content: public String toString()
return:
type: "26831127"
description: <p>String representation of the object. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.validate(StoreShardMap,Connection)
id: validate(StoreShardMap,Connection)
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: validate(StoreShardMap shardMap, Connection conn)
nameWithType: RangeMapping.validate(StoreShardMap shardMap, Connection conn)
fullName: void com.microsoft.azure.elasticdb.shard.base.RangeMapping.validate(StoreShardMap shardMap, Connection conn)
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.validate*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 236
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Performs validation that the local representation is as up-to-date as the representation on the backing data store.</p>
<p></p>
syntax:
content: public void validate(StoreShardMap shardMap, Connection conn)
parameters:
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> map to which the shard provider belongs. </p>
- id: conn
type: 8270ccc2
description: <p>Connection used for validation. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.validateAsync(StoreShardMap,Connection)
id: validateAsync(StoreShardMap,Connection)
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
langs:
- java
name: validateAsync(StoreShardMap shardMap, Connection conn)
nameWithType: RangeMapping.validateAsync(StoreShardMap shardMap, Connection conn)
fullName: Callable com.microsoft.azure.elasticdb.shard.base.RangeMapping.validateAsync(StoreShardMap shardMap, Connection conn)
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping.validateAsync*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMapping.java
startLine: 266
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Asynchronously performs validation that the local representation is as up-to-date as the representation on the backing data store.</p>
<p></p>
syntax:
content: public Callable validateAsync(StoreShardMap shardMap, Connection conn)
parameters:
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> map to which the shard provider belongs. </p>
- id: conn
type: 8270ccc2
description: <p>Connection used for validation. </p>
return:
type: b2e5ac79
description: <p>A task to await validation completion </p>
references:
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.RangeMapping*
name: RangeMapping
nameWithType: RangeMapping.RangeMapping
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.RangeMapping
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getStatus*
name: getStatus
nameWithType: RangeMapping.getStatus
fullName: MappingStatus com.microsoft.azure.elasticdb.shard.base.RangeMapping.getStatus
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getShard*
name: getShard
nameWithType: RangeMapping.getShard
fullName: Shard com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShard
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getValue*
name: getValue
nameWithType: RangeMapping.getValue
fullName: Range com.microsoft.azure.elasticdb.shard.base.RangeMapping.getValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getRange*
name: getRange
nameWithType: RangeMapping.getRange
fullName: ShardRange com.microsoft.azure.elasticdb.shard.base.RangeMapping.getRange
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.setRange*
name: setRange
nameWithType: RangeMapping.setRange
fullName: void com.microsoft.azure.elasticdb.shard.base.RangeMapping.setRange
package: com.microsoft.azure.elasticdb.shard.base
- uid: add9545a
spec.java:
- name: UUID
fullName: UUID
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getId*
name: getId
nameWithType: RangeMapping.getId
fullName: UUID com.microsoft.azure.elasticdb.shard.base.RangeMapping.getId
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getShardMapId*
name: getShardMapId
nameWithType: RangeMapping.getShardMapId
fullName: UUID com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShardMapId
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getShardMapManager*
name: getShardMapManager
nameWithType: RangeMapping.getShardMapManager
fullName: ShardMapManager com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShardMapManager
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.setShardMapManager*
name: setShardMapManager
nameWithType: RangeMapping.setShardMapManager
fullName: void com.microsoft.azure.elasticdb.shard.base.RangeMapping.setShardMapManager
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getStoreMapping*
name: getStoreMapping
nameWithType: RangeMapping.getStoreMapping
fullName: StoreMapping com.microsoft.azure.elasticdb.shard.base.RangeMapping.getStoreMapping
package: com.microsoft.azure.elasticdb.shard.base
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.toString*
name: toString
nameWithType: RangeMapping.toString
fullName: String com.microsoft.azure.elasticdb.shard.base.RangeMapping.toString
package: com.microsoft.azure.elasticdb.shard.base
- uid: "79317049"
spec.java:
- name: Object
fullName: Object
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.equals*
name: equals
nameWithType: RangeMapping.equals
fullName: boolean com.microsoft.azure.elasticdb.shard.base.RangeMapping.equals
package: com.microsoft.azure.elasticdb.shard.base
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.hashCode*
name: hashCode
nameWithType: RangeMapping.hashCode
fullName: int com.microsoft.azure.elasticdb.shard.base.RangeMapping.hashCode
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getShardInfo*
name: getShardInfo
nameWithType: RangeMapping.getShardInfo
fullName: Shard com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShardInfo
package: com.microsoft.azure.elasticdb.shard.base
- uid: 8270ccc2
spec.java:
- name: Connection
fullName: Connection
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.validate*
name: validate
nameWithType: RangeMapping.validate
fullName: void com.microsoft.azure.elasticdb.shard.base.RangeMapping.validate
package: com.microsoft.azure.elasticdb.shard.base
- uid: b2e5ac79
spec.java:
- name: Callable
fullName: Callable
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.validateAsync*
name: validateAsync
nameWithType: RangeMapping.validateAsync
fullName: Callable com.microsoft.azure.elasticdb.shard.base.RangeMapping.validateAsync
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.clone*
name: clone
nameWithType: RangeMapping.clone
fullName: RangeMapping com.microsoft.azure.elasticdb.shard.base.RangeMapping.clone
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getKind*
name: getKind
nameWithType: RangeMapping.getKind
fullName: MappingKind com.microsoft.azure.elasticdb.shard.base.RangeMapping.getKind
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping.getTypeName*
name: getTypeName
nameWithType: RangeMapping.getTypeName
fullName: String com.microsoft.azure.elasticdb.shard.base.RangeMapping.getTypeName
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._i_shard_provider
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.yml
name: IShardProvider<ValueT>
nameWithType: IShardProvider<ValueT>
fullName: com.microsoft.azure.elasticdb.shard.base.IShardProvider<ValueT>
type: Interface
summary: <p>Represents capabilities to provide a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> along with an associated value. </p>
syntax:
content: public interface IShardProvider<ValueT>
typeParameters:
- type: 0fb6b535
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
name: IMappingInfoProvider
nameWithType: IMappingInfoProvider
fullName: com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider
type: Interface
summary: <p>Interface that represents capability to provide information relevant to Add/Remove/Update operations for a mapping object. </p>
syntax:
content: public interface IMappingInfoProvider
- 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._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_range
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_range.yml
name: ShardRange
nameWithType: ShardRange
fullName: com.microsoft.azure.elasticdb.shard.base.ShardRange
type: Class
summary: <p>A range of shard keys between a low key and a high key. The low key is inclusive (part of the range) while the high key is exclusive (not part of the range). The <xref uid="com.microsoft.azure.elasticdb.shard.base._shard_range" data-throw-if-not-resolved="false">ShardRange</xref> class is immutable. </p>
syntax:
content: public class ShardRange
- 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.store._store_mapping
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_mapping.yml
name: StoreMapping
nameWithType: StoreMapping
fullName: com.microsoft.azure.elasticdb.shard.store.StoreMapping
type: Class
summary: <p>Storage representation of a mapping b/w key ranges and shards. </p>
syntax:
content: public class StoreMapping
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.yml
name: RangeMappingCreationInfo
nameWithType: RangeMappingCreationInfo
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo
type: Class
summary: <p>Arguments used to create a <xref uid="com.microsoft.azure.elasticdb.shard.base._range_mapping" data-throw-if-not-resolved="false">RangeMapping</xref>. </p>
syntax:
content: public class RangeMappingCreationInfo
- 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.base._mapping_status
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_status.yml
name: MappingStatus
nameWithType: MappingStatus
fullName: com.microsoft.azure.elasticdb.shard.base.MappingStatus
type: Enum
summary: <p>Status of a mapping. </p>
syntax:
content: public enum MappingStatus
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapId()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
name: getShardMapId()
nameWithType: IMappingInfoProvider.getShardMapId()
fullName: UUID com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getShardMapId()
type: Method
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> map associated with the mapping. </p>
syntax:
content: public UUID getShardMapId()
return:
type: add9545a
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getShardMapManager()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
name: getShardMapManager()
nameWithType: IMappingInfoProvider.getShardMapManager()
fullName: ShardMapManager com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getShardMapManager()
type: Method
summary: <p>ShardMapManager for the object. </p>
syntax:
content: public ShardMapManager getShardMapManager()
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getStoreMapping()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
name: getStoreMapping()
nameWithType: IMappingInfoProvider.getStoreMapping()
fullName: StoreMapping com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getStoreMapping()
type: Method
summary: <p>Storage representation of the mapping. </p>
syntax:
content: public StoreMapping getStoreMapping()
return:
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
- uid: com.microsoft.azure.elasticdb.shard.store._store_shard_map
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_shard_map.yml
name: StoreShardMap
nameWithType: StoreShardMap
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShardMap
type: Class
summary: <p>Store representation of a shard map. </p>
syntax:
content: public class StoreShardMap
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
name: RangeMapping
nameWithType: RangeMapping
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping
type: Class
summary: <p>Represents a mapping between a range of key values and a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>. </p>
syntax: *o1
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_kind
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_kind.yml
name: MappingKind
nameWithType: MappingKind
fullName: com.microsoft.azure.elasticdb.shard.base.MappingKind
type: Enum
summary: <p>Types of supported mappings. </p>
syntax:
content: public enum MappingKind
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getKind()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
name: getKind()
nameWithType: IMappingInfoProvider.getKind()
fullName: MappingKind com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getKind()
type: Method
summary: <p>Type of the mapping. </p>
syntax:
content: public MappingKind getKind()
return:
type: com.microsoft.azure.elasticdb.shard.base._mapping_kind
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.getTypeName()
parent: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
name: getTypeName()
nameWithType: IMappingInfoProvider.getTypeName()
fullName: String com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getTypeName()
type: Method
summary: <p>Mapping type, useful for diagnostics. </p>
syntax:
content: public String getTypeName()
return:
type: "26831127"

Просмотреть файл

@ -0,0 +1,252 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info
id: _range_mapping_creation_info
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getRange()
- com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getShard()
- com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getStatus()
- com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getValue()
- com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.RangeMappingCreationInfo(Range,Shard,MappingStatus)
- com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.setRange(ShardRange)
href: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.yml
langs:
- java
name: RangeMappingCreationInfo
nameWithType: RangeMappingCreationInfo
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMappingCreationInfo.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/base/RangeMappingCreationInfo.java
startLine: 15
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Arguments used to create a <xref uid="com.microsoft.azure.elasticdb.shard.base._range_mapping" data-throw-if-not-resolved="false">RangeMapping</xref>. </p>
syntax:
content: public class RangeMappingCreationInfo
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getRange()
id: getRange()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info
href: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.yml
langs:
- java
name: getRange()
nameWithType: RangeMappingCreationInfo.getRange()
fullName: ShardRange com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo.getRange()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getRange*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMappingCreationInfo.java
startLine: 84
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public ShardRange getRange()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard_range
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getShard()
id: getShard()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info
href: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.yml
langs:
- java
name: getShard()
nameWithType: RangeMappingCreationInfo.getShard()
fullName: Shard com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo.getShard()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMappingCreationInfo.java
startLine: 68
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public Shard getShard()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getStatus()
id: getStatus()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info
href: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.yml
langs:
- java
name: getStatus()
nameWithType: RangeMappingCreationInfo.getStatus()
fullName: MappingStatus com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo.getStatus()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getStatus*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMappingCreationInfo.java
startLine: 76
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public MappingStatus getStatus()
return:
type: com.microsoft.azure.elasticdb.shard.base._mapping_status
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info
href: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.yml
langs:
- java
name: getValue()
nameWithType: RangeMappingCreationInfo.getValue()
fullName: Range com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo.getValue()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMappingCreationInfo.java
startLine: 60
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public Range getValue()
return:
type: com.microsoft.azure.elasticdb.shard.base._range
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.RangeMappingCreationInfo(Range,Shard,MappingStatus)
id: RangeMappingCreationInfo(Range,Shard,MappingStatus)
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info
href: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.yml
langs:
- java
name: RangeMappingCreationInfo(Range value, Shard shard, MappingStatus status)
nameWithType: RangeMappingCreationInfo.RangeMappingCreationInfo(Range value, Shard shard, MappingStatus status)
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo.RangeMappingCreationInfo(Range value, Shard shard, MappingStatus status)
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.RangeMappingCreationInfo*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMappingCreationInfo.java
startLine: 47
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Arguments used for creation of a range mapping.</p>
<p></p>
syntax:
content: public RangeMappingCreationInfo(Range value, Shard shard, MappingStatus status)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.base._range
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._range" data-throw-if-not-resolved="false">Range</xref> being mapped. </p>
- id: shard
type: com.microsoft.azure.elasticdb.shard.base._shard
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> used as the mapping target. </p>
- id: status
type: com.microsoft.azure.elasticdb.shard.base._mapping_status
description: <p>Status of the mapping. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.setRange(ShardRange)
id: setRange(ShardRange)
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info
href: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.yml
langs:
- java
name: setRange(ShardRange value)
nameWithType: RangeMappingCreationInfo.setRange(ShardRange value)
fullName: void com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo.setRange(ShardRange value)
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.setRange*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMappingCreationInfo.java
startLine: 88
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public void setRange(ShardRange value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.base._shard_range
references:
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.RangeMappingCreationInfo*
name: RangeMappingCreationInfo
nameWithType: RangeMappingCreationInfo.RangeMappingCreationInfo
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo.RangeMappingCreationInfo
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getValue*
name: getValue
nameWithType: RangeMappingCreationInfo.getValue
fullName: Range com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo.getValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getShard*
name: getShard
nameWithType: RangeMappingCreationInfo.getShard
fullName: Shard com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo.getShard
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getStatus*
name: getStatus
nameWithType: RangeMappingCreationInfo.getStatus
fullName: MappingStatus com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo.getStatus
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.getRange*
name: getRange
nameWithType: RangeMappingCreationInfo.getRange
fullName: ShardRange com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo.getRange
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.setRange*
name: setRange
nameWithType: RangeMappingCreationInfo.setRange
fullName: void com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo.setRange
package: com.microsoft.azure.elasticdb.shard.base
- 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._mapping_status
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_status.yml
name: MappingStatus
nameWithType: MappingStatus
fullName: com.microsoft.azure.elasticdb.shard.base.MappingStatus
type: Enum
summary: <p>Status of a mapping. </p>
syntax:
content: public enum MappingStatus
- uid: com.microsoft.azure.elasticdb.shard.base._shard_range
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_range.yml
name: ShardRange
nameWithType: ShardRange
fullName: com.microsoft.azure.elasticdb.shard.base.ShardRange
type: Class
summary: <p>A range of shard keys between a low key and a high key. The low key is inclusive (part of the range) while the high key is exclusive (not part of the range). The <xref uid="com.microsoft.azure.elasticdb.shard.base._shard_range" data-throw-if-not-resolved="false">ShardRange</xref> class is immutable. </p>
syntax:
content: public class ShardRange
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
name: RangeMapping
nameWithType: RangeMapping
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping
type: Class
summary: <p>Represents a mapping between a range of key values and a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>. </p>
syntax:
content: public class RangeMapping implements IShardProvider<Range>,IMappingInfoProvider

Просмотреть файл

@ -0,0 +1,272 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_update
id: _range_mapping_update
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._range_mapping_update.isBeingTakenOffline(MappingStatus,MappingStatus)
- com.microsoft.azure.elasticdb.shard.base._range_mapping_update.RangeMappingUpdate()
href: com.microsoft.azure.elasticdb.shard.base._range_mapping_update.yml
langs:
- java
name: RangeMappingUpdate
nameWithType: RangeMappingUpdate
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMappingUpdate
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMappingUpdate.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/base/RangeMappingUpdate.java
startLine: 14
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Represents updates to a mapping between a <xref uid="com.microsoft.azure.elasticdb.shard.base._range" data-throw-if-not-resolved="false">Range</xref> of values and the <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> that stores its data. Also see <xref uid="com.microsoft.azure.elasticdb.shard.base._range_mapping" data-throw-if-not-resolved="false">RangeMapping</xref>. </p>
syntax:
content: public class RangeMappingUpdate extends BaseMappingUpdate<MappingStatus>
inheritance:
- java.lang.Object
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update
inheritedMembers:
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getShard()
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getStatus()
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isAnyPropertySet(MappingUpdatedProperties)
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isBeingTakenOffline(StatusT,StatusT)
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isMappingBeingTakenOffline(StatusT)
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setShard(Shard)
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setStatus(StatusT)
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_update.isBeingTakenOffline(MappingStatus,MappingStatus)
id: isBeingTakenOffline(MappingStatus,MappingStatus)
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._range_mapping_update.yml
langs:
- java
name: isBeingTakenOffline(MappingStatus originalStatus, MappingStatus updatedStatus)
nameWithType: RangeMappingUpdate.isBeingTakenOffline(MappingStatus originalStatus, MappingStatus updatedStatus)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.RangeMappingUpdate.isBeingTakenOffline(MappingStatus originalStatus, MappingStatus updatedStatus)
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping_update.isBeingTakenOffline*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMappingUpdate.java
startLine: 33
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Detects if the current mapping is being taken offline.</p>
<p></p>
syntax:
content: protected boolean isBeingTakenOffline(MappingStatus originalStatus, MappingStatus updatedStatus)
parameters:
- id: originalStatus
type: com.microsoft.azure.elasticdb.shard.base._mapping_status
description: <p>Original status. </p>
- id: updatedStatus
type: com.microsoft.azure.elasticdb.shard.base._mapping_status
description: <p>Updated status. </p>
return:
type: 4fc6e284
description: <p>Detects in the derived types if the mapping is being taken offline. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_update.RangeMappingUpdate()
id: RangeMappingUpdate()
parent: com.microsoft.azure.elasticdb.shard.base._range_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._range_mapping_update.yml
langs:
- java
name: RangeMappingUpdate()
nameWithType: RangeMappingUpdate.RangeMappingUpdate()
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMappingUpdate.RangeMappingUpdate()
overload: com.microsoft.azure.elasticdb.shard.base._range_mapping_update.RangeMappingUpdate*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/RangeMappingUpdate.java
startLine: 19
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Instantiates a new range mapping update object. </p>
syntax:
content: public RangeMappingUpdate()
references:
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_update.RangeMappingUpdate*
name: RangeMappingUpdate
nameWithType: RangeMappingUpdate.RangeMappingUpdate
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMappingUpdate.RangeMappingUpdate
package: com.microsoft.azure.elasticdb.shard.base
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_update.isBeingTakenOffline*
name: isBeingTakenOffline
nameWithType: RangeMappingUpdate.isBeingTakenOffline
fullName: boolean com.microsoft.azure.elasticdb.shard.base.RangeMappingUpdate.isBeingTakenOffline
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getShard()
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: getShard()
nameWithType: BaseMappingUpdate<StatusT>.getShard()
fullName: final Shard com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.getShard()
type: Method
summary: <p>Gets the <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> property. </p>
syntax:
content: public final Shard getShard()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.base._shard
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.getStatus()
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: getStatus()
nameWithType: BaseMappingUpdate<StatusT>.getStatus()
fullName: final StatusT com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.getStatus()
type: Method
summary: <p>Gets the Status property. </p>
syntax:
content: public final StatusT getStatus()
return:
type: 8514b11a
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isAnyPropertySet(MappingUpdatedProperties)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: isAnyPropertySet(MappingUpdatedProperties properties)
nameWithType: BaseMappingUpdate<StatusT>.isAnyPropertySet(MappingUpdatedProperties properties)
fullName: final boolean com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.isAnyPropertySet(MappingUpdatedProperties properties)
type: Method
summary: >-
<p>Checks if any property is set in the given bitmap.</p>
<p></p>
syntax:
content: public final boolean isAnyPropertySet(MappingUpdatedProperties properties)
parameters:
- id: properties
type: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
description: <p>Properties bitmap. </p>
return:
type: 4dda0764
description: <p>True if any of the properties is set, false otherwise. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isBeingTakenOffline(StatusT,StatusT)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: isBeingTakenOffline(StatusT originalStatus, StatusT updatedStatus)
nameWithType: BaseMappingUpdate<StatusT>.isBeingTakenOffline(StatusT originalStatus, StatusT updatedStatus)
fullName: abstract boolean com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.isBeingTakenOffline(StatusT originalStatus, StatusT updatedStatus)
type: Method
summary: >-
<p>Detects if the current mapping is being taken offline.</p>
<p></p>
syntax:
content: protected abstract boolean isBeingTakenOffline(StatusT originalStatus, StatusT updatedStatus)
parameters:
- id: originalStatus
type: "6102e815"
description: <p>Original status. </p>
- id: updatedStatus
type: "6102e815"
description: <p>Updated status. </p>
return:
type: 352efe7b
description: <p>Detects in the derived types if the mapping is being taken offline. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.isMappingBeingTakenOffline(StatusT)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: isMappingBeingTakenOffline(StatusT originalStatus)
nameWithType: BaseMappingUpdate<StatusT>.isMappingBeingTakenOffline(StatusT originalStatus)
fullName: final boolean com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.isMappingBeingTakenOffline(StatusT originalStatus)
type: Method
summary: >-
<p>Checks if the mapping is being taken offline.</p>
<p></p>
syntax:
content: public final boolean isMappingBeingTakenOffline(StatusT originalStatus)
parameters:
- id: originalStatus
type: "6102e815"
description: <p>Original status. </p>
return:
type: 4dda0764
description: <p>True of the update will take the mapping offline. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setShard(Shard)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: setShard(Shard value)
nameWithType: BaseMappingUpdate<StatusT>.setShard(Shard value)
fullName: final void com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.setShard(Shard value)
type: Method
summary: <p>Sets the <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> property. </p>
syntax:
content: public final void setShard(Shard value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.base._shard
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.setStatus(StatusT)
parent: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: setStatus(StatusT value)
nameWithType: BaseMappingUpdate<StatusT>.setStatus(StatusT value)
fullName: final void com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>.setStatus(StatusT value)
type: Method
summary: <p>Sets the Status property. </p>
syntax:
content: public final void setStatus(StatusT value)
parameters:
- id: value
type: "6102e815"
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: BaseMappingUpdate<StatusT>
nameWithType: BaseMappingUpdate<StatusT>
fullName: com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>
type: Class
summary: <p>Base class for updates to mappings from shardlets to shards. </p>
syntax:
content: public class BaseMappingUpdate<StatusT> implements IMappingUpdate<StatusT>
typeParameters:
- type: "6102e815"
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_status
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_status.yml
name: MappingStatus
nameWithType: MappingStatus
fullName: com.microsoft.azure.elasticdb.shard.base.MappingStatus
type: Enum
summary: <p>Status of a mapping. </p>
syntax:
content: public enum MappingStatus
- 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._range_mapping
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
name: RangeMapping
nameWithType: RangeMapping
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping
type: Class
summary: <p>Represents a mapping between a range of key values and a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>. </p>
syntax:
content: public class RangeMapping implements IShardProvider<Range>,IMappingInfoProvider

Просмотреть файл

@ -0,0 +1,992 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._shard
id: _shard
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._shard.clone()
- com.microsoft.azure.elasticdb.shard.base._shard.equals(Object)
- com.microsoft.azure.elasticdb.shard.base._shard.equals(Shard)
- com.microsoft.azure.elasticdb.shard.base._shard.getId()
- com.microsoft.azure.elasticdb.shard.base._shard.getLocation()
- com.microsoft.azure.elasticdb.shard.base._shard.getShardInfo()
- com.microsoft.azure.elasticdb.shard.base._shard.getShardMap()
- com.microsoft.azure.elasticdb.shard.base._shard.getShardMapId()
- com.microsoft.azure.elasticdb.shard.base._shard.getShardMapManager()
- com.microsoft.azure.elasticdb.shard.base._shard.getStatus()
- com.microsoft.azure.elasticdb.shard.base._shard.getStoreShard()
- com.microsoft.azure.elasticdb.shard.base._shard.getValue()
- com.microsoft.azure.elasticdb.shard.base._shard.getVersion()
- com.microsoft.azure.elasticdb.shard.base._shard.hashCode()
- com.microsoft.azure.elasticdb.shard.base._shard.openConnection(String)
- com.microsoft.azure.elasticdb.shard.base._shard.openConnection(String,ConnectionOptions)
- com.microsoft.azure.elasticdb.shard.base._shard.openConnectionAsync(String)
- com.microsoft.azure.elasticdb.shard.base._shard.openConnectionAsync(String,ConnectionOptions)
- com.microsoft.azure.elasticdb.shard.base._shard.setShardMap(ShardMap)
- com.microsoft.azure.elasticdb.shard.base._shard.setShardMapManager(ShardMapManager)
- com.microsoft.azure.elasticdb.shard.base._shard.setStoreShard(StoreShard)
- com.microsoft.azure.elasticdb.shard.base._shard.Shard(ShardMapManager,ShardMap,ShardCreationInfo)
- com.microsoft.azure.elasticdb.shard.base._shard.Shard(ShardMapManager,ShardMap,StoreShard)
- com.microsoft.azure.elasticdb.shard.base._shard.toString()
- com.microsoft.azure.elasticdb.shard.base._shard.validate(StoreShardMap,Connection)
- com.microsoft.azure.elasticdb.shard.base._shard.validateAsync(StoreShardMap,Connection)
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: Shard
nameWithType: Shard
fullName: com.microsoft.azure.elasticdb.shard.base.Shard
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.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/base/Shard.java
startLine: 34
package: com.microsoft.azure.elasticdb.shard.base
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: &o1
content: public class Shard implements IShardProvider<ShardLocation>
inheritance:
- java.lang.Object
- com.microsoft.azure.elasticdb.shard.base._i_shard_provider
- uid: com.microsoft.azure.elasticdb.shard.base._shard.clone()
id: clone()
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: clone()
nameWithType: Shard.clone()
fullName: Shard com.microsoft.azure.elasticdb.shard.base.Shard.clone()
overload: com.microsoft.azure.elasticdb.shard.base._shard.clone*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 315
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Clones the instance.</p>
<p></p>
syntax:
content: public Shard clone()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard
description: <p>clone of the instance. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard.equals(Object)
id: equals(Object)
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: equals(Object obj)
nameWithType: Shard.equals(Object obj)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.Shard.equals(Object obj)
overload: com.microsoft.azure.elasticdb.shard.base._shard.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 337
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Determines whether the specified object is equal to the current object.</p>
<p></p>
syntax:
content: public boolean equals(Object obj)
parameters:
- id: obj
type: "79317049"
description: <p>The object to compare with the current object. </p>
return:
type: 4fc6e284
description: <p>True if the specified object is equal to the current object; otherwise, false. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard.equals(Shard)
id: equals(Shard)
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: equals(Shard other)
nameWithType: Shard.equals(Shard other)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.Shard.equals(Shard other)
overload: com.microsoft.azure.elasticdb.shard.base._shard.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 348
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Performs equality comparison with given <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>.</p>
<p></p>
syntax:
content: public boolean equals(Shard other)
parameters:
- id: other
type: com.microsoft.azure.elasticdb.shard.base._shard
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> to compare with. </p>
return:
type: 4fc6e284
description: <p>True if this object is equal to other object, false otherwise. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getId()
id: getId()
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: getId()
nameWithType: Shard.getId()
fullName: UUID com.microsoft.azure.elasticdb.shard.base.Shard.getId()
overload: com.microsoft.azure.elasticdb.shard.base._shard.getId*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 128
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Identity of the shard. Each shard should have a unique one. </p>
syntax:
content: public UUID getId()
return:
type: add9545a
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getLocation()
id: getLocation()
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: getLocation()
nameWithType: Shard.getLocation()
fullName: ShardLocation com.microsoft.azure.elasticdb.shard.base.Shard.getLocation()
overload: com.microsoft.azure.elasticdb.shard.base._shard.getLocation*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 112
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Gets Location of the shard. </p>
syntax:
content: public ShardLocation getLocation()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard_location
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getShardInfo()
id: getShardInfo()
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: getShardInfo()
nameWithType: Shard.getShardInfo()
fullName: Shard com.microsoft.azure.elasticdb.shard.base.Shard.getShardInfo()
overload: com.microsoft.azure.elasticdb.shard.base._shard.getShardInfo*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 142
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> for the ShardProvider object. </p>
syntax:
content: public Shard getShardInfo()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getShardMap()
id: getShardMap()
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: getShardMap()
nameWithType: Shard.getShardMap()
fullName: ShardMap com.microsoft.azure.elasticdb.shard.base.Shard.getShardMap()
overload: com.microsoft.azure.elasticdb.shard.base._shard.getShardMap*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 153
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public ShardMap getShardMap()
return:
type: com.microsoft.azure.elasticdb.shard.map._shard_map
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getShardMapId()
id: getShardMapId()
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: getShardMapId()
nameWithType: Shard.getShardMapId()
fullName: UUID com.microsoft.azure.elasticdb.shard.base.Shard.getShardMapId()
overload: com.microsoft.azure.elasticdb.shard.base._shard.getShardMapId*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 164
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Identify of the ShardMap this shard belongs to. </p>
syntax:
content: public UUID getShardMapId()
return:
type: add9545a
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getShardMapManager()
id: getShardMapManager()
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: getShardMapManager()
nameWithType: Shard.getShardMapManager()
fullName: ShardMapManager com.microsoft.azure.elasticdb.shard.base.Shard.getShardMapManager()
overload: com.microsoft.azure.elasticdb.shard.base._shard.getShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 168
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public ShardMapManager getShardMapManager()
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getStatus()
id: getStatus()
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: getStatus()
nameWithType: Shard.getStatus()
fullName: ShardStatus com.microsoft.azure.elasticdb.shard.base.Shard.getStatus()
overload: com.microsoft.azure.elasticdb.shard.base._shard.getStatus*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 121
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Gets the status of the shard which can be either online or offline. Connections can only be opened using Shard.OpenConnection(string, ConnectionOptions) on the shard map when the shard is online. Setting the shard status to offline prevents connections when the shard is undergoing maintenance operations. </p>
syntax:
content: public ShardStatus getStatus()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard_status
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getStoreShard()
id: getStoreShard()
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: getStoreShard()
nameWithType: Shard.getStoreShard()
fullName: StoreShard com.microsoft.azure.elasticdb.shard.base.Shard.getStoreShard()
overload: com.microsoft.azure.elasticdb.shard.base._shard.getStoreShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 176
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public StoreShard getStoreShard()
return:
type: com.microsoft.azure.elasticdb.shard.store._store_shard
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: getValue()
nameWithType: Shard.getValue()
fullName: ShardLocation com.microsoft.azure.elasticdb.shard.base.Shard.getValue()
overload: com.microsoft.azure.elasticdb.shard.base._shard.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 149
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Value corresponding to the <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>. Represents traits of the <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> object provided by the ShardInfo property. </p>
syntax:
content: public ShardLocation getValue()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard_location
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getVersion()
id: getVersion()
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: getVersion()
nameWithType: Shard.getVersion()
fullName: UUID com.microsoft.azure.elasticdb.shard.base.Shard.getVersion()
overload: com.microsoft.azure.elasticdb.shard.base._shard.getVersion*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 135
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> version. </p>
syntax:
content: public UUID getVersion()
return:
type: add9545a
- uid: com.microsoft.azure.elasticdb.shard.base._shard.hashCode()
id: hashCode()
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: hashCode()
nameWithType: Shard.hashCode()
fullName: int com.microsoft.azure.elasticdb.shard.base.Shard.hashCode()
overload: com.microsoft.azure.elasticdb.shard.base._shard.hashCode*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 375
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Calculates the hash code for this instance.</p>
<p></p>
syntax:
content: public int hashCode()
return:
type: f75371fa
description: <p>Hash code for the object. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard.openConnection(String)
id: openConnection(String)
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: openConnection(String connectionString)
nameWithType: Shard.openConnection(String connectionString)
fullName: Connection com.microsoft.azure.elasticdb.shard.base.Shard.openConnection(String connectionString)
overload: com.microsoft.azure.elasticdb.shard.base._shard.openConnection*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 194
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Opens a regular SqlConnection to the specified shard, with <xref uid="com.microsoft.azure.elasticdb.shard.mapper._connection_options.Validate" data-throw-if-not-resolved="false">ConnectionOptions.Validate</xref>.</p>
<p></p>
syntax:
content: public Connection openConnection(String connectionString)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection string with credential information such as SQL Server credentials or Integrated Security settings. The hostname of the server and the database name for the shard are obtained from the lookup operation for key. Note that the SqlConnection object returned by this call is not protected against transient faults. Callers should follow best practices to protect the connection against transient faults in their application code, e.g., by using the transient fault handling functionality in the Enterprise Library from Microsoft Patterns and Practices team. </p>
return:
type: 8270ccc2
- uid: com.microsoft.azure.elasticdb.shard.base._shard.openConnection(String,ConnectionOptions)
id: openConnection(String,ConnectionOptions)
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: openConnection(String connectionString, ConnectionOptions options)
nameWithType: Shard.openConnection(String connectionString, ConnectionOptions options)
fullName: Connection com.microsoft.azure.elasticdb.shard.base.Shard.openConnection(String connectionString, ConnectionOptions options)
overload: com.microsoft.azure.elasticdb.shard.base._shard.openConnection*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 210
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Opens a regular SqlConnection to the specified shard.</p>
<p></p>
syntax:
content: public Connection openConnection(String connectionString, ConnectionOptions options)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection string with credential information such as SQL Server credentials or Integrated Security settings. The hostname of the server and the database name for the shard are obtained from 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. Note that the SqlConnection object returned by this call is not protected against transient faults. Callers should follow best practices to protect the connection against transient faults in their application code, e.g., by using the transient fault handling functionality in the Enterprise Library from Microsoft Patterns and Practices team. </p>
return:
type: 8270ccc2
- uid: com.microsoft.azure.elasticdb.shard.base._shard.openConnectionAsync(String)
id: openConnectionAsync(String)
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: openConnectionAsync(String connectionString)
nameWithType: Shard.openConnectionAsync(String connectionString)
fullName: Callable<Connection> com.microsoft.azure.elasticdb.shard.base.Shard.openConnectionAsync(String connectionString)
overload: com.microsoft.azure.elasticdb.shard.base._shard.openConnectionAsync*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 228
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Asynchronously opens a regular SqlConnection to the specified shard, with <xref uid="com.microsoft.azure.elasticdb.shard.mapper._connection_options.Validate" data-throw-if-not-resolved="false">ConnectionOptions.Validate</xref>.</p>
<p></p>
syntax:
content: public Callable<Connection> openConnectionAsync(String connectionString)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection string with credential information such as SQL Server credentials or Integrated Security settings. The hostname of the server and the database name for the shard are obtained from the lookup operation for key. </p>
return:
type: 68f3503d
description: <p>A Task encapsulating an opened SqlConnection Note that the SqlConnection object returned by this call is not protected against transient faults. Callers should follow best practices to protect the connection against transient faults in their application code, e.g., by using the transient fault handling functionality in the Enterprise Library from Microsoft Patterns and Practices team. All non-usage errors will be propagated via the returned Task. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard.openConnectionAsync(String,ConnectionOptions)
id: openConnectionAsync(String,ConnectionOptions)
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: openConnectionAsync(String connectionString, ConnectionOptions options)
nameWithType: Shard.openConnectionAsync(String connectionString, ConnectionOptions options)
fullName: Callable<Connection> com.microsoft.azure.elasticdb.shard.base.Shard.openConnectionAsync(String connectionString, ConnectionOptions options)
overload: com.microsoft.azure.elasticdb.shard.base._shard.openConnectionAsync*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 245
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Asynchronously a regular SqlConnection to the specified shard.</p>
<p></p>
syntax:
content: public Callable<Connection> openConnectionAsync(String connectionString, ConnectionOptions options)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection string with credential information such as SQL Server credentials or Integrated Security settings. The hostname of the server and the database name for the shard are obtained from 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 Note that the SqlConnection object returned by this call is not protected against transient faults. Callers should follow best practices to protect the connection against transient faults in their application code, e.g., by using the transient fault handling functionality in the Enterprise Library from Microsoft Patterns and Practices team. All non-usage errors will be propagated via the returned Task. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard.setShardMap(ShardMap)
id: setShardMap(ShardMap)
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: setShardMap(ShardMap value)
nameWithType: Shard.setShardMap(ShardMap value)
fullName: void com.microsoft.azure.elasticdb.shard.base.Shard.setShardMap(ShardMap value)
overload: com.microsoft.azure.elasticdb.shard.base._shard.setShardMap*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 157
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public void setShardMap(ShardMap value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.map._shard_map
- uid: com.microsoft.azure.elasticdb.shard.base._shard.setShardMapManager(ShardMapManager)
id: setShardMapManager(ShardMapManager)
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: setShardMapManager(ShardMapManager value)
nameWithType: Shard.setShardMapManager(ShardMapManager value)
fullName: void com.microsoft.azure.elasticdb.shard.base.Shard.setShardMapManager(ShardMapManager value)
overload: com.microsoft.azure.elasticdb.shard.base._shard.setShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 172
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public void setShardMapManager(ShardMapManager value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
- uid: com.microsoft.azure.elasticdb.shard.base._shard.setStoreShard(StoreShard)
id: setStoreShard(StoreShard)
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: setStoreShard(StoreShard value)
nameWithType: Shard.setStoreShard(StoreShard value)
fullName: void com.microsoft.azure.elasticdb.shard.base.Shard.setStoreShard(StoreShard value)
overload: com.microsoft.azure.elasticdb.shard.base._shard.setStoreShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 180
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public void setStoreShard(StoreShard value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.store._store_shard
- uid: com.microsoft.azure.elasticdb.shard.base._shard.Shard(ShardMapManager,ShardMap,ShardCreationInfo)
id: Shard(ShardMapManager,ShardMap,ShardCreationInfo)
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: Shard(ShardMapManager shardMapManager, ShardMap shardMap, ShardCreationInfo creationInfo)
nameWithType: Shard.Shard(ShardMapManager shardMapManager, ShardMap shardMap, ShardCreationInfo creationInfo)
fullName: com.microsoft.azure.elasticdb.shard.base.Shard.Shard(ShardMapManager shardMapManager, ShardMap shardMap, ShardCreationInfo creationInfo)
overload: com.microsoft.azure.elasticdb.shard.base._shard.Shard*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 68
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Constructs a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> given shard creation arguments.</p>
<p></p>
syntax:
content: public Shard(ShardMapManager shardMapManager, ShardMap shardMap, ShardCreationInfo creationInfo)
parameters:
- id: shardMapManager
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>Owning ShardMapManager. </p>
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.map._shard_map
description: <p>Owning shard map. </p>
- id: creationInfo
type: com.microsoft.azure.elasticdb.shard.base._shard_creation_info
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> creation information. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard.Shard(ShardMapManager,ShardMap,StoreShard)
id: Shard(ShardMapManager,ShardMap,StoreShard)
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: Shard(ShardMapManager shardMapManager, ShardMap shardMap, StoreShard storeShard)
nameWithType: Shard.Shard(ShardMapManager shardMapManager, ShardMap shardMap, StoreShard storeShard)
fullName: com.microsoft.azure.elasticdb.shard.base.Shard.Shard(ShardMapManager shardMapManager, ShardMap shardMap, StoreShard storeShard)
overload: com.microsoft.azure.elasticdb.shard.base._shard.Shard*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 94
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Internal constructor that uses storage representation.</p>
<p></p>
syntax:
content: public Shard(ShardMapManager shardMapManager, ShardMap shardMap, StoreShard storeShard)
parameters:
- id: shardMapManager
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>Owning ShardMapManager. </p>
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.map._shard_map
description: <p>Owning shard map. </p>
- id: storeShard
type: com.microsoft.azure.elasticdb.shard.store._store_shard
description: <p>Storage representation of the shard. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard.toString()
id: toString()
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: toString()
nameWithType: Shard.toString()
fullName: String com.microsoft.azure.elasticdb.shard.base.Shard.toString()
overload: com.microsoft.azure.elasticdb.shard.base._shard.toString*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 325
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Converts the object to its string representation.</p>
<p></p>
syntax:
content: public String toString()
return:
type: "26831127"
description: <p>String representation of the object. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard.validate(StoreShardMap,Connection)
id: validate(StoreShardMap,Connection)
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: validate(StoreShardMap shardMap, Connection conn)
nameWithType: Shard.validate(StoreShardMap shardMap, Connection conn)
fullName: void com.microsoft.azure.elasticdb.shard.base.Shard.validate(StoreShardMap shardMap, Connection conn)
overload: com.microsoft.azure.elasticdb.shard.base._shard.validate*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 261
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Performs validation that the local representation is as up-to-date as the representation on the backing data store.</p>
<p></p>
syntax:
content: public void validate(StoreShardMap shardMap, Connection conn)
parameters:
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> map to which the shard provider belongs. </p>
- id: conn
type: 8270ccc2
description: <p>Connection used for validation. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard.validateAsync(StoreShardMap,Connection)
id: validateAsync(StoreShardMap,Connection)
parent: com.microsoft.azure.elasticdb.shard.base._shard
href: com.microsoft.azure.elasticdb.shard.base._shard.yml
langs:
- java
name: validateAsync(StoreShardMap shardMap, Connection conn)
nameWithType: Shard.validateAsync(StoreShardMap shardMap, Connection conn)
fullName: Callable com.microsoft.azure.elasticdb.shard.base.Shard.validateAsync(StoreShardMap shardMap, Connection conn)
overload: com.microsoft.azure.elasticdb.shard.base._shard.validateAsync*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/Shard.java
startLine: 289
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Asynchronously performs validation that the local representation is as up-to-date as the representation on the backing data store.</p>
<p></p>
syntax:
content: public Callable validateAsync(StoreShardMap shardMap, Connection conn)
parameters:
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> map to which the shard provider belongs. </p>
- id: conn
type: 8270ccc2
description: <p>Connection used for validation. </p>
return:
type: b2e5ac79
description: <p>A task to await validation completion </p>
references:
- uid: com.microsoft.azure.elasticdb.shard.base._shard.Shard*
name: Shard
nameWithType: Shard.Shard
fullName: com.microsoft.azure.elasticdb.shard.base.Shard.Shard
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getLocation*
name: getLocation
nameWithType: Shard.getLocation
fullName: ShardLocation com.microsoft.azure.elasticdb.shard.base.Shard.getLocation
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getStatus*
name: getStatus
nameWithType: Shard.getStatus
fullName: ShardStatus com.microsoft.azure.elasticdb.shard.base.Shard.getStatus
package: com.microsoft.azure.elasticdb.shard.base
- uid: add9545a
spec.java:
- name: UUID
fullName: UUID
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getId*
name: getId
nameWithType: Shard.getId
fullName: UUID com.microsoft.azure.elasticdb.shard.base.Shard.getId
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getVersion*
name: getVersion
nameWithType: Shard.getVersion
fullName: UUID com.microsoft.azure.elasticdb.shard.base.Shard.getVersion
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getShardInfo*
name: getShardInfo
nameWithType: Shard.getShardInfo
fullName: Shard com.microsoft.azure.elasticdb.shard.base.Shard.getShardInfo
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getValue*
name: getValue
nameWithType: Shard.getValue
fullName: ShardLocation com.microsoft.azure.elasticdb.shard.base.Shard.getValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getShardMap*
name: getShardMap
nameWithType: Shard.getShardMap
fullName: ShardMap com.microsoft.azure.elasticdb.shard.base.Shard.getShardMap
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard.setShardMap*
name: setShardMap
nameWithType: Shard.setShardMap
fullName: void com.microsoft.azure.elasticdb.shard.base.Shard.setShardMap
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getShardMapId*
name: getShardMapId
nameWithType: Shard.getShardMapId
fullName: UUID com.microsoft.azure.elasticdb.shard.base.Shard.getShardMapId
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getShardMapManager*
name: getShardMapManager
nameWithType: Shard.getShardMapManager
fullName: ShardMapManager com.microsoft.azure.elasticdb.shard.base.Shard.getShardMapManager
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard.setShardMapManager*
name: setShardMapManager
nameWithType: Shard.setShardMapManager
fullName: void com.microsoft.azure.elasticdb.shard.base.Shard.setShardMapManager
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard.getStoreShard*
name: getStoreShard
nameWithType: Shard.getStoreShard
fullName: StoreShard com.microsoft.azure.elasticdb.shard.base.Shard.getStoreShard
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard.setStoreShard*
name: setStoreShard
nameWithType: Shard.setStoreShard
fullName: void com.microsoft.azure.elasticdb.shard.base.Shard.setStoreShard
package: com.microsoft.azure.elasticdb.shard.base
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: 8270ccc2
spec.java:
- name: Connection
fullName: Connection
- uid: com.microsoft.azure.elasticdb.shard.base._shard.openConnection*
name: openConnection
nameWithType: Shard.openConnection
fullName: Connection com.microsoft.azure.elasticdb.shard.base.Shard.openConnection
package: com.microsoft.azure.elasticdb.shard.base
- uid: 68f3503d
spec.java:
- name: Callable<Connection>
fullName: Callable<Connection>
- uid: com.microsoft.azure.elasticdb.shard.base._shard.openConnectionAsync*
name: openConnectionAsync
nameWithType: Shard.openConnectionAsync
fullName: Callable<Connection> com.microsoft.azure.elasticdb.shard.base.Shard.openConnectionAsync
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard.validate*
name: validate
nameWithType: Shard.validate
fullName: void com.microsoft.azure.elasticdb.shard.base.Shard.validate
package: com.microsoft.azure.elasticdb.shard.base
- uid: b2e5ac79
spec.java:
- name: Callable
fullName: Callable
- uid: com.microsoft.azure.elasticdb.shard.base._shard.validateAsync*
name: validateAsync
nameWithType: Shard.validateAsync
fullName: Callable com.microsoft.azure.elasticdb.shard.base.Shard.validateAsync
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard.clone*
name: clone
nameWithType: Shard.clone
fullName: Shard com.microsoft.azure.elasticdb.shard.base.Shard.clone
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard.toString*
name: toString
nameWithType: Shard.toString
fullName: String com.microsoft.azure.elasticdb.shard.base.Shard.toString
package: com.microsoft.azure.elasticdb.shard.base
- uid: "79317049"
spec.java:
- name: Object
fullName: Object
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.base._shard.equals*
name: equals
nameWithType: Shard.equals
fullName: boolean com.microsoft.azure.elasticdb.shard.base.Shard.equals
package: com.microsoft.azure.elasticdb.shard.base
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.base._shard.hashCode*
name: hashCode
nameWithType: Shard.hashCode
fullName: int com.microsoft.azure.elasticdb.shard.base.Shard.hashCode
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._i_shard_provider
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.yml
name: IShardProvider<ValueT>
nameWithType: IShardProvider<ValueT>
fullName: com.microsoft.azure.elasticdb.shard.base.IShardProvider<ValueT>
type: Interface
summary: <p>Represents capabilities to provide a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> along with an associated value. </p>
syntax:
content: public interface IShardProvider<ValueT>
typeParameters:
- type: 0fb6b535
- 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.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: *o1
- 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.store._store_shard
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_shard.yml
name: StoreShard
nameWithType: StoreShard
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShard
type: Class
summary: <p>Storage representation of a single shard. </p>
syntax:
content: public class StoreShard
- uid: com.microsoft.azure.elasticdb.shard.base._shard_creation_info
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.yml
name: ShardCreationInfo
nameWithType: ShardCreationInfo
fullName: com.microsoft.azure.elasticdb.shard.base.ShardCreationInfo
type: Class
summary: <p>Arguments used to create a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>. </p>
syntax:
content: public class ShardCreationInfo
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
name: ShardLocation
nameWithType: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
type: Class
summary: <p>Represents the location of a shard in terms of its server name and database name. This is used to manage connections to the shard and to support other operations on shards. As opposed to a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>, a shard location is not registered with the shard map. </p>
syntax:
content: public class ShardLocation
- uid: com.microsoft.azure.elasticdb.shard.base._shard_status
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_status.yml
name: ShardStatus
nameWithType: ShardStatus
fullName: com.microsoft.azure.elasticdb.shard.base.ShardStatus
type: Enum
summary: <p>Status of a shard. </p>
syntax:
content: public enum ShardStatus
- uid: com.microsoft.azure.elasticdb.shard.mapper._connection_options.Validate
parent: com.microsoft.azure.elasticdb.shard.mapper._connection_options
href: com.microsoft.azure.elasticdb.shard.mapper._connection_options.yml
name: Validate
nameWithType: ConnectionOptions.Validate
fullName: com.microsoft.azure.elasticdb.shard.mapper.ConnectionOptions.Validate
type: Field
summary: <p>Validation will be performed on the connection to ensure that the state of the corresponding mapping has not changed since the mapping information was last cached at the client. </p>
syntax:
content: public Validate=(1)
- 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.store._store_shard_map
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_shard_map.yml
name: StoreShardMap
nameWithType: StoreShardMap
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShardMap
type: Class
summary: <p>Store representation of a shard map. </p>
syntax:
content: public class StoreShardMap
- 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 implements IShardProvider<Object>,IMappingInfoProvider
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
name: RangeMapping
nameWithType: RangeMapping
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping
type: Class
summary: <p>Represents a mapping between a range of key values and a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>. </p>
syntax:
content: public class RangeMapping implements IShardProvider<Range>,IMappingInfoProvider

Просмотреть файл

@ -0,0 +1,198 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._shard_creation_info
id: _shard_creation_info
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._shard_creation_info.getLocation()
- com.microsoft.azure.elasticdb.shard.base._shard_creation_info.getStatus()
- com.microsoft.azure.elasticdb.shard.base._shard_creation_info.setStatus(ShardStatus)
- com.microsoft.azure.elasticdb.shard.base._shard_creation_info.ShardCreationInfo(ShardLocation)
- com.microsoft.azure.elasticdb.shard.base._shard_creation_info.ShardCreationInfo(ShardLocation,ShardStatus)
href: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.yml
langs:
- java
name: ShardCreationInfo
nameWithType: ShardCreationInfo
fullName: com.microsoft.azure.elasticdb.shard.base.ShardCreationInfo
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardCreationInfo.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/base/ShardCreationInfo.java
startLine: 15
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Arguments used to create a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>. </p>
syntax:
content: public class ShardCreationInfo
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.getLocation()
id: getLocation()
parent: com.microsoft.azure.elasticdb.shard.base._shard_creation_info
href: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.yml
langs:
- java
name: getLocation()
nameWithType: ShardCreationInfo.getLocation()
fullName: ShardLocation com.microsoft.azure.elasticdb.shard.base.ShardCreationInfo.getLocation()
overload: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.getLocation*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardCreationInfo.java
startLine: 53
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public ShardLocation getLocation()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard_location
- uid: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.getStatus()
id: getStatus()
parent: com.microsoft.azure.elasticdb.shard.base._shard_creation_info
href: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.yml
langs:
- java
name: getStatus()
nameWithType: ShardCreationInfo.getStatus()
fullName: ShardStatus com.microsoft.azure.elasticdb.shard.base.ShardCreationInfo.getStatus()
overload: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.getStatus*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardCreationInfo.java
startLine: 61
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public ShardStatus getStatus()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard_status
- uid: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.setStatus(ShardStatus)
id: setStatus(ShardStatus)
parent: com.microsoft.azure.elasticdb.shard.base._shard_creation_info
href: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.yml
langs:
- java
name: setStatus(ShardStatus value)
nameWithType: ShardCreationInfo.setStatus(ShardStatus value)
fullName: void com.microsoft.azure.elasticdb.shard.base.ShardCreationInfo.setStatus(ShardStatus value)
overload: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.setStatus*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardCreationInfo.java
startLine: 65
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public void setStatus(ShardStatus value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.base._shard_status
- uid: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.ShardCreationInfo(ShardLocation)
id: ShardCreationInfo(ShardLocation)
parent: com.microsoft.azure.elasticdb.shard.base._shard_creation_info
href: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.yml
langs:
- java
name: ShardCreationInfo(ShardLocation location)
nameWithType: ShardCreationInfo.ShardCreationInfo(ShardLocation location)
fullName: com.microsoft.azure.elasticdb.shard.base.ShardCreationInfo.ShardCreationInfo(ShardLocation location)
overload: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.ShardCreationInfo*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardCreationInfo.java
startLine: 34
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Arguments used to create a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>.</p>
<p></p>
syntax:
content: public ShardCreationInfo(ShardLocation location)
parameters:
- id: location
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>Location of the shard. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.ShardCreationInfo(ShardLocation,ShardStatus)
id: ShardCreationInfo(ShardLocation,ShardStatus)
parent: com.microsoft.azure.elasticdb.shard.base._shard_creation_info
href: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.yml
langs:
- java
name: ShardCreationInfo(ShardLocation location, ShardStatus status)
nameWithType: ShardCreationInfo.ShardCreationInfo(ShardLocation location, ShardStatus status)
fullName: com.microsoft.azure.elasticdb.shard.base.ShardCreationInfo.ShardCreationInfo(ShardLocation location, ShardStatus status)
overload: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.ShardCreationInfo*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardCreationInfo.java
startLine: 46
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Arguments used to create a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>.</p>
<p></p>
syntax:
content: public ShardCreationInfo(ShardLocation location, ShardStatus status)
parameters:
- id: location
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>Location of the shard. </p>
- id: status
type: com.microsoft.azure.elasticdb.shard.base._shard_status
description: <p>Status of the shard. </p>
references:
- uid: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.ShardCreationInfo*
name: ShardCreationInfo
nameWithType: ShardCreationInfo.ShardCreationInfo
fullName: com.microsoft.azure.elasticdb.shard.base.ShardCreationInfo.ShardCreationInfo
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.getLocation*
name: getLocation
nameWithType: ShardCreationInfo.getLocation
fullName: ShardLocation com.microsoft.azure.elasticdb.shard.base.ShardCreationInfo.getLocation
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.getStatus*
name: getStatus
nameWithType: ShardCreationInfo.getStatus
fullName: ShardStatus com.microsoft.azure.elasticdb.shard.base.ShardCreationInfo.getStatus
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.setStatus*
name: setStatus
nameWithType: ShardCreationInfo.setStatus
fullName: void com.microsoft.azure.elasticdb.shard.base.ShardCreationInfo.setStatus
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
name: ShardLocation
nameWithType: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
type: Class
summary: <p>Represents the location of a shard in terms of its server name and database name. This is used to manage connections to the shard and to support other operations on shards. As opposed to a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>, a shard location is not registered with the shard map. </p>
syntax:
content: public class ShardLocation
- uid: com.microsoft.azure.elasticdb.shard.base._shard_status
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_status.yml
name: ShardStatus
nameWithType: ShardStatus
fullName: com.microsoft.azure.elasticdb.shard.base.ShardStatus
type: Enum
summary: <p>Status of a shard. </p>
syntax:
content: public enum ShardStatus
- 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 implements IShardProvider<ShardLocation>

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -0,0 +1,187 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key_type
id: _shard_key_type
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._shard_key_type.forValue(int)
- com.microsoft.azure.elasticdb.shard.base._shard_key_type.getByteArraySize()
- com.microsoft.azure.elasticdb.shard.base._shard_key_type.getValue()
- com.microsoft.azure.elasticdb.shard.base._shard_key_type.ShardKeyType(int,int)
- com.microsoft.azure.elasticdb.shard.base._shard_key_type.XmlEnumValue
href: com.microsoft.azure.elasticdb.shard.base._shard_key_type.yml
langs:
- java
name: ShardKeyType
nameWithType: ShardKeyType
fullName: com.microsoft.azure.elasticdb.shard.base.ShardKeyType
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardKeyType.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/base/ShardKeyType.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Type of shard key. Currently, only Int32, Int64, Guid and byte[] are the data types supported as shard keys. </p>
syntax: &o1
content: public enum ShardKeyType
inheritance:
- java.lang.Object
- java.lang.Enum<ShardKeyType>
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key_type.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.base._shard_key_type
href: com.microsoft.azure.elasticdb.shard.base._shard_key_type.yml
langs:
- java
name: forValue(int value)
nameWithType: ShardKeyType.forValue(int value)
fullName: static ShardKeyType com.microsoft.azure.elasticdb.shard.base.ShardKeyType.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.base._shard_key_type.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardKeyType.java
startLine: 88
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static ShardKeyType forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.base._shard_key_type
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key_type.getByteArraySize()
id: getByteArraySize()
parent: com.microsoft.azure.elasticdb.shard.base._shard_key_type
href: com.microsoft.azure.elasticdb.shard.base._shard_key_type.yml
langs:
- java
name: getByteArraySize()
nameWithType: ShardKeyType.getByteArraySize()
fullName: int com.microsoft.azure.elasticdb.shard.base.ShardKeyType.getByteArraySize()
overload: com.microsoft.azure.elasticdb.shard.base._shard_key_type.getByteArraySize*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardKeyType.java
startLine: 96
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public int getByteArraySize()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key_type.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.base._shard_key_type
href: com.microsoft.azure.elasticdb.shard.base._shard_key_type.yml
langs:
- java
name: getValue()
nameWithType: ShardKeyType.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.base.ShardKeyType.getValue()
overload: com.microsoft.azure.elasticdb.shard.base._shard_key_type.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardKeyType.java
startLine: 92
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key_type.ShardKeyType(int,int)
id: ShardKeyType(int,int)
parent: com.microsoft.azure.elasticdb.shard.base._shard_key_type
href: com.microsoft.azure.elasticdb.shard.base._shard_key_type.yml
langs:
- java
name: ShardKeyType(int value, int expectedByteArrayLength)
nameWithType: ShardKeyType.ShardKeyType(int value, int expectedByteArrayLength)
fullName: com.microsoft.azure.elasticdb.shard.base.ShardKeyType.ShardKeyType(int value, int expectedByteArrayLength)
overload: com.microsoft.azure.elasticdb.shard.base._shard_key_type.ShardKeyType*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardKeyType.java
startLine: 70
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public ShardKeyType(int value, int expectedByteArrayLength)
parameters:
- id: value
type: f75371fa
- id: expectedByteArrayLength
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key_type.XmlEnumValue
id: XmlEnumValue
parent: com.microsoft.azure.elasticdb.shard.base._shard_key_type
href: com.microsoft.azure.elasticdb.shard.base._shard_key_type.yml
langs:
- java
name: XmlEnumValue
nameWithType: ShardKeyType.XmlEnumValue
fullName: com.microsoft.azure.elasticdb.shard.base.ShardKeyType.XmlEnumValue
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardKeyType.java
startLine: 21
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>No type specified.</p>
<p>32-bit integral value.</p>
<p>64-bit integral value.</p>
<p>UniqueIdentifier value.</p>
<p>Array of bytes value.</p>
<p>Date and time value.</p>
<p>Time value.</p>
<p>Date and time value with offset. </p>
syntax:
content: >-
public XmlEnumValue=("0")
None(0, 0)
references:
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key_type.ShardKeyType*
name: ShardKeyType
nameWithType: ShardKeyType.ShardKeyType
fullName: com.microsoft.azure.elasticdb.shard.base.ShardKeyType.ShardKeyType
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key_type.getValue*
name: getValue
nameWithType: ShardKeyType.getValue
fullName: int com.microsoft.azure.elasticdb.shard.base.ShardKeyType.getValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key_type.getByteArraySize*
name: getByteArraySize
nameWithType: ShardKeyType.getByteArraySize
fullName: int com.microsoft.azure.elasticdb.shard.base.ShardKeyType.getByteArraySize
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key_type.forValue*
name: forValue
nameWithType: ShardKeyType.forValue
fullName: static ShardKeyType com.microsoft.azure.elasticdb.shard.base.ShardKeyType.forValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key_type
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_key_type.yml
name: ShardKeyType
nameWithType: ShardKeyType
fullName: com.microsoft.azure.elasticdb.shard.base.ShardKeyType
type: Enum
summary: <p>Type of shard key. Currently, only Int32, Int64, Guid and byte[] are the data types supported as shard keys. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,457 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
id: _shard_location
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._shard_location.equals(Object)
- com.microsoft.azure.elasticdb.shard.base._shard_location.equals(ShardLocation)
- com.microsoft.azure.elasticdb.shard.base._shard_location.getDatabase()
- com.microsoft.azure.elasticdb.shard.base._shard_location.getDataSource()
- com.microsoft.azure.elasticdb.shard.base._shard_location.getPort()
- com.microsoft.azure.elasticdb.shard.base._shard_location.getProtocol()
- com.microsoft.azure.elasticdb.shard.base._shard_location.getServer()
- com.microsoft.azure.elasticdb.shard.base._shard_location.hashCode()
- com.microsoft.azure.elasticdb.shard.base._shard_location.ShardLocation()
- com.microsoft.azure.elasticdb.shard.base._shard_location.ShardLocation(String,String)
- com.microsoft.azure.elasticdb.shard.base._shard_location.ShardLocation(String,String,SqlProtocol)
- com.microsoft.azure.elasticdb.shard.base._shard_location.ShardLocation(String,String,SqlProtocol,int)
- com.microsoft.azure.elasticdb.shard.base._shard_location.toString()
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
langs:
- java
name: ShardLocation
nameWithType: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardLocation.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/base/ShardLocation.java
startLine: 24
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Represents the location of a shard in terms of its server name and database name. This is used to manage connections to the shard and to support other operations on shards. As opposed to a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>, a shard location is not registered with the shard map. </p>
syntax: &o1
content: public class ShardLocation
inheritance:
- java.lang.Object
- Serializable
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.equals(Object)
id: equals(Object)
parent: com.microsoft.azure.elasticdb.shard.base._shard_location
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
langs:
- java
name: equals(Object obj)
nameWithType: ShardLocation.equals(Object obj)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.ShardLocation.equals(Object obj)
overload: com.microsoft.azure.elasticdb.shard.base._shard_location.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardLocation.java
startLine: 200
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Determines whether the specified object is equal to the current object.</p>
<p></p>
syntax:
content: public boolean equals(Object obj)
parameters:
- id: obj
type: "79317049"
description: <p>The object to compare with the current object. </p>
return:
type: 4fc6e284
description: <p>True if the specified object is equal to the current object; otherwise, false. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.equals(ShardLocation)
id: equals(ShardLocation)
parent: com.microsoft.azure.elasticdb.shard.base._shard_location
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
langs:
- java
name: equals(ShardLocation other)
nameWithType: ShardLocation.equals(ShardLocation other)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.ShardLocation.equals(ShardLocation other)
overload: com.microsoft.azure.elasticdb.shard.base._shard_location.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardLocation.java
startLine: 211
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Performs equality comparison with another given <xref uid="com.microsoft.azure.elasticdb.shard.base._shard_location" data-throw-if-not-resolved="false">ShardLocation</xref>.</p>
<p></p>
syntax:
content: public boolean equals(ShardLocation other)
parameters:
- id: other
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard_location" data-throw-if-not-resolved="false">ShardLocation</xref> to compare with. </p>
return:
type: 4fc6e284
description: <p>True if same locations, false otherwise. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.getDatabase()
id: getDatabase()
parent: com.microsoft.azure.elasticdb.shard.base._shard_location
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
langs:
- java
name: getDatabase()
nameWithType: ShardLocation.getDatabase()
fullName: String com.microsoft.azure.elasticdb.shard.base.ShardLocation.getDatabase()
overload: com.microsoft.azure.elasticdb.shard.base._shard_location.getDatabase*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardLocation.java
startLine: 164
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public String getDatabase()
return:
type: "26831127"
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.getDataSource()
id: getDataSource()
parent: com.microsoft.azure.elasticdb.shard.base._shard_location
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
langs:
- java
name: getDataSource()
nameWithType: ShardLocation.getDataSource()
fullName: String com.microsoft.azure.elasticdb.shard.base.ShardLocation.getDataSource()
overload: com.microsoft.azure.elasticdb.shard.base._shard_location.getDataSource*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardLocation.java
startLine: 160
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>DataSource name which can be used to construct connection string Data Source property. </p>
syntax:
content: public String getDataSource()
return:
type: "26831127"
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.getPort()
id: getPort()
parent: com.microsoft.azure.elasticdb.shard.base._shard_location
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
langs:
- java
name: getPort()
nameWithType: ShardLocation.getPort()
fullName: int com.microsoft.azure.elasticdb.shard.base.ShardLocation.getPort()
overload: com.microsoft.azure.elasticdb.shard.base._shard_location.getPort*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardLocation.java
startLine: 149
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public int getPort()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.getProtocol()
id: getProtocol()
parent: com.microsoft.azure.elasticdb.shard.base._shard_location
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
langs:
- java
name: getProtocol()
nameWithType: ShardLocation.getProtocol()
fullName: SqlProtocol com.microsoft.azure.elasticdb.shard.base.ShardLocation.getProtocol()
overload: com.microsoft.azure.elasticdb.shard.base._shard_location.getProtocol*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardLocation.java
startLine: 133
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public SqlProtocol getProtocol()
return:
type: com.microsoft.azure.elasticdb.shard.base._sql_protocol
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.getServer()
id: getServer()
parent: com.microsoft.azure.elasticdb.shard.base._shard_location
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
langs:
- java
name: getServer()
nameWithType: ShardLocation.getServer()
fullName: String com.microsoft.azure.elasticdb.shard.base.ShardLocation.getServer()
overload: com.microsoft.azure.elasticdb.shard.base._shard_location.getServer*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardLocation.java
startLine: 141
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public String getServer()
return:
type: "26831127"
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.hashCode()
id: hashCode()
parent: com.microsoft.azure.elasticdb.shard.base._shard_location
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
langs:
- java
name: hashCode()
nameWithType: ShardLocation.hashCode()
fullName: int com.microsoft.azure.elasticdb.shard.base.ShardLocation.hashCode()
overload: com.microsoft.azure.elasticdb.shard.base._shard_location.hashCode*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardLocation.java
startLine: 188
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Calculates the hash code for this instance.</p>
<p></p>
syntax:
content: public int hashCode()
return:
type: f75371fa
description: <p>Hash code for the object. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.ShardLocation()
id: ShardLocation()
parent: com.microsoft.azure.elasticdb.shard.base._shard_location
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
langs:
- java
name: ShardLocation()
nameWithType: ShardLocation.ShardLocation()
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation.ShardLocation()
overload: com.microsoft.azure.elasticdb.shard.base._shard_location.ShardLocation*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardLocation.java
startLine: 55
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public ShardLocation()
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.ShardLocation(String,String)
id: ShardLocation(String,String)
parent: com.microsoft.azure.elasticdb.shard.base._shard_location
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
langs:
- java
name: ShardLocation(String server, String database)
nameWithType: ShardLocation.ShardLocation(String server, String database)
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation.ShardLocation(String server, String database)
overload: com.microsoft.azure.elasticdb.shard.base._shard_location.ShardLocation*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardLocation.java
startLine: 112
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Constructor that allows specification of address and database to identify a shard.</p>
<p></p>
syntax:
content: public ShardLocation(String server, String database)
parameters:
- id: server
type: "26831127"
description: <p>Fully qualified hostname of the server for the shard database. </p>
- id: database
type: "26831127"
description: <p>Name of the shard database. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.ShardLocation(String,String,SqlProtocol)
id: ShardLocation(String,String,SqlProtocol)
parent: com.microsoft.azure.elasticdb.shard.base._shard_location
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
langs:
- java
name: ShardLocation(String server, String database, SqlProtocol protocol)
nameWithType: ShardLocation.ShardLocation(String server, String database, SqlProtocol protocol)
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation.ShardLocation(String server, String database, SqlProtocol protocol)
overload: com.microsoft.azure.elasticdb.shard.base._shard_location.ShardLocation*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardLocation.java
startLine: 127
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Constructor that allows specification of address and database to identify a shard.</p>
<p></p>
syntax:
content: public ShardLocation(String server, String database, SqlProtocol protocol)
parameters:
- id: server
type: "26831127"
description: <p>Fully qualified hostname of the server for the shard database. </p>
- id: database
type: "26831127"
description: <p>Name of the shard database. </p>
- id: protocol
type: com.microsoft.azure.elasticdb.shard.base._sql_protocol
description: <p>Transport protcol used for the connection. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.ShardLocation(String,String,SqlProtocol,int)
id: ShardLocation(String,String,SqlProtocol,int)
parent: com.microsoft.azure.elasticdb.shard.base._shard_location
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
langs:
- java
name: ShardLocation(String server, String database, SqlProtocol protocol, int port)
nameWithType: ShardLocation.ShardLocation(String server, String database, SqlProtocol protocol, int port)
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation.ShardLocation(String server, String database, SqlProtocol protocol, int port)
overload: com.microsoft.azure.elasticdb.shard.base._shard_location.ShardLocation*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardLocation.java
startLine: 70
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Constructor that allows specification of protocol, address, port and database to identify a shard.</p>
<p></p>
syntax:
content: public ShardLocation(String server, String database, SqlProtocol protocol, int port)
parameters:
- id: server
type: "26831127"
description: <p>Fully qualified hostname of the server for the shard database. </p>
- id: database
type: "26831127"
description: <p>Name of the shard database. </p>
- id: protocol
type: com.microsoft.azure.elasticdb.shard.base._sql_protocol
description: <p>Transport protcol used for the connection. </p>
- id: port
type: f75371fa
description: <p>Port number for TCP/IP connections. Specify 0 to use the default port for the specified <em>protocol</em> . </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.toString()
id: toString()
parent: com.microsoft.azure.elasticdb.shard.base._shard_location
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
langs:
- java
name: toString()
nameWithType: ShardLocation.toString()
fullName: String com.microsoft.azure.elasticdb.shard.base.ShardLocation.toString()
overload: com.microsoft.azure.elasticdb.shard.base._shard_location.toString*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardLocation.java
startLine: 178
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Converts the shard location to its string representation.</p>
<p></p>
syntax:
content: public String toString()
return:
type: "26831127"
description: <p>String representation of shard location. </p>
references:
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.ShardLocation*
name: ShardLocation
nameWithType: ShardLocation.ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation.ShardLocation
package: com.microsoft.azure.elasticdb.shard.base
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.getProtocol*
name: getProtocol
nameWithType: ShardLocation.getProtocol
fullName: SqlProtocol com.microsoft.azure.elasticdb.shard.base.ShardLocation.getProtocol
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.getServer*
name: getServer
nameWithType: ShardLocation.getServer
fullName: String com.microsoft.azure.elasticdb.shard.base.ShardLocation.getServer
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.getPort*
name: getPort
nameWithType: ShardLocation.getPort
fullName: int com.microsoft.azure.elasticdb.shard.base.ShardLocation.getPort
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.getDataSource*
name: getDataSource
nameWithType: ShardLocation.getDataSource
fullName: String com.microsoft.azure.elasticdb.shard.base.ShardLocation.getDataSource
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.getDatabase*
name: getDatabase
nameWithType: ShardLocation.getDatabase
fullName: String com.microsoft.azure.elasticdb.shard.base.ShardLocation.getDatabase
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.toString*
name: toString
nameWithType: ShardLocation.toString
fullName: String com.microsoft.azure.elasticdb.shard.base.ShardLocation.toString
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.hashCode*
name: hashCode
nameWithType: ShardLocation.hashCode
fullName: int com.microsoft.azure.elasticdb.shard.base.ShardLocation.hashCode
package: com.microsoft.azure.elasticdb.shard.base
- uid: "79317049"
spec.java:
- name: Object
fullName: Object
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location.equals*
name: equals
nameWithType: ShardLocation.equals
fullName: boolean com.microsoft.azure.elasticdb.shard.base.ShardLocation.equals
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._sql_protocol
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._sql_protocol.yml
name: SqlProtocol
nameWithType: SqlProtocol
fullName: com.microsoft.azure.elasticdb.shard.base.SqlProtocol
type: Enum
summary: <p>Types of transport protocols supported in SQL Server connections. </p>
syntax:
content: public enum SqlProtocol
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
name: ShardLocation
nameWithType: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
type: Class
summary: <p>Represents the location of a shard in terms of its server name and database name. This is used to manage connections to the shard and to support other operations on shards. As opposed to a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>, a shard location is not registered with the shard map. </p>
syntax: *o1
- 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 implements IShardProvider<ShardLocation>

Просмотреть файл

@ -0,0 +1,50 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._shard_range._max_shard_key
id: _max_shard_key
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._shard_range._max_shard_key.MaxShardKey()
href: com.microsoft.azure.elasticdb.shard.base._shard_range._max_shard_key.yml
langs:
- java
name: ShardRange.MaxShardKey
nameWithType: ShardRange.MaxShardKey
fullName: com.microsoft.azure.elasticdb.shard.base.ShardRange.MaxShardKey
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardRange.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/base/ShardRange.java
startLine: 470
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public class MaxShardKey
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.base._shard_range._max_shard_key.MaxShardKey()
id: MaxShardKey()
parent: com.microsoft.azure.elasticdb.shard.base._shard_range._max_shard_key
href: com.microsoft.azure.elasticdb.shard.base._shard_range._max_shard_key.yml
langs:
- java
name: MaxShardKey()
nameWithType: ShardRange.MaxShardKey.MaxShardKey()
fullName: com.microsoft.azure.elasticdb.shard.base.ShardRange.MaxShardKey.MaxShardKey()
overload: com.microsoft.azure.elasticdb.shard.base._shard_range._max_shard_key.MaxShardKey*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardRange.java
startLine: 478
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public MaxShardKey()
references:
- uid: com.microsoft.azure.elasticdb.shard.base._shard_range._max_shard_key.MaxShardKey*
name: MaxShardKey
nameWithType: ShardRange.MaxShardKey.MaxShardKey
fullName: com.microsoft.azure.elasticdb.shard.base.ShardRange.MaxShardKey.MaxShardKey
package: com.microsoft.azure.elasticdb.shard.base

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -0,0 +1,201 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._shard_status
id: _shard_status
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._shard_status.forValue(int)
- com.microsoft.azure.elasticdb.shard.base._shard_status.getValue()
- com.microsoft.azure.elasticdb.shard.base._shard_status.Offline
- com.microsoft.azure.elasticdb.shard.base._shard_status.Online
- com.microsoft.azure.elasticdb.shard.base._shard_status.ShardStatus(int)
- com.microsoft.azure.elasticdb.shard.base._shard_status.SIZE
href: com.microsoft.azure.elasticdb.shard.base._shard_status.yml
langs:
- java
name: ShardStatus
nameWithType: ShardStatus
fullName: com.microsoft.azure.elasticdb.shard.base.ShardStatus
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardStatus.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/base/ShardStatus.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Status of a shard. </p>
syntax: &o1
content: public enum ShardStatus
inheritance:
- java.lang.Object
- java.lang.Enum<ShardStatus>
- uid: com.microsoft.azure.elasticdb.shard.base._shard_status.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.base._shard_status
href: com.microsoft.azure.elasticdb.shard.base._shard_status.yml
langs:
- java
name: forValue(int value)
nameWithType: ShardStatus.forValue(int value)
fullName: static ShardStatus com.microsoft.azure.elasticdb.shard.base.ShardStatus.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.base._shard_status.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardStatus.java
startLine: 44
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static ShardStatus forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.base._shard_status
- uid: com.microsoft.azure.elasticdb.shard.base._shard_status.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.base._shard_status
href: com.microsoft.azure.elasticdb.shard.base._shard_status.yml
langs:
- java
name: getValue()
nameWithType: ShardStatus.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.base.ShardStatus.getValue()
overload: com.microsoft.azure.elasticdb.shard.base._shard_status.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardStatus.java
startLine: 48
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._shard_status.Offline
id: Offline
parent: com.microsoft.azure.elasticdb.shard.base._shard_status
href: com.microsoft.azure.elasticdb.shard.base._shard_status.yml
langs:
- java
name: Offline
nameWithType: ShardStatus.Offline
fullName: com.microsoft.azure.elasticdb.shard.base.ShardStatus.Offline
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardStatus.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> is Offline. </p>
syntax:
content: public Offline=(0)
- uid: com.microsoft.azure.elasticdb.shard.base._shard_status.Online
id: Online
parent: com.microsoft.azure.elasticdb.shard.base._shard_status
href: com.microsoft.azure.elasticdb.shard.base._shard_status.yml
langs:
- java
name: Online
nameWithType: ShardStatus.Online
fullName: com.microsoft.azure.elasticdb.shard.base.ShardStatus.Online
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardStatus.java
startLine: 22
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> is Online. </p>
syntax:
content: public Online=(1)
- uid: com.microsoft.azure.elasticdb.shard.base._shard_status.ShardStatus(int)
id: ShardStatus(int)
parent: com.microsoft.azure.elasticdb.shard.base._shard_status
href: com.microsoft.azure.elasticdb.shard.base._shard_status.yml
langs:
- java
name: ShardStatus(int value)
nameWithType: ShardStatus.ShardStatus(int value)
fullName: com.microsoft.azure.elasticdb.shard.base.ShardStatus.ShardStatus(int value)
overload: com.microsoft.azure.elasticdb.shard.base._shard_status.ShardStatus*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardStatus.java
startLine: 28
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public ShardStatus(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._shard_status.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.base._shard_status
href: com.microsoft.azure.elasticdb.shard.base._shard_status.yml
langs:
- java
name: SIZE
nameWithType: ShardStatus.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.base.ShardStatus.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardStatus.java
startLine: 24
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static final int SIZE= Integer.SIZE
return:
type: cd225469
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.base._shard_status.ShardStatus*
name: ShardStatus
nameWithType: ShardStatus.ShardStatus
fullName: com.microsoft.azure.elasticdb.shard.base.ShardStatus.ShardStatus
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_status.getValue*
name: getValue
nameWithType: ShardStatus.getValue
fullName: int com.microsoft.azure.elasticdb.shard.base.ShardStatus.getValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_status.forValue*
name: forValue
nameWithType: ShardStatus.forValue
fullName: static ShardStatus com.microsoft.azure.elasticdb.shard.base.ShardStatus.forValue
package: com.microsoft.azure.elasticdb.shard.base
- 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 implements IShardProvider<ShardLocation>
- uid: com.microsoft.azure.elasticdb.shard.base._shard_status
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_status.yml
name: ShardStatus
nameWithType: ShardStatus
fullName: com.microsoft.azure.elasticdb.shard.base.ShardStatus
type: Enum
summary: <p>Status of a shard. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,176 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._shard_update
id: _shard_update
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._shard_update.getStatus()
- com.microsoft.azure.elasticdb.shard.base._shard_update.isAnyPropertySet(ShardUpdatedProperties)
- com.microsoft.azure.elasticdb.shard.base._shard_update.setStatus(ShardStatus)
- com.microsoft.azure.elasticdb.shard.base._shard_update.ShardUpdate()
href: com.microsoft.azure.elasticdb.shard.base._shard_update.yml
langs:
- java
name: ShardUpdate
nameWithType: ShardUpdate
fullName: com.microsoft.azure.elasticdb.shard.base.ShardUpdate
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardUpdate.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/base/ShardUpdate.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Represents updates to a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>. </p>
syntax:
content: public class ShardUpdate
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.base._shard_update.getStatus()
id: getStatus()
parent: com.microsoft.azure.elasticdb.shard.base._shard_update
href: com.microsoft.azure.elasticdb.shard.base._shard_update.yml
langs:
- java
name: getStatus()
nameWithType: ShardUpdate.getStatus()
fullName: ShardStatus com.microsoft.azure.elasticdb.shard.base.ShardUpdate.getStatus()
overload: com.microsoft.azure.elasticdb.shard.base._shard_update.getStatus*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardUpdate.java
startLine: 34
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Get Status property. </p>
syntax:
content: public ShardStatus getStatus()
return:
type: com.microsoft.azure.elasticdb.shard.base._shard_status
- uid: com.microsoft.azure.elasticdb.shard.base._shard_update.isAnyPropertySet(ShardUpdatedProperties)
id: isAnyPropertySet(ShardUpdatedProperties)
parent: com.microsoft.azure.elasticdb.shard.base._shard_update
href: com.microsoft.azure.elasticdb.shard.base._shard_update.yml
langs:
- java
name: isAnyPropertySet(ShardUpdatedProperties p)
nameWithType: ShardUpdate.isAnyPropertySet(ShardUpdatedProperties p)
fullName: boolean com.microsoft.azure.elasticdb.shard.base.ShardUpdate.isAnyPropertySet(ShardUpdatedProperties p)
overload: com.microsoft.azure.elasticdb.shard.base._shard_update.isAnyPropertySet*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardUpdate.java
startLine: 55
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Checks if any of the properties specified in the given bitmap have been set by the user.</p>
<p></p>
syntax:
content: public boolean isAnyPropertySet(ShardUpdatedProperties p)
parameters:
- id: p
type: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties
description: <p>Bitmap of properties. </p>
return:
type: 4fc6e284
description: <p>True if any property is set, false otherwise. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._shard_update.setStatus(ShardStatus)
id: setStatus(ShardStatus)
parent: com.microsoft.azure.elasticdb.shard.base._shard_update
href: com.microsoft.azure.elasticdb.shard.base._shard_update.yml
langs:
- java
name: setStatus(ShardStatus value)
nameWithType: ShardUpdate.setStatus(ShardStatus value)
fullName: void com.microsoft.azure.elasticdb.shard.base.ShardUpdate.setStatus(ShardStatus value)
overload: com.microsoft.azure.elasticdb.shard.base._shard_update.setStatus*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardUpdate.java
startLine: 41
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Set Status property. </p>
syntax:
content: public void setStatus(ShardStatus value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.base._shard_status
- uid: com.microsoft.azure.elasticdb.shard.base._shard_update.ShardUpdate()
id: ShardUpdate()
parent: com.microsoft.azure.elasticdb.shard.base._shard_update
href: com.microsoft.azure.elasticdb.shard.base._shard_update.yml
langs:
- java
name: ShardUpdate()
nameWithType: ShardUpdate.ShardUpdate()
fullName: com.microsoft.azure.elasticdb.shard.base.ShardUpdate.ShardUpdate()
overload: com.microsoft.azure.elasticdb.shard.base._shard_update.ShardUpdate*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardUpdate.java
startLine: 28
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Instantiates the shard update object with no property set. </p>
syntax:
content: public ShardUpdate()
references:
- uid: com.microsoft.azure.elasticdb.shard.base._shard_update.ShardUpdate*
name: ShardUpdate
nameWithType: ShardUpdate.ShardUpdate
fullName: com.microsoft.azure.elasticdb.shard.base.ShardUpdate.ShardUpdate
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_update.getStatus*
name: getStatus
nameWithType: ShardUpdate.getStatus
fullName: ShardStatus com.microsoft.azure.elasticdb.shard.base.ShardUpdate.getStatus
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_update.setStatus*
name: setStatus
nameWithType: ShardUpdate.setStatus
fullName: void com.microsoft.azure.elasticdb.shard.base.ShardUpdate.setStatus
package: com.microsoft.azure.elasticdb.shard.base
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.base._shard_update.isAnyPropertySet*
name: isAnyPropertySet
nameWithType: ShardUpdate.isAnyPropertySet
fullName: boolean com.microsoft.azure.elasticdb.shard.base.ShardUpdate.isAnyPropertySet
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.yml
name: ShardUpdatedProperties
nameWithType: ShardUpdatedProperties
fullName: com.microsoft.azure.elasticdb.shard.base.ShardUpdatedProperties
type: Enum
summary: <p>Records the updated properties on the shard. </p>
syntax:
content: public enum ShardUpdatedProperties
- uid: com.microsoft.azure.elasticdb.shard.base._shard_status
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_status.yml
name: ShardStatus
nameWithType: ShardStatus
fullName: com.microsoft.azure.elasticdb.shard.base.ShardStatus
type: Enum
summary: <p>Status of a shard. </p>
syntax:
content: public enum ShardStatus
- 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 implements IShardProvider<ShardLocation>

Просмотреть файл

@ -0,0 +1,183 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties
id: _shard_updated_properties
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.All
- com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.forValue(int)
- com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.getValue()
- com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.ShardUpdatedProperties(int)
- com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.SIZE
- com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.Status
href: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.yml
langs:
- java
name: ShardUpdatedProperties
nameWithType: ShardUpdatedProperties
fullName: com.microsoft.azure.elasticdb.shard.base.ShardUpdatedProperties
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardUpdatedProperties.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/base/ShardUpdatedProperties.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Records the updated properties on the shard. </p>
syntax: &o1
content: public enum ShardUpdatedProperties
inheritance:
- java.lang.Object
- java.lang.Enum<ShardUpdatedProperties>
- uid: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.All
id: All
parent: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties
href: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.yml
langs:
- java
name: All
nameWithType: ShardUpdatedProperties.All
fullName: com.microsoft.azure.elasticdb.shard.base.ShardUpdatedProperties.All
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardUpdatedProperties.java
startLine: 15
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public All=(1)
- uid: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties
href: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.yml
langs:
- java
name: forValue(int value)
nameWithType: ShardUpdatedProperties.forValue(int value)
fullName: static ShardUpdatedProperties com.microsoft.azure.elasticdb.shard.base.ShardUpdatedProperties.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardUpdatedProperties.java
startLine: 37
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static ShardUpdatedProperties forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties
- uid: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties
href: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.yml
langs:
- java
name: getValue()
nameWithType: ShardUpdatedProperties.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.base.ShardUpdatedProperties.getValue()
overload: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardUpdatedProperties.java
startLine: 41
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.ShardUpdatedProperties(int)
id: ShardUpdatedProperties(int)
parent: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties
href: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.yml
langs:
- java
name: ShardUpdatedProperties(int value)
nameWithType: ShardUpdatedProperties.ShardUpdatedProperties(int value)
fullName: com.microsoft.azure.elasticdb.shard.base.ShardUpdatedProperties.ShardUpdatedProperties(int value)
overload: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.ShardUpdatedProperties*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardUpdatedProperties.java
startLine: 21
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public ShardUpdatedProperties(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties
href: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.yml
langs:
- java
name: SIZE
nameWithType: ShardUpdatedProperties.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.base.ShardUpdatedProperties.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardUpdatedProperties.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
- uid: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.Status
id: Status
parent: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties
href: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.yml
langs:
- java
name: Status
nameWithType: ShardUpdatedProperties.Status
fullName: com.microsoft.azure.elasticdb.shard.base.ShardUpdatedProperties.Status
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ShardUpdatedProperties.java
startLine: 14
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public Status=(1)
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.ShardUpdatedProperties*
name: ShardUpdatedProperties
nameWithType: ShardUpdatedProperties.ShardUpdatedProperties
fullName: com.microsoft.azure.elasticdb.shard.base.ShardUpdatedProperties.ShardUpdatedProperties
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.getValue*
name: getValue
nameWithType: ShardUpdatedProperties.getValue
fullName: int com.microsoft.azure.elasticdb.shard.base.ShardUpdatedProperties.getValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.forValue*
name: forValue
nameWithType: ShardUpdatedProperties.forValue
fullName: static ShardUpdatedProperties com.microsoft.azure.elasticdb.shard.base.ShardUpdatedProperties.forValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.yml
name: ShardUpdatedProperties
nameWithType: ShardUpdatedProperties
fullName: com.microsoft.azure.elasticdb.shard.base.ShardUpdatedProperties
type: Enum
summary: <p>Records the updated properties on the shard. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,175 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._sql_protocol
id: _sql_protocol
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._sql_protocol.forValue(int)
- com.microsoft.azure.elasticdb.shard.base._sql_protocol.getValue()
- com.microsoft.azure.elasticdb.shard.base._sql_protocol.SIZE
- com.microsoft.azure.elasticdb.shard.base._sql_protocol.SqlProtocol(int)
- com.microsoft.azure.elasticdb.shard.base._sql_protocol.XmlEnumValue
href: com.microsoft.azure.elasticdb.shard.base._sql_protocol.yml
langs:
- java
name: SqlProtocol
nameWithType: SqlProtocol
fullName: com.microsoft.azure.elasticdb.shard.base.SqlProtocol
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/SqlProtocol.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/base/SqlProtocol.java
startLine: 15
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Types of transport protocols supported in SQL Server connections. </p>
syntax: &o1
content: public enum SqlProtocol
inheritance:
- java.lang.Object
- java.lang.Enum<SqlProtocol>
- uid: com.microsoft.azure.elasticdb.shard.base._sql_protocol.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.base._sql_protocol
href: com.microsoft.azure.elasticdb.shard.base._sql_protocol.yml
langs:
- java
name: forValue(int value)
nameWithType: SqlProtocol.forValue(int value)
fullName: static SqlProtocol com.microsoft.azure.elasticdb.shard.base.SqlProtocol.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.base._sql_protocol.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/SqlProtocol.java
startLine: 60
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static SqlProtocol forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.base._sql_protocol
- uid: com.microsoft.azure.elasticdb.shard.base._sql_protocol.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.base._sql_protocol
href: com.microsoft.azure.elasticdb.shard.base._sql_protocol.yml
langs:
- java
name: getValue()
nameWithType: SqlProtocol.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.base.SqlProtocol.getValue()
overload: com.microsoft.azure.elasticdb.shard.base._sql_protocol.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/SqlProtocol.java
startLine: 64
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._sql_protocol.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.base._sql_protocol
href: com.microsoft.azure.elasticdb.shard.base._sql_protocol.yml
langs:
- java
name: SIZE
nameWithType: SqlProtocol.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.base.SqlProtocol.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/SqlProtocol.java
startLine: 40
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
- uid: com.microsoft.azure.elasticdb.shard.base._sql_protocol.SqlProtocol(int)
id: SqlProtocol(int)
parent: com.microsoft.azure.elasticdb.shard.base._sql_protocol
href: com.microsoft.azure.elasticdb.shard.base._sql_protocol.yml
langs:
- java
name: SqlProtocol(int value)
nameWithType: SqlProtocol.SqlProtocol(int value)
fullName: com.microsoft.azure.elasticdb.shard.base.SqlProtocol.SqlProtocol(int value)
overload: com.microsoft.azure.elasticdb.shard.base._sql_protocol.SqlProtocol*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/SqlProtocol.java
startLine: 44
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public SqlProtocol(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.base._sql_protocol.XmlEnumValue
id: XmlEnumValue
parent: com.microsoft.azure.elasticdb.shard.base._sql_protocol
href: com.microsoft.azure.elasticdb.shard.base._sql_protocol.yml
langs:
- java
name: XmlEnumValue
nameWithType: SqlProtocol.XmlEnumValue
fullName: com.microsoft.azure.elasticdb.shard.base.SqlProtocol.XmlEnumValue
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/SqlProtocol.java
startLine: 19
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Default protocol.</p>
<p>TCP/IP protocol.</p>
<p>Named pipes protocol.</p>
<p>Shared memory protocol. </p>
syntax:
content: >-
public XmlEnumValue=("0")
Default(0)
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.base._sql_protocol.SqlProtocol*
name: SqlProtocol
nameWithType: SqlProtocol.SqlProtocol
fullName: com.microsoft.azure.elasticdb.shard.base.SqlProtocol.SqlProtocol
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._sql_protocol.getValue*
name: getValue
nameWithType: SqlProtocol.getValue
fullName: int com.microsoft.azure.elasticdb.shard.base.SqlProtocol.getValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._sql_protocol.forValue*
name: forValue
nameWithType: SqlProtocol.forValue
fullName: static SqlProtocol com.microsoft.azure.elasticdb.shard.base.SqlProtocol.forValue
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._sql_protocol
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._sql_protocol.yml
name: SqlProtocol
nameWithType: SqlProtocol
fullName: com.microsoft.azure.elasticdb.shard.base.SqlProtocol
type: Enum
summary: <p>Types of transport protocols supported in SQL Server connections. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,272 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base._validation_utils
id: _validation_utils
parent: com.microsoft.azure.elasticdb.shard.base
children:
- com.microsoft.azure.elasticdb.shard.base._validation_utils.validateMapping(Connection,ShardMapManager,StoreShardMap,StoreMapping)
- com.microsoft.azure.elasticdb.shard.base._validation_utils.validateMappingAsync(Connection,ShardMapManager,StoreShardMap,StoreMapping)
- com.microsoft.azure.elasticdb.shard.base._validation_utils.validateShard(Connection,ShardMapManager,StoreShardMap,StoreShard)
- com.microsoft.azure.elasticdb.shard.base._validation_utils.validateShardAsync(Connection,ShardMapManager,StoreShardMap,StoreShard)
href: com.microsoft.azure.elasticdb.shard.base._validation_utils.yml
langs:
- java
name: ValidationUtils
nameWithType: ValidationUtils
fullName: com.microsoft.azure.elasticdb.shard.base.ValidationUtils
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ValidationUtils.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/base/ValidationUtils.java
startLine: 39
package: com.microsoft.azure.elasticdb.shard.base
syntax:
content: public class ValidationUtils
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.base._validation_utils.validateMapping(Connection,ShardMapManager,StoreShardMap,StoreMapping)
id: validateMapping(Connection,ShardMapManager,StoreShardMap,StoreMapping)
parent: com.microsoft.azure.elasticdb.shard.base._validation_utils
href: com.microsoft.azure.elasticdb.shard.base._validation_utils.yml
langs:
- java
name: validateMapping(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreMapping storeMapping)
nameWithType: ValidationUtils.validateMapping(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreMapping storeMapping)
fullName: static void com.microsoft.azure.elasticdb.shard.base.ValidationUtils.validateMapping(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreMapping storeMapping)
overload: com.microsoft.azure.elasticdb.shard.base._validation_utils.validateMapping*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ValidationUtils.java
startLine: 55
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Performs validation that the local representation is as up-to-date as the representation on the backing data store.</p>
<p></p>
syntax:
content: public static void validateMapping(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreMapping storeMapping)
parameters:
- id: conn
type: 8270ccc2
description: <p>Connection used for validation. </p>
- id: shardMapManager
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>ShardMapManager reference. </p>
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> map for the mapping. </p>
- id: storeMapping
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
description: <p>Mapping to validate. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._validation_utils.validateMappingAsync(Connection,ShardMapManager,StoreShardMap,StoreMapping)
id: validateMappingAsync(Connection,ShardMapManager,StoreShardMap,StoreMapping)
parent: com.microsoft.azure.elasticdb.shard.base._validation_utils
href: com.microsoft.azure.elasticdb.shard.base._validation_utils.yml
langs:
- java
name: validateMappingAsync(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreMapping storeMapping)
nameWithType: ValidationUtils.validateMappingAsync(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreMapping storeMapping)
fullName: static Callable com.microsoft.azure.elasticdb.shard.base.ValidationUtils.validateMappingAsync(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreMapping storeMapping)
overload: com.microsoft.azure.elasticdb.shard.base._validation_utils.validateMappingAsync*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ValidationUtils.java
startLine: 139
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Asynchronously performs validation that the local representation is as up-to-date as the representation on the backing data store.</p>
<p></p>
syntax:
content: public static Callable validateMappingAsync(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreMapping storeMapping)
parameters:
- id: conn
type: 8270ccc2
description: <p>Connection used for validation. </p>
- id: shardMapManager
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>ShardMapManager reference. </p>
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> map for the mapping. </p>
- id: storeMapping
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
description: <p>Mapping to validate. </p>
return:
type: b2e5ac79
description: <p>A task to await validation completion </p>
- uid: com.microsoft.azure.elasticdb.shard.base._validation_utils.validateShard(Connection,ShardMapManager,StoreShardMap,StoreShard)
id: validateShard(Connection,ShardMapManager,StoreShardMap,StoreShard)
parent: com.microsoft.azure.elasticdb.shard.base._validation_utils
href: com.microsoft.azure.elasticdb.shard.base._validation_utils.yml
langs:
- java
name: validateShard(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreShard shard)
nameWithType: ValidationUtils.validateShard(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreShard shard)
fullName: static void com.microsoft.azure.elasticdb.shard.base.ValidationUtils.validateShard(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreShard shard)
overload: com.microsoft.azure.elasticdb.shard.base._validation_utils.validateShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ValidationUtils.java
startLine: 161
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Performs validation that the local representation is as up-to-date as the representation on the backing data store.</p>
<p></p>
syntax:
content: public static void validateShard(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreShard shard)
parameters:
- id: conn
type: 8270ccc2
description: <p>Connection used for validation. </p>
- id: shardMapManager
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>ShardMapManager reference. </p>
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> map for the shard. </p>
- id: shard
type: com.microsoft.azure.elasticdb.shard.store._store_shard
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> to validate. </p>
- uid: com.microsoft.azure.elasticdb.shard.base._validation_utils.validateShardAsync(Connection,ShardMapManager,StoreShardMap,StoreShard)
id: validateShardAsync(Connection,ShardMapManager,StoreShardMap,StoreShard)
parent: com.microsoft.azure.elasticdb.shard.base._validation_utils
href: com.microsoft.azure.elasticdb.shard.base._validation_utils.yml
langs:
- java
name: validateShardAsync(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreShard shard)
nameWithType: ValidationUtils.validateShardAsync(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreShard shard)
fullName: static Callable com.microsoft.azure.elasticdb.shard.base.ValidationUtils.validateShardAsync(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreShard shard)
overload: com.microsoft.azure.elasticdb.shard.base._validation_utils.validateShardAsync*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/ValidationUtils.java
startLine: 228
package: com.microsoft.azure.elasticdb.shard.base
summary: >-
<p>Asynchronously performs validation that the local representation is as up-to-date as the representation on the backing data store.</p>
<p></p>
syntax:
content: public static Callable validateShardAsync(Connection conn, ShardMapManager shardMapManager, StoreShardMap shardMap, StoreShard shard)
parameters:
- id: conn
type: 8270ccc2
description: <p>Connection used for validation. </p>
- id: shardMapManager
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>ShardMapManager reference. </p>
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> map for the shard. </p>
- id: shard
type: com.microsoft.azure.elasticdb.shard.store._store_shard
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> to validate. </p>
return:
type: b2e5ac79
description: <p>A task to await validation completion </p>
references:
- uid: 8270ccc2
spec.java:
- name: Connection
fullName: Connection
- uid: com.microsoft.azure.elasticdb.shard.base._validation_utils.validateMapping*
name: validateMapping
nameWithType: ValidationUtils.validateMapping
fullName: static void com.microsoft.azure.elasticdb.shard.base.ValidationUtils.validateMapping
package: com.microsoft.azure.elasticdb.shard.base
- uid: b2e5ac79
spec.java:
- name: Callable
fullName: Callable
- uid: com.microsoft.azure.elasticdb.shard.base._validation_utils.validateMappingAsync*
name: validateMappingAsync
nameWithType: ValidationUtils.validateMappingAsync
fullName: static Callable com.microsoft.azure.elasticdb.shard.base.ValidationUtils.validateMappingAsync
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._validation_utils.validateShard*
name: validateShard
nameWithType: ValidationUtils.validateShard
fullName: static void com.microsoft.azure.elasticdb.shard.base.ValidationUtils.validateShard
package: com.microsoft.azure.elasticdb.shard.base
- uid: com.microsoft.azure.elasticdb.shard.base._validation_utils.validateShardAsync*
name: validateShardAsync
nameWithType: ValidationUtils.validateShardAsync
fullName: static Callable com.microsoft.azure.elasticdb.shard.base.ValidationUtils.validateShardAsync
package: com.microsoft.azure.elasticdb.shard.base
- 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.store._store_shard_map
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_shard_map.yml
name: StoreShardMap
nameWithType: StoreShardMap
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShardMap
type: Class
summary: <p>Store representation of a shard map. </p>
syntax:
content: public class StoreShardMap
- uid: com.microsoft.azure.elasticdb.shard.store._store_mapping
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_mapping.yml
name: StoreMapping
nameWithType: StoreMapping
fullName: com.microsoft.azure.elasticdb.shard.store.StoreMapping
type: Class
summary: <p>Storage representation of a mapping b/w key ranges and shards. </p>
syntax:
content: public class StoreMapping
- 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 implements IShardProvider<ShardLocation>
- uid: com.microsoft.azure.elasticdb.shard.store._store_shard
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_shard.yml
name: StoreShard
nameWithType: StoreShard
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShard
type: Class
summary: <p>Storage representation of a single shard. </p>
syntax:
content: public class StoreShard

Просмотреть файл

@ -0,0 +1,347 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.base
id: base
children:
- com.microsoft.azure.elasticdb.shard.base._base_mapping_update
- com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
- com.microsoft.azure.elasticdb.shard.base._i_mapping_update
- com.microsoft.azure.elasticdb.shard.base._i_shard_provider
- com.microsoft.azure.elasticdb.shard.base._lock_owner_id_op_type
- com.microsoft.azure.elasticdb.shard.base._lookup_options
- com.microsoft.azure.elasticdb.shard.base._mapping_kind
- com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
- com.microsoft.azure.elasticdb.shard.base._mapping_status
- com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
- com.microsoft.azure.elasticdb.shard.base._point_mapping
- com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info
- com.microsoft.azure.elasticdb.shard.base._point_mapping_update
- com.microsoft.azure.elasticdb.shard.base._range
- com.microsoft.azure.elasticdb.shard.base._range_mapping
- com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info
- com.microsoft.azure.elasticdb.shard.base._range_mapping_update
- com.microsoft.azure.elasticdb.shard.base._shard
- com.microsoft.azure.elasticdb.shard.base._shard_creation_info
- com.microsoft.azure.elasticdb.shard.base._shard_key
- com.microsoft.azure.elasticdb.shard.base._shard_key_type
- com.microsoft.azure.elasticdb.shard.base._shard_location
- com.microsoft.azure.elasticdb.shard.base._shard_range
- com.microsoft.azure.elasticdb.shard.base._shard_range._max_shard_key
- com.microsoft.azure.elasticdb.shard.base._shard_status
- com.microsoft.azure.elasticdb.shard.base._shard_update
- com.microsoft.azure.elasticdb.shard.base._shard_updated_properties
- com.microsoft.azure.elasticdb.shard.base._sql_protocol
- com.microsoft.azure.elasticdb.shard.base._validation_utils
href: com.microsoft.azure.elasticdb.shard.base.yml
langs:
- java
name: com.microsoft.azure.elasticdb.shard.base
nameWithType: com.microsoft.azure.elasticdb.shard.base
fullName: com.microsoft.azure.elasticdb.shard.base
type: Namespace
source:
remote:
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/base/BaseMappingUpdate.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/base/BaseMappingUpdate.java
syntax:
content: package com.microsoft.azure.elasticdb.shard.base
references:
- uid: com.microsoft.azure.elasticdb.shard.base._base_mapping_update
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._base_mapping_update.yml
name: BaseMappingUpdate<StatusT>
nameWithType: BaseMappingUpdate<StatusT>
fullName: com.microsoft.azure.elasticdb.shard.base.BaseMappingUpdate<StatusT>
type: Class
summary: <p>Base class for updates to mappings from shardlets to shards. </p>
syntax:
content: public class BaseMappingUpdate<StatusT> implements IMappingUpdate<StatusT>
typeParameters:
- type: "6102e815"
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_info_provider.yml
name: IMappingInfoProvider
nameWithType: IMappingInfoProvider
fullName: com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider
type: Interface
summary: <p>Interface that represents capability to provide information relevant to Add/Remove/Update operations for a mapping object. </p>
syntax:
content: public interface IMappingInfoProvider
- uid: com.microsoft.azure.elasticdb.shard.base._i_mapping_update
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._i_mapping_update.yml
name: IMappingUpdate<StatusT>
nameWithType: IMappingUpdate<StatusT>
fullName: com.microsoft.azure.elasticdb.shard.base.IMappingUpdate<StatusT>
type: Interface
summary: <p>Common interface for point/range mapping updates. </p>
syntax:
content: public interface IMappingUpdate<StatusT>
typeParameters:
- type: "6102e815"
- uid: com.microsoft.azure.elasticdb.shard.base._i_shard_provider
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.yml
name: IShardProvider<ValueT>
nameWithType: IShardProvider<ValueT>
fullName: com.microsoft.azure.elasticdb.shard.base.IShardProvider<ValueT>
type: Interface
summary: <p>Represents capabilities to provide a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> along with an associated value. </p>
syntax:
content: public interface IShardProvider<ValueT>
typeParameters:
- type: 0fb6b535
- 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
- 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._mapping_kind
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_kind.yml
name: MappingKind
nameWithType: MappingKind
fullName: com.microsoft.azure.elasticdb.shard.base.MappingKind
type: Enum
summary: <p>Types of supported mappings. </p>
syntax:
content: public enum MappingKind
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_lock_token.yml
name: MappingLockToken
nameWithType: MappingLockToken
fullName: com.microsoft.azure.elasticdb.shard.base.MappingLockToken
type: Class
summary: <p>Public type that represents the owner of a lock held on a mapping. This class is immutable. </p>
syntax:
content: public class MappingLockToken
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_status
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_status.yml
name: MappingStatus
nameWithType: MappingStatus
fullName: com.microsoft.azure.elasticdb.shard.base.MappingStatus
type: Enum
summary: <p>Status of a mapping. </p>
syntax:
content: public enum MappingStatus
- uid: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._mapping_updated_properties.yml
name: MappingUpdatedProperties
nameWithType: MappingUpdatedProperties
fullName: com.microsoft.azure.elasticdb.shard.base.MappingUpdatedProperties
type: Enum
summary: <p>Records the updated properties for a mapping update object. </p>
syntax:
content: public enum MappingUpdatedProperties
- 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 implements IShardProvider<Object>,IMappingInfoProvider
- uid: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._point_mapping_creation_info.yml
name: PointMappingCreationInfo
nameWithType: PointMappingCreationInfo
fullName: com.microsoft.azure.elasticdb.shard.base.PointMappingCreationInfo
type: Class
summary: <p>Arguments used to create a <xref uid="com.microsoft.azure.elasticdb.shard.base._point_mapping" data-throw-if-not-resolved="false">PointMapping</xref>. </p>
syntax:
content: public class PointMappingCreationInfo
- 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 extends BaseMappingUpdate<MappingStatus>
- 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._range_mapping
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._range_mapping.yml
name: RangeMapping
nameWithType: RangeMapping
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping
type: Class
summary: <p>Represents a mapping between a range of key values and a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>. </p>
syntax:
content: public class RangeMapping implements IShardProvider<Range>,IMappingInfoProvider
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._range_mapping_creation_info.yml
name: RangeMappingCreationInfo
nameWithType: RangeMappingCreationInfo
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo
type: Class
summary: <p>Arguments used to create a <xref uid="com.microsoft.azure.elasticdb.shard.base._range_mapping" data-throw-if-not-resolved="false">RangeMapping</xref>. </p>
syntax:
content: public class RangeMappingCreationInfo
- uid: com.microsoft.azure.elasticdb.shard.base._range_mapping_update
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._range_mapping_update.yml
name: RangeMappingUpdate
nameWithType: RangeMappingUpdate
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMappingUpdate
type: Class
summary: <p>Represents updates to a mapping between a <xref uid="com.microsoft.azure.elasticdb.shard.base._range" data-throw-if-not-resolved="false">Range</xref> of values and the <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> that stores its data. Also see <xref uid="com.microsoft.azure.elasticdb.shard.base._range_mapping" data-throw-if-not-resolved="false">RangeMapping</xref>. </p>
syntax:
content: public class RangeMappingUpdate extends BaseMappingUpdate<MappingStatus>
- 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 implements IShardProvider<ShardLocation>
- uid: com.microsoft.azure.elasticdb.shard.base._shard_creation_info
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_creation_info.yml
name: ShardCreationInfo
nameWithType: ShardCreationInfo
fullName: com.microsoft.azure.elasticdb.shard.base.ShardCreationInfo
type: Class
summary: <p>Arguments used to create a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>. </p>
syntax:
content: public class ShardCreationInfo
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_key.yml
name: ShardKey
nameWithType: ShardKey
fullName: com.microsoft.azure.elasticdb.shard.base.ShardKey
type: Class
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> key value. Wraps the type and value and allows normalization/denormalization for serialization. </p>
syntax:
content: public class ShardKey
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key_type
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_key_type.yml
name: ShardKeyType
nameWithType: ShardKeyType
fullName: com.microsoft.azure.elasticdb.shard.base.ShardKeyType
type: Enum
summary: <p>Type of shard key. Currently, only Int32, Int64, Guid and byte[] are the data types supported as shard keys. </p>
syntax:
content: public enum ShardKeyType
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
name: ShardLocation
nameWithType: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
type: Class
summary: <p>Represents the location of a shard in terms of its server name and database name. This is used to manage connections to the shard and to support other operations on shards. As opposed to a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>, a shard location is not registered with the shard map. </p>
syntax:
content: public class ShardLocation
- uid: com.microsoft.azure.elasticdb.shard.base._shard_range
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_range.yml
name: ShardRange
nameWithType: ShardRange
fullName: com.microsoft.azure.elasticdb.shard.base.ShardRange
type: Class
summary: <p>A range of shard keys between a low key and a high key. The low key is inclusive (part of the range) while the high key is exclusive (not part of the range). The <xref uid="com.microsoft.azure.elasticdb.shard.base._shard_range" data-throw-if-not-resolved="false">ShardRange</xref> class is immutable. </p>
syntax:
content: public class ShardRange
- uid: com.microsoft.azure.elasticdb.shard.base._shard_status
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_status.yml
name: ShardStatus
nameWithType: ShardStatus
fullName: com.microsoft.azure.elasticdb.shard.base.ShardStatus
type: Enum
summary: <p>Status of a shard. </p>
syntax:
content: public enum ShardStatus
- uid: com.microsoft.azure.elasticdb.shard.base._shard_update
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_update.yml
name: ShardUpdate
nameWithType: ShardUpdate
fullName: com.microsoft.azure.elasticdb.shard.base.ShardUpdate
type: Class
summary: <p>Represents updates to a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>. </p>
syntax:
content: public class ShardUpdate
- uid: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_updated_properties.yml
name: ShardUpdatedProperties
nameWithType: ShardUpdatedProperties
fullName: com.microsoft.azure.elasticdb.shard.base.ShardUpdatedProperties
type: Enum
summary: <p>Records the updated properties on the shard. </p>
syntax:
content: public enum ShardUpdatedProperties
- uid: com.microsoft.azure.elasticdb.shard.base._sql_protocol
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._sql_protocol.yml
name: SqlProtocol
nameWithType: SqlProtocol
fullName: com.microsoft.azure.elasticdb.shard.base.SqlProtocol
type: Enum
summary: <p>Types of transport protocols supported in SQL Server connections. </p>
syntax:
content: public enum SqlProtocol
- uid: com.microsoft.azure.elasticdb.shard.base._validation_utils
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._validation_utils.yml
name: ValidationUtils
nameWithType: ValidationUtils
fullName: com.microsoft.azure.elasticdb.shard.base.ValidationUtils
type: Class
syntax:
content: public class ValidationUtils
- uid: com.microsoft.azure.elasticdb.shard.base._shard_range._max_shard_key
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_range._max_shard_key.yml
name: ShardRange.MaxShardKey
nameWithType: ShardRange.MaxShardKey
fullName: com.microsoft.azure.elasticdb.shard.base.ShardRange.MaxShardKey
type: Class
syntax:
content: public class MaxShardKey

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -0,0 +1,296 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions
id: _shard_map_extensions
parent: com.microsoft.azure.elasticdb.shard.map
children:
- com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.asListShardMap(ShardMap)
- com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.asListShardMap(ShardMap,boolean)
- com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.asRangeShardMap(ShardMap)
- com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.asRangeShardMap(ShardMap,boolean)
- com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.getConversionException(StoreShardMap,String,String)
href: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.yml
langs:
- java
name: ShardMapExtensions
nameWithType: ShardMapExtensions
fullName: com.microsoft.azure.elasticdb.shard.map.ShardMapExtensions
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapExtensions.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/map/ShardMapExtensions.java
startLine: 22
package: com.microsoft.azure.elasticdb.shard.map
summary: <p>Extension methods on ShardMaps that allow down-casting. </p>
syntax:
content: public class ShardMapExtensions
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.asListShardMap(ShardMap)
id: asListShardMap(ShardMap)
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions
href: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.yml
langs:
- java
name: asListShardMap(ShardMap shardMap)
nameWithType: ShardMapExtensions.asListShardMap(ShardMap shardMap)
fullName: static <KeyT> ListShardMap<KeyT> com.microsoft.azure.elasticdb.shard.map.ShardMapExtensions.asListShardMap(ShardMap shardMap)
overload: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.asListShardMap*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapExtensions.java
startLine: 31
package: com.microsoft.azure.elasticdb.shard.map
summary: >-
<p>Downcasts to <xref uid="com.microsoft.azure.elasticdb.shard.map._list_shard_map" data-throw-if-not-resolved="false">ListShardMap</xref> of KeyT. </p>
<p></p>
syntax:
content: public static static<KeyT> ListShardMap<KeyT> asListShardMap(ShardMap shardMap)
parameters:
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.map._shard_map
description: <p>Input shard map. </p>
return:
type: fa29f205com.microsoft.azure.elasticdb.shard.map._list_shard_map9d2fc6d0
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.map._list_shard_map" data-throw-if-not-resolved="false">ListShardMap</xref> representation of this object. </p>
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.asListShardMap(ShardMap,boolean)
id: asListShardMap(ShardMap,boolean)
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions
href: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.yml
langs:
- java
name: asListShardMap(ShardMap shardMap, boolean throwOnFailure)
nameWithType: ShardMapExtensions.asListShardMap(ShardMap shardMap, boolean throwOnFailure)
fullName: static <KeyT> ListShardMap<KeyT> com.microsoft.azure.elasticdb.shard.map.ShardMapExtensions.asListShardMap(ShardMap shardMap, boolean throwOnFailure)
overload: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.asListShardMap*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapExtensions.java
startLine: 46
package: com.microsoft.azure.elasticdb.shard.map
summary: >-
<p>Downcasts to <xref uid="com.microsoft.azure.elasticdb.shard.map._list_shard_map" data-throw-if-not-resolved="false">ListShardMap</xref> of KeyT. </p>
<p></p>
syntax:
content: public static static<KeyT> ListShardMap<KeyT> asListShardMap(ShardMap shardMap, boolean throwOnFailure)
parameters:
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.map._shard_map
description: <p>Input shard map. </p>
- id: throwOnFailure
type: 4fc6e284
description: <p>Whether to throw exception or return null on failure. </p>
return:
type: fa29f205com.microsoft.azure.elasticdb.shard.map._list_shard_map9d2fc6d0
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.map._list_shard_map" data-throw-if-not-resolved="false">ListShardMap</xref> representation of this object. </p>
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.asRangeShardMap(ShardMap)
id: asRangeShardMap(ShardMap)
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions
href: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.yml
langs:
- java
name: asRangeShardMap(ShardMap shardMap)
nameWithType: ShardMapExtensions.asRangeShardMap(ShardMap shardMap)
fullName: static <KeyT> RangeShardMap<KeyT> com.microsoft.azure.elasticdb.shard.map.ShardMapExtensions.asRangeShardMap(ShardMap shardMap)
overload: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.asRangeShardMap*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapExtensions.java
startLine: 68
package: com.microsoft.azure.elasticdb.shard.map
summary: >-
<p>Downcasts to <xref uid="com.microsoft.azure.elasticdb.shard.map._range_shard_map" data-throw-if-not-resolved="false">RangeShardMap</xref> of KeyT. </p>
<p></p>
syntax:
content: public static static<KeyT> RangeShardMap<KeyT> asRangeShardMap(ShardMap shardMap)
parameters:
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.map._shard_map
description: <p>Input shard map. </p>
return:
type: fa29f205com.microsoft.azure.elasticdb.shard.map._range_shard_map9d2fc6d0
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.map._range_shard_map" data-throw-if-not-resolved="false">RangeShardMap</xref> representation of this object. </p>
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.asRangeShardMap(ShardMap,boolean)
id: asRangeShardMap(ShardMap,boolean)
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions
href: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.yml
langs:
- java
name: asRangeShardMap(ShardMap shardMap, boolean throwOnFailure)
nameWithType: ShardMapExtensions.asRangeShardMap(ShardMap shardMap, boolean throwOnFailure)
fullName: static <KeyT> RangeShardMap<KeyT> com.microsoft.azure.elasticdb.shard.map.ShardMapExtensions.asRangeShardMap(ShardMap shardMap, boolean throwOnFailure)
overload: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.asRangeShardMap*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapExtensions.java
startLine: 83
package: com.microsoft.azure.elasticdb.shard.map
summary: >-
<p>Downcasts to <xref uid="com.microsoft.azure.elasticdb.shard.map._range_shard_map" data-throw-if-not-resolved="false">RangeShardMap</xref> of KeyT. </p>
<p></p>
syntax:
content: public static static<KeyT> RangeShardMap<KeyT> asRangeShardMap(ShardMap shardMap, boolean throwOnFailure)
parameters:
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.map._shard_map
description: <p>Input shard map. </p>
- id: throwOnFailure
type: 4fc6e284
description: <p>Whether to throw exception or return null on failure. </p>
return:
type: fa29f205com.microsoft.azure.elasticdb.shard.map._range_shard_map9d2fc6d0
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.map._range_shard_map" data-throw-if-not-resolved="false">RangeShardMap</xref> representation of this object. </p>
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.getConversionException(StoreShardMap,String,String)
id: getConversionException(StoreShardMap,String,String)
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions
href: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.yml
langs:
- java
name: getConversionException(StoreShardMap ssm, String sourceKind, String targetKind)
nameWithType: ShardMapExtensions.getConversionException(StoreShardMap ssm, String sourceKind, String targetKind)
fullName: static ShardManagementException com.microsoft.azure.elasticdb.shard.map.ShardMapExtensions.getConversionException(StoreShardMap ssm, String sourceKind, String targetKind)
overload: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.getConversionException*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapExtensions.java
startLine: 106
package: com.microsoft.azure.elasticdb.shard.map
summary: >-
<p>Raise conversion exception. </p>
<p></p>
syntax:
content: public static ShardManagementException getConversionException(StoreShardMap ssm, String sourceKind, String targetKind)
parameters:
- id: ssm
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: <p>Shard map whose conversion failed. </p>
- id: sourceKind
type: "26831127"
- id: targetKind
type: "26831127"
description: <p>Requested type of shard map. </p>
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception
references:
- uid: fa29f205com.microsoft.azure.elasticdb.shard.map._list_shard_map9d2fc6d0
spec.java:
- name: 'static<KeyT> '
fullName: 'static<KeyT> '
- uid: com.microsoft.azure.elasticdb.shard.map._list_shard_map
name: ListShardMap
fullName: com.microsoft.azure.elasticdb.shard.map.ListShardMap
href: com.microsoft.azure.elasticdb.shard.map._list_shard_map.yml
- name: <KeyT>
fullName: <KeyT>
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.asListShardMap*
name: asListShardMap
nameWithType: ShardMapExtensions.asListShardMap
fullName: static <KeyT> ListShardMap<KeyT> com.microsoft.azure.elasticdb.shard.map.ShardMapExtensions.asListShardMap
package: com.microsoft.azure.elasticdb.shard.map
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: fa29f205com.microsoft.azure.elasticdb.shard.map._range_shard_map9d2fc6d0
spec.java:
- name: 'static<KeyT> '
fullName: 'static<KeyT> '
- uid: com.microsoft.azure.elasticdb.shard.map._range_shard_map
name: RangeShardMap
fullName: com.microsoft.azure.elasticdb.shard.map.RangeShardMap
href: com.microsoft.azure.elasticdb.shard.map._range_shard_map.yml
- name: <KeyT>
fullName: <KeyT>
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.asRangeShardMap*
name: asRangeShardMap
nameWithType: ShardMapExtensions.asRangeShardMap
fullName: static <KeyT> RangeShardMap<KeyT> com.microsoft.azure.elasticdb.shard.map.ShardMapExtensions.asRangeShardMap
package: com.microsoft.azure.elasticdb.shard.map
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.getConversionException*
name: getConversionException
nameWithType: ShardMapExtensions.getConversionException
fullName: static ShardManagementException com.microsoft.azure.elasticdb.shard.map.ShardMapExtensions.getConversionException
package: com.microsoft.azure.elasticdb.shard.map
- uid: com.microsoft.azure.elasticdb.shard.map._list_shard_map
parent: com.microsoft.azure.elasticdb.shard.map
href: com.microsoft.azure.elasticdb.shard.map._list_shard_map.yml
name: ListShardMap<KeyT>
nameWithType: ListShardMap<KeyT>
fullName: com.microsoft.azure.elasticdb.shard.map.ListShardMap<KeyT>
type: Class
summary: <p>Represents a shard map of points where points are of the specified key. </p>
syntax:
content: public class ListShardMap<KeyT> extends ShardMap
typeParameters:
- type: 3590bc99
- 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.map._range_shard_map
parent: com.microsoft.azure.elasticdb.shard.map
href: com.microsoft.azure.elasticdb.shard.map._range_shard_map.yml
name: RangeShardMap<KeyT>
nameWithType: RangeShardMap<KeyT>
fullName: com.microsoft.azure.elasticdb.shard.map.RangeShardMap<KeyT>
type: Class
summary: "<p>Represents a shard map of ranges. \r\n. </p>"
syntax:
content: public class RangeShardMap<KeyT> extends ShardMap
typeParameters:
- type: 3590bc99
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.yml
name: ShardManagementException
nameWithType: ShardManagementException
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementException
type: Class
summary: <p>Representation of exceptions that occur during storage operations. </p>
syntax:
content: public class ShardManagementException
- uid: com.microsoft.azure.elasticdb.shard.store._store_shard_map
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_shard_map.yml
name: StoreShardMap
nameWithType: StoreShardMap
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShardMap
type: Class
summary: <p>Store representation of a shard map. </p>
syntax:
content: public class StoreShardMap

Просмотреть файл

@ -0,0 +1,173 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_type
id: _shard_map_type
parent: com.microsoft.azure.elasticdb.shard.map
children:
- com.microsoft.azure.elasticdb.shard.map._shard_map_type.forValue(int)
- com.microsoft.azure.elasticdb.shard.map._shard_map_type.getValue()
- com.microsoft.azure.elasticdb.shard.map._shard_map_type.ShardMapType(int)
- com.microsoft.azure.elasticdb.shard.map._shard_map_type.SIZE
- com.microsoft.azure.elasticdb.shard.map._shard_map_type.XmlEnumValue
href: com.microsoft.azure.elasticdb.shard.map._shard_map_type.yml
langs:
- java
name: ShardMapType
nameWithType: ShardMapType
fullName: com.microsoft.azure.elasticdb.shard.map.ShardMapType
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapType.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/map/ShardMapType.java
startLine: 15
package: com.microsoft.azure.elasticdb.shard.map
summary: <p>Type of shard map. </p>
syntax: &o1
content: public enum ShardMapType
inheritance:
- java.lang.Object
- java.lang.Enum<ShardMapType>
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_type.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_type
href: com.microsoft.azure.elasticdb.shard.map._shard_map_type.yml
langs:
- java
name: forValue(int value)
nameWithType: ShardMapType.forValue(int value)
fullName: static ShardMapType com.microsoft.azure.elasticdb.shard.map.ShardMapType.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.map._shard_map_type.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapType.java
startLine: 54
package: com.microsoft.azure.elasticdb.shard.map
syntax:
content: public static ShardMapType forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.map._shard_map_type
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_type.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_type
href: com.microsoft.azure.elasticdb.shard.map._shard_map_type.yml
langs:
- java
name: getValue()
nameWithType: ShardMapType.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.map.ShardMapType.getValue()
overload: com.microsoft.azure.elasticdb.shard.map._shard_map_type.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapType.java
startLine: 58
package: com.microsoft.azure.elasticdb.shard.map
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_type.ShardMapType(int)
id: ShardMapType(int)
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_type
href: com.microsoft.azure.elasticdb.shard.map._shard_map_type.yml
langs:
- java
name: ShardMapType(int value)
nameWithType: ShardMapType.ShardMapType(int value)
fullName: com.microsoft.azure.elasticdb.shard.map.ShardMapType.ShardMapType(int value)
overload: com.microsoft.azure.elasticdb.shard.map._shard_map_type.ShardMapType*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapType.java
startLine: 38
package: com.microsoft.azure.elasticdb.shard.map
syntax:
content: public ShardMapType(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_type.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_type
href: com.microsoft.azure.elasticdb.shard.map._shard_map_type.yml
langs:
- java
name: SIZE
nameWithType: ShardMapType.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.map.ShardMapType.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapType.java
startLine: 34
package: com.microsoft.azure.elasticdb.shard.map
syntax:
content: public static final int SIZE= Integer.SIZE
return:
type: cd225469
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_type.XmlEnumValue
id: XmlEnumValue
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_type
href: com.microsoft.azure.elasticdb.shard.map._shard_map_type.yml
langs:
- java
name: XmlEnumValue
nameWithType: ShardMapType.XmlEnumValue
fullName: com.microsoft.azure.elasticdb.shard.map.ShardMapType.XmlEnumValue
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapType.java
startLine: 19
package: com.microsoft.azure.elasticdb.shard.map
summary: >-
<p>Invalid kind of shard map. Only used for serialization/deserialization.</p>
<p>Shard map with list based mappings.</p>
<p>Shard map with range based mappings. </p>
syntax:
content: >-
public XmlEnumValue=("0")
None(0)
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_type.ShardMapType*
name: ShardMapType
nameWithType: ShardMapType.ShardMapType
fullName: com.microsoft.azure.elasticdb.shard.map.ShardMapType.ShardMapType
package: com.microsoft.azure.elasticdb.shard.map
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_type.getValue*
name: getValue
nameWithType: ShardMapType.getValue
fullName: int com.microsoft.azure.elasticdb.shard.map.ShardMapType.getValue
package: com.microsoft.azure.elasticdb.shard.map
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_type.forValue*
name: forValue
nameWithType: ShardMapType.forValue
fullName: static ShardMapType com.microsoft.azure.elasticdb.shard.map.ShardMapType.forValue
package: com.microsoft.azure.elasticdb.shard.map
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_type
parent: com.microsoft.azure.elasticdb.shard.map
href: com.microsoft.azure.elasticdb.shard.map._shard_map_type.yml
name: ShardMapType
nameWithType: ShardMapType
fullName: com.microsoft.azure.elasticdb.shard.map.ShardMapType
type: Enum
summary: <p>Type of shard map. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,222 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_utils
id: _shard_map_utils
parent: com.microsoft.azure.elasticdb.shard.map
children:
- com.microsoft.azure.elasticdb.shard.map._shard_map_utils.ActiveDirectoryIntegratedStr
- com.microsoft.azure.elasticdb.shard.map._shard_map_utils.Authentication
- com.microsoft.azure.elasticdb.shard.map._shard_map_utils.ConnectRetryCount
- com.microsoft.azure.elasticdb.shard.map._shard_map_utils.createShardMapFromStoreShardMap(ShardMapManager,StoreShardMap)
- com.microsoft.azure.elasticdb.shard.map._shard_map_utils.getIsConnectionResiliencySupported()
- com.microsoft.azure.elasticdb.shard.map._shard_map_utils.setIsConnectionResiliencySupported(boolean)
href: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.yml
langs:
- java
name: ShardMapUtils
nameWithType: ShardMapUtils
fullName: com.microsoft.azure.elasticdb.shard.map.ShardMapUtils
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapUtils.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/map/ShardMapUtils.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.map
summary: <p>Helper methods related to shard map instantiation. </p>
syntax:
content: public class ShardMapUtils
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.ActiveDirectoryIntegratedStr
id: ActiveDirectoryIntegratedStr
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_utils
href: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.yml
langs:
- java
name: ActiveDirectoryIntegratedStr
nameWithType: ShardMapUtils.ActiveDirectoryIntegratedStr
fullName: final String com.microsoft.azure.elasticdb.shard.map.ShardMapUtils.ActiveDirectoryIntegratedStr
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapUtils.java
startLine: 33
package: com.microsoft.azure.elasticdb.shard.map
summary: <p>String representation of SqlAuthenticationMethod.ActiveDirectoryIntegrated SqlAuthenticationMethod.ActiveDirectoryIntegrated.ToString() cannot be used because it may not be available in the .NET framework version that we are running in </p>
syntax:
content: public static final String ActiveDirectoryIntegratedStr= "ActiveDirectoryIntegrated"
return:
type: 3d93591e
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.Authentication
id: Authentication
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_utils
href: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.yml
langs:
- java
name: Authentication
nameWithType: ShardMapUtils.Authentication
fullName: final String com.microsoft.azure.elasticdb.shard.map.ShardMapUtils.Authentication
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapUtils.java
startLine: 27
package: com.microsoft.azure.elasticdb.shard.map
summary: <p>SqlConnectionStringBuilder property that allows specifying active directoty authentication to connect to SQL instance. </p>
syntax:
content: public static final String Authentication= "Authentication"
return:
type: 3d93591e
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.ConnectRetryCount
id: ConnectRetryCount
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_utils
href: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.yml
langs:
- java
name: ConnectRetryCount
nameWithType: ShardMapUtils.ConnectRetryCount
fullName: final String com.microsoft.azure.elasticdb.shard.map.ShardMapUtils.ConnectRetryCount
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapUtils.java
startLine: 22
package: com.microsoft.azure.elasticdb.shard.map
summary: <p>SqlConnectionStringBuilder property that allows one to specify the number of reconnect attempts on connection failure. </p>
syntax:
content: public static final String ConnectRetryCount= "ConnectRetryCount"
return:
type: 3d93591e
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.createShardMapFromStoreShardMap(ShardMapManager,StoreShardMap)
id: createShardMapFromStoreShardMap(ShardMapManager,StoreShardMap)
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_utils
href: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.yml
langs:
- java
name: createShardMapFromStoreShardMap(ShardMapManager shardMapManager, StoreShardMap ssm)
nameWithType: ShardMapUtils.createShardMapFromStoreShardMap(ShardMapManager shardMapManager, StoreShardMap ssm)
fullName: static ShardMap com.microsoft.azure.elasticdb.shard.map.ShardMapUtils.createShardMapFromStoreShardMap(ShardMapManager shardMapManager, StoreShardMap ssm)
overload: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.createShardMapFromStoreShardMap*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapUtils.java
startLine: 66
package: com.microsoft.azure.elasticdb.shard.map
summary: >-
<p>Converts StoreShardMap to <xref uid="com.microsoft.azure.elasticdb.shard.map._shard_map" data-throw-if-not-resolved="false">ShardMap</xref>.</p>
<p></p>
syntax:
content: public static ShardMap createShardMapFromStoreShardMap(ShardMapManager shardMapManager, StoreShardMap ssm)
parameters:
- id: shardMapManager
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>Reference to shard map manager. </p>
- id: ssm
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: <p>Storage representation for <xref uid="com.microsoft.azure.elasticdb.shard.map._shard_map" data-throw-if-not-resolved="false">ShardMap</xref>. </p>
return:
type: com.microsoft.azure.elasticdb.shard.map._shard_map
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.map._shard_map" data-throw-if-not-resolved="false">ShardMap</xref> object corresponding to storange representation. </p>
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.getIsConnectionResiliencySupported()
id: getIsConnectionResiliencySupported()
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_utils
href: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.yml
langs:
- java
name: getIsConnectionResiliencySupported()
nameWithType: ShardMapUtils.getIsConnectionResiliencySupported()
fullName: static boolean com.microsoft.azure.elasticdb.shard.map.ShardMapUtils.getIsConnectionResiliencySupported()
overload: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.getIsConnectionResiliencySupported*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapUtils.java
startLine: 49
package: com.microsoft.azure.elasticdb.shard.map
syntax:
content: public static boolean getIsConnectionResiliencySupported()
return:
type: 4fc6e284
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.setIsConnectionResiliencySupported(boolean)
id: setIsConnectionResiliencySupported(boolean)
parent: com.microsoft.azure.elasticdb.shard.map._shard_map_utils
href: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.yml
langs:
- java
name: setIsConnectionResiliencySupported(boolean value)
nameWithType: ShardMapUtils.setIsConnectionResiliencySupported(boolean value)
fullName: static void com.microsoft.azure.elasticdb.shard.map.ShardMapUtils.setIsConnectionResiliencySupported(boolean value)
overload: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.setIsConnectionResiliencySupported*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ShardMapUtils.java
startLine: 53
package: com.microsoft.azure.elasticdb.shard.map
syntax:
content: public static void setIsConnectionResiliencySupported(boolean value)
parameters:
- id: value
type: 4fc6e284
references:
- uid: 3d93591e
spec.java:
- name: final String
fullName: final String
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.getIsConnectionResiliencySupported*
name: getIsConnectionResiliencySupported
nameWithType: ShardMapUtils.getIsConnectionResiliencySupported
fullName: static boolean com.microsoft.azure.elasticdb.shard.map.ShardMapUtils.getIsConnectionResiliencySupported
package: com.microsoft.azure.elasticdb.shard.map
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.setIsConnectionResiliencySupported*
name: setIsConnectionResiliencySupported
nameWithType: ShardMapUtils.setIsConnectionResiliencySupported
fullName: static void com.microsoft.azure.elasticdb.shard.map.ShardMapUtils.setIsConnectionResiliencySupported
package: com.microsoft.azure.elasticdb.shard.map
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.createShardMapFromStoreShardMap*
name: createShardMapFromStoreShardMap
nameWithType: ShardMapUtils.createShardMapFromStoreShardMap
fullName: static ShardMap com.microsoft.azure.elasticdb.shard.map.ShardMapUtils.createShardMapFromStoreShardMap
package: com.microsoft.azure.elasticdb.shard.map
- 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.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.store._store_shard_map
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_shard_map.yml
name: StoreShardMap
nameWithType: StoreShardMap
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShardMap
type: Class
summary: <p>Store representation of a shard map. </p>
syntax:
content: public class StoreShardMap

Просмотреть файл

@ -0,0 +1,91 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.map
id: map
children:
- com.microsoft.azure.elasticdb.shard.map._list_shard_map
- com.microsoft.azure.elasticdb.shard.map._range_shard_map
- com.microsoft.azure.elasticdb.shard.map._shard_map
- com.microsoft.azure.elasticdb.shard.map._shard_map_extensions
- com.microsoft.azure.elasticdb.shard.map._shard_map_type
- com.microsoft.azure.elasticdb.shard.map._shard_map_utils
href: com.microsoft.azure.elasticdb.shard.map.yml
langs:
- java
name: com.microsoft.azure.elasticdb.shard.map
nameWithType: com.microsoft.azure.elasticdb.shard.map
fullName: com.microsoft.azure.elasticdb.shard.map
type: Namespace
source:
remote:
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/map/ListShardMap.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/map/ListShardMap.java
syntax:
content: package com.microsoft.azure.elasticdb.shard.map
references:
- uid: com.microsoft.azure.elasticdb.shard.map._list_shard_map
parent: com.microsoft.azure.elasticdb.shard.map
href: com.microsoft.azure.elasticdb.shard.map._list_shard_map.yml
name: ListShardMap<KeyT>
nameWithType: ListShardMap<KeyT>
fullName: com.microsoft.azure.elasticdb.shard.map.ListShardMap<KeyT>
type: Class
summary: <p>Represents a shard map of points where points are of the specified key. </p>
syntax:
content: public class ListShardMap<KeyT> extends ShardMap
typeParameters:
- type: 3590bc99
- uid: com.microsoft.azure.elasticdb.shard.map._range_shard_map
parent: com.microsoft.azure.elasticdb.shard.map
href: com.microsoft.azure.elasticdb.shard.map._range_shard_map.yml
name: RangeShardMap<KeyT>
nameWithType: RangeShardMap<KeyT>
fullName: com.microsoft.azure.elasticdb.shard.map.RangeShardMap<KeyT>
type: Class
summary: "<p>Represents a shard map of ranges. \r\n. </p>"
syntax:
content: public class RangeShardMap<KeyT> extends ShardMap
typeParameters:
- type: 3590bc99
- 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.map._shard_map_extensions
parent: com.microsoft.azure.elasticdb.shard.map
href: com.microsoft.azure.elasticdb.shard.map._shard_map_extensions.yml
name: ShardMapExtensions
nameWithType: ShardMapExtensions
fullName: com.microsoft.azure.elasticdb.shard.map.ShardMapExtensions
type: Class
summary: <p>Extension methods on ShardMaps that allow down-casting. </p>
syntax:
content: public class ShardMapExtensions
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_type
parent: com.microsoft.azure.elasticdb.shard.map
href: com.microsoft.azure.elasticdb.shard.map._shard_map_type.yml
name: ShardMapType
nameWithType: ShardMapType
fullName: com.microsoft.azure.elasticdb.shard.map.ShardMapType
type: Enum
summary: <p>Type of shard map. </p>
syntax:
content: public enum ShardMapType
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_utils
parent: com.microsoft.azure.elasticdb.shard.map
href: com.microsoft.azure.elasticdb.shard.map._shard_map_utils.yml
name: ShardMapUtils
nameWithType: ShardMapUtils
fullName: com.microsoft.azure.elasticdb.shard.map.ShardMapUtils
type: Class
summary: <p>Helper methods related to shard map instantiation. </p>
syntax:
content: public class ShardMapUtils

Просмотреть файл

@ -0,0 +1,318 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
id: _shard_management_error_category
parent: com.microsoft.azure.elasticdb.shard.mapmanager
children:
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.forValue(int)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.General
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.getValue()
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.ListShardMap
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.RangeShardMap
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.Recovery
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.SchemaInfoCollection
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.ShardManagementErrorCategory(int)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.ShardMap
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.ShardMapManager
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.ShardMapManagerFactory
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.SIZE
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.Validation
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
langs:
- java
name: ShardManagementErrorCategory
nameWithType: ShardManagementErrorCategory
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCategory.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/mapmanager/ShardManagementErrorCategory.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Represents error categories related to Shard Management operations. </p>
syntax: &o1
content: public enum ShardManagementErrorCategory
inheritance:
- java.lang.Object
- java.lang.Enum<ShardManagementErrorCategory>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
langs:
- java
name: forValue(int value)
nameWithType: ShardManagementErrorCategory.forValue(int value)
fullName: static ShardManagementErrorCategory com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCategory.java
startLine: 79
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public static ShardManagementErrorCategory forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.General
id: General
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
langs:
- java
name: General
nameWithType: ShardManagementErrorCategory.General
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.General
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCategory.java
startLine: 57
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>General failure category. </p>
syntax:
content: public General=(8)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
langs:
- java
name: getValue()
nameWithType: ShardManagementErrorCategory.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.getValue()
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCategory.java
startLine: 83
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.ListShardMap
id: ListShardMap
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
langs:
- java
name: ListShardMap
nameWithType: ShardManagementErrorCategory.ListShardMap
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.ListShardMap
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCategory.java
startLine: 32
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>List shard map. </p>
syntax:
content: public ListShardMap=(3)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.RangeShardMap
id: RangeShardMap
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
langs:
- java
name: RangeShardMap
nameWithType: ShardManagementErrorCategory.RangeShardMap
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.RangeShardMap
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCategory.java
startLine: 37
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Range shard map. </p>
syntax:
content: public RangeShardMap=(4)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.Recovery
id: Recovery
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
langs:
- java
name: Recovery
nameWithType: ShardManagementErrorCategory.Recovery
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.Recovery
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCategory.java
startLine: 47
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Recovery oriented errors. </p>
syntax:
content: public Recovery=(6)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.SchemaInfoCollection
id: SchemaInfoCollection
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
langs:
- java
name: SchemaInfoCollection
nameWithType: ShardManagementErrorCategory.SchemaInfoCollection
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.SchemaInfoCollection
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCategory.java
startLine: 52
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Errors related to Schema Info Collection. </p>
syntax:
content: public SchemaInfoCollection=(7)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.ShardManagementErrorCategory(int)
id: ShardManagementErrorCategory(int)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
langs:
- java
name: ShardManagementErrorCategory(int value)
nameWithType: ShardManagementErrorCategory.ShardManagementErrorCategory(int value)
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.ShardManagementErrorCategory(int value)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.ShardManagementErrorCategory*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCategory.java
startLine: 63
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public ShardManagementErrorCategory(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.ShardMap
id: ShardMap
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
langs:
- java
name: ShardMap
nameWithType: ShardManagementErrorCategory.ShardMap
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.ShardMap
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCategory.java
startLine: 27
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>ShardMap. </p>
syntax:
content: public ShardMap=(2)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.ShardMapManager
id: ShardMapManager
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
langs:
- java
name: ShardMapManager
nameWithType: ShardManagementErrorCategory.ShardMapManager
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.ShardMapManager
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCategory.java
startLine: 22
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>ShardMap manager. </p>
syntax:
content: public ShardMapManager=(1)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.ShardMapManagerFactory
id: ShardMapManagerFactory
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
langs:
- java
name: ShardMapManagerFactory
nameWithType: ShardManagementErrorCategory.ShardMapManagerFactory
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.ShardMapManagerFactory
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCategory.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>ShardMap manager factory. </p>
syntax:
content: public ShardMapManagerFactory=(0)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
langs:
- java
name: SIZE
nameWithType: ShardManagementErrorCategory.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCategory.java
startLine: 59
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.Validation
id: Validation
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
langs:
- java
name: Validation
nameWithType: ShardManagementErrorCategory.Validation
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.Validation
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCategory.java
startLine: 42
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Version validation. </p>
syntax:
content: public Validation=(5)
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.ShardManagementErrorCategory*
name: ShardManagementErrorCategory
nameWithType: ShardManagementErrorCategory.ShardManagementErrorCategory
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.ShardManagementErrorCategory
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.getValue*
name: getValue
nameWithType: ShardManagementErrorCategory.getValue
fullName: int com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.getValue
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.forValue*
name: forValue
nameWithType: ShardManagementErrorCategory.forValue
fullName: static ShardManagementErrorCategory com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory.forValue
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
name: ShardManagementErrorCategory
nameWithType: ShardManagementErrorCategory
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory
type: Enum
summary: <p>Represents error categories related to Shard Management operations. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,757 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
id: _shard_management_error_code
parent: com.microsoft.azure.elasticdb.shard.mapmanager
children:
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.forValue(int)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.getValue()
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.GlobalStoreOperationInsufficientParameters
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.GlobalStoreVersionMismatch
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.LocalStoreOperationInsufficientParameters
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.LocalStoreVersionMismatch
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.LockNotAcquired
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.LockNotReleased
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingDoesNotExist
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingIsAlreadyLocked
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingIsNotOffline
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingIsOffline
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingLockOwnerIdDoesNotMatch
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingNotFoundForKey
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingPointAlreadyMapped
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingRangeAlreadyMapped
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingsKillConnectionFailure
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardAlreadyExists
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardDoesNotExist
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardHasMappings
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardLocationAlreadyExists
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardManagementErrorCode(int)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardMapAlreadyExists
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardMapDoesNotExist
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardMapHasShards
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardMapLookupFailure
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardMapManagerStoreAlreadyExists
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardMapManagerStoreDoesNotExist
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardMapTypeConversionError
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardNotValid
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardVersionMismatch
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.SIZE
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.StorageOperationFailure
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.Success
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.UnexpectedError
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: ShardManagementErrorCode
nameWithType: ShardManagementErrorCode
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.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/mapmanager/ShardManagementErrorCode.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Represents error codes related to <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> operations. </p>
syntax: &o1
content: public enum ShardManagementErrorCode
inheritance:
- java.lang.Object
- java.lang.Enum<ShardManagementErrorCode>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: forValue(int value)
nameWithType: ShardManagementErrorCode.forValue(int value)
fullName: static ShardManagementErrorCode com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 221
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public static ShardManagementErrorCode forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: getValue()
nameWithType: ShardManagementErrorCode.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.getValue()
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 225
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.GlobalStoreOperationInsufficientParameters
id: GlobalStoreOperationInsufficientParameters
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: GlobalStoreOperationInsufficientParameters
nameWithType: ShardManagementErrorCode.GlobalStoreOperationInsufficientParameters
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.GlobalStoreOperationInsufficientParameters
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 63
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>All necessary parameters for GSM stored procedure are not supplied. </p>
syntax:
content: public GlobalStoreOperationInsufficientParameters=(26)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.GlobalStoreVersionMismatch
id: GlobalStoreVersionMismatch
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: GlobalStoreVersionMismatch
nameWithType: ShardManagementErrorCode.GlobalStoreVersionMismatch
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.GlobalStoreVersionMismatch
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 53
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>GSM store version does not match with client library. </p>
syntax:
content: public GlobalStoreVersionMismatch=(24)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.LocalStoreOperationInsufficientParameters
id: LocalStoreOperationInsufficientParameters
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: LocalStoreOperationInsufficientParameters
nameWithType: ShardManagementErrorCode.LocalStoreOperationInsufficientParameters
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.LocalStoreOperationInsufficientParameters
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 68
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>All necessary parameters for LSM stored procedure are not supplied. </p>
syntax:
content: public LocalStoreOperationInsufficientParameters=(27)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.LocalStoreVersionMismatch
id: LocalStoreVersionMismatch
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: LocalStoreVersionMismatch
nameWithType: ShardManagementErrorCode.LocalStoreVersionMismatch
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.LocalStoreVersionMismatch
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 58
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>LSM store version does not match with client library. </p>
syntax:
content: public LocalStoreVersionMismatch=(25)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.LockNotAcquired
id: LockNotAcquired
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: LockNotAcquired
nameWithType: ShardManagementErrorCode.LockNotAcquired
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.LockNotAcquired
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 139
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>An application lock could not be acquired. </p>
syntax:
content: public LockNotAcquired=(64)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.LockNotReleased
id: LockNotReleased
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: LockNotReleased
nameWithType: ShardManagementErrorCode.LockNotReleased
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.LockNotReleased
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 144
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>An application lock count not be released. </p>
syntax:
content: public LockNotReleased=(65)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingDoesNotExist
id: MappingDoesNotExist
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: MappingDoesNotExist
nameWithType: ShardManagementErrorCode.MappingDoesNotExist
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.MappingDoesNotExist
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 158
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>#endregion Common </p><p>#region Common Mapper Specified mapping no longer exists. </p>
syntax:
content: public MappingDoesNotExist=(71)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingIsAlreadyLocked
id: MappingIsAlreadyLocked
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: MappingIsAlreadyLocked
nameWithType: ShardManagementErrorCode.MappingIsAlreadyLocked
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.MappingIsAlreadyLocked
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 188
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Specified mapping has already been locked. </p>
syntax:
content: public MappingIsAlreadyLocked=(77)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingIsNotOffline
id: MappingIsNotOffline
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: MappingIsNotOffline
nameWithType: ShardManagementErrorCode.MappingIsNotOffline
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.MappingIsNotOffline
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 178
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Specified mapping is not offline which certain management operations warrant. </p>
syntax:
content: public MappingIsNotOffline=(75)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingIsOffline
id: MappingIsOffline
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: MappingIsOffline
nameWithType: ShardManagementErrorCode.MappingIsOffline
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.MappingIsOffline
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 168
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Specified mapping is offline. </p>
syntax:
content: public MappingIsOffline=(73)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingLockOwnerIdDoesNotMatch
id: MappingLockOwnerIdDoesNotMatch
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: MappingLockOwnerIdDoesNotMatch
nameWithType: ShardManagementErrorCode.MappingLockOwnerIdDoesNotMatch
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.MappingLockOwnerIdDoesNotMatch
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 183
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Specified mapping is locked and the given lock owner id does not match the owner id in the store. </p>
syntax:
content: public MappingLockOwnerIdDoesNotMatch=(76)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingNotFoundForKey
id: MappingNotFoundForKey
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: MappingNotFoundForKey
nameWithType: ShardManagementErrorCode.MappingNotFoundForKey
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.MappingNotFoundForKey
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 163
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Could not locate a mapping corresponding to given key. </p>
syntax:
content: public MappingNotFoundForKey=(72)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingPointAlreadyMapped
id: MappingPointAlreadyMapped
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: MappingPointAlreadyMapped
nameWithType: ShardManagementErrorCode.MappingPointAlreadyMapped
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.MappingPointAlreadyMapped
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 106
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>#endregion </p><p>#region PointMapping Given point is already associated with a mapping. </p>
syntax:
content: public MappingPointAlreadyMapped=(41)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingRangeAlreadyMapped
id: MappingRangeAlreadyMapped
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: MappingRangeAlreadyMapped
nameWithType: ShardManagementErrorCode.MappingRangeAlreadyMapped
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.MappingRangeAlreadyMapped
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 115
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>#endregion PointMapping </p><p>#region RangeMapping Specified range is already associated with a mapping. </p>
syntax:
content: public MappingRangeAlreadyMapped=(51)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.MappingsKillConnectionFailure
id: MappingsKillConnectionFailure
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: MappingsKillConnectionFailure
nameWithType: ShardManagementErrorCode.MappingsKillConnectionFailure
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.MappingsKillConnectionFailure
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 173
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Could not terminate connections associated with the Specified mapping. </p>
syntax:
content: public MappingsKillConnectionFailure=(74)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardAlreadyExists
id: ShardAlreadyExists
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: ShardAlreadyExists
nameWithType: ShardManagementErrorCode.ShardAlreadyExists
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.ShardAlreadyExists
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 87
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Shard already exists. </p>
syntax:
content: public ShardAlreadyExists=(33)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardDoesNotExist
id: ShardDoesNotExist
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: ShardDoesNotExist
nameWithType: ShardManagementErrorCode.ShardDoesNotExist
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.ShardDoesNotExist
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 134
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Shard does not exist any more. </p>
syntax:
content: public ShardDoesNotExist=(63)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardHasMappings
id: ShardHasMappings
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: ShardHasMappings
nameWithType: ShardManagementErrorCode.ShardHasMappings
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.ShardHasMappings
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 82
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Shard has mappings associated with it. </p>
syntax:
content: public ShardHasMappings=(32)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardLocationAlreadyExists
id: ShardLocationAlreadyExists
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: ShardLocationAlreadyExists
nameWithType: ShardManagementErrorCode.ShardLocationAlreadyExists
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.ShardLocationAlreadyExists
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 92
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Shard location already exists. </p>
syntax:
content: public ShardLocationAlreadyExists=(34)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardManagementErrorCode(int)
id: ShardManagementErrorCode(int)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: ShardManagementErrorCode(int value)
nameWithType: ShardManagementErrorCode.ShardManagementErrorCode(int value)
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.ShardManagementErrorCode(int value)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardManagementErrorCode*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 205
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public ShardManagementErrorCode(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardMapAlreadyExists
id: ShardMapAlreadyExists
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: ShardMapAlreadyExists
nameWithType: ShardManagementErrorCode.ShardMapAlreadyExists
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.ShardMapAlreadyExists
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 38
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>#endregion </p><p>#region <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> ShardMap with specified name already exists. </p>
syntax:
content: public ShardMapAlreadyExists=(21)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardMapDoesNotExist
id: ShardMapDoesNotExist
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: ShardMapDoesNotExist
nameWithType: ShardManagementErrorCode.ShardMapDoesNotExist
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.ShardMapDoesNotExist
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 129
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>ShardMap does not exist any more. </p>
syntax:
content: public ShardMapDoesNotExist=(62)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardMapHasShards
id: ShardMapHasShards
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: ShardMapHasShards
nameWithType: ShardManagementErrorCode.ShardMapHasShards
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.ShardMapHasShards
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 48
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>ShardMap has shards associated with it. </p>
syntax:
content: public ShardMapHasShards=(23)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardMapLookupFailure
id: ShardMapLookupFailure
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: ShardMapLookupFailure
nameWithType: ShardManagementErrorCode.ShardMapLookupFailure
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.ShardMapLookupFailure
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 43
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>ShardMap with specified name not found. </p>
syntax:
content: public ShardMapLookupFailure=(22)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardMapManagerStoreAlreadyExists
id: ShardMapManagerStoreAlreadyExists
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: ShardMapManagerStoreAlreadyExists
nameWithType: ShardManagementErrorCode.ShardMapManagerStoreAlreadyExists
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.ShardMapManagerStoreAlreadyExists
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 24
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>#region <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory" data-throw-if-not-resolved="false">ShardMapManagerFactory</xref></p><p>Store already exists on target shard map manager database. </p>
syntax:
content: public ShardMapManagerStoreAlreadyExists=(11)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardMapManagerStoreDoesNotExist
id: ShardMapManagerStoreDoesNotExist
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: ShardMapManagerStoreDoesNotExist
nameWithType: ShardManagementErrorCode.ShardMapManagerStoreDoesNotExist
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.ShardMapManagerStoreDoesNotExist
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 29
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Store does not exist on target shard map manager database. </p>
syntax:
content: public ShardMapManagerStoreDoesNotExist=(12)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardMapTypeConversionError
id: ShardMapTypeConversionError
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: ShardMapTypeConversionError
nameWithType: ShardManagementErrorCode.ShardMapTypeConversionError
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.ShardMapTypeConversionError
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 77
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>#endregion </p><p>#region ShardMap Conversion of shard map failed. </p>
syntax:
content: public ShardMapTypeConversionError=(31)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardNotValid
id: ShardNotValid
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: ShardNotValid
nameWithType: ShardManagementErrorCode.ShardNotValid
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.ShardNotValid
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 197
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>#endregion Common Mapper </p><p>#region Recovery Shard does not have storage structures. </p>
syntax:
content: public ShardNotValid=(81)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardVersionMismatch
id: ShardVersionMismatch
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: ShardVersionMismatch
nameWithType: ShardManagementErrorCode.ShardVersionMismatch
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.ShardVersionMismatch
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 97
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Shard has been updated by concurrent user. </p>
syntax:
content: public ShardVersionMismatch=(35)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: SIZE
nameWithType: ShardManagementErrorCode.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 201
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>#endregion </p>
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.StorageOperationFailure
id: StorageOperationFailure
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: StorageOperationFailure
nameWithType: ShardManagementErrorCode.StorageOperationFailure
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.StorageOperationFailure
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 124
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>#endregion RangeMapping </p><p>#region Common Storage operation failed. </p>
syntax:
content: public StorageOperationFailure=(61)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.Success
id: Success
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: Success
nameWithType: ShardManagementErrorCode.Success
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.Success
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Successful execution. </p>
syntax:
content: public Success=(0)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.UnexpectedError
id: UnexpectedError
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
langs:
- java
name: UnexpectedError
nameWithType: ShardManagementErrorCode.UnexpectedError
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.UnexpectedError
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCode.java
startLine: 149
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>An unexpected error has occurred. </p>
syntax:
content: public UnexpectedError=(66)
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.ShardManagementErrorCode*
name: ShardManagementErrorCode
nameWithType: ShardManagementErrorCode.ShardManagementErrorCode
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.ShardManagementErrorCode
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.getValue*
name: getValue
nameWithType: ShardManagementErrorCode.getValue
fullName: int com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.getValue
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.forValue*
name: forValue
nameWithType: ShardManagementErrorCode.forValue
fullName: static ShardManagementErrorCode com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode.forValue
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.yml
name: ShardMapManagerFactory
nameWithType: ShardMapManagerFactory
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory
type: Class
summary: <p>Factory for <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref>s facilitates the creation and management of shard map manager persistent state. Use this class as the entry point to the library's object hierarchy. </p>
syntax:
content: public class ShardMapManagerFactory
- 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.mapmanager._shard_management_error_code
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
name: ShardManagementErrorCode
nameWithType: ShardManagementErrorCode
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode
type: Enum
summary: <p>Represents error codes related to <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> operations. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,261 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception
id: _shard_management_exception
parent: com.microsoft.azure.elasticdb.shard.mapmanager
children:
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.getErrorCategory()
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.getErrorCode()
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.ShardManagementException(ShardManagementErrorCategory,ShardManagementErrorCode,String,Object...)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.ShardManagementException(ShardManagementErrorCategory,ShardManagementErrorCode,String,RuntimeException,Object...)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.ShardManagementException(ShardManagementErrorCategory,ShardManagementErrorCode,String)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.ShardManagementException(ShardManagementErrorCategory,ShardManagementErrorCode,String,RuntimeException)
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.yml
langs:
- java
name: ShardManagementException
nameWithType: ShardManagementException
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementException
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementException.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/mapmanager/ShardManagementException.java
startLine: 16
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Representation of exceptions that occur during storage operations. </p>
syntax:
content: public class ShardManagementException
inheritance:
- java.lang.Object
- RuntimeException
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.getErrorCategory()
id: getErrorCategory()
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.yml
langs:
- java
name: getErrorCategory()
nameWithType: ShardManagementException.getErrorCategory()
fullName: ShardManagementErrorCategory com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementException.getErrorCategory()
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.getErrorCategory*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementException.java
startLine: 111
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public ShardManagementErrorCategory getErrorCategory()
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.getErrorCode()
id: getErrorCode()
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.yml
langs:
- java
name: getErrorCode()
nameWithType: ShardManagementException.getErrorCode()
fullName: ShardManagementErrorCode com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementException.getErrorCode()
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.getErrorCode*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementException.java
startLine: 119
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public ShardManagementErrorCode getErrorCode()
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.ShardManagementException(ShardManagementErrorCategory,ShardManagementErrorCode,String,Object...)
id: )
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.yml
langs:
- java
name: ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String format, Object... args)
nameWithType: ShardManagementException.ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String format, Object... args)
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementException.ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String format, Object... args)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.ShardManagementException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementException.java
startLine: 57
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Initializes a new instance with a specified formatted error message.</p>
<p></p>
syntax:
content: public ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String format, Object... args)
parameters:
- id: category
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
description: <p>Category of error. </p>
- id: code
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
description: <p>Error code. </p>
- id: format
type: "26831127"
description: <p>The format message that describes the error </p>
- id: args
type: 1355eaf1
description: <p>The arguments to the format string </p>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.ShardManagementException(ShardManagementErrorCategory,ShardManagementErrorCode,String,RuntimeException,Object...)
id: )
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.yml
langs:
- java
name: ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String format, RuntimeException inner, Object... args)
nameWithType: ShardManagementException.ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String format, RuntimeException inner, Object... args)
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementException.ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String format, RuntimeException inner, Object... args)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.ShardManagementException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementException.java
startLine: 101
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Initializes a new instance with a specified formatted error message and a reference to the inner exception that is the cause of this exception.</p>
<p></p>
syntax:
content: public ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String format, RuntimeException inner, Object... args)
parameters:
- id: category
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
description: <p>Category of error. </p>
- id: code
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
description: <p>Error code. </p>
- id: format
type: "26831127"
description: <p>The format message that describes the error </p>
- id: inner
type: 9b2a4515
description: <p>The exception that is the cause of the current exception </p>
- id: args
type: 1355eaf1
description: <p>The arguments to the format string </p>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.ShardManagementException(ShardManagementErrorCategory,ShardManagementErrorCode,String)
id: ShardManagementException(ShardManagementErrorCategory,ShardManagementErrorCode,String)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.yml
langs:
- java
name: ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String message)
nameWithType: ShardManagementException.ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String message)
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementException.ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String message)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.ShardManagementException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementException.java
startLine: 37
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Initializes a new instance with a specified error message.</p>
<p></p>
syntax:
content: public ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String message)
parameters:
- id: category
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
description: <p>Category of error. </p>
- id: code
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
description: <p>Error code. </p>
- id: message
type: "26831127"
description: <p>Error message. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.ShardManagementException(ShardManagementErrorCategory,ShardManagementErrorCode,String,RuntimeException)
id: ShardManagementException(ShardManagementErrorCategory,ShardManagementErrorCode,String,RuntimeException)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.yml
langs:
- java
name: ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String message, RuntimeException inner)
nameWithType: ShardManagementException.ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String message, RuntimeException inner)
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementException.ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String message, RuntimeException inner)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.ShardManagementException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementException.java
startLine: 78
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Initializes a new instance with a specified error message and a reference to the inner exception that is the cause of this exception.</p>
<p></p>
syntax:
content: public ShardManagementException(ShardManagementErrorCategory category, ShardManagementErrorCode code, String message, RuntimeException inner)
parameters:
- id: category
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
description: <p>Category of error. </p>
- id: code
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
description: <p>Error code. </p>
- id: message
type: "26831127"
description: <p>A message that describes the error </p>
- id: inner
type: 9b2a4515
description: <p>The exception that is the cause of the current exception </p>
references:
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.ShardManagementException*
name: ShardManagementException
nameWithType: ShardManagementException.ShardManagementException
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementException.ShardManagementException
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: 1355eaf1
spec.java:
- name: Object...
fullName: Object...
- uid: 9b2a4515
spec.java:
- name: RuntimeException
fullName: RuntimeException
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.getErrorCategory*
name: getErrorCategory
nameWithType: ShardManagementException.getErrorCategory
fullName: ShardManagementErrorCategory com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementException.getErrorCategory
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.getErrorCode*
name: getErrorCode
nameWithType: ShardManagementException.getErrorCode
fullName: ShardManagementErrorCode com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementException.getErrorCode
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
name: ShardManagementErrorCategory
nameWithType: ShardManagementErrorCategory
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory
type: Enum
summary: <p>Represents error categories related to Shard Management operations. </p>
syntax:
content: public enum ShardManagementErrorCategory
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
name: ShardManagementErrorCode
nameWithType: ShardManagementErrorCode
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode
type: Enum
summary: <p>Represents error codes related to <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> operations. </p>
syntax:
content: public enum ShardManagementErrorCode

Просмотреть файл

@ -0,0 +1,144 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy
id: _shard_management_transient_error_detection_strategy
parent: com.microsoft.azure.elasticdb.shard.mapmanager
children:
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy.isTransient(Exception)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy.ShardManagementTransientErrorDetectionStrategy(RetryBehavior)
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy.yml
langs:
- java
name: ShardManagementTransientErrorDetectionStrategy
nameWithType: ShardManagementTransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementTransientErrorDetectionStrategy
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementTransientErrorDetectionStrategy.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/mapmanager/ShardManagementTransientErrorDetectionStrategy.java
startLine: 19
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Provides the transient error detection logic for transient faults that are specific to Shard map manager. </p>
syntax:
content: public class ShardManagementTransientErrorDetectionStrategy implements ITransientErrorDetectionStrategy
inheritance:
- java.lang.Object
- com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy.isTransient(Exception)
id: isTransient(Exception)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy.yml
langs:
- java
name: isTransient(Exception ex)
nameWithType: ShardManagementTransientErrorDetectionStrategy.isTransient(Exception ex)
fullName: boolean com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementTransientErrorDetectionStrategy.isTransient(Exception ex)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy.isTransient*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementTransientErrorDetectionStrategy.java
startLine: 43
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Determines whether the specified exception represents a transient failure that can be compensated by a retry.</p>
<p></p>
syntax:
content: public boolean isTransient(Exception ex)
parameters:
- id: ex
type: 8a99d4b0
description: <p>The exception object to be verified. </p>
return:
type: 4fc6e284
description: <p>true if the specified exception is considered as transient; otherwise, false. </p>
overridden: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.isTransient(Exception)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy.ShardManagementTransientErrorDetectionStrategy(RetryBehavior)
id: ShardManagementTransientErrorDetectionStrategy(RetryBehavior)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy.yml
langs:
- java
name: ShardManagementTransientErrorDetectionStrategy(RetryBehavior retryBehavior)
nameWithType: ShardManagementTransientErrorDetectionStrategy.ShardManagementTransientErrorDetectionStrategy(RetryBehavior retryBehavior)
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementTransientErrorDetectionStrategy.ShardManagementTransientErrorDetectionStrategy(RetryBehavior retryBehavior)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy.ShardManagementTransientErrorDetectionStrategy*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementTransientErrorDetectionStrategy.java
startLine: 32
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Creates a new instance of transient error detection strategy for Shard map manager.</p>
<p></p>
syntax:
content: public ShardManagementTransientErrorDetectionStrategy(RetryBehavior retryBehavior)
parameters:
- id: retryBehavior
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
description: <p>User specified retry behavior. </p>
references:
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy.ShardManagementTransientErrorDetectionStrategy*
name: ShardManagementTransientErrorDetectionStrategy
nameWithType: ShardManagementTransientErrorDetectionStrategy.ShardManagementTransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementTransientErrorDetectionStrategy.ShardManagementTransientErrorDetectionStrategy
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: 8a99d4b0
spec.java:
- name: Exception
fullName: Exception
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy.isTransient*
name: isTransient
nameWithType: ShardManagementTransientErrorDetectionStrategy.isTransient
fullName: boolean com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementTransientErrorDetectionStrategy.isTransient
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.yml
name: ITransientErrorDetectionStrategy
nameWithType: ITransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ITransientErrorDetectionStrategy
type: Interface
summary: <p>Defines an interface that must be implemented by custom components responsible for detecting specific transient conditions. </p>
syntax:
content: public interface ITransientErrorDetectionStrategy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.yml
name: RetryBehavior
nameWithType: RetryBehavior
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryBehavior
type: Class
summary: <p>Defines the retry behavior to use for detecting transient errors. </p>
syntax:
content: public class RetryBehavior
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.isTransient(Exception)
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ff40c226a7d228847951c8c201a34746.yml
name: isTransient(Exception ex)
nameWithType: ITransientErrorDetectionStrategy.isTransient(Exception ex)
fullName: boolean com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ITransientErrorDetectionStrategy.isTransient(Exception ex)
type: Method
summary: >-
<p>Determines whether the specified exception represents a transient failure that can be compensated by a retry.</p>
<p></p>
syntax:
content: public boolean isTransient(Exception ex)
parameters:
- id: ex
type: 8a99d4b0
description: <p>The exception object to be verified. </p>
return:
type: 4fc6e284
description: <p>true if the specified exception is considered as transient; otherwise, false. </p>

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -0,0 +1,185 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
id: _shard_map_manager_create_mode
parent: com.microsoft.azure.elasticdb.shard.mapmanager
children:
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.forValue(int)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.getValue()
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.KeepExisting
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.ReplaceExisting
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.ShardMapManagerCreateMode(int)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.SIZE
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.yml
langs:
- java
name: ShardMapManagerCreateMode
nameWithType: ShardMapManagerCreateMode
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerCreateMode
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerCreateMode.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/mapmanager/ShardMapManagerCreateMode.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Describes the creation options for shard map manager storage representation. </p>
syntax: &o1
content: public enum ShardMapManagerCreateMode
inheritance:
- java.lang.Object
- java.lang.Enum<ShardMapManagerCreateMode>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.yml
langs:
- java
name: forValue(int value)
nameWithType: ShardMapManagerCreateMode.forValue(int value)
fullName: static ShardMapManagerCreateMode com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerCreateMode.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerCreateMode.java
startLine: 44
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public static ShardMapManagerCreateMode forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.yml
langs:
- java
name: getValue()
nameWithType: ShardMapManagerCreateMode.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerCreateMode.getValue()
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerCreateMode.java
startLine: 48
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.KeepExisting
id: KeepExisting
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.yml
langs:
- java
name: KeepExisting
nameWithType: ShardMapManagerCreateMode.KeepExisting
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerCreateMode.KeepExisting
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerCreateMode.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>If the shard map manager data structures are already present in the store, then this method will raise exception. </p>
syntax:
content: public KeepExisting=(0)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.ReplaceExisting
id: ReplaceExisting
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.yml
langs:
- java
name: ReplaceExisting
nameWithType: ShardMapManagerCreateMode.ReplaceExisting
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerCreateMode.ReplaceExisting
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerCreateMode.java
startLine: 22
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>If the shard map manager data structures are already present in the store, then this method will overwrite them. </p>
syntax:
content: public ReplaceExisting=(1)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.ShardMapManagerCreateMode(int)
id: ShardMapManagerCreateMode(int)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.yml
langs:
- java
name: ShardMapManagerCreateMode(int value)
nameWithType: ShardMapManagerCreateMode.ShardMapManagerCreateMode(int value)
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerCreateMode.ShardMapManagerCreateMode(int value)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.ShardMapManagerCreateMode*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerCreateMode.java
startLine: 28
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public ShardMapManagerCreateMode(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.yml
langs:
- java
name: SIZE
nameWithType: ShardMapManagerCreateMode.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerCreateMode.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerCreateMode.java
startLine: 24
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.ShardMapManagerCreateMode*
name: ShardMapManagerCreateMode
nameWithType: ShardMapManagerCreateMode.ShardMapManagerCreateMode
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerCreateMode.ShardMapManagerCreateMode
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.getValue*
name: getValue
nameWithType: ShardMapManagerCreateMode.getValue
fullName: int com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerCreateMode.getValue
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.forValue*
name: forValue
nameWithType: ShardMapManagerCreateMode.forValue
fullName: static ShardMapManagerCreateMode com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerCreateMode.forValue
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.yml
name: ShardMapManagerCreateMode
nameWithType: ShardMapManagerCreateMode
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerCreateMode
type: Enum
summary: <p>Describes the creation options for shard map manager storage representation. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,592 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
id: _shard_map_manager_factory
parent: com.microsoft.azure.elasticdb.shard.mapmanager
children:
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager(String)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager(String,RetryBehavior)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager(String,ShardMapManagerCreateMode)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager(String,ShardMapManagerCreateMode,RetryBehavior)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager(String,ShardMapManagerCreateMode,RetryBehavior,EventHandler<RetryingEventArgs>)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager(String,ShardMapManagerCreateMode,Version)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.getSqlShardMapManager(String,ShardMapManagerLoadPolicy)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.getSqlShardMapManager(String,ShardMapManagerLoadPolicy,RetryBehavior)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.getSqlShardMapManager(String,ShardMapManagerLoadPolicy,RetryBehavior,EventHandler<RetryingEventArgs>)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.tryGetSqlShardMapManager(String,ShardMapManagerLoadPolicy,ReferenceObjectHelper<ShardMapManager>)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.tryGetSqlShardMapManager(String,ShardMapManagerLoadPolicy,RetryBehavior,EventHandler<RetryingEventArgs>,ReferenceObjectHelper<ShardMapManager>)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.tryGetSqlShardMapManager(String,ShardMapManagerLoadPolicy,RetryBehavior,ReferenceObjectHelper<ShardMapManager>)
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.yml
langs:
- java
name: ShardMapManagerFactory
nameWithType: ShardMapManagerFactory
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerFactory.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/mapmanager/ShardMapManagerFactory.java
startLine: 41
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Factory for <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref>s facilitates the creation and management of shard map manager persistent state. Use this class as the entry point to the library's object hierarchy. </p>
syntax:
content: public class ShardMapManagerFactory
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager(String)
id: createSqlShardMapManager(String)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.yml
langs:
- java
name: createSqlShardMapManager(String connectionString)
nameWithType: ShardMapManagerFactory.createSqlShardMapManager(String connectionString)
fullName: static ShardMapManager com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory.createSqlShardMapManager(String connectionString)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerFactory.java
startLine: 53
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Creates a <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> and its corresponding storage structures in the specified SQL Server database, with <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.KeepExisting" data-throw-if-not-resolved="false">ShardMapManagerCreateMode.KeepExisting</xref> and RetryBehavior.DefaultRetryBehavior.</p>
<p></p>
syntax:
content: public static ShardMapManager createSqlShardMapManager(String connectionString)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection parameters used for creating shard map manager database. </p>
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>A shard map manager object used for performing management and read operations for shard maps, shards and shard mappings. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager(String,RetryBehavior)
id: createSqlShardMapManager(String,RetryBehavior)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.yml
langs:
- java
name: createSqlShardMapManager(String connectionString, RetryBehavior retryBehavior)
nameWithType: ShardMapManagerFactory.createSqlShardMapManager(String connectionString, RetryBehavior retryBehavior)
fullName: static ShardMapManager com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory.createSqlShardMapManager(String connectionString, RetryBehavior retryBehavior)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerFactory.java
startLine: 99
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Creates a <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> and its corresponding storage structures in the specified SQL Server database, with <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.KeepExisting" data-throw-if-not-resolved="false">ShardMapManagerCreateMode.KeepExisting</xref>.</p>
<p></p>
syntax:
content: public static ShardMapManager createSqlShardMapManager(String connectionString, RetryBehavior retryBehavior)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection parameters used for creating shard map manager database. </p>
- id: retryBehavior
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
description: <p>Behavior for detecting transient exceptions in the store. </p>
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>A shard map manager object used for performing management and read operations for shard maps, shards and shard mappings. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager(String,ShardMapManagerCreateMode)
id: createSqlShardMapManager(String,ShardMapManagerCreateMode)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.yml
langs:
- java
name: createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode)
nameWithType: ShardMapManagerFactory.createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode)
fullName: static ShardMapManager com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory.createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerFactory.java
startLine: 67
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Creates a <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> and its corresponding storage structures in the specified SQL Server database, with RetryBehavior.DefaultRetryBehavior.</p>
<p></p>
syntax:
content: public static ShardMapManager createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection parameters used for creating shard map manager database. </p>
- id: createMode
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
description: <p>Describes the option selected by the user for creating shard map manager database. </p>
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>A shard map manager object used for performing management and read operations for shard maps, shards and shard mappings. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager(String,ShardMapManagerCreateMode,RetryBehavior)
id: createSqlShardMapManager(String,ShardMapManagerCreateMode,RetryBehavior)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.yml
langs:
- java
name: createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode, RetryBehavior retryBehavior)
nameWithType: ShardMapManagerFactory.createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode, RetryBehavior retryBehavior)
fullName: static ShardMapManager com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory.createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode, RetryBehavior retryBehavior)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerFactory.java
startLine: 115
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Creates a <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> and its corresponding storage structures in the specified SQL Server database.</p>
<p></p>
syntax:
content: public static ShardMapManager createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode, RetryBehavior retryBehavior)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection parameters used for creating shard map manager database. </p>
- id: createMode
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
description: <p>Describes the option selected by the user for creating shard map manager database. </p>
- id: retryBehavior
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
description: <p>Behavior for detecting transient exceptions in the store. </p>
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>A shard map manager object used for performing management and read operations for shard maps, shards and shard mappings. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager(String,ShardMapManagerCreateMode,RetryBehavior,EventHandler<RetryingEventArgs>)
id: createSqlShardMapManager(String,ShardMapManagerCreateMode,RetryBehavior,EventHandler<RetryingEventArgs>)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.yml
langs:
- java
name: createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode, RetryBehavior retryBehavior, EventHandler<RetryingEventArgs> retryEventHandler)
nameWithType: ShardMapManagerFactory.createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode, RetryBehavior retryBehavior, EventHandler<RetryingEventArgs> retryEventHandler)
fullName: static ShardMapManager com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory.createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode, RetryBehavior retryBehavior, EventHandler<RetryingEventArgs> retryEventHandler)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerFactory.java
startLine: 134
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Creates a <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> and its corresponding storage structures in the specified SQL Server database.</p>
<p></p>
syntax:
content: public static ShardMapManager createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode, RetryBehavior retryBehavior, EventHandler<RetryingEventArgs> retryEventHandler)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection parameters used for creating shard map manager database. </p>
- id: createMode
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
description: <p>Describes the option selected by the user for creating shard map manager database. </p>
- id: retryBehavior
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
description: <p>Behavior for detecting transient exceptions in the store. </p>
- id: retryEventHandler
type: f45ab895com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_argsa08ddfce
description: <p>Event handler for store operation retry events. </p>
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>A shard map manager object used for performing management and read operations for shard maps, shards and shard mappings. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager(String,ShardMapManagerCreateMode,Version)
id: createSqlShardMapManager(String,ShardMapManagerCreateMode,Version)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.yml
langs:
- java
name: createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode, Version targetVersion)
nameWithType: ShardMapManagerFactory.createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode, Version targetVersion)
fullName: static ShardMapManager com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory.createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode, Version targetVersion)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerFactory.java
startLine: 83
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Creates a <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> and its corresponding storage structures in the specified SQL Server database, with <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultRetryPolicy()" data-throw-if-not-resolved="false">RetryPolicy.getDefaultRetryPolicy()</xref>.</p>
<p></p>
syntax:
content: public static ShardMapManager createSqlShardMapManager(String connectionString, ShardMapManagerCreateMode createMode, Version targetVersion)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection parameters used for creating shard map manager database. </p>
- id: createMode
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
description: <p>Describes the option selected by the user for creating shard map manager database. </p>
- id: targetVersion
type: com.microsoft.azure.elasticdb.shard.store._version
description: <p>Target version of store to create. </p>
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.getSqlShardMapManager(String,ShardMapManagerLoadPolicy)
id: getSqlShardMapManager(String,ShardMapManagerLoadPolicy)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.yml
langs:
- java
name: getSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy)
nameWithType: ShardMapManagerFactory.getSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy)
fullName: static ShardMapManager com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory.getSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.getSqlShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerFactory.java
startLine: 316
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Gets <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> from persisted state in a SQL Server database, with RetryBehavior.DefaultRetryBehavior.</p>
<p></p>
syntax:
content: public static ShardMapManager getSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection parameters used for performing operations against shard map manager database(s). </p>
- id: loadPolicy
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
description: <p>Initialization policy. </p>
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>A shard map manager object used for performing management and read operations for shard maps, shards and shard mappings. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.getSqlShardMapManager(String,ShardMapManagerLoadPolicy,RetryBehavior)
id: getSqlShardMapManager(String,ShardMapManagerLoadPolicy,RetryBehavior)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.yml
langs:
- java
name: getSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior)
nameWithType: ShardMapManagerFactory.getSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior)
fullName: static ShardMapManager com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory.getSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.getSqlShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerFactory.java
startLine: 332
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Gets <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> from persisted state in a SQL Server database.</p>
<p></p>
syntax:
content: public static ShardMapManager getSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection parameters used for performing operations against shard map manager database(s). </p>
- id: loadPolicy
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
description: <p>Initialization policy. </p>
- id: retryBehavior
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
description: <p>Behavior for detecting transient exceptions in the store. </p>
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>A shard map manager object used for performing management and read operations for shard maps, shards and shard mappings. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.getSqlShardMapManager(String,ShardMapManagerLoadPolicy,RetryBehavior,EventHandler<RetryingEventArgs>)
id: getSqlShardMapManager(String,ShardMapManagerLoadPolicy,RetryBehavior,EventHandler<RetryingEventArgs>)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.yml
langs:
- java
name: getSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior, EventHandler<RetryingEventArgs> retryEventHandler)
nameWithType: ShardMapManagerFactory.getSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior, EventHandler<RetryingEventArgs> retryEventHandler)
fullName: static ShardMapManager com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory.getSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior, EventHandler<RetryingEventArgs> retryEventHandler)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.getSqlShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerFactory.java
startLine: 351
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Gets <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> from persisted state in a SQL Server database.</p>
<p></p>
syntax:
content: public static ShardMapManager getSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior, EventHandler<RetryingEventArgs> retryEventHandler)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection parameters used for performing operations against shard map manager database(s). </p>
- id: loadPolicy
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
description: <p>Initialization policy. </p>
- id: retryBehavior
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
description: <p>Behavior for detecting transient exceptions in the store. </p>
- id: retryEventHandler
type: f45ab895com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_argsa08ddfce
description: <p>Event handler for store operation retry events. </p>
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>A shard map manager object used for performing management and read operations for shard maps, shards and shard mappings. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.tryGetSqlShardMapManager(String,ShardMapManagerLoadPolicy,ReferenceObjectHelper<ShardMapManager>)
id: tryGetSqlShardMapManager(String,ShardMapManagerLoadPolicy,ReferenceObjectHelper<ShardMapManager>)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.yml
langs:
- java
name: tryGetSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, ReferenceObjectHelper<ShardMapManager> shardMapManager)
nameWithType: ShardMapManagerFactory.tryGetSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, ReferenceObjectHelper<ShardMapManager> shardMapManager)
fullName: static boolean com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory.tryGetSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, ReferenceObjectHelper<ShardMapManager> shardMapManager)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.tryGetSqlShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerFactory.java
startLine: 225
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Gets <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> from persisted state in a SQL Server database.</p>
<p></p>
syntax:
content: public static boolean tryGetSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, ReferenceObjectHelper<ShardMapManager> shardMapManager)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection parameters used for performing operations against shard map manager database(s). </p>
- id: loadPolicy
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
description: <p>Initialization policy. </p>
- id: shardMapManager
type: 2695f77dcom.microsoft.azure.elasticdb.shard.mapmanager._shard_map_managera08ddfce
description: <p>Shard map manager object used for performing management and read operations for shard maps, shards and shard mappings or <code>null</code> in case shard map manager does not exist. </p>
return:
type: 4fc6e284
description: >-
<p>
<code>true</code> if a shard map manager object was created, <code>false</code> otherwise. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.tryGetSqlShardMapManager(String,ShardMapManagerLoadPolicy,RetryBehavior,EventHandler<RetryingEventArgs>,ReferenceObjectHelper<ShardMapManager>)
id: tryGetSqlShardMapManager(String,ShardMapManagerLoadPolicy,RetryBehavior,EventHandler<RetryingEventArgs>,ReferenceObjectHelper<ShardMapManager>)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.yml
langs:
- java
name: tryGetSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior, EventHandler<RetryingEventArgs> retryEventHandler, ReferenceObjectHelper<ShardMapManager> shardMapManager)
nameWithType: ShardMapManagerFactory.tryGetSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior, EventHandler<RetryingEventArgs> retryEventHandler, ReferenceObjectHelper<ShardMapManager> shardMapManager)
fullName: static boolean com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory.tryGetSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior, EventHandler<RetryingEventArgs> retryEventHandler, ReferenceObjectHelper<ShardMapManager> shardMapManager)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.tryGetSqlShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerFactory.java
startLine: 283
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Gets <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> from persisted state in a SQL Server database.</p>
<p></p>
syntax:
content: public static boolean tryGetSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior, EventHandler<RetryingEventArgs> retryEventHandler, ReferenceObjectHelper<ShardMapManager> shardMapManager)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection parameters used for performing operations against shard map manager database(s). </p>
- id: loadPolicy
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
description: <p>Initialization policy. </p>
- id: retryBehavior
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
description: <p>Behavior for detecting transient exceptions in the store. </p>
- id: retryEventHandler
type: f45ab895com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_argsa08ddfce
description: <p>Event handler for store operation retry events. </p>
- id: shardMapManager
type: 2695f77dcom.microsoft.azure.elasticdb.shard.mapmanager._shard_map_managera08ddfce
description: <p>Shard map manager object used for performing management and read operations for shard maps, shards and shard mappings or <code>null</code> in case shard map manager does not exist. </p>
return:
type: 4fc6e284
description: >-
<p>
<code>true</code> if a shard map manager object was created, <code>false</code> otherwise. </p>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.tryGetSqlShardMapManager(String,ShardMapManagerLoadPolicy,RetryBehavior,ReferenceObjectHelper<ShardMapManager>)
id: tryGetSqlShardMapManager(String,ShardMapManagerLoadPolicy,RetryBehavior,ReferenceObjectHelper<ShardMapManager>)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.yml
langs:
- java
name: tryGetSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior, ReferenceObjectHelper<ShardMapManager> shardMapManager)
nameWithType: ShardMapManagerFactory.tryGetSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior, ReferenceObjectHelper<ShardMapManager> shardMapManager)
fullName: static boolean com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory.tryGetSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior, ReferenceObjectHelper<ShardMapManager> shardMapManager)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.tryGetSqlShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerFactory.java
startLine: 245
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: >-
<p>Gets <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> from persisted state in a SQL Server database.</p>
<p></p>
syntax:
content: public static boolean tryGetSqlShardMapManager(String connectionString, ShardMapManagerLoadPolicy loadPolicy, RetryBehavior retryBehavior, ReferenceObjectHelper<ShardMapManager> shardMapManager)
parameters:
- id: connectionString
type: "26831127"
description: <p>Connection parameters used for performing operations against shard map manager database(s). </p>
- id: loadPolicy
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
description: <p>Initialization policy. </p>
- id: retryBehavior
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
description: <p>Behavior for detecting transient exceptions in the store. </p>
- id: shardMapManager
type: 2695f77dcom.microsoft.azure.elasticdb.shard.mapmanager._shard_map_managera08ddfce
description: <p>Shard map manager object used for performing management and read operations for shard maps, shards and shard mappings or <code>null</code> in case shard map manager does not exist. </p>
return:
type: 4fc6e284
description: >-
<p>
<code>true</code> if a shard map manager object was created, <code>false</code> otherwise. </p>
references:
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.createSqlShardMapManager*
name: createSqlShardMapManager
nameWithType: ShardMapManagerFactory.createSqlShardMapManager
fullName: static ShardMapManager com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory.createSqlShardMapManager
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: f45ab895com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_argsa08ddfce
spec.java:
- name: EventHandler<
fullName: EventHandler<
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args
name: RetryingEventArgs
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.yml
- name: '>'
fullName: '>'
- uid: 2695f77dcom.microsoft.azure.elasticdb.shard.mapmanager._shard_map_managera08ddfce
spec.java:
- name: ReferenceObjectHelper<
fullName: ReferenceObjectHelper<
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
name: ShardMapManager
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager.yml
- name: '>'
fullName: '>'
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.tryGetSqlShardMapManager*
name: tryGetSqlShardMapManager
nameWithType: ShardMapManagerFactory.tryGetSqlShardMapManager
fullName: static boolean com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory.tryGetSqlShardMapManager
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.getSqlShardMapManager*
name: getSqlShardMapManager
nameWithType: ShardMapManagerFactory.getSqlShardMapManager
fullName: static ShardMapManager com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory.getSqlShardMapManager
package: com.microsoft.azure.elasticdb.shard.mapmanager
- 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.mapmanager._shard_map_manager_create_mode.KeepExisting
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.yml
name: KeepExisting
nameWithType: ShardMapManagerCreateMode.KeepExisting
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerCreateMode.KeepExisting
type: Field
summary: <p>If the shard map manager data structures are already present in the store, then this method will raise exception. </p>
syntax:
content: public KeepExisting=(0)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.yml
name: ShardMapManagerCreateMode
nameWithType: ShardMapManagerCreateMode
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerCreateMode
type: Enum
summary: <p>Describes the creation options for shard map manager storage representation. </p>
syntax:
content: public enum ShardMapManagerCreateMode
- uid: com.microsoft.azure.elasticdb.shard.store._version
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._version.yml
name: Version
nameWithType: Version
fullName: com.microsoft.azure.elasticdb.shard.store.Version
type: Class
summary: <p>Represents the version number of an assembly, operating system, or the common language runtime. This class cannot be inherited. </p>
syntax:
content: public class Version
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.getDefaultRetryPolicy()
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy.yml
name: getDefaultRetryPolicy()
nameWithType: RetryPolicy.getDefaultRetryPolicy()
fullName: static RetryPolicy com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryPolicy.getDefaultRetryPolicy()
type: Method
summary: <p>Gets the default retry policy. 5 retries at 1 second intervals. </p>
syntax:
content: public static RetryPolicy getDefaultRetryPolicy()
return:
type: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_policy
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retry_behavior.yml
name: RetryBehavior
nameWithType: RetryBehavior
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryBehavior
type: Class
summary: <p>Defines the retry behavior to use for detecting transient errors. </p>
syntax:
content: public class RetryBehavior
- uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args
parent: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
href: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling._retrying_event_args.yml
name: RetryingEventArgs
nameWithType: RetryingEventArgs
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryingEventArgs
type: Class
summary: <p>Shard management retrying event arguments. </p>
syntax:
content: public class RetryingEventArgs
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.yml
name: ShardMapManagerLoadPolicy
nameWithType: ShardMapManagerLoadPolicy
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerLoadPolicy
type: Enum
summary: <p>Describes the policy used for initialization of <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> from the store. </p>
syntax:
content: public enum ShardMapManagerLoadPolicy

Просмотреть файл

@ -0,0 +1,195 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
id: _shard_map_manager_load_policy
parent: com.microsoft.azure.elasticdb.shard.mapmanager
children:
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.Eager
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.forValue(int)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.getValue()
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.Lazy
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.ShardMapManagerLoadPolicy(int)
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.SIZE
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.yml
langs:
- java
name: ShardMapManagerLoadPolicy
nameWithType: ShardMapManagerLoadPolicy
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerLoadPolicy
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerLoadPolicy.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/mapmanager/ShardMapManagerLoadPolicy.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Describes the policy used for initialization of <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> from the store. </p>
syntax: &o1
content: public enum ShardMapManagerLoadPolicy
inheritance:
- java.lang.Object
- java.lang.Enum<ShardMapManagerLoadPolicy>
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.Eager
id: Eager
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.yml
langs:
- java
name: Eager
nameWithType: ShardMapManagerLoadPolicy.Eager
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerLoadPolicy.Eager
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerLoadPolicy.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Load all shard maps and their corresponding mappings into the cache for fast retrieval. </p>
syntax:
content: public Eager=(0)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.yml
langs:
- java
name: forValue(int value)
nameWithType: ShardMapManagerLoadPolicy.forValue(int value)
fullName: static ShardMapManagerLoadPolicy com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerLoadPolicy.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerLoadPolicy.java
startLine: 44
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public static ShardMapManagerLoadPolicy forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.yml
langs:
- java
name: getValue()
nameWithType: ShardMapManagerLoadPolicy.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerLoadPolicy.getValue()
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerLoadPolicy.java
startLine: 48
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.Lazy
id: Lazy
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.yml
langs:
- java
name: Lazy
nameWithType: ShardMapManagerLoadPolicy.Lazy
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerLoadPolicy.Lazy
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerLoadPolicy.java
startLine: 22
package: com.microsoft.azure.elasticdb.shard.mapmanager
summary: <p>Load all shard maps and their corresponding mappings on as needed basis. </p>
syntax:
content: public Lazy=(1)
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.ShardMapManagerLoadPolicy(int)
id: ShardMapManagerLoadPolicy(int)
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.yml
langs:
- java
name: ShardMapManagerLoadPolicy(int value)
nameWithType: ShardMapManagerLoadPolicy.ShardMapManagerLoadPolicy(int value)
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerLoadPolicy.ShardMapManagerLoadPolicy(int value)
overload: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.ShardMapManagerLoadPolicy*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerLoadPolicy.java
startLine: 28
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public ShardMapManagerLoadPolicy(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.yml
langs:
- java
name: SIZE
nameWithType: ShardMapManagerLoadPolicy.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerLoadPolicy.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardMapManagerLoadPolicy.java
startLine: 24
package: com.microsoft.azure.elasticdb.shard.mapmanager
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.ShardMapManagerLoadPolicy*
name: ShardMapManagerLoadPolicy
nameWithType: ShardMapManagerLoadPolicy.ShardMapManagerLoadPolicy
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerLoadPolicy.ShardMapManagerLoadPolicy
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.getValue*
name: getValue
nameWithType: ShardMapManagerLoadPolicy.getValue
fullName: int com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerLoadPolicy.getValue
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.forValue*
name: forValue
nameWithType: ShardMapManagerLoadPolicy.forValue
fullName: static ShardMapManagerLoadPolicy com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerLoadPolicy.forValue
package: com.microsoft.azure.elasticdb.shard.mapmanager
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.yml
name: ShardMapManagerLoadPolicy
nameWithType: ShardMapManagerLoadPolicy
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerLoadPolicy
type: Enum
summary: <p>Describes the policy used for initialization of <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> from the store. </p>
syntax: *o1
- 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

Просмотреть файл

@ -0,0 +1,109 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.mapmanager
id: mapmanager
children:
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
- com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
href: com.microsoft.azure.elasticdb.shard.mapmanager.yml
langs:
- java
name: com.microsoft.azure.elasticdb.shard.mapmanager
nameWithType: com.microsoft.azure.elasticdb.shard.mapmanager
fullName: com.microsoft.azure.elasticdb.shard.mapmanager
type: Namespace
source:
remote:
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapmanager/ShardManagementErrorCategory.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/mapmanager/ShardManagementErrorCategory.java
syntax:
content: package com.microsoft.azure.elasticdb.shard.mapmanager
references:
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_category.yml
name: ShardManagementErrorCategory
nameWithType: ShardManagementErrorCategory
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCategory
type: Enum
summary: <p>Represents error categories related to Shard Management operations. </p>
syntax:
content: public enum ShardManagementErrorCategory
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_error_code.yml
name: ShardManagementErrorCode
nameWithType: ShardManagementErrorCode
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementErrorCode
type: Enum
summary: <p>Represents error codes related to <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> operations. </p>
syntax:
content: public enum ShardManagementErrorCode
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_exception.yml
name: ShardManagementException
nameWithType: ShardManagementException
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementException
type: Class
summary: <p>Representation of exceptions that occur during storage operations. </p>
syntax:
content: public class ShardManagementException
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_management_transient_error_detection_strategy.yml
name: ShardManagementTransientErrorDetectionStrategy
nameWithType: ShardManagementTransientErrorDetectionStrategy
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardManagementTransientErrorDetectionStrategy
type: Class
summary: <p>Provides the transient error detection logic for transient faults that are specific to Shard map manager. </p>
syntax:
content: public class ShardManagementTransientErrorDetectionStrategy implements ITransientErrorDetectionStrategy
- 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.mapmanager._shard_map_manager_create_mode
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_create_mode.yml
name: ShardMapManagerCreateMode
nameWithType: ShardMapManagerCreateMode
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerCreateMode
type: Enum
summary: <p>Describes the creation options for shard map manager storage representation. </p>
syntax:
content: public enum ShardMapManagerCreateMode
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_factory.yml
name: ShardMapManagerFactory
nameWithType: ShardMapManagerFactory
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerFactory
type: Class
summary: <p>Factory for <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref>s facilitates the creation and management of shard map manager persistent state. Use this class as the entry point to the library's object hierarchy. </p>
syntax:
content: public class ShardMapManagerFactory
- uid: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy
parent: com.microsoft.azure.elasticdb.shard.mapmanager
href: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager_load_policy.yml
name: ShardMapManagerLoadPolicy
nameWithType: ShardMapManagerLoadPolicy
fullName: com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManagerLoadPolicy
type: Enum
summary: <p>Describes the policy used for initialization of <xref uid="com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager" data-throw-if-not-resolved="false">ShardMapManager</xref> from the store. </p>
syntax:
content: public enum ShardMapManagerLoadPolicy

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -0,0 +1,183 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.mapper._connection_options
id: _connection_options
parent: com.microsoft.azure.elasticdb.shard.mapper
children:
- com.microsoft.azure.elasticdb.shard.mapper._connection_options.ConnectionOptions(int)
- com.microsoft.azure.elasticdb.shard.mapper._connection_options.forValue(int)
- com.microsoft.azure.elasticdb.shard.mapper._connection_options.getValue()
- com.microsoft.azure.elasticdb.shard.mapper._connection_options.None
- com.microsoft.azure.elasticdb.shard.mapper._connection_options.SIZE
- com.microsoft.azure.elasticdb.shard.mapper._connection_options.Validate
href: com.microsoft.azure.elasticdb.shard.mapper._connection_options.yml
langs:
- java
name: ConnectionOptions
nameWithType: ConnectionOptions
fullName: com.microsoft.azure.elasticdb.shard.mapper.ConnectionOptions
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ConnectionOptions.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/ConnectionOptions.java
startLine: 10
package: com.microsoft.azure.elasticdb.shard.mapper
syntax: &o1
content: public enum ConnectionOptions
inheritance:
- java.lang.Object
- java.lang.Enum<ConnectionOptions>
- uid: com.microsoft.azure.elasticdb.shard.mapper._connection_options.ConnectionOptions(int)
id: ConnectionOptions(int)
parent: com.microsoft.azure.elasticdb.shard.mapper._connection_options
href: com.microsoft.azure.elasticdb.shard.mapper._connection_options.yml
langs:
- java
name: ConnectionOptions(int value)
nameWithType: ConnectionOptions.ConnectionOptions(int value)
fullName: com.microsoft.azure.elasticdb.shard.mapper.ConnectionOptions.ConnectionOptions(int value)
overload: com.microsoft.azure.elasticdb.shard.mapper._connection_options.ConnectionOptions*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ConnectionOptions.java
startLine: 26
package: com.microsoft.azure.elasticdb.shard.mapper
syntax:
content: public ConnectionOptions(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.mapper._connection_options.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.mapper._connection_options
href: com.microsoft.azure.elasticdb.shard.mapper._connection_options.yml
langs:
- java
name: forValue(int value)
nameWithType: ConnectionOptions.forValue(int value)
fullName: static ConnectionOptions com.microsoft.azure.elasticdb.shard.mapper.ConnectionOptions.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.mapper._connection_options.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ConnectionOptions.java
startLine: 42
package: com.microsoft.azure.elasticdb.shard.mapper
syntax:
content: public static ConnectionOptions forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.mapper._connection_options
- uid: com.microsoft.azure.elasticdb.shard.mapper._connection_options.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.mapper._connection_options
href: com.microsoft.azure.elasticdb.shard.mapper._connection_options.yml
langs:
- java
name: getValue()
nameWithType: ConnectionOptions.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.mapper.ConnectionOptions.getValue()
overload: com.microsoft.azure.elasticdb.shard.mapper._connection_options.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ConnectionOptions.java
startLine: 46
package: com.microsoft.azure.elasticdb.shard.mapper
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.mapper._connection_options.None
id: None
parent: com.microsoft.azure.elasticdb.shard.mapper._connection_options
href: com.microsoft.azure.elasticdb.shard.mapper._connection_options.yml
langs:
- java
name: None
nameWithType: ConnectionOptions.None
fullName: com.microsoft.azure.elasticdb.shard.mapper.ConnectionOptions.None
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ConnectionOptions.java
startLine: 14
package: com.microsoft.azure.elasticdb.shard.mapper
summary: <p>No operation will be performed on the opened connection. </p>
syntax:
content: public None=(0)
- uid: com.microsoft.azure.elasticdb.shard.mapper._connection_options.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.mapper._connection_options
href: com.microsoft.azure.elasticdb.shard.mapper._connection_options.yml
langs:
- java
name: SIZE
nameWithType: ConnectionOptions.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.mapper.ConnectionOptions.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ConnectionOptions.java
startLine: 22
package: com.microsoft.azure.elasticdb.shard.mapper
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
- uid: com.microsoft.azure.elasticdb.shard.mapper._connection_options.Validate
id: Validate
parent: com.microsoft.azure.elasticdb.shard.mapper._connection_options
href: com.microsoft.azure.elasticdb.shard.mapper._connection_options.yml
langs:
- java
name: Validate
nameWithType: ConnectionOptions.Validate
fullName: com.microsoft.azure.elasticdb.shard.mapper.ConnectionOptions.Validate
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/ConnectionOptions.java
startLine: 20
package: com.microsoft.azure.elasticdb.shard.mapper
summary: <p>Validation will be performed on the connection to ensure that the state of the corresponding mapping has not changed since the mapping information was last cached at the client. </p>
syntax:
content: public Validate=(1)
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.mapper._connection_options.ConnectionOptions*
name: ConnectionOptions
nameWithType: ConnectionOptions.ConnectionOptions
fullName: com.microsoft.azure.elasticdb.shard.mapper.ConnectionOptions.ConnectionOptions
package: com.microsoft.azure.elasticdb.shard.mapper
- uid: com.microsoft.azure.elasticdb.shard.mapper._connection_options.getValue*
name: getValue
nameWithType: ConnectionOptions.getValue
fullName: int com.microsoft.azure.elasticdb.shard.mapper.ConnectionOptions.getValue
package: com.microsoft.azure.elasticdb.shard.mapper
- uid: com.microsoft.azure.elasticdb.shard.mapper._connection_options.forValue*
name: forValue
nameWithType: ConnectionOptions.forValue
fullName: static ConnectionOptions com.microsoft.azure.elasticdb.shard.mapper.ConnectionOptions.forValue
package: com.microsoft.azure.elasticdb.shard.mapper
- 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: *o1

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -0,0 +1,376 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
id: _i_shard_mapper
parent: com.microsoft.azure.elasticdb.shard.mapper
children:
- com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.add(MappingT)
- com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.lookup(ValueT,LookupOptions)
- 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._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._i_shard_mapper.remove(MappingT,UUID)
- com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.tryLookup(ValueT,LookupOptions,ReferenceObjectHelper<MappingT>)
href: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.yml
langs:
- java
name: IShardMapper<MappingT,ValueT>
nameWithType: IShardMapper<MappingT,ValueT>
fullName: com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT,ValueT>
type: Interface
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/IShardMapper.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/IShardMapper.java
startLine: 21
package: com.microsoft.azure.elasticdb.shard.mapper
summary: <p>Container for a collection of keys to shards mappings. </p>
syntax:
content: public interface IShardMapper<MappingT extends IShardProvider,ValueT>
typeParameters:
- type: e8a622a9
- type: 0fb6b535
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.add(MappingT)
id: add(MappingT)
parent: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
href: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.yml
langs:
- java
name: add(MappingT mapping)
nameWithType: IShardMapper<MappingT,ValueT>.add(MappingT mapping)
fullName: MappingT com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.add(MappingT mapping)
overload: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.add*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/IShardMapper.java
startLine: 67
package: com.microsoft.azure.elasticdb.shard.mapper
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._i_shard_mapper.lookup(ValueT,LookupOptions)
id: lookup(ValueT,LookupOptions)
parent: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
href: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.yml
langs:
- java
name: lookup(ValueT key, LookupOptions lookupOptions)
nameWithType: IShardMapper<MappingT,ValueT>.lookup(ValueT key, LookupOptions lookupOptions)
fullName: MappingT com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.lookup(ValueT key, LookupOptions lookupOptions)
overload: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.lookup*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/IShardMapper.java
startLine: 89
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 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._i_shard_mapper.openConnectionForKey(ValueT,String)
id: openConnectionForKey(ValueT,String)
parent: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
href: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.yml
langs:
- java
name: openConnectionForKey(ValueT key, String connectionString)
nameWithType: IShardMapper<MappingT,ValueT>.openConnectionForKey(ValueT key, String connectionString)
fullName: Connection com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.openConnectionForKey(ValueT key, String connectionString)
overload: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.openConnectionForKey*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/IShardMapper.java
startLine: 23
package: com.microsoft.azure.elasticdb.shard.mapper
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)
id: 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
langs:
- java
name: openConnectionForKey(ValueT key, String connectionString, ConnectionOptions options)
nameWithType: IShardMapper<MappingT,ValueT>.openConnectionForKey(ValueT key, String connectionString, ConnectionOptions options)
fullName: Connection com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.openConnectionForKey(ValueT key, String connectionString, ConnectionOptions options)
overload: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.openConnectionForKey*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/IShardMapper.java
startLine: 38
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(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._i_shard_mapper.openConnectionForKeyAsync(ValueT,String)
id: openConnectionForKeyAsync(ValueT,String)
parent: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
href: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.yml
langs:
- java
name: openConnectionForKeyAsync(ValueT key, String connectionString)
nameWithType: IShardMapper<MappingT,ValueT>.openConnectionForKeyAsync(ValueT key, String connectionString)
fullName: Callable<Connection> com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.openConnectionForKeyAsync(ValueT key, String connectionString)
overload: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.openConnectionForKeyAsync*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/IShardMapper.java
startLine: 42
package: com.microsoft.azure.elasticdb.shard.mapper
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)
id: 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
langs:
- java
name: openConnectionForKeyAsync(ValueT key, String connectionString, ConnectionOptions options)
nameWithType: IShardMapper<MappingT,ValueT>.openConnectionForKeyAsync(ValueT key, String connectionString, ConnectionOptions options)
fullName: Callable<Connection> com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.openConnectionForKeyAsync(ValueT key, String connectionString, ConnectionOptions options)
overload: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.openConnectionForKeyAsync*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/IShardMapper.java
startLine: 57
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(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._i_shard_mapper.remove(MappingT,UUID)
id: remove(MappingT,UUID)
parent: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
href: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.yml
langs:
- java
name: remove(MappingT mapping, UUID lockOwnerId)
nameWithType: IShardMapper<MappingT,ValueT>.remove(MappingT mapping, UUID lockOwnerId)
fullName: void com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.remove(MappingT mapping, UUID lockOwnerId)
overload: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.remove*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/IShardMapper.java
startLine: 77
package: com.microsoft.azure.elasticdb.shard.mapper
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._i_shard_mapper.tryLookup(ValueT,LookupOptions,ReferenceObjectHelper<MappingT>)
id: 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
langs:
- java
name: tryLookup(ValueT key, LookupOptions lookupOptions, ReferenceObjectHelper<MappingT> mapping)
nameWithType: IShardMapper<MappingT,ValueT>.tryLookup(ValueT key, LookupOptions lookupOptions, ReferenceObjectHelper<MappingT> mapping)
fullName: boolean com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.tryLookup(ValueT key, LookupOptions lookupOptions, ReferenceObjectHelper<MappingT> mapping)
overload: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.tryLookup*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/IShardMapper.java
startLine: 103
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(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>
references:
- uid: e8a622a9
spec.java:
- name: MappingT
fullName: MappingT
- uid: 0fb6b535
spec.java:
- name: ValueT
fullName: ValueT
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: 8270ccc2
spec.java:
- name: Connection
fullName: Connection
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.openConnectionForKey*
name: openConnectionForKey
nameWithType: IShardMapper<MappingT,ValueT>.openConnectionForKey
fullName: Connection com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.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._i_shard_mapper.openConnectionForKeyAsync*
name: openConnectionForKeyAsync
nameWithType: IShardMapper<MappingT,ValueT>.openConnectionForKeyAsync
fullName: Callable<Connection> com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.openConnectionForKeyAsync
package: com.microsoft.azure.elasticdb.shard.mapper
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.add*
name: add
nameWithType: IShardMapper<MappingT,ValueT>.add
fullName: MappingT com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.add
package: com.microsoft.azure.elasticdb.shard.mapper
- uid: add9545a
spec.java:
- name: UUID
fullName: UUID
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.remove*
name: remove
nameWithType: IShardMapper<MappingT,ValueT>.remove
fullName: void com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.remove
package: com.microsoft.azure.elasticdb.shard.mapper
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.lookup*
name: lookup
nameWithType: IShardMapper<MappingT,ValueT>.lookup
fullName: MappingT com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.lookup
package: com.microsoft.azure.elasticdb.shard.mapper
- uid: 1d490b8c
spec.java:
- name: ReferenceObjectHelper<MappingT>
fullName: ReferenceObjectHelper<MappingT>
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper.tryLookup*
name: tryLookup
nameWithType: IShardMapper<MappingT,ValueT>.tryLookup
fullName: boolean com.microsoft.azure.elasticdb.shard.mapper.IShardMapper<MappingT extends IShardProvider, ValueT>.tryLookup
package: com.microsoft.azure.elasticdb.shard.mapper
- uid: com.microsoft.azure.elasticdb.shard.base._i_shard_provider
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._i_shard_provider.yml
name: IShardProvider<ValueT>
nameWithType: IShardProvider<ValueT>
fullName: com.microsoft.azure.elasticdb.shard.base.IShardProvider<ValueT>
type: Interface
summary: <p>Represents capabilities to provide a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> along with an associated value. </p>
syntax:
content: public interface IShardProvider<ValueT>
typeParameters:
- type: 0fb6b535
- 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._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

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -0,0 +1,95 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.mapper
id: mapper
children:
- com.microsoft.azure.elasticdb.shard.mapper._base_shard_mapper
- com.microsoft.azure.elasticdb.shard.mapper._connection_options
- com.microsoft.azure.elasticdb.shard.mapper._default_shard_mapper
- com.microsoft.azure.elasticdb.shard.mapper._i_shard_mapper
- com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
- com.microsoft.azure.elasticdb.shard.mapper._range_shard_mapper
href: com.microsoft.azure.elasticdb.shard.mapper.yml
langs:
- java
name: com.microsoft.azure.elasticdb.shard.mapper
nameWithType: com.microsoft.azure.elasticdb.shard.mapper
fullName: com.microsoft.azure.elasticdb.shard.mapper
type: Namespace
source:
remote:
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/mapper/BaseShardMapper.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/BaseShardMapper.java
syntax:
content: package com.microsoft.azure.elasticdb.shard.mapper
references:
- 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._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.mapper._default_shard_mapper
parent: com.microsoft.azure.elasticdb.shard.mapper
href: com.microsoft.azure.elasticdb.shard.mapper._default_shard_mapper.yml
name: DefaultShardMapper
nameWithType: DefaultShardMapper
fullName: com.microsoft.azure.elasticdb.shard.mapper.DefaultShardMapper
type: Class
summary: <p>Default shard mapper, that basically is a container of shards with no keys. </p>
syntax:
content: public class DefaultShardMapper extends BaseShardMapper implements IShardMapper<Shard, Shard>
- 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:
- type: e8a622a9
- type: 0fb6b535
- uid: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper
parent: com.microsoft.azure.elasticdb.shard.mapper
href: com.microsoft.azure.elasticdb.shard.mapper._list_shard_mapper.yml
name: ListShardMapper
nameWithType: ListShardMapper
fullName: com.microsoft.azure.elasticdb.shard.mapper.ListShardMapper
type: Class
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>
- uid: com.microsoft.azure.elasticdb.shard.mapper._range_shard_mapper
parent: com.microsoft.azure.elasticdb.shard.mapper
href: com.microsoft.azure.elasticdb.shard.mapper._range_shard_mapper.yml
name: RangeShardMapper
nameWithType: RangeShardMapper
fullName: com.microsoft.azure.elasticdb.shard.mapper.RangeShardMapper
type: Class
summary: >-
<p>Mapper from a range of keys to their corresponding shards.</p>
<p></p>
syntax:
content: public class RangeShardMapper extends BaseShardMapper implements IShardMapper<RangeMapping, Object>

Просмотреть файл

@ -0,0 +1,422 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
id: _mapping_comparison_result
parent: com.microsoft.azure.elasticdb.shard.recovery
children:
- com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getMappingLocation()
- com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getRange()
- com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getShardMap()
- com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getShardMapManagerMapping()
- com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getShardMapping()
- com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.MappingComparisonResult(StoreShardMap,ShardRange,MappingLocation,StoreMapping,StoreMapping)
- com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setMappingLocation(MappingLocation)
- com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setRange(ShardRange)
- com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setShardMap(StoreShardMap)
- com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setShardMapManagerMapping(StoreMapping)
- com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setShardMapping(StoreMapping)
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
langs:
- java
name: MappingComparisonResult
nameWithType: MappingComparisonResult
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonResult.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/recovery/MappingComparisonResult.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Result of comparison b/w the given range mappings. </p>
syntax:
content: public class MappingComparisonResult
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getMappingLocation()
id: getMappingLocation()
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
langs:
- java
name: getMappingLocation()
nameWithType: MappingComparisonResult.getMappingLocation()
fullName: final MappingLocation com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.getMappingLocation()
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getMappingLocation*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonResult.java
startLine: 86
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public final MappingLocation getMappingLocation()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.recovery._mapping_location
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getRange()
id: getRange()
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
langs:
- java
name: getRange()
nameWithType: MappingComparisonResult.getRange()
fullName: final ShardRange com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.getRange()
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getRange*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonResult.java
startLine: 78
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public final ShardRange getRange()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.base._shard_range
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getShardMap()
id: getShardMap()
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
langs:
- java
name: getShardMap()
nameWithType: MappingComparisonResult.getShardMap()
fullName: final StoreShardMap com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.getShardMap()
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getShardMap*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonResult.java
startLine: 70
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public final StoreShardMap getShardMap()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.store._store_shard_map
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getShardMapManagerMapping()
id: getShardMapManagerMapping()
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
langs:
- java
name: getShardMapManagerMapping()
nameWithType: MappingComparisonResult.getShardMapManagerMapping()
fullName: final StoreMapping com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.getShardMapManagerMapping()
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getShardMapManagerMapping*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonResult.java
startLine: 94
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public final StoreMapping getShardMapManagerMapping()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.store._store_mapping
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getShardMapping()
id: getShardMapping()
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
langs:
- java
name: getShardMapping()
nameWithType: MappingComparisonResult.getShardMapping()
fullName: final StoreMapping com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.getShardMapping()
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getShardMapping*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonResult.java
startLine: 102
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public final StoreMapping getShardMapping()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.store._store_mapping
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.MappingComparisonResult(StoreShardMap,ShardRange,MappingLocation,StoreMapping,StoreMapping)
id: MappingComparisonResult(StoreShardMap,ShardRange,MappingLocation,StoreMapping,StoreMapping)
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
langs:
- java
name: MappingComparisonResult(StoreShardMap ssm, ShardRange range, MappingLocation mappingLocation, StoreMapping gsmMapping, StoreMapping lsmMapping)
nameWithType: MappingComparisonResult.MappingComparisonResult(StoreShardMap ssm, ShardRange range, MappingLocation mappingLocation, StoreMapping gsmMapping, StoreMapping lsmMapping)
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.MappingComparisonResult(StoreShardMap ssm, ShardRange range, MappingLocation mappingLocation, StoreMapping gsmMapping, StoreMapping lsmMapping)
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.MappingComparisonResult*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonResult.java
startLine: 58
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Instantiates a new instance of range mapping comparison result.</p>
<p></p>
syntax:
content: public MappingComparisonResult(StoreShardMap ssm, ShardRange range, MappingLocation mappingLocation, StoreMapping gsmMapping, StoreMapping lsmMapping)
parameters:
- id: ssm
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: <p>Store representation of shard map. </p>
- id: range
type: com.microsoft.azure.elasticdb.shard.base._shard_range
description: <p>Range being considered. </p>
- id: mappingLocation
type: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
description: <p>Location of mapping. </p>
- id: gsmMapping
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
description: <p>Storage representation of GSM mapping. </p>
- id: lsmMapping
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
description: <p>Storage representation of LSM mapping. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setMappingLocation(MappingLocation)
id: setMappingLocation(MappingLocation)
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
langs:
- java
name: setMappingLocation(MappingLocation value)
nameWithType: MappingComparisonResult.setMappingLocation(MappingLocation value)
fullName: final void com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.setMappingLocation(MappingLocation value)
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setMappingLocation*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonResult.java
startLine: 90
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public final void setMappingLocation(MappingLocation value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setRange(ShardRange)
id: setRange(ShardRange)
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
langs:
- java
name: setRange(ShardRange value)
nameWithType: MappingComparisonResult.setRange(ShardRange value)
fullName: final void com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.setRange(ShardRange value)
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setRange*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonResult.java
startLine: 82
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public final void setRange(ShardRange value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.base._shard_range
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setShardMap(StoreShardMap)
id: setShardMap(StoreShardMap)
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
langs:
- java
name: setShardMap(StoreShardMap value)
nameWithType: MappingComparisonResult.setShardMap(StoreShardMap value)
fullName: final void com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.setShardMap(StoreShardMap value)
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setShardMap*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonResult.java
startLine: 74
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public final void setShardMap(StoreShardMap value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setShardMapManagerMapping(StoreMapping)
id: setShardMapManagerMapping(StoreMapping)
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
langs:
- java
name: setShardMapManagerMapping(StoreMapping value)
nameWithType: MappingComparisonResult.setShardMapManagerMapping(StoreMapping value)
fullName: final void com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.setShardMapManagerMapping(StoreMapping value)
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setShardMapManagerMapping*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonResult.java
startLine: 98
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public final void setShardMapManagerMapping(StoreMapping value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setShardMapping(StoreMapping)
id: setShardMapping(StoreMapping)
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
langs:
- java
name: setShardMapping(StoreMapping value)
nameWithType: MappingComparisonResult.setShardMapping(StoreMapping value)
fullName: final void com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.setShardMapping(StoreMapping value)
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setShardMapping*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonResult.java
startLine: 106
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public final void setShardMapping(StoreMapping value)
parameters:
- id: value
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
return:
type: 3f6357ce
references:
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.MappingComparisonResult*
name: MappingComparisonResult
nameWithType: MappingComparisonResult.MappingComparisonResult
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.MappingComparisonResult
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: 93de0ef9com.microsoft.azure.elasticdb.shard.store._store_shard_map
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.shard.store._store_shard_map
name: StoreShardMap
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShardMap
href: com.microsoft.azure.elasticdb.shard.store._store_shard_map.yml
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getShardMap*
name: getShardMap
nameWithType: MappingComparisonResult.getShardMap
fullName: final StoreShardMap com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.getShardMap
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: 3f6357ce
spec.java:
- name: final void
fullName: final void
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setShardMap*
name: setShardMap
nameWithType: MappingComparisonResult.setShardMap
fullName: final void com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.setShardMap
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: 93de0ef9com.microsoft.azure.elasticdb.shard.base._shard_range
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.shard.base._shard_range
name: ShardRange
fullName: com.microsoft.azure.elasticdb.shard.base.ShardRange
href: com.microsoft.azure.elasticdb.shard.base._shard_range.yml
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getRange*
name: getRange
nameWithType: MappingComparisonResult.getRange
fullName: final ShardRange com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.getRange
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setRange*
name: setRange
nameWithType: MappingComparisonResult.setRange
fullName: final void com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.setRange
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: 93de0ef9com.microsoft.azure.elasticdb.shard.recovery._mapping_location
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
name: MappingLocation
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingLocation
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getMappingLocation*
name: getMappingLocation
nameWithType: MappingComparisonResult.getMappingLocation
fullName: final MappingLocation com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.getMappingLocation
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setMappingLocation*
name: setMappingLocation
nameWithType: MappingComparisonResult.setMappingLocation
fullName: final void com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.setMappingLocation
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: 93de0ef9com.microsoft.azure.elasticdb.shard.store._store_mapping
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.shard.store._store_mapping
name: StoreMapping
fullName: com.microsoft.azure.elasticdb.shard.store.StoreMapping
href: com.microsoft.azure.elasticdb.shard.store._store_mapping.yml
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getShardMapManagerMapping*
name: getShardMapManagerMapping
nameWithType: MappingComparisonResult.getShardMapManagerMapping
fullName: final StoreMapping com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.getShardMapManagerMapping
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setShardMapManagerMapping*
name: setShardMapManagerMapping
nameWithType: MappingComparisonResult.setShardMapManagerMapping
fullName: final void com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.setShardMapManagerMapping
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.getShardMapping*
name: getShardMapping
nameWithType: MappingComparisonResult.getShardMapping
fullName: final StoreMapping com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.getShardMapping
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.setShardMapping*
name: setShardMapping
nameWithType: MappingComparisonResult.setShardMapping
fullName: final void com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult.setShardMapping
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.store._store_shard_map
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_shard_map.yml
name: StoreShardMap
nameWithType: StoreShardMap
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShardMap
type: Class
summary: <p>Store representation of a shard map. </p>
syntax:
content: public class StoreShardMap
- uid: com.microsoft.azure.elasticdb.shard.base._shard_range
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_range.yml
name: ShardRange
nameWithType: ShardRange
fullName: com.microsoft.azure.elasticdb.shard.base.ShardRange
type: Class
summary: <p>A range of shard keys between a low key and a high key. The low key is inclusive (part of the range) while the high key is exclusive (not part of the range). The <xref uid="com.microsoft.azure.elasticdb.shard.base._shard_range" data-throw-if-not-resolved="false">ShardRange</xref> class is immutable. </p>
syntax:
content: public class ShardRange
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
name: MappingLocation
nameWithType: MappingLocation
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingLocation
type: Enum
summary: <p>Location where the different mappings exist. </p>
syntax:
content: public enum MappingLocation
- uid: com.microsoft.azure.elasticdb.shard.store._store_mapping
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_mapping.yml
name: StoreMapping
nameWithType: StoreMapping
fullName: com.microsoft.azure.elasticdb.shard.store.StoreMapping
type: Class
summary: <p>Storage representation of a mapping b/w key ranges and shards. </p>
syntax:
content: public class StoreMapping

Просмотреть файл

@ -0,0 +1,202 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils
id: _mapping_comparison_utils
parent: com.microsoft.azure.elasticdb.shard.recovery
children:
- com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils.comparePointMappings(StoreShardMap,List<StoreMapping>,List<StoreMapping>)
- com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils.compareRangeMappings(StoreShardMap,List<StoreMapping>,List<StoreMapping>)
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils.yml
langs:
- java
name: MappingComparisonUtils
nameWithType: MappingComparisonUtils
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonUtils
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonUtils.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/recovery/MappingComparisonUtils.java
startLine: 32
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>contains utility methods for performing comparisons among collections of mappings of either list or range shard maps. </p>
syntax:
content: public class MappingComparisonUtils
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils.comparePointMappings(StoreShardMap,List<StoreMapping>,List<StoreMapping>)
id: comparePointMappings(StoreShardMap,List<StoreMapping>,List<StoreMapping>)
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils.yml
langs:
- java
name: comparePointMappings(StoreShardMap ssm, List<StoreMapping> gsmMappings, List<StoreMapping> lsmMappings)
nameWithType: MappingComparisonUtils.comparePointMappings(StoreShardMap ssm, List<StoreMapping> gsmMappings, List<StoreMapping> lsmMappings)
fullName: static List<MappingComparisonResult> com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonUtils.comparePointMappings(StoreShardMap ssm, List<StoreMapping> gsmMappings, List<StoreMapping> lsmMappings)
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils.comparePointMappings*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonUtils.java
startLine: 315
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Helper function that produces a list of MappingComparisonResults from union of points in the gsmMappings and lsmMappings.</p>
<p></p>
syntax:
content: public static List<MappingComparisonResult> comparePointMappings(StoreShardMap ssm, List<StoreMapping> gsmMappings, List<StoreMapping> lsmMappings)
parameters:
- id: ssm
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: <p>StoreShardMap to be referenced in produced MappingComparisonResults </p>
- id: gsmMappings
type: 5618da2dcom.microsoft.azure.elasticdb.shard.store._store_mappinga08ddfce
description: <p>List of mappings from the GSM. </p>
- id: lsmMappings
type: 5618da2dcom.microsoft.azure.elasticdb.shard.store._store_mappinga08ddfce
description: <p>List of mappings from the LSM. </p>
return:
type: 5618da2dcom.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_resulta08ddfce
description: '<p>List of <xref uid="com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result" data-throw-if-not-resolved="false">MappingComparisonResult</xref>: one for each range arising from the union of boundaries in gsmMappings and lsmMappings. </p>'
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils.compareRangeMappings(StoreShardMap,List<StoreMapping>,List<StoreMapping>)
id: compareRangeMappings(StoreShardMap,List<StoreMapping>,List<StoreMapping>)
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils.yml
langs:
- java
name: compareRangeMappings(StoreShardMap ssm, List<StoreMapping> gsmMappings, List<StoreMapping> lsmMappings)
nameWithType: MappingComparisonUtils.compareRangeMappings(StoreShardMap ssm, List<StoreMapping> gsmMappings, List<StoreMapping> lsmMappings)
fullName: static ArrayList<MappingComparisonResult> com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonUtils.compareRangeMappings(StoreShardMap ssm, List<StoreMapping> gsmMappings, List<StoreMapping> lsmMappings)
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils.compareRangeMappings*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonUtils.java
startLine: 45
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Helper function that produces a list of MappingComparisonResults from union of range boundaries in the gsmMappings and lsmMappings.</p>
<p></p>
syntax:
content: public static ArrayList<MappingComparisonResult> compareRangeMappings(StoreShardMap ssm, List<StoreMapping> gsmMappings, List<StoreMapping> lsmMappings)
parameters:
- id: ssm
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: <p>StoreShardMap to be referenced in produced MappingComparisonResults </p>
- id: gsmMappings
type: 5618da2dcom.microsoft.azure.elasticdb.shard.store._store_mappinga08ddfce
description: <p>List of mappings from the GSM. </p>
- id: lsmMappings
type: 5618da2dcom.microsoft.azure.elasticdb.shard.store._store_mappinga08ddfce
description: <p>List of mappings from the LSM. </p>
return:
type: 573b1e0bcom.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_resulta08ddfce
description: '<p>List of <xref uid="com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result" data-throw-if-not-resolved="false">MappingComparisonResult</xref>: one for each range arising from the union of boundaries in gsmMappings and lsmMappings. </p>'
references:
- uid: 5618da2dcom.microsoft.azure.elasticdb.shard.store._store_mappinga08ddfce
spec.java:
- name: List<
fullName: List<
- uid: com.microsoft.azure.elasticdb.shard.store._store_mapping
name: StoreMapping
fullName: com.microsoft.azure.elasticdb.shard.store.StoreMapping
href: com.microsoft.azure.elasticdb.shard.store._store_mapping.yml
- name: '>'
fullName: '>'
- uid: 573b1e0bcom.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_resulta08ddfce
spec.java:
- name: ArrayList<
fullName: ArrayList<
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
name: MappingComparisonResult
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils.compareRangeMappings*
name: compareRangeMappings
nameWithType: MappingComparisonUtils.compareRangeMappings
fullName: static ArrayList<MappingComparisonResult> com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonUtils.compareRangeMappings
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: 5618da2dcom.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_resulta08ddfce
spec.java:
- name: List<
fullName: List<
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
name: MappingComparisonResult
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils.comparePointMappings*
name: comparePointMappings
nameWithType: MappingComparisonUtils.comparePointMappings
fullName: static List<MappingComparisonResult> com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonUtils.comparePointMappings
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
name: MappingComparisonResult
nameWithType: MappingComparisonResult
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult
type: Class
summary: <p>Result of comparison b/w the given range mappings. </p>
syntax:
content: public class MappingComparisonResult
- uid: com.microsoft.azure.elasticdb.shard.store._store_shard_map
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_shard_map.yml
name: StoreShardMap
nameWithType: StoreShardMap
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShardMap
type: Class
summary: <p>Store representation of a shard map. </p>
syntax:
content: public class StoreShardMap
- uid: com.microsoft.azure.elasticdb.shard.store._store_mapping
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_mapping.yml
name: StoreMapping
nameWithType: StoreMapping
fullName: com.microsoft.azure.elasticdb.shard.store.StoreMapping
type: Class
summary: <p>Storage representation of a mapping b/w key ranges and shards. </p>
syntax:
content: public class StoreMapping
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_key.yml
name: ShardKey
nameWithType: ShardKey
fullName: com.microsoft.azure.elasticdb.shard.base.ShardKey
type: Class
summary: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref> key value. Wraps the type and value and allows normalization/denormalization for serialization. </p>
syntax:
content: public class ShardKey
- uid: com.microsoft.azure.elasticdb.shard.base._shard_key_type
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_key_type.yml
name: ShardKeyType
nameWithType: ShardKeyType
fullName: com.microsoft.azure.elasticdb.shard.base.ShardKeyType
type: Enum
summary: <p>Type of shard key. Currently, only Int32, Int64, Guid and byte[] are the data types supported as shard keys. </p>
syntax:
content: public enum ShardKeyType
- uid: com.microsoft.azure.elasticdb.shard.base._shard_range
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_range.yml
name: ShardRange
nameWithType: ShardRange
fullName: com.microsoft.azure.elasticdb.shard.base.ShardRange
type: Class
summary: <p>A range of shard keys between a low key and a high key. The low key is inclusive (part of the range) while the high key is exclusive (not part of the range). The <xref uid="com.microsoft.azure.elasticdb.shard.base._shard_range" data-throw-if-not-resolved="false">ShardRange</xref> class is immutable. </p>
syntax:
content: public class ShardRange

Просмотреть файл

@ -0,0 +1,273 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference
id: _mapping_difference
parent: com.microsoft.azure.elasticdb.shard.recovery
children:
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getLocation()
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getMappingForShard()
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getMappingForShardMap()
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getShardMap()
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getType()
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.MappingDifference(MappingDifferenceType,MappingLocation,StoreShardMap,StoreMapping,StoreMapping)
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.yml
langs:
- java
name: MappingDifference
nameWithType: MappingDifference
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifference
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifference.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/recovery/MappingDifference.java
startLine: 16
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Class for mapping differences. </p>
syntax:
content: public class MappingDifference
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getLocation()
id: getLocation()
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.yml
langs:
- java
name: getLocation()
nameWithType: MappingDifference.getLocation()
fullName: final MappingLocation com.microsoft.azure.elasticdb.shard.recovery.MappingDifference.getLocation()
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getLocation*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifference.java
startLine: 77
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public final MappingLocation getLocation()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.recovery._mapping_location
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getMappingForShard()
id: getMappingForShard()
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.yml
langs:
- java
name: getMappingForShard()
nameWithType: MappingDifference.getMappingForShard()
fullName: final StoreMapping com.microsoft.azure.elasticdb.shard.recovery.MappingDifference.getMappingForShard()
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getMappingForShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifference.java
startLine: 101
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public final StoreMapping getMappingForShard()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.store._store_mapping
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getMappingForShardMap()
id: getMappingForShardMap()
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.yml
langs:
- java
name: getMappingForShardMap()
nameWithType: MappingDifference.getMappingForShardMap()
fullName: final StoreMapping com.microsoft.azure.elasticdb.shard.recovery.MappingDifference.getMappingForShardMap()
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getMappingForShardMap*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifference.java
startLine: 93
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public final StoreMapping getMappingForShardMap()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.store._store_mapping
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getShardMap()
id: getShardMap()
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.yml
langs:
- java
name: getShardMap()
nameWithType: MappingDifference.getShardMap()
fullName: final StoreShardMap com.microsoft.azure.elasticdb.shard.recovery.MappingDifference.getShardMap()
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getShardMap*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifference.java
startLine: 85
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public final StoreShardMap getShardMap()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.store._store_shard_map
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getType()
id: getType()
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.yml
langs:
- java
name: getType()
nameWithType: MappingDifference.getType()
fullName: final MappingDifferenceType com.microsoft.azure.elasticdb.shard.recovery.MappingDifference.getType()
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getType*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifference.java
startLine: 69
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public final MappingDifferenceType getType()
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.MappingDifference(MappingDifferenceType,MappingLocation,StoreShardMap,StoreMapping,StoreMapping)
id: MappingDifference(MappingDifferenceType,MappingLocation,StoreShardMap,StoreMapping,StoreMapping)
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.yml
langs:
- java
name: MappingDifference(MappingDifferenceType type, MappingLocation location, StoreShardMap shardMap, StoreMapping mappingForShardMap, StoreMapping mappingForShard)
nameWithType: MappingDifference.MappingDifference(MappingDifferenceType type, MappingLocation location, StoreShardMap shardMap, StoreMapping mappingForShardMap, StoreMapping mappingForShard)
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifference.MappingDifference(MappingDifferenceType type, MappingLocation location, StoreShardMap shardMap, StoreMapping mappingForShardMap, StoreMapping mappingForShard)
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.MappingDifference*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifference.java
startLine: 57
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Creates an Instance of Mapping Difference.</p>
<p></p>
syntax:
content: public MappingDifference(MappingDifferenceType type, MappingLocation location, StoreShardMap shardMap, StoreMapping mappingForShardMap, StoreMapping mappingForShard)
parameters:
- id: type
type: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
description: <p>Mapping Difference Type </p>
- id: location
type: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
description: <p>Mapping Location </p>
- id: shardMap
type: com.microsoft.azure.elasticdb.shard.store._store_shard_map
description: <p>Shard Map </p>
- id: mappingForShardMap
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
description: <p>Store Mapping for Shard Map </p>
- id: mappingForShard
type: com.microsoft.azure.elasticdb.shard.store._store_mapping
description: <p>Store Mapping for Shard </p>
references:
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.MappingDifference*
name: MappingDifference
nameWithType: MappingDifference.MappingDifference
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifference.MappingDifference
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: 93de0ef9com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
name: MappingDifferenceType
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceType
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.yml
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getType*
name: getType
nameWithType: MappingDifference.getType
fullName: final MappingDifferenceType com.microsoft.azure.elasticdb.shard.recovery.MappingDifference.getType
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: 93de0ef9com.microsoft.azure.elasticdb.shard.recovery._mapping_location
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
name: MappingLocation
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingLocation
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getLocation*
name: getLocation
nameWithType: MappingDifference.getLocation
fullName: final MappingLocation com.microsoft.azure.elasticdb.shard.recovery.MappingDifference.getLocation
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: 93de0ef9com.microsoft.azure.elasticdb.shard.store._store_shard_map
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.shard.store._store_shard_map
name: StoreShardMap
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShardMap
href: com.microsoft.azure.elasticdb.shard.store._store_shard_map.yml
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getShardMap*
name: getShardMap
nameWithType: MappingDifference.getShardMap
fullName: final StoreShardMap com.microsoft.azure.elasticdb.shard.recovery.MappingDifference.getShardMap
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: 93de0ef9com.microsoft.azure.elasticdb.shard.store._store_mapping
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.shard.store._store_mapping
name: StoreMapping
fullName: com.microsoft.azure.elasticdb.shard.store.StoreMapping
href: com.microsoft.azure.elasticdb.shard.store._store_mapping.yml
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getMappingForShardMap*
name: getMappingForShardMap
nameWithType: MappingDifference.getMappingForShardMap
fullName: final StoreMapping com.microsoft.azure.elasticdb.shard.recovery.MappingDifference.getMappingForShardMap
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.getMappingForShard*
name: getMappingForShard
nameWithType: MappingDifference.getMappingForShard
fullName: final StoreMapping com.microsoft.azure.elasticdb.shard.recovery.MappingDifference.getMappingForShard
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.yml
name: MappingDifferenceType
nameWithType: MappingDifferenceType
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceType
type: Enum
summary: <p>Type of mapping difference. Useful for down casting. </p>
syntax:
content: public enum MappingDifferenceType
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
name: MappingLocation
nameWithType: MappingLocation
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingLocation
type: Enum
summary: <p>Location where the different mappings exist. </p>
syntax:
content: public enum MappingLocation
- uid: com.microsoft.azure.elasticdb.shard.store._store_shard_map
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_shard_map.yml
name: StoreShardMap
nameWithType: StoreShardMap
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShardMap
type: Class
summary: <p>Store representation of a shard map. </p>
syntax:
content: public class StoreShardMap
- uid: com.microsoft.azure.elasticdb.shard.store._store_mapping
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_mapping.yml
name: StoreMapping
nameWithType: StoreMapping
fullName: com.microsoft.azure.elasticdb.shard.store.StoreMapping
type: Class
summary: <p>Storage representation of a mapping b/w key ranges and shards. </p>
syntax:
content: public class StoreMapping

Просмотреть файл

@ -0,0 +1,204 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution
id: _mapping_difference_resolution
parent: com.microsoft.azure.elasticdb.shard.recovery
children:
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.forValue(int)
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.getValue()
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.Ignore
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.KeepShardMapMapping
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.KeepShardMapping
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.MappingDifferenceResolution(int)
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.SIZE
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.yml
langs:
- java
name: MappingDifferenceResolution
nameWithType: MappingDifferenceResolution
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceResolution
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifferenceResolution.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/recovery/MappingDifferenceResolution.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Resolution strategy for resolving mapping differences. </p>
syntax: &o1
content: public enum MappingDifferenceResolution
inheritance:
- java.lang.Object
- java.lang.Enum<MappingDifferenceResolution>
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.yml
langs:
- java
name: forValue(int value)
nameWithType: MappingDifferenceResolution.forValue(int value)
fullName: static MappingDifferenceResolution com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceResolution.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifferenceResolution.java
startLine: 49
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public static MappingDifferenceResolution forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.yml
langs:
- java
name: getValue()
nameWithType: MappingDifferenceResolution.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceResolution.getValue()
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifferenceResolution.java
startLine: 53
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.Ignore
id: Ignore
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.yml
langs:
- java
name: Ignore
nameWithType: MappingDifferenceResolution.Ignore
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceResolution.Ignore
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifferenceResolution.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Ignore the difference for now. </p>
syntax:
content: public Ignore=(0)
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.KeepShardMapMapping
id: KeepShardMapMapping
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.yml
langs:
- java
name: KeepShardMapMapping
nameWithType: MappingDifferenceResolution.KeepShardMapMapping
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceResolution.KeepShardMapMapping
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifferenceResolution.java
startLine: 22
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Use the mapping present in shard map. </p>
syntax:
content: public KeepShardMapMapping=(1)
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.KeepShardMapping
id: KeepShardMapping
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.yml
langs:
- java
name: KeepShardMapping
nameWithType: MappingDifferenceResolution.KeepShardMapping
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceResolution.KeepShardMapping
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifferenceResolution.java
startLine: 27
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Use the mapping in the shard. </p>
syntax:
content: public KeepShardMapping=(2)
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.MappingDifferenceResolution(int)
id: MappingDifferenceResolution(int)
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.yml
langs:
- java
name: MappingDifferenceResolution(int value)
nameWithType: MappingDifferenceResolution.MappingDifferenceResolution(int value)
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceResolution.MappingDifferenceResolution(int value)
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.MappingDifferenceResolution*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifferenceResolution.java
startLine: 33
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public MappingDifferenceResolution(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.yml
langs:
- java
name: SIZE
nameWithType: MappingDifferenceResolution.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceResolution.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifferenceResolution.java
startLine: 29
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.MappingDifferenceResolution*
name: MappingDifferenceResolution
nameWithType: MappingDifferenceResolution.MappingDifferenceResolution
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceResolution.MappingDifferenceResolution
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.getValue*
name: getValue
nameWithType: MappingDifferenceResolution.getValue
fullName: int com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceResolution.getValue
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.forValue*
name: forValue
nameWithType: MappingDifferenceResolution.forValue
fullName: static MappingDifferenceResolution com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceResolution.forValue
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.yml
name: MappingDifferenceResolution
nameWithType: MappingDifferenceResolution
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceResolution
type: Enum
summary: <p>Resolution strategy for resolving mapping differences. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,185 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
id: _mapping_difference_type
parent: com.microsoft.azure.elasticdb.shard.recovery
children:
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.forValue(int)
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.getValue()
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.List
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.MappingDifferenceType(int)
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.Range
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.SIZE
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.yml
langs:
- java
name: MappingDifferenceType
nameWithType: MappingDifferenceType
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceType
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifferenceType.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/recovery/MappingDifferenceType.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Type of mapping difference. Useful for down casting. </p>
syntax: &o1
content: public enum MappingDifferenceType
inheritance:
- java.lang.Object
- java.lang.Enum<MappingDifferenceType>
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.yml
langs:
- java
name: forValue(int value)
nameWithType: MappingDifferenceType.forValue(int value)
fullName: static MappingDifferenceType com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceType.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifferenceType.java
startLine: 44
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public static MappingDifferenceType forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.yml
langs:
- java
name: getValue()
nameWithType: MappingDifferenceType.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceType.getValue()
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifferenceType.java
startLine: 48
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.List
id: List
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.yml
langs:
- java
name: List
nameWithType: MappingDifferenceType.List
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceType.List
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifferenceType.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Violation associated with ListShardMap. </p>
syntax:
content: public List=(0)
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.MappingDifferenceType(int)
id: MappingDifferenceType(int)
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.yml
langs:
- java
name: MappingDifferenceType(int value)
nameWithType: MappingDifferenceType.MappingDifferenceType(int value)
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceType.MappingDifferenceType(int value)
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.MappingDifferenceType*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifferenceType.java
startLine: 28
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public MappingDifferenceType(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.Range
id: Range
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.yml
langs:
- java
name: Range
nameWithType: MappingDifferenceType.Range
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceType.Range
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifferenceType.java
startLine: 22
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Violation associated with RangeShardMap. </p>
syntax:
content: public Range=(1)
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.yml
langs:
- java
name: SIZE
nameWithType: MappingDifferenceType.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceType.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingDifferenceType.java
startLine: 24
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.MappingDifferenceType*
name: MappingDifferenceType
nameWithType: MappingDifferenceType.MappingDifferenceType
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceType.MappingDifferenceType
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.getValue*
name: getValue
nameWithType: MappingDifferenceType.getValue
fullName: int com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceType.getValue
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.forValue*
name: forValue
nameWithType: MappingDifferenceType.forValue
fullName: static MappingDifferenceType com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceType.forValue
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.yml
name: MappingDifferenceType
nameWithType: MappingDifferenceType
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceType
type: Enum
summary: <p>Type of mapping difference. Useful for down casting. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,204 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
id: _mapping_location
parent: com.microsoft.azure.elasticdb.shard.recovery
children:
- com.microsoft.azure.elasticdb.shard.recovery._mapping_location.forValue(int)
- com.microsoft.azure.elasticdb.shard.recovery._mapping_location.getValue()
- com.microsoft.azure.elasticdb.shard.recovery._mapping_location.MappingInShardMapAndShard
- com.microsoft.azure.elasticdb.shard.recovery._mapping_location.MappingInShardMapOnly
- com.microsoft.azure.elasticdb.shard.recovery._mapping_location.MappingInShardOnly
- com.microsoft.azure.elasticdb.shard.recovery._mapping_location.MappingLocation(int)
- com.microsoft.azure.elasticdb.shard.recovery._mapping_location.SIZE
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
langs:
- java
name: MappingLocation
nameWithType: MappingLocation
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingLocation
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingLocation.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/recovery/MappingLocation.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Location where the different mappings exist. </p>
syntax: &o1
content: public enum MappingLocation
inheritance:
- java.lang.Object
- java.lang.Enum<MappingLocation>
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
langs:
- java
name: forValue(int value)
nameWithType: MappingLocation.forValue(int value)
fullName: static MappingLocation com.microsoft.azure.elasticdb.shard.recovery.MappingLocation.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingLocation.java
startLine: 49
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public static MappingLocation forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
langs:
- java
name: getValue()
nameWithType: MappingLocation.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.recovery.MappingLocation.getValue()
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingLocation.java
startLine: 53
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.MappingInShardMapAndShard
id: MappingInShardMapAndShard
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
langs:
- java
name: MappingInShardMapAndShard
nameWithType: MappingLocation.MappingInShardMapAndShard
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingLocation.MappingInShardMapAndShard
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingLocation.java
startLine: 27
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Mapping present at both global store and shard. </p>
syntax:
content: public MappingInShardMapAndShard=(2)
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.MappingInShardMapOnly
id: MappingInShardMapOnly
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
langs:
- java
name: MappingInShardMapOnly
nameWithType: MappingLocation.MappingInShardMapOnly
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingLocation.MappingInShardMapOnly
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingLocation.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Mapping is present in global store, but absent on the shard. </p>
syntax:
content: public MappingInShardMapOnly=(0)
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.MappingInShardOnly
id: MappingInShardOnly
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
langs:
- java
name: MappingInShardOnly
nameWithType: MappingLocation.MappingInShardOnly
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingLocation.MappingInShardOnly
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingLocation.java
startLine: 22
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Mapping is absent in global store, but present on the shard. </p>
syntax:
content: public MappingInShardOnly=(1)
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.MappingLocation(int)
id: MappingLocation(int)
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
langs:
- java
name: MappingLocation(int value)
nameWithType: MappingLocation.MappingLocation(int value)
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingLocation.MappingLocation(int value)
overload: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.MappingLocation*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingLocation.java
startLine: 33
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public MappingLocation(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
langs:
- java
name: SIZE
nameWithType: MappingLocation.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.recovery.MappingLocation.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingLocation.java
startLine: 29
package: com.microsoft.azure.elasticdb.shard.recovery
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.MappingLocation*
name: MappingLocation
nameWithType: MappingLocation.MappingLocation
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingLocation.MappingLocation
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.getValue*
name: getValue
nameWithType: MappingLocation.getValue
fullName: int com.microsoft.azure.elasticdb.shard.recovery.MappingLocation.getValue
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.forValue*
name: forValue
nameWithType: MappingLocation.forValue
fullName: static MappingLocation com.microsoft.azure.elasticdb.shard.recovery.MappingLocation.forValue
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
name: MappingLocation
nameWithType: MappingLocation
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingLocation
type: Enum
summary: <p>Location where the different mappings exist. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,833 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
id: _recovery_manager
parent: com.microsoft.azure.elasticdb.shard.recovery
children:
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.attachShard(ShardLocation)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.attachShard(ShardLocation,String)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.detachShard(ShardLocation)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.detachShard(ShardLocation,String)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.detectMappingDifferences(ShardLocation)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.detectMappingDifferences(ShardLocation,String)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getMappingDifferences(RecoveryToken)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardInfo(RecoveryToken,ReferenceObjectHelper<ShardMapType>,ReferenceObjectHelper<String>)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardInfo(RecoveryToken,ReferenceObjectHelper<ShardMapType>,ReferenceObjectHelper<String>,ReferenceObjectHelper<ShardLocation>)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardLocation(RecoveryToken)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardMapName(RecoveryToken)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardMapType(RecoveryToken)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShard(RecoveryToken,List<ShardRange>)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShardMapManagerFromShards(List<ShardLocation>)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShardMapManagerFromShards(List<ShardLocation>,String)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShardsFromShardMapManager(List<ShardLocation>)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShardsFromShardMapManager(List<ShardLocation>,String)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.RecoveryManager(ShardMapManager)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.resolveMappingDifferences(RecoveryToken,MappingDifferenceResolution)
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: RecoveryManager
nameWithType: RecoveryManager
fullName: com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.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/recovery/RecoveryManager.java
startLine: 48
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Manages various recovery related tasks for a shard map manager. It helps resolving data corruption issues between shard map information stored locally on the shards and in the global shard map manager database. It also helps with certain 'oops' recovery scenarios where reconstruction of shard maps from database backups or database copies is necessary. Note that some of the recovery methods can cause unrecoverable data loss when not used properly. It is recommend to take backups or copies of all databases that participate in recovery operations. </p>
syntax:
content: public class RecoveryManager
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.attachShard(ShardLocation)
id: attachShard(ShardLocation)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: attachShard(ShardLocation location)
nameWithType: RecoveryManager.attachShard(ShardLocation location)
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.attachShard(ShardLocation location)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.attachShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 123
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Attaches a shard to the shard map manager. Earlier versions of mappings for the same shard map will automatically be updated if more recent versions are found on the shard to be attached. After attaching a shard, DetectMappingDifferences(ShardLocation, string) should be called to check for any inconsistencies that warrant manual conflict resolution.</p>
<p></p>
syntax:
content: public void attachShard(ShardLocation location)
parameters:
- id: location
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>Location of the shard being attached. Note that this method can cause unrecoverable data loss. Make sure you have taken backups or copies of your databases and only then proceed with great care. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.attachShard(ShardLocation,String)
id: attachShard(ShardLocation,String)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: attachShard(ShardLocation location, String shardMapName)
nameWithType: RecoveryManager.attachShard(ShardLocation location, String shardMapName)
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.attachShard(ShardLocation location, String shardMapName)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.attachShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 139
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Attaches a shard to the shard map manager. Earlier versions of mappings for the same shard map will automatically be updated if more recent versions are found on the shard to be attached. Shard location will be upgraded to latest version of local store as part of this operation. After attaching a shard, DetectMappingDifferences(ShardLocation, string) should be called to check for any inconsistencies that warrant manual conflict resolution.</p>
<p></p>
syntax:
content: public void attachShard(ShardLocation location, String shardMapName)
parameters:
- id: location
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>Location of the shard being attached. </p>
- id: shardMapName
type: "26831127"
description: <p>Optional string to filter on the shard map name. Note that this method can cause unrecoverable data loss. Make sure you have taken backups or copies of your databases and only then proceed with great care. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.detachShard(ShardLocation)
id: detachShard(ShardLocation)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: detachShard(ShardLocation location)
nameWithType: RecoveryManager.detachShard(ShardLocation location)
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.detachShard(ShardLocation location)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.detachShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 183
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Detaches the given shard from the shard map manager. Mappings pointing to the shard to be deleted will automatically be removed by this method.</p>
<p></p>
syntax:
content: public void detachShard(ShardLocation location)
parameters:
- id: location
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>Location of the shard being detached. Note that this method can cause unrecoverable data loss. Make sure you have taken backups or copies of your databases and only then proceed with great care. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.detachShard(ShardLocation,String)
id: detachShard(ShardLocation,String)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: detachShard(ShardLocation location, String shardMapName)
nameWithType: RecoveryManager.detachShard(ShardLocation location, String shardMapName)
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.detachShard(ShardLocation location, String shardMapName)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.detachShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 196
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Detaches the given shard from the shard map manager. Mappings pointing to the shard to be deleted will automatically be removed by this method.</p>
<p></p>
syntax:
content: public void detachShard(ShardLocation location, String shardMapName)
parameters:
- id: location
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>Location of the shard being detached. </p>
- id: shardMapName
type: "26831127"
description: <p>Optional string to filter on shard map name. Note that this method can cause unrecoverable data loss. Make sure you have taken backups or copies of your databases and only then proceed with great care. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.detectMappingDifferences(ShardLocation)
id: detectMappingDifferences(ShardLocation)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: detectMappingDifferences(ShardLocation location)
nameWithType: RecoveryManager.detectMappingDifferences(ShardLocation location)
fullName: List<RecoveryToken> com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.detectMappingDifferences(ShardLocation location)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.detectMappingDifferences*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 523
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Enumerates differences in the mappings between the global shard map manager database and the local shard database in the specified shard location.</p>
<p></p>
syntax:
content: public List<RecoveryToken> detectMappingDifferences(ShardLocation location)
parameters:
- id: location
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>Location of shard for which to detect inconsistencies. </p>
return:
type: 5618da2dcom.microsoft.azure.elasticdb.shard.recovery._recovery_tokena08ddfce
description: <p>Collection of tokens to be used for further resolution tasks (see ResolveMappingDifferences). </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.detectMappingDifferences(ShardLocation,String)
id: detectMappingDifferences(ShardLocation,String)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: detectMappingDifferences(ShardLocation location, String shardMapName)
nameWithType: RecoveryManager.detectMappingDifferences(ShardLocation location, String shardMapName)
fullName: List<RecoveryToken> com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.detectMappingDifferences(ShardLocation location, String shardMapName)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.detectMappingDifferences*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 537
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Enumerates differences in the mappings between the global shard map manager database and the local shard database in the specified shard location.</p>
<p></p>
syntax:
content: public List<RecoveryToken> detectMappingDifferences(ShardLocation location, String shardMapName)
parameters:
- id: location
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>Location of shard for which to detect inconsistencies. </p>
- id: shardMapName
type: "26831127"
description: <p>Optional parameter to specify a particular shard map. </p>
return:
type: 5618da2dcom.microsoft.azure.elasticdb.shard.recovery._recovery_tokena08ddfce
description: <p>Collection of tokens to be used for further resolution tasks (see ResolveMappingDifferences). </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getMappingDifferences(RecoveryToken)
id: getMappingDifferences(RecoveryToken)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: getMappingDifferences(RecoveryToken token)
nameWithType: RecoveryManager.getMappingDifferences(RecoveryToken token)
fullName: Map<ShardRange, MappingLocation> com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.getMappingDifferences(RecoveryToken token)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getMappingDifferences*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 222
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Returns a dictionary of range-to-location key-value pairs. The location returned is an enumerator stating whether a given range (or point) is present only in the local shard map, only in the global shard map, or both. Ranges not contained in either shard map cannot contain differences so those ranges are not shown.</p>
<p></p>
syntax:
content: public Map<ShardRange, MappingLocation> getMappingDifferences(RecoveryToken token)
parameters:
- id: token
type: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
description: <p>Recovery token returned from DetectMappingDifferences(ShardLocation, string). </p>
return:
type: 6110eba5com.microsoft.azure.elasticdb.shard.base._shard_rangeb33c76fccom.microsoft.azure.elasticdb.shard.recovery._mapping_locationa08ddfce
description: <p>The set of ranges and their corresponding <xref uid="com.microsoft.azure.elasticdb.shard.recovery._mapping_location" data-throw-if-not-resolved="false">MappingLocation</xref>. This method assumes a previous call to DetectMappingDifferences(ShardLocation, string) that provides the recovery token parameter. The result of this method is typically used in subsequent calls to resolve inconsistencies such as ResolveMappingDifferences or RebuildMappingsOnShard. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardInfo(RecoveryToken,ReferenceObjectHelper<ShardMapType>,ReferenceObjectHelper<String>)
id: getShardInfo(RecoveryToken,ReferenceObjectHelper<ShardMapType>,ReferenceObjectHelper<String>)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: getShardInfo(RecoveryToken token, ReferenceObjectHelper<ShardMapType> mapType, ReferenceObjectHelper<String> shardMapName)
nameWithType: RecoveryManager.getShardInfo(RecoveryToken token, ReferenceObjectHelper<ShardMapType> mapType, ReferenceObjectHelper<String> shardMapName)
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.getShardInfo(RecoveryToken token, ReferenceObjectHelper<ShardMapType> mapType, ReferenceObjectHelper<String> shardMapName)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardInfo*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 287
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Retrieves shard map type and name based on the token returned from DetectMappingDifferences(ShardLocation, string).</p>
<p></p>
syntax:
content: public void getShardInfo(RecoveryToken token, ReferenceObjectHelper<ShardMapType> mapType, ReferenceObjectHelper<String> shardMapName)
parameters:
- id: token
type: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
description: <p>Recovery token returned from DetectMappingDifferences(ShardLocation, string). </p>
- id: mapType
type: 2695f77dcom.microsoft.azure.elasticdb.shard.map._shard_map_typea08ddfce
description: <p>Output ShardMap type (Range or List). </p>
- id: shardMapName
type: 4f397241
description: <p>Output name of shard map. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardInfo(RecoveryToken,ReferenceObjectHelper<ShardMapType>,ReferenceObjectHelper<String>,ReferenceObjectHelper<ShardLocation>)
id: getShardInfo(RecoveryToken,ReferenceObjectHelper<ShardMapType>,ReferenceObjectHelper<String>,ReferenceObjectHelper<ShardLocation>)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: getShardInfo(RecoveryToken token, ReferenceObjectHelper<ShardMapType> mapType, ReferenceObjectHelper<String> shardMapName, ReferenceObjectHelper<ShardLocation> shardLocation)
nameWithType: RecoveryManager.getShardInfo(RecoveryToken token, ReferenceObjectHelper<ShardMapType> mapType, ReferenceObjectHelper<String> shardMapName, ReferenceObjectHelper<ShardLocation> shardLocation)
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.getShardInfo(RecoveryToken token, ReferenceObjectHelper<ShardMapType> mapType, ReferenceObjectHelper<String> shardMapName, ReferenceObjectHelper<ShardLocation> shardLocation)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardInfo*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 249
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Retrieves shard map type, name and shard location based on the token returned from DetectMappingDifferences(ShardLocation, string).</p>
<p></p>
syntax:
content: public void getShardInfo(RecoveryToken token, ReferenceObjectHelper<ShardMapType> mapType, ReferenceObjectHelper<String> shardMapName, ReferenceObjectHelper<ShardLocation> shardLocation)
parameters:
- id: token
type: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
description: <p>Recovery token returned from DetectMappingDifferences(ShardLocation, string). </p>
- id: mapType
type: 2695f77dcom.microsoft.azure.elasticdb.shard.map._shard_map_typea08ddfce
description: <p>Outputs shard map type (Range or List). </p>
- id: shardMapName
type: 4f397241
description: <p>Outputs shard map name. </p>
- id: shardLocation
type: 2695f77dcom.microsoft.azure.elasticdb.shard.base._shard_locationa08ddfce
description: <p>Outputs shard location </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardLocation(RecoveryToken)
id: getShardLocation(RecoveryToken)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: getShardLocation(RecoveryToken token)
nameWithType: RecoveryManager.getShardLocation(RecoveryToken token)
fullName: ShardLocation com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.getShardLocation(RecoveryToken token)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardLocation*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 360
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Returns the shard location of the local shard map processed by DetectMappingDifferences(ShardLocation, string).</p>
<p></p>
syntax:
content: public ShardLocation getShardLocation(RecoveryToken token)
parameters:
- id: token
type: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
description: <p>Recovery token returned from DetectMappingDifferences(ShardLocation, string) </p>
return:
type: com.microsoft.azure.elasticdb.shard.base._shard_location
description: <p>Location of the shard corresponding to the set of mapping differences detected in DetectMappingDifferences(ShardLocation, string). </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardMapName(RecoveryToken)
id: getShardMapName(RecoveryToken)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: getShardMapName(RecoveryToken token)
nameWithType: RecoveryManager.getShardMapName(RecoveryToken token)
fullName: String com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.getShardMapName(RecoveryToken token)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardMapName*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 336
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Returns the shard map name of the shard map processed by DetectMappingDifferences(ShardLocation, string).</p>
<p></p>
syntax:
content: public String getShardMapName(RecoveryToken token)
parameters:
- id: token
type: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
description: <p>Recovery token returned from DetectMappingDifferences(ShardLocation, string). </p>
return:
type: "26831127"
description: <p>The name of the shard map for the given recovery token. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardMapType(RecoveryToken)
id: getShardMapType(RecoveryToken)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: getShardMapType(RecoveryToken token)
nameWithType: RecoveryManager.getShardMapType(RecoveryToken token)
fullName: ShardMapType com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.getShardMapType(RecoveryToken token)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardMapType*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 313
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Returns the shard map type of the shard map processed by DetectMappingDifferences(ShardLocation, string).</p>
<p></p>
syntax:
content: public ShardMapType getShardMapType(RecoveryToken token)
parameters:
- id: token
type: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
description: <p>Recovery token returned from DetectMappingDifferences(ShardLocation, string). </p>
return:
type: com.microsoft.azure.elasticdb.shard.map._shard_map_type
description: <p>The type of shard map (list, range, etc...) corresponding to the recovery token. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShard(RecoveryToken,List<ShardRange>)
id: rebuildMappingsOnShard(RecoveryToken,List<ShardRange>)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: rebuildMappingsOnShard(RecoveryToken token, List<ShardRange> ranges)
nameWithType: RecoveryManager.rebuildMappingsOnShard(RecoveryToken token, List<ShardRange> ranges)
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.rebuildMappingsOnShard(RecoveryToken token, List<ShardRange> ranges)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShard*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 460
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Rebuilds a local range shard map from a list of inconsistent shard ranges detected by DetectMappingDifferences(ShardLocation, string) and then accessed by GetMappingDifferences. The resulting local range shard map will always still be inconsistent with the global shard map in the shard map manager database. A subsequent call to ResolveMappingDifferences is necessary to bring the system back to a healthy state.</p>
<p></p>
syntax:
content: public void rebuildMappingsOnShard(RecoveryToken token, List<ShardRange> ranges)
parameters:
- id: token
type: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
description: <p>The recovery token from a previous call to DetectMappingDifferences </p>
- id: ranges
type: 5618da2dcom.microsoft.azure.elasticdb.shard.base._shard_rangea08ddfce
description: <p>The set of ranges to keep on the local shard when rebuilding the local shard map. Note that this method can cause unrecoverable data loss. Make sure you have taken backups or copies of your databases and only then proceed with great care. Only shard ranges with inconsistencies can be rebuilt using this method. All ranges with no inconsistencies between the local shard and the global shard map will be kept intact on the local shard and are not affected by this call. Subsequent changes to the non-conflicting mappings can be made later using the regular interfaces in the shard map manager. It is not necessary to use the recovery manager to change non-conflicting mappings. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShardMapManagerFromShards(List<ShardLocation>)
id: rebuildMappingsOnShardMapManagerFromShards(List<ShardLocation>)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: rebuildMappingsOnShardMapManagerFromShards(List<ShardLocation> shardLocations)
nameWithType: RecoveryManager.rebuildMappingsOnShardMapManagerFromShards(List<ShardLocation> shardLocations)
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.rebuildMappingsOnShardMapManagerFromShards(List<ShardLocation> shardLocations)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShardMapManagerFromShards*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 419
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Given a collection of shard locations, reconstructs the shard map manager based on mapping information stored in the individual shards. The specified shards need to be registered already in the global shard map. This method only rebuilds mappings. It does not rebuild shard membership within the global shard map. If the information in the individual shard maps is or becomes inconsistent, the behavior is undefined. No cross shard locks are taken, so if any shards become inconsistent during the execution of this method, the final state of the global shard map may be corrupt.</p>
<p></p>
syntax:
content: public void rebuildMappingsOnShardMapManagerFromShards(List<ShardLocation> shardLocations)
parameters:
- id: shardLocations
type: 5618da2dcom.microsoft.azure.elasticdb.shard.base._shard_locationa08ddfce
description: <p>Collection of shard locations. Note that this method can cause unrecoverable data loss. Make sure you have taken backups or copies of your databases and only then proceed with great care. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShardMapManagerFromShards(List<ShardLocation>,String)
id: rebuildMappingsOnShardMapManagerFromShards(List<ShardLocation>,String)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: rebuildMappingsOnShardMapManagerFromShards(List<ShardLocation> shardLocations, String shardMapName)
nameWithType: RecoveryManager.rebuildMappingsOnShardMapManagerFromShards(List<ShardLocation> shardLocations, String shardMapName)
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.rebuildMappingsOnShardMapManagerFromShards(List<ShardLocation> shardLocations, String shardMapName)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShardMapManagerFromShards*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 436
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Given a collection of shard locations, reconstructs the shard map manager based on mapping information stored in the individual shards. The specified shards need to be registered already in the global shard map. This method only rebuilds mappings. It does not rebuild shard membership within the global shard map. If the information in the individual shard maps is or becomes inconsistent, the behavior is undefined. No cross shard locks are taken, so if any shards become inconsistent during the execution of this method, the final state of the global shard map may be corrupt.</p>
<p></p>
syntax:
content: public void rebuildMappingsOnShardMapManagerFromShards(List<ShardLocation> shardLocations, String shardMapName)
parameters:
- id: shardLocations
type: 5618da2dcom.microsoft.azure.elasticdb.shard.base._shard_locationa08ddfce
description: <p>Collection of shard locations. </p>
- id: shardMapName
type: "26831127"
description: <p>Optional name of shard map. If omitted, will attempt to recover from all shard maps present on each shard. Note that this method can cause unrecoverable data loss. Make sure you have taken backups or copies of your databases and only then proceed with great care. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShardsFromShardMapManager(List<ShardLocation>)
id: rebuildMappingsOnShardsFromShardMapManager(List<ShardLocation>)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: rebuildMappingsOnShardsFromShardMapManager(List<ShardLocation> shardLocations)
nameWithType: RecoveryManager.rebuildMappingsOnShardsFromShardMapManager(List<ShardLocation> shardLocations)
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.rebuildMappingsOnShardsFromShardMapManager(List<ShardLocation> shardLocations)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShardsFromShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 385
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Given a collection of shard locations, reconstructs local shard maps based on the mapping information stored in the global shard map. The specified shards need to be registered already in the global shard map. This method only rebuilds mappings. It does not rebuild shard membership within the global shard map.</p>
<p></p>
syntax:
content: public void rebuildMappingsOnShardsFromShardMapManager(List<ShardLocation> shardLocations)
parameters:
- id: shardLocations
type: 5618da2dcom.microsoft.azure.elasticdb.shard.base._shard_locationa08ddfce
description: <p>Collection of shard locations. Note that this method can cause unrecoverable data loss. Make sure you have taken backups or copies of your databases and only then proceed with great care. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShardsFromShardMapManager(List<ShardLocation>,String)
id: rebuildMappingsOnShardsFromShardMapManager(List<ShardLocation>,String)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: rebuildMappingsOnShardsFromShardMapManager(List<ShardLocation> shardLocations, String shardMapName)
nameWithType: RecoveryManager.rebuildMappingsOnShardsFromShardMapManager(List<ShardLocation> shardLocations, String shardMapName)
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.rebuildMappingsOnShardsFromShardMapManager(List<ShardLocation> shardLocations, String shardMapName)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShardsFromShardMapManager*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 400
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Given a collection of shard locations, reconstructs local shard maps based on the mapping information stored in the global shard map. The specified shards need to be registered already in the global shard map. This method only rebuilds mappings. It does not rebuild shard membership within the global shard map.</p>
<p></p>
syntax:
content: public void rebuildMappingsOnShardsFromShardMapManager(List<ShardLocation> shardLocations, String shardMapName)
parameters:
- id: shardLocations
type: 5618da2dcom.microsoft.azure.elasticdb.shard.base._shard_locationa08ddfce
description: <p>Collection of shard locations. </p>
- id: shardMapName
type: "26831127"
description: <p>Optional parameter to filter by shard map name. If omitted, all shard maps will be rebuilt. Note that this method can cause unrecoverable data loss. Make sure you have taken backups or copies of your databases and only then proceed with great care. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.RecoveryManager(ShardMapManager)
id: RecoveryManager(ShardMapManager)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: RecoveryManager(ShardMapManager shardMapManager)
nameWithType: RecoveryManager.RecoveryManager(ShardMapManager shardMapManager)
fullName: com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.RecoveryManager(ShardMapManager shardMapManager)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.RecoveryManager*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 74
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Constructs an instance of the recovery manager for given shard map manager.</p>
<p></p>
syntax:
content: public RecoveryManager(ShardMapManager shardMapManager)
parameters:
- id: shardMapManager
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>Shard map manager being recovered. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.resolveMappingDifferences(RecoveryToken,MappingDifferenceResolution)
id: resolveMappingDifferences(RecoveryToken,MappingDifferenceResolution)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
langs:
- java
name: resolveMappingDifferences(RecoveryToken token, MappingDifferenceResolution resolution)
nameWithType: RecoveryManager.resolveMappingDifferences(RecoveryToken token, MappingDifferenceResolution resolution)
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.resolveMappingDifferences(RecoveryToken token, MappingDifferenceResolution resolution)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.resolveMappingDifferences*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryManager.java
startLine: 771
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Selects one of the shard maps (either local or global) as a source of truth and brings mappings on both shard maps in sync.</p>
<p></p>
syntax:
content: public void resolveMappingDifferences(RecoveryToken token, MappingDifferenceResolution resolution)
parameters:
- id: token
type: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
description: <p>Recovery token returned from DetectMappingDifferences(ShardLocation, string). </p>
- id: resolution
type: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution
description: <p>The resolution strategy to be used for resolution. Note that this method can cause unrecoverable data loss. Make sure you have taken backups or copies of your databases and only then proceed with great care. </p>
references:
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.RecoveryManager*
name: RecoveryManager
nameWithType: RecoveryManager.RecoveryManager
fullName: com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.RecoveryManager
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.attachShard*
name: attachShard
nameWithType: RecoveryManager.attachShard
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.attachShard
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.detachShard*
name: detachShard
nameWithType: RecoveryManager.detachShard
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.detachShard
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: 6110eba5com.microsoft.azure.elasticdb.shard.base._shard_rangeb33c76fccom.microsoft.azure.elasticdb.shard.recovery._mapping_locationa08ddfce
spec.java:
- name: Map<
fullName: Map<
- uid: com.microsoft.azure.elasticdb.shard.base._shard_range
name: ShardRange
fullName: com.microsoft.azure.elasticdb.shard.base.ShardRange
href: com.microsoft.azure.elasticdb.shard.base._shard_range.yml
- name: ', '
fullName: ', '
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
name: MappingLocation
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingLocation
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getMappingDifferences*
name: getMappingDifferences
nameWithType: RecoveryManager.getMappingDifferences
fullName: Map<ShardRange, MappingLocation> com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.getMappingDifferences
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: 2695f77dcom.microsoft.azure.elasticdb.shard.map._shard_map_typea08ddfce
spec.java:
- name: ReferenceObjectHelper<
fullName: ReferenceObjectHelper<
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_type
name: ShardMapType
fullName: com.microsoft.azure.elasticdb.shard.map.ShardMapType
href: com.microsoft.azure.elasticdb.shard.map._shard_map_type.yml
- name: '>'
fullName: '>'
- uid: 4f397241
spec.java:
- name: ReferenceObjectHelper<String>
fullName: ReferenceObjectHelper<String>
- uid: 2695f77dcom.microsoft.azure.elasticdb.shard.base._shard_locationa08ddfce
spec.java:
- name: ReferenceObjectHelper<
fullName: ReferenceObjectHelper<
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
name: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardInfo*
name: getShardInfo
nameWithType: RecoveryManager.getShardInfo
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.getShardInfo
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardMapType*
name: getShardMapType
nameWithType: RecoveryManager.getShardMapType
fullName: ShardMapType com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.getShardMapType
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardMapName*
name: getShardMapName
nameWithType: RecoveryManager.getShardMapName
fullName: String com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.getShardMapName
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.getShardLocation*
name: getShardLocation
nameWithType: RecoveryManager.getShardLocation
fullName: ShardLocation com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.getShardLocation
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: 5618da2dcom.microsoft.azure.elasticdb.shard.base._shard_locationa08ddfce
spec.java:
- name: List<
fullName: List<
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
name: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShardsFromShardMapManager*
name: rebuildMappingsOnShardsFromShardMapManager
nameWithType: RecoveryManager.rebuildMappingsOnShardsFromShardMapManager
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.rebuildMappingsOnShardsFromShardMapManager
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShardMapManagerFromShards*
name: rebuildMappingsOnShardMapManagerFromShards
nameWithType: RecoveryManager.rebuildMappingsOnShardMapManagerFromShards
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.rebuildMappingsOnShardMapManagerFromShards
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: 5618da2dcom.microsoft.azure.elasticdb.shard.base._shard_rangea08ddfce
spec.java:
- name: List<
fullName: List<
- uid: com.microsoft.azure.elasticdb.shard.base._shard_range
name: ShardRange
fullName: com.microsoft.azure.elasticdb.shard.base.ShardRange
href: com.microsoft.azure.elasticdb.shard.base._shard_range.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.rebuildMappingsOnShard*
name: rebuildMappingsOnShard
nameWithType: RecoveryManager.rebuildMappingsOnShard
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.rebuildMappingsOnShard
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: 5618da2dcom.microsoft.azure.elasticdb.shard.recovery._recovery_tokena08ddfce
spec.java:
- name: List<
fullName: List<
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
name: RecoveryToken
fullName: com.microsoft.azure.elasticdb.shard.recovery.RecoveryToken
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.detectMappingDifferences*
name: detectMappingDifferences
nameWithType: RecoveryManager.detectMappingDifferences
fullName: List<RecoveryToken> com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.detectMappingDifferences
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.resolveMappingDifferences*
name: resolveMappingDifferences
nameWithType: RecoveryManager.resolveMappingDifferences
fullName: void com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager.resolveMappingDifferences
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.yml
name: RecoveryToken
nameWithType: RecoveryToken
fullName: com.microsoft.azure.elasticdb.shard.recovery.RecoveryToken
type: Class
summary: <p>Recovery token generated and used by methods of the <xref uid="com.microsoft.azure.elasticdb.shard.recovery._recovery_manager" data-throw-if-not-resolved="false">RecoveryManager</xref> to perform conflict detection and resolution for shard maps. </p>
syntax:
content: public class RecoveryToken
- uid: com.microsoft.azure.elasticdb.shard.base._shard_range
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_range.yml
name: ShardRange
nameWithType: ShardRange
fullName: com.microsoft.azure.elasticdb.shard.base.ShardRange
type: Class
summary: <p>A range of shard keys between a low key and a high key. The low key is inclusive (part of the range) while the high key is exclusive (not part of the range). The <xref uid="com.microsoft.azure.elasticdb.shard.base._shard_range" data-throw-if-not-resolved="false">ShardRange</xref> class is immutable. </p>
syntax:
content: public class ShardRange
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.yml
name: MappingDifference
nameWithType: MappingDifference
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifference
type: Class
summary: <p>Class for mapping differences. </p>
syntax:
content: public class MappingDifference
- uid: com.microsoft.azure.elasticdb.shard.store._store_shard_map
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_shard_map.yml
name: StoreShardMap
nameWithType: StoreShardMap
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShardMap
type: Class
summary: <p>Store representation of a shard map. </p>
syntax:
content: public class StoreShardMap
- uid: com.microsoft.azure.elasticdb.shard.store._store_shard
parent: com.microsoft.azure.elasticdb.shard.store
href: com.microsoft.azure.elasticdb.shard.store._store_shard.yml
name: StoreShard
nameWithType: StoreShard
fullName: com.microsoft.azure.elasticdb.shard.store.StoreShard
type: Class
summary: <p>Storage representation of a single shard. </p>
syntax:
content: public class StoreShard
- uid: com.microsoft.azure.elasticdb.shard.base._shard_location
parent: com.microsoft.azure.elasticdb.shard.base
href: com.microsoft.azure.elasticdb.shard.base._shard_location.yml
name: ShardLocation
nameWithType: ShardLocation
fullName: com.microsoft.azure.elasticdb.shard.base.ShardLocation
type: Class
summary: <p>Represents the location of a shard in terms of its server name and database name. This is used to manage connections to the shard and to support other operations on shards. As opposed to a <xref uid="com.microsoft.azure.elasticdb.shard.base._shard" data-throw-if-not-resolved="false">Shard</xref>, a shard location is not registered with the shard map. </p>
syntax:
content: public class ShardLocation
- 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.recovery._mapping_location
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
name: MappingLocation
nameWithType: MappingLocation
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingLocation
type: Enum
summary: <p>Location where the different mappings exist. </p>
syntax:
content: public enum MappingLocation
- uid: com.microsoft.azure.elasticdb.shard.map._shard_map_type
parent: com.microsoft.azure.elasticdb.shard.map
href: com.microsoft.azure.elasticdb.shard.map._shard_map_type.yml
name: ShardMapType
nameWithType: ShardMapType
fullName: com.microsoft.azure.elasticdb.shard.map.ShardMapType
type: Enum
summary: <p>Type of shard map. </p>
syntax:
content: public enum ShardMapType
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.yml
name: MappingDifferenceResolution
nameWithType: MappingDifferenceResolution
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceResolution
type: Enum
summary: <p>Resolution strategy for resolving mapping differences. </p>
syntax:
content: public enum MappingDifferenceResolution

Просмотреть файл

@ -0,0 +1,217 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
id: _recovery_token
parent: com.microsoft.azure.elasticdb.shard.recovery
children:
- com.microsoft.azure.elasticdb.shard.recovery._recovery_token.equals(Object)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_token.equals(RecoveryToken)
- com.microsoft.azure.elasticdb.shard.recovery._recovery_token.hashCode()
- com.microsoft.azure.elasticdb.shard.recovery._recovery_token.RecoveryToken()
- com.microsoft.azure.elasticdb.shard.recovery._recovery_token.toString()
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.yml
langs:
- java
name: RecoveryToken
nameWithType: RecoveryToken
fullName: com.microsoft.azure.elasticdb.shard.recovery.RecoveryToken
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryToken.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/recovery/RecoveryToken.java
startLine: 15
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Recovery token generated and used by methods of the <xref uid="com.microsoft.azure.elasticdb.shard.recovery._recovery_manager" data-throw-if-not-resolved="false">RecoveryManager</xref> to perform conflict detection and resolution for shard maps. </p>
syntax: &o1
content: public class RecoveryToken
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.equals(Object)
id: equals(Object)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.yml
langs:
- java
name: equals(Object obj)
nameWithType: RecoveryToken.equals(Object obj)
fullName: boolean com.microsoft.azure.elasticdb.shard.recovery.RecoveryToken.equals(Object obj)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryToken.java
startLine: 65
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Determines whether the specified Object is equal to the current Object.</p>
<p></p>
syntax:
content: public boolean equals(Object obj)
parameters:
- id: obj
type: "79317049"
description: <p>The object to compare with the current object. </p>
return:
type: 4fc6e284
description: <p>True if the specified object is equal to the current object; otherwise, false. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.equals(RecoveryToken)
id: equals(RecoveryToken)
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.yml
langs:
- java
name: equals(RecoveryToken other)
nameWithType: RecoveryToken.equals(RecoveryToken other)
fullName: boolean com.microsoft.azure.elasticdb.shard.recovery.RecoveryToken.equals(RecoveryToken other)
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryToken.java
startLine: 79
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Performs equality comparison with another given <xref uid="com.microsoft.azure.elasticdb.shard.recovery._recovery_token" data-throw-if-not-resolved="false">RecoveryToken</xref>.</p>
<p></p>
syntax:
content: public boolean equals(RecoveryToken other)
parameters:
- id: other
type: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.recovery._recovery_token" data-throw-if-not-resolved="false">RecoveryToken</xref> to compare with. </p>
return:
type: 4fc6e284
description: <p>True if same locations, false otherwise. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.hashCode()
id: hashCode()
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.yml
langs:
- java
name: hashCode()
nameWithType: RecoveryToken.hashCode()
fullName: int com.microsoft.azure.elasticdb.shard.recovery.RecoveryToken.hashCode()
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.hashCode*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryToken.java
startLine: 53
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Calculates the hash code for this instance.</p>
<p></p>
syntax:
content: public int hashCode()
return:
type: f75371fa
description: <p>Hash code for the object. </p>
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.RecoveryToken()
id: RecoveryToken()
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.yml
langs:
- java
name: RecoveryToken()
nameWithType: RecoveryToken.RecoveryToken()
fullName: com.microsoft.azure.elasticdb.shard.recovery.RecoveryToken.RecoveryToken()
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.RecoveryToken*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryToken.java
startLine: 25
package: com.microsoft.azure.elasticdb.shard.recovery
summary: <p>Parameter less constructor to generate a new unique token for shard map conflict detection and resolution. </p>
syntax:
content: public RecoveryToken()
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.toString()
id: toString()
parent: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.yml
langs:
- java
name: toString()
nameWithType: RecoveryToken.toString()
fullName: String com.microsoft.azure.elasticdb.shard.recovery.RecoveryToken.toString()
overload: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.toString*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/RecoveryToken.java
startLine: 43
package: com.microsoft.azure.elasticdb.shard.recovery
summary: >-
<p>Converts the object to its string representation.</p>
<p></p>
syntax:
content: public String toString()
return:
type: "26831127"
description: <p>String representation of the object. </p>
references:
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.RecoveryToken*
name: RecoveryToken
nameWithType: RecoveryToken.RecoveryToken
fullName: com.microsoft.azure.elasticdb.shard.recovery.RecoveryToken.RecoveryToken
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.toString*
name: toString
nameWithType: RecoveryToken.toString
fullName: String com.microsoft.azure.elasticdb.shard.recovery.RecoveryToken.toString
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.hashCode*
name: hashCode
nameWithType: RecoveryToken.hashCode
fullName: int com.microsoft.azure.elasticdb.shard.recovery.RecoveryToken.hashCode
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: "79317049"
spec.java:
- name: Object
fullName: Object
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.equals*
name: equals
nameWithType: RecoveryToken.equals
fullName: boolean com.microsoft.azure.elasticdb.shard.recovery.RecoveryToken.equals
package: com.microsoft.azure.elasticdb.shard.recovery
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.yml
name: RecoveryToken
nameWithType: RecoveryToken
fullName: com.microsoft.azure.elasticdb.shard.recovery.RecoveryToken
type: Class
summary: <p>Recovery token generated and used by methods of the <xref uid="com.microsoft.azure.elasticdb.shard.recovery._recovery_manager" data-throw-if-not-resolved="false">RecoveryManager</xref> to perform conflict detection and resolution for shard maps. </p>
syntax: *o1
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
name: RecoveryManager
nameWithType: RecoveryManager
fullName: com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager
type: Class
summary: <p>Manages various recovery related tasks for a shard map manager. It helps resolving data corruption issues between shard map information stored locally on the shards and in the global shard map manager database. It also helps with certain 'oops' recovery scenarios where reconstruction of shard maps from database backups or database copies is necessary. Note that some of the recovery methods can cause unrecoverable data loss when not used properly. It is recommend to take backups or copies of all databases that participate in recovery operations. </p>
syntax:
content: public class RecoveryManager

Просмотреть файл

@ -0,0 +1,109 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.recovery
id: recovery
children:
- com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
- com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution
- com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
- com.microsoft.azure.elasticdb.shard.recovery._mapping_location
- com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
- com.microsoft.azure.elasticdb.shard.recovery._recovery_token
href: com.microsoft.azure.elasticdb.shard.recovery.yml
langs:
- java
name: com.microsoft.azure.elasticdb.shard.recovery
nameWithType: com.microsoft.azure.elasticdb.shard.recovery
fullName: com.microsoft.azure.elasticdb.shard.recovery
type: Namespace
source:
remote:
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/recovery/MappingComparisonResult.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/recovery/MappingComparisonResult.java
syntax:
content: package com.microsoft.azure.elasticdb.shard.recovery
references:
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_result.yml
name: MappingComparisonResult
nameWithType: MappingComparisonResult
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonResult
type: Class
summary: <p>Result of comparison b/w the given range mappings. </p>
syntax:
content: public class MappingComparisonResult
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_comparison_utils.yml
name: MappingComparisonUtils
nameWithType: MappingComparisonUtils
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingComparisonUtils
type: Class
summary: <p>contains utility methods for performing comparisons among collections of mappings of either list or range shard maps. </p>
syntax:
content: public class MappingComparisonUtils
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference.yml
name: MappingDifference
nameWithType: MappingDifference
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifference
type: Class
summary: <p>Class for mapping differences. </p>
syntax:
content: public class MappingDifference
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_resolution.yml
name: MappingDifferenceResolution
nameWithType: MappingDifferenceResolution
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceResolution
type: Enum
summary: <p>Resolution strategy for resolving mapping differences. </p>
syntax:
content: public enum MappingDifferenceResolution
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_difference_type.yml
name: MappingDifferenceType
nameWithType: MappingDifferenceType
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingDifferenceType
type: Enum
summary: <p>Type of mapping difference. Useful for down casting. </p>
syntax:
content: public enum MappingDifferenceType
- uid: com.microsoft.azure.elasticdb.shard.recovery._mapping_location
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._mapping_location.yml
name: MappingLocation
nameWithType: MappingLocation
fullName: com.microsoft.azure.elasticdb.shard.recovery.MappingLocation
type: Enum
summary: <p>Location where the different mappings exist. </p>
syntax:
content: public enum MappingLocation
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_manager.yml
name: RecoveryManager
nameWithType: RecoveryManager
fullName: com.microsoft.azure.elasticdb.shard.recovery.RecoveryManager
type: Class
summary: <p>Manages various recovery related tasks for a shard map manager. It helps resolving data corruption issues between shard map information stored locally on the shards and in the global shard map manager database. It also helps with certain 'oops' recovery scenarios where reconstruction of shard maps from database backups or database copies is necessary. Note that some of the recovery methods can cause unrecoverable data loss when not used properly. It is recommend to take backups or copies of all databases that participate in recovery operations. </p>
syntax:
content: public class RecoveryManager
- uid: com.microsoft.azure.elasticdb.shard.recovery._recovery_token
parent: com.microsoft.azure.elasticdb.shard.recovery
href: com.microsoft.azure.elasticdb.shard.recovery._recovery_token.yml
name: RecoveryToken
nameWithType: RecoveryToken
fullName: com.microsoft.azure.elasticdb.shard.recovery.RecoveryToken
type: Class
summary: <p>Recovery token generated and used by methods of the <xref uid="com.microsoft.azure.elasticdb.shard.recovery._recovery_manager" data-throw-if-not-resolved="false">RecoveryManager</xref> to perform conflict detection and resolution for shard maps. </p>
syntax:
content: public class RecoveryToken

Просмотреть файл

@ -0,0 +1,265 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.schema._reference_table_info
id: _reference_table_info
parent: com.microsoft.azure.elasticdb.shard.schema
children:
- com.microsoft.azure.elasticdb.shard.schema._reference_table_info.equals(Object)
- com.microsoft.azure.elasticdb.shard.schema._reference_table_info.hashCode()
- com.microsoft.azure.elasticdb.shard.schema._reference_table_info.ReferenceTableInfo()
- com.microsoft.azure.elasticdb.shard.schema._reference_table_info.ReferenceTableInfo(String,String)
- com.microsoft.azure.elasticdb.shard.schema._reference_table_info.ReferenceTableInfo(String)
href: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.yml
langs:
- java
name: ReferenceTableInfo
nameWithType: ReferenceTableInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.ReferenceTableInfo
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/ReferenceTableInfo.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/schema/ReferenceTableInfo.java
startLine: 22
package: com.microsoft.azure.elasticdb.shard.schema
summary: <p>Represents information about a single reference table. </p>
syntax: &o1
content: public class ReferenceTableInfo extends TableInfo
inheritance:
- java.lang.Object
- com.microsoft.azure.elasticdb.shard.schema._table_info
inheritedMembers:
- com.microsoft.azure.elasticdb.shard.schema._table_info.getSchemaName()
- com.microsoft.azure.elasticdb.shard.schema._table_info.getTableName()
- com.microsoft.azure.elasticdb.shard.schema._table_info.setSchemaName(String)
- com.microsoft.azure.elasticdb.shard.schema._table_info.setTableName(String)
- uid: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.equals(Object)
id: equals(Object)
parent: com.microsoft.azure.elasticdb.shard.schema._reference_table_info
href: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.yml
langs:
- java
name: equals(Object obj)
nameWithType: ReferenceTableInfo.equals(Object obj)
fullName: boolean com.microsoft.azure.elasticdb.shard.schema.ReferenceTableInfo.equals(Object obj)
overload: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/ReferenceTableInfo.java
startLine: 65
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Overrides the Equals() method of Object class. Determines whether the specified object is equal to the current object.</p>
<p></p>
syntax:
content: public boolean equals(Object obj)
parameters:
- id: obj
type: "79317049"
description: <p>The object to compare with the current <xref uid="com.microsoft.azure.elasticdb.shard.schema._reference_table_info" data-throw-if-not-resolved="false">ReferenceTableInfo</xref> object. </p>
return:
type: 4fc6e284
description: <p>true if the specified object is equal to the current <xref uid="com.microsoft.azure.elasticdb.shard.schema._reference_table_info" data-throw-if-not-resolved="false">ReferenceTableInfo</xref> object; otherwise, false. </p>
- uid: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.hashCode()
id: hashCode()
parent: com.microsoft.azure.elasticdb.shard.schema._reference_table_info
href: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.yml
langs:
- java
name: hashCode()
nameWithType: ReferenceTableInfo.hashCode()
fullName: int com.microsoft.azure.elasticdb.shard.schema.ReferenceTableInfo.hashCode()
overload: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.hashCode*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/ReferenceTableInfo.java
startLine: 77
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Calculates the hash code for this instance.</p>
<p></p>
syntax:
content: public int hashCode()
return:
type: f75371fa
description: <p>Hash code for the object. </p>
- uid: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.ReferenceTableInfo()
id: ReferenceTableInfo()
parent: com.microsoft.azure.elasticdb.shard.schema._reference_table_info
href: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.yml
langs:
- java
name: ReferenceTableInfo()
nameWithType: ReferenceTableInfo.ReferenceTableInfo()
fullName: com.microsoft.azure.elasticdb.shard.schema.ReferenceTableInfo.ReferenceTableInfo()
overload: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.ReferenceTableInfo*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/ReferenceTableInfo.java
startLine: 24
package: com.microsoft.azure.elasticdb.shard.schema
syntax:
content: public ReferenceTableInfo()
- uid: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.ReferenceTableInfo(String,String)
id: ReferenceTableInfo(String,String)
parent: com.microsoft.azure.elasticdb.shard.schema._reference_table_info
href: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.yml
langs:
- java
name: ReferenceTableInfo(String schemaName, String tableName)
nameWithType: ReferenceTableInfo.ReferenceTableInfo(String schemaName, String tableName)
fullName: com.microsoft.azure.elasticdb.shard.schema.ReferenceTableInfo.ReferenceTableInfo(String schemaName, String tableName)
overload: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.ReferenceTableInfo*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/ReferenceTableInfo.java
startLine: 48
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.shard.schema._reference_table_info" data-throw-if-not-resolved="false">ReferenceTableInfo</xref> class.</p>
<p></p>
syntax:
content: public ReferenceTableInfo(String schemaName, String tableName)
parameters:
- id: schemaName
type: "26831127"
description: <p>Schema name of the reference table. </p>
- id: tableName
type: "26831127"
description: <p>Reference table name. </p>
- uid: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.ReferenceTableInfo(String)
id: ReferenceTableInfo(String)
parent: com.microsoft.azure.elasticdb.shard.schema._reference_table_info
href: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.yml
langs:
- java
name: ReferenceTableInfo(String tableName)
nameWithType: ReferenceTableInfo.ReferenceTableInfo(String tableName)
fullName: com.microsoft.azure.elasticdb.shard.schema.ReferenceTableInfo.ReferenceTableInfo(String tableName)
overload: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.ReferenceTableInfo*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/ReferenceTableInfo.java
startLine: 33
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.shard.schema._reference_table_info" data-throw-if-not-resolved="false">ReferenceTableInfo</xref> class.</p>
<p></p>
syntax:
content: public ReferenceTableInfo(String tableName)
parameters:
- id: tableName
type: "26831127"
description: <p>Reference table name. </p>
references:
- uid: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.ReferenceTableInfo*
name: ReferenceTableInfo
nameWithType: ReferenceTableInfo.ReferenceTableInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.ReferenceTableInfo.ReferenceTableInfo
package: com.microsoft.azure.elasticdb.shard.schema
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: "79317049"
spec.java:
- name: Object
fullName: Object
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.equals*
name: equals
nameWithType: ReferenceTableInfo.equals
fullName: boolean com.microsoft.azure.elasticdb.shard.schema.ReferenceTableInfo.equals
package: com.microsoft.azure.elasticdb.shard.schema
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.hashCode*
name: hashCode
nameWithType: ReferenceTableInfo.hashCode
fullName: int com.microsoft.azure.elasticdb.shard.schema.ReferenceTableInfo.hashCode
package: com.microsoft.azure.elasticdb.shard.schema
- uid: com.microsoft.azure.elasticdb.shard.schema._table_info.getSchemaName()
parent: com.microsoft.azure.elasticdb.shard.schema._table_info
href: com.microsoft.azure.elasticdb.shard.schema._table_info.yml
name: getSchemaName()
nameWithType: TableInfo.getSchemaName()
fullName: final String com.microsoft.azure.elasticdb.shard.schema.TableInfo.getSchemaName()
type: Method
syntax:
content: public final String getSchemaName()
return:
type: 3d93591e
- uid: com.microsoft.azure.elasticdb.shard.schema._table_info.getTableName()
parent: com.microsoft.azure.elasticdb.shard.schema._table_info
href: com.microsoft.azure.elasticdb.shard.schema._table_info.yml
name: getTableName()
nameWithType: TableInfo.getTableName()
fullName: final String com.microsoft.azure.elasticdb.shard.schema.TableInfo.getTableName()
type: Method
syntax:
content: public final String getTableName()
return:
type: 3d93591e
- uid: com.microsoft.azure.elasticdb.shard.schema._table_info.setSchemaName(String)
parent: com.microsoft.azure.elasticdb.shard.schema._table_info
href: com.microsoft.azure.elasticdb.shard.schema._table_info.yml
name: setSchemaName(String value)
nameWithType: TableInfo.setSchemaName(String value)
fullName: final void com.microsoft.azure.elasticdb.shard.schema.TableInfo.setSchemaName(String value)
type: Method
syntax:
content: protected final void setSchemaName(String value)
parameters:
- id: value
type: "26831127"
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.schema._table_info.setTableName(String)
parent: com.microsoft.azure.elasticdb.shard.schema._table_info
href: com.microsoft.azure.elasticdb.shard.schema._table_info.yml
name: setTableName(String value)
nameWithType: TableInfo.setTableName(String value)
fullName: final void com.microsoft.azure.elasticdb.shard.schema.TableInfo.setTableName(String value)
type: Method
syntax:
content: protected final void setTableName(String value)
parameters:
- id: value
type: "26831127"
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.schema._table_info
parent: com.microsoft.azure.elasticdb.shard.schema
href: com.microsoft.azure.elasticdb.shard.schema._table_info.yml
name: TableInfo
nameWithType: TableInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.TableInfo
type: Class
summary: <p>Repesents a table in a database. </p>
syntax:
content: public class TableInfo
- uid: com.microsoft.azure.elasticdb.shard.schema._reference_table_info
parent: com.microsoft.azure.elasticdb.shard.schema
href: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.yml
name: ReferenceTableInfo
nameWithType: ReferenceTableInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.ReferenceTableInfo
type: Class
summary: <p>Represents information about a single reference table. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,404 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info
id: _schema_info
parent: com.microsoft.azure.elasticdb.shard.schema
children:
- com.microsoft.azure.elasticdb.shard.schema._schema_info.add(ReferenceTableInfo)
- com.microsoft.azure.elasticdb.shard.schema._schema_info.add(ShardedTableInfo)
- com.microsoft.azure.elasticdb.shard.schema._schema_info.afterUnmarshal(Unmarshaller,Object)
- com.microsoft.azure.elasticdb.shard.schema._schema_info.equals(Object)
- com.microsoft.azure.elasticdb.shard.schema._schema_info.getReferenceTables()
- com.microsoft.azure.elasticdb.shard.schema._schema_info.getShardedTables()
- com.microsoft.azure.elasticdb.shard.schema._schema_info.remove(ReferenceTableInfo)
- com.microsoft.azure.elasticdb.shard.schema._schema_info.remove(ShardedTableInfo)
- com.microsoft.azure.elasticdb.shard.schema._schema_info.SchemaInfo()
- com.microsoft.azure.elasticdb.shard.schema._schema_info.SchemaInfo(ResultSet,int)
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
langs:
- java
name: SchemaInfo
nameWithType: SchemaInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfo
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfo.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/schema/SchemaInfo.java
startLine: 38
package: com.microsoft.azure.elasticdb.shard.schema
summary: <p>Represents information identifying the list of sharded tables and the list of reference tables associated with a sharding scheme. Reference tables are replicated across shards. This class is thread safe. </p>
syntax: &o1
content: public class SchemaInfo
inheritance:
- java.lang.Object
- Serializable
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.add(ReferenceTableInfo)
id: add(ReferenceTableInfo)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
langs:
- java
name: add(ReferenceTableInfo referenceTableInfo)
nameWithType: SchemaInfo.add(ReferenceTableInfo referenceTableInfo)
fullName: final void com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.add(ReferenceTableInfo referenceTableInfo)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info.add*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfo.java
startLine: 191
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Adds information about a reference table.</p>
<p></p>
syntax:
content: public final void add(ReferenceTableInfo referenceTableInfo)
parameters:
- id: referenceTableInfo
type: com.microsoft.azure.elasticdb.shard.schema._reference_table_info
description: <p>Reference table info. </p>
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.add(ShardedTableInfo)
id: add(ShardedTableInfo)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
langs:
- java
name: add(ShardedTableInfo shardedTableInfo)
nameWithType: SchemaInfo.add(ShardedTableInfo shardedTableInfo)
fullName: final void com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.add(ShardedTableInfo shardedTableInfo)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info.add*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfo.java
startLine: 153
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Adds information about a sharded table.</p>
<p></p>
syntax:
content: public final void add(ShardedTableInfo shardedTableInfo)
parameters:
- id: shardedTableInfo
type: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info
description: <p>Sharded table info. </p>
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.afterUnmarshal(Unmarshaller,Object)
id: afterUnmarshal(Unmarshaller,Object)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
langs:
- java
name: afterUnmarshal(Unmarshaller unmarshaller, Object parent)
nameWithType: SchemaInfo.afterUnmarshal(Unmarshaller unmarshaller, Object parent)
fullName: void com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.afterUnmarshal(Unmarshaller unmarshaller, Object parent)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info.afterUnmarshal*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfo.java
startLine: 122
package: com.microsoft.azure.elasticdb.shard.schema
summary: <p>Initialize any non-DataMember objects post deserialization. </p>
syntax:
content: public void afterUnmarshal(Unmarshaller unmarshaller, Object parent)
parameters:
- id: unmarshaller
type: 2e1dabbe
- id: parent
type: "79317049"
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.equals(Object)
id: equals(Object)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
langs:
- java
name: equals(Object o)
nameWithType: SchemaInfo.equals(Object o)
fullName: boolean com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.equals(Object o)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfo.java
startLine: 272
package: com.microsoft.azure.elasticdb.shard.schema
syntax:
content: public boolean equals(Object o)
parameters:
- id: o
type: "79317049"
return:
type: 4fc6e284
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.getReferenceTables()
id: getReferenceTables()
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
langs:
- java
name: getReferenceTables()
nameWithType: SchemaInfo.getReferenceTables()
fullName: final HashSet<ReferenceTableInfo> com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.getReferenceTables()
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info.getReferenceTables*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfo.java
startLine: 115
package: com.microsoft.azure.elasticdb.shard.schema
summary: <p>Read-only list of information concerning all reference tables. </p>
syntax:
content: public final HashSet<ReferenceTableInfo> getReferenceTables()
return:
type: 55028a32com.microsoft.azure.elasticdb.shard.schema._reference_table_infoa08ddfce
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.getShardedTables()
id: getShardedTables()
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
langs:
- java
name: getShardedTables()
nameWithType: SchemaInfo.getShardedTables()
fullName: final HashSet<ShardedTableInfo> com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.getShardedTables()
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info.getShardedTables*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfo.java
startLine: 108
package: com.microsoft.azure.elasticdb.shard.schema
summary: <p>Read-only list of information concerning all sharded tables. </p>
syntax:
content: public final HashSet<ShardedTableInfo> getShardedTables()
return:
type: 55028a32com.microsoft.azure.elasticdb.shard.schema._sharded_table_infoa08ddfce
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.remove(ReferenceTableInfo)
id: remove(ReferenceTableInfo)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
langs:
- java
name: remove(ReferenceTableInfo referenceTableInfo)
nameWithType: SchemaInfo.remove(ReferenceTableInfo referenceTableInfo)
fullName: final boolean com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.remove(ReferenceTableInfo referenceTableInfo)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info.remove*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfo.java
startLine: 239
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Removes information about a reference table.</p>
<p></p>
syntax:
content: public final boolean remove(ReferenceTableInfo referenceTableInfo)
parameters:
- id: referenceTableInfo
type: com.microsoft.azure.elasticdb.shard.schema._reference_table_info
description: <p>Reference table info. </p>
return:
type: 4dda0764
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.remove(ShardedTableInfo)
id: remove(ShardedTableInfo)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
langs:
- java
name: remove(ShardedTableInfo shardedTableInfo)
nameWithType: SchemaInfo.remove(ShardedTableInfo shardedTableInfo)
fullName: final boolean com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.remove(ShardedTableInfo shardedTableInfo)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info.remove*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfo.java
startLine: 229
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Removes information about a sharded table.</p>
<p></p>
syntax:
content: public final boolean remove(ShardedTableInfo shardedTableInfo)
parameters:
- id: shardedTableInfo
type: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info
description: <p>Sharded table info. </p>
return:
type: 4dda0764
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.SchemaInfo()
id: SchemaInfo()
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
langs:
- java
name: SchemaInfo()
nameWithType: SchemaInfo.SchemaInfo()
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.SchemaInfo()
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info.SchemaInfo*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfo.java
startLine: 77
package: com.microsoft.azure.elasticdb.shard.schema
summary: <p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> class. </p>
syntax:
content: public SchemaInfo()
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.SchemaInfo(ResultSet,int)
id: SchemaInfo(ResultSet,int)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
langs:
- java
name: SchemaInfo(ResultSet reader, int offset)
nameWithType: SchemaInfo.SchemaInfo(ResultSet reader, int offset)
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.SchemaInfo(ResultSet reader, int offset)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info.SchemaInfo*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfo.java
startLine: 84
package: com.microsoft.azure.elasticdb.shard.schema
summary: <p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> class. </p>
syntax:
content: public SchemaInfo(ResultSet reader, int offset)
parameters:
- id: reader
type: af343675
- id: offset
type: f75371fa
references:
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.SchemaInfo*
name: SchemaInfo
nameWithType: SchemaInfo.SchemaInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.SchemaInfo
package: com.microsoft.azure.elasticdb.shard.schema
- uid: af343675
spec.java:
- name: ResultSet
fullName: ResultSet
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: 55028a32com.microsoft.azure.elasticdb.shard.schema._sharded_table_infoa08ddfce
spec.java:
- name: final HashSet<
fullName: final HashSet<
- uid: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info
name: ShardedTableInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.ShardedTableInfo
href: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.getShardedTables*
name: getShardedTables
nameWithType: SchemaInfo.getShardedTables
fullName: final HashSet<ShardedTableInfo> com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.getShardedTables
package: com.microsoft.azure.elasticdb.shard.schema
- uid: 55028a32com.microsoft.azure.elasticdb.shard.schema._reference_table_infoa08ddfce
spec.java:
- name: final HashSet<
fullName: final HashSet<
- uid: com.microsoft.azure.elasticdb.shard.schema._reference_table_info
name: ReferenceTableInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.ReferenceTableInfo
href: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.getReferenceTables*
name: getReferenceTables
nameWithType: SchemaInfo.getReferenceTables
fullName: final HashSet<ReferenceTableInfo> com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.getReferenceTables
package: com.microsoft.azure.elasticdb.shard.schema
- uid: 2e1dabbe
spec.java:
- name: Unmarshaller
fullName: Unmarshaller
- uid: "79317049"
spec.java:
- name: Object
fullName: Object
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.afterUnmarshal*
name: afterUnmarshal
nameWithType: SchemaInfo.afterUnmarshal
fullName: void com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.afterUnmarshal
package: com.microsoft.azure.elasticdb.shard.schema
- uid: 3f6357ce
spec.java:
- name: final void
fullName: final void
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.add*
name: add
nameWithType: SchemaInfo.add
fullName: final void com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.add
package: com.microsoft.azure.elasticdb.shard.schema
- uid: 4dda0764
spec.java:
- name: final boolean
fullName: final boolean
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.remove*
name: remove
nameWithType: SchemaInfo.remove
fullName: final boolean com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.remove
package: com.microsoft.azure.elasticdb.shard.schema
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info.equals*
name: equals
nameWithType: SchemaInfo.equals
fullName: boolean com.microsoft.azure.elasticdb.shard.schema.SchemaInfo.equals
package: com.microsoft.azure.elasticdb.shard.schema
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info
parent: com.microsoft.azure.elasticdb.shard.schema
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
name: SchemaInfo
nameWithType: SchemaInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfo
type: Class
summary: <p>Represents information identifying the list of sharded tables and the list of reference tables associated with a sharding scheme. Reference tables are replicated across shards. This class is thread safe. </p>
syntax: *o1
- uid: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info
parent: com.microsoft.azure.elasticdb.shard.schema
href: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.yml
name: ShardedTableInfo
nameWithType: ShardedTableInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.ShardedTableInfo
type: Class
summary: <p>Represents information about a single sharded table. </p>
syntax:
content: public class ShardedTableInfo
- uid: com.microsoft.azure.elasticdb.shard.schema._reference_table_info
parent: com.microsoft.azure.elasticdb.shard.schema
href: com.microsoft.azure.elasticdb.shard.schema._reference_table_info.yml
name: ReferenceTableInfo
nameWithType: ReferenceTableInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.ReferenceTableInfo
type: Class
summary: <p>Represents information about a single reference table. </p>
syntax:
content: public class ReferenceTableInfo extends TableInfo
- uid: com.microsoft.azure.elasticdb.shard.schema._table_info
parent: com.microsoft.azure.elasticdb.shard.schema
href: com.microsoft.azure.elasticdb.shard.schema._table_info.yml
name: TableInfo
nameWithType: TableInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.TableInfo
type: Class
summary: <p>Repesents a table in a database. </p>
syntax:
content: public class TableInfo

Просмотреть файл

@ -0,0 +1,344 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection
id: _schema_info_collection
parent: com.microsoft.azure.elasticdb.shard.schema
children:
- com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.add(String,SchemaInfo)
- com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.get(String)
- com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.iterator()
- com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.remove(String)
- com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.replace(String,SchemaInfo)
- com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.SchemaInfoCollection(ShardMapManager)
- com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.tryGet(String,ReferenceObjectHelper<SchemaInfo>)
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.yml
langs:
- java
name: SchemaInfoCollection
nameWithType: SchemaInfoCollection
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoCollection.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/schema/SchemaInfoCollection.java
startLine: 29
package: com.microsoft.azure.elasticdb.shard.schema
summary: <p>Provides storage services to a client for storing or updating or retrieving schema information associated with a sharding scheme and assigning names to individual buckets of information. The class doesn't store the association between a sharding scheme and the metadata unit. It's the caller's responsibility to maintain the mapping. </p>
syntax: &o1
content: public class SchemaInfoCollection
inheritance:
- java.lang.Object
- java.util.ArrayList<Map.Entry<String, SchemaInfo>>
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.add(String,SchemaInfo)
id: add(String,SchemaInfo)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.yml
langs:
- java
name: add(String shardMapName, SchemaInfo schemaInfo)
nameWithType: SchemaInfoCollection.add(String shardMapName, SchemaInfo schemaInfo)
fullName: final void com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection.add(String shardMapName, SchemaInfo schemaInfo)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.add*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoCollection.java
startLine: 64
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Adds a <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> that is associated with the given ShardMap name. The associated data contains information concerning sharded tables and reference tables. If you try to add a <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> with an existing name, a name-conflict exception will be thrown</p>
<p></p>
syntax:
content: public final void add(String shardMapName, SchemaInfo schemaInfo)
parameters:
- id: shardMapName
type: "26831127"
description: <p>The name of the ShardMap that the <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> will be associated with </p>
- id: schemaInfo
type: com.microsoft.azure.elasticdb.shard.schema._schema_info
description: <p>Sharding schema information. </p>
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.get(String)
id: get(String)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.yml
langs:
- java
name: get(String shardMapName)
nameWithType: SchemaInfoCollection.get(String shardMapName)
fullName: final SchemaInfo com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection.get(String shardMapName)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.get*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoCollection.java
startLine: 146
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Fetches the <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> stored with the supplied ShardMap name.</p>
<p></p>
syntax:
content: public final SchemaInfo get(String shardMapName)
parameters:
- id: shardMapName
type: "26831127"
description: <p>The name of the ShardMap to get. </p>
return:
type: 93de0ef9com.microsoft.azure.elasticdb.shard.schema._schema_info
description: >-
<p>
<xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> object. </p>
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.iterator()
id: iterator()
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.yml
langs:
- java
name: iterator()
nameWithType: SchemaInfoCollection.iterator()
fullName: final Iterator<Map.Entry<String, SchemaInfo>> com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection.iterator()
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.iterator*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoCollection.java
startLine: 190
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Returns an enumerator that iterates through the <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info_collection" data-throw-if-not-resolved="false">SchemaInfoCollection</xref>.</p>
<p></p>
syntax:
content: public final Iterator<Map.Entry<String, SchemaInfo>> iterator()
return:
type: bbcb92afcom.microsoft.azure.elasticdb.shard.schema._schema_infoe7daa122
description: <p>Enumerator of key-value pairs of name and <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> objects. </p>
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.remove(String)
id: remove(String)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.yml
langs:
- java
name: remove(String shardMapName)
nameWithType: SchemaInfoCollection.remove(String shardMapName)
fullName: final void com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection.remove(String shardMapName)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.remove*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoCollection.java
startLine: 173
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Removes the <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> with the given ShardMap name.</p>
<p></p>
syntax:
content: public final void remove(String shardMapName)
parameters:
- id: shardMapName
type: "26831127"
description: <p>The name of the ShardMap whose <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> will be removed </p>
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.replace(String,SchemaInfo)
id: replace(String,SchemaInfo)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.yml
langs:
- java
name: replace(String shardMapName, SchemaInfo schemaInfo)
nameWithType: SchemaInfoCollection.replace(String shardMapName, SchemaInfo schemaInfo)
fullName: final void com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection.replace(String shardMapName, SchemaInfo schemaInfo)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.replace*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoCollection.java
startLine: 88
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Replaces the <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> with the given ShardMap name.</p>
<p></p>
syntax:
content: public final void replace(String shardMapName, SchemaInfo schemaInfo)
parameters:
- id: shardMapName
type: "26831127"
description: <p>The name of the ShardMap whose <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> will be replaced. </p>
- id: schemaInfo
type: com.microsoft.azure.elasticdb.shard.schema._schema_info
description: <p>Sharding schema information. </p>
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.SchemaInfoCollection(ShardMapManager)
id: SchemaInfoCollection(ShardMapManager)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.yml
langs:
- java
name: SchemaInfoCollection(ShardMapManager shardMapManager)
nameWithType: SchemaInfoCollection.SchemaInfoCollection(ShardMapManager shardMapManager)
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection.SchemaInfoCollection(ShardMapManager shardMapManager)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.SchemaInfoCollection*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoCollection.java
startLine: 42
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Constructs an instance of schema info collection.</p>
<p></p>
syntax:
content: public SchemaInfoCollection(ShardMapManager shardMapManager)
parameters:
- id: shardMapManager
type: com.microsoft.azure.elasticdb.shard.mapmanager._shard_map_manager
description: <p>Shard map manager object. </p>
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.tryGet(String,ReferenceObjectHelper<SchemaInfo>)
id: tryGet(String,ReferenceObjectHelper<SchemaInfo>)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.yml
langs:
- java
name: tryGet(String shardMapName, ReferenceObjectHelper<SchemaInfo> schemaInfo)
nameWithType: SchemaInfoCollection.tryGet(String shardMapName, ReferenceObjectHelper<SchemaInfo> schemaInfo)
fullName: final boolean com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection.tryGet(String shardMapName, ReferenceObjectHelper<SchemaInfo> schemaInfo)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.tryGet*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoCollection.java
startLine: 113
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Tries to fetch the <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> with the given ShardMap name without raising any exception if data doesn't exist.</p>
<p></p>
syntax:
content: public final boolean tryGet(String shardMapName, ReferenceObjectHelper<SchemaInfo> schemaInfo)
parameters:
- id: shardMapName
type: "26831127"
description: <p>The name of the ShardMap whose <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> will be fetched </p>
- id: schemaInfo
type: 2695f77dcom.microsoft.azure.elasticdb.shard.schema._schema_infoa08ddfce
description: <p>The <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> that was fetched or null if retrieval failed </p>
return:
type: 4dda0764
description: <p>true if schema info exists with given name, false otherwise. </p>
references:
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.SchemaInfoCollection*
name: SchemaInfoCollection
nameWithType: SchemaInfoCollection.SchemaInfoCollection
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection.SchemaInfoCollection
package: com.microsoft.azure.elasticdb.shard.schema
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: 3f6357ce
spec.java:
- name: final void
fullName: final void
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.add*
name: add
nameWithType: SchemaInfoCollection.add
fullName: final void com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection.add
package: com.microsoft.azure.elasticdb.shard.schema
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.replace*
name: replace
nameWithType: SchemaInfoCollection.replace
fullName: final void com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection.replace
package: com.microsoft.azure.elasticdb.shard.schema
- uid: 2695f77dcom.microsoft.azure.elasticdb.shard.schema._schema_infoa08ddfce
spec.java:
- name: ReferenceObjectHelper<
fullName: ReferenceObjectHelper<
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info
name: SchemaInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfo
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
- name: '>'
fullName: '>'
- uid: 4dda0764
spec.java:
- name: final boolean
fullName: final boolean
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.tryGet*
name: tryGet
nameWithType: SchemaInfoCollection.tryGet
fullName: final boolean com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection.tryGet
package: com.microsoft.azure.elasticdb.shard.schema
- uid: 93de0ef9com.microsoft.azure.elasticdb.shard.schema._schema_info
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info
name: SchemaInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfo
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.get*
name: get
nameWithType: SchemaInfoCollection.get
fullName: final SchemaInfo com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection.get
package: com.microsoft.azure.elasticdb.shard.schema
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.remove*
name: remove
nameWithType: SchemaInfoCollection.remove
fullName: final void com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection.remove
package: com.microsoft.azure.elasticdb.shard.schema
- uid: bbcb92afcom.microsoft.azure.elasticdb.shard.schema._schema_infoe7daa122
spec.java:
- name: 'final Iterator<Map.Entry<String, '
fullName: 'final Iterator<Map.Entry<String, '
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info
name: SchemaInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfo
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
- name: '>>'
fullName: '>>'
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.iterator*
name: iterator
nameWithType: SchemaInfoCollection.iterator
fullName: final Iterator<Map.Entry<String, SchemaInfo>> com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection.iterator
package: com.microsoft.azure.elasticdb.shard.schema
- 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.schema._schema_info
parent: com.microsoft.azure.elasticdb.shard.schema
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
name: SchemaInfo
nameWithType: SchemaInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfo
type: Class
summary: <p>Represents information identifying the list of sharded tables and the list of reference tables associated with a sharding scheme. Reference tables are replicated across shards. This class is thread safe. </p>
syntax:
content: public class SchemaInfo
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection
parent: com.microsoft.azure.elasticdb.shard.schema
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.yml
name: SchemaInfoCollection
nameWithType: SchemaInfoCollection
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection
type: Class
summary: <p>Provides storage services to a client for storing or updating or retrieving schema information associated with a sharding scheme and assigning names to individual buckets of information. The class doesn't store the association between a sharding scheme and the metadata unit. It's the caller's responsibility to maintain the mapping. </p>
syntax: *o1

Просмотреть файл

@ -0,0 +1,224 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code
id: _schema_info_error_code
parent: com.microsoft.azure.elasticdb.shard.schema
children:
- com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.forValue(int)
- com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.getValue()
- com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.SchemaInfoErrorCode(int)
- com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.SchemaInfoNameConflict
- com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.SchemaInfoNameDoesNotExist
- com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.SIZE
- com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.TableInfoAlreadyPresent
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.yml
langs:
- java
name: SchemaInfoErrorCode
nameWithType: SchemaInfoErrorCode
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoErrorCode
type: Enum
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoErrorCode.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/schema/SchemaInfoErrorCode.java
startLine: 13
package: com.microsoft.azure.elasticdb.shard.schema
summary: <p>Possible errors encountered by <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info_collection" data-throw-if-not-resolved="false">SchemaInfoCollection</xref>. </p>
syntax: &o1
content: public enum SchemaInfoErrorCode
inheritance:
- java.lang.Object
- java.lang.Enum<SchemaInfoErrorCode>
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.forValue(int)
id: forValue(int)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.yml
langs:
- java
name: forValue(int value)
nameWithType: SchemaInfoErrorCode.forValue(int value)
fullName: static SchemaInfoErrorCode com.microsoft.azure.elasticdb.shard.schema.SchemaInfoErrorCode.forValue(int value)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.forValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoErrorCode.java
startLine: 49
package: com.microsoft.azure.elasticdb.shard.schema
syntax:
content: public static SchemaInfoErrorCode forValue(int value)
parameters:
- id: value
type: f75371fa
return:
type: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.getValue()
id: getValue()
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.yml
langs:
- java
name: getValue()
nameWithType: SchemaInfoErrorCode.getValue()
fullName: int com.microsoft.azure.elasticdb.shard.schema.SchemaInfoErrorCode.getValue()
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.getValue*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoErrorCode.java
startLine: 53
package: com.microsoft.azure.elasticdb.shard.schema
syntax:
content: public int getValue()
return:
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.SchemaInfoErrorCode(int)
id: SchemaInfoErrorCode(int)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.yml
langs:
- java
name: SchemaInfoErrorCode(int value)
nameWithType: SchemaInfoErrorCode.SchemaInfoErrorCode(int value)
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoErrorCode.SchemaInfoErrorCode(int value)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.SchemaInfoErrorCode*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoErrorCode.java
startLine: 33
package: com.microsoft.azure.elasticdb.shard.schema
syntax:
content: public SchemaInfoErrorCode(int value)
parameters:
- id: value
type: f75371fa
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.SchemaInfoNameConflict
id: SchemaInfoNameConflict
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.yml
langs:
- java
name: SchemaInfoNameConflict
nameWithType: SchemaInfoErrorCode.SchemaInfoNameConflict
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoErrorCode.SchemaInfoNameConflict
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoErrorCode.java
startLine: 22
package: com.microsoft.azure.elasticdb.shard.schema
summary: <p>A <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> entry with the given name already exists. </p>
syntax:
content: public SchemaInfoNameConflict=(1)
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.SchemaInfoNameDoesNotExist
id: SchemaInfoNameDoesNotExist
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.yml
langs:
- java
name: SchemaInfoNameDoesNotExist
nameWithType: SchemaInfoErrorCode.SchemaInfoNameDoesNotExist
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoErrorCode.SchemaInfoNameDoesNotExist
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoErrorCode.java
startLine: 17
package: com.microsoft.azure.elasticdb.shard.schema
summary: <p>No <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> exists with the given name. </p>
syntax:
content: public SchemaInfoNameDoesNotExist=(0)
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.SIZE
id: SIZE
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.yml
langs:
- java
name: SIZE
nameWithType: SchemaInfoErrorCode.SIZE
fullName: " static final int com.microsoft.azure.elasticdb.shard.schema.SchemaInfoErrorCode.SIZE"
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoErrorCode.java
startLine: 29
package: com.microsoft.azure.elasticdb.shard.schema
syntax:
content: public static final int SIZE= java.lang.Integer.SIZE
return:
type: cd225469
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.TableInfoAlreadyPresent
id: TableInfoAlreadyPresent
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.yml
langs:
- java
name: TableInfoAlreadyPresent
nameWithType: SchemaInfoErrorCode.TableInfoAlreadyPresent
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoErrorCode.TableInfoAlreadyPresent
type: Field
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoErrorCode.java
startLine: 27
package: com.microsoft.azure.elasticdb.shard.schema
summary: <p>An entry for the given table already exists in the <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info" data-throw-if-not-resolved="false">SchemaInfo</xref> object. </p>
syntax:
content: public TableInfoAlreadyPresent=(2)
references:
- uid: cd225469
spec.java:
- name: final int
fullName: final int
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.SchemaInfoErrorCode*
name: SchemaInfoErrorCode
nameWithType: SchemaInfoErrorCode.SchemaInfoErrorCode
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoErrorCode.SchemaInfoErrorCode
package: com.microsoft.azure.elasticdb.shard.schema
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.getValue*
name: getValue
nameWithType: SchemaInfoErrorCode.getValue
fullName: int com.microsoft.azure.elasticdb.shard.schema.SchemaInfoErrorCode.getValue
package: com.microsoft.azure.elasticdb.shard.schema
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.forValue*
name: forValue
nameWithType: SchemaInfoErrorCode.forValue
fullName: static SchemaInfoErrorCode com.microsoft.azure.elasticdb.shard.schema.SchemaInfoErrorCode.forValue
package: com.microsoft.azure.elasticdb.shard.schema
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info
parent: com.microsoft.azure.elasticdb.shard.schema
href: com.microsoft.azure.elasticdb.shard.schema._schema_info.yml
name: SchemaInfo
nameWithType: SchemaInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfo
type: Class
summary: <p>Represents information identifying the list of sharded tables and the list of reference tables associated with a sharding scheme. Reference tables are replicated across shards. This class is thread safe. </p>
syntax:
content: public class SchemaInfo
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code
parent: com.microsoft.azure.elasticdb.shard.schema
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.yml
name: SchemaInfoErrorCode
nameWithType: SchemaInfoErrorCode
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoErrorCode
type: Enum
summary: <p>Possible errors encountered by <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info_collection" data-throw-if-not-resolved="false">SchemaInfoCollection</xref>. </p>
syntax: *o1
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection
parent: com.microsoft.azure.elasticdb.shard.schema
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_collection.yml
name: SchemaInfoCollection
nameWithType: SchemaInfoCollection
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoCollection
type: Class
summary: <p>Provides storage services to a client for storing or updating or retrieving schema information associated with a sharding scheme and assigning names to individual buckets of information. The class doesn't store the association between a sharding scheme and the metadata unit. It's the caller's responsibility to maintain the mapping. </p>
syntax:
content: public class SchemaInfoCollection

Просмотреть файл

@ -0,0 +1,254 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception
id: _schema_info_exception
parent: com.microsoft.azure.elasticdb.shard.schema
children:
- com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.getErrorCode()
- com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException()
- com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException(SchemaInfoErrorCode,String,Object...)
- com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException(SchemaInfoErrorCode,String,RuntimeException)
- com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException(String,Object...)
- com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException(String)
- com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException(String,RuntimeException)
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.yml
langs:
- java
name: SchemaInfoException
nameWithType: SchemaInfoException
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoException
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoException.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/schema/SchemaInfoException.java
startLine: 16
package: com.microsoft.azure.elasticdb.shard.schema
summary: <p>The exception that is thrown when an error occurs during operations related to schema info collection. </p>
syntax:
content: public class SchemaInfoException
inheritance:
- java.lang.Object
- RuntimeException
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.getErrorCode()
id: getErrorCode()
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.yml
langs:
- java
name: getErrorCode()
nameWithType: SchemaInfoException.getErrorCode()
fullName: SchemaInfoErrorCode com.microsoft.azure.elasticdb.shard.schema.SchemaInfoException.getErrorCode()
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.getErrorCode*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoException.java
startLine: 100
package: com.microsoft.azure.elasticdb.shard.schema
syntax:
content: public SchemaInfoErrorCode getErrorCode()
return:
type: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException()
id: SchemaInfoException()
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.yml
langs:
- java
name: SchemaInfoException()
nameWithType: SchemaInfoException.SchemaInfoException()
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoException.SchemaInfoException()
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoException.java
startLine: 26
package: com.microsoft.azure.elasticdb.shard.schema
summary: <p>Initializes a new instance. </p>
syntax:
content: public SchemaInfoException()
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException(SchemaInfoErrorCode,String,Object...)
id: )
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.yml
langs:
- java
name: SchemaInfoException(SchemaInfoErrorCode code, String format, Object... args)
nameWithType: SchemaInfoException.SchemaInfoException(SchemaInfoErrorCode code, String format, Object... args)
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoException.SchemaInfoException(SchemaInfoErrorCode code, String format, Object... args)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoException.java
startLine: 76
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Initializes a new instance with a specified formatted error message.</p>
<p></p>
syntax:
content: public SchemaInfoException(SchemaInfoErrorCode code, String format, Object... args)
parameters:
- id: code
type: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code
description: <p>Error code. </p>
- id: format
type: "26831127"
description: <p>The format message that describes the error </p>
- id: args
type: 1355eaf1
description: <p>The arguments to the format string </p>
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException(SchemaInfoErrorCode,String,RuntimeException)
id: SchemaInfoException(SchemaInfoErrorCode,String,RuntimeException)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.yml
langs:
- java
name: SchemaInfoException(SchemaInfoErrorCode code, String message, RuntimeException inner)
nameWithType: SchemaInfoException.SchemaInfoException(SchemaInfoErrorCode code, String message, RuntimeException inner)
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoException.SchemaInfoException(SchemaInfoErrorCode code, String message, RuntimeException inner)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoException.java
startLine: 93
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Initializes a new instance with a specified error message and a reference to the inner exception that is the cause of this exception.</p>
<p></p>
syntax:
content: public SchemaInfoException(SchemaInfoErrorCode code, String message, RuntimeException inner)
parameters:
- id: code
type: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code
description: <p>Error code. </p>
- id: message
type: "26831127"
description: <p>A message that describes the error </p>
- id: inner
type: 9b2a4515
description: <p>The exception that is the cause of the current exception </p>
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException(String,Object...)
id: )
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.yml
langs:
- java
name: SchemaInfoException(String format, Object... args)
nameWithType: SchemaInfoException.SchemaInfoException(String format, Object... args)
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoException.SchemaInfoException(String format, Object... args)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoException.java
startLine: 48
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Initializes a new instance with a specified formatted error message.</p>
<p></p>
syntax:
content: public SchemaInfoException(String format, Object... args)
parameters:
- id: format
type: "26831127"
description: <p>The format message that describes the error. </p>
- id: args
type: 1355eaf1
description: <p>The arguments to the format string. </p>
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException(String)
id: SchemaInfoException(String)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.yml
langs:
- java
name: SchemaInfoException(String message)
nameWithType: SchemaInfoException.SchemaInfoException(String message)
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoException.SchemaInfoException(String message)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoException.java
startLine: 36
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Initializes a new instance with a specified error message.</p>
<p></p>
syntax:
content: public SchemaInfoException(String message)
parameters:
- id: message
type: "26831127"
description: <p>Error message. </p>
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException(String,RuntimeException)
id: SchemaInfoException(String,RuntimeException)
parent: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.yml
langs:
- java
name: SchemaInfoException(String message, RuntimeException inner)
nameWithType: SchemaInfoException.SchemaInfoException(String message, RuntimeException inner)
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoException.SchemaInfoException(String message, RuntimeException inner)
overload: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/SchemaInfoException.java
startLine: 61
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Initializes a new instance with a specified error message and a reference to the inner exception that caused this exception.</p>
<p></p>
syntax:
content: public SchemaInfoException(String message, RuntimeException inner)
parameters:
- id: message
type: "26831127"
description: <p>A message that describes the error. </p>
- id: inner
type: 9b2a4515
description: <p>The exception that is the cause of the current exception. </p>
references:
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.SchemaInfoException*
name: SchemaInfoException
nameWithType: SchemaInfoException.SchemaInfoException
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoException.SchemaInfoException
package: com.microsoft.azure.elasticdb.shard.schema
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: 1355eaf1
spec.java:
- name: Object...
fullName: Object...
- uid: 9b2a4515
spec.java:
- name: RuntimeException
fullName: RuntimeException
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_exception.getErrorCode*
name: getErrorCode
nameWithType: SchemaInfoException.getErrorCode
fullName: SchemaInfoErrorCode com.microsoft.azure.elasticdb.shard.schema.SchemaInfoException.getErrorCode
package: com.microsoft.azure.elasticdb.shard.schema
- uid: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code
parent: com.microsoft.azure.elasticdb.shard.schema
href: com.microsoft.azure.elasticdb.shard.schema._schema_info_error_code.yml
name: SchemaInfoErrorCode
nameWithType: SchemaInfoErrorCode
fullName: com.microsoft.azure.elasticdb.shard.schema.SchemaInfoErrorCode
type: Enum
summary: <p>Possible errors encountered by <xref uid="com.microsoft.azure.elasticdb.shard.schema._schema_info_collection" data-throw-if-not-resolved="false">SchemaInfoCollection</xref>. </p>
syntax:
content: public enum SchemaInfoErrorCode

Просмотреть файл

@ -0,0 +1,335 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info
id: _sharded_table_info
parent: com.microsoft.azure.elasticdb.shard.schema
children:
- com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.equals(Object)
- com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.equals(ShardedTableInfo)
- com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.getKeyColumnName()
- com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.hashCode()
- com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.ShardedTableInfo()
- com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.ShardedTableInfo(String,String,String)
- com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.ShardedTableInfo(String,String)
href: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.yml
langs:
- java
name: ShardedTableInfo
nameWithType: ShardedTableInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.ShardedTableInfo
type: Class
source:
remote: &o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/ShardedTableInfo.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/schema/ShardedTableInfo.java
startLine: 22
package: com.microsoft.azure.elasticdb.shard.schema
summary: <p>Represents information about a single sharded table. </p>
syntax: &o1
content: public class ShardedTableInfo extends TableInfo
inheritance:
- java.lang.Object
- com.microsoft.azure.elasticdb.shard.schema._table_info
inheritedMembers:
- com.microsoft.azure.elasticdb.shard.schema._table_info.getSchemaName()
- com.microsoft.azure.elasticdb.shard.schema._table_info.getTableName()
- com.microsoft.azure.elasticdb.shard.schema._table_info.setSchemaName(String)
- com.microsoft.azure.elasticdb.shard.schema._table_info.setTableName(String)
- uid: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.equals(Object)
id: equals(Object)
parent: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info
href: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.yml
langs:
- java
name: equals(Object obj)
nameWithType: ShardedTableInfo.equals(Object obj)
fullName: boolean com.microsoft.azure.elasticdb.shard.schema.ShardedTableInfo.equals(Object obj)
overload: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/ShardedTableInfo.java
startLine: 102
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Overrides the Equals() method of Object class. Determines whether the specified object is equal to the current object.</p>
<p></p>
syntax:
content: public boolean equals(Object obj)
parameters:
- id: obj
type: "79317049"
description: <p>The object to compare with the current <xref uid="com.microsoft.azure.elasticdb.shard.schema._sharded_table_info" data-throw-if-not-resolved="false">ShardedTableInfo</xref> object. </p>
return:
type: 4fc6e284
description: <p>true if the specified object is equal to the current <xref uid="com.microsoft.azure.elasticdb.shard.schema._sharded_table_info" data-throw-if-not-resolved="false">ShardedTableInfo</xref> object; otherwise, false. </p>
- uid: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.equals(ShardedTableInfo)
id: equals(ShardedTableInfo)
parent: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info
href: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.yml
langs:
- java
name: equals(ShardedTableInfo other)
nameWithType: ShardedTableInfo.equals(ShardedTableInfo other)
fullName: final boolean com.microsoft.azure.elasticdb.shard.schema.ShardedTableInfo.equals(ShardedTableInfo other)
overload: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.equals*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/ShardedTableInfo.java
startLine: 88
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Determines whether the specified <xref uid="com.microsoft.azure.elasticdb.shard.schema._sharded_table_info" data-throw-if-not-resolved="false">ShardedTableInfo</xref> object is equal to the current object.</p>
<p></p>
syntax:
content: public final boolean equals(ShardedTableInfo other)
parameters:
- id: other
type: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info
description: <p>The <xref uid="com.microsoft.azure.elasticdb.shard.schema._sharded_table_info" data-throw-if-not-resolved="false">ShardedTableInfo</xref> object to compare with the current object. </p>
return:
type: 4dda0764
description: <p>true if the specified <xref uid="com.microsoft.azure.elasticdb.shard.schema._sharded_table_info" data-throw-if-not-resolved="false">ShardedTableInfo</xref> object is equal to the current object; otherwise, false. </p>
- uid: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.getKeyColumnName()
id: getKeyColumnName()
parent: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info
href: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.yml
langs:
- java
name: getKeyColumnName()
nameWithType: ShardedTableInfo.getKeyColumnName()
fullName: final String com.microsoft.azure.elasticdb.shard.schema.ShardedTableInfo.getKeyColumnName()
overload: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.getKeyColumnName*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/ShardedTableInfo.java
startLine: 73
package: com.microsoft.azure.elasticdb.shard.schema
syntax:
content: public final String getKeyColumnName()
return:
type: 3d93591e
- uid: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.hashCode()
id: hashCode()
parent: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info
href: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.yml
langs:
- java
name: hashCode()
nameWithType: ShardedTableInfo.hashCode()
fullName: int com.microsoft.azure.elasticdb.shard.schema.ShardedTableInfo.hashCode()
overload: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.hashCode*
type: Method
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/ShardedTableInfo.java
startLine: 113
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Calculates the hash code for this instance.</p>
<p></p>
syntax:
content: public int hashCode()
return:
type: f75371fa
description: <p>Hash code for the object. </p>
- uid: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.ShardedTableInfo()
id: ShardedTableInfo()
parent: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info
href: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.yml
langs:
- java
name: ShardedTableInfo()
nameWithType: ShardedTableInfo.ShardedTableInfo()
fullName: com.microsoft.azure.elasticdb.shard.schema.ShardedTableInfo.ShardedTableInfo()
overload: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.ShardedTableInfo*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/ShardedTableInfo.java
startLine: 70
package: com.microsoft.azure.elasticdb.shard.schema
syntax:
content: public ShardedTableInfo()
- uid: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.ShardedTableInfo(String,String,String)
id: ShardedTableInfo(String,String,String)
parent: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info
href: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.yml
langs:
- java
name: ShardedTableInfo(String schemaName, String tableName, String columnName)
nameWithType: ShardedTableInfo.ShardedTableInfo(String schemaName, String tableName, String columnName)
fullName: com.microsoft.azure.elasticdb.shard.schema.ShardedTableInfo.ShardedTableInfo(String schemaName, String tableName, String columnName)
overload: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.ShardedTableInfo*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/ShardedTableInfo.java
startLine: 58
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.shard.schema._sharded_table_info" data-throw-if-not-resolved="false">ShardedTableInfo</xref> class.</p>
<p></p>
syntax:
content: public ShardedTableInfo(String schemaName, String tableName, String columnName)
parameters:
- id: schemaName
type: "26831127"
description: <p>Schema name of the sharded table. </p>
- id: tableName
type: "26831127"
description: <p>Sharded table name. </p>
- id: columnName
type: "26831127"
description: <p>Shard key column name. </p>
- uid: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.ShardedTableInfo(String,String)
id: ShardedTableInfo(String,String)
parent: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info
href: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.yml
langs:
- java
name: ShardedTableInfo(String tableName, String columnName)
nameWithType: ShardedTableInfo.ShardedTableInfo(String tableName, String columnName)
fullName: com.microsoft.azure.elasticdb.shard.schema.ShardedTableInfo.ShardedTableInfo(String tableName, String columnName)
overload: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.ShardedTableInfo*
type: Constructor
source:
remote: *o0
path: elastic-db-tools/src/main/java/com/microsoft/azure/elasticdb/shard/schema/ShardedTableInfo.java
startLine: 38
package: com.microsoft.azure.elasticdb.shard.schema
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.shard.schema._sharded_table_info" data-throw-if-not-resolved="false">ShardedTableInfo</xref> class.</p>
<p></p>
syntax:
content: public ShardedTableInfo(String tableName, String columnName)
parameters:
- id: tableName
type: "26831127"
description: <p>Sharded table name. </p>
- id: columnName
type: "26831127"
description: <p>Shard key column name. </p>
references:
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.ShardedTableInfo*
name: ShardedTableInfo
nameWithType: ShardedTableInfo.ShardedTableInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.ShardedTableInfo.ShardedTableInfo
package: com.microsoft.azure.elasticdb.shard.schema
- uid: 3d93591e
spec.java:
- name: final String
fullName: final String
- uid: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.getKeyColumnName*
name: getKeyColumnName
nameWithType: ShardedTableInfo.getKeyColumnName
fullName: final String com.microsoft.azure.elasticdb.shard.schema.ShardedTableInfo.getKeyColumnName
package: com.microsoft.azure.elasticdb.shard.schema
- uid: 4dda0764
spec.java:
- name: final boolean
fullName: final boolean
- uid: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.equals*
name: equals
nameWithType: ShardedTableInfo.equals
fullName: final boolean com.microsoft.azure.elasticdb.shard.schema.ShardedTableInfo.equals
package: com.microsoft.azure.elasticdb.shard.schema
- uid: "79317049"
spec.java:
- name: Object
fullName: Object
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: f75371fa
spec.java:
- name: int
fullName: int
- uid: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.hashCode*
name: hashCode
nameWithType: ShardedTableInfo.hashCode
fullName: int com.microsoft.azure.elasticdb.shard.schema.ShardedTableInfo.hashCode
package: com.microsoft.azure.elasticdb.shard.schema
- uid: com.microsoft.azure.elasticdb.shard.schema._table_info.getSchemaName()
parent: com.microsoft.azure.elasticdb.shard.schema._table_info
href: com.microsoft.azure.elasticdb.shard.schema._table_info.yml
name: getSchemaName()
nameWithType: TableInfo.getSchemaName()
fullName: final String com.microsoft.azure.elasticdb.shard.schema.TableInfo.getSchemaName()
type: Method
syntax:
content: public final String getSchemaName()
return:
type: 3d93591e
- uid: com.microsoft.azure.elasticdb.shard.schema._table_info.getTableName()
parent: com.microsoft.azure.elasticdb.shard.schema._table_info
href: com.microsoft.azure.elasticdb.shard.schema._table_info.yml
name: getTableName()
nameWithType: TableInfo.getTableName()
fullName: final String com.microsoft.azure.elasticdb.shard.schema.TableInfo.getTableName()
type: Method
syntax:
content: public final String getTableName()
return:
type: 3d93591e
- uid: com.microsoft.azure.elasticdb.shard.schema._table_info.setSchemaName(String)
parent: com.microsoft.azure.elasticdb.shard.schema._table_info
href: com.microsoft.azure.elasticdb.shard.schema._table_info.yml
name: setSchemaName(String value)
nameWithType: TableInfo.setSchemaName(String value)
fullName: final void com.microsoft.azure.elasticdb.shard.schema.TableInfo.setSchemaName(String value)
type: Method
syntax:
content: protected final void setSchemaName(String value)
parameters:
- id: value
type: "26831127"
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.schema._table_info.setTableName(String)
parent: com.microsoft.azure.elasticdb.shard.schema._table_info
href: com.microsoft.azure.elasticdb.shard.schema._table_info.yml
name: setTableName(String value)
nameWithType: TableInfo.setTableName(String value)
fullName: final void com.microsoft.azure.elasticdb.shard.schema.TableInfo.setTableName(String value)
type: Method
syntax:
content: protected final void setTableName(String value)
parameters:
- id: value
type: "26831127"
return:
type: 3f6357ce
- uid: com.microsoft.azure.elasticdb.shard.schema._table_info
parent: com.microsoft.azure.elasticdb.shard.schema
href: com.microsoft.azure.elasticdb.shard.schema._table_info.yml
name: TableInfo
nameWithType: TableInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.TableInfo
type: Class
summary: <p>Repesents a table in a database. </p>
syntax:
content: public class TableInfo
- uid: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info
parent: com.microsoft.azure.elasticdb.shard.schema
href: com.microsoft.azure.elasticdb.shard.schema._sharded_table_info.yml
name: ShardedTableInfo
nameWithType: ShardedTableInfo
fullName: com.microsoft.azure.elasticdb.shard.schema.ShardedTableInfo
type: Class
summary: <p>Represents information about a single sharded table. </p>
syntax: *o1

Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше