[incubator-pinot] branch master updated: Deprecate PQL endpoint on Broker (#6607)

[si...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

siddteotia pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pinot.git


The following commit(s) were added to refs/heads/master by this push:
     new b3de286  Deprecate PQL endpoint on Broker (#6607)
b3de286 is described below

commit b3de28669260255949678674e3dfae2d81653bfc
Author: Siddharth Teotia <si...@gmail.com>
AuthorDate: Wed Feb 24 12:17:13 2021 -0800

    Deprecate PQL endpoint on Broker (#6607)
    
    * Deprecate PQL endpoint on Broker
    
    * Javadoc
    
    Co-authored-by: Siddharth Teotia <st...@steotia-mn1.linkedin.biz>
---
 .../pinot/broker/api/resources/PinotClientRequest.java | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotClientRequest.java b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotClientRequest.java
index 65d2bf6..216a7c4 100644
--- a/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotClientRequest.java
+++ b/pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotClientRequest.java
@@ -63,11 +63,18 @@ public class PinotClientRequest {
   @Inject
   private BrokerMetrics brokerMetrics;
 
+  /**
+   * Legacy API to query Pinot using PQL (Pinot Query Language) syntax
+   * and semantics. This API is deprecated and PQL is no longer supported
+   * by Pinot. The API will be removed in the next release. Please use
+   * the standard SQL syntax (API /query/sql) to query Pinot.
+   */
+  @Deprecated
   @GET
   @ManagedAsync
   @Produces(MediaType.APPLICATION_JSON)
   @Path("query")
-  @ApiOperation(value = "Querying pinot")
+  @ApiOperation(value = "Querying pinot using PQL")
   @ApiResponses(value = {@ApiResponse(code = 200, message = "Query response"), @ApiResponse(code = 500, message = "Internal Server Error")})
   public void processQueryGet(
       // Query param "bql" is for backward compatibility
@@ -93,11 +100,18 @@ public class PinotClientRequest {
     }
   }
 
+  /**
+   * Legacy API to query Pinot using PQL (Pinot Query Language) syntax
+   * and semantics. This API is deprecated and PQL is no longer supported
+   * by Pinot. The API will be removed in the next release. Please use
+   * the standard SQL syntax (API /query/sql) to query Pinot.
+   */
+  @Deprecated
   @POST
   @ManagedAsync
   @Produces(MediaType.APPLICATION_JSON)
   @Path("query")
-  @ApiOperation(value = "Querying pinot")
+  @ApiOperation(value = "Querying pinot using PQL")
   @ApiResponses(value = {@ApiResponse(code = 200, message = "Query response"), @ApiResponse(code = 500, message = "Internal Server Error")})
   public void processQueryPost(String query, @Suspended AsyncResponse asyncResponse,
       @Context org.glassfish.grizzly.http.server.Request requestContext) {


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org