Merge pull request #368 from couchbase/DOC-10839

Fixed DOC-10839

Author: RichardSmedley

modules/howtos/examples/Queries.java

@@ -51,24 +51,6 @@ public static void main(String[] args) throws Exception {
     Scope scope = bucket.scope("inventory");
     // end::connect-bucket-and-scope[]
 
-    {
-      System.out.println("Example: [simple]");
-      // tag::simple[]
-      try {
-        final QueryResult result = cluster.query("select * from `travel-sample`.inventory.airline limit 100",
-            queryOptions().metrics(true));
-
-        for (JsonObject row : result.rowsAsObject()) {
-          System.out.println("Found row: " + row);
-        }
-
-        System.out.println("Reported execution time: " + result.metaData().metrics().get().executionTime());
-      } catch (CouchbaseException ex) {
-        ex.printStackTrace();
-      }
-      // end::simple[]
-    }
-
     {
       System.out.println("\nExample: [named]");
       // tag::named[]

modules/howtos/examples/SimpleQuery.java

@@ -0,0 +1,34 @@
+import static com.couchbase.client.java.query.QueryOptions.queryOptions;
+
+import com.couchbase.client.core.error.CouchbaseException;
+import com.couchbase.client.java.Cluster;
+import com.couchbase.client.java.json.JsonObject;
+import com.couchbase.client.java.query.QueryResult;
+
+// tag::class[]
+public class SimpleQuery {
+  // Update these variables to point to your Couchbase instance and credentials.
+  static String connectionString = "localhost";
+  static String username = "Administrator";
+  static String password = "password";
+
+  public static void main(String[] args) throws Exception {
+    Cluster cluster = Cluster.connect(connectionString, username, password);
+  
+    {
+      try {
+        final QueryResult result = cluster.query("select * from `travel-sample`.inventory.airline limit 100",
+          queryOptions().metrics(true));
+  
+        for (JsonObject row : result.rowsAsObject()) {
+          System.out.println("Found row: " + row);
+        }
+  
+        System.out.println("Reported execution time: " + result.metaData().metrics().get().executionTime());
+      } catch (CouchbaseException ex) {
+        ex.printStackTrace();
+      }
+    }
+  }
+}
+// end::class[]

modules/howtos/examples/SimpleQueryCloud.java

@@ -0,0 +1,40 @@
+import static com.couchbase.client.java.query.QueryOptions.queryOptions;
+
+import com.couchbase.client.core.error.CouchbaseException;
+import com.couchbase.client.java.*;
+import com.couchbase.client.java.json.*;
+import com.couchbase.client.java.query.*;
+
+// tag::class[]
+public class SimpleQueryCloud {
+  // Update these variables to point to your Couchbase Capella instance and credentials.
+  static String connectionString = "couchbases://cb.<your-endpoint-here>.cloud.couchbase.com";
+  static String username = "Administrator";
+  static String password = "password";
+
+  public static void main(String[] args) throws Exception {
+    Cluster cluster = Cluster.connect(
+    connectionString,
+    ClusterOptions.clusterOptions(username, password).environment(env -> {
+    env.applyProfile("wan-development");
+    })
+    );
+
+    { 
+      try {
+        final QueryResult result = cluster.query("select * from `travel-sample`.inventory.airline limit 100",
+        queryOptions().metrics(true));
+
+        for (JsonObject row : result.rowsAsObject()) {
+          System.out.println("Found row: " + row);
+      }
+
+      System.out.println("Reported execution time: " + result.metaData().metrics().get().executionTime());
+
+      } catch (CouchbaseException ex) {
+        ex.printStackTrace();
+      }
+    }
+  }
+}
+// end::class[]

modules/howtos/pages/n1ql-queries-with-sdk.adoc

@@ -1,5 +1,5 @@
 = Query
-:description: You can query for documents in Couchbase using the {sqlpp_url}[{sqlpp} (formerly N1QL)] query language, a language based on SQL, but designed for structured and flexible JSON documents.
+:description: You can query for documents in Couchbase using the {sqlpp_url}[{sqlpp}] (formerly N1QL) query language, a language based on SQL, but designed for structured and flexible JSON documents.
 :page-topic-type: howto
 :page-aliases: n1ql-query,ROOT:querying-n1ql
 :page-pagination: full
@@ -23,10 +23,33 @@ include::example$Queries.java[tag=imports,indent=0]
 
 Here's a complete example of doing a query and handling the results:
 
+[{tabs}]
+====
+Couchbase Capella Sample::
++
+--
+These examples requires the Travel Sample Bucket.
+The Couchbase Capella free trial version comes with this bucket, and its Query indexes, loaded and ready.
+
+[source,java]
+----
+include::example$SimpleQueryCloud.java[tag=class,indent=0]
+----
+--
+
+Local Couchbase Server::
++
+--
+To run these examples, you will need to install the Travel Sample Bucket
+using either the xref:{version-server}@server:manage:manage-settings/install-sample-buckets.adoc#install-sample-buckets-with-the-ui[Web interface]
+or the xref:{version-server}@server:manage:manage-settings/install-sample-buckets.adoc#install-sample-buckets-with-the-cli[command line].
+
 [source,java]
 ----
-include::example$Queries.java[tag=simple,indent=0]
+include::example$SimpleQuery.java[tag=class,indent=0]
 ----
+--
+====
 
 Let's break it down. A query is always performed at the `Cluster` level, using the `query` method. It takes the statement as a required argument and then allows to provide additional options if needed (in the example above, no options are specified).
 
@@ -156,7 +179,7 @@ include::example$Queries.java[tag=scanconsistency,indent=0]
 //If you need "global" scan consistency, use `QueryScanConsistency.REQUEST_PLUS` on `scanConsistency(QueryScanConsistency)`.
 
 
-=== Client Context Id
+=== Client Context ID
 
 The SDK will always send a client context ID with each query, even if none is provided by the user.
 By default a UUID will be generated that is mirrored back from the query engine and can be used for debugging purposes.

modules/student/examples/AddEnrollments.java

@@ -7,6 +7,7 @@
 import com.couchbase.client.java.json.JsonObject;
 import com.couchbase.client.java.query.QueryOptions;
 import com.couchbase.client.java.query.QueryResult;
+import com.couchbase.client.java.query.QueryScanConsistency;
 
 import java.time.Duration;
 import java.time.LocalDate;
@@ -54,25 +55,27 @@ public static void main(String[] args) {
 
     private static JsonObject retrieveStudent(Cluster cluster, String name) throws CouchbaseException {
 
+        QueryOptions studentQueryOptions = QueryOptions.queryOptions();
+        studentQueryOptions.parameters(JsonObject.create().put("name", name));
+        studentQueryOptions.scanConsistency(QueryScanConsistency.REQUEST_PLUS);
+
         final QueryResult result = cluster.query("select META().id, src.* " +
                         "from `student-bucket`.`art-school-scope`.`student-record-collection` src " +
-                        "where src.`name` = $name",
-                QueryOptions.queryOptions()
-                        .parameters(JsonObject.create()
-                                .put("name", name)));
+                        "where src.`name` = $name", studentQueryOptions);
 
         return result.rowsAsObject().get(0);
 
     }
 
     private static JsonObject retrieveCourse(Cluster cluster, String course) throws CouchbaseException {
 
+        QueryOptions courseQueryOptions = QueryOptions.queryOptions();
+        courseQueryOptions.parameters(JsonObject.create().put("courseName", course));
+        courseQueryOptions.scanConsistency(QueryScanConsistency.REQUEST_PLUS);
+
         final QueryResult result = cluster.query("select META().id, crc.* " +
                         "from `student-bucket`.`art-school-scope`.`course-record-collection` crc " +
-                        "where crc.`course-name` = $courseName",
-                QueryOptions.queryOptions()
-                        .parameters(JsonObject.create()
-                                .put("courseName", course)));
+                        "where crc.`course-name` = $courseName", courseQueryOptions);
 
         return result.rowsAsObject().get(0);
 

modules/test/test-howtos.bats

@@ -112,6 +112,18 @@ load 'test_helper'
     assert_output --partial "id='hotel_26223'"
 }
 
+@test "[howtos] - SimpleQuery.java" {
+    runExample SimpleQuery
+    assert_success
+}
+
+@test "[howtos] - SimpleQueryCloud.java" {
+    skip "Example requires a cloud endpoint. Unable to run."
+
+    runExample SimpleQueryCloud
+    assert_success
+}
+
 @test "[howtos] - SubDocument.java" {
     runExample SubDocument
     assert_success