JCBC-1179 Add profile option to N1qlParams

Change-Id: Icbd317c44153b85ab213a42160c1152e4fe89bc9
Reviewed-on: http://review.couchbase.org/91928
Reviewed-by: Subhashni Balakrishnan <[email protected]>
Tested-by: Subhashni Balakrishnan <[email protected]>

Author: bsubhashni

src/integration/java/com/couchbase/client/java/N1qlQueryTest.java

@@ -340,4 +340,22 @@ public void shouldWorkWithPrettyFalse() {
         assertNotNull(result.allRows());
         assertNotNull(result.errors());
     }
+
+    @Test
+    public void shouldWorkWithProfileInfoEnabled() {
+        ctx.ignoreIfClusterUnder(Version.parseVersion("4.5.1"));
+        N1qlQuery query = N1qlQuery.simple(
+                select("*").fromCurrentBucket().limit(1),
+                N1qlParams.build().profile(N1qlProfile.TIMINGS).consistency(CONSISTENCY)
+        );
+
+        N1qlQueryResult result = ctx.bucket().query(query);
+        assertEquals(1, result.allRows().size());
+        assertTrue(result.parseSuccess());
+        assertTrue(result.finalSuccess());
+        assertNotNull(result.info());
+        assertNotNull(result.allRows());
+        assertNotNull(result.errors());
+        assertTrue(result.profileInfo().size() > 0);
+    }
 }

src/main/java/com/couchbase/client/java/query/N1qlParams.java

@@ -64,6 +64,7 @@ public class N1qlParams implements Serializable {
     private Map<String, Object> rawParams;
     private boolean pretty;
     private boolean readonly;
+    private N1qlProfile profile;
 
     private final Map<String, String> credentials;
 
@@ -142,6 +143,10 @@ public void injectParams(JsonObject queryJson) {
             queryJson.put("readonly", true);
         }
 
+        if (this.profile != null) {
+            queryJson.put("profile", this.profile.toString());
+        }
+
         if (this.rawParams != null) {
             for (Map.Entry<String, Object> entry : rawParams.entrySet()) {
                 queryJson.put(entry.getKey(), entry.getValue());
@@ -410,6 +415,17 @@ public N1qlParams pipelineCap(int pipelineCap) {
         return this;
     }
 
+    /**
+     * Specifies if there should be a profile section returned with the request results.
+     *
+     * @param profile the profile param {@link N1qlProfile}.
+     * @return this {@link N1qlParams} for chaining.
+     */
+    public N1qlParams profile(N1qlProfile profile) {
+        this.profile = profile;
+        return this;
+    }
+
     /**
      * Allows to specify an arbitrary, raw N1QL param.
      *
@@ -480,6 +496,7 @@ public boolean equals(Object o) {
         if (mutationState != null ? !mutationState.equals(that.mutationState) : that.mutationState != null)
             return false;
         if (!credentials.equals(that.credentials)) return false;
+        if (profile != that.profile) return false;
         return rawParams != null ? rawParams.equals(that.rawParams) : that.rawParams == null;
     }
 
@@ -500,6 +517,7 @@ public int hashCode() {
         result = 31 * result + (adhoc ? 1 : 0);
         result = 31 * result + (pretty ? 1 : 0);
         result = 31 * result + (readonly ? 1 : 0);
+        result = 31 * result + (profile != null ? profile.hashCode() : 0);
         return result;
     }
 
@@ -521,6 +539,9 @@ public String toString() {
         sb.append(", rawParams=").append(rawParams);
         if (!credentials.isEmpty())
             sb.append(", credentials=").append(credentials.size());
+        if (profile != null) {
+            sb.append(", profile=").append(profile.toString());
+        }
         sb.append('}');
         return sb.toString();
     }

src/main/java/com/couchbase/client/java/query/N1qlProfile.java

@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2018 Couchbase, Inc.
+ *
+ * Licensed 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.
+ */
+package com.couchbase.client.java.query;
+
+/**
+ * N1ql profile options
+ */
+public enum N1qlProfile {
+
+    /**
+     * No profiling information is added to the query response.
+     */
+    OFF {
+        @Override
+        public String toString() {
+            return "off";
+        }
+    },
+
+    /**
+     * The query response includes a profile section with stats and details
+     * about various phases of the query plan and execution.
+     * Three phase times will be included in the system:active_requests and
+     * system:completed_requests monitoring keyspaces.
+     */
+    PHASES {
+        @Override
+        public String toString() {
+            return "phases";
+        }
+    },
+
+    /**
+     * Besides the phase times, the profile section of the query response document will
+     * include a full query plan with timing and information about the number of processed
+     * documents at each phase. This information will be included in the system:active_requests
+     * and system:completed_requests keyspaces.
+     */
+    TIMINGS {
+        @Override
+        public String toString() {
+            return "timings";
+        }
+    }
+}