Github user wuchong commented on a diff in the pull request:
https://github.com/apache/flink/pull/3829#discussion_r134158670
--- Diff:
flink-libraries/flink-table/src/main/scala/org/apache/flink/table/api/StreamTableEnvironment.scala
---
@@ -132,6 +132,44 @@ abstract class StreamTableEnvironment(
}
/**
+ * Registers an external [[TableSink]] in this [[TableEnvironment]]'s
catalog.
+ * Registered sink tables can be referenced in SQL DML clause.
+ *
+ * Examples:
+ *
+ * - predefine a table sink with schema
+ * {{{
+ * val fieldTypes: Array[TypeInformation[_]] = Array( #TODO )
+ * val fieldNames: Array[String] = Array("a", "b", "c")
+ * val tableSink: TableSink = new YourTableSinkImpl(fieldTypes,
Option(fieldNames))
+ * }}}
+ *
+ * - register an alias for this table sink to catalog
+ * {{{
+ * tableEnv.registerTableSink("example_sink_table", tableSink)
+ * }}}
+ *
+ * - use the registered sink in SQL directly
+ * {{{
+ * tableEnv.sqlInsert("INSERT INTO example_sink_table SELECT a, b, c
FROM sourceTable")
+ * }}}
+ *
+ * @param name The name under which the [[TableSink]] is registered.
+ * @param tableSink The [[TableSink]] to register.
+ */
+ override def registerTableSink(name: String, tableSink: TableSink[_]):
Unit = {
+ checkValidTableName(name)
+
+ tableSink match {
+ case t @ (_: AppendStreamTableSink[_] | _: UpsertStreamTableSink[_] |
+ _: RetractStreamTableSink[_]) =>
+ registerTableInternal(name, new TableSinkTable(t))
+ case _ =>
+ throw new TableException("BatchTableSink can not be registered in
StreamTableEnvironment")
--- End diff --
There maybe more kinds of TableSink in the future. So I would suggest to
change this exception message to `Only AppendStreamTableSink,
UpsertStreamTableSink and RetractStreamTableSink can be registered in
StreamTableEnvironment`.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
