Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To customize compression encoding for specific columns when creating a table, the connector provides a way to set the
encoding column metadata field. Please refer to the available encodings in the Amazon Redshift documentation.
Redshift allows descriptions to be attached to columns, which can be viewed in most query tools. You can specify a description for individual columns by setting the description column metadata field. This can be done using the COMMENT command.


IV) Datatype Mapping

Flink TypeRedshift Type
CHARVARCHAR
VARCHARVARCHAR
STRINGVARCHAR
BOOLEANBoolean
BYTESNot supported
DECIMALDecimal
TINYINTInt8
SMALLINTInt16
INTEGERInt32
BIGINTInt64
FLOATFloat32
DOUBLEFloat64
DATEDate
TIMETimestamp
TIMESTAMPTimestamp
TIMESTAMP_LTZTimestamp
INTERVAL_YEAR_MONTHInt32
INTERVAL_DAY_TIMEInt64
ARRAYNot supported
MAPNot supported
ROWNot supported
MULTISETNot supported
RAWNot supported


V) Source Design

Flink connector redshift will offer 2 modes to read from the source:-

...

  1. Configuration:

    Source Connector Options

    OptionRequiredDefaultTypeDescription
    hostnamerequirednoneStringRedshift connection hostname
    portrequired5439IntegerRedshift connection port
    usernamerequirednoneStringRedshift user username
    passwordrequirednoneStringRedshift user password
    database.namerequireddevStringRedshift database to connect
    table.namerequirednoneStringReshift table name
    source.batch.sizeoptional1000IntegerThe max flush size, over this will flush data.
    source.flush.intervaloptional1sDurationOver this flush interval mills, asynchronous threads will flush data.
    source.max.retriesoptional3IntegerThe max retry times when writing records to the database failed.
    scan.read.moderequiredfalseBooleanUsing Redshift UNLOAD command.
    unload.temp.s3.pathconditional requirednoneStringIf the unload-mode=true then then Redshift UNLOAD command must need a S3 URI.
    iam-role-arnconditional requirednoneStringIf the unload.mode=true then then Redshift UNLOAD command must need a IAM role. And this role must have the privilege and attache to the Redshift cluser



VI) Sink Design

      Flink connector Redshift will offer 2 modes to write to Redshift:-

  1. Directly writing to redshift using JDBC driver.
  2. Flink stream write to a specified s3 path in the format and schema accepted by Redshift then use COPY command to write data into the redshift table.

    Flink connector redshift will provide users with the ability to configure different modes for the connector sink by utilizing the sink.write.mode  option in the source configuration. This configuration flexibility allows users to tailor the behaviour of the connector sink to their specific needs. Internally, the flink-connector-redshift module will intelligently select and integrate with the appropriate connectors based on the chosen write mode. If the user specifies the write mode as "jdbc" in the source configuration, the flink-connector-redshift will use custom redshift JDBC driver. This integration will enable seamless interaction with Redshift using the JDBC protocol, ensuring efficient data transfer from Flink to the Redshift database. Similarly, when the write mode is selected as a file-based operation, the flink-connector-redshift module will utilize the flink-connector-filesystem. This connector will facilitate writing data to an S3 bucket, adhering to the specific format and schema requirements outlined by Redshift's COPY command. By utilizing this connector, the flink-connector-redshift module will ensure that data is written in a manner compatible with Redshift's expectations. To provide a streamlined sink solution for Flink and Redshift integration, the flink-connector-redshift module will orchestrate and use flink-filesystem, behind the scenes. It preprocesses the data and seamlessly wraps these connectors to offer a unified sink interface for transferring data from Flink to Redshift.

Sink Connector Options

OptionRequiredDefaultTypeDescription
hostnamerequirednoneStringRedshift connection hostname
portrequired5439IntegerRedshift connection port
usernamerequirednoneStringRedshift user username
passwordrequirednoneStringRedshift user password
database-namerequireddevStringRedshift database to connect
table-namerequirednoneStringReshift table name
sink.batch-sizeoptional1000IntegerThe max flush size, over this will flush data.
sink.flush-intervaloptional1sDurationOver this flush interval mills, asynchronous threads will flush data.
sink.max-retriesoptional3IntegerThe max retry times when writing records to the database failed.
copy-moderequiredfalseBooleanUsing Redshift COPY command to insert/upsert or not.
copy-temp-s3-uriconditional requirednoneStringIf the copy-mode=true then then Redshift COPY command must need a S3 URI.
iam-role-arnconditional requirednoneStringIf the copy-mode=true then then Redshift COPY command must need a IAM role. And this role must have the privilege and attache to the Redshift cluser.

Update/Delete Data Considerations: The data is updated and deleted by the primary key.

...

      1. Flink to Redshift: The Flink connects to Redshift via JDBC using a username and password.
        Redshift does not support the use of IAM roles to authenticate this connection.
        This connection can be secured using SSL; for more details, see the Encryption section below.
      2. Flink to S3: S3 acts as a middleman to store bulk data when reading from or writing to Redshift.
        Flink connects to S3 using both the Hadoop FileSystem interfaces and directly using the Amazon Java SDK's S3 client.

        This connection can be authenticated using either AWS keys or IAM roles.
      3. Default Authentication: Flink-connector-aws provides different modes of Authentication redshift connectors will use CredentialProvider.
        AWS credentials will automatically be retrieved through the
        DefaultAWSCredentialsProviderChain.
        Users can use IAM instance roles to authenticate to S3 (e.g. on EMR, or EC2).

Proof Of Concept POC : https://github.com/Samrat002/flink-connector-aws/tree/redshift-connector

...