Class CouchbaseDestination<TInput>
A data flow destination for inserting data into a couchbase bucket.
Inheritance
object
CouchbaseDestination<TInput>
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: ETLBox.Couchbase
Assembly: ETLBox.Couchbase.dll
Syntax
public class CouchbaseDestination<TInput> : DataFlowBatchDestination<TInput>, ILoggableTask, IDataFlowLogging, IDataFlowBatchDestination<TInput>, IDataFlowDestination<TInput>, IDataFlowBatchDestination, IDataFlowDestination, IDataFlowComponent
Type Parameters
Name | Description |
---|
TInput | Type of ingoing data. |
Constructors
CouchbaseDestination()
Declaration
public CouchbaseDestination()
CouchbaseDestination(int)
Declaration
public CouchbaseDestination(int batchSize)
Parameters
Type | Name | Description |
---|
int | batchSize | |
Properties
BucketName
The bucket name to insert the data into. Object will be serialized into Json.
Declaration
public string BucketName { get; set; }
Property Value
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
Type | Description |
---|
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
CouchbaseCluster
An existing couchbase Cluster that holds a couchbase connection.
Declaration
public ICluster CouchbaseCluster { get; set; }
Property Value
KeyColumn
The property that is used to retrieve the key. Only one key column is accepted.
If no key column is provided, a Guid is generated and used as key.
The property that hold the key must either be a string or implement ToString().
Declaration
public KeyColumn KeyColumn { get; set; }
Property Value
Options
Additional insert options to use when inserted data into the bucket.
Declaration
public InsertOptions Options { get; set; }
Property Value
Type | Description |
---|
InsertOptions | |
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
BulkInsertData(TInput[])
Declaration
protected override void BulkInsertData(TInput[] data)
Parameters
Type | Name | Description |
---|
TInput[] | data | |
Overrides
ETLBox.DataFlow.DataFlowBatchDestination<TInput>.BulkInsertData(TInput[])
CheckParameter()
Declaration
protected override void CheckParameter()
Overrides
FinishWrite()
Declaration
protected override void FinishWrite()
Overrides
ETLBox.DataFlow.DataFlowBatchDestination<TInput>.FinishWrite()
PrepareParameter()
Declaration
protected override void PrepareParameter()
Overrides
PrepareWrite()
Declaration
protected override void PrepareWrite()
Overrides
ETLBox.DataFlow.DataFlowBatchDestination<TInput>.PrepareWrite()
Implements