- 
                Notifications
    You must be signed in to change notification settings 
- Fork 183
DOC-11702: IA Phase 2 — Backport IA refresh to server #3545
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Merged
      
      
            simon-dew
  merged 24 commits into
  couchbase:DOC-11965-ia-refresh-76
from
simon-dew:DOC-11702-76
  
      
      
   
  Apr 16, 2024 
      
    
  
     Merged
                    Changes from all commits
      Commits
    
    
            Show all changes
          
          
            24 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      11a0c67
              
                Update nav for devex docs
              
              
                simon-dew ca7ed04
              
                Query workbench: add signposting and escape hatch
              
              
                simon-dew 1e589e3
              
                Query workbench: put results before insights
              
              
                simon-dew 836add5
              
                Remove Import Documents from Manage nav
              
              
                simon-dew 0d866e2
              
                Import Documents: add pagination and signposting,
              
              
                simon-dew 540c154
              
                Remove Manage Indexes from Manage nav
              
              
                simon-dew daa0480
              
                Remove Monitor Queries and Monitor Indexes from Monitor nav
              
              
                simon-dew 200a25c
              
                Add Manage Documents dev guide
              
              
                simon-dew 1aebe65
              
                Update Couchbase Web Console doc to cut down on documentation managem…
              
              
                simon-dew 381f27c
              
                Update Manage Indexes doc to cut down on query workbench instructions
              
              
                simon-dew 4b3104e
              
                Add Index Advice for CE to query workbench doc
              
              
                simon-dew 4c2826c
              
                Minor updates to Query Monitoring
              
              
                simon-dew 655b3cf
              
                Temp fix for Eventing section
              
              
                simon-dew 080bac6
              
                Rename settings and parameters
              
              
                simon-dew 8864a68
              
                Hide tools-ref
              
              
                simon-dew bd7f954
              
                Rename Monitor Queries → Manage and Monitor Queries
              
              
                simon-dew fcf5a19
              
                Manage documents:
              
              
                simon-dew a61eae2
              
                Add component signposts and escape hatches where needed
              
              
                simon-dew e826179
              
                Minor formatting changes for import documents, manage and monitor ind…
              
              
                simon-dew 16a19d9
              
                Synchronize tabs in CBQ and Query Settings
              
              
                simon-dew eb9dadc
              
                Fix request-level REST API example in Query Settings
              
              
                simon-dew 06ebc8e
              
                Move analytics icon to analytics repo
              
              
                simon-dew fd89ed1
              
                Delete tools-ref
              
              
                simon-dew bc0adac
              
                DOC-10181: Query Monitor is only available in Enterprise Edition
              
              
                simon-dew File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              This file was deleted.
      
      Oops, something went wrong.
      
    
  
        
          
          
            94 changes: 50 additions & 44 deletions
          
          94 
        
  modules/manage/pages/import-documents/import-documents.adoc
  
  
      
      
   
        
      
      
    Large diffs are not rendered by default.
      
      Oops, something went wrong.
      
    
  
        
          
          
            130 changes: 130 additions & 0 deletions
          
          130 
        
  modules/manage/pages/manage-documents/manage-documents.adoc
  
  
      
      
   
        
      
      
    
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| = Manage Documents in the Couchbase Web Console | ||
| :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. | ||
| :escape-hatch: cloud:clusters:data-service/manage-documents.adoc | ||
|  | ||
| [abstract] | ||
| {description} | ||
|  | ||
| include::ROOT:partial$component-signpost.adoc[] | ||
|  | ||
| == Access the Documents Workbench | ||
|  | ||
| You can use the *Documents* workbench to view and manage documents in a database. | ||
|  | ||
| image::manage-ui/documentsScreenWithDocuments.png["The Documents workbench with documents displayed",700] | ||
|  | ||
| To display the *Documents* workbench, do one of the following: | ||
|  | ||
| * In the Couchbase Web Console, choose menu:Documents[Workbench]. | ||
|  | ||
| * Alternatively, choose menu:Buckets[], then click the *Documents* link for any bucket, scope, or collection. | ||
|  | ||
| [#retrieve-documents] | ||
| == Retrieve Documents | ||
|  | ||
| You can use the *Documents* workbench 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* workbench 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. | ||
|  | ||
| * *N1QL WHERE*: Accepts a {sqlpp} query -- specifically, a WHERE clause which determines the subset of documents to show. | ||
|  | ||
| // The control really is called N1QL WHERE. Do not update. | ||
|  | ||
| 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 *N1QL WHERE* to specify a set of documents, then click btn:[Retrieve Docs] to retrieve the documents based on your configuration. | ||
|  | ||
| . (Optional) To view successive sets of documents, use the *next batch >* and *< prev batch* controls. | ||
|  | ||
| == 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. | ||
|  | ||
| . (Optional) Click *Data* to view the document data. | ||
| This comprises a series of key-value pairs in JSON format, which may be nested. | ||
| You can make modifications to the document data. | ||
| + | ||
| image::manage-ui/editDocumentData.png["The Edit Document dialog showing document data",300] | ||
|  | ||
|  | ||
| . (Optional) Click *Metadata* to view the xref:learn:data/data.adoc#metadata[document metadata]. | ||
| It's not possible to edit a document's metadata. | ||
| Couchbase Server generates metadata when the document is saved. | ||
| + | ||
| image::manage-ui/editDocumentMetaData.png["The Edit Document dialog showing document metadata",300] | ||
|  | ||
| . Click btn:[Save] to save your changes. | ||
|  | ||
| == Edit Existing Documents in Spreadsheet View | ||
|  | ||
| When spreadsheet view is enabled, you can edit an existing document directly in the results area. | ||
|  | ||
| To edit existing documents in spreadsheet view: | ||
|  | ||
| . <<retrieve-documents,Retrieve>> the document to display it in the results area. | ||
| . Click *enable field editing* so that the switch is enabled. | ||
| . Edit any of the existing fields in the document. | ||
| . Click the save icon icon:save[] next to the document name. | ||
|  | ||
| == Copy Existing Documents | ||
|  | ||
| To create a copy of an existing document: | ||
|  | ||
| . <<retrieve-documents,Retrieve>> the document to display it in the results area. | ||
| . Click the copy icon icon:copy[] next to the document name. | ||
| . Enter a document *ID* and edit the contents of the document. | ||
| . Click btn:[Save] to create the document. | ||
|  | ||
| == Create New Documents | ||
|  | ||
| To create a new document: | ||
|  | ||
| . Click btn:[Add Document]. | ||
| . Enter a document *ID* and edit the 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:[Continue] to delete the document. | ||
|  | ||
| == Related Links | ||
|  | ||
| To import a set of JSON documents or a CSV file, see xref:manage:import-documents/import-documents.adoc[]. | 
      
      Oops, something went wrong.
        
    
  
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
Uh oh!
There was an error while loading. Please reload this page.