com.microsoft.azure.documentdb.bulkexecutor

Class DocumentBulkExecutor.Builder

java.lang.Object

com.microsoft.azure.documentdb.bulkexecutor.DocumentBulkExecutor.Builder

Enclosing class:

DocumentBulkExecutor

public static class DocumentBulkExecutor.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
DocumentBulkExecutor	build() Instantiates DocumentBulkExecutor given the configured DocumentBulkExecutor.Builder.
DocumentBulkExecutor.Builder	from(com.microsoft.azure.documentdb.DocumentClient client, String databaseName, String collectionName, com.microsoft.azure.documentdb.PartitionKeyDefinition partitionKeyDef, int offerThroughput) Use the instance of DocumentClient to perform bulk operations in target DocumentCollection instance at specified allocated throughput.
DocumentBulkExecutor.Builder	withInitializationRetryOptions(com.microsoft.azure.documentdb.RetryOptions options) Use the given retry options to apply to DocumentClient used in initialization of DocumentBulkExecutor.
DocumentBulkExecutor.Builder	withMaxMiniBatchSize(int size) Use the given size to configure max mini-batch size (specific to bulk import API).
DocumentBulkExecutor.Builder	withMaxUpdateMiniBatchCount(int count) Use the given count to configure max update mini-batch count (specific to bulk update API).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public DocumentBulkExecutor.Builder from(com.microsoft.azure.documentdb.DocumentClient client,
                                         String databaseName,
                                         String collectionName,
                                         com.microsoft.azure.documentdb.PartitionKeyDefinition partitionKeyDef,
                                         int offerThroughput)

Use the instance of DocumentClient to perform bulk operations in target DocumentCollection instance at specified allocated throughput.

Parameters:

client - an instance of DocumentClient

partitionKeyDef - specifies the PartitionKeyDefinition of the collection

databaseName - name of the database

collectionName - name of the collection

offerThroughput - specifies the throughput allocated for bulk operations out of the collection's total throughput

Returns:

an instance of DocumentBulkExecutor.Builder

withMaxMiniBatchSize

public DocumentBulkExecutor.Builder withMaxMiniBatchSize(int size)

Use the given size to configure max mini-batch size (specific to bulk import API). If not specified will use the default value of 220200 bytes.

Parameters:

size - specifies the size of a mini-batch used in bulk import API.

Returns:

DocumentBulkExecutor.Builder

withMaxUpdateMiniBatchCount

public DocumentBulkExecutor.Builder withMaxUpdateMiniBatchCount(int count)

Use the given count to configure max update mini-batch count (specific to bulk update API). If not specified will use the default value of 500.

Parameters:

count - specifies the maximum count of update items in a mini-batch used in bulk import API.

Returns:

DocumentBulkExecutor.Builder

withInitializationRetryOptions

public DocumentBulkExecutor.Builder withInitializationRetryOptions(com.microsoft.azure.documentdb.RetryOptions options)

Use the given retry options to apply to DocumentClient used in initialization of DocumentBulkExecutor.

Parameters:

options - an instance of RetryOptions

Returns:

DocumentBulkExecutor.Builder

build

public DocumentBulkExecutor build()
                           throws Exception

Instantiates DocumentBulkExecutor given the configured DocumentBulkExecutor.Builder.

Returns:

the newly instantiated instance of DocumentBulkExecutor

Throws:

Exception - if there is any failure