DOC-12829: Publish Couchbase Server 7.6.4 Docs

Merge pull request #3753 from couchbase/prerelease/7.6.4

Rebase and merge not available due to merge conflicts.

Author: simon-dew

modules/ROOT/nav.adoc

@@ -313,8 +313,10 @@ include::cli:partial$cbcli/nav.adoc[]
  ** xref:cli:cbtools/cbtransfer.adoc[cbtransfer]
  ** xref:cli:cbtools/cbworkloadgen.adoc[cbworkloadgen]
  ** xref:cli:couchbase-server.adoc[couchbase-server]
+ ** xref:cli:finderr.adoc[finderr]
  ** xref:cli:mctimings.adoc[mctimings]
  ** xref:cli:mcstat.adoc[mcstat]
+ ** xref:cli:mctestauth.adoc[mctestauth]
 * xref:rest-api:rest-intro.adoc[REST API Reference]
 
 ** xref:rest-api:rest-cluster-intro.adoc[Nodes and Clusters API]
@@ -507,7 +509,7 @@ include::cli:partial$cbcli/nav.adoc[]
     *** xref:rest-api:rest-fts-query.adoc[Active Queries]
     *** xref:rest-api:rest-fts-partition-file-transfer.adoc[Rebalance Based on File Transfer]
 
-   ** xref:eventing:eventing-api.adoc[Eventing Service API]
+   ** xref:eventing-rest-api:index.adoc[Eventing Service API]
 
    ** xref:analytics:rest-analytics.adoc[Analytics Service API]
      *** xref:analytics-rest-service:index.adoc[Analytics Service REST API]

modules/cli/pages/cli-intro.adoc

@@ -1,6 +1,6 @@
 = CLI Reference
 :description: The command-line interface (CLI) tools let you manage and monitor your Couchbase Server installation including clusters, servers, vBuckets, and XDCR.
-:tools-ver: 7.6.2
+:tools-ver: 7.6.4
 
 [abstract]
 {description}
@@ -39,46 +39,97 @@ You can collect diagnostics through the command-line interface by using the xref
 [#server-tools-packages]
 == Server Tools Packages
 
-For convenience, Couchbase provides a  tools package  that contains the following utilities:
+For convenience, Couchbase provides the Server developer tools package and the Server admin tools package.
+
+=== Server Developer Tools Package
+
+The Server developer tools package lets you install the following EE Server utilities on the systems where you have not installed Couchbase Server:
 
 * xref:tools:cbimport.adoc[`cbimport`]
 * xref:tools:cbexport.adoc[`cbexport`]
 * xref:cli:cbq-tool.adoc[`cbq`]
 * xref:backup-restore:cbbackupmgr.adoc[`cbbackupmgr`]
 
-This package lets you install these tools on systems where you have not installed Couchbase Server.
 
 Download the command line tools package for your platform from the following links:
 
-* Linux: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-linux_x86_64.tar.gz[]
-* Linux aarch64: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-linux_aarch64.tar.gz[]
-* macOS: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-macos_x86_64.zip[]
-* macOS arm64: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-macos_arm64.zip[]
-* Windows: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-windows_amd64.zip[]
+* Linux: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-dev-tools_{tools-ver}-linux_x86_64.tar.gz[]
+* Linux aarch64: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-dev-tools_{tools-ver}-linux_aarch64.tar.gz[]
+* macOS: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-dev-tools_{tools-ver}-macos_x86_64.zip[]
+* macOS arm64: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-dev-tools_{tools-ver}-macos_arm64.zip[]
+* Windows: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-dev-tools_{tools-ver}-windows_amd64.zip[]
 
 Unzip or untar the packages, and the binaries are ready to run.
 For example:
 
 [source,console,subs="attributes+"]
 ----
-wget https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-tools_{tools-ver}-linux_x86_64.tar.gz
+wget https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-dev-tools_{tools-ver}-linux_x86_64.tar.gz
 
-tar -xf couchbase-server-tools_{tools-ver}-linux_x86_64.tar.gz
+tar -xf couchbase-server-dev-tools_{tools-ver}-linux_x86_64.tar.gz
 ----
 
 Each package also contains a `README` file and a copy of the software license.
 
 NOTE: On Windows, you must have a recent version of the Microsoft Visual {cpp} Redistributable runtime libraries installed.
 If you do not have these libraries installed, download them from https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170[Microsoft Visual {cpp} Redistributable latest supported downloads].
 
+=== Server Admin Tools Package
+
+The Server admin tools package lets you install the following Server utilities on the systems where you have not installed Couchbase Server:
+
+* xref:backup-restore:cbbackupmgr.adoc[`cbbackupmgr`]
+* https://docs.couchbase.com/sdk-api/couchbase-c-client/md_doc_2cbc.html[`cbc`]
+* xref:tools:cbdatarecovery.adoc[`cbdatarecovery`]
+* xref:tools:cbexport.adoc[`cbexport`]
+* xref:tools:cbimport.adoc[`cbimport`]
+* xref:cli:cbq-tool.adoc[`cbq`]
+* xref:cli:cbstats-intro.adoc[`cbstats`]
+* xref:cli:cbcli/couchbase-cli.adoc[`couchbase-cli`]
+* xref:cli:mcstat.adoc[`mcstat`]
+* xref:cli:mctimings.adoc[`mctimings`]
+* xref:cli:mctestauth.adoc[`mctestauth`]
+
+Download the command line tools package for your platform from the following links:
+
+* Linux: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-admin-tools_{tools-ver}-linux_x86_64.tar.gz[]
+* Linux aarch64: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-admin-tools_{tools-ver}-linux_aarch64.tar.gz[]
+* macOS: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-admin-tools_{tools-ver}-macos_x86_64.zip[]
+* macOS arm64: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-admin-tools_{tools-ver}-macos_arm64.zip[]
+* Windows: https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-admin-tools_{tools-ver}-windows_amd64.zip[]
+
+Unzip or untar the packages, and the binaries are ready to run.
+For example:
+
+[source,console,subs="attributes+"]
+----
+wget https://packages.couchbase.com/releases/{tools-ver}/couchbase-server-admin-tools_{tools-ver}-linux_x86_64.tar.gz
+
+tar -xf couchbase-server-admin-tools_{tools-ver}-linux_x86_64.tar.gz
+----
+
+Each package also contains a `README` file and a copy of the software license.
+
+NOTE: On Windows, you must have a recent version of the Microsoft Visual {cpp} Redistributable runtime libraries installed.
+If you do not have these libraries installed, download them from https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist[Microsoft Visual {cpp} Redistributable latest supported downloads].
+
+
 [#version-compatibility]
 == Version Compatibility
 
 The versions of the utilities installed by the tools package are the same as the corresponding Couchbase Server installation package.
 
-The {tools-ver} `cbimport`, `cbexport`, `cbbackupmgr`, and `cbq` utilities are compatible with the following Couchbase Server versions:
+For Server developer tools package, the {tools-ver} version of `cbimport`, `cbexport`, `cbbackupmgr`, and `cbq` utilities are compatible with the following Couchbase Server versions:
 
-* 7.6.0, 7.6.1
+* 7.6.0, 7.6.1, 7.6.2, 7.6.3
 * 7.2.x
 * 7.1.x
 * 7.0.x
+
+You can download and use the latest version of the utilities (`cbimport`, `cbexport`, `cbbackupmgr`, and `cbq`) with earlier Couchbase Server versions.
+
+For Server admin tools package, do the following:
+
+* Use the `--version` option to get the version of the utility. However, for the `cbc` utility, use the `cbc version` option.
+* `couchbase-cli` is a utility for administering the Couchbase cluster. Make sure that the versions of `couchbase-cli` and the Couchbase cluster match. 
+* For all utilities, a feature that exists in a latest Server version only is not supported by an earlier version utility.

modules/cli/pages/finderr.adoc

@@ -0,0 +1,221 @@
+= finderr
+:description: pass:q[The [.cmd]`finderr` tool returns the full details of any Query service or cbq shell error.]
+:page-status: Couchbase Server 7.6.4
+:page-topic-type: reference
+
+[abstract]
+{description}
+
+== Syntax
+
+The basic syntax is:
+
+----
+finderr <number|string|regex>
+----
+
+== Description
+
+ifeval::['{page-component-version}' == '7.6'] 
+This tool is only available in Couchbase Server 7.6.4 and later.
+endif::[]
+
+Depending upon your platform, this tool is at the following locations:
+
+[cols="1,3"]
+|===
+| Operating system | Location
+
+| Linux
+| [.path]`/opt/couchbase/bin/`
+
+| Windows
+| [.path]`C:\Program Files\Couchbase\Server\bin\`
+
+| Mac OS X
+| [.path]`/Applications/CouchbaseServer.app/Contents/Resources/couchbase-core/bin/`
+|===
+
+== Options
+
+The tool takes a single argument, which must be one of the following:
+
+number::
+A number representing an error code.
+In this case, the tool returns the full details of the error matching the error code.
+
+string::
+A string.
+In this case, the tool searches for the target string in all of the error message fields except for `USER ERROR`, and returns the full details of any errors that match the string.
+
+regex::
+A regular expression.
+In this case, the tool searches for the regular expression in all of the error message fields except for `USER ERROR`, and returns the full details of any errors that match the pattern.
+
+== Output
+
+If the tool finds a single error that matches the find argument, it outputs the full details of the error.
+
+If the tool finds multiple errors that match the find argument, it outputs a list showing the code and description of each matching error.
+You can use the tool again, passing the code or description as an argument, to get the full details of any of these errors.
+
+Full error details include some or all of the following fields.
+
+[options="header", cols="50a,147a"]
+|===
+|Name|Description
+
+|**APPLIES TO**
+|One of the following:
+
+* `cbq-shell`: The error applies to the cbq shell.
+* `Server`: The error applies to the server.
+
+|**CODE**
+|A number representing the error.
+
+|**DESCRIPTION**
+|Message describing why the error occurred.
+
+|**REASON**
+|List of possible causes of the error.
+
+|**USER ACTION**
+|List of possible steps a user can take to mitigate the error.
+
+|**USER ERROR**
+|One of the following:
+
+* `Yes`: The error was caused by the user.
+* `No`: The error was caused by other services, or was internal to the server.
+* `Maybe`: A combination of both.
+|===
+
+NOTE: The error details also include a `SYMBOL` field, which contains a representation string for the error.
+This field is for internal use only, and is not shown in the output.
+However, the tool does search this field when the find argument is a string or a regular expression.
+
+== Examples
+
+[[finderr-ex1]]
+.Find error details by code number
+====
+.Command
+[source,sh]
+----
+./finderr 5011
+----
+
+.Output
+----
+CODE
+  5011 (error)
+
+
+DESCRIPTION
+  Abort: «reason»
+
+
+REASON
+  The SQL++ abort() function was called in the statement.
+  e.g. SELECT abort('An example cause')
+
+
+USER ERROR
+  Yes
+
+
+APPLIES TO
+  Server
+----
+====
+
+[[finderr-ex2]]
+.Find error details by matching a string
+====
+.Command
+[source,sh]
+----
+./finderr "A semantic error is present in the statement."
+----
+
+.Output
+----
+CODE
+  3100 (error)
+
+
+DESCRIPTION
+  A semantic error is present in the statement.
+
+
+REASON
+  The statement includes portions that violate semantic constraints.
+
+
+USER ACTION
+  The cause will contain more detail on the violation; revise the statement and re-submit.
+
+
+USER ERROR
+  Yes
+
+
+APPLIES TO
+  Server
+----
+====
+
+[[finderr-ex3]]
+.Find multiple errors by matching a string
+====
+.Command
+[source,sh]
+----
+./finderr "semantic"
+----
+
+.Output
+----
+Matching errors
+  3100 A semantic error is present in the statement.
+  3220 «name» window function «clause» «reason»
+  3300 recursive_with semantics: «cause»
+----
+====
+
+[[finderr-ex4]]
+.Find multiple errors by matching a regular expression
+====
+.Command
+[source,sh]
+----
+./finderr "[UI][NP]SERT"
+----
+
+.Output
+----
+Matching errors
+  3150 MERGE with ON KEY clause cannot have document key specification in INSERT action.
+  3160 MERGE with ON clause must have document key specification in INSERT action
+  3180 MERGE with ON KEY clause cannot have USE INDEX hint specified on target.
+  5006 Out of key validation space.
+  5050 No INSERT key for «document»
+  5060 No INSERT value for «document»
+  5070 Cannot INSERT non-string key «key» of type «type»
+  5071 Cannot INSERT non-OBJECT options «options» of type «type»
+  5072 No UPSERT key for «value»
+  5073 Cannot act on the same key multiple times in an UPSERT statement
+  5075 No UPSERT value for «value»
+  5078 Cannot UPSERT non-string key «key» of type «type».
+  5079 Cannot UPSERT non-OBJECT options «value» of type «type».
+  5330 Multiple INSERT of the same document (document key «key») in a MERGE statement
+ 12036 Error in INSERT of key: «key»
+ 15005 No keys to insert «details»
+----
+====
+
+== See Also
+
+* The {sqlpp} xref:n1ql:n1ql-language-reference/metafun.adoc#finderr[FINDERR()] function
+* xref:n1ql:n1ql-language-reference/n1ql-error-codes.adoc[]