Class CosmosSource<TOutput>

{{< /rawhtml >}} ```C# public class CosmosSource : DataFlowExecutableSource, IDataFlowExecutableSource, IDataFlowSource, IDataFlowExecutableSource, IDataFlowSource, IDataFlowComponent, ILoggableTask ``` {{< rawhtml >}}

Type Parameters

Name	Description
TOutput	Type of outgoing data.

Constructors

CosmosSource()

Declaration

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

CosmosSource(string, string, string, string)

Declaration

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

Parameters

Type	Name	Description
string	connectionString
string	databaseName
string	containerName
string	sql

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

QueryDefinition

The query definition to retrieve the data. If no query definition is provided, Sql, the definition will be automatically generated from the provided Sql statement.

Declaration

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

Property Value

Type	Description
QueryDefinition

QueryRequestOptions

Optional: Request options for the query.

Declaration

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

Property Value

Type	Description
QueryRequestOptions

Sql

The Sql used to retrieve the data. Alternatively, you can also provide a QueryDefinition.

Declaration

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

Property Value

Type	Description
string

Methods

CheckParameter()

Declaration

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

Overrides

DataFlowComponent.CheckParameter()

CleanUpOnFaulted(Exception)

Declaration

{{< /rawhtml >}} ```C# protected override void CleanUpOnFaulted(Exception e) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
Exception	e

Overrides

DataFlowComponent.CleanUpOnFaulted(Exception)

CleanUpOnSuccess()

Declaration

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

Overrides

DataFlowComponent.CleanUpOnSuccess()

InitCheckedParameter()

Declaration

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

Overrides

DataFlowComponent.InitCheckedParameter()

OnExecutionDoAsyncWork()

Declaration

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

Overrides

DataFlowExecutableSource<TOutput>.OnExecutionDoAsyncWork()

PrepareParameterForCheck()

Declaration

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

Overrides

DataFlowComponent.PrepareParameterForCheck()

Implements

IDataFlowExecutableSource<TOutput>

IDataFlowSource<TOutput>

IDataFlowExecutableSource

IDataFlowSource

IDataFlowComponent

ILoggableTask