Class DatabaseOperations

数据库操作类提供常用的数据库操作方法，支持查询、添加、更新、删除、聚合等操作集成了查询缓存、敏感字段加密/解密、时间戳管理等功能

Template: T

文档数据类型，默认为 Record<string, unknown>

Example

// 查询文档
const users = await DatabaseOperations.find('users', ctx, { status: 'active' }, {
  limit: 10,
  orderBy: { field: 'createTime', direction: 'desc' }
})

// 添加文档
const result = await DatabaseOperations.add('users', ctx, { name: 'John', age: 30 })

// 更新文档
await DatabaseOperations.update('users', ctx, { _id: 'xxx' }, { age: 31 })

// 分页查询
const pageData = await DatabaseOperations.paginate('users', ctx, {}, 1, 10)

Index

Constructors

constructor

new DatabaseOperations(): DatabaseOperations
Returns DatabaseOperations

Methods

`Static`clearCache

clearCache(): void
清空缓存删除所有缓存条目

Returns void
Example
```
DatabaseOperations.clearCache()
```
- Defined in db/DatabaseOperations.ts:287

`Static`getCacheStats

getCacheStats(): { size: number; ttl: number }
获取缓存统计信息返回缓存的大小和TTL配置

Returns { size: number; ttl: number }
缓存统计信息
Example
```
const stats = DatabaseOperations.getCacheStats()
console.log(stats.size) // 当前缓存条目数
console.log(stats.ttl)  // 缓存TTL（毫秒）
```
- Defined in db/DatabaseOperations.ts:305

`Static`addTimestamps

addTimestamps<T extends Record<string, unknown>>(
data: T,
isUpdate?: boolean,
): T & { createTime?: number; updateTime?: number }
为文档添加时间戳字段自动添加 createTime 和 updateTime 字段
Type Parameters
- T extends Record<string, unknown>
  文档数据类型
Parameters
- data: T
  文档数据
- OptionalisUpdate: boolean = false
  是否为更新操作
Returns T & { createTime?: number; updateTime?: number }
添加了时间戳的文档数据
Example
```
const userData = { name: 'John', age: 30 }
const newData = DatabaseOperations.addTimestamps(userData)
// { name: 'John', age: 30, createTime: 1234567890, updateTime: 1234567890 }

const updatedData = DatabaseOperations.addTimestamps({ age: 31 }, true)
// { age: 31, updateTime: 1234567891 }
```
- Defined in db/DatabaseOperations.ts:332

`Static`collection

collection(collectionName: string, ctx: DatabaseContext): CollectionReference
获取集合引用
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
Returns CollectionReference
集合引用
- Defined in db/DatabaseOperations.ts:360

`Static`find

find<T extends Record<string, unknown> = Record<string, unknown>>(
    collectionName: string,
    ctx: DatabaseContext,
    query?: Record<string, unknown>,
    options?: DatabaseQueryOptions,
): Promise<T[]>
查询文档 - 支持 MongoDB 查询语法和缓存
Type Parameters
- T extends Record<string, unknown> = Record<string, unknown>
  文档类型
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
- Optionalquery: Record<string, unknown>
  查询条件，支持 MongoDB 查询语法（如 $gt, $lt, $in, $regex 等）
- Optionaloptions: DatabaseQueryOptions
  查询选项
  - limit
    限制返回数量
  - offset
    偏移量
  - orderBy
    排序选项
  - orderBy.field
    排序字段
  - orderBy.direction
    排序方向
  - projection
    投影选项
  - cache
    是否启用缓存
Returns Promise<T[]>
查询结果
- Defined in db/DatabaseOperations.ts:389

`Static`findById

findById<T extends Record<string, unknown> = Record<string, unknown>>(
    collectionName: string,
    ctx: DatabaseContext,
    id: string,
): Promise<T | null>
根据ID获取单个文档
Type Parameters
- T extends Record<string, unknown> = Record<string, unknown>
  文档类型
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
- id: string
  文档ID
Returns Promise<T | null>
文档数据
- Defined in db/DatabaseOperations.ts:463

`Static`add

add<T extends Record<string, unknown> = Record<string, unknown>>(
    collectionName: string,
    ctx: DatabaseContext,
    data: Partial<T>,
): Promise<{ id: string; ids?: string[] }>
添加文档
Type Parameters
- T extends Record<string, unknown> = Record<string, unknown>
  文档类型
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
- data: Partial<T>
  文档数据
Returns Promise<{ id: string; ids?: string[] }>
添加结果
- Defined in db/DatabaseOperations.ts:492

