摘要：使用實(shí)現(xiàn)的一個類的用于在前端查詢數(shù)據(jù)的類庫。通過內(nèi)置鉤子函數(shù)對字段進(jìn)行格式化。對數(shù)據(jù)集和查詢條件進(jìn)行重置。銷毀實(shí)例靜態(tài)方法屬性添加自定義格式化鉤子函數(shù)鉤子名稱鉤子方法添加一個重置標(biāo)題的鉤子函數(shù)我是格式化后的標(biāo)題我是格式化后的標(biāo)題版本號

使用JavaScript實(shí)現(xiàn)的一個類SQL的用于在前端查詢數(shù)據(jù)的類庫。基本接口參考了thinkphp查詢語法的實(shí)現(xiàn)。

// 支持 umd

var data = [] // 數(shù)據(jù)
var query = new Query(data)

Description

[Parameter Collections] 從數(shù)據(jù)中選取一個從開始索引(start)到一個結(jié)束索引(end)之間的部分的淺拷貝出來作為目標(biāo)對象，參數(shù)同Array.prototype.slice。多次調(diào)用以最后一次收集到的參數(shù)為準(zhǔn)。

Syntax

/**
 * @param {Number} start
 * @param {Number} end 
 */
query.range(start, end)

Example

query.range(0, 10)

Description

[Parameter Collections] 通過內(nèi)置鉤子函數(shù)(hooks)對字段進(jìn)行格式化。

Document

內(nèi)置鉤子函數(shù)(format hooks)

Syntax

/**
 * @param {String} field 待格式化字段
 * @param {String} type 鉤子函數(shù)名稱
 * @param {Object} options 可用配置項(xiàng)
 */
query.to(field, type, options) / query.format(field, type, options)

Example

// "createTime": "2017-09-08T15:26:03.896Z",
query.to("createTime", "date", {args: ["yy-MM-dd"], new: "date"})
// $date: "2017-09-08"

Description

[Parameter Collections] 條件查詢語句

Document

Syntax

/**
 * @param {String} field 字段
 * @param {String} expression 表達(dá)式
 * @param {String | Function} condition 條件
 * @param {String} relation {and(default) | or} 與上次where結(jié)果的關(guān)系
 */
query.where(field, expression, condition, relation)

Example

query
  .where("author", "eq", "smohan")
  .where([["title", "like", "javascript"], ["tags", "like", "javascript", "or"] ])
  .where("count.comments", "gt", 0)
// author === "smohan" && (title like "javascript" || tags like "javascript") && "count.comments > 0"     

Description

[Parameter Collections] 根據(jù)字段對結(jié)果集分組，返回新的結(jié)果集。一個字段只能分組一次。

Syntax

/**
 * @param {String} field 待分組的字段
 */
query.group(field)

Example

query.group("author")
/**
 * result
 * [
 *   "smohan": {count: 22, list:[...]},
 *   "流云諸葛": {count: 1, list: [...]},
 *   ...   
 * ]
 */     

Description

[Parameter Collections] 用于分頁時指定開始查詢的起始行數(shù)。

Syntax

/**
 * @param {Number} skip 指定起始行數(shù)
 */
query.skip(skip)

Example

// 從第0行開始查詢
query.skip(0)     

Description

[Parameter Collections] 用于分頁時指定查詢的數(shù)量。

Syntax

/**
 * @param {Number} limit 指定查詢的數(shù)量
 */
query.limit(limit)

Example

// 查詢10條結(jié)果
query.limit(10)
// 從第5條開始查詢10條結(jié)果
query.skip(5).limit(10)     

Description

[Parameter Collections] 對查詢結(jié)果進(jìn)行排序，輸出排序后的結(jié)果。

Syntax

/**
 * @param {String | Object} field 待排序的字段
 * @param {String | void} type 排序類型 [asc|desc]
 */
query.sort(field, type)

Example

// 按order的降序排序,如果order一樣，則再按照創(chuàng)建時間的降序排序
query
  .sort("order", "desc")
  .sort("createTime", "desc")

// 同時指定多個排序方式
query.sort({
  create_time: "desc",
  id: "desc",
  name: "asc"
})

Description

[Export results] 返回經(jīng)過查詢后的結(jié)果的總數(shù)，如果需要分頁，建議在分頁前調(diào)用該方法。

Syntax

/**
 * @returns {Number}
 */
query.count()

Example

query.count()

Description

[Export results] 返回經(jīng)過查詢后的結(jié)果集。

Syntax

/**
 * @returns {Array}
 */
query.find()

Example

query.find()

Description

對數(shù)據(jù)集和查詢條件進(jìn)行重置。一旦調(diào)用find()/count()方法后，目標(biāo)集合將會被改變，此時如果需要對源數(shù)據(jù)進(jìn)行重新查詢，需要調(diào)用該方法。

Syntax

query.reset()

Example

query.reset()
//.where()
//...

Description

銷毀實(shí)例

Syntax

query.destroy()

Description

[Static Method] 添加自定義格式化鉤子函數(shù)

Syntax

/**
 * @param {String} name 鉤子名稱
 * @param {function} handler 鉤子方法
 */
Query.hooks(name, handler)

Example

// 添加一個重置標(biāo)題的鉤子函數(shù)
Query.hooks("myTitle", function(value) {
  return "我是格式化后的標(biāo)題:" + value
})

// use
query.to("title", "myTitle", {new: true})
// result: 
// $title: "我是格式化后的標(biāo)題:title"

Description

[Static Attribute] 版本號

Syntax

Query.version