You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "xuyangzhong (via GitHub)" <gi...@apache.org> on 2024/07/02 16:58:56 UTC

[PR] [FLINK-35271][doc] Add doc for syntax DESCRIBE JOB [flink]

xuyangzhong opened a new pull request, #24984:
URL: https://github.com/apache/flink/pull/24984

   ## What is the purpose of the change
   
   *Add doc for syntax DESCRIBE JOB <JOB_ID>*
   
   ## Brief change log
   
     - *add doc for en and zh*
   
   ## Verifying this change
   
   This pr is no need to test.
   
   ## Does this pull request potentially affect one of the following parts:
   
     - Dependencies (does it add or upgrade a dependency): no
     - The public API, i.e., is any changed class annotated with `@Public(Evolving)`: no
     - The serializers: no
     - The runtime per-record code paths (performance sensitive): no
     - Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
     - The S3 file system connector: no
   
   ## Documentation
   
     - Does this pull request introduce a new feature? 
     - If yes, how is the feature documented? 
   


-- 
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


Re: [PR] [FLINK-35271][doc] Add doc for syntax DESCRIBE JOB [flink]

Posted by "flinkbot (via GitHub)" <gi...@apache.org>.
flinkbot commented on PR #24984:
URL: https://github.com/apache/flink/pull/24984#issuecomment-2191596027

   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "9cdced1ce814bc30f779f7c8f55c1ea0b75fcaf6",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "9cdced1ce814bc30f779f7c8f55c1ea0b75fcaf6",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 9cdced1ce814bc30f779f7c8f55c1ea0b75fcaf6 UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run azure` re-run the last Azure build
   </details>


-- 
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


Re: [PR] [FLINK-35271][doc] Add doc for syntax DESCRIBE JOB [flink]

Posted by "xuyangzhong (via GitHub)" <gi...@apache.org>.
xuyangzhong commented on code in PR #24984:
URL: https://github.com/apache/flink/pull/24984#discussion_r1654746594


##########
docs/content/docs/dev/table/sql/describe.md:
##########
@@ -26,25 +26,25 @@ under the License.
 
 # DESCRIBE Statements
 
-DESCRIBE statements are used to describe the schema of a table or a view, or the metadata of a catalog.
+DESCRIBE statements are used to describe the schema of a table or a view, or the metadata of a catalog, or the specified job in the Flink cluster.
 
 
 ## Run a DESCRIBE statement
 
 {{< tabs "describe" >}}
 {{< tab "Java" >}}
-DESCRIBE statements can be executed with the `executeSql()` method of the `TableEnvironment`. The `executeSql()` method returns the schema of given table for a successful DESCRIBE operation, otherwise will throw an exception.
+DESCRIBE statements can be executed with the `executeSql()` method of the `TableEnvironment`. The `executeSql()` method returns objects for a successful DESCRIBE operation, otherwise will throw an exception.

Review Comment:
   I just follow the description with the chapter `'SHOW Statements'`



-- 
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