OpenMldb

OpenMldb source connector

Description

Used to read data from OpenMldb.

Key features

• batch
• stream
• exactly-once
• column projection
• parallelism
• support user-defined split

Options

name	type	required	default value	description
cluster_mode	boolean	yes	-	Whether to connect to OpenMLDB in cluster mode.
sql	string	yes	-	SQL statement to read data.
database	string	yes	-	Database name.
host	string	no	-	Required when cluster_mode is false.
port	int	no	-	Required when cluster_mode is false.
zk_host	string	no	-	Required when cluster_mode is true.
zk_path	string	no	-	Required when cluster_mode is true.
session_timeout	int	no	10000	OpenMLDB session timeout in milliseconds.
request_timeout	int	no	60000	OpenMLDB request timeout in milliseconds.
common-options		no	-	Source plugin common parameters.

cluster_mode [boolean]

Whether to connect to OpenMLDB in cluster mode. When it is false, configure host and port. When it is true, configure zk_host and zk_path.

sql [string]

Sql statement

database [string]

Database name

host [string]

OpenMldb host, only supported on OpenMldb single mode

port [int]

OpenMldb port, only supported on OpenMldb single mode

zk_host [string]

Zookeeper host, only supported on OpenMldb cluster mode

zk_path [string]

Zookeeper path, only supported on OpenMldb cluster mode

session_timeout [int]

OpenMLDB session timeout in milliseconds.

request_timeout [int]

OpenMLDB request timeout in milliseconds.

common options

Source plugin common parameters, please refer to Source Common Options for details

Example

source {
  OpenMldb {
    host = "172.17.0.2"
    port = 6527
    sql = "select * from demo_table1"
    database = "demo_db"
    cluster_mode = false
  }
}

Cluster mode example:

source {
  OpenMldb {
    zk_host = "zk-1:2181,zk-2:2181,zk-3:2181"
    zk_path = "/openmldb"
    sql = "select * from demo_table1"
    database = "demo_db"
    cluster_mode = true
  }
}

Changelog

Change Log

Change	Commit	Version
[improve] openmldb options (#9166)	https://github.com/apache/seatunnel/commit/d324fc59a4	2.3.11
[Improve][Common] Introduce new error define rule (#5793)	https://github.com/apache/seatunnel/commit/9d1b2582b2	2.3.4
[Improve][build] Give the maven module a human readable name (#4114)	https://github.com/apache/seatunnel/commit/d7cd601051	2.3.1
[Improve][Project] Code format with spotless plugin. (#4101)	https://github.com/apache/seatunnel/commit/a2ab166561	2.3.1
[Feature][Connector] add get source method to all source connector (#3846)	https://github.com/apache/seatunnel/commit/417178fb84	2.3.1
[Feature][API & Connector & Doc] add parallelism and column projection interface (#3829)	https://github.com/apache/seatunnel/commit/b9164b8ba1	2.3.1
[Hotfix][OptionRule] Fix option rule about all connectors (#3592)	https://github.com/apache/seatunnel/commit/226dc6a119	2.3.0
[Feature][Conenctor-V2] Add openmldb source connector (#3313)	https://github.com/apache/seatunnel/commit/e68ecf7bef	2.3.0