Realtime Compute for Apache Flink:Hologres

VVR 11+

CREATE TEMPORARY TABLE test_message_src_binlog_table(
  id INTEGER,
  title VARCHAR,
  body VARCHAR
) WITH (
  'connector'='hologres',
  'dbname'='<yourDbname>',
  'tablename'='<yourTablename>',
  'username'='${secret_values.ak_id}',            -- AK/SK の漏洩を防ぐため、変数の使用を推奨します。
  'password'='${secret_values.ak_secret}',        
  'endpoint'='<yourEndpoint>',
  'source.binlog.change-log-mode'='ALL',  -- INSERT、DELETE、UPDATE_BEFORE、UPDATE_AFTER を含むすべての changeLog 型を読み取ります。
  'retry-count'='10',                     -- binlog 読み取りエラー発生時のリトライ回数。
  'retry-sleep-step-ms'='5000',           -- リトライ間の増分バックオフ時間。初回リトライは 5 秒待機、2 回目は 10 秒待機、といった具合です。
  'source.binlog.batch-size'='512'        -- binlog から一度に読み取る行数。
);

VVR 8+

CREATE TEMPORARY TABLE test_message_src_binlog_table(
  id INTEGER,
  title VARCHAR,
  body VARCHAR
) WITH (
  'connector'='hologres',
  'dbname'='<yourDbname>',
  'tablename'='<yourTablename>',
  'username' = '${secret_values.ak_id}',       -- AK/SK の漏洩を防ぐため、変数の使用を推奨します。   
  'password' = '${secret_values.ak_secret}',
  'endpoint'='<yourEndpoint>',
  'binlog' = 'true',
  'cdcMode' = 'true',
  'sdkMode'='jdbc',
  'binlogMaxRetryTimes' = '10',     -- binlog 読み取りエラー発生時のリトライ回数。
  'binlogRetryIntervalMs' = '500',  -- binlog 読み取りエラー発生後のリトライ間隔（ミリ秒単位）。
  'binlogBatchReadSize' = '100'     -- binlog から一度に読み取る行数。
);

VVR 11+

CREATE TEMPORARY TABLE test_message_src_binlog_table(
  id INTEGER,
  title VARCHAR,
  body VARCHAR
) WITH (
  'connector'='hologres',
  'dbname'='<yourDbname>',
  'tablename'='<yourTablename>',
  'username' = '${secret_values.ak_id}',       -- AK/SK の漏洩を防ぐため、変数の使用を推奨します。   
  'password' = '${secret_values.ak_secret}',
  'endpoint'='<yourEndpoint>',
  'source.binlog.change-log-mode'='ALL_AS_APPEND_ONLY',  -- すべての changelog 型を INSERT として扱います。
  'retry-count'='10',                     -- binlog 読み取りエラー発生時のリトライ回数。
  'retry-sleep-step-ms'='5000',           -- リトライ間の増分バックオフ時間。初回リトライは 5 秒待機、2 回目は 10 秒待機、といった具合です。
  'source.binlog.batch-size'='512'        -- binlog から一度に読み取る行数。
);

VVR 8+

CREATE TEMPORARY TABLE test_message_src_binlog_table(
  hg_binlog_lsn BIGINT,
  hg_binlog_event_type BIGINT,
  hg_binlog_timestamp_us BIGINT,
  id INTEGER,
  title VARCHAR,
  body VARCHAR
) WITH (
  'connector'='hologres',
  'dbname'='<yourDbname>',
  'tablename'='<yourTablename>',
  'username' = '${secret_values.ak_id}',       -- AK/SK の漏洩を防ぐため、変数の使用を推奨します。   
  'password' = '${secret_values.ak_secret}',
  'endpoint'='<yourEndpoint>',
  'binlog' = 'true',
  'binlogMaxRetryTimes' = '10',     -- binlog 読み取りエラー発生時のリトライ回数。
  'binlogRetryIntervalMs' = '500',  -- binlog 読み取りエラー発生後のリトライ間隔（ミリ秒単位）。
  'binlogBatchReadSize' = '100'     -- binlog から一度に読み取る行数。
);

VVR 11+

Hologres に、以下の DDL で定義されたパーティションテーブルが存在し、バイナリログおよび動的パーティションが有効化されていると仮定します。

CREATE TABLE "test_message_src1" (
    id int,
    title text,
    body text,
    dt text,
    PRIMARY KEY (id, dt)
)
PARTITION BY LIST (dt) WITH (
    binlog_level = 'replica', 
    auto_partitioning_enable =  'true',   -- 動的パーティションを有効化します。
    auto_partitioning_time_unit = 'DAY',  -- パーティションは日単位で作成されます。例: test_message_src1_20250512、test_message_src1_20250513。
    auto_partitioning_num_precreate = '2' -- 2 つのパーティションを事前に作成します。
);
-- 既存のパーティションテーブルに対しても、ALTER TABLE を使用して動的パーティションを有効化できます。

