Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 9 additions & 14 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,8 @@
include::develop:partial$nav.adoc[]
include::tutorials:partial$nav.adoc[]
include::guides:partial$nav.adoc[]
include::search:partial$nav.adoc[]

* xref:home:ROOT:sdk.adoc[SDKs]
** xref:sdk-extensions::distributed-acid-transactions.adoc[Distributed ACID Transactions]
** xref:sdk-extensions::field-level-encryption.adoc[Field Level Encryption]
** xref:sdk-extensions::response-time-observability.adoc[Response Time Observability]
** xref:sdk-extensions::spring-data-couchbase.adoc[Spring Data Couchbase]
** xref:getting-started:starter-kits.adoc[Starter Kits]
** xref:sdk:sdk-doctor.adoc[Troubleshooting Connections with SDK Doctor]

include::n1ql:partial$nav.adoc[]
include::search:partial$nav.adoc[]
* xref:fts:fts-introduction.adoc[Search]
** xref:fts:fts-quickstart-guide.adoc[Quickstart Guide]
** xref:fts:fts-creating-indexes.adoc[Create Search Indexes]
Expand Down Expand Up @@ -201,6 +192,14 @@ include::n1ql:partial$nav.adoc[]
** xref:eventing:troubleshooting-best-practices.adoc[Troubleshooting and Best Practices]
** xref:eventing:eventing-faq.adoc[Frequently Asked Questions]
include::analytics:partial$nav.adoc[]
* xref:home:ROOT:sdk.adoc[SDKs]
** xref:sdk-extensions::distributed-acid-transactions.adoc[Distributed ACID Transactions]
** xref:sdk-extensions::field-level-encryption.adoc[Field Level Encryption]
** xref:sdk-extensions::response-time-observability.adoc[Response Time Observability]
** xref:sdk-extensions::spring-data-couchbase.adoc[Spring Data Couchbase]
** xref:getting-started:starter-kits.adoc[Starter Kits]
** xref:sdk:sdk-doctor.adoc[Troubleshooting Connections with SDK Doctor]
include::third-party:partial$nav.adoc[]

.Learn
* xref:learn:architecture-overview.adoc[Overview]
Expand Down Expand Up @@ -331,8 +330,6 @@ include::analytics:partial$nav.adoc[]
** xref:manage:manage-security/manage-system-secrets.adoc[Manage System Secrets]
** xref:manage:manage-security/manage-connections-and-disks.adoc[Manage Connections and Disks]
* xref:manage:manage-statistics/manage-statistics.adoc[Manage Statistics]
* xref:manage:manage-indexes/manage-indexes.adoc[Manage Indexes]
* xref:manage:import-documents/import-documents.adoc[Import Documents]
* xref:manage:manage-backup-and-restore/manage-backup-and-restore.adoc[Manage Backup and Restore]
** xref:backup-restore:enterprise-backup-restore.adoc[cbbackupmgr]
*** xref:backup-restore:cbbackupmgr-strategies.adoc[Strategies]
Expand All @@ -341,8 +338,6 @@ include::analytics:partial$nav.adoc[]
*** xref:backup-restore:cbbackupmgr-network-filesystems.adoc[Network Filesystems]
*** xref:backup-restore:cbbackupmgr-encryption.adoc[Encryption]
* xref:manage:monitor/monitor-intro.adoc[Monitor]
** xref:manage:monitor/monitoring-n1ql-query.adoc[Monitor Queries]
** xref:manage:monitor/monitoring-indexes.adoc[Monitor Indexes]
** xref:manage:monitor/xdcr-monitor-timestamp-conflict-resolution.adoc[Monitor Clock Drift]
** xref:manage:monitor/set-up-prometheus-for-monitoring.adoc[Configure Prometheus to Collect Couchbase Metrics]
* xref:manage:troubleshoot/troubleshoot.adoc[Troubleshoot]
Expand Down
23 changes: 15 additions & 8 deletions modules/manage/pages/import-documents/import-documents.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
= Import Documents
:imagesdir: ../../assets/images
:page-pagination:
:description: Couchbase Web Console provides a graphical interface for the importing of data, in both JSON and other formats.

