咨询LB4中CouchDB连接器model index及model-specific-configuration用法 求示例代码
LoopBack 4 环境下 CouchDB 连接器配置实现
按数据库维度配置 Model 索引的核心逻辑
CouchDB 连接器的配置支持两层生效粒度,按数据库维度做隔离配置时需要遵循以下规则:
- 每个独立的 CouchDB 数据库需要对应一个独立的数据源绑定实例,不能在同一个数据源内通过动态切换 database 参数实现多库隔离,避免连接池、索引规则串库的问题
- 数据源层级配置的索引,会作用到所有绑定到该数据源的模型上,和该数据源关联的数据库一一对应
- 模型层级的索引配置优先级高于数据源全局配置,同名字的索引规则会直接覆盖全局配置,不会发生索引重复创建
单模型专属配置的实现方式
LoopBack 4 不需要像旧版本那样把所有模型配置硬编码在全局数据源文件中,只需要在模型的@model()装饰器的settings参数内嵌入对应连接器的自定义配置块,即可实现单模型级别的参数覆盖,不需要修改全局数据源的公共规则。
参考实现示例
1. 按库拆分的数据源配置示例
业务数据库对应的数据源:
// src/datasources/couchdb-business.datasource.ts import {inject, lifeCycleObserver, LifeCycleObserver} from '@loopback/core'; import {juggler} from '@loopback/repository'; const config = { name: 'couchdbBusiness', connector: 'couchdb2', url: 'http://127.0.0.1:5984', database: 'business_core', username: 'admin', password: 'your_db_password', // 该库下的全局通用索引 indexes: { idx_common_doc_type: { identity: 'doc_type', index: {fields: ['docType']} } } }; @lifeCycleObserver('datasource') export class CouchdbBusinessDataSource extends juggler.DataSource implements LifeCycleObserver { static dataSourceName = 'couchdbBusiness'; static readonly defaultConfig = config; constructor( @inject('datasources.config.couchdbBusiness', {optional: true}) dsConfig: object = config, ) { super(dsConfig); } }
日志数据库对应的数据源:
// src/datasources/couchdb-log.datasource.ts import {inject, lifeCycleObserver, LifeCycleObserver} from '@loopback/core'; import {juggler} from '@loopback/repository'; const config = { name: 'couchdbLog', connector: 'couchdb2', url: 'http://127.0.0.1:5984', database: 'operation_log', username: 'admin', password: 'your_db_password', // 日志库专属的全局通用索引 indexes: { idx_common_log_time: { identity: 'log_time', index: {fields: ['logLevel', 'createTime']} } } }; @lifeCycleObserver('datasource') export class CouchdbLogDataSource extends juggler.DataSource implements LifeCycleObserver { static dataSourceName = 'couchdbLog'; static readonly defaultConfig = config; constructor( @inject('datasources.config.couchdbLog', {optional: true}) dsConfig: object = config, ) { super(dsConfig); } }
2. 带模型专属配置的模型定义示例
绑定到业务库的订单模型,携带专属索引配置:
// src/models/order.model.ts import {model, property, BaseEntity} from '@loopback/repository'; @model({ settings: { // 指定模型绑定的数据源,实现按库维度路由 couchdb: 'couchdbBusiness', // 模型专属索引,优先级高于数据源全局配置 indexes: { idx_order_search: { identity: 'order_search', index: {fields: ['orderNo', 'orderStatus']} } }, // 模型级其他自定义配置 conflictCheckEnabled: true } }) export class Order extends BaseEntity { @property({type: 'string', id: true}) id?: string; @property({type: 'string'}) orderNo: string; @property({type: 'string'}) orderStatus: string; @property({type: 'string'}) docType: string; }
绑定到日志库的操作日志模型,携带专属索引配置:
// src/models/operation-log.model.ts import {model, property, BaseEntity} from '@loopback/repository'; @model({ settings: { // 指定绑定到日志库数据源 couchdb: 'couchdbLog', // 日志模型专属索引 indexes: { idx_operator_trace: { identity: 'operator_trace', index: {fields: ['operatorId', 'operationType']} } } } }) export class OperationLog extends BaseEntity { @property({type: 'string', id: true}) id?: string; @property({type: 'string'}) operatorId: string; @property({type: 'string'}) operationType: string; @property({type: 'date'}) createTime: Date; }
配置常见注意事项
- 索引的格式需要和 CouchDB 原生 Mango 查询索引的结构保持一致,连接器会在应用启动、模型初始化阶段自动完成索引创建,不需要手动在 CouchDB 控制台提前执行建索引操作
- 当模型同时存在数据源全局索引、自身专属索引时,连接器会自动合并两组配置的索引项,不会出现重复创建的问题
- 模型级的专属配置覆盖范围不限于索引,还可以自定义文档ID生成规则、版本冲突处理策略、单文档查询超时时间等参数
- 跨库访问时,只要模型指定的
couchdb字段对应的数据源名称存在,应用就会自动完成路由,不需要在服务层额外做数据源切换逻辑
内容的提问来源于stack exchange,提问作者Jerry H
相关产品推荐
相关产品推荐

