btburnett3/couchbase-index-manager

概述

提供用于管理Couchbase索引的命令行界面，可将索引同步至文件中提供的索引定义。旨在作为CI/CD流水线的一部分使用，或辅助本地开发。

使用方法

sh
docker run --rm -it -v ./:/definitions btburnett3/couchbase-index-manager -c couchbase://cluster -u Administrator -p password sync beer-sample /definitions

通用参数

• -c couchbase://xxx - Couchbase集群地址，默认为localhost
• -u username - 连接Couchbase集群的用户名
• -p password - 连接Couchbase集群的密码
• --no-color - 禁止输出彩色内容

Sync命令

sync命令用于执行索引同步操作

sh
couchbase-index-manager sync <bucketName> <path>

bucketName为待同步的桶名称，path为索引定义文件的路径。path可以是单个YAML或JSON文件，也可以是包含多个文件的目录。

选项

• -f - 跳过配置提示，直接执行同步（适用于脚本）
• --dry-run - 仅输出计划，不执行任何更改
• --safe - 不删除现有索引，仅创建新索引
• -t 30 - 等待索引构建完成的秒数，0表示无限等待（默认5分钟）

示例

sh
couchbase-index-manager -c couchbase://localhost -u Administrator -p password sync beer-sample ./directory/
couchbase-index-manager -c couchbase://localhost -u Administrator -p password sync beer-sample ./directory/file.yaml
couchbase-index-manager -c couchbase://localhost -u Administrator -p password sync beer-sample ./directory/file.json

定义文件

定义文件可使用JSON或YAML格式编写，用于定义索引名称、索引列及其他选项。

使用YAML时，单个文件中可包含多个定义，用一行短横线分隔。

yaml
name: BeersByAbv
index_key:
- abv
condition: (`type` = 'beer')
num_replica: 0
---
name: BeersByIbu
index_key:
- ibu
condition: (`type` = 'beer')
num_replica: 0
---
name: OldIndex
lifecycle:
  drop: true

更新索引

couchbase-index-manager需要能够识别索引何时更新。Couchbase Server会对index_key和condition进行某些规范化处理，这意味着Couchbase中的值可能与创建索引时提交的值略有不同。

因此，创建定义文件时需考虑规范化。确保定义中包含已规范化的键和条件，否则couchbase-index-manager可能在每次运行时删除并重新创建索引。

删除索引

若从定义文件中移除某个索引，该索引不会被删除。这可防止不同CI/CD流程在管理不同索引时相互干扰。要删除索引，需保留定义并将lifecycle.drop设置为true。