Netezza database plugin

Owned by Illia
Last updated: Jul 21, 2019 by Vlad Hlinskiy

Introduction

A separate database plugin to support Netezza-specific features and configurations.

Use-Case

  • Users can choose and install Netezza source and sink plugins.
  • Users should see Netezza logo on plugin configuration page for better experience.
  • Users should get relevant information from the tool tip:
    • The tool tip for the connection string should be customized specifically to the Netezza database,
    • The tool tip should describe accurately what each field is used for.
  • Users should not have to specify any redundant configuration (ex: JDBC type in source plugin, columns in the sink plugin).
  • Users should get field level lineage for the source and sink that is being used.
  • Reference documentation should be updated to account for the changes.
  • The source code for Netezza database plugin should be placed in repo under data-integrations org.
  • Integration tests for Netezza database plugin should be added in the test repo.
  • The data pipeline using source and sink plugins should run on both mapreduce and spark engines.

User Stories

  • User should be able to install Netezza specific database source and sink plugins from the Hub
  • Users should have each tool tip accurately describe what each field does
  • Users should get field level lineage information for the Netezza source and sink
  • Users should be able to setup a pipeline avoiding specifying redundant information
  • Users should get updated reference document for Netezza source and sink
  • Users should be able to read all the DB types

Plugin Type

  • Batch Source
  • Batch Sink 
  • Real-time Source
  • Real-time Sink
  • Action
  • Post-Run Action
  • Aggregate
  • Join
  • Spark Model
  • Spark Compute

Design Tips

Netezza connector reference: https://www.ibm.com/support/knowledgecenter/en/SSZJPZ_11.7.0/com.ibm.swg.im.iis.conn.container.nav.doc/topics/properties_reference_netezza_connector.html

Existing database plugins: https://github.com/cdapio/hydrator-plugins/tree/develop/database-plugins

Netezza datatypes mappings and conversions: https://www.ibm.com/support/knowledgecenter/en/SSEP7J_10.1.1/com.ibm.swg.ba.cognos.vvm_reference_guide.10.1.1.doc/c_netezzads.html


Design

The suggestion is to create maven submodule netezza-plugin under database-plugins repo.


Sink Properties

User Facing NameTypeDescriptionConstraints
LabelString Label for UI
Reference NameStringUniquely identified name for lineage
HostStringNetezza hostRequired (defaults to localhost on UI)
PortNumberSpecific port which Netezza is listening to

Optional

(default 5480)

DatabaseStringDatabase name to connectRequired
UsernameStringDB usernameRequired
PasswordPasswordUser passwordRequired
Transaction Isolation LevelSelectTransaction isolation level for queries run by this sink
Connection ArgumentsKeyvalue

A list of arbitrary string tag/value pairs as connection arguments, list of properties:

Netezza connection properties


Table NameStringName of a database table to write to

Source Properties


User Facing NameTypeDescriptionConstraints
LabelStringLabel for UI
Reference NameStringUniquely identified name for lineage
HostStringNetezza host Required (defaults to localhost on UI)
PortNumberSpecific port which Netezza is listening to

Optional

(default 5480)
DatabaseStringDatabase name to connectRequired
Import QueryStringQuery for import dataValid SQL query
UsernameStringDB usernameRequired
PasswordStringUser passwordRequired
Bounding QueryStringReturns max and min of split-By FiledValid SQL query
Split-By Field NameStringField name which will be used to generate splits
Number of Splits to GenerateNumberNumber of splits to generate
Transaction Isolation LevelSelectTransaction isolation level for queries run by this sink
Connection ArgumentsKeyvalue

A list of arbitrary string tag/value pairs as connection arguments, list of properties: Netezza connection properties



Action Properties


User Facing NameTypeDescriptionConstraints
LabelStringLabel for UI
HostStringNetezza host Required (defaults to localhost on UI)
PortNumberSpecific port which Netezza is listening to

Optional

(default 5480)
DatabaseStringDatabase name to connectRequired
Username

String

DB usernameRequired
PasswordStringUser passwordRequired
Connection ArgumentsKeyvalue

A list of arbitrary string tag/value pairs as connection arguments, list of properties:

Netezza connection properties


Database CommandStringDatabase command to runValid SQL query


Data Types Mapping

Netezza Data TypeCDAP Schema Data TypeSupportComment
BOOLEANSchema.Type.BOOLEAN+
BYTEINTSchema.Type.INT+
CHARSchema.Type.STRING+
DATESchema.LogicalType.DATE+
NUMERIC/DECIMALSchema.LogicalType.DECIMAL+
DOUBLE PRECISION/FLOAT(15)Schema.Type.DOUBLE+
FLOAT(N)Schema.Type.FLOAT/Schema.Type.DOUBLE+Can be mapped to FLOAT or DOUBLE, depends on N
INTEGERSchema.Type.INT+
SMALLINTSchema.Type.INT+
BIGINTSchema.Type.LONG+
NCHARSchema.Type.STRING+
NVARCHARSchema.Type.STRING+
REAL/FLOAT(6)Schema.Type.FLOAT+
TIMESchema.LogicalType.TIME_MICROS+
TIMETZ/TIME WITH TIME ZONESchema.Type.STRING+
TIMESTAMPSchema.LogicalType.TIMESTAMP_MICROS+
VARCHARSchema.Type.STRING+
INTERVALSchema.Type.STRING+
VARBINARYSchema.Type.BYTES+
ST_GEOMETRYSchema.Type.BYTES+



Approach

Create a module netezza-plugin in database-plugins project, reuse existing database-plugins code if possible. Add Netezza-specific properties to configuration, add support for Netezza-specific datatypes. Update UI widgets JSON definitions.

Pipeline Samples


API changes

Deprecated Programmatic APIs

database-plugins is moved to Data Integrations

UI Impact or Changes

Configurable database properties are presented as named text fields instead of arbitrary key value pairs. Netezza source and sink are separate entries with Netezza logo in source and sink lists.

Test Scenarios

TODO

Releases

Release X.Y.Z

Related Work

Database plugin enhancements

Future work

DB2 database plugin