`Static`addMany

addMany<T extends Record<string, unknown> = Record<string, unknown>>(
    collectionName: string,
    ctx: DatabaseContext,
    dataList: Partial<T>[],
    batchSize?: number,
): Promise<{ id: string; ids?: string[] }[]>
批量添加文档
Type Parameters
- T extends Record<string, unknown> = Record<string, unknown>
  文档类型
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
- dataList: Partial<T>[]
  文档数据列表
- batchSize: number = 100
  批量操作大小，默认 100
Returns Promise<{ id: string; ids?: string[] }[]>
批量添加结果
- Defined in db/DatabaseOperations.ts:521

`Static`updateMany

updateMany<T extends Record<string, unknown> = Record<string, unknown>>(
    collectionName: string,
    ctx: DatabaseContext,
    updates: { query: Record<string, unknown>; updateData: Partial<T> }[],
): Promise<{ updated: number }[]>
批量更新文档
Type Parameters
- T extends Record<string, unknown> = Record<string, unknown>
  文档类型
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
- updates: { query: Record<string, unknown>; updateData: Partial<T> }[]
  更新操作列表
Returns Promise<{ updated: number }[]>
批量更新结果
- Defined in db/DatabaseOperations.ts:583

`Static`update

update<T extends Record<string, unknown> = Record<string, unknown>>(
    collectionName: string,
    ctx: DatabaseContext,
    query: Record<string, unknown>,
    updateData: Partial<T>,
): Promise<{ updated: number }>
更新文档
Type Parameters
- T extends Record<string, unknown> = Record<string, unknown>
  文档类型
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
- query: Record<string, unknown>
  查询条件，支持 MongoDB 查询语法
- updateData: Partial<T>
  更新数据
Returns Promise<{ updated: number }>
更新结果
- Defined in db/DatabaseOperations.ts:610

`Static`updateById

updateById<T extends Record<string, unknown> = Record<string, unknown>>(
    collectionName: string,
    ctx: DatabaseContext,
    id: string,
    updateData: Partial<T>,
): Promise<{ updated: number }>
根据ID更新文档
Type Parameters
- T extends Record<string, unknown> = Record<string, unknown>
  文档类型
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
- id: string
  文档ID
- updateData: Partial<T>
  更新数据
Returns Promise<{ updated: number }>
更新结果
- Defined in db/DatabaseOperations.ts:639

`Static`removeMany

removeMany(
    collectionName: string,
    ctx: DatabaseContext,
    queries: Record<string, unknown>[],
): Promise<{ deleted: number }[]>
批量删除文档
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
- queries: Record<string, unknown>[]
  删除条件列表
Returns Promise<{ deleted: number }[]>
批量删除结果
- Defined in db/DatabaseOperations.ts:666

`Static`remove

remove(
    collectionName: string,
    ctx: DatabaseContext,
    query: Record<string, unknown>,
): Promise<{ deleted: number }>
删除文档 - 支持 MongoDB 查询语法
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
- query: Record<string, unknown>
  查询条件，支持 MongoDB 查询语法
Returns Promise<{ deleted: number }>
删除结果
- Defined in db/DatabaseOperations.ts:689

`Static`removeById

removeById(
    collectionName: string,
    ctx: DatabaseContext,
    id: string,
): Promise<{ deleted: number }>
根据ID删除文档
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
- id: string
  文档ID
Returns Promise<{ deleted: number }>
删除结果
- Defined in db/DatabaseOperations.ts:712

`Static`count

count(
    collectionName: string,
    ctx: DatabaseContext,
    query?: Record<string, unknown>,
): Promise<number>
统计文档数量 - 支持 MongoDB 查询语法
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
- Optionalquery: Record<string, unknown>
  查询条件，支持 MongoDB 查询语法
Returns Promise<number>
统计结果
- Defined in db/DatabaseOperations.ts:735

`Static`findOne

findOne<T extends Record<string, unknown> = Record<string, unknown>>(
    collectionName: string,
    ctx: DatabaseContext,
    query?: string | Record<string, unknown>,
): Promise<T | null>
查询单个文档 - 支持 MongoDB 查询语法
Type Parameters
- T extends Record<string, unknown> = Record<string, unknown>
  文档类型
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
- Optionalquery: string | Record<string, unknown>
  查询条件，支持 MongoDB 查询语法
Returns Promise<T | null>
单个文档数据
- Defined in db/DatabaseOperations.ts:794

`Static`aggregate

aggregate(collectionName: string, ctx: DatabaseContext): Aggregation
获取聚合引用
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
Returns Aggregation
聚合引用
- Defined in db/DatabaseOperations.ts:839

