Flink 本身是批流统一的处理框架,所以 Table API 和 SQL,就是批流统一的上层处理 API。
Table API 是一套内嵌在 Java 和 Scala 语言中的查询 API,它允许我们以非常直观的方式,组合来自一些关系运算符的查询(比如 select、filter 和 join)。
Flink SQL,就是直接可以在代码中写 SQL,来实现一些查询(Query)操作。Flink 的 SQL 支持,基于实现了 SQL标准的 Apache Calcite(Apache 开源 SQL 解析工具)。
无论输入是批输入还是流式输入,在这两套 API 中,指定的查询都具有相同的语义,得到相同的结果。
Table API 和 SQL 需要引入的依赖有两个:planner 和 bridge。
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-table-planner_2.11</artifactId>
<version>1.10.0</version>
</dependency>
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-table-api-scala-bridge_2.11</artifactId>
<version>1.10.0</version>
</dependency>
flink-table-planner:planner 计划器,是 table API 最主要的部分,提供了运行时环境和
生成程序执行计划的 planner;
flink-table-api-scala-bridge:bridge 桥接器,主要负责 table API 和 DataStream/DataSet API的连接支持,按照语言分 java 和 scala。
这里的两个依赖,是 IDE 环境下运行需要添加的;如果是生产环境,lib 目录下默认已经有了 planner,就只需要有 bridge 就可以了。如果想使用用户自定义函数,或是跟 kafka 做连接,需要有一个 SQL client,这个包含在 flink-table-common 里:
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-table-common</artifactId>
<version>1.10.0</version>
<!-- <scope>provided</scope>-->
</dependency>
Table API 和 SQL 的程序结构,与流式处理的程序结构类似;也可以近似地认为有这么几步:
首先创建执行环境,然后定义 source、transform 和 sink。
具体操作流程如下:
val tableEnv = ... // 创建表的执行环境
// 创建一张表,用于读取数据
tableEnv.connect(...).createTemporaryTable("inputTable")
// 注册一张表,用于把计算结果输出
tableEnv.connect(...).createTemporaryTable("outputTable")
// 通过 Table API 查询算子,得到一张结果表
val result = tableEnv.from("inputTable").select(...)
// 通过 SQL 查询语句,得到一张结果表
val sqlResult = tableEnv.sqlQuery("SELECT ... FROM inputTable ...")
// 将结果表写入输出表中
result.insertInto("outputTable")
1.配置老版本的流式查询(Flink-Streaming-Query):
val settings = EnvironmentSettings
.newInstance()
.useOldPlanner() // 使用老版本 planner
.inStreamingMode() // 流处理模式
.build()
val tableEnv = StreamTableEnvironment.create(env, settings)
2.基于老版本的批处理环境(Flink-Batch-Query):
val batchEnv = ExecutionEnvironment.getExecutionEnvironment
val batchTableEnv = BatchTableEnvironment.create(batchEnv)
3.基于 blink 版本的流处理环境(Blink-Streaming-Query):
val bsSettings = EnvironmentSettings
.newInstance()
.useBlinkPlanner()
.inStreamingMode()
.build()
val bsTableEnv = StreamTableEnvironment.create(env, bsSettings)
4.基于 blink 版本的批处理环境(Blink-Batch-Query):
val bbSettings = EnvironmentSettings
.newInstance()
.useBlinkPlanner()
.inBatchMode().build()
val bbTableEnv = TableEnvironment.create(bbSettings)
TableEnvironment 可以注册目录 Catalog,并可以基于 Catalog 注册表。它会维护一个 Catalog-Table 表之间的 map。
表(Table)是由一个 “标识符” 来指定的,由 3 部分组成:
Catalog 名、数据库(database)名和对象名(表名)。如果没有指定目录或数据库,就使用当前的默认值。
表可以是常规的(Table,表),或者虚拟的(View,视图)。
常规表(Table)一般可以用来描述外部数据,比如文件、数据库表或消息队列的数据,也可以直接从 DataStream 转换而来。
视图可以从现有的表中创建,通常是 table API 或者 SQL 查询的一个结果。
引入依赖:
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-csv</artifactId>
<version>1.10.0</version>
</dependency>
代码:
tableEnv
.connect(new FileSystem().path("sensor.txt")) // 定义表数据来源,外部连接
.withFormat(new Csv()) // 定义从外部系统读取数据之后的格式化方法
.withSchema(
new Schema()
.field("id", DataTypes.STRING())
.field("timestamp", DataTypes.BIGINT())
.field("temperature", DataTypes.DOUBLE())
) // 定义表结构
.createTemporaryTable("inputTable") // 创建临时表
kafka 的连接器 flink-kafka-connector 中,1.10 版本的已经提供了 Table API 的
支持。我们可以在 connect 方法中直接传入一个叫做 Kafka 的类,这就是 kafka 连接器的描述器 ConnectorDescriptor。
tableEnv
.connect(
new Kafka()
.version("0.11") // 定义 kafka 的版本
.topic("sensor") // 定义主题
.property("zookeeper.connect", "localhost:2181") .property("bootstrap.servers", "localhost:9092") ).withFormat(new Csv())
.withSchema(
new Schema()
.field("id", DataTypes.STRING())
.field("timestamp", DataTypes.BIGINT())
.field("temperature", DataTypes.DOUBLE())
).createTemporaryTable("kafkaInputTable")
当然也可以连接到 ElasticSearch、MySql、HBase、Hive 等外部系统,实现方式基本上是类似的。
Flink提供了两种查询方式:Table API 和 Flink SQL
Table API 基于代表一张 “表” 的 Table 类,并提供一整套操作处理的方法 API。这些方法会返回一个新的 Table 对象,这个对象就表示对输入表应用转换操作的结果。
代码中的实现如下:
val sensorTable: Table = tableEnv.from("inputTable")
val resultTable: Table = senorTable
.select("id, temperature") .filter("id ='sensor_1'")
Flink 的 SQL 集成,基于的是 Apache Calcite,它实现了 SQL 标准。在 Flink 中,
用常规字符串来定义 SQL 查询语句。SQL 查询的结果,是一个新的 Table。
代码实现如下:
val resultSqlTable: Table = tableEnv
.sqlQuery("select id, temperature from inputTable where id ='sensor_1'")
或者:
val resultSqlTable: Table = tableEnv.sqlQuery(
"""
|select id, temperature
|from inputTable
|where id = 'sensor_1'
""".stripMargin)
统计每个 sensor 温度数据出现的个数,做个 count 统计:
Table API实现:
val aggResultTable = sensorTable
.groupBy('id)
.select('id, 'id.count as 'count)
这里 Table API 里指定的字段,前面加了一个单引号’,这是 Table API 中定义的 Expression
类型的写法,可以很方便地表示一个表中的字段。
字段可以直接全部用双引号引起来,也可以用半边单引号 + 字段名的方式
SQL 的实现:
val aggResultSqlTable = tableEnv
.sqlQuery("select id, count(id) as cnt from inputTable group by id")
基于一个 DataStream,先流式地读取数据源,然后 map 成样例类,再把它转成 Table。Table 的列字段(column fields),就是样例类里的字段
代码具体如下:
val inputStream: DataStream[String] = env.readTextFile(“sensor.txt”)
val dataStream: DataStream[SensorReading] = inputStream
.map(data => {
val dataArray = data.split(",")
SensorReading(dataArray(0), dataArray(1).toLong, dataArray(2).toDouble)
})
val sensorTable: Table = tableEnv.fromDataStream(dataStream)
val sensorTable2 = tableEnv.fromDataStream(dataStream, 'id, 'timestamp as 'ts)
数据类型与 Table schema 的对应:
基于名称的对应:
val sensorTable = tableEnv
.fromDataStream(dataStream, 'timestamp as 'ts, 'id as 'myId, 'temperature)
基于位置的对应:
val sensorTable = tableEnv
.fromDataStream(dataStream, 'myId, 'ts)
元组类型和原子类型,一般用位置对应会好一些;如果非要用名称对应,也是可以的:
元组类型,默认的名称是 “_1”, “_2”;而原子类型,默认名称是”f0”。
1.从 DataStream 转换而来。同样,可以直接对应字段转换;也可以在转换的时候,指定相应的字段。
代码如下:
tableEnv.createTemporaryView("sensorView", dataStream)
tableEnv.createTemporaryView("sensorView",
dataStream, 'id, 'temperature, 'timestamp as 'ts)
2.基于 Table 创建视图:
tableEnv.createTemporaryView("sensorView", sensorTable)
表的输出,是通过将数据写入 TableSink 来实现的。TableSink 是一个通用接口,可以支持不同的文件格式、存储数据库和消息队列。
具体实现,输出表最直接的方法,就是通过 Table.insertInto() 方法将一个 Table 写入注册过的 TableSink 中。
代码如下:
// 注册输出表
tableEnv.connect(
new FileSystem().path("…\\resources\\out.txt") ) // 定义到文件系统的连接
.withFormat(new Csv()) // 定义格式化方法,Csv 格式
.withSchema(
new Schema()
.field("id", DataTypes.STRING())
.field("temp", DataTypes.DOUBLE())
) // 定义表结构
.createTemporaryTable("outputTable") // 创建临时表
resultSqlTable.insertInto("outputTable")
对于流式查询(Streaming Queries),需要声明如何在(动态)表和外部连接器之间执行转换。
与外部系统交换的消息类型,由更新模式(update mode)指定。
Flink Table API 中的更新模式有以下三种:
除了输出到文件,也可以输出到 Kafka。我们可以结合前面 Kafka 作为输入
数据,构建数据管道,kafka 进,kafka 出。
代码如下:
// 输出到 kafka
tableEnv.connect(
new Kafka()
.version("0.11") .topic("sinkTest") .property("zookeeper.connect", "localhost:2181") .property("bootstrap.servers", "localhost:9092") ).withFormat(new Csv())
.withSchema(
new Schema()
.field("id", DataTypes.STRING())
.field("temp", DataTypes.DOUBLE())
).createTemporaryTable("kafkaOutputTable")
resultTable.insertInto("kafkaOutputTable")
ElasticSearch 的 connector 可以在 upsert(update+insert,更新插入)模式下操作,这样就可以使用 Query 定义的键(key)与外部系统交换 UPSERT/DELETE 消息。
另外,对于 “仅追加”(append-only)的查询,connector 还可以在 append 模式下操作,这样就可以与外部系统只交换 insert 消息。
es 目前支持的数据格式,只有 Json,而 flink 本身并没有对应的支持,所以还需要引入依赖:
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-json</artifactId>
<version>1.10.0</version>
</dependency>
代码实现如下:
// 输出到 es
tableEnv.connect(
new Elasticsearch()
.version("6") .host("localhost", 9200, "http") .index("sensor") .documentType("temp")
).inUpsertMode() // 指定是 Upsert 模式
.withFormat(new Json())
.withSchema(
new Schema()
.field("id", DataTypes.STRING())
.field("count", DataTypes.BIGINT())
).createTemporaryTable("esOutputTable")
aggResultTable.insertInto("esOutputTable")
Flink 专门为 Table API 的 jdbc 连接提供了 flink-jdbc 连接器,我们需要先引
入依赖:
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-jdbc_2.11</artifactId>
<version>1.10.0</version>
</dependency>
jdbc 连接的代码实现比较特殊,因为没有对应的 java/scala 类实现 ConnectorDescriptor,所以不能直接 tableEnv.connect()。不过 Flink SQL 留下了执行 DDL 的接口:tableEnv.sqlUpdate()。
对于 jdbc 的创建表操作,天生就适合直接写 DDL 来实现,所以我们的代码可以这样写:
// 输出到 Mysql
val sinkDDL: String =
"""
|create table jdbcOutputTable (
| id varchar(20) not null,
| cnt bigint not null
|) with (
| 'connector.type' = 'jdbc',
| 'connector.url' = 'jdbc:mysql://localhost:3306/test',
| 'connector.table' = 'sensor_count',
| 'connector.driver' = 'com.mysql.jdbc.Driver',
| 'connector.username' = 'root',
| 'connector.password' = '123456'
|)
""".stripMargin
tableEnv.sqlUpdate(sinkDDL)
aggResultSqlTable.insertInto("jdbcOutputTable")
表可以转换为 DataStream 或 DataSet。这样,自定义流处理或批处理程序就可以继续在 TableAPI 或 SQL 查询的结果上运行了。
将表转换为 DataStream 或 DataSet 时,需要指定生成的数据类型,即要将表的每一行转换成的数据类型。通常,最方便的转换类型就是 Row。当然,因为结果的所有字段类型都是明确的,我们也经常会用元组类型来表示。
表作为流式查询的结果,是动态更新的。所以,将这种动态查询转换成的数据流,同样需要对表的更新操作进行编码,进而有不同的转换模式。
Table API 中表到 DataStream 有两种模式:
• 追加模式(Append Mode)
用于表只会被插入(Insert)操作更改的场景。
• 撤回模式(Retract Mode)
用于任何场景。有些类似于更新模式中 Retract 模式,它只有 Insert 和 Delete 两类操作。得到的数据会增加一个 Boolean 类型的标识位(返回的第一个字段),用它来表示到底是新增的数据(Insert),还是被删除的数据(老数据,Delete)。
代码实现如下:
val resultStream: DataStream[Row] = tableEnv
.toAppendStream[Row](resultTable)
val aggResultStream: DataStream[(Boolean, (String, Long))] = tableEnv
.toRetractStream[(String, Long)](aggResultTable)
resultStream.print("result")
aggResultStream.print("aggResult")
所以,没有经过 groupby 之类聚合操作,可以直接用 toAppendStream 来转换;而如果经过了聚合,有更新操作,一般就必须用 toRetractDstream。
Table API 提供了一种机制来解释(Explain)计算表的逻辑和优化查询计划。这是通过 TableEnvironment.explain(table)方法或 TableEnvironment.explain()方法完成的。
explain 方法会返回一个字符串,描述三个计划:
• 未优化的逻辑查询计划
• 优化后的逻辑查询计划
• 实际执行计划
我们可以在代码中查看执行计划:
val explaination: String = tableEnv.explain(resultTable)
println(explaination)
Query 的解释和执行过程,老 planner 和 blink planner 大体是一致的,又有所不同。整体来讲,
Query 都会表示成一个逻辑查询计划,然后分两步解释:
Table API 和 SQL,本质上还是基于关系型表的操作方式;而关系型表、关系代数,以及 SQL本身,一般是有界的,更适合批处理的场景。这就导致在进行流处理的过程中,理解会稍微复杂一些,需要引入一些特殊概念。
关系代数(主要就是指关系型数据库中的表)和 SQL,主要就是针对批处理
的,这和流处理有天生的隔阂。
因为流处理面对的数据,是连续不断的,这和关系型数据库中保存的 “表” 完全不同。所以,如果把流数据转换成 Table,然后执行类似于 table 的 select 操作,结果就不是一成不变的,而是随着新数据的到来,会不停更新。
我们可以随着新数据的到来,不停地在之前的基础上更新结果。这样得到的表,在 Flink TableAPI 概念里,就叫做 “动态表”(Dynamic Tables)。
动态表是 Flink 对流数据的 Table API 和 SQL 支持的核心概念。与表示批处理数据的静态表不同,动态表是随时间变化的。动态表可以像静态的批处理表一样进行查询,查询一个动态表会产生持续查询(Continuous Query)。连续查询永远不会终止,并会生成另一个动态表。
查询(Query)会不断更新其动态结果表,以反映其动态输入表上的更改。
下图显示了流、动态表和连续查询的关系:
流式持续查询的过程为:
为了处理带有关系查询的流,必须先将其转换为表
案例:
输入数据:用户在网站上的访问行为,数据类型(Schema)如下:
{
user: VARCHAR, // 用户名
cTime: TIMESTAMP, // 访问某个 URL 的时间戳
url: VARCHAR // 用户访问的 URL
}
下图显示了如何将访问 URL 事件流,或者叫点击事件流(左侧)转换为表(右侧)
随着插入更多的访问事件流记录,生成的表将不断增长。
持续查询,会在动态表上做计算处理,并作为结果生成新的动态表。与批处理查询不同,连续查询从不终止,并根据输入表上的更新更新其结果表。
案例:对点击事件流中的一个持续查询。
分组聚合做 count 统计的查询,将用户字段上的 clicks 表分组,并统计访问的 url 数。
图中显示了随着时间的推移,当 clicks 表被其他行更新时如何计算查询。
与常规的数据库表一样,动态表可以通过插入(Insert)、更新(Update)和删除(Delete)更改,进行持续的修改。将动态表转换为流或将其写入外部系统时,需要
对这些更改进行编码。Flink 的 Table API 和 SQL 支持三种方式对动态表的更改进行编码:
基于时间的操作(比如 Table API 和 SQL 中窗口操作),需要定义相关的时间语义和时间数据来源的信息。所以,Table 可以提供一个逻辑上的时间字段,用于在表处理程序中,指示时间和访问相应的时间戳。
时间属性,可以是每个表 schema 的一部分。一旦定义了时间属性,它就可以作为一个字段引用,并且可以在基于时间的操作中使用。
时间属性的行为类似于常规时间戳,可以访问,并且进行计算。
定义处理时间属性有三种方法:
1.在 DataStream 转化时直接指定
2.在定义 Table Schema 时指定
3.在创建表的 DDL 中指定
注意,这个 proctime 属性只能通过附加逻辑字段,来扩展物理 schema。因此,只能在 schema定义的末尾定义它
代码如下:
// 定义好 DataStream
val inputStream: DataStream[String] = env.readTextFile("\\sensor.txt")
val dataStream: DataStream[SensorReading] = inputStream
.map(data => {
val dataArray = data.split(",")
SensorReading(dataArray(0), dataArray(1).toLong, dataArray(2).toDouble)
})
// 将 DataStream 转换为 Table,并指定时间字段
val sensorTable = tableEnv
.fromDataStream(dataStream, 'id, 'temperature, 'timestamp, 'pt.proctime)
代码如下:
tableEnv
.connect(
new FileSystem().path("..\\sensor.txt"))
.withFormat(new Csv())
.withSchema(
new Schema()
.field("id", DataTypes.STRING())
.field("timestamp", DataTypes.BIGINT())
.field("temperature", DataTypes.DOUBLE())
.field("pt", DataTypes.TIMESTAMP(3))
.proctime() // 指定 pt 字段为处理时间
) // 定义表结构
.createTemporaryTable("inputTable") // 创建临时表
代码如下:
val sinkDDL: String =
"""
|create table dataTable (
| id varchar(20) not null,
| ts bigint,
| temperature double,
| pt AS PROCTIME()
|) with (
| 'connector.type' = 'filesystem',
| 'connector.path' = 'file:///D:\\..\\sensor.txt',
| 'format.type' = 'csv'
|)
""".stripMargin
tableEnv.sqlUpdate(sinkDDL) // 执行 DDL
注意:运行这段 DDL,必须使用 Blink Planner。
事件时间语义,允许表处理程序根据每个记录中包含的时间生成结果。这样即使在有乱序事件或者延迟事件时,也可以获得正确的结果。
为了处理无序事件,并区分流中的准时和迟到事件;Flink 需要从事件数据中,提取时间戳,并用来推进事件时间的进展(watermark)
代码如下:
val inputStream: DataStream[String] = env.readTextFile("\\sensor.txt")
val dataStream: DataStream[SensorReading] = inputStream
.map(data => {
val dataArray = data.split(",")
SensorReading(dataArray(0), dataArray(1).toLong, dataArray(2).toDouble)
})
.assignAscendingTimestamps(_.timestamp * 1000L)
// 将 DataStream 转换为 Table,并指定时间字段
val sensorTable = tableEnv
.fromDataStream(dataStream, 'id, 'timestamp.rowtime, 'temperature)
// 或者,直接追加字段
val sensorTable2 = tableEnv
.fromDataStream(dataStream, 'id, 'temperature, 'timestamp, 'rt.rowtime)
代码如下:
tableEnv
.connect(new FileSystem().path("sensor.txt"))
.withFormat(new Csv())
.withSchema(
new Schema()
.field("id", DataTypes.STRING())
.field("timestamp", DataTypes.BIGINT())
.rowtime(
new Rowtime()
.timestampsFromField("timestamp") // 从字段中提取时间戳
.watermarksPeriodicBounded(1000) // watermark 延迟 1 秒 ).field("temperature", DataTypes.DOUBLE())
) // 定义表结构
.createTemporaryTable("inputTable") // 创建临时表
代码如下:
val sinkDDL: String =
"""
|create table dataTable (
目录 184
| id varchar(20) not null,
| ts bigint,
| temperature double,
| rt AS TO_TIMESTAMP( FROM_UNIXTIME(ts) ),
| watermark for rt as rt - interval '1' second
|) with (
| 'connector.type' = 'filesystem',
| 'connector.path' = 'file:///D:\\..\\sensor.txt',
| 'format.type' = 'csv'
|)
""".stripMargin
tableEnv.sqlUpdate(sinkDDL) // 执行 DDL
这里 FROM_UNIXTIME 是系统内置的时间函数,用来将一个整数(秒数)转换成 “YYYY-MM-DD hh:mm:ss” 格式(默认,也可以作为第二个 String 参数传入)的日期时间字符串(datetime string);然后再用 TO_TIMESTAMP 将其转换成 Timestamp。
时间语义,要配合窗口操作才能发挥作用。最主要的用途就是开窗口、根据时间段做计算了。
在 Table API 和 SQL 中,主要有两种窗口:Group Windows 和 Over Windows
分组窗口(Group Windows)会根据时间或行计数间隔,将行聚合到有限的组(Group)中,并对每个组的数据执行一次聚合函数。
Table API 中的 Group Windows 都是使用.window(w:GroupWindow)子句定义的,并且必须由 as 子句指定一个别名。为了按窗口对表进行分组,窗口的别名必须在 group by 子句中,像常规的分组字段一样引用。
val table = input
.window([w: GroupWindow] as 'w) // 定义窗口,别名 w .groupBy('w, 'a) // 以属性 a 和窗口 w 作为分组的 key
.select('a, 'b.sum) // 聚合字段 b 的值,求和
或者,还可以把窗口的相关信息,作为字段添加到结果表中:
val table = input
.window([w: GroupWindow] as 'w)
.groupBy('w, 'a)
.select('a, 'w.start, 'w.end, 'w.rowtime, 'b.count)
Table API 支持的窗口定义,主要也是三种:滚动(Tumbling)、滑动(Sliding)和会话(Session)
滚动窗口(Tumbling windows)要用 Tumble 类来定义,另外还有三个方法:
• over:定义窗口长度
• on:用来分组(按时间间隔)或者排序(按行数)的时间字段
• as:别名,必须出现在后面的 groupBy 中
代码如下:
// Tumbling Event-time Window(事件时间字段 rowtime)
.window(Tumble over 10.minutes on 'rowtime as 'w)
// Tumbling Processing-time Window(处理时间字段 proctime)
.window(Tumble over 10.minutes on 'proctime as 'w)
// Tumbling Row-count Window (类似于计数窗口,按处理时间排序,10 行一组)
.window(Tumble over 10.rows on 'proctime as 'w)
滑动窗口(Sliding windows)要用 Slide 类来定义,另外还有四个方法:
• over:定义窗口长度
• every:定义滑动步长
• on:用来分组(按时间间隔)或者排序(按行数)的时间字段
• as:别名,必须出现在后面的 groupBy 中
代码如下:
// Sliding Event-time Window
.window(Slide over 10.minutes every 5.minutes on 'rowtime as 'w)
// Sliding Processing-time window
.window(Slide over 10.minutes every 5.minutes on 'proctime as 'w)
// Sliding Row-count window
.window(Slide over 10.rows every 5.rows on 'proctime as 'w)
会话窗口(Session windows)要用 Session 类来定义,另外还有三个方法:
• withGap:会话时间间隔
• on:用来分组(按时间间隔)或者排序(按行数)的时间字段
• as:别名,必须出现在后面的 groupBy 中
代码如下:
// Session Event-time Window
.window(Session withGap 10.minutes on 'rowtime as 'w)
// Session Processing-time Window
.window(Session withGap 10.minutes on 'proctime as 'w)
Over window 聚合是标准 SQL 中已有的(Over 子句),可以在查询的 SELECT 子句中定义。Over window 聚合,会针对每个输入行,计算相邻行范围内的聚合。Over windows 使 用.window(w:overwindows*)子句定义,并在 select() 方法中通过别名来引用。
val table = input
.window([w: OverWindow] as 'w)
.select('a, 'b.sum over 'w, 'c.min over 'w)
Table API 提供了 Over 类,来配置 Over 窗口的属性。可以在事件时间或处理时间,以及指定为时间间隔、或行计数的范围内,定义 Over windows。
无界的 over window 是使用常量指定的。也就是说,时间间隔要指定 UNBOUNDED_RANGE,
或者行计数间隔要指定 UNBOUNDED_ROW。
而有界的 over window 是用间隔的大小指定
的。
实际代码应用如下:
1. 无界的 over window
// 无界的事件时间 over window (时间字段 "rowtime")
.window(Over partitionBy 'a orderBy 'rowtime preceding UNBOUNDED_RANGE as 'w)
//无界的处理时间 over window (时间字段"proctime")
.window(Over partitionBy 'a orderBy 'proctime preceding UNBOUNDED_RANGE as 'w)
// 无界的事件时间 Row-count over window (时间字段 "rowtime")
.window(Over partitionBy 'a orderBy 'rowtime preceding UNBOUNDED_ROW as 'w)
//无界的处理时间 Row-count over window (时间字段 "rowtime")
.window(Over partitionBy 'a orderBy 'proctime preceding UNBOUNDED_ROW as 'w)
2. 有界的 over window
// 有界的事件时间 over window (时间字段 "rowtime",之前 1 分钟)
.window(Over partitionBy 'a orderBy 'rowtime preceding 1.minutes as 'w)
// 有界的处理时间 over window (时间字段 "rowtime",之前 1 分钟)
.window(Over partitionBy 'a orderBy 'proctime preceding 1.minutes as 'w)
// 有界的事件时间 Row-count over window (时间字段 "rowtime",之前 10 行)
.window(Over partitionBy 'a orderBy 'rowtime preceding 10.rows as 'w)
// 有界的处理时间 Row-count over window (时间字段 "rowtime",之前 10 行)
.window(Over partitionBy 'a orderBy 'proctime preceding 10.rows as 'w)
Group Windows 在 SQL 查询的 Group BY 子句中定义。与使用常规 GROUP BY 子句的查询一样,使用 GROUP BY 子句的查询会计算每个组的单个结果行。
SQL 支持以下 Group 窗口函数:
另外还有一些辅助函数,可以用来选择 Group Window 的开始和结束时间戳,以及时间属性。
这里只写 TUMBLE_,滑动和会话窗口是类似的(HOP_,SESSION_*)。
• TUMBLE_START(time_attr, interval)
• TUMBLE_END(time_attr, interval)
• TUMBLE_ROWTIME(time_attr, interval)
• TUMBLE_PROCTIME(time_attr, interval)
由于 Over 本来就是 SQL 内置支持的语法,所以这在 SQL 中属于基本的聚合操作。所有聚合必须在同一窗口上定义,也就是说,必须是相同的分区、排序和范围。目前仅支持在当前行范围之前的窗口(无边界和有边界)。
注意,ORDER BY 必须在单一的时间属性上指定。
代码如下:
SELECT COUNT(amount) OVER (
PARTITION BY user
ORDER BY proctime
ROWS BETWEEN 2 PRECEDING AND CURRENT ROW)
FROM Orders
// 也可以做多个聚合
SELECT COUNT(amount) OVER w, SUM(amount) OVER w
FROM Orders
WINDOW w AS (
PARTITION BY user
ORDER BY proctime
ROWS BETWEEN 2 PRECEDING AND CURRENT ROW)
import com.jaffe.day02.SensorSource
import org.apache.flink.streaming.api.TimeCharacteristic
import org.apache.flink.streaming.api.scala.StreamExecutionEnvironment
import org.apache.flink.table.api.scala._
import org.apache.flink.api.scala._
import org.apache.flink.table.api.{EnvironmentSettings, Tumble}
/**
* @Author jaffe
* @Date 2020/06/19 10:33
*/
object CountTempByTableApi {
def main(args: Array[String]): Unit = {
val env = StreamExecutionEnvironment.getExecutionEnvironment
env.setParallelism(1)
env.setStreamTimeCharacteristic(TimeCharacteristic.EventTime)
val stream = env
.addSource(new SensorSource)
.assignAscendingTimestamps(_.timestamp)
// 表相关代码
val settings = EnvironmentSettings
.newInstance()
.useBlinkPlanner()
.inStreamingMode()
.build()
val tableEnv = StreamTableEnvironment.create(env, settings)
// 将流转换成动态表
val dataTable = tableEnv
.fromDataStream(stream, 'id, 'timestamp.rowtime as 'ts, 'temperature as 'temp)
.window(Tumble over 10.seconds on 'ts as 'w)
.groupBy('id, 'w) // keyby.timeWindow
.select('id, 'id.count) // 每个窗口有多少条数据
// 将动态表转换成流
dataTable
.toRetractStream[(String, Long)] // `id, id.count`; 撤回流
.print()
env.execute()
}
}
import com.jaffe.day02.SensorSource
import org.apache.flink.streaming.api.TimeCharacteristic
import org.apache.flink.streaming.api.scala.StreamExecutionEnvironment
import org.apache.flink.table.api.scala._
import org.apache.flink.api.scala._
import org.apache.flink.table.api.EnvironmentSettings
/**
* @Author jaffe
* @Date 2020/06/19 10:34
*/
object CountTempBySQL {
def main(args: Array[String]): Unit = {
val env = StreamExecutionEnvironment.getExecutionEnvironment
env.setParallelism(1)
env.setStreamTimeCharacteristic(TimeCharacteristic.EventTime)
val stream = env
.addSource(new SensorSource)
.assignAscendingTimestamps(_.timestamp)
val settings = EnvironmentSettings
.newInstance()
.useBlinkPlanner()
.inStreamingMode()
.build()
// 表相关代码
val tableEnv = StreamTableEnvironment.create(env, settings)
// 将流转换成动态表
val dataTable = tableEnv
.fromDataStream(stream, 'id, 'timestamp.rowtime as 'ts, 'temperature as 'temp)
// 将动态表转换成流
tableEnv
.sqlQuery("SELECT id, COUNT(id) FROM " + dataTable + " GROUP BY id, TUMBLE(ts, INTERVAL '10' SECOND)")
.toRetractStream[(String, Long)] // `id, id.count`; 撤回流
.print()
env.execute()
}
}
Flink Table 和 SQL 内置了很多 SQL 中支持的函数;如果有无法满足的需要,则可以实现用户自定义的函数(UDF)来解决。
比较函数
SQL:
value1 = value2
value1 > value2
Table API:
ANY1 === ANY2
ANY1 > ANY2
逻辑函数
SQL:
boolean1 OR boolean2
boolean IS FALSE
NOT boolean
Table API:
BOOLEAN1 || BOOLEAN2
BOOLEAN.isFalse
!BOOLEAN
算术函数
SQL:
numeric1 + numeric2
POWER(numeric1, numeric2)
Table API:
NUMERIC1 + NUMERIC2
NUMERIC1.power(NUMERIC2)
字符串函数
SQL:
string1 || string2
UPPER(string)
CHAR_LENGTH(string)
Table API:
STRING1 + STRING2
STRING.upperCase()
STRING.charLength()
时间函数
SQL:
DATE string
TIMESTAMP string
CURRENT_TIME
INTERVAL string range
Table API:
STRING.toDate
STRING.toTimestamp
currentTime()
NUMERIC.days
NUMERIC.minutes
聚合函数
SQL:
COUNT(*)
SUM([ ALL | DISTINCT ] expression)
RANK()
ROW_NUMBER()
Table API:
FIELD.count
FIELD.sum0
用户定义函数(User-defined Functions,UDF)是一个重要的特性,因为它们显著地扩展了查询(Query)的表达能力。一些系统内置函数无法解决的需求,我们可以用 UDF 来自定义实现。
函数通过调用 registerFunction()方法在 TableEnvironment 中注册。当用户定义的函数被注册时,它被插入到 TableEnvironment 的函数目录中,这样 Table API 或 SQL 解析器就可以识别并正确地解释它。
用户定义的标量函数,可以将 0、1 或多个标量值,映射到新的标量值。
为了定义标量函数,必须在 org.apache.flink.table.functions 中扩展基类 Scalar Function,并实现(一个或多个)求值(evaluation,eval)方法。标量函数的行为由求值方法决定,求值方法必须公开声明并命名为 eval(直接 def 声明,没有 override)。求值方法的参数类型和返回类型,确定了标量函数的参数和返回类型。
在下面的代码中,我们定义自己的 HashCode 函数,在 TableEnvironment 中注册它,并在查询中调用它
import com.jaffe.day02.SensorSource
import org.apache.flink.streaming.api.TimeCharacteristic
import org.apache.flink.streaming.api.scala.StreamExecutionEnvironment
import org.apache.flink.table.api.EnvironmentSettings
import org.apache.flink.table.api.scala._
import org.apache.flink.api.scala._
import org.apache.flink.table.functions.ScalarFunction
/**
* @Author jaffe
* @Date 2020/06/19 11:49
*/
object ScalarFunctionExample {
def main(args: Array[String]): Unit = {
val env = StreamExecutionEnvironment.getExecutionEnvironment
env.setParallelism(1)
env.setStreamTimeCharacteristic(TimeCharacteristic.EventTime)
val stream = env
.addSource(new SensorSource)
.assignAscendingTimestamps(_.timestamp)
// 表相关代码
val settings = EnvironmentSettings
.newInstance()
.useBlinkPlanner()
.inStreamingMode()
.build()
val tableEnv = StreamTableEnvironment.create(env, settings)
val hashCode = new HashCode(10)
// 将流转换成动态表
val dataTable = tableEnv
.fromDataStream(stream,'id,'timestamp.rowtime as 'ts,'temperature as 'temp)
dataTable
.select('id,hashCode('id))
.toAppendStream[(String,Int)]
// .print()
// 注册udf函数
tableEnv.registerFunction("hashCode",new HashCode(10))
tableEnv
.sqlQuery("SELECT id, hashCode(id) FROM " + dataTable)
.toAppendStream[(String, Int)]
.print()
env.execute()
}
class HashCode(val factor:Int) extends ScalarFunction{
def eval(s:String):Int = {
s.hashCode * factor
}
}
}
与用户定义的标量函数类似,用户定义的表函数,可以将 0、1或多个标量值作为输入参数;与标量函数不同的是,它可以返回任意数量的行作为输出,而不是单个值。
为了定义一个表函数,必须扩展 org.apache.flink.table.functions 中的基类 TableFunction 并实现(一个或多个)求值方法。表函数的行为由其求值方法决定,求值方法必须是 public 的,并命名为 eval。求值方法的参数类型,决定表函数的所有有效参数。
返回表的类型由 TableFunction 的泛型类型确定。求值方法使用 protected collect(T)方法发出输出行。
在 Table API 中,Table 函数需要与.joinLateral 或.leftOuterJoinLateral 一起使用。
joinLateral 算子,会将外部表中的每一行,与表函数(TableFunction,算子的参数是它的表达式)计算得到的所有行连接起来。
而 leftOuterJoinLateral 算子,则是左外连接,它同样会将外部表中的每一行与表函数计算生成的所有行连接起来;并且,对于表函数返回的是空表的外部行,也要保留下来。
在 SQL 中,则需要使用 Lateral Table(),或者带有 ON TRUE 条件的左连接。
下面的代码中,我们将定义一个表函数,在表环境中注册它,并在查询中调用它。
自定义 TableFunction:
import org.apache.flink.streaming.api.scala.StreamExecutionEnvironment
import org.apache.flink.table.api.scala._
import org.apache.flink.api.scala._
import org.apache.flink.streaming.api.TimeCharacteristic
import org.apache.flink.table.api.EnvironmentSettings
import org.apache.flink.table.functions.TableFunction
import org.apache.flink.types.Row
/**
* @Author jaffe
* @Date 2020/06/19 13:50
*/
object TableFunctionExample {
def main(args: Array[String]): Unit = {
val env = StreamExecutionEnvironment.getExecutionEnvironment
env.setParallelism(1)
env.setStreamTimeCharacteristic(TimeCharacteristic.EventTime)
val stream = env
.fromElements("hello#world", "jaffe#zuoyuan")
// 表相关代码
val settings = EnvironmentSettings
.newInstance()
.useBlinkPlanner()
.inStreamingMode()
.build()
val tableEnv = StreamTableEnvironment.create(env,settings)
val split = new Split("#")
val dataTable = tableEnv.fromDataStream(stream, 's)
dataTable
.leftOuterJoinLateral(split('s) as ('word, 'length))
.select('s,'word,'length)
.toAppendStream[(String,String,Int)]
// 注册udf函数
tableEnv.registerFunction("split", new Split("#"))
tableEnv.createTemporaryView("t",dataTable)
tableEnv
.sqlQuery(
"""
|SELECT s, word, length from
| t
| LEFT JOIN LATERAL TABLE(split(s)) AS T(word, length) ON TRUE""".stripMargin
).toAppendStream[Row]
.print()
env.execute()
}
class Split(separator: String) extends TableFunction[(String,Int)]{
def eval (str:String):Unit = {
str.split(separator).foreach(word =>
collect((word,word.length)))
}
}
}
用户自定义聚合函数(User-Defined Aggregate Functions,UDAGGs)可以把一个表中的数据,聚合成一个标量值。用户定义的聚合函数,是通过继承AggregateFunction 抽象类实现的。
AggregateFunction 的工作原理如下
• 首先,它需要一个累加器,用来保存聚合中间结果的数据结构(状态)。可以通过调用
AggregateFunction 的 createAccumulator()方法创建空累加器。
• 随后,对每个输入行调用函数的 accumulate()方法来更新累加器。
• 处理完所有行后,将调用函数的 getValue()方法来计算并返回最终结果。
AggregationFunction 要求必须实现的方法:
• createAccumulator()
• accumulate()
• getValue()
除了上述方法之外,还有一些可选择实现的方法。其中一些方法,可以让系统执行查询更有效率,而另一些方法,对于某些场景是必需的。例如,如果聚合函数应用在会话窗口(session group window)的上下文中,则 merge()方法是必需的。
• retract()
• merge()
• resetAccumulator()
案例:自定义 AggregateFunction,计算一下每个 sensor 的平均温度值
import com.jaffe.day02.SensorSource
import org.apache.flink.streaming.api.scala.StreamExecutionEnvironment
import org.apache.flink.table.api.EnvironmentSettings
import org.apache.flink.table.api.scala.StreamTableEnvironment
import org.apache.flink.table.api.scala._
import org.apache.flink.api.scala._
import org.apache.flink.table.functions.AggregateFunction
import org.apache.flink.types.Row
/**
* @Author jaffe
* @Date 2020/06/19 14:41
*/
object AggregateFunctionExample {
def main(args: Array[String]): Unit = {
val env = StreamExecutionEnvironment.getExecutionEnvironment
env.setParallelism(1)
val stream = env.addSource(new SensorSource).filter(_.id.equals("sensor_1"))
val setttings = EnvironmentSettings
.newInstance()
.useBlinkPlanner()
.inStreamingMode()
.build()
val tableEnv = StreamTableEnvironment.create(env, setttings)
val table = tableEnv.fromDataStream(stream,'id,'timestamp as 'ts,'temperature as 'temp)
// 实例化udf函数
val avgTemp = new AvgTemp
table
.groupBy('id)
.aggregate(avgTemp('temp) as 'avgTemp)
.select('id,'avgTemp)
.toRetractStream[Row]
// .print()
// 使用sql的方式
// 创建临时表
tableEnv.createTemporaryView("t",table)
// 注册udf函数
tableEnv.registerFunction("avgTemp",avgTemp)
tableEnv
.sqlQuery(
"""
|SELECT id, avgTemp(temp) FROM t GROUP BY id""".stripMargin
).toRetractStream[Row]
.print()
env.execute()
}
class AvgTemp extends AggregateFunction[Double,AvgTempAcc]{
// 创建累加器
override def createAccumulator(): AvgTempAcc = new AvgTempAcc
// 累加规则
def accumulate(acc:AvgTempAcc,temp: Double) = {
acc.sum += temp
acc.count += 1
}
// 获取结果
override def getValue(acc: AvgTempAcc): Double = acc.sum / acc.count
}
class AvgTempAcc{
var sum = 0.0
var count = 0
}
}
用户定义的表聚合函数(User-Defined Table Aggregate Functions,UDTAGGs),可以把一个表中数据,聚合为具有多行和多列的结果表。这跟 AggregateFunction 非常类似,只是之前聚合结果是一个标量值,现在变成了一张表。
比如现在需要找到表中所有饮料的前 2 个最高价格,即执行 top2() 表聚合。需要检查 5 行中的每一行,得到的结果将是一个具有排序后前 2 个值的表。
用户定义的表聚合函数,是通过继承 TableAggregateFunction 抽象类来实现的。
TableAggregateFunction 的工作原理如下。
• 首先,它同样需要一个累加器(Accumulator),它是保存聚合中间结果的数据结构。通过调用 TableAggregateFunction 的 createAccumulator() 方法可以创建空累加器。
• 随后,对每个输入行调用函数的 accumulate() 方法来更新累加器。
• 处理完所有行后,将调用函数的 emitValue() 方法来计算并返回最终结果。
AggregationFunction 要求必须实现的方法:
• createAccumulator()
• accumulate()
除了上述方法之外,还有一些可选择实现的方法。
• retract()
• merge()
• resetAccumulator()
• emitValue()
• emitUpdateWithRetract()
案例:自定义 TableAggregateFunction,用来提取每个 sensor 最高的两个温度值
import com.jaffe.day02.SensorSource
import org.apache.flink.streaming.api.scala.StreamExecutionEnvironment
import org.apache.flink.table.api.EnvironmentSettings
import org.apache.flink.table.api.scala.StreamTableEnvironment
import org.apache.flink.table.api.scala._
import org.apache.flink.api.scala._
import org.apache.flink.table.functions.TableAggregateFunction
import org.apache.flink.types.Row
import org.apache.flink.util.Collector
/**
* @Author jaffe
* @Date 2020/06/19 15:02
*/
object TableAggregateFunctionExample {
def main(args: Array[String]): Unit = {
val env = StreamExecutionEnvironment.getExecutionEnvironment
env.setParallelism(1)
val stream = env.addSource(new SensorSource).filter(_.id.equals("sensor_1"))
val setttings = EnvironmentSettings
.newInstance()
.useBlinkPlanner()
.inStreamingMode()
.build()
val tableEnv = StreamTableEnvironment.create(env, setttings)
val table = tableEnv.fromDataStream(stream, 'id, 'timestamp as 'ts, 'temperature as 'temp)
val top2Temp = new Top2Temp
table
.groupBy('id)
.flatAggregate(top2Temp('temp) as ('temp,'rank))
.select('id,'temp,'rank)
.toRetractStream[Row]
.print()
env.execute()
}
class Top2TempAcc {
var highestTemp: Double = Double.MinValue
var secondHighestTemp: Double = Double.MinValue
}
class Top2Temp extends TableAggregateFunction[(Double, Int), Top2TempAcc] {
override def createAccumulator(): Top2TempAcc = new Top2TempAcc
def accumulate(acc: Top2TempAcc, temp: Double) = {
if (temp > acc.highestTemp) {
acc.secondHighestTemp = acc.highestTemp
acc.highestTemp = temp
} else if (temp > acc.secondHighestTemp) {
acc.secondHighestTemp = temp
}
}
// (Double, Int) => (温度,排名)
def emitValue(acc: Top2TempAcc, out: Collector[(Double, Int)]): Unit = {
out.collect(acc.highestTemp, 1)
out.collect(acc.secondHighestTemp, 2)
}
}
}
import java.sql.Timestamp
import com.jaffe.project.util.UserBehavior
import org.apache.flink.streaming.api.TimeCharacteristic
import org.apache.flink.streaming.api.scala.StreamExecutionEnvironment
import org.apache.flink.api.scala._
import org.apache.flink.table.api.{EnvironmentSettings, Tumble}
import org.apache.flink.table.api.scala._
object HotItemsTable {
def main(args: Array[String]): Unit = {
val env = StreamExecutionEnvironment.getExecutionEnvironment
// 有关 Blink 的配置,样板代码
val settings = EnvironmentSettings.newInstance()
.useBlinkPlanner()
.inStreamingMode()
.build()
// 创建流式表的环境
val tEnv = StreamTableEnvironment.create(env, settings)
env.setParallelism(1)
// 使用事件时间
env.setStreamTimeCharacteristic(TimeCharacteristic.EventTime)
// 过滤出 pv 事件,并抽取时间戳
val stream = env
.readTextFile("`UserBehavior.csv`的绝对路径")
.map(line => {
val arr = line.split(",")
UserBehavior(arr(0).toLong,
arr(1).toLong, arr(2).toInt, arr(3), arr(4).toLong * 1000)
})
.filter(_.behavior == "pv")
.assignAscendingTimestamps(_.timestamp)
// 从流中提取两个字段,时间戳;itemId,组成一张表
val table = tEnv.fromDataStream(stream, 'timestamp.rowtime, 'itemId)
val t = table
.window(Tumble over 60.minutes on 'timestamp as 'w) // 一小时滚动窗口
.groupBy('itemId, 'w) // 根据 itemId 和窗口进行分组
.aggregate('itemId.count as 'icount) // 对 itemId 进行计数
.select('itemId, 'icount, 'w.end as 'windowEnd) // 查询三个字段
.toAppendStream[(Long, Long, Timestamp)] // 转换成 DataStream
// 创建临时表
tEnv.createTemporaryView("topn", t, 'itemId, 'icount, 'windowEnd)
// topN 查询,Blink 支持的特性
val result = tEnv.sqlQuery(
"""
|SELECT *
|FROM (
| SELECT *,
| ROW_NUMBER() OVER
| (PARTITION BY windowEnd ORDER BY icount DESC) as row_num
| FROM topn)
|WHERE row_num <= 5
|""".stripMargin
)
// 使用 toRetractStream 转换成 DataStream,用来实时更新排行榜
// true 代表 insert, false 代表 delete
result.toRetractStream[(Long, Long, Timestamp, Long)].print()
env.execute()
}
}
import org.apache.flink.streaming.api.TimeCharacteristic
import org.apache.flink.streaming.api.scala.StreamExecutionEnvironment
import org.apache.flink.table.api.{EnvironmentSettings, Tumble}
import org.apache.flink.table.api.scala.StreamTableEnvironment
import org.apache.flink.table.api.scala._
import org.apache.flink.api.scala._
import org.apache.flink.types.Row
/**
* @Author jaffe
* @Date 2020/06/20 09:29
*/
object HotItemsSQL {
case class UserBehavior(userId: Long,
itemId: Long,
categoryId: Long,
behavior: String,
timestamp: Long)
def main(args: Array[String]): Unit = {
val env = StreamExecutionEnvironment.getExecutionEnvironment
env.setStreamTimeCharacteristic(TimeCharacteristic.EventTime)
env.setParallelism(1)
// 新建表环境
val settings = EnvironmentSettings
.newInstance()
.useBlinkPlanner()
.inStreamingMode()
.build()
val tableEnv = StreamTableEnvironment.create(env, settings)
val stream = env
.readTextFile("F:\\ide\\moven\\flink0608\\src\\main\\resources\\UserBehavior.csv")
.map(line => {
val arr = line.split(",")
UserBehavior(arr(0).toLong, arr(1).toLong, arr(2).toLong, arr(3), arr(4).toLong * 1000L)
})
.filter(_.behavior.equals("pv"))
.assignAscendingTimestamps(_.timestamp) // 分配升序时间戳 DataStream
// 创建临时表
tableEnv.createTemporaryView("t", stream, 'itemId, 'timestamp.rowtime as 'ts)
// top n只有blink planner支持
// 最内部的子查询实现了:stream.keyBy(_.itemId).timeWindow(Time.hours(1), Time.minutes(5)).aggregate(new CountAgg, new WindowResult)
// 倒数第二层子查询:.keyBy(_.windowEnd).process(Sort)
// 最外层:取出前三名
var Top_num = 3
val result = tableEnv.sqlQuery(
s"""
|SELECT *
|FROM (
| SELECT * ,
| ROW_NUMBER() OVER (PARTITION BY windowEnd ORDER BY icount desc) as row_num
| FROM(
| SELECT itemId, COUNT(itemId) as icount,
| HOP_END( ts, INTERVAL '5' MINUTE, INTERVAL '1' HOUR ) as windowEnd
| FROM t GROUP BY itemId, HOP( ts, INTERVAL '5' MINUTE, INTERVAL '1' HOUR )
| )
|)
|WHERE row_num <= ${Top_num}
|""".stripMargin)
result
.toRetractStream[Row]
.filter(_._1 == true)
.print()
env.execute()
}
}