Flink では、以下の SQL ステートメントを使用して、test_message_src1 パーティションテーブルを DYNAMIC モードで消費します。

CREATE TEMPORARY TABLE hologres_source
(
  id INTEGER,
  title VARCHAR,
  body VARCHAR,
  dt VARCHAR  -- Hologres パーティションテーブルのパーティションカラム。
)
with (
  'connector' = 'hologres',
  'dbname' = '<yourDatabase>',
  'tablename' = 'test_message_src1',  -- 動的パーティションが有効化された Hologres テーブル。
  'username' = '<yourUserName>',
  'password' = '<yourPassword>',
  'endpoint' = '<yourEndpoint>',
  'source.binlog.partition-binlog-mode' = 'DYNAMIC', -- 最新のパーティションを動的に監視します。
  'source.binlog.startup-mode' = 'initial'           -- まずすべての既存データを読み取り、その後増分読み取りを開始します。
);

VVR 8.0.11

Hologres に、以下の DDL で定義されたパーティションテーブルが存在し、バイナリログおよび動的パーティションが有効化されていると仮定します。

CREATE TABLE "test_message_src1" (
    id int,
    title text,
    body text,
    dt text,
    PRIMARY KEY (id, dt)
)
PARTITION BY LIST (dt) WITH (
    binlog_level = 'replica', 
    auto_partitioning_enable =  'true',   -- 動的パーティションを有効化します。
    auto_partitioning_time_unit = 'DAY',  -- パーティションは日単位で作成されます。例: test_message_src1_20241027、test_message_src1_20241028。
    auto_partitioning_num_precreate = '2' -- 2 つのパーティションを事前に作成します。
);

-- 既存のパーティションテーブルに対しても、ALTER TABLE を使用して動的パーティションを有効化できます。

Flink では、以下の SQL ステートメントを使用して、test_message_src1 パーティションテーブルを DYNAMIC モードで消費します。

CREATE TEMPORARY TABLE hologres_source
(
  id INTEGER,
  title VARCHAR,
  body VARCHAR,
  dt VARCHAR  -- Hologres パーティションテーブルのパーティションカラム。
)
with (
  'connector' = 'hologres',
  'dbname' = '<yourDatabase>',
  'tablename' = 'test_message_src1',  -- 動的パーティションが有効化された Hologres テーブル。
  'username' = '<yourUserName>',
  'password' = '<yourPassword>',
  'endpoint' = '<yourEndpoint>',
  'binlog' = 'true',
  'partition-binlog.mode' = 'DYNAMIC',  -- 最新のパーティションを動的に監視します。
  'binlogstartUpMode' = 'initial',      -- まずすべての既存データを読み取り、その後増分読み取りを開始します。
  'sdkMode' = 'jdbc_fixed'              -- 接続数制限の問題を回避するためにこのモードを使用します。
);

VVR 11+

Hologres に、以下の Data Definition Language（DDL）で定義されたパーティションテーブルが存在し、バイナリログが有効化されていると仮定します。

CREATE TABLE test_message_src2 (
    id int,
    title text,
    body text,
    color text,
    PRIMARY KEY (id, color)
)
PARTITION BY LIST (color) WITH (
    binlog_level = 'replica'
);
create table test_message_src2_red partition of test_message_src2 for values in ('red');
create table test_message_src2_blue partition of test_message_src2 for values in ('blue');
create table test_message_src2_green partition of test_message_src2 for values in ('green');
create table test_message_src2_black partition of test_message_src2 for values in ('black');

Flink では、以下の SQL ステートメントを使用して、test_message_src2 パーティションテーブルを STATIC モードで消費します。

CREATE TEMPORARY TABLE hologres_source
(
  id INTEGER,
  title VARCHAR,
  body VARCHAR,
  color VARCHAR  -- Hologres パーティションテーブルのパーティションカラム。
)
with (
  'connector' = 'hologres',
  'dbname' = '<yourDatabase>',
  'tablename' = 'test_message_src2',  -- パーティションテーブル。
  'username' = '<yourUserName>',
  'password' = '<yourPassword>',
  'endpoint' = '<yourEndpoint>',
  'source.binlog.partition-binlog-mode' = 'STATIC', -- 固定のパーティションセットを読み取ります。
  'source.binlog.partition-values-to-read' = 'red,blue,green',  -- red、blue、green の 3 つのパーティションのみを読み取ります。black パーティションは読み取られません。新規パーティションも読み取られません。設定しない場合、親テーブルのすべてのパーティションが読み取られます。
  'source.binlog.startup-mode' = 'initial'  -- まずすべての既存データを読み取り、その後増分読み取りを開始します。
);

