Class DbDestination<TInput>
A DbDestination represents a database table where ingoing data from the flow is written into. Inserts are done in batches (using Bulk insert or an equivalent INSERT statement).
Inherited Members
Namespace: ETLBox.DataFlow
Assembly: ETLBox.dll
Syntax
{{< /rawhtml >}} ```C# public class DbDestinationType Parameters
| Name | Description |
|---|---|
| TInput | Data type for ingoing data, preferably representing the data type for the destination table. |
Constructors
DbDestination()
Declaration
{{< /rawhtml >}} ```C# public DbDestination() ``` {{< rawhtml >}}DbDestination(IConnectionManager, string)
Declaration
{{< /rawhtml >}} ```C# public DbDestination(IConnectionManager connectionManager, string tableName) ``` {{< rawhtml >}}Parameters
| Type | Name | Description |
|---|---|---|
| IConnectionManager | connectionManager | Sets the ConnectionManager |
| string | tableName | Sets the TableName |
DbDestination(IConnectionManager, string, int)
Declaration
{{< /rawhtml >}} ```C# public DbDestination(IConnectionManager connectionManager, string tableName, int batchSize) ``` {{< rawhtml >}}Parameters
| Type | Name | Description |
|---|---|---|
| IConnectionManager | connectionManager | Sets the ConnectionManager |
| string | tableName | Sets the TableName |
| int | batchSize | Sets the BatchSize |
DbDestination(string)
Declaration
{{< /rawhtml >}} ```C# public DbDestination(string tableName) ``` {{< rawhtml >}}Parameters
| Type | Name | Description |
|---|---|---|
| string | tableName | Sets the TableName |
DbDestination(string, int)
Declaration
{{< /rawhtml >}} ```C# public DbDestination(string tableName, int batchSize) ``` {{< rawhtml >}}Parameters
| Type | Name | Description |
|---|---|---|
| string | tableName | Sets the TableName |
| int | batchSize | Sets the BatchSize |
Properties
AllowIdentityInsert
By default, identity columns (a.k.a auto increment or serial columns) are ignored when writing into the destination. If set to true, the DbDestination will try to overwrite identity values (if there is a corresponding property with a new id value in the data object)
Declaration
{{< /rawhtml >}} ```C# public bool AllowIdentityInsert { get; set; } ``` {{< rawhtml >}}Property Value
| Type | Description |
|---|---|
| bool |
BulkInsertConnectionManager
The connection manager used for the bulk inserts. This is a copy of the provided connection manager.
Declaration
{{< /rawhtml >}} ```C# public IConnectionManager BulkInsertConnectionManager { get; protected set; } ``` {{< rawhtml >}}Property Value
| Type | Description |
|---|---|
| IConnectionManager |
BulkOperation
The bulk operation mode used for inserting data. By default, the database will insert the arriving data into the destination table using bulk insert. You can use BulkOperation.Delete to bulk delete matching data in the destination. You can use BulkOperation.Update to bulk update matching data in the destination. IdColumns must match to delete a record. UpdateColumns define which columns are updated (all non id columns if no update columns is set).
Declaration
{{< /rawhtml >}} ```C# public BulkOperation BulkOperation { get; set; } ``` {{< rawhtml >}}Property Value
| Type | Description |
|---|---|
| BulkOperation |
ColumnConverters
Use a column converter to apply a conversion function to each value of a column.
Declaration
{{< /rawhtml >}} ```C# public ICollectionProperty Value
| Type | Description |
|---|---|
| ICollection<ColumnConverter> |
ColumnMapping
Column mapping to map property to column names. E.g. if the value of property "Id" should be written into the database column "Key", then you can simply add a column mapping: DbColumnName: "Id" -> PropertyName: "Key".
Declaration
{{< /rawhtml >}} ```C# public ICollectionProperty Value
| Type | Description |
|---|---|
| ICollection<DbColumnMap> |
ConnectionManager
The connection manager used to connect to the database - use the right connection manager for your database type.
Declaration
{{< /rawhtml >}} ```C# public virtual IConnectionManager ConnectionManager { get; set; } ``` {{< rawhtml >}}Property Value
| Type | Description |
|---|---|
| IConnectionManager |
IdColumns
List of id columns that are used to identify matching records. Only needed when BulkOpteration is set to BulkOperation.Update or BulkOperation.Delete.
Declaration
{{< /rawhtml >}} ```C# public ICollectionProperty Value
| Type | Description |
|---|---|
| ICollection<IdColumn> |
IgnoreDefaultColumnsOnInsert
If set to true, columns that have a default value declaration in the database are ignored when inserting data.
Declaration
{{< /rawhtml >}} ```C# public bool IgnoreDefaultColumnsOnInsert { get; set; } ``` {{< rawhtml >}}Property Value
| Type | Description |
|---|---|
| bool |
InsertColumns
List of columns that are are insert when BulkOperation is set to BulkOperation.Insert
Declaration
{{< /rawhtml >}} ```C# public ICollectionProperty Value
| Type | Description |
|---|---|
| ICollection<InsertColumn> |
MatchCaseInsensitive
When set to true, property names are matched to column names in a case-insensitive manner. This automatically creates a ColumnMapping to perform case-insensitive matching by reading the table definition from the database. You cannot use this property together with a manually set PropertyToColumnNamesResolver or ColumnMapping.
Declaration
{{< /rawhtml >}} ```C# public bool MatchCaseInsensitive { get; set; } ``` {{< rawhtml >}}Property Value
| Type | Description |
|---|---|
| bool |
PropertyToColumnNamesResolver
A custom resolver function that maps property names in the target object to corresponding column names in the database. You can only use either the PropertyToColumnNamesResolver or specify a ColumnMapping, not both. Use this to define dynamic mappings, such as converting camelCase property names to lowercase or snake_case column names in the database.
Declaration
{{< /rawhtml >}} ```C# public FuncProperty Value
| Type | Description |
|---|---|
| Func<string, string> |
Examples
Assume your database columns are all lowercase (e.g., "firstname", "lastname"), and your POCO properties are camelCase (e.g., "FirstName", "LastName").
dest.PropertyToColumnResolver = propName => propName.ToLower();TableDefinition
The table definition of the destination table. By default, the table definition is read from the database. Provide a table definition if the definition of the target can't be read automatically or you want the DbDestination only to use the columns in the provided definition.
Declaration
{{< /rawhtml >}} ```C# public TableDefinition TableDefinition { get; set; } ``` {{< rawhtml >}}Property Value
| Type | Description |
|---|---|
| TableDefinition |
TableName
Name of the database table that receives the data from the data flow.
Declaration
{{< /rawhtml >}} ```C# public string TableName { get; set; } ``` {{< rawhtml >}}Property Value
| Type | Description |
|---|---|
| string |
UpdateColumns
List of columns that are are updated when BulkOperation is set to BulkOperation.Update
Declaration
{{< /rawhtml >}} ```C# public ICollectionProperty Value
| Type | Description |
|---|---|
| ICollection<UpdateColumn> |
ValueGeneratedColumns
List of columns that contain information generated from the underlying database (e.g. identity/auto increment/serial columns, or columns with default values when inserting null). This information can be read for supported databases after bulk inserting the data.
Declaration
{{< /rawhtml >}} ```C# public ICollectionProperty Value
| Type | Description |
|---|---|
| ICollection<ValueGenerationColumn> |
Methods
BulkInsertData(TInput[])
Declaration
{{< /rawhtml >}} ```C# protected override void BulkInsertData(TInput[] data) ``` {{< rawhtml >}}Parameters
| Type | Name | Description |
|---|---|---|
| TInput[] | data |
Overrides
CheckParameter()
Declaration
{{< /rawhtml >}} ```C# protected override void CheckParameter() ``` {{< rawhtml >}}Overrides
FinishWrite()
Declaration
{{< /rawhtml >}} ```C# protected override void FinishWrite() ``` {{< rawhtml >}}Overrides
PrepareParameterForCheck()
Declaration
{{< /rawhtml >}} ```C# protected override void PrepareParameterForCheck() ``` {{< rawhtml >}}Overrides
PrepareWrite()
Declaration
{{< /rawhtml >}} ```C# protected override void PrepareWrite() ``` {{< rawhtml >}}Overrides
Reset()
Declaration
{{< /rawhtml >}} ```C# protected override void Reset() ``` {{< rawhtml >}}Overrides
SkipRecord(string, string)
Declaration
{{< /rawhtml >}} ```C# public bool SkipRecord(string propName, string colname) ``` {{< rawhtml >}}Parameters
| Type | Name | Description |
|---|---|---|
| string | propName | |
| string | colname |
Returns
| Type | Description |
|---|---|
| bool |