Class CouchbaseSource<TOutput>

A data flow source for Couchbase

Inheritance
System.Object
CouchbaseSource<TOutput>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: ETLBox.DataFlow.Connectors
Assembly: ETLBox.Couchbase.dll
Syntax
    public class CouchbaseSource<TOutput> : DataFlowExecutableSource<TOutput>, ILoggableTask, IDataFlowLogging, IDataFlowExecutableSource<TOutput>, IDataFlowSource<TOutput>, IDataFlowSource, IDataFlowComponent, IDataFlowExecutableSource
Type Parameters
NameDescription
TOutput

Type of outgoing data.

Constructors

CouchbaseSource()

Declaration
    public CouchbaseSource()

Properties

ClusterOptions

If you provide ClusterOptions (or a connection string), this component will create a new Cluster object to connect with Couchbase. If you already have a cluster object instantiated in your application, use CouchbaseCluster instead to pass it directly to the component. Instead or additional to a ClustOptions you can also set the ConnectionString.

Declaration
    public ClusterOptions ClusterOptions { get; set; }
Property Value
TypeDescription
Couchbase.ClusterOptions

ConnectionString

If you provide a connection string (or cluster options), this component will create a new Cluster object to connect with Couchbase. If you already have a cluster object instantiated in your application, use CouchbaseCluster instead to pass it directly to the component. Instead or additional to a connection string you can also set the ClusterOptions.

Declaration
    public string ConnectionString { get; set; }
Property Value
TypeDescription
System.String

CouchbaseCluster

An existing couchbase Cluster that holds a couchbase connection.

Declaration
    public ICluster CouchbaseCluster { get; set; }
Property Value
TypeDescription
Couchbase.ICluster

N1QLStatement

The N1QL statement used to retrieve data from your Couchbase DB. Objects will be deserialized from json.

Declaration
    public string N1QLStatement { get; set; }
Property Value
TypeDescription
System.String

Options

Additional query options when retrieving data with the N1QLStatement

Declaration
    public QueryOptions Options { get; set; }
Property Value
TypeDescription
Couchbase.Query.QueryOptions

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
TypeDescription
System.String
Overrides

Methods

CheckParameter()

Declaration
    protected override void CheckParameter()
Overrides

CleanUpOnFaulted(Exception)

Declaration
    protected override void CleanUpOnFaulted(Exception e)
Parameters
TypeNameDescription
System.Exceptione
Overrides

CleanUpOnSuccess()

Declaration
    protected override void CleanUpOnSuccess()
Overrides

InitParameter()

Declaration
    protected override void InitParameter()
Overrides

OnExecutionDoAsyncWork()

Declaration
    protected override void OnExecutionDoAsyncWork()
Overrides
ETLBox.DataFlow.DataFlowExecutableSource<TOutput>.OnExecutionDoAsyncWork()

OnExecutionDoSynchronousWork()

Declaration
    protected override void OnExecutionDoSynchronousWork()
Overrides
ETLBox.DataFlow.DataFlowExecutableSource<TOutput>.OnExecutionDoSynchronousWork()

Implements