Skip to content

nav.adoc

Latest commit

 

History

History
621 lines (580 loc) · 38.5 KB

nav.adoc

File metadata and controls

621 lines (580 loc) · 38.5 KB
Introduction

  • Why Couchbase?

  • What’s New?

  • Developer Preview Mode

Get Started

  • getting-started:start-here.adoc

  • getting-started:do-a-quick-install.adoc

  • getting-started:look-at-the-results.adoc

  • getting-started:try-a-query.adoc

  • getting-started:choose-your-next-steps.adoc

Develop

develop:partial$nav.adoc tutorials:partial$nav.adoc guides:partial$nav.adoc n1ql:partial$nav.adoc vector-index:partial$nav.adoc search:partial$nav.adoc eventing:partial$nav.adoc analytics:partial$nav.adoc * SDKs Distributed ACID Transactions Field Level Encryption Response Time Observability Spring Data Couchbase Starter Kits Troubleshooting Connections with SDK Doctor third-party:partial$nav.adoc

Learn

  • Overview

    • Glossary

    • List of Architecture Diagrams

  • Data

    • Data Model

    • learn:data/n1ql-versus-sql.adoc

    • Extended Attributes

    • Scopes and Collections

    • Change History

    • Expiration

    • Indexes

    • Durability

    • Transactions

  • Buckets, Memory, and Storage

    • Buckets

      • vBuckets

      • Compression

    • Memory and Storage

      • Memory

      • Storage Engines

      • Storage Properties

  • Services

    • Data Service

    • Query Service

    • Index Service

    • Search Service

    • Analytics Service

    • Eventing Service

    • Backup Service

  • Clusters and Availability

    • Cluster Manager

    • Metadata Management

    • Connectivity

    • System Events

    • Size Limits

    • Nodes

      • Rebalance

        • Index Rebalance

        • Index Rebalance Use Cases

      • Removal

      • Failover

        • Graceful

        • Hard

        • Automatic

      • learn:clusters-and-availability/unstable-nodes.adoc

      • Recovery

      • Node-to-Node Encryption

    • Availability

      • Intra-Cluster Replication

      • Cross Data Center Replication (XDCR)

        • XDCR Advanced Filtering

        • XDCR Conflict Resolution

        • XDCR with Scopes and Collections

        • XDCR enableCrossClusterVersioning

        • XDCR Conflict Logging

          • Viewing Conflict Logs

        • XDCR Active-Active with Sync Gateway

        • xdcr-reference:xdcr-lowering-memory-footprint.adoc

      • Server Group Awareness

  • Security

    • Authentication

      • Understanding Authentication

      • Usernames and Passwords

      • Authentication Domains

      • Certificates

        • Using Multiple Root Certificates

    • Authorization

      • Roles

    • On-the-Wire Security

    • Auditing

    • Encryption

      • learn:security/native-encryption-at-rest-overview.adoc

Manage

  • Overview

    • Couchbase Web Console

  • Manage Nodes and Clusters

    • Initialize a Node

    • Create a Cluster

    • Add a Node and Rebalance

    • Join a Cluster and Rebalance

    • List Cluster Nodes

    • Remove a Node and Rebalance

    • Fail a Node Over and Rebalance

      • Graceful

      • Hard

    • Recover a Node and Rebalance

    • Adding or Removing the Data Service on Existing Nodes

    • Modify Services and Rebalance

    • Manage Node-to-Node Encryption

    • Manage Address Families

  • Manage Buckets

    • Create a Bucket

    • Edit a Bucket

    • Flush a Bucket

    • Drop a Bucket

    • manage:manage-buckets/migrate-bucket.adoc

    • manage:manage-buckets/change-ejection-policy.adoc

  • Manage Scopes and Collections

  • Manage Logging

  • Manage Settings

    • General

    • Auto-Compaction

    • Alerts

    • Sample Buckets

  • Manage Server Groups

  • Manage XDCR

    • Prepare for XDCR

    • Create a Reference

    • Create a Replication

    • Pause a Replication

    • Resume a Replication

    • Delete a Replication

    • Delete a Reference

    • Secure a Replication

      • Half-Secure

      • Fully Secure

    • Replicate Using Scopes and Collections

    • Filter a Replication

    • Incoming Replications

    • Recover Data with XDCR

    • xdcrDiffer Utility

  • Manage Security

    • Manage Security Settings

    • Manage Users, Groups, and Roles

    • Manage Authentication

      • Configure LDAP

      • Configure saslauthd

      • Configure SAML

      • Configure PAM

      • Manage Passwords

      • Manage Certificates

        • Configure Server Certificates

        • Configure Client Certificates

        • Enable Client-Certificate Handling

        • Certificate Rotation

        • Certificate Error Handling

    • Manage On-the-Wire Security

    • manage:manage-security/manage-native-encryption-at-rest.adoc

    • Manage Auditing

    • Manage Sessions

    • Manage Console Access

    • Manage System Secrets

    • Manage Connections and Disks

  • Manage Statistics

  • Manage Expiration

  • Manage Backup and Restore

    • cbbackupmgr

      • Strategies

      • Tutorial

      • Cloud Backup

      • Network Filesystems

      • Encryption

  • Monitor

    • Monitor Clock Drift

    • manage:monitor/set-up-prometheus-for-monitoring.adoc

    • manage:monitor/monitor-node-stability.adoc

  • Troubleshoot

    • Common Errors

    • Core Files

