SQL客户端测试版

译者：flink.sojb.cn

Flink的Table＆SQL API可以处理用SQL语言编写的查询，但是这些查询需要嵌入在用Java或Scala编写的表程序中。而且，这些程序需要在提交到集群之前使用构建工具打包。这或多或少地限制了Flink对Java / Scala程序员的使用。

在SQL客户端旨在提供编写，调试，并提交表格程序到Flink集群的一个简单的方法没有的Java或Scala代码一行。在SQL客户端CLI允许检索和命令行中运行分布式应用可视化实时结果。

注意 SQL客户端处于早期开发阶段。即使应用程序还没有生产就绪，它可以是一个非常有用的工具，用于原型设计和Flink SQL。在未来，社区计划通过提供基于REST的SQL客户端网关来扩展其函数。

本节介绍如何从命令行设置和运行第一个Flink SQL程序。

SQL客户端捆绑在常规Flink分发中，因此可以开箱即用。它只需要一个正在运行的Flink集群，其中可以执行表程序。有关设置Flink群集的详细信息，请参阅群集和部署部分。如果您只想尝试SQL客户端，还可以使用以下命令启动具有一个worker的本地群集：

SQL客户端脚本也位于Flink的二进制目录中。将来，用户可以通过启动嵌入式独立进程或连接到远程SQL客户端网关来启动SQL Client CLI。目前仅embedded支持该模式。您可以通过调用以下命令启动CLI：

默认情况下，SQL客户端将从位于的环境文件中读取其配置./conf/sql-client-defaults.yaml。有关环境文件结构的更多信息，请参阅配置部分。

启动CLI后，您可以使用该HELP命令列出所有可用的SQL语句。要验证您的设置和群集连接，您可以输入第一个SQL查询并Enter按键执行它：

此查询不需要表源，并生成单行结果。CLI将从群集中检索结果并将其可视化。您可以通过按键关闭结果视图Q。

CLI支持两种维护和可视化结果的模式。

该表模式物化在内存中的结果和可视化他们的常客，分页表表示。可以通过在CLI中执行以下命令来启用它：

的更改日志模式不实现结果和可视化，其由所产生的结果数据流的连续查询由插入的（+）和撤消（-）。

您可以使用以下查询来查看两种结果模式：

此查询执行有界字数计数示例。

在更改日志模式下，可视化更改日志应类似于：

在表模式下，可视化结果表不断更新，直到表程序结束为：

在SQL查询的原型设计期间，两种结果模式都很有用。在这两种模式下，结果都存储在SQL客户端的Java堆内存中。为了使CLI界面保持响应，更改日志模式仅显示最新的1000个更改。表模式允许导航更大的结果，这些结果仅受可用主存储器和配置的最大行数（max-table-result-rows）的限制。

注意只能使用table结果模式检索在批处理环境中执行的查询。

定义查询后，可以将其作为长时间运行的分离Flink作业提交给集群。为此，需要使用INSERT INTO语句指定存储结果的目标系统。在配置部分解释了如何申报表源读取数据，如何申报表汇写入数据，以及如何配置其它表程序性能。

可以使用以下可选CLI命令启动SQL Client。它们将在随后的章节中详细讨论。

SQL查询需要一个执行它的配置环境。所谓的环境文件定义了可用的表源和接收器，外部目录，用户定义的函数以及执行和部署所需的其他属性。

每个环境文件都是常规的YAML文件。下面给出了这种文件的一个例子。

这个配置：

根据用例，可以将配置拆分为多个文件。因此，可以为一般用途（默认使用环境文件--defaults）以及每个会话（使用会话环境文件--environment）创建环境文件。每个CLI会话都使用默认属性进行初始化，后跟会话属性。例如，默认环境文件可以指定在每个会话中可用于查询的所有表源，而会话环境文件仅声明特定的状态保存时间和并行性。启动CLI应用程序时，可以传递默认和会话环境文件。如果未指定默认环境文件，则SQL客户端将搜索./conf/sql-client-defaults.yaml 在Flink的配置目录中。

注意在CLI会话中设置的属性（例如，使用该SET命令）具有最高优先级：

