Versions Compared

Old Version 1

changes.mady.by.user Jincheng Sun

Saved on

compared with

New Version Current

changes.mady.by.user Chesnay Schepler

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Authors: Wei Zhong, Jincheng Sun

Status

Current state: [Under Discussion]

...

Page properties


Discussion threadhttps://lists.apache.org/thread/1c2q89dr4pc7xhn9jbrjkxltx2r2b5tr
Vote threadhttps://

...

lists.apache.org/

...

thread/38n2opdp5ot8s4qz5grzfc2dylrmtx0r
JIRA

...

Jira
serverASF JIRA
serverId5aa69414-a9e9-3523-82ec-879b028fb15b
keyFLINK-18775

...

Release1.12


Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).

...

          That is, add a "Python API" section at the same level of "DataStream API", "DataSet API" and "Table API & SQL". We hope to have a unified entry for all PyFlink documentation, which includes         includes   Python  Table API and Python DataStream API. So that Python users don’t need to dive into the ocean of Java documentation to find the Python part.

  • Restructure current Python documentation to a brand new structure to ensure complete content and friendly to beginners

           Please Please see the next section for detailed structure and description.

...

Proposed Changes

Top-Level Structure

</> Application Development

     DataStream API                        ▾

     DataSet API                              ▾

     Table API & SQL                       

     Python API                               ▾ (newly added)

     Data Types & Serialization        ▾

     Managing Execution                  ▾

     API Migration Guides

Python API Document Structure


  1. OverView
  2. Getting Started
    1. Installation
    2. Tutorial
      1. Table API
      2. DataStream API
  • Installation
    • Tutorial
    1. User Guide
      1. Table API
        1. 10 minutes to Table API
        2. TableEnvironment
        3. DataTypes
        4. Operations
        5. Expression Syntax
        6. Built-in Functions
        7. Connectors
          1. From/To Variables
          2. Formats
          3. DataGen & Print & BlackHole
          4. Kafka
          5. FileSystem
          6. JDBC
          7. HBase
          8. Elasticsearch
          9. Hive
          10. Custom Connectors
        8. User Defined Functions
          1. General User Defined Functions
          2. Vectorized User Defined Functions
        9. Dependency Management
        10. SQL
        11. Catalogs
        12. MLPipeline
        13. CEP
        14. Metrics
        15. Configurations
        16. Environment Variables
        17. Debugging 
      2. DataStream API
        1. 10 minutes to DataStream API
        2. DataTypes
        3. Operations
        4. Connectors
        5. Metrics
        6. Configurations
    Table API
  • DataStream API
    1. CookBook
      1. Recipe for Event Driven scenario
      2. Recipe for ETL scenario
      3. Recipe for Data Analyze scenario
    2. FAQ
    3. API Docs

    The following are descriptions for each document above. Some of them can refer to existing documents:

    ...

    Currently the content of this document can copy from the bottom of be a reference to https://ci.apache.org/projects/flink/flink-docs-release-1.11/dev/table/tableApi.html. In future it will be replaced with the syntax of Python Expression DSL.

    Built-in Functions

    Moved from Could be a reference to https://ci.apache.org/projects/flink/flink-docs-release-1.11/dev/table/functions/systemFunctions.html.

    ...

    The generated sphinx doc of PyFlink, e.g. https://ci.apache.org/projects/flink/flink-docs-release-1.11/api/python/.

    But we can’t just simply put the link here. Some And some examples in the docs still use the deprecated APIs. We need to keep the examples in it up to date.

    Rejected Alternatives

    N/A

    Implementation plan

    The details will be refined in 

    Jira
    serverASF JIRA
    serverId5aa69414-a9e9-3523-82ec-879b028fb15b
    keyFLINK-18775
    in the way of creating sub JIRA.