Versions Compared

Key

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

...

          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.

...

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. Table API
    2. DataStream API
    1. Installation
    2. Tutorial
  3. User Guide
    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 
    1. 10 minutes to DataStream API
    2. DataTypes
    3. Operations
    4. Connectors
    5. Metrics
    6. Configurations
    1. Table API
    2. DataStream API
  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:

...