Class CosmosDestination<TInput>

{{< /rawhtml >}} ```C# public class CosmosDestination : DataFlowBatchDestination, IDataFlowBatchDestination, IDataFlowDestination, IDataFlowBatchDestination, IDataFlowDestination, IDataFlowComponent, ILoggableTask ``` {{< rawhtml >}}

Type Parameters

Name	Description
TInput	Type of ingoing data.

Constructors

CosmosDestination()

Declaration

{{< /rawhtml >}} ```C# public CosmosDestination() ``` {{< rawhtml >}}

CosmosDestination(int)

Declaration

{{< /rawhtml >}} ```C# public CosmosDestination(int batchSize) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
int	batchSize

CosmosDestination(string, string, string)

Declaration

{{< /rawhtml >}} ```C# public CosmosDestination(string connectionString, string databaseName, string containerName) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
string	connectionString
string	databaseName
string	containerName

Properties

AccountEndpoint

Optional: An Azure Cosmos Db account endpoint used when opening the connection (works only in combination with AuthKeyOrResourceToken) ConnectionString, AzureKeyCredential and AzureTokenCredential have no effect then.

Declaration

{{< /rawhtml >}} ```C# public string AccountEndpoint { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
string

AuthKeyOrResourceToken

Optional: An Azure Authorization key or resource token which is used when opening the connection (works only in combination with AccountEndpoint) /// ConnectionString, AzureKeyCredential and AzureTokenCredential have no effect then.

Declaration

{{< /rawhtml >}} ```C# public string AuthKeyOrResourceToken { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
string

AzureKeyCredential

Optional: An Azure Key Credential used when opening the connection (works only in combination with ConnectionString)

Declaration

{{< /rawhtml >}} ```C# public AzureKeyCredential AzureKeyCredential { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
AzureKeyCredential

AzureTokenCredential

Optional: An Azure Token Credential used when opening the connection (works only in combination with ConnectionString)

Declaration

{{< /rawhtml >}} ```C# public TokenCredential AzureTokenCredential { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
TokenCredential

ConnectionString

The connection string which points to the Azure Cosmos Db. The connection string may contain all relevant connection information. Please also specify the DatabaseName and ContainerName. Optional: You can also provide either an AzureKeyCredential or AzureTokenCredential along with the connection string. Alternatively, you can use the AccountEndpoint and AuthKeyOrResourceToken to establish a connection.

Declaration

{{< /rawhtml >}} ```C# public string ConnectionString { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
string

ContainerName

The container name of the Azure Cosmos Db destination

Declaration

{{< /rawhtml >}} ```C# public string ContainerName { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
string

CosmosClient

Optional: Instead of providing the ConnectionString and/or other credentials, you can also create the CosmosClient manually in your code and assign it to this property. This client will then be used, and no new client won't be created. Please make sure bulk insert is allowed in the client.

Declaration

{{< /rawhtml >}} ```C# public CosmosClient CosmosClient { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
CosmosClient

DatabaseName

The database name of the Azure Cosmos Db destination

Declaration

{{< /rawhtml >}} ```C# public string DatabaseName { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
string

SetItemActionOptions

By default, all data is created/inserted into the destination. For each record, you can influcene the item action (e.g. to change it to upsert, replace or delete). Replace and Delete will need to set a partition key for each record via the SetItemActionOptions. For Delete you will also need to set an id to identify the record to be deleted.

Declaration

{{< /rawhtml >}} ```C# public Action SetItemActionOptions { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
Action<ItemActionOption, TInput>

Examples

dest.SetItemActionOptions = (options, item) => {
    options.ItemAction = ItemAction.Delete;  //or ItemAction.Replace or ItemAction.Upsert
    options.Id = item.Id; //only for Deletes                
    options.PartitionKey = new PartitionKey(item.PartitionKey);
};

UseTransactionalBatch

By default, data is inserted as bulk. If you prefer to insert data as part of a transactional batch, set this property to true. The maximum allowed batch size is then 100 (due to the limitation of Cosmos Db). This works best if all data has the same partition key. If the incoming data has different partition keys, the data is inserted in multiple batches, grouped by each partition key. Make sure to add a partition key for each record using the SetItemActionOptions action. If any of the records in the batch is flawed, the whole batch will not be inserted. You can redirect erroneous batches using 'LinkErrorsTo()' when linking your components.

Declaration

{{< /rawhtml >}} ```C# public bool UseTransactionalBatch { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
bool

Examples

dest.UseTransactionalBatch = true;
 dest.SetItemActionOptions = (config, item) => config.PartitionKey = new PartitionKey(item.Block);

Methods

BulkInsertData(TInput[])

Declaration

{{< /rawhtml >}} ```C# protected override void BulkInsertData(TInput[] data) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
TInput[]	data

Overrides

DataFlowBatchDestination<TInput>.BulkInsertData(TInput[])

CheckParameter()

Declaration

{{< /rawhtml >}} ```C# protected override void CheckParameter() ``` {{< rawhtml >}}

Overrides

DataFlowComponent.CheckParameter()

FinishWrite()

Declaration

{{< /rawhtml >}} ```C# protected override void FinishWrite() ``` {{< rawhtml >}}

Overrides

DataFlowBatchDestination<TInput>.FinishWrite()

PrepareParameterForCheck()

Declaration

{{< /rawhtml >}} ```C# protected override void PrepareParameterForCheck() ``` {{< rawhtml >}}

Overrides

DataFlowComponent.PrepareParameterForCheck()

PrepareWrite()

Declaration

{{< /rawhtml >}} ```C# protected override void PrepareWrite() ``` {{< rawhtml >}}

Overrides

DataFlowBatchDestination<TInput>.PrepareWrite()

Implements

IDataFlowBatchDestination<TInput>

IDataFlowDestination<TInput>

IDataFlowBatchDestination

IDataFlowDestination

IDataFlowComponent

ILoggableTask