You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2022/11/15 09:04:55 UTC
[GitHub] [flink] dianfu commented on a diff in pull request #21280: [FLINK-29966][python][doc] Replace and redesign the Python api documentation base
dianfu commented on code in PR #21280:
URL: https://github.com/apache/flink/pull/21280#discussion_r1018617362
##########
flink-python/docs/reference/pyflink.table/expressions.rst:
##########
@@ -0,0 +1,77 @@
+.. ################################################################################
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ ################################################################################
+
+
+===========
+Expressions
Review Comment:
Could we also list the methods in Expression class which are also very helpful?
##########
flink-python/docs/reference/pyflink.table/table_environment.rst:
##########
@@ -0,0 +1,230 @@
+.. ################################################################################
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ ################################################################################
+
+================
+TableEnvironment
+================
+
+A table environment is the base class, entry point, and central context for creating Table
+and SQL API programs.
+
+EnvironmentSettings
+-------------------
+
+Defines all parameters that initialize a table environment. Those parameters are used only
+during instantiation of a :class:`~pyflink.table.TableEnvironment` and cannot be changed
+afterwards.
+
+Example:
+::
+
+ >>> EnvironmentSettings.new_instance() \\
Review Comment:
```suggestion
>>> EnvironmentSettings.new_instance() \
```
Need also check other examples.
##########
flink-python/docs/reference/pyflink.table/table_environment.rst:
##########
@@ -0,0 +1,230 @@
+.. ################################################################################
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ ################################################################################
+
+================
+TableEnvironment
+================
+
+A table environment is the base class, entry point, and central context for creating Table
+and SQL API programs.
+
+EnvironmentSettings
+-------------------
+
+Defines all parameters that initialize a table environment. Those parameters are used only
+during instantiation of a :class:`~pyflink.table.TableEnvironment` and cannot be changed
+afterwards.
+
+Example:
+::
+
+ >>> EnvironmentSettings.new_instance() \\
+ ... .in_streaming_mode() \\
+ ... .with_built_in_catalog_name("my_catalog") \\
+ ... .with_built_in_database_name("my_database") \\
+ ... .build()
+
+:func:`~EnvironmentSettings.in_streaming_mode` or :func:`~EnvironmentSettings.in_batch_mode`
+might be convenient as shortcuts.
+
+.. currentmodule:: pyflink.table.environment_settings
+
+.. autosummary::
+ :toctree: api/
+
+ EnvironmentSettings.new_instance
+ EnvironmentSettings.from_configuration
+ EnvironmentSettings.in_streaming_mode
+ EnvironmentSettings.in_batch_mode
+ EnvironmentSettings.get_built_in_catalog_name
+ EnvironmentSettings.get_built_in_database_name
+ EnvironmentSettings.is_streaming_mode
+ EnvironmentSettings.to_configuration
+ EnvironmentSettings.get_configuration
+ EnvironmentSettings.Builder.with_configuration
+ EnvironmentSettings.Builder.in_batch_mode
+ EnvironmentSettings.Builder.in_streaming_mode
+ EnvironmentSettings.Builder.with_built_in_catalog_name
+ EnvironmentSettings.Builder.with_built_in_database_name
+ EnvironmentSettings.Builder.build
+
+TableConfig
+-----------
+
Review Comment:
Add some description for TableConfig?
##########
flink-python/docs/reference/pyflink.table/table.rst:
##########
@@ -0,0 +1,116 @@
+.. ################################################################################
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ ################################################################################
+
+=====
+Table
+=====
Review Comment:
Also expose the other classes such as GroupTable?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org