`Static`paginate

paginate<T extends Record<string, unknown> = Record<string, unknown>>(
    collectionName: string,
    ctx: DatabaseContext,
    query?: Record<string, unknown>,
    page?: number,
    pageSize?: number,
    options?: PaginateOptions,
): Promise<PaginatedResult<T>>
分页查询 - 支持 MongoDB 查询语法
Type Parameters
- T extends Record<string, unknown> = Record<string, unknown>
  文档类型
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
- Optionalquery: Record<string, unknown>
  查询条件，支持 MongoDB 查询语法
- page: number = 1
  页码（从1开始）
- pageSize: number = 10
  每页大小
- Optionaloptions: PaginateOptions
  查询选项
  - orderBy
    排序选项
  - orderBy.field
    排序字段
  - orderBy.direction
    排序方向
  - projection
    投影选项
Returns Promise<PaginatedResult<T>>
分页结果
- Defined in db/DatabaseOperations.ts:858

`Static`aggregatePipeline

aggregatePipeline<T extends Record<string, unknown> = Record<string, unknown>>(
    collectionName: string,
    ctx: DatabaseContext,
    pipeline: AggregationPipelineStage[],
): Promise<T[]>
复杂查询 - 支持 MongoDB 聚合管道查询
Type Parameters
- T extends Record<string, unknown> = Record<string, unknown>
  文档类型
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
- pipeline: AggregationPipelineStage[]
  聚合管道操作数组
Returns Promise<T[]>
聚合查询结果
- Defined in db/DatabaseOperations.ts:920

`Static`query

query<T extends Record<string, unknown> = Record<string, unknown>>(
    collectionName: string,
    ctx: DatabaseContext,
    query?: Record<string, unknown>,
    modifiers?: QueryModifiers,
): Promise<T[]>
更灵活的查询方法 - 支持更多 MongoDB 操作符
Type Parameters
- T extends Record<string, unknown> = Record<string, unknown>
  文档类型
Parameters
- collectionName: string
  集合名称
- ctx: DatabaseContext
  上下文对象
- Optionalquery: Record<string, unknown>
  查询条件，完全支持 MongoDB 查询语法
- Optionalmodifiers: QueryModifiers
  额外的查询修饰符，如 sort, skip, limit 等
  - sort
    排序选项
  - skip
    跳过数量
  - limit
    限制数量
  - projection
    投影选项
Returns Promise<T[]>
查询结果
- Defined in db/DatabaseOperations.ts:1024

Class DatabaseOperations

Template: T

Example

Index

Constructors

Methods

Constructors

constructor

Returns DatabaseOperations

Methods

StaticclearCache

Returns void

Example

StaticgetCacheStats

Returns { size: number; ttl: number }

Example

StaticaddTimestamps

Type Parameters

Parameters

Returns T & { createTime?: number; updateTime?: number }

Example

Staticcollection

Parameters

Returns CollectionReference

Staticfind

Type Parameters

Parameters

limit

offset

orderBy

orderBy.field

orderBy.direction

projection

cache

Returns Promise<T[]>

StaticfindById

Type Parameters

Parameters

Returns Promise<T | null>

Staticadd

Type Parameters

Parameters

Returns Promise<{ id: string; ids?: string[] }>

StaticaddMany

Type Parameters

Parameters

Returns Promise<{ id: string; ids?: string[] }[]>

StaticupdateMany

Type Parameters

Parameters

Returns Promise<{ updated: number }[]>

Staticupdate

Type Parameters

Parameters

Returns Promise<{ updated: number }>

StaticupdateById

Type Parameters

Parameters

Returns Promise<{ updated: number }>

StaticremoveMany

Parameters

Returns Promise<{ deleted: number }[]>

Staticremove

Parameters

Returns Promise<{ deleted: number }>

StaticremoveById

Parameters

Returns Promise<{ deleted: number }>

Staticcount

Parameters

Returns Promise<number>

StaticfindOne

Type Parameters

Parameters

Returns Promise<T | null>

Staticaggregate

Parameters

Returns Aggregation

Staticpaginate

Type Parameters

`Static`clearCache

`Static`getCacheStats

`Static`addTimestamps

`Static`collection

`Static`find

`Static`findById

`Static`add

`Static`addMany

`Static`updateMany

`Static`update

`Static`updateById

`Static`removeMany

`Static`remove

`Static`removeById

`Static`count

`Static`findOne

`Static`aggregate

`Static`paginate

`Static`aggregatePipeline

`Static`query