[abstract]
{description}

[.signpost]
image:ROOT:couchbase-logo.svg["Couchbase Server", 25.6]
This page is for Couchbase Server.
For Couchbase Capella, see xref:cloud:clusters:data-service/import-data-documents.adoc[].

[#importing-data]
== Options for Importing Data

Expand All @@ -17,7 +24,7 @@ Data can be imported into Couchbase Server by means of the following:

The *cbimport json* and *cbimport csv* command-line utilities should be used in preference to Couchbase Web Console whenever high-performance importing is required; and especially when the data-set to be imported is greater in size than 100 MB.

For information on the *cbimport* command-line utilities, access the *cbimport* entry, in the *CLI Reference*, in the vertical navigation bar, to the left.
For information on the *cbimport* command-line utilities, see xref:tools:cbimport.adoc[].
The remainder of this page explains how to import data by means of Couchbase Web Console.
Note the following prerequisites:

Expand All @@ -29,7 +36,7 @@ The procedures below assume that a bucket named `testBucket` has been created.
* Before attempting to import data with Couchbase Web Console, ensure that the *Query Service* has been deployed on the cluster: data-import with Couchbase Web Console depends on this service.

[#access-the-import-documents-panel]
== Accessing the Import Documents Panel
== Access the Import Documents Panel

Access the *Import Documents* panel of Couchbase Web Console, as follows:

Expand All @@ -46,7 +53,7 @@ The *Import* panel is now displayed:
image::import-documents/importDocumentsPanel.png[,720,align=left]

[#understanding-the-import-panel]
== Understanding the Import Panel
== Understand the Import Panel

The *Import* panel displays the following interactive graphical elements:

Expand Down Expand Up @@ -107,7 +114,7 @@ Status on the operation is displayed immediately below the button.
Note that if the operation takes a long time, the button's label is changed to *Cancel*; at which point, by left-clicking, the user can cancel the import operation.

[#import-a-json-list]
== Importing a JSON List
== Import a JSON List

To be imported, JSON documents must be specified in a file: the file itself must then specified as the target for import.
Within the file, the documents can be specified in either of two ways: as a _list_, or as a series of _lines_.
Expand Down Expand Up @@ -207,7 +214,7 @@ Each has been automatically assigned an id.
The documents can now be inspected and edited, by means of the *Workbench*.

[#importing-into-scopes-and-collections]
=== Importing into Scopes and Collections
=== Import into Scopes and Collections

A _collection_ is a data container, defined on Couchbase Server, within a bucket whose type is either _Couchbase_ or _Ephemeral_.
A _scope_ is a mechanism for the grouping of multiple collections.
Expand All @@ -234,7 +241,7 @@ This can be validated by accessing the *Documents* panel, and specifying the app
image::import-documents/documentsImportedIntoCollection.png[,720,align=left]

[#importing-json-lines]
== Importing JSON Lines
== Import JSON Lines

A _JSON Lines_ file is one that contains one or more JSON documents, each on a separate line.
The following procedure demonstrates how to import such a file.
Expand Down Expand Up @@ -279,7 +286,7 @@ image::import-documents/importedDocumentsWithEmployeeNumberID.png[,720,align=lef
Thus, each document has been imported, with its `employeeNumber` value as the id of the document.

[#importing-csv-and-tsv-files]
== Importing CSV and TSV Files
== Import CSV and TSV Files

To import a CSV (_comma-separated values_) file, proceed as follows:

Expand Down Expand Up @@ -318,7 +325,7 @@ davis 0009324
----

[#handling-errors]
== Handling Errors
== Handle Errors

If the contents of a file selected for import are inconsistent, Couchbase Server displays an error notification.
For example:
Expand Down
117 changes: 117 additions & 0 deletions modules/manage/pages/manage-documents/manage-documents.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
= Manage Documents
:imagesdir: ../../assets/images
:page-topic-type: guide
:page-pagination:
:description: Couchbase Web Console provides a graphical interface that you can use to view and edit documents.

// FIXME: Needs further information about spreadsheet view, copying existing records, etc.

[abstract]
{description}

[.signpost]
image:ROOT:couchbase-logo.svg["Couchbase Server", 25.6]
This page is for Couchbase Server.
For Couchbase Capella, see xref:cloud:clusters:data-service/manage-documents.adoc[].

== Access Documents in the Couchbase Web Console

You can use the *Documents* tool to view and manage documents in a database.

To display the *Documents* tool, do one of the following:

* In the Couchbase Web UI, click menu:Documents[].

* Alternatively, click menu:Buckets[], then click the *Documents* link for any bucket, scope, or collection.

[#retrieve-documents]
== Retrieve Documents

You can use the *Documents* tool to retrieve and view the individual documents contained within a bucket, scope, or collection on the database.
The retrieved documents are summarized in a table format, with a row for each retrieved document.
Document retrieval controls at the top of the summary control the retrieval and display of documents.

The *Documents* tool has the following controls:

* *Keyspace*: A set of three related drop-down menus:

** A drop-down menu that displays the name of the bucket whose documents are shown.
You can use the drop-down menu to select from a list of buckets in the current database.

** A drop-down menu that displays the name of the scope whose documents are shown.
The `_default` scope is the default.
You can use the drop-down menu to select from a list of all the scopes within the current bucket.

** A drop-down menu that displays the name of the collection whose documents are shown.
The `_default` collection is the default.
You can use the drop-down menu to select from a list of all the collections within the current scope.

* *Limit*: The maximum number of rows (documents) to retrieve and display at once.

* *Offset*: The number of documents in the entire set of the current bucket that is skipped, before display begins.

* *Document ID*: Accepts the ID value of a specific document.
Leave this field blank to retrieve documents based on *Limit* and *Offset*.

* *show range*: Enables you to enter starting ID and ending ID values to specify a range of ID values.

* *SQL++ WHERE*: Accepts a {sqlpp} query -- specifically, a WHERE clause which determines the subset of documents to show.

To retrieve a set of documents:

. Use the *Keyspace* drop-down menus to specify the location of the documents you want to view.
The set of retrieved documents is automatically updated based on your selections.

. (Optional) Use *Limit*, *Offset*, *Document IT*, or *SQL++ WHERE* to specify a set of documents, then click btn:[Retrieve Docs] to retrieve the documents based on your configuration.

== View and Edit Existing Documents

To view and edit a document:

. <<retrieve-documents,Retrieve>> a set of documents.

. Click on a document name, or click the pencil icon icon:pencil[] next to the document name.

+
Toggle the following tabs:

+
[#json-metadata,cols="1,2",options="header"]
|===

|Tab
|Description

|*Data*
|Comprises a series of key-value pairs sometimes expressed as name-value pairs.
You can make modifications to key-values.

|*Metadata*
|View the document's metadata.

It's not possible to edit a document's metadata as Couchbase Server generates when the document is saved.
For more information, see xref:learn:data/data.adoc#metadata[document metadata].

|===

. Click btn:[Save] to save your changes.

== Create Documents

To create a document:

. Click btn:[Add Document].
. Enter the *Document ID* and edit the *Data* contents of the document.
. Click btn:[Save] to create the document.

== Delete Documents

To delete a document:

. <<retrieve-documents,Retrieve>> the document to display it in the results area.
. Click the Trash icon icon:trash[] next to the document name.
. Click btn:[Delete].

== Related Links

To import a set of JSON documents or a CSV file, see xref:manage:import-documents/import-documents.adoc[].
94 changes: 1 addition & 93 deletions modules/manage/pages/manage-indexes/manage-indexes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -155,99 +155,7 @@ image::manage-indexes/indexInQueryWorkbench.png[,700,align=left]
. Modify the {sqlpp} index-definition, as required.
(Note that you cannot change the definition of the existing index, but you can create a new index with the modified definition.)

Immediately beneath the *Query Editor*, four buttons are displayed.
These can be used to test queries, and to determine how to design corresponding indexes; so as to maximize query-performance.
The buttons are as follows.

==== Execute

When left-clicked on, this executes the query that has been typed into the *Query Editor*.
For example, type the following query into the *Query Editor*: `SELECT icao FROM &#96;travel-sample&#96; WHERE name = "SeaPort Airlines";`.
This selects every `icao` key-value pair from the bucket `travel-sample`, where the host document also contains a `name` value that is `SeaPort Airlines`:

image::manage-ui/queryEditorWithSelectQuery.png[,540,align=left]

Left-click on the *Execute* button.

image::manage-ui/leftClickOnExecuteButton.png[,110,align=left]

Couchbase Web Console now provides feedback on the ongoing execution of the query, to the right of the buttons.
When query-execution has concluded, the results are duly displayed:

image::manage-indexes/resultsOfqueryExecution.png[,520,align=left]

Note also that the default appearance of the *Query* screen includes, at the upper right, a button labeled *query context*:

image::manage-indexes/queryContextButton.png[,120,align=left]

Left-click on the control at the right-hand side of the button, to reveal its pulldown menu.
This menu contains an entry for each bucket defined on the cluster:

image::manage-indexes/bucketsButton.png[,120,align=left]

Once a bucket has been selected, a further button (with pulldown-menu control) appears to the right, allowing selection of a scope within the selected bucket:

image::manage-indexes/scopesButton.png[,240,align=left]

Once a scope &#8212; for example, `inventory` &#8212; has been selected, queries can be entered into the *Query Editor* panel without explicit specification of bucket or scope being required: the bucket and scope for the query will be inferred from the pulldown-menu selections that have been made.
For example, the following expression performs a query on the documents in the `airline` collection; which itself resides within `inventory`, within `travel-sample`:

image::manage-indexes/queryEditorWithShorterSelectQuery.png[,540,align=left]

Note that buckets and scopes other than those currently selected by means of the pulldown menus can still be explicitly specified within the *Query Editor*, if required.

==== Explain

When left-clicked on, this provides an explanation of how query-execution proceeded:

image::manage-ui/leftClickOnExplainButton.png[,110,align=left]

The explanation is now displayed in the *Query Results* panel:

image::manage-ui/queryExplanation.png[,720,align=left]

This indicates the bucket and primary index scan that have been used in the query; as well as the filter applied, and the number of terms returned.

==== Index Advisor

When left-clicked on, this displays advice as to what index or indexes might be created, in order to improve the future performance of the query:

image::manage-indexes/leftClickOnAdviseButton.png[,110,align=left]

Advice is duly displayed in the *Query Results* panel:

image::manage-indexes/queryAdviceDisplay2.png[,440,align=left]

In this instance, the advice consists of two options; which are, respectively, the creation of a _covering_ index, and the creation of a regular index.
To create a covering index, left-click on the *Create and Build Covering Index* button:

The following notification is now displayed:

image::manage-ui/indexCreateWarning.png[,380,align=left]

Left-click on *Continue*.
When index-creation is completed, the following success-message appears on the *Query* screen:

image::manage-ui/createIndexSuccessMessage.png[,620,align=left]

==== Run as TX

The *Run as TX* button allows the specified query to be run transactionally, across multiple indexes.
For information on transactions, see xref:learn:data/transactions.adoc[Transactions].

Left-click on the *Run as TX* button, and the query is run as a transaction.
When the transaction is complete, status is displayed as follows:

image::manage-indexes/transactionSuccessDisplay.png[,620,align=left]

=== Index-Definition Support in Community Edition

Note that in Couchbase Server _Community_ Edition, index-definition support is provided in a slightly different way.
The area immediately below the *Query Editor* appears as follows:

image::manage-ui/ceIndexAdvisorLink.png[,320,align=left]

The https://index-advisor.couchbase.com/indexadvisor/#1[External Query Advisor^] link takes the user to an external web-site, where the *Query Advisor* can be accessed and used.
For more information on using the Query Workbench, see xref:tools:query-workbench.adoc[].

[[drop-index]]
=== Drop the Index
Expand Down
Loading