Tutorials
on Couchbase

Learn to build and operate apps using Couchbase.

Cloud

Cluster and Data

Having followed the sign up process and deployed your first cluster, follow the steps below to explore Couchbase Capella — loading data, configuring your cluster, and connecting to it along the way.

Run Your First Capella Queries

Run Your First N1QL Queries and build indexes on Couchbase Capella

Other Capella Data Tools

Other data tools to find and look for documents.

SDKs

Start with Java and Spring Boot

Build a REST API with Couchbase's Java SDK 3 and Spring Boot.

Couchbase With Spring-Boot and Spring Data

Build a REST API with Couchbase and Spring Data.

Transactions with Java SDK

In this exercise will use a sample application that allows transferring virtual credits between different accounts to show how to work with Couchbase transactions in Java SDK.

Start with Kotlin and Ktor

Build a REST API with Couchbase's Java SDK 3 and Kotlin.

Quickstart Node JS and Express

Build a REST API with Couchbase's NodeJS SDK 3 using Express.

Getting Started with Ottoman v1 and Couchbase Node.js SDK 2.6

Get started with Ottoman version 1 and the Couchbase Node.js SDK version 2.6 using JavaScript to create models and schema, persist, and read data from Couchbase Server.

Connecting with TLS on the Node.js SDK

Connect to a TLS-secured Couchbase cluster (such as Capella) with the root certificate

Quickstart Ottoman JS and Express

Build a REST API with Couchbase's Ottoman JS and SDK 3 using Express.

Quickstart in Couchbase with Scala

Build REST APIs with Couchbase's Scala SDK.

Creating User Defined Functions with Javascript

Build a User Defined Function with Javascript for Query Service

Creating Analytics User Defined Functions with Python

Build an Analytics User Defined Function with Python.

ASP.NET Core First Query with Couchbase 6.5

Using the Couchbase .NET SDK in an ASP.NET Core application to create new database records in Couchbase and look them up.

ASP.NET Core First Query with Couchbase SDK 3

Using the Couchbase .NET SDK in an ASP.NET Core application to create new database records in Couchbase and look them up.

.NET Core with Linq2Couchbase First Query

Using the Couchbase .NET SDK in a .NET Core console application to create new database records in Couchbase and look them up with Linq2Couchbase.

Quickstart in Couchbase with C# and ASP.NET

Build a REST API with Couchbase's C# SDK 3 and ASP.NET.

Quickstart in Couchbase with C# and ASP.NET Minimum API

Build a REST API with Couchbase's C# SDK 3 and ASP.NET Minimum API.

Using NextJS with Couchbase NodeJS SDK

Build a basic NextJS front-end and back-end app with Couchbase.

Quickstart in Couchbase with Python and Flask

Build a REST API with Couchbase's Python SDK (4.x) and Flask.

N1QL/Data Modeling

Comparing Document-Oriented and Relational Data

In this tutorial we are comapring document-oriented models vs relational-oriented models for data.

Using JSON documents

JSON is a lightweight data-interchange format which is easy to read and change.

Schemaless Data Modeling

When you use documents to represent data, a database schema is optional. The majority of your effort will be creating one or more documents that will represent application data.

Phases of Data Modeling

A data modeling exercise consists of logical and physical data modeling phases to describe your entities and relationships and map them to physical containers.

JSON Design Choices

Couchbase Server neither enforces nor validates for any particular document structure. Below are the design choices that impact JSON document design.

Document Key Design

The most important part of NoSQL database modeling is document keys. There are different patterns when it comes to designing a document key.

Standardization, Optimization, and Resources

Wrapping up our Data Modeling Guide, we talk about standardization and optimization of your documents and modeling and share some resources to help you dive deeper.

Standardized Document Properties

Multiple data sets can share a common bucket in Couchbase. To ensure each data set has isolated keyspaces, it's best practice to include a certain prefixes in your document keys.

Document Optimizations

In any database, every byte of stored data adds up, in this tutorial we go over options and best practices to proactively reduce document sizes.

Schema Versioning

Storing the schema version within the document is a best practice that provides a mechanism to migrate and upgrade models as they change over time. In this tutorial, we illustrate an approach to schema management through code.

Document Revisions

There may be requirements to save multiple revisions of a document within a bucket, this history is maintained by the application. This tutorial is intended to outline one way this can be accomplished.

Understanding Query Workflow and Optimization

Applications submit the N1QL query to one of the available query nodes. The Query node parses and analyzes the query, uses metadata on underlying objects to figure out the optimal execution plan and executes it.

Understanding Index Scans

Query predicate indicates the subset of the data interested. During the query planning phase, we select the indexes to be used for the query.

Identifying the Top Slow Queries

The top slow queries can be identified by querying the system catalog.

Understanding an Explain Plan

The tutorial describes the various attributes you see in an explain plan and how to interpret them.

Understanding Cardinality and Selectivity

Cardinality and selectivity can provide measurable insights into your data set and effectiveness of the index, pointing you to where specific optimizations can be made.

Understanding Covering Indexes and TTLs

When using covering indexes, the N1QL queries are constructed in a way to ensure they do NOT return stale data from your indexes(GSIs).

Tuning Tips and Advice

A collection of tips and advice for you to improve the query performance.

Operators Guide

A guide to all the operators for query optimization.

Mobile

Tutorial Background App Refresh in iOS with UIKit and Swift

Build an iOS App in Swift with UIKit that uses Background.

Tutorial Couchbase Lite with Recycler Views in Android with Java

Build an Android App in Java with Couchbase Lite and Recycler Views

Quickstart with Peer-to-Peer Sync in Swift and UIKit

Build an iOS App in Swift with UIKit that uses Peer-to-Peer Sync

Quickstart with Peer-to-Peer Sync in C# and Xamarin Forms

Build an Xamarin App in C# with Xamarin Forms that uses Peer-to-Peer Sync

Quickstart in Couchbase Lite with Android and Java

Build an Android App in Java with Couchbase Lite

Quickstart in Couchbase Lite Query with Android and Java

Build an Android App in Java and Couchbase Lite using Query

Quickstart in Couchbase Lite Data Sync with Android and Java

Build an Android App that uses Data Sync in Java and Couchbase Lite

Quickstart in Couchbase Lite Query with iOS, Swift, and UIKit

Build an iOS App in Swift with UIKit and Couchbase Lite using Query

Quickstart in Couchbase Lite with iOS, Swift, and UIKit

Build an iOS App in Swift with UIKit and Couchbase Lite

Quickstart in Couchbase Lite Data Sync with iOS, Swift, and UIKit

Build an iOS App that uses Data Sync in Swift with UIKit and Couchbase Lite

Quickstart in Couchbase Lite with C#, .NET, and Xamarin Forms

Build an App in dotnet with C#, Xamarin Forms, and Couchbase Lite

Quickstart in Couchbase Lite Query with C#, .NET, and Xamarin Forms

Build an App in C# with Xamarin and Couchbase Lite using Query

Quickstart in Couchbase Lite Data Sync with C#, .NET, and Xamarin Forms

Build an App that uses Data Sync in C# with Xamarin and Couchbase Lite

OpenID Connect Authentication for Sync Gateway with Keycloak

Configure Keycloak an OpenID Connect OP to work with Sync Gateway

XCode Playground: Exploring Couchbase Lite Query API

Use XCode Playground to explore the Couchbase Lite Query API

Observability

Monitoring Operating System

In order to have a solid understanding of overall cluster health, it is important to monitor the operating system and various stats for each node in the cluster.

Monitoring Nodes

This tutorial describes the important metrics and how to monitor them for each node in the cluster.

Monitoring XDCR

This tutorial describes the important metrics and how to monitor them for cross data center replication (XDCR) operations in the cluster.

Monitoring Query Service

This tutorial describes the important metrics and how to monitor them for query service running in the cluster.

Monitoring Index Service

This tutorial describes the important metrics and how to monitor them for index service running in the cluster.

Monitoring FTS Service

This tutorial describes the important metrics and how to monitor them for full text service (FTS) running in the cluster.

Monitoring Eventing Service

This tutorial describes the important metrics and how to monitor them for eventing service running in the cluster.

This tutorial goes over the Couchbase API used to access the alerts from the logs in the server.

Install Prometheus

This tutorial walks you through installation and configuration of Prometheus as a stand alone instance. This should not be installed on each or any node in the Couchbase cluster.

Node Exporter Setup

This tutorial is optional step in the Prometheus Integration Learning Path and requires setup on each server that you wish to gather system metrics using Node Exporter.

Process Exporter Setup

This tutorial is optional step in the Prometheus Integration Learning Path and requires setup on each server that you wish to monitor process metrics using Process Exporter.

Couchbase Exporter Setup

This tutorial walks you through installation and configure the Couchbase Exporter and its dependencies. The mode you run Couchbase Exporter in will determine a single instance for each cluster, or an instance for each node in the cluster.

Configure Prometheus

Prometheus is configured through a single YAML file. When configured, Prometheus runs as a service, in this tutorial, we configure Prometheus.

Configure AlertManager

It's important to know that Prometheus can support multiple AlertManagers for High-Availability by specifying more than one target. For the purpose of this tutorial, we install a single AlertManager on the same server as Prometheus and Grafana.

Configure Prometheus Alerts

This tutorial will help you to set up and configure Prometheus Alerts with AlterManager configuration ans creation and configuration of Prometheus rules for alerting.

Install Grafana

This tutorial walks you through installation and configuration of Grafana as a stand alone instance. This should not be installed on each or any node in the Couchbase cluster.

Configure Grafana

This tutorial will help you add a data source for Grafana for use with Prometheus to give your dashboard different ways of visualizing your data.

Upgrading Services

In the final tutorial of the Prometheues Integration learning path, we will upgrade all of our services installed in our application. This can be used for reference in the future as part of ongoing maintainence of your project.

Monitoring Data Service

This tutorial describes the important metrics and how to monitor them for data service running in the cluster.

Others

Couchbase Database Server Installation Options

This tutorial shows the different installation options for Couchbase Server - developers can run a Couchbase cluster on many platforms (Capella, Couchbase Playground, Docker, Kubernetes, and locally on their machine). This tutorial will guide you through deploying Couchbase Server on the aforementioned platforms. If you are not sure which one to use, we recommend using Couchbase Capella to get started for the least amount of friction.

Customer 360 Data Ingestion

Learn about how Couchbase can fit into your data ingestion architecture

Couchbase Server CE Docker Container - Example Manual Configuration

Get started with Couchbase Server CE using Docker with manual configuration.

Installing and Operating Couchbase Server Community Edition (CE)

Tutorial to install and operate Couchbase Server Community Edition (CE)

Grafana Dashboards with Couchbase

Tutorial on how to install and configure Grafana Couchbase data source plugin.

Working with Support

To speed up the resolution of your issue, our Customer Support will need information to replicate and troubleshoot your issue. The more info provided, the faster we'll able to identify the issue and propose a fix.

General Support Best Practices

To help your support ticket get solved in a timely manner, follow these best practices for general support!

Was this page helpful?

yes

no