DOC-9450: Update SEARCH_META(..) instructions and examples

Author: abhinavdangeti

modules/fts/pages/fts-searching-from-N1QL.adoc

@@ -5,11 +5,57 @@ Search functions enable you to use full text search queries directly within a N1
 == Prerequisites
 
 To use any of the search functions, the Search service must be available on the cluster.
-It is also recommended, but not required, that you should create suitable full text indexes for the searches that you need to perform.
+It is required for you to create suitable full text indexes for the searches that you want to perform.
 
 [NOTE]
 --
-The examples in this page all assume that demonstration full text indexes have been created.
+The examples in this page assume that you have a full text search index created with this definition, unless specified otherwise ..
+[source,json]
+----
+{
+ "name": "travel-sample-inventory-hotels",
+ "type": "fulltext-index",
+ "params": {
+  "doc_config": {
+   "mode": "scope.collection.type_field",
+   "type_field": "type"
+  },
+  "mapping": {
+   "default_analyzer": "standard",
+   "default_datetime_parser": "dateTimeOptional",
+   "default_field": "_all",
+   "default_mapping": {
+    "dynamic": true,
+    "enabled": false
+   },
+   "default_type": "_default",
+   "docvalues_dynamic": false,
+   "index_dynamic": true,
+   "store_dynamic": false,
+   "type_field": "_type",
+   "types": {
+    "inventory.hotel": {
+     "dynamic": true,
+     "enabled": true
+    }
+   }
+  },
+  "store": {
+   "indexType": "scorch",
+   "segmentVersion": 15
+  }
+ },
+ "sourceType": "gocbcore",
+ "sourceName": "travel-sample",
+ "sourceUUID": "",
+ "sourceParams": {},
+ "planParams": {
+  "indexPartitions": 1
+ },
+ "uuid": ""
+}
+----
+
 --
 
 === Authorization
@@ -203,33 +249,29 @@ The following queries are equivalent:
 [source,n1ql]
 ----
 SELECT META(t1).id
-FROM `travel-sample`.inventory.airline AS t1
+FROM `travel-sample`.inventory.hotel AS t1
 WHERE SEARCH(t1.country, "+United +States");
 ----
 
 [source,n1ql]
 ----
 SELECT META(t1).id
-FROM `travel-sample`.inventory.airline AS t1
+FROM `travel-sample`.inventory.hotel AS t1
 WHERE SEARCH(t1, "country:\"United States\"");
 ----
 
 .Results
 [source,json]
 ----
 [
- 
-  {
-    "id": "airline_10"
-  },
   {
-    "id": "airline_10123"
+    "id": "hotel_26215"
   },
   {
-    "id": "airline_10226"
+    "id": "hotel_7396"
   },
   {
-    "id": "airline_10748"
+    "id": "hotel_32177"
   },
 ...
 ]
@@ -350,8 +392,74 @@ WHERE t1.type = "hotel" AND SEARCH(t1.description, "amazing");
 ----
 
 If the full text search index being queried has its default mapping disabled and has a custom type mapping defined, the query needs to specify the type explicitly.
-
-//The above query uses the demonstration index xref:fts:fts-demonstration-indexes.adoc#travel-sample-index-hotel-description[travel-sample-index-hotel-description], which has the custom type mapping "hotel".
+The above query uses the following index definition ..
+[source,json]
+----
+{
+  "name": "travel-sample-index-hotel-description",
+  "type": "fulltext-index",
+  "params": {
+    "doc_config": {
+      "mode": "type_field",
+      "type_field": "type"
+    },
+    "mapping": {
+      "analysis": {
+        "analyzers": {
+          "myUnicodeAnalyzer": {
+            "tokenizer": "unicode",
+            "type": "custom"
+          }
+        }
+      },
+      "default_analyzer": "standard",
+      "default_datetime_parser": "dateTimeOptional",
+      "default_field": "_all",
+      "default_mapping": {
+        "dynamic": true,
+        "enabled": false
+      },
+      "default_type": "_default",
+      "index_dynamic": true,
+      "store_dynamic": true,
+      "type_field": "type",
+      "types": {
+        "hotel": {
+          "dynamic": false,
+          "enabled": true,
+          "properties": {
+            "description": {
+              "enabled": true,
+              "dynamic": false,
+              "fields": [
+                {
+                  "include_in_all": true,
+                  "include_term_vectors": true,
+                  "index": true,
+                  "name": "description",
+                  "store": true,
+                  "type": "text"
+                }
+              ]
+            }
+          }
+        }
+      }
+    },
+    "store": {
+      "indexType": "scorch"
+    }
+  },
+  "sourceType": "couchbase",
+  "sourceName": "travel-sample",
+  "sourceUUID": "",
+  "sourceParams": {},
+  "planParams": {
+    "indexPartitions": 1
+  },
+  "uuid": ""
+}
+----
 
 For more information on defining custom type mappings within the full text search index, refer to xref:fts:fts-type-mappings.adoc[Type Mappings].
 Note that for N1QL queries, only full text search indexes with one type mapping are searchable.
@@ -506,6 +614,10 @@ AND SEARCH(t1, {
 ----
 [
   {
+    "meta": {
+      "id": "hotel_17598",
+      "score": 2.1256278997816835
+    },
     "name": "Marina del Rey Marriott"
   }
 ]
@@ -569,16 +681,19 @@ LIMIT 3;
 ----
 [
   {
-    "description": "3 Star Hotel next to the Mountain Railway terminus and set in 30 acres of grounds which include Dolbadarn Castle",
-    "name": "The Royal Victoria Hotel"
+    "description": "370 guest rooms offering both water and mountain view.",
+    "name": "Marina del Rey Marriott",
+    "score": 2.1256278997816835
   },
   {
-    "description": "370 guest rooms offering both water and mountain view.",
-    "name": "Marina del Rey Marriott"
+    "description": "Log cabin glamping in a rural setting with panoramic views toward the Clwydian Mountain Range.",
+    "name": "Clwydian Holidays",
+    "score": 1.6956645086702617
   },
   {
-    "description": "This small family run hotel captures the spirit of Mull and is a perfect rural holiday retreat. The mountain and sea blend together to give fantastic, panoramic views from the hotel which is in an elevated position on the shoreline. Panoramic views are also available from the bar and restaurant which serves local produce 7 days a week.",
-    "name": "The Glenforsa Hotel"
+    "description": "3 Star Hotel next to the Mountain Railway terminus and set in 30 acres of grounds which include Dolbadarn Castle",
+    "name": "The Royal Victoria Hotel",
+    "score": 1.5030458987111712
   }
 ]
 ----
@@ -682,4 +797,4 @@ WHERE reviews.content LIKE "%travel%";
 SELECT META().id
 FROM `travel-sample`.`inventory`.`hotel` t USE INDEX(USING FTS)
 WHERE content LIKE "%travel%";
-----
+----