APIリファレンス(JavaScript)

baasatrakuza > QueryBase

QueryBase class

Queryのベースクラスです。

Signature:

export declare abstract class QueryBase<T extends QueryBase<T>> 

Remarks

カスタムのQueryを作成する場合は、このクラスを継承してください。

Queryのメソッドは中間メソッドと終端メソッドに分かれます。 中間メソッドで条件を指定し、終端メソッドで実際にAPIにリクエストを送信します。

WARNING

このクラスを継承するすべてのQueryがすべての条件を使用できる訳ではありません。

どの条件を使用できるかは、各Queryの終端メソッドのコメントを確認してください。 例えば、ContactQuery.find()に対して、QueryBase.limit()を設定してもAPIは無視します。

Example

const dataResult = await RKZ.Data.query('shop')
  .equalTo('city', 'okayama') // 中間メソッド
  .find() // 終端メソッド

Constructors

Constructor	Modifiers	Description
(constructor)(context)		コンストラクタです。

Properties

Property	Modifiers	Type	Description
_limit		number
_offset		number
api		API	APIです
context		Context
order		Order[]
where		Condition[]

Methods

Method	Modifiers	Description
asc(columnName)		昇順のソート条件を追加します。
betweenExclude(columnName, from, to)		範囲検索条件の検索条件を追加します。
betweenInclude(columnName, from, to)		範囲検索条件の検索条件を追加します。
contains(columnName, value)		中間一致検索条件を追加します。
containsInArray(columnName, values)		チェックボックス項目の要素リスト一致検索条件を追加します。
desc(columnName)		降順のソート条件を追加します。
endsWith(columnName, value)		後方一致検索条件を追加します。
equalTo(columnName, value)		一致検索条件を追加します。
greaterThanOrEqualTo(columnName, value)		条件値以上の検索条件を追加します。
in(columnName, values)		要素リスト一致検索条件を追加します。
lessThanOrEqualTo(columnName, value)		条件値以下の検索条件を追加します。
limit(limit)		取得件数を設定します。
notEqualTo(columnName, value)		不一致検索条件を追加します。
notIn(columnName, values)		要素リスト不一致検索条件を追加します。
offset(offset)		取得データの開始位置を設定します。
startsWith(columnName, value)		前方一致検索条件を追加します。
toJSON()		QueryをJSONに変換します。