VVR 8.0.11

Hologres に、以下の DDL で定義されたパーティションテーブルが存在し、バイナリログが有効化されていると仮定します。

CREATE TABLE test_message_src2 (
    id int,
    title text,
    body text,
    color text,
    PRIMARY KEY (id, color)
)
PARTITION BY LIST (color) WITH (
    binlog_level = 'replica'
);
create table test_message_src2_red partition of test_message_src2 for values in ('red');
create table test_message_src2_blue partition of test_message_src2 for values in ('blue');
create table test_message_src2_green partition of test_message_src2 for values in ('green');
create table test_message_src2_black partition of test_message_src2 for values in ('black');

Flink では、以下の SQL ステートメントを使用して、test_message_src2 パーティションテーブルを STATIC モードで読み取ります。

CREATE TEMPORARY TABLE hologres_source
(
  id INTEGER,
  title VARCHAR,
  body VARCHAR,
  color VARCHAR  -- Hologres パーティションテーブルのパーティションカラム。
)
with (
  'connector' = 'hologres',
  'dbname' = '<yourDatabase>',
  'tablename' = 'test_message_src2',  -- パーティションテーブル。
  'username' = '<yourUserName>',
  'password' = '<yourPassword>',
  'endpoint' = '<yourEndpoint>',
  'binlog' = 'true',
  'partition-binlog.mode' = 'STATIC', -- 固定のパーティションセットを読み取ります。
  'partition-values-to-read' = 'red,blue,green',  -- red、blue、green の 3 つのパーティションのみを読み取ります。black パーティションは読み取られません。新規パーティションも読み取られません。設定しない場合、親テーブルのすべてのパーティションが読み取られます。
  'binlogstartUpMode' = 'initial',  -- まずすべての既存データを読み取り、その後増分読み取りを開始します。
  'sdkMode' = 'jdbc_fixed' -- 接続数制限の問題を回避するためにこのモードを使用します。
);

VVR 11.3+

public class Sample {                                                                                                                                                                          
        public static void main(String[] args) throws Exception {
            final StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment();
            // 読み取るテーブルのスキーマを初期化します。これは Hologres テーブルスキーマのカラムと一致する必要があります。サブセットのカラムを定義できます。
            TableSchema schema = TableSchema.builder()
                    .field("a", DataTypes.INT())
                    .field("b", DataTypes.STRING())
                    .field("c", DataTypes.TIMESTAMP())
                    .build();

            // 読み取るテーブルの名前。
            String sourceTableName = "sourceTableName";

            // Hologres コネクタオプション。
            Configuration config = new Configuration();
            config.setString(HologresConfigs.ENDPOINT, "yourEndpoint");
            config.setString(HologresConfigs.USERNAME, "yourUserName");
            config.setString(HologresConfigs.PASSWORD, "yourPassword");
            config.setString(HologresConfigs.DATABASE, "yourDatabaseName");
            config.setString(HologresConfigs.TABLE, sourceTableName);
            config.set(HologresConfigs.BINLOG, true);
            config.set(HologresConfigs.BINLOG_CHANGE_LOG_MODE, BinlogChangeLogMode.ALL);
            // HologresBinlogSource を構築します。
            HologresBinlogSource source = new HologresBinlogSource(
                    new HologresConnectionParam(config),
                    schema,
                    config,
                    StartupMode.INITIAL,
                    sourceTableName,
                    "",
                    Collections.emptyList(),
                    -1,
                    Collections.emptySet(),
                    Collections.emptyList()
            );
            env.fromSource(source, WatermarkStrategy.noWatermarks(), "Test source").print();
            env.execute();
        }
  }

VVR 8.0.11+

public class Sample {
    public static void main(String[] args) throws Exception {
        final StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment();
        // 読み取るテーブルのスキーマを初期化します。これは Hologres テーブルスキーマのカラムと一致する必要があります。サブセットのカラムを定義できます。
        TableSchema schema = TableSchema.builder()
                .field("a", DataTypes.INT())
                .field("b", DataTypes.STRING())
                .field("c", DataTypes.TIMESTAMP())
                .build();
        // Hologres コネクタオプション。
        Configuration config = new Configuration();
        config.setString(HologresConfigs.ENDPOINT, "yourEndpoint");
        config.setString(HologresConfigs.USERNAME, "yourUserName");
        config.setString(HologresConfigs.PASSWORD, "yourPassword");
        config.setString(HologresConfigs.DATABASE, "yourDatabaseName");
        config.setString(HologresConfigs.TABLE, "yourTableName");
        config.setString(HologresConfigs.SDK_MODE, "jdbc");
        config.setBoolean(HologresBinlogConfigs.OPTIONAL_BINLOG, true);
        config.setBoolean(HologresBinlogConfigs.BINLOG_CDC_MODE, true);
        // JDBCOptions を構築します。
        JDBCOptions jdbcOptions = JDBCUtils.getJDBCOptions(config);
        // HologresBinlogSource を構築します。
        long startTimeMs = 0;
        HologresBinlogSource source = new HologresBinlogSource(
                new HologresConnectionParam(config),
                schema,
                config,
                jdbcOptions,
                startTimeMs,
                StartupMode.INITIAL,
                "",
                "",
                -1,
                Collections.emptySet(),
                new ArrayList<>()
        );
        env.fromSource(source, WatermarkStrategy.noWatermarks(), "Test source").print();
        env.execute();
    }
}

