Versions Compared

Old Version 5

changes.mady.by.user Jincheng Sun

Saved on

compared with

New Version 6

changes.mady.by.user Jincheng Sun

Saved on

Key

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

...

Python API Document Structure


  1. OverView
  2. Getting Started
    1. Installation
    2. Tutorial
      1. Table API
      2. DataStream API
  3. 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
  4. CookBook
    1. Recipe for Event Driven scenario
    2. Recipe for ETL scenario
    3. Recipe for Data Analyze scenario
  5. FAQ
  6. 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 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 tomo 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

...