Install & Upgrade

  • Deployment Options

  • System Requirements

    • Supported Platforms

    • System Resource Requirements

    • Additional Requirements

    • Couchbase Server Ports

  • Deployment Guidelines

    • Sizing Guidelines

    • Clock Synchronization Requirements

    • Disable THP

    • Configure Kernel Swappiness

    • install:tcp_mem_settings.adoc

    • Security Considerations

    • install:install-splitlock-mitigation.adoc

    • Couchbase Server Process List

    • VM and Container Guidelines

    • Two-Node and Single-Node Clusters

  • Installation

    • Install on Linux

      • Red Hat, Oracle Linux, or Amazon Linux

      • Ubuntu & Debian

      • SUSE Enterprise

      • Non-Root Install and Upgrade

    • Install on Windows

    • Install on macOS

    • Verify the Installation

    • Startup and Shutdown

    • Uninstall

  • Cloud and Container Deployment

    • AWS

      • Deploy with AWS Marketplace

      • Deploy Sync Gateway with AWS Marketplace

    • Azure

      • Deploy with Azure Marketplace

    • GCP

      • Deploy with GCP Marketplace

    • Kubernetes & OpenShift

      • Deploy with Autonomous Operator

    • Docker

      • Install with Docker

    • Couchbase Containers FAQ

  • Upgrade

    • Upgrade-Procedure Selection

    • Upgrade Procedures

      • Cluster Offline

      • Cluster Online

        • At Reduced Capacity

        • At Full Capacity

        • install:upgrade-docker-cluster-online-full-capacity.adoc

      • IPv6 Cluster-Upgrade

    • Feature Availability During Upgrade

  • Data Migration

    • install:migrating-application-data.adoc

    • Enabling Timestamp-based Conflict Resolution for Migrated Data

Integrate

  • Connector Guides

  • Elasticsearch Plug-in

  • Kafka Connector

  • Spark Connector

  • Power BI Connector

  • Tableau Connector

  • Couchbase ODBC and JDBC Drivers

