[
https://issues.apache.org/jira/browse/FLINK-3793?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15266498#comment-15266498
]
ASF GitHub Bot commented on FLINK-3793:
---------------------------------------
Github user fhueske commented on the pull request:
https://github.com/apache/flink/pull/1955#issuecomment-216221749
Thanks for this PR @vasia.
I noticed a few things:
- The docs page (`./apis/table.html`) still has the menu of the DataSet API
on the left hand side. Is it possible to remove it?
- Could you add support of `Table.orderBy()` to the table. We forgot to
update the docs when the feature was added.
- I think we should add a note to the SQL section that it is not feature
complete and only supports what the Table API supports. Hence it does not
support: Outer joins, distinct aggregates, date and decimal data types, and
more .
I have a few more suggestions:
- Overall, the documentation is quite focused on the Table API and how it
integrates with the DataSet and DataStream API. I think it would be good to
describe it as an independent API for relational stream *and* batch processing
with a good integration into the DataSet and DataStream API. Table API and SQL
should be described as equivalent APIs.
- We could move the section about table registration out of the Table API
section. It is also valid for SQL and could go into the "Using the Table API
and SQL" section (or become a top-level section itself). We could also describe
the registration as the default way to create tables and the describe the
`DataSet`/`DataStream` -> `Table` conversions of the Table API as shortcuts.
Might be easier to understand.
What do you think?
> Re-organize the Table API and SQL docs
> --------------------------------------
>
> Key: FLINK-3793
> URL: https://issues.apache.org/jira/browse/FLINK-3793
> Project: Flink
> Issue Type: Bug
> Components: Documentation, Table API
> Affects Versions: 1.1.0
> Reporter: Vasia Kalavri
> Assignee: Vasia Kalavri
>
> Now that we have added SQL and soon streaming SQL support, we need to
> reorganize the Table API documentation.
> - The current guide is under "apis/batch/libs". We should either split it
> into a streaming and a batch part or move it to under "apis". The second
> option might be preferable, as the batch and stream APIs have a lot in common.
> - The current guide has separate sections for Java and Scala APIs. These can
> be merged and organized with tabs, like other parts of the docs.
> - Mentions of "Table API" can be renamed to "Table API and SQL", e.g. in the
> software stack figure and homepage.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
