• Couchbase
  • Couchbase Documentation Couchbase Documentation
  • Server
  • Mobile
  • SDKs
Downloads Start Free Trial
Navigation
Server
  • Couchbase Server
    • Introduction
      • Why Couchbase?
      • What’s New?
      • Developer Preview Mode
    • Get Started
      • Start Here!
      • Do a Quick Install
      • Explore the Server Configuration
      • Run Your First SQL++ Query
      • Choose Your Next Steps
    • SDKs
      • Distributed ACID Transactions
      • Field Level Encryption
      • Response Time Observability
      • Spring Data Couchbase
      • Starter Kits
    • Learn
      • Overview
        • Glossary
        • List of Architecture Diagrams
      • Data
        • Data Model
        • SQL++ versus SQL
        • Extended Attributes
        • Scopes and Collections
        • Change History
        • Indexes
        • Durability
        • Expiration
        • Transactions
      • Buckets, Memory, and Storage
        • Buckets
          • vBuckets
          • Compression
        • Memory and Storage
          • Memory
          • Storage Engines
          • Storage Settings
      • 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
          • Removal
          • Failover
            • Graceful
            • Hard
            • Automatic
          • 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
          • Server Group Awareness
      • Security
        • Authentication
          • Understanding Authentication
          • Usernames and Passwords
          • Authentication Domains
          • Certificates
            • Using Multiple Root Certificates
        • Authorization
          • Roles
          • Upgrading to RBAC
        • On-the-Wire Security
        • Auditing
        • Encryption
    • 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
        • Manage Node-to-Node Encryption
        • Manage Address Families
      • Manage Buckets
        • Create a Bucket
        • Edit a Bucket
        • Flush a Bucket
        • Drop a Bucket
      • 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
        • Recover Data with XDCR
      • Manage Security
        • Manage Security Settings
        • Manage Users, Groups, and Roles
        • Manage Authentication
          • Configure LDAP
          • Configure saslauthd
          • Configure SAML
          • Configure PAM
          • Manage Certificates
            • Configure Server Certificates
            • Configure Client Certificates
            • Enable Client-Certificate Handling
            • Certificate Rotation
            • Certificate Error Handling
        • Manage On-the-Wire Security
        • Manage Auditing
        • Manage Sessions
        • Manage Console Access
        • Manage System Secrets
        • Manage Connections and Disks
      • Manage Statistics
      • Manage Indexes
      • Import Documents
      • Manage Backup and Restore
        • cbbackupmgr
          • Strategies
          • Tutorial
          • Cloud Backup
          • Network Filesystems
          • Encryption
      • Monitor
        • Monitor Queries
        • Monitor Indexes
        • Monitor Clock Drift
        • Set up Prometheus for Monitoring
      • 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
        • Security Considerations
        • Couchbase Server Process List
        • VM and Container Guidelines
        • About Clusters with Fewer Than 3 Nodes
      • Installation
        • Install on Linux
          • Red Hat & CentOS
          • Ubuntu & Debian
          • SUSE Enterprise
          • Oracle Enterprise
          • Amazon Linux 2
          • Non-Root Install and Upgrade
          • Install Multiple Instances
        • 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
          • Deploy with Terraform
        • 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
            • Upgrade an Online Docker Cluster, Full Capacity
          • IPv6 Cluster-Upgrade
        • Feature Availability During Upgrade
      • Migration
        • Migrating Data
        • Enabling Timestamp-based Conflict Resolution for Migrated Data
    • Integrate
      • Connector Guides
      • Elasticsearch Plug-in
      • Kafka Connector
      • Spark Connector
      • Tableau Connector
      • Couchbase ODBC and JDBC Drivers
    • Reference
      • CLI Reference
        • cbanalyze-core
        • cbbackup
        • cbbackupwrapper
        • cbcollect_info
        • cbepctl
          • set checkpoint_param
          • set flush_param
          • set tap_param
        • cbft-bleve
          • cbft-bleve: Moss Indexes
          • cbft-bleve: Scorch Indexes
          • cbft-bleve: Zap Files
        • cblogredaction
        • cbq
        • cbrecovery
        • cbrestore
        • cbrestorewrapper
        • cbstats
          • all
          • allocator
          • checkpoint
          • collections
          • collections-details
          • config
          • dcp
          • dcpagg
          • dcp-vbtakeover
          • diskinfo
          • dispatcher
          • durability-monitor
          • failovers
          • hash
          • items
          • key
          • kvstore
          • kvtimings
          • memory
          • prev-vbucket
          • raw
          • reset
          • responses
          • runtimes
          • scheduler
          • scopes
          • scopes-details
          • slabs
          • tap-vbtakeover
          • tasks
          • timings
          • uuid
          • vbucket
          • vbucket-details
          • vbucket-seqno
          • vkey
          • warmup
          • workload
        • cbsummary
        • cbtransfer
        • cbworkloadgen
        • couchbase-server
        • mctimings
      • REST API Reference
        • Nodes and Clusters API
          • Cluster Initialization and Provisioning
            • Initializing a Cluster
            • Initializing a Node
            • Establishing Credentials
            • Naming a Node
            • Configuring Memory
            • Assigning Services
            • Naming a Cluster
          • Node Addition and Removal
            • Adding Nodes to Clusters
            • Joining Nodes into Clusters
            • Removing Nodes from Clusters
          • Rebalance
            • 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
          • 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
            • Getting a Single Statistic
            • Getting Multiple Statistics
          • Logging API
            • Retrieving Log Information
            • Creating Client Logs
        • 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
          • Setting Thread Allocations
          • 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 a Reference
          • Checking Connections
          • Getting a Reference
          • Creating a Replication
          • Pausing and Resuming a Replication
          • Deleting a Replication
          • Deleting a Reference
          • 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
          • Authorization API
            • Role-Based Access Control (RBAC)
          • Configure On-the-Wire Security
          • Rotate Internal Credentials
          • Configure HSTS
          • SystemSecrets API
            • Configuring System Secrets
            • Changing the Master Password
            • Rotating the Data Key
        • Query Service API
          • Examples
            • Successful Request
            • Request with Positional Parameters
            • Request with Named Parameters
            • Request Timeout
            • Request Error
            • Service Error
            • SQL++ Error
            • Unsupported HTTP Method
            • Request with Authentication — HTTP Header
            • Request with Authentication — Request Parameter
          • Admin REST API
          • Query Settings API
          • Functions REST API
        • Index Service API
          • Retrieve GSI Settings
          • Set GSI Settings
          • Index Statistics API
          • Modify Index Batch Size
        • Backup Service API
          • Create and Edit Plans
          • Create a Repository
          • Get Information on Repositories
          • Get Information on Plans
          • Get Information on Tasks
          • Pause and Resume Tasks
          • Examine Backed-Up Data
          • Perform an Immediate Backup
          • Perform an Immediate Merge
          • Restore Data
          • Delete a Backup
          • Archive a Repository
          • Import a Repository
          • Delete a Repository
          • Delete a Plan
          • Get Information on the Cluster
          • Manage Backup Configuration
        • Search Service API
          • Node Configuration
          • Indexes
          • Advanced
          • Search Statistics
          • Active Queries
          • Rebalance Based on File Transfer
        • 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
        • Query Service Metrics
        • Index Service Metrics
        • Search Service Metrics
        • Eventing Service Metrics
        • Analytics Service Metrics
        • Backup Service Metrics
        • Cluster Manager Metrics
        • XDCR Metrics
        • Metrics for All Services
      • 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
      • Release Notes
      • Licenses for Third-Party Components
    • Contribute
      • Contribute to the Documentation
  • Edit on GitHub

Is this page helpful?

Yes No
Leave Additional Feedback?
Skip

Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

  • Couchbase Server
  • Integrate
  • Connector Guides

Connector Guides

    +
    Couchbase connectors enable you to exchange data with a number of other platforms.

    Connectors are provided for:

    • Elasticsearch

    • Kafka

    • Spark

    • Tableau

    • Couchbase ODBC and JDBC Drivers

    Couchbase
    • Documentation
    • Forums
    • Support
    • Developer Portal
    • Blog
    • Resources
    • Get Started
    • Downloads
    • Training
    • Twitter
    • Linkedin
    • Facebook
    © 2023 Couchbase, Inc. Couchbase, Couchbase Lite and the Couchbase logo are registered trademarks of Couchbase, Inc.
    Terms of Use Privacy Policy Cookie Policy Support Policy Marketing Preference Center