[
https://issues.apache.org/jira/browse/FLINK-6745?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16032091#comment-16032091
]
ASF GitHub Bot commented on FLINK-6745:
---------------------------------------
Github user fhueske commented on a diff in the pull request:
https://github.com/apache/flink/pull/4013#discussion_r119487175
--- Diff: docs/dev/tableApi.md ---
@@ -61,21 +45,38 @@ The following dependency must be added to your project
in order to use the Table
</dependency>
{% endhighlight %}
-*Note: The Table API is currently not part of the binary distribution. See
linking with it for cluster execution [here]({{ site.baseurl
}}/dev/linking.html).*
+In addition, you need to add a dependency for either Flink's Scala batch
or streaming API. For a batch query you need to add:
+
+{% highlight xml %}
+<dependency>
+ <groupId>org.apache.flink</groupId>
+ <artifactId>flink-scala{{ site.scala_version_suffix }}</artifactId>
+ <version>{{site.version }}</version>
+</dependency>
+{% endhighlight %}
+
+For a streaming query you need to add:
+
+{% highlight xml %}
+<dependency>
+ <groupId>org.apache.flink</groupId>
+ <artifactId>flink-streaming-scala{{ site.scala_version_suffix
}}</artifactId>
+ <version>{{site.version }}</version>
+</dependency>
+{% endhighlight %}
-**TODO: Rework and add:**
-* Project dependencies (flink-table + flink-scala or flink-streaming-scala)
-* Copy `./opt/flink-table.jar` to `./lib`
+**Note:** Due to an issue in Apache Calcite, which prevents the user
classloaders from being garbage-collected, we do *not* recommend to build a
fat-jar the includes the `flink-table` dependency. Instead, we recommend to
configure Flink to include the `flink-table` dependency in the system
classloader. This can be done by copying the `flink-table.jar` file from the
`./opt` folder to the `./lib` folder. See [these instructions]({{ site.baseurl
}}/dev/linking.html) for further details.
{% top %}
Where to go next?
-----------------
-* [Concepts & Common API]({{ site.baseurl }}/dev/table/common.html): Share
concepts and API of the Table API and SQL.
-* [Table API]({{ site.baseurl }}/dev/table/tableapi.html): Supported
Operations and API for the Table API
-* [SQL]({{ site.baseurl }}/dev/table/sql.html): Supported Operations and
Syntax for SQL
-* [Table Sources & Sinks]({{ site.baseurl }}/dev/table/sourceSinks.html):
Ingestion and emission of tables.
+* [Concepts & Common API]({{ site.baseurl }}/dev/table/common.html):
Shared concepts and APIs of the Table API and SQL.
--- End diff --
I'd keep it as it is because the Table API and SQL share some parts of
their APIs which is the common API (singular) and many concepts.
> Table API / SQL Docs: Overview Page
> -----------------------------------
>
> Key: FLINK-6745
> URL: https://issues.apache.org/jira/browse/FLINK-6745
> Project: Flink
> Issue Type: Sub-task
> Components: Documentation, Table API & SQL
> Affects Versions: 1.3.0
> Reporter: Fabian Hueske
> Assignee: Fabian Hueske
>
> Update and refine ./docs/dev/tableApi.md in feature branch
> https://github.com/apache/flink/tree/tableDocs
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
