Craft Document DB

const { docDb } = MODULES;

Table of Contents

• DocDbSchemaField
  • Properties
• DocDbFindParam
  • Properties
• DocDbFindResult
  • Properties
• createCollection
  • Parameters
• insert
  • Parameters
• find
  • Parameters
• update
  • Parameters
• delete
  • Parameters

DocDbSchemaField

Type: Object

Properties

• type ("string" | "number" | "boolean" | "date" | "array") フィールドの型
• items ("string" | "number" | "boolean" | "date")? 配列型の場合の要素型
• primaryKey boolean? 主キーにする場合はtrue

DocDbFindParam

Type: Object

Properties

• collectionName string 検索対象のコレクション名
• where object? 検索条件。{ field: value } または { field: { eq|gt|gte|lt|lte|has|hasAny: value } } を指定
• orderBy object? ソート条件。{ field: 'asc' | 'desc' } を指定
• take number? 取得件数。デフォルトは10
• cursor string? 次ページ取得用カーソル

DocDbFindResult

Type: Object

Properties

• data Array<object> 条件に一致したドキュメントの配列
• nextCursor (string | null) 次ページ取得用カーソル。続きがない場合はnull
• hasMore boolean 次ページが存在するかどうか

createCollection

コレクションを作成する

管理画面からもコレクションを作成できます。

Parameters

• param object
  • param.collectionName string 作成するコレクション名
  • param.schema Object<string, DocDbSchemaField> コレクションのスキーマ定義

Returns Promise<object> empty object

insert

ドキュメントを追加する

Parameters

• param object
  • param.collectionName string 登録先のコレクション名
  • param.data object 登録するドキュメント。主キーを含める必要あり

Returns Promise<{data: object}> 登録したドキュメント

find

ドキュメントを検索する

Parameters

• param DocDbFindParam
  • param.collectionName
  • param.where
  • param.orderBy
  • param.take (optional, default 10)
  • param.cursor

Returns Promise<DocDbFindResult> 検索結果

update

ドキュメントを更新する

Parameters

• param object
  • param.collectionName string 更新対象ドキュメントのコレクション名
  • param.where object 更新対象を特定する条件。主キーを含める必要あり
  • param.data object 更新するドキュメント

Returns Promise<{data: object}> 更新後のドキュメント

delete

ドキュメントを削除する

Parameters

• param object
  • param.collectionName string 削除対象ドキュメントのコレクション名
  • param.where object 削除対象を特定する条件。主キーを含める必要あり

Returns Promise<object> empty object