Couchbase Java SDK 技术文档

1. 安装指南

1.1 通过 Maven 安装

最简单的安装方式是通过 Maven 下载 jar 包及其依赖项。在项目的 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>com.couchbase.client</groupId>
    <artifactId>java-client</artifactId>
    <version>2.7.23</version>
</dependency>

1.2 其他安装方式

你可以在 这里 找到旧版本的安装信息以及其他下载方式。

2. 项目的使用说明

2.1 连接到 Couchbase 集群

首先，创建一个 Couchbase 集群的引用，并连接到指定的 Bucket：

// 创建一个集群引用
CouchbaseCluster cluster = CouchbaseCluster.create("127.0.0.1");

// 连接到默认的 Bucket
Bucket bucket = cluster.openBucket("default");

2.2 存储和检索文档

你可以创建一个 JSON 文档并将其存储在 Couchbase 中，然后检索并打印文档内容：

// 创建一个 JSON 文档并存储它，ID 为 "helloworld"
JsonObject content = JsonObject.create().put("hello", "world");
JsonDocument inserted = bucket.upsert(JsonDocument.create("helloworld", content));

// 读取文档并打印 "hello" 字段
JsonDocument found = bucket.get("helloworld");
System.out.println("Couchbase is the best database in the " + found.content().getString("hello"));

2.3 执行 N1QL 查询

你可以执行 N1QL 查询来从 Couchbase 中获取数据：

N1qlQueryResult result = bucket.query(N1qlQuery.simple("SELECT DISTINCT(country) FROM `travel-sample` WHERE type = 'airline' LIMIT 10"));

for (N1qlQueryRow row : result) {
    System.out.println(row.value());
}

2.4 关闭连接

使用完毕后，记得关闭 Bucket 和集群连接：

// 关闭所有 Bucket 并断开连接
cluster.disconnect();

3. 项目 API 使用文档

3.1 集群管理 API

• CouchbaseCluster.create(String hostname): 创建一个 Couchbase 集群的引用。
• cluster.openBucket(String bucketName): 打开指定的 Bucket。
• cluster.disconnect(): 断开与集群的连接。

3.2 Bucket API

• bucket.upsert(JsonDocument document): 插入或更新一个文档。
• bucket.get(String id): 根据文档 ID 获取文档。
• bucket.query(N1qlQuery query): 执行 N1QL 查询。

3.3 文档操作 API

• JsonObject.create(): 创建一个空的 JSON 对象。
• jsonObject.put(String key, Object value): 向 JSON 对象中添加键值对。
• JsonDocument.create(String id, JsonObject content): 创建一个带有指定 ID 和内容的 JSON 文档。

4. 项目安装方式

4.1 Maven 安装

如前所述，通过 Maven 安装是最简单的方式。只需在 pom.xml 中添加依赖即可。

4.2 手动下载

你也可以手动下载 jar 包并将其添加到项目的 classpath 中。

4.3 其他构建工具

如果你使用的是 Gradle 或其他构建工具，可以参考相应的依赖管理文档进行配置。

---

通过以上文档，你应该能够顺利安装、使用和理解 Couchbase Java SDK 的基本功能。如果有更多问题，可以参考官方文档或社区论坛获取帮助。