重新启动策略控制在发生故障时如何重新启动Flink作业。与Flink集群的全局重新启动策略类似，可以在环境文件中声明更细粒度的重新启动配置。

支持以下策略：

SQL客户端不需要使用Maven或SBT设置Java项目。相反，您可以将依赖项作为提交到集群的常规JAR文件传递。您可以单独指定每个JAR文件（使用--jar），也可以定义整个库目录（使用--library）。对于连接外部系统（如Apache Kafka）和相应数据格式（如JSON）的连接器，Flink提供了即用型JAR包。这些JAR文件sql-jar以Maven中央存储库的每个版本为后缀并可以下载。

可以在与外部系统页面的连接上找到提供的SQL JAR的完整列表以及有关如何使用它们的文档。

以下示例显示了一个环境文件，该文件定义从Apache Kafka读取JSON数据的表源。

生成的TaxiRide表模式包含JSON模式的大多数字段。此外，它还添加了rowtime属性rowTime和processing-time属性procTime。

双方connector并format允许定义属性的版本（这是目前版本1），为未来的向后兼容性。

SQL客户端允许用户创建要在SQL查询中使用的自定义用户定义函数。目前，这些函数仅限于在Java / Scala类中以编程方式定义。

为了提供用户定义的函数，您需要首先实现和编译扩展的函数类ScalarFunction，AggregateFunction或者TableFunction（参见用户定义的函数）。然后可以将一个或多个函数打包到SQL客户端的依赖项JAR中。

在调用之前，必须在环境文件中声明所有函数。对于列表中的每个项目functions，必须指定

确保指定参数的顺序和类型严格匹配函数类的一个构造函数。

根据用户定义的函数，可能需要在SQL语句中使用它之前参数化实现。

如前面的示例所示，在声明用户定义的函数时，可以使用以下三种方法之一使用构造函数参数来配置类：

具有隐式类型的文字值： SQL客户端将根据文字值本身自动派生类型。目前，仅值BOOLEAN，INT，DOUBLE和VARCHAR在这里的支持。如果自动派生不能按预期工作（例如，您需要VARCHAR false），请改用显式类型。

具有显式类型的文字值：使用类型安全性type和value属性显式声明参数。

下表说明了受支持的Java参数类型和相应的SQL类型字符串。

更多类型（例如，TIMESTAMP或ARRAY），原始类型，并且null尚不支持。

（嵌套）类实例：除文字值外，您还可以通过指定class和constructor属性为构造函数参数创建（嵌套）类实例。可以递归地执行此过程，直到所有构造函数参数都使用文字值表示。

为了定义端到端SQL管道，SQL INSERT INTO语句可用于向Flink集群提交长时间运行的分离查询。这些查询将结果生成到外部系统而不是SQL客户端。这允许处理更高的并行性和更大量的数据。CLI本身在提交后对分离的查询没有任何控制权。

MyTableSink必须在环境文件中声明表接收器。有关支持的外部系统及其配置的详细信息，请参阅连接页面。Apache Kafka表接收器的示例如下所示。

SQL客户端确保将语句成功提交到群集。提交查询后，CLI将显示有关Flink作业的信息。

注意 SQL Client在提交后不会跟踪正在运行的Flink作业的状态。提交后可以关闭CLI进程，而不会影响分离的查询。Flink的重启策略负责容错。可以使用Flink的Web界面，命令行或REST API取消查询。

视图允许从SQL查询定义虚拟表。视图定义将立即进行解析和验证。但是，在提交常规INSERT INTO或SELECT语句期间访问视图时会发生实际执行。

视图可以在环境文件中定义，也可以在CLI会话中定义。

以下示例显示如何在文件中定义多个视图：

与表源和接收器类似，会话环境文件中定义的视图具有最高优先级。

也可以使用以下CREATE VIEW语句在CLI会话中创建视图：

也可以使用以下DROP VIEW语句再次删除在CLI会话中创建的视图：

注意视图的定义仅限于上面提到的语法。在将来的版本中，将支持为表名中的视图或转义空格定义模式。

当前的SQL客户端实施处于非常早期的开发阶段，并且可能会在未来作为更大的Flink改进提案24（FLIP-24）的一部分进行更改。随意加入讨论，并打开有关您认为有用的错误和函数的问题。