Python API 教程

在该教程中，我们会从零开始，介绍如何创建一个Flink Python项目及运行Python Table API程序。

关于Python执行环境的要求，请参考Python Table API环境安装。

创建一个Python Table API项目

首先，使用您最熟悉的IDE创建一个Python项目，然后安装PyFlink包，请参考PyFlink安装指南了解详细信息。

编写一个Flink Python Table API程序

编写Flink Python Table API程序的第一步是创建BatchTableEnvironment (或者StreamTableEnvironment，如果你要创建一个流式作业)。这是Python Table API作业的入口类。

  1. exec_env = ExecutionEnvironment.get_execution_environment()
  2. exec_env.set_parallelism(1)
  3. t_config = TableConfig()
  4. t_env = BatchTableEnvironment.create(exec_env, t_config)

ExecutionEnvironment (或者StreamExecutionEnvironment，如果你要创建一个流式作业) 可以用来设置执行参数，比如重启策略，缺省并发值等。

TableConfig可以用来设置缺省的catalog名字，自动生成代码时方法大小的阈值等.

接下来，我们将介绍如何创建源表和结果表。

  1. t_env.connect(FileSystem().path('/tmp/input')) \
  2.     .with_format(OldCsv()
  3.                  .field('word', DataTypes.STRING())) \
  4.     .with_schema(Schema()
  5.                  .field('word', DataTypes.STRING())) \
  6.     .create_temporary_table('mySource')
  8. t_env.connect(FileSystem().path('/tmp/output')) \
  9.     .with_format(OldCsv()
  10.                  .field_delimiter('\t')
  11.                  .field('word', DataTypes.STRING())
  12.                  .field('count', DataTypes.BIGINT())) \
  13.     .with_schema(Schema()
  14.                  .field('word', DataTypes.STRING())
  15.                  .field('count', DataTypes.BIGINT())) \
  16.     .create_temporary_table('mySink')

You can also use the TableEnvironment.sql_update() method to register a source/sink table defined in DDL:

  1. my_source_ddl = """
  2.     create table mySource (
  3.         word VARCHAR
  4.     ) with (
  5.         'connector.type' = 'filesystem',
  6.         'format.type' = 'csv',
  7.         'connector.path' = '/tmp/input'
  8.     )
  9. """
  11. my_sink_ddl = """
  12.     create table mySink (
  13.         word VARCHAR,
  14.         `count` BIGINT
  15.     ) with (
  16.         'connector.type' = 'filesystem',
  17.         'format.type' = 'csv',
  18.         'connector.path' = '/tmp/output'
  19.     )
  20. """
  22. t_env.sql_update(my_source_ddl)
  23. t_env.sql_update(my_sink_ddl)

上面的程序展示了如何创建及在ExecutionEnvironment中注册表名分别为mySource和mySink的表。 其中，源表mySource有一列: word，该表代表了从输入文件/tmp/input中读取的单词； 结果表mySink有两列: word和count，该表会将计算结果输出到文件/tmp/output中，字段之间使用\t作为分隔符。

接下来，我们介绍如何创建一个作业：该作业读取表mySource中的数据，进行一些变换，然后将结果写入表mySink。

  1. t_env.scan('mySource') \
  2.     .group_by('word') \
  3.     .select('word, count(1)') \
  4.     .insert_into('mySink')

最后，需要做的就是启动Flink Python Table API作业。上面所有的操作，比如创建源表 进行变换以及写入结果表的操作都只是构建作业逻辑图，只有当t_env.execute(job_name)被调用的时候， 作业才会被真正提交到集群或者本地进行执行。

  1. t_env.execute("python_job")

该教程的完整代码如下:

  1. from pyflink.dataset import ExecutionEnvironment
  2. from pyflink.table import TableConfig, DataTypes, BatchTableEnvironment
  3. from pyflink.table.descriptors import Schema, OldCsv, FileSystem
  5. exec_env = ExecutionEnvironment.get_execution_environment()
  6. exec_env.set_parallelism(1)
  7. t_config = TableConfig()
  8. t_env = BatchTableEnvironment.create(exec_env, t_config)
  10. t_env.connect(FileSystem().path('/tmp/input')) \
  11.     .with_format(OldCsv()
  12.                  .field('word', DataTypes.STRING())) \
  13.     .with_schema(Schema()
  14.                  .field('word', DataTypes.STRING())) \
  15.     .create_temporary_table('mySource')
  17. t_env.connect(FileSystem().path('/tmp/output')) \
  18.     .with_format(OldCsv()
  19.                  .field_delimiter('\t')
  20.                  .field('word', DataTypes.STRING())
  21.                  .field('count', DataTypes.BIGINT())) \
  22.     .with_schema(Schema()
  23.                  .field('word', DataTypes.STRING())
  24.                  .field('count', DataTypes.BIGINT())) \
  25.     .create_temporary_table('mySink')
  27. t_env.from_path('mySource') \
  28.     .group_by('word') \
  29.     .select('word, count(1)') \
  30.     .insert_into('mySink')
  32. t_env.execute("python_job")

执行一个Flink Python Table API程序

首先，你需要在文件 “/tmp/input” 中准备好输入数据。你可以选择通过如下命令准备输入数据：

  1. $ echo -e  "flink\npyflink\nflink" > /tmp/input

接下来，可以在命令行中运行作业（假设作业名为WordCount.py）（注意：如果输出结果文件“/tmp/output”已经存在，你需要先删除文件，否则程序将无法正确运行起来）：

  1. $ python WordCount.py

上述命令会构建Python Table API程序，并在本地mini cluster中运行。如果想将作业提交到远端集群执行， 可以参考作业提交示例。

最后，你可以通过如下命令查看你的运行结果：

  1. $ cat /tmp/output
  2. flink    2
  3. pyflink    1

上述教程介绍了如何编写并运行一个Flink Python Table API程序，如果想了解Flink Python Table API 的更多信息，可以参考Flink Python Table API文档。