ETLBox
Title here
Summary here
CosmosSource<TOutput>
Class CosmosSource<TOutput>
A data flow source for Couchbase
Inherited Members
Namespace: ETLBox.Azure.CosmosDb
Assembly: ETLBox.Azure.CosmosDb.dll
Syntax
public class CosmosSource<TOutput> : DataFlowExecutableSource<TOutput>, IDataFlowExecutableSource<TOutput>, IDataFlowSource<TOutput>, IDataFlowExecutableSource, IDataFlowSource, IDataFlowComponent, ILoggableTaskType Parameters
| Name | Description |
|---|---|
| TOutput | Type of outgoing data. |
Constructors
CosmosSource()
Declaration
public CosmosSource()CosmosSource(string, string, string, string)
Declaration
public CosmosSource(string connectionString, string databaseName, string containerName, string sql)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
public string AccountEndpoint { get; set; }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
public string AuthKeyOrResourceToken { get; set; }Property Value
| Type | Description |
|---|---|
| string |
AzureKeyCredential
Optional: An Azure Key Credential used when opening the connection (works only in combination with ConnectionString)
Declaration
public AzureKeyCredential AzureKeyCredential { get; set; }Property Value
| Type | Description |
|---|---|
| AzureKeyCredential |
AzureTokenCredential
Optional: An Azure Token Credential used when opening the connection (works only in combination with ConnectionString)
Declaration
public TokenCredential AzureTokenCredential { get; set; }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
public string ConnectionString { get; set; }Property Value
| Type | Description |
|---|---|
| string |
ContainerName
The container name of the Azure Cosmos Db destination
Declaration
public string ContainerName { get; set; }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
public CosmosClient CosmosClient { get; set; }Property Value
| Type | Description |
|---|---|
| CosmosClient |
DatabaseName
The database name of the Azure Cosmos Db destination
Declaration
public string DatabaseName { get; set; }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
public QueryDefinition QueryDefinition { get; set; }Property Value
| Type | Description |
|---|---|
| QueryDefinition |
QueryRequestOptions
Optional: Request options for the query.
Declaration
public QueryRequestOptions QueryRequestOptions { get; set; }Property Value
| Type | Description |
|---|---|
| QueryRequestOptions |
Sql
The Sql used to retrieve the data. Alternatively, you can also provide a QueryDefinition.
Declaration
public string Sql { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Methods
CheckParameter()
Declaration
protected override void CheckParameter()Overrides
CleanUpOnFaulted(Exception)
Declaration
protected override void CleanUpOnFaulted(Exception e)Parameters
| Type | Name | Description |
|---|---|---|
| Exception | e |
Overrides
CleanUpOnSuccess()
Declaration
protected override void CleanUpOnSuccess()Overrides
InitCheckedParameter()
Declaration
protected override void InitCheckedParameter()Overrides
OnExecutionDoAsyncWork()
Declaration
protected override void OnExecutionDoAsyncWork()Overrides
PrepareParameterForCheck()
Declaration
protected override void PrepareParameterForCheck()Overrides
Implements
Next
CosmosSource