ETLBoxClass MongoDbSource<TOutput>
A data flow source for MonogDb.
Inheritance
System.Object
DataFlowSource<TOutput>
DataFlowExecutableSource<TOutput>
MongoDbSource<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.MongoDb.dll
Syntax
public class MongoDbSource<TOutput> : DataFlowExecutableSource<TOutput>, ILoggableTask, IDataFlowLogging, IDataFlowExecutableSource<TOutput>, IDataFlowSource<TOutput>, IDataFlowSource, IDataFlowComponent, IDataFlowExecutableSource
Type Parameters
| Name | Description |
|---|---|
| TOutput | Type of outgoing data. |
Constructors
MongoDbSource()
Declaration
public MongoDbSource()
Fields
DEFAULT_BATCH_SIZE
Default batch size when retrieving documents.
Declaration
public const int DEFAULT_BATCH_SIZE = 1000
Field Value
| Type | Description |
|---|---|
| System.Int32 |
Properties
CollectionName
Name of the collection to retrieve the documents from.
Declaration
public string CollectionName { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ConnectionString
If you provide a connection string, this component will create a new MongoClient object to connect with MongoDb. If you already have a client object instantiated in your application, use DbClient instead to pass it directly to the component.
Declaration
public string ConnectionString { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
DatabaseName
The used database.
Declaration
public string DatabaseName { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
DbClient
An existing MongoClient that holds a MongoDb connection.
Declaration
public MongoClient DbClient { get; set; }
Property Value
| Type | Description |
|---|---|
| MongoDB.Driver.MongoClient |
Filter
A filter description applied when retrieving the documents from the collection.
Declaration
public FilterDefinition<BsonDocument> Filter { get; set; }
Property Value
| Type | Description |
|---|---|
| MongoDB.Driver.FilterDefinition<MongoDB.Bson.BsonDocument> |
FindOptions
Additional find options when retrieving the documents from the collection.
Declaration
public FindOptions FindOptions { get; set; }
Property Value
| Type | Description |
|---|---|
| MongoDB.Driver.FindOptions |
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
| Type | Description |
|---|---|
| System.String |
Overrides
Methods
CheckParameter()
Declaration
protected override void CheckParameter()
Overrides
CleanUpOnFaulted(Exception)
Declaration
protected override void CleanUpOnFaulted(Exception e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Exception | e |
Overrides
CleanUpOnSuccess()
Declaration
protected override void CleanUpOnSuccess()
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()