Class CosmosSource<TOutput>
A data flow source for Couchbase
Inheritance
CosmosSource<TOutput>
Namespace: ETLBox.Azure.CosmosDb
Assembly: ETLBox.Azure.CosmosDb.dll
Syntax
public class CosmosSource<TOutput> : DataFlowExecutableSource<TOutput>, IDataFlowLogging, IDataFlowExecutableSource<TOutput>, IDataFlowSource<TOutput>, IDataFlowExecutableSource, IDataFlowSource, IDataFlowComponent, ILoggableTask
Type Parameters
Name | Description |
---|
TOutput | Type of outgoing data. |
Constructors
CosmosSource()
Declaration
CosmosSource(string, string, string, string)
Declaration
public CosmosSource(string connectionString, string databaseName, string containerName, string sql)
Parameters
Properties
AccountEndpoint
Declaration
public string AccountEndpoint { get; set; }
Property Value
AuthKeyOrResourceToken
Declaration
public string AuthKeyOrResourceToken { get; set; }
Property Value
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
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
ConnectionString
Declaration
public string ConnectionString { get; set; }
Property Value
ContainerName
The container name of the Azure Cosmos Db destination
Declaration
public string ContainerName { get; set; }
Property Value
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
DatabaseName
The database name of the Azure Cosmos Db destination
Declaration
public string DatabaseName { get; set; }
Property Value
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
QueryRequestOptions
Optional: Request options for the query.
Declaration
public QueryRequestOptions QueryRequestOptions { get; set; }
Property Value
Sql
The Sql used to retrieve the data. Alternatively, you can also provide a QueryDefinition.
Declaration
public string Sql { get; set; }
Property Value
TaskName
A name to identify the task or component. Every component or task comes
with a default name that can be overwritten.
Declaration
public override string TaskName { get; set; }
Property Value
Overrides
Methods
CheckParameter()
Declaration
protected override void CheckParameter()
Overrides
CleanUpOnFaulted(Exception)
Declaration
protected override void CleanUpOnFaulted(Exception e)
Parameters
Overrides
CleanUpOnSuccess()
Declaration
protected override void CleanUpOnSuccess()
Overrides
InitParameter()
Declaration
protected override void InitParameter()
Overrides
OnExecutionDoAsyncWork()
Declaration
protected override void OnExecutionDoAsyncWork()
Overrides
OnExecutionDoSynchronousWork()
Declaration
protected override void OnExecutionDoSynchronousWork()
Overrides
PrepareParameter()
Declaration
protected override void PrepareParameter()
Overrides
Implements