DatabaseTableSchemaRegistry

Description:

Provides a service for generating a record schema from a database table definition. The service is configured to use a table name and a database connection fetches the table metadata (i.e. table definition) such as column names, data types, nullability, etc.

Tags:

schema, registry, database, table

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Database Connection Pooling ServiceDatabase Connection Pooling ServiceController Service API:
DBCPService
Implementations: HadoopDBCPConnectionPool
DBCPConnectionPool
DBCPConnectionPoolLookup
HikariCPConnectionPool
The Controller Service that is used to obtain a connection to the database for retrieving table information.
Catalog NameCatalog NameThe name of the catalog used to locate the desired table. This may not apply for the database that you are querying. In this case, leave the field empty. Note that if the property is set and the database is case-sensitive, the catalog name must match the database's catalog name exactly.
Supports Expression Language: true (will be evaluated using variable registry only)
Schema NameSchema NameThe 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. Note that if the property is set and the database is case-sensitive, the schema name must match the database's schema name exactly. Also notice that if the same table name exists in multiple schemas and Schema Name is not specified, the service will find those tables and give an error if the different tables have the same column name(s).
Supports Expression Language: true (will be evaluated using variable registry only)

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.