VVR 8.0.7+

public class Sample {
    public static void main(String[] args) throws Exception {
        final StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment();
        // 読み取るテーブルのスキーマを初期化します。これは Hologres テーブルスキーマのカラムと一致する必要があります。サブセットのカラムを定義できます。
        TableSchema schema = TableSchema.builder()
                .field("a", DataTypes.INT())
                .field("b", DataTypes.STRING())
                .field("c", DataTypes.TIMESTAMP())
                .build();
        // Hologres コネクタオプション。
        Configuration config = new Configuration();
        config.setString(HologresConfigs.ENDPOINT, "yourEndpoint");
        config.setString(HologresConfigs.USERNAME, "yourUserName");
        config.setString(HologresConfigs.PASSWORD, "yourPassword");
        config.setString(HologresConfigs.DATABASE, "yourDatabaseName");
        config.setString(HologresConfigs.TABLE, "yourTableName");
        config.setString(HologresConfigs.SDK_MODE, "jdbc");
        config.setBoolean(HologresBinlogConfigs.OPTIONAL_BINLOG, true);
        config.setBoolean(HologresBinlogConfigs.BINLOG_CDC_MODE, true);
        // JDBCOptions を構築します。
        JDBCOptions jdbcOptions = JDBCUtils.getJDBCOptions(config);
        // HologresBinlogSource を構築します。
        long startTimeMs = 0;
        HologresBinlogSource source = new HologresBinlogSource(
                new HologresConnectionParam(config),
                schema,
                config,
                jdbcOptions,
                startTimeMs,
                StartupMode.INITIAL,
                "",
                "",
                -1,
                Collections.emptySet()
        );
        env.fromSource(source, WatermarkStrategy.noWatermarks(), "Test source").print();
        env.execute();
    }
}

VVR 6.0.7+

public class Sample {
    public static void main(String[] args) throws Exception {
        final StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment();
        // 読み取るテーブルのスキーマを初期化します。これは Hologres テーブルスキーマのカラムと一致する必要があります。サブセットのカラムを定義できます。
        TableSchema schema = TableSchema.builder()
                .field("a", DataTypes.INT())
                .build();
         // Hologres コネクタオプション。
        Configuration config = new Configuration();
        config.setString(HologresConfigs.ENDPOINT, "yourEndpoint");
        config.setString(HologresConfigs.USERNAME, "yourUserName");
        config.setString(HologresConfigs.PASSWORD, "yourPassword");
        config.setString(HologresConfigs.DATABASE, "yourDatabaseName");
        config.setString(HologresConfigs.TABLE, "yourTableName");
        config.setString(HologresConfigs.SDK_MODE, "jdbc");
        config.setBoolean(HologresBinlogConfigs.OPTIONAL_BINLOG, true);
        config.setBoolean(HologresBinlogConfigs.BINLOG_CDC_MODE, true);
        // JDBCOptions を構築します。
        JDBCOptions jdbcOptions = JDBCUtils.getJDBCOptions(config);
        // 既定のスロット名を設定または作成します。
        config.setString(HologresBinlogConfigs.JDBC_BINLOG_SLOT_NAME, HoloBinlogUtil.getOrCreateDefaultSlotForJDBCBinlog(jdbcOptions));

        boolean cdcMode = config.get(HologresBinlogConfigs.BINLOG_CDC_MODE) && config.get(HologresBinlogConfigs.OPTIONAL_BINLOG);
        // JDBCBinlogRecordConverter を構築します。
        JDBCBinlogRecordConverter recordConverter = new JDBCBinlogRecordConverter(
                jdbcOptions.getTable(),
                schema,
                new HologresConnectionParam(config),
                cdcMode,
                Collections.emptySet());
        
        // HologresBinlogSource を構築します。
        long startTimeMs = 0;
        HologresJDBCBinlogSource source = new HologresJDBCBinlogSource(
                new HologresConnectionParam(config),
                schema,
                config,
                jdbcOptions,
                startTimeMs,
                StartupMode.TIMESTAMP,
                recordConverter,
                "",
                -1);
        env.fromSource(source, WatermarkStrategy.noWatermarks(), "Test source").print();
        env.execute();
    }
}