Reference

  • CLI Reference

    backup-restore:partial$nav.adoc tools:partial$nav-cbdatarecovery.adoc tools:partial$nav-cbdocloader.adoc tools:partial$nav-cbexport.adoc tools:partial$nav-cbimport.adoc cli:partial$cbcli/nav.adoc

    • cbanalyze-core

    • cbcollect_info

    • cbepctl

      • set checkpoint_param

      • set flush_param

    • cbft-bleve

      • cbft-bleve: Moss Indexes

      • cbft-bleve: Scorch Indexes

      • cbft-bleve: Zap Files

    • cblogredaction

    • cbq

    • cbqueryreportgen

    • cbrecovery

    • cbstats

      • all

      • checkpoint

      • collections

      • collections-details

      • config

      • dcp

      • dcpagg

      • dcp-vbtakeover

      • diskinfo

      • dispatcher

      • durability-monitor

      • failovers

      • hash

      • key

      • kvstore

      • kvtimings

      • memory

      • prev-vbucket

      • raw

      • reset

      • responses

      • runtimes

      • scheduler

      • scopes

      • scopes-details

      • tap-vbtakeover

      • tasks

      • timings

      • uuid

      • vbucket

      • vbucket-details

      • vbucket-seqno

      • vkey

      • warmup

      • workload

    • cbsummary

    • cbtransfer

    • cbmigrate

    • cbworkloadgen

    • couchbase-server

    • finderr

    • mctimings

    • mcstat

    • mctestauth

  • REST API Reference

    • Nodes and Clusters API

      • Cluster Initialization and Provisioning

        • Initializing a Cluster

        • Initializing a Node

        • Establishing Credentials

        • Naming a Node

        • Configuring Memory

        • Naming a Cluster

        • Getting Memory Information

        • Assigning Services to a New Single Node

        • Assigning Services to an Existing Node

      • Node Addition and Removal

        • Adding Nodes to Clusters

        • Joining Nodes into Clusters

        • Removing Nodes from Clusters

      • Rebalance

        • rest-api:file-based-data-rebalance.adoc

        • Getting Rebalance Reason Codes

        • Rebalancing the Cluster

        • Getting Rebalance Progress

        • Configuring Rebalance Retries

        • Getting Rebalance-Retry Status

        • Canceling Rebalance Retries

        • Limiting Concurrent vBucket Moves

        • Disabling Consistent View Query Results on Rebalance

      • Manual Failover

        • Performing Hard Failover

        • Reinitializing Nodes

        • Performing Graceful Failover

        • Setting Recovery Type

      • Auto-Failover

        • Retrieving Auto-Failover Settings

        • Enabling and Disabling Auto-Failover

        • Resetting Auto-Failover

        • Setting Recovery Type

      • Settings and Connections

        • Managing Internal Settings

        • Managing Cluster Connections

        • Managing Alternate Addresses

        • Setting Alerts

        • rest-api:disk-usage-limits.adoc

      • Status and Events

        • Getting Cluster Tasks

        • Retrieving Cluster Information

        • Viewing Cluster Details

        • Getting System Events

        • Identifying the Orchestrator Node

        • Getting Information on Nodes

        • Listing Node Services

      • Statistics

        • Prometheus Discovery API

        • Getting a Single Statistic

        • Getting Multiple Statistics

      • Logging

        • Retrieving Diagnostic and Log Information

        • Collecting Logs

        • Logging Client-Side Errors

      • rest-api:application-telemetry.adoc

    • Buckets API

      • Creating and Editing Buckets

      • Setting a Replica-Minimum

      • Getting Bucket Information

      • Listing Nodes by Bucket

      • Getting Bucket Statistics

      • Getting Bucket Streaming URI

      • Deleting Buckets

      • Flushing Buckets

      • Managing Sample Buckets

    • Scopes and Collections API

      • Creating a Scope

      • Creating and Editing a Collection

      • Listing Scopes and Collections

      • Dropping a Collection

      • Dropping a Scope

    • Memory and Storage API

      • Initializing a Node

      • Configuring Memory

      • Getting Memory Information

      • rest-api:rest-reader-writer-thread-config.adoc

      • Getting Storage Information

      • Performing Compaction Manually

      • Auto-Compaction: Global

      • Auto-Compaction: Per Bucket

    • Server Groups API

      • Getting Group Information

      • Creating Groups

      • Adding Nodes to Groups

      • Renaming Groups

      • Updating Group Membership

      • Deleting Groups

    • XDCR API

      • Creating or Editing a Reference

      • Checking Connections

      • Getting a Reference

      • Creating a Replication

      • Pausing and Resuming a Replication

      • Deleting a Replication

      • Deleting a Reference

      • Listing Incoming Replications

      • Managing Advanced Settings

      • Getting Statistics

    • Security API

      • Who Am I?

      • Configure Auditing

      • Restrict Node-Addition

      • Authentication API

        • Configure LDAP

        • Configure SAML

        • Configure saslauthd

        • Set Password Policy

        • Change Password

        • Certificate Management API

          • Load Root Certificates

          • Get Root Certificates

          • Delete Root Certificates

          • Retrieve All Node Certificates

          • Upload and Retrieve a Node Certificate

          • Regenerate All Certificates

          • Deprecated Certificate Management APIs

            • Upload and Retrieve the Root Certificate

      • rest-api:security/encryption-at-rest/encryption-at-rest.adoc

        • rest-api:security/encryption-at-rest/manage-encryption-keys.adoc

        • rest-api:security/encryption-at-rest/manage-system-encryption-at-rest.adoc

        • rest-api:security/encryption-at-rest/rotate-encryption-at-rest-key.adoc

        • rest-api:security/encryption-at-rest/force-encryption-at-rest.adoc

        • rest-api:security/encryption-at-rest/drop-encryption-deks.adoc

      • Authorization API

        • Role-Based Access Control (RBAC)

      • Configure On-the-Wire Security

      • Rotate Internal Credentials

      • Configure HSTS

      • System Secrets API

        • Configure System Secrets

        • Change the Master Password

        • Rotate the Data Key

    • n1ql:n1ql-rest-api/intro.adoc

      • n1ql-rest-query:index.adoc

        • n1ql:n1ql-rest-api/examplesrest.adoc

          • n1ql:n1ql-rest-api/exsuccessful.adoc

          • n1ql:n1ql-rest-api/expositional.adoc

          • n1ql:n1ql-rest-api/exnamed.adoc

          • n1ql:n1ql-rest-api/extimeout.adoc

          • n1ql:n1ql-rest-api/exrequesterror.adoc

          • n1ql:n1ql-rest-api/exserviceerror.adoc

          • n1ql:n1ql-rest-api/exn1qlerror.adoc

          • n1ql:n1ql-rest-api/exunsupportedhttp.adoc

          • n1ql:n1ql-rest-api/exauthhttp.adoc

          • n1ql:n1ql-rest-api/exauthrequest.adoc

      • n1ql-rest-admin:index.adoc

      • n1ql-rest-settings:index.adoc

      • n1ql-rest-functions:index.adoc

    • Index Service API

      • Retrieve GSI Settings

      • Set GSI Settings

      • Index Statistics API

      • Index Settings API

    • Backup Service API

      • Create and Edit Plans

      • Create a Repository

      • Get Backup Repository Information

      • Get Backup Plan Information

      • Get Backup Task History

      • Pause and Resume Tasks

      • Examine Backed-Up Data

      • Perform an Immediate Backup

      • Perform an Immediate Merge

      • Perform an Immediate Prune

      • Retain a Backup

      • Restore Data

      • Delete a Backup

      • Archive a Repository

      • Import a Repository

      • Delete a Repository

      • Delete a Plan

      • Get Expired Backup Information

      • Get Information on the Cluster

      • Manage Backup Configuration

      • rest-api:backup-node-threads.adoc

    • Search Service API

      • Node Configuration

      • Indexes

      • Advanced

      • Search Statistics

      • Active Queries

      • Search Manager Options

    • Eventing Service API

    • Analytics Service API

      • Analytics Service REST API

      • Analytics Admin REST API

      • Analytics Config REST API

      • Analytics Settings REST API

      • Analytics Links REST API

      • Analytics Library REST API

  • XDCR Reference

    • Advanced Settings

    • Filtering

      • Regular Expressions

      • Filtering Expressions

      • Data-Type Conversion

    • Security and Networking

  • Audit Event Reference

  • System Event Reference

  • Rebalance Reference

  • Metrics Reference

    • Data Service Metrics

      • Data Service Metrics Cross Reference

    • Query Service Metrics

      • Query Service Metrics Cross Reference

    • Index Service Metrics

      • Index Service Metrics Cross Reference

    • Search Service Metrics

    • Eventing Service Metrics

    • Analytics Service Metrics

      • Analytics Service Metrics Cross Reference

    • Backup Service Metrics

    • Cluster Manager Metrics

    • XDCR Metrics

      • XDCR Metrics Cross Reference

  • Views Reference

    • View Concepts

      • Stream-based Views

      • View Operations

      • Views and Stored Data

      • Development Views

      • Production Views

    • MapReduce Views

      • Writing MapReduce Views

        • Views Best Practices

        • Map Function

        • Reduce Function

        • Built-in Utility Functions

        • Built-in _count Function

        • Built-in _sum Function

        • Built-in _stats Function

        • Re-writing Built-in Reduce Functions

        • Custom Reduce Functions

        • Re-reduce Argument

        • Views for Non-JSON Objects

        • Translating SQL to MapReduce

        • Views in a Schema-less Database

      • Querying MapReduce Views

        • View and Query Examples

    • Views API

      • Getting Design Doc Information

      • Creating Design Documents

      • Deleting Design Documents

      • Getting Views Information

      • Limiting Views Requests

Release Notes & Licenses
Contribute

  • Contribute to the Documentation