Skip to content

overview.adoc

Latest commit

 

History

History
205 lines (156 loc) · 6.11 KB

overview.adoc

File metadata and controls

205 lines (156 loc) · 6.11 KB

Couchbase {name-sdk} {sdk_dot_minor}

Couchbase {name-sdk} {sdk_dot_minor}

The Couchbase {name-sdk} allows {name_platform} applications to access a Couchbase cluster — Capella or self-managed.

Quickstart Guide | project-docs:sdk-release-notes.adoc | {sdk-api-link}[{name-sdk} API Reference] | {sdk-gh-link}[{name-sdk} SDK source code]

What’s the point of a fast and scalable database if it’s not easy to develop for? Couchbase gives you the {name_platform} APIs to work with Capella, our managed solution, or self-managed options in your private Cloud or datacenter.

Data Ops (CRUD)
link:devguide:example$java/KvOperations.java[role=include]
{sqlpp} Query (OLTP)
link:devguide:example$java/Queries.java[role=include]
Vector Search
link:devguide:example$java/Search.java[role=include]

Couchbase is a large platform — covering many services — and Couchbase SDKs are not thin wrappers generated around a REST API, but well thought out interfaces to the platform that make it easier to design and maintain your client code, and work with Couchbase in more natural ways for your platform. Install the SDK, and explore in the way that works best for you.

Installing the SDK via Maven
<dependencies>
    <dependency>
        <groupId>com.couchbase.client</groupId>
        <artifactId>java-client</artifactId>
        <version>{sdk_current_version}</version>
    </dependency>
</dependencies>

The Couchbase Java SDK integrates into the Java ecosystem through a number of extensions and connectors, including:

Exploring the Java SDK

The links in the sections below will take you where you want to go — as will the navigation on the left-hand side of this page. But if you don’t know exactly where you need to go, try one of the following:

  • Our Quickstart Guide introduces the SDK with a quick install, and CRUD examples against the Data Service.

  • Couchbase’s familiar SQL-family query language and fuzzy search options (including vector search) are introduced on the concept-docs:querying-your-data.adoc page.

  • The {name-sdk} docs are, necessarily, just a sub-set {sdk-api-link}[{name-sdk} API Reference] — and a complete listing of all APIs can be found in the reference.

  • For a fuller orientation, there is a guide to the {name-sdk} docs.


[database] Using Your Database

How-to guides to help you start your development journey with Couchbase and the {name-sdk}.

Easy to Connect & Get Started

  • Getting Started

  • hello-world:sample-application.adoc

  • Beginners' Couchbase Tutorial

  • howtos:managing-connections.adoc

Search, Query, Analyze

  • Query with a familiar, SQL-like language

  • Vector Search for your AI app

  • Fuzzy Search with text and Geo data

  • OLAP — long running analytical queries

Lightning Fast Data Service

  • howtos:kv-operations.adoc

  • howtos:subdocument-operations.adoc

  • howtos:encrypting-using-sdk.adoc

  • Multi-Document Distributed ACID Transactions

Observability & Error Handling

  • howtos:error-handling.adoc

  • howtos:collecting-information-and-logging.adoc

  • howtos:slow-operations-logging.adoc

  • howtos:health-check.adoc


[book] Resources

Useful resources to help support your development experience with Couchbase and the {name_platform} SDK.

Reference

  • {sdk-api-link}[API Reference^]

  • ref:client-settings.adoc

  • ref:error-codes.adoc

  • {sdk-gh-link}[SDK source code]

Deployment

  • project-docs:sdk-release-notes.adoc

  • Compatibility

  • project-docs:third-party-integrations.adoc

  • Couchbase Quarkus Java Extension

  • project-docs:sdk-full-installation.adoc

{version-common}@sdk:shared:partial$columnar-available.adoc