flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sunjincheng121 <...@git.apache.org>
Subject [GitHub] flink pull request #4012: [FLINK-6746] [docs] Updated Table API / SQL docs: ...
Date Tue, 30 May 2017 12:07:43 GMT
Github user sunjincheng121 commented on a diff in the pull request:

    https://github.com/apache/flink/pull/4012#discussion_r119071180
  
    --- Diff: docs/dev/table/common.md ---
    @@ -98,374 +89,767 @@ env.execute("Your Query")
     </div>
     </div>
     
    +**Note:** Table API and SQL queries can be easily integrated with and embedded into DataStream
or DataSet programs. Have a look a the [Integration with DataStream and DataSet API](#integration-with-datastream-and-dataset-api)
section to learn how DataStreams and DataSets can be converted into Tables and vice versa.
    +
     {% top %}
     
     Create a TableEnvironment
     -------------------------
     
    -A `Table` is always bound to a specific `TableEnvironment`. It is not possible to combine
Tables of different TableEnvironments.
    +The `TableEnvironment` is a central concept of the Table API and SQL integration. It
is responsible for:
    +* Registering a `Table` in the internal catalog
    +* Registering an external catalog 
    +* Executing SQL queries
    +* Registering a user-defined (scalar, table, or aggregation) function
    +* Converting a `DataStream` or `DataSet` into a `Table`
    +* Holding a reference to an `ExecutionEnvironment` or `StreamExecutionEnvironment`
    +
    +A `Table` is always bound to a specific `TableEnvironment`. It is not process tables
of different TableEnvironments in the same query, e.g., to join or union them.
    +
    +A `TableEnvironment` is created by calling the static `TableEnvironment.getTableEnvironment()`
method with a `StreamExecutionEnvironment` or an `ExecutionEnvironment` and an optional `TableConfig`.
The `TableConfig` can be used to configure the `TableEnvironment` or to customize the query
optimization and translation process (see [Query Optimization](#query-optimization)).
     
    -**TODO: Extend**
    +<div class="codetabs" markdown="1">
    +<div data-lang="java" markdown="1">
    +{% highlight java %}
    +// ***************
    +// STREAMING QUERY
    +// ***************
    --- End diff --
    
    Do we need uniform annotation style?
    In this doc sometime use `// For batch programs ...` sometime use 
    ```
    // ***************
     // STREAMING QUERY
     // ***************
    ```
    When user see the doc will feeling a bit strange. What do you think?


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message