DatabaseRecordSink

DatabaseRecordSink 2.0.0

Bundle: org.apache.nifi | nifi-dbcp-service-nar
Description: Provides a service to write records using a configured database connection.
Tags: connection, database, db, jdbc, record
Input Requirement
Supports Sensitive Dynamic Properties: false

Properties

Catalog Name
The name of the catalog that the statement should update. This may not apply for the database that you are updating. In this case, leave the field empty

Display Name

Catalog Name

Description

The name of the catalog that the statement should update. This may not apply for the database that you are updating. In this case, leave the field empty

API Name

db-record-sink-catalog-name

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Database Connection Pooling Service
The Controller Service that is used to obtain a connection to the database for sending records.

Display Name

Database Connection Pooling Service

Description

The Controller Service that is used to obtain a connection to the database for sending records.

API Name

db-record-sink-dcbp-service

Service Interface

org.apache.nifi.dbcp.DBCPService

Service Implementations

org.apache.nifi.dbcp.DBCPConnectionPool

org.apache.nifi.dbcp.DBCPConnectionPoolLookup

org.apache.nifi.dbcp.HikariCPConnectionPool

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Max Wait Time
The maximum amount of time allowed for a running SQL statement , zero means there is no limit. Max time less than 1 second will be equal to zero.

Display Name

Max Wait Time

Description

The maximum amount of time allowed for a running SQL statement , zero means there is no limit. Max time less than 1 second will be equal to zero.

API Name

db-record-sink-query-timeout

Default Value

0 seconds

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Quote Column Identifiers
Enabling this option will cause all column names to be quoted, allowing you to use reserved words as column names in your tables.
Display Name

Quote Column Identifiers

Description

Enabling this option will cause all column names to be quoted, allowing you to use reserved words as column names in your tables.

API Name

db-record-sink-quoted-identifiers

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Quote Table Identifiers
Enabling this option will cause the table name to be quoted to support the use of special characters in the table name.
Display Name

Quote Table Identifiers

Description

Enabling this option will cause the table name to be quoted to support the use of special characters in the table name.

API Name

db-record-sink-quoted-table-identifiers

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Schema Name
The name of the schema that the table belongs to. This may not apply for the database that you are updating. In this case, leave the field empty

Display Name

Schema Name

Description

The name of the schema that the table belongs to. This may not apply for the database that you are updating. In this case, leave the field empty

API Name

db-record-sink-schema-name

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Table Name
The name of the table that the statement should affect.

Display Name

Table Name

Description

The name of the table that the statement should affect.

API Name

db-record-sink-table-name

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Translate Field Names
If true, the Processor will attempt to translate field names into the appropriate column names for the table specified. If false, the field names must match the column names exactly, or the column will not be updated
Display Name

Translate Field Names

Description

If true, the Processor will attempt to translate field names into the appropriate column names for the table specified. If false, the field names must match the column names exactly, or the column will not be updated

API Name

db-record-sink-translate-field-names

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Unmatched Column Behavior
If an incoming record does not have a field mapping for all of the database table's columns, this property specifies how to handle the situation
Display Name

Unmatched Column Behavior

Description

If an incoming record does not have a field mapping for all of the database table's columns, this property specifies how to handle the situation

API Name

db-record-sink-unmatched-column-behavior

Default Value

Fail on Unmatched Columns

Allowable Values
- Ignore Unmatched Columns
- Warn on Unmatched Columns
- Fail on Unmatched Columns
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Unmatched Field Behavior
If an incoming record has a field that does not map to any of the database table's columns, this property specifies how to handle the situation
Display Name

Unmatched Field Behavior

Description

If an incoming record has a field that does not map to any of the database table's columns, this property specifies how to handle the situation

API Name

db-record-sink-unmatched-field-behavior

Default Value

Ignore Unmatched Fields

Allowable Values
- Ignore Unmatched Fields
- Fail on Unmatched Fields
Expression Language Scope

Not Supported

Sensitive

false

Required

false