Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
bb351f2
DOC-12321: Add docs for finderr tool and builtin function (#3681)
simon-dew Sep 5, 2024
f5d3b4a
Adding details for
RayOffiah Nov 6, 2024
af41ba8
[DOC-12706]: Documentation needed for changes to the Prometheus Disco…
RayOffiah Nov 8, 2024
e921b9a
Added release note workaround for https://jira.issues.couchbase.com/b…
RayOffiah Nov 9, 2024
21a61e3
Changed https://jira.issues.couchbase.com/browse/MB-64155 to a bug fix.
RayOffiah Nov 11, 2024
8ff3a32
The release note for 7.6.3 wasn't included in the 7.6.4 branch.
RayOffiah Nov 11, 2024
40ffed1
https://jira.issues.couchbase.com/browse/MB-63414[MB-63414] moved fro…
RayOffiah Nov 13, 2024
bd43d1f
[DOC-12684]: Update Explore the Server Configuration page (#3720)
RayOffiah Nov 15, 2024
e7f052d
[DOC-12684]: Update Explore the Server Configuration page (#3731)
RayOffiah Nov 21, 2024
784f4fb
[DOC-12608] Adding note on cosine similarity metric. (#3735)
sarahlwelton Nov 21, 2024
b969beb
Adding note on Server tools packages for DOC 12539
rao-shwe Dec 3, 2024
8d4d090
DOC-12728 deprecate windows 10 (#3740)
ggray-cb Dec 3, 2024
44b0aaf
Minor tweaking for the server admin/developer entry.
RayOffiah Dec 4, 2024
fba1bb4
[DOC-12432] Add Whats New for ctl: validate (#3746)
sarahlwelton Dec 6, 2024
52f4f35
DOC-12777: Update Eventing REST API with sync-gateway-aware options (…
simon-dew Dec 9, 2024
02b7f9e
[DOC-12515]: Improve the diagram on the Upgrade page. (#3682)
RayOffiah Sep 6, 2024
4c4e86d
[quickfix/release/7.6] (#3684)
RayOffiah Sep 6, 2024
5e55b97
[DOC-12496]: Create release note for Couchbase Server 7.6.3 (#3675)
RayOffiah Sep 6, 2024
560d606
DOC-12453 restore different storage engines (and fixes to Auto-remove…
ggray-cb Sep 10, 2024
f292e7e
[DOC-12528]: Add MB-63414 to the 7.6.3 release note. (#3685)
RayOffiah Sep 10, 2024
3099db7
DOC-10729: fix broken internal link (#3687)
osfameron Sep 13, 2024
c1840c1
[DOC-11486]: Raise visibility of 'Guarding against Data Loss during X…
RayOffiah Sep 14, 2024
e6f607b
[CBSE-17766]: Amadeus: Docs: Swap Rebalance: Explicitly mention to no…
RayOffiah Sep 16, 2024
9f26232
Fix cbbs task fail system event reference (#3571)
TanGafCS Sep 17, 2024
740ad8f
Removed line about NRU (#3531)
julia-cb Sep 17, 2024
a660ea1
DOC-10648 windows install permissions (#3697)
ggray-cb Sep 17, 2024
d3534dc
Update list-cluster-nodes.adoc (#3698)
hyunjuV Sep 20, 2024
d4c498f
[DOC-11500]: Completely incorrect and misleading example. (#3707)
RayOffiah Sep 30, 2024
71aa512
typo fix
RichardSmedley Oct 1, 2024
6ef444a
Merge pull request #3711
RayOffiah Oct 9, 2024
dbad3a1
DOC-12650: Convert N1QL REST API references to use OpenAPI generator …
simon-dew Oct 18, 2024
1d57b1c
DOC-12652: Convert other server REST API references to use OpenAPI ge…
simon-dew Oct 22, 2024
fc8d54d
Update rest-initialize-node.adoc to fix wrong field/key name in synta…
hyunjuV Oct 29, 2024
36b1a8e
Update rest-initialize-cluster.adoc syntax (#3701)
hyunjuV Oct 29, 2024
9d79817
DOC-12651: Convert Analytics REST API references to use OpenAPI gener…
simon-dew Nov 1, 2024
aac4783
Fix apostrophes in example commands (#3098)
CB-DavidPancic Nov 1, 2024
84a80e1
Remove extra blank line in description (#3110)
BKaneAtWork Nov 1, 2024
c587b54
Quick clarification about unequal groups (#2877)
BKaneAtWork Nov 1, 2024
aea205d
Update data-service.adoc (#2357)
nawazish-github Nov 1, 2024
cd618d0
Update automatic-failover.adoc (#3224)
BKaneAtWork Nov 1, 2024
cd3cd40
[DOC-10997] Delete fts-pagination as it's now covered by documentatio…
sarahlwelton Nov 20, 2024
6995625
[DOC-12729]: Feedback on Disabling Transparent Huge Pages (THP) | Cou…
RayOffiah Nov 22, 2024
8a13b80
[DOC-12759]: Feedback on Auto-Compaction | Couchbase Docs (#3736)
RayOffiah Nov 25, 2024
0d2b0dd
[DOC-12356]: Feedback on Storage Properties | Couchbase Docs (#3737)
RayOffiah Nov 25, 2024
dd60b45
Typo fix (#3745)
ggray-cb Dec 4, 2024
3504836
DOC-12539 Update Server dev tools package and add Server admin tools …
rao-shwe Dec 10, 2024
fd57295
DOC-12605 Update GSI Rebalance Settings (#3744)
rao-shwe Dec 10, 2024
d3c7fed
Update Release Notes for 7.6.4 (#3752)
bfavini Dec 10, 2024
c88f59a
Merge branch 'release/7.6' into prerelease/7.6.4
simon-dew Dec 11, 2024
c12e730
Fixed a structural bug on the release note.
RayOffiah Dec 11, 2024
4e98994
edits in mctestauth (#3755)
rao-shwe Dec 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down
75 changes: 63 additions & 12 deletions modules/cli/pages/cli-intro.adoc
Original file line number Diff line number Diff line change
@@ -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}
Expand Down Expand Up @@ -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.
221 changes: 221 additions & 0 deletions modules/cli/pages/finderr.adoc
Original file line number Diff line number Diff line change
@@ -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[]
Loading