Pricing About Documentation Login Free Trial

Couchbase is an open-source distributed NoSQL cloud database designed for applications in cloud, mobile, AI, and edge computing. Couchbase Capella introduces generative AI coding assistance to enhance developer productivity. It supports multiple data access patterns, reducing architectural complexity and ensuring distributed performance across various cloud platforms.

Join Cluster

On your first visit to the site, you will be presented with the login/signup screen.

Couchbase login screen

When your instance is first created, an account is created for you with the email you chose. You can get the password for this account by going to your Elestio dashboard and clicking on the "Show Password" button.

Enter your username and password and click the "Join Cluster" button.

Dashboard

Once you join the cluster, you will be taken to the dashboard. The dashboard in Couchbase provides an overview of the cluster, including metrics such as total operations, N1QL request rate, and search query rate. It also displays resource utilization metrics such as RAM, disk, and CPU usage. Additionally, you can monitor query execution time, index scan rate, replica items, and read/write failures.

Couchbase dashboard screen

Servers

A server is node in the Couchbase cluster that stores and manages data. Each server in the cluster is responsible for handling data storage, replication, and query processing. Servers work together to provide high availability, fault tolerance, and scalability for the Couchbase database. Server is designed to be horizontally scalable, allowing additional servers to be added to the cluster to accommodate increased data volumes or user loads. This scalable and distributed nature of Couchbase servers contributes to the database's ability to handle a wide range of applications and workloads. You can access the servers and choose to rebalance the cluster by clicking on the "Servers" tab on the left side of the screen.

Couchbase servers screen

Buckets

Buckets are logical containers that hold data. They are similar to tables in a relational database or collections in other NoSQL databases. Buckets are used to organize and partition data, allowing for data retrieval and management. Each bucket can have its own set of configurations, such as replication, eviction policies, and data durability settings. By using buckets, you can separate and isolate different types of data within your Couchbase cluster. Buckets enable horizontal scaling by distributing data across multiple servers and support individualized configurations for parameters such as replicas, storage engine types, and access controls. You can access the buckets by clicking on the "Buckets" tab on the left side of the screen.

Couchbase buckets screen

Backups

Backup is a process of creating copies of the database's data and configuration files to ensure data protection and disaster recovery. These backups can be used to restore the database in case of data loss, system failures, or other unforeseen events. Couchbase provides built-in backup and restore functionality, allowing users to schedule and automate backups. Couchbase supports consistency in backups, allowing for point in time recovery to restore the database to specific states. Administrators can implement various backup strategies, including scheduled backups and integration with external tools, and choose from different storage options such as local disk or cloud services. You can access the backups by clicking on the "Backups" tab on the left side of the screen.

Couchbase backups screen

XDCR (Cross Datacenter Replication)

XDCR stands for Cross Datacenter Replication in Couchbase. It is a feature that allows data to be replicated between different Couchbase clusters located in different data centers. XDCR provides high availability, disaster recovery, and data locality by automatically replicating data changes from one cluster to another in near real-time. This feature ensures that data remains consistent and available across multiple geographically distributed clusters, enabling applications to access data from the nearest data center for optimal performance. You can access the XDCR by clicking on the "XDCR" tab on the left side of the screen.

Couchbase xdcr screen

Security

Couchbase includes various aspects of security such as authentication, authorization, encryption, and auditing. Couchbase provides security features to safeguard data, including role-based access control (RBAC), secure communication channels, data encryption at rest and in transit, and auditing. These security measures help protect against unauthorized access, data breaches, and ensure compliance with industry regulations. You can configure certificate and other authentication settings by clicking on the "Security" tab on the left side of the screen.

Couchbase security screen

Settings

Settings in Couchbase cover a range of configurable parameters enabling administrators to configure the behavior, performance, and security of the Couchbase Server. These settings have various categories, including cluster configuration, bucket properties, security configurations, indexing parameters, and more. Cluster wide specifications such as the cluster name and memory quotas, bucket specific configurations like replication and storage settings, as well as security measures such as user roles and SSL/TLS configurations can be handled through settings. Head over to the "Settings" tab on the left side of the screen to configure these settings.

Couchbase settings screen

Logs

Logs are records of events and activities that occur within the Couchbase database. They provide information for troubleshooting, monitoring, and auditing purposes. Couchbase logs capture various types of information, such as errors, warnings, performance metrics, and system events. These logs can help administrators and developers identify and resolve issues, track system performance, and gain insights into the overall health and behavior of the Couchbase cluster. You can access and filter logs by clicking on the "Logs" tab on the left side of the screen.

Couchbase logs screen

Query Editor

The query is a feature that allows you to write and execute queries against your Couchbase database. It provides an interface for querying and manipulating data using the N1QL query language. The query tab allows you to write complex queries, perform aggregations, filter data, and retrieve specific information from your database. It also provides tools for optimizing and analyzing query performance. Users can choose to use AI functionalities to explain the query or the response received. Additionally, you have the option to run the query as TX and receive the results in different formats. Access the query tab by clicking on the "Query" tab on the left side of the screen.

Couchbase query editor screen

Indexes

Indexes in Couchbase are data structures that improve the performance of queries by allowing for data retrieval. They are used to speed up the execution of queries by precomputing and organizing data in a way that facilitates quick lookup and filtering. Indexes are created on specific fields or attributes of documents stored in buckets. These indexes enable the database to locate and retrieve documents based on the values of the indexed fields. By using indexes, queries can avoid scanning the entire dataset and instead directly access the relevant documents, resulting in faster query execution times. You can access and setup indexes and their scope by clicking on the "Indexes" tab on the left side of the screen.

Couchbase indexes screen

Creating Views

Views in Couchbase are a way to create and query secondary indexes on data stored in buckets. They allow you to define and execute custom queries on your data. Views are created using MapReduce functions, where the map function extracts key-value pairs from the documents in a bucket, and the reduce function aggregates and processes the emitted key-value pairs. Once a view is created, it can be queried using the Couchbase Query Language (N1QL). Views can be useful when you have recurring query patterns or when you need to perform calculations or aggregations on your data. Access and create views by clicking on the "Views > Add view" tab on the left side of the screen.

Couchbase creating views screen