jsql 项目技术文档

1. 安装指南

安装环境要求

• Node.js 版本：>= 12.x
• npm 或 yarn

安装步骤

1. 打开终端或命令行工具。
2. 使用 npm 或 yarn 安装 jsql：

npm install jsql

或

yarn add jsql

3. 安装完成后，您可以在项目中引入 jsql 进行使用。

2. 项目使用说明

概述

jsql 是一个 JavaScript 查询语言，旨在提供一种原生的 JSON 查询格式，用于查询任何内容，最初仅限于 JavaScript 对象。jsql 的参考实现 searchjs 使用 jsql 查询 JS 对象或对象数组，并返回匹配的结果。

基本用法

jsql 的查询语法始终是一个单一的 JavaScript 对象 {}，其中包含用于查询的参数。查询对象可以包含三种类型的属性：

• Primitives（基本类型）：用于匹配一个或多个字段，支持 AND 或 OR 逻辑，以及否定操作。
• Modifiers（修饰符）：用于修改其他属性的处理方式，如否定、字段连接类型、范围和文本搜索。
• Composites（复合类型）：用于将多个基本类型组合在一起。

示例

以下是一个简单的查询示例：

const searchjs = require('jsql');

const data = [
  { name: "John", age: 30 },
  { name: "Alice", age: 25 },
  { name: "Bob", age: 35 }
];

const query = { name: "John" };

const results = searchjs.match(data, query);
console.log(results); // 输出: [{ name: "John", age: 30 }]

3. 项目 API 使用文档

match(data, query)

• 描述：根据查询条件匹配数据中的对象。
• 参数：
  • data：要查询的数据，可以是单个对象或对象数组。
  • query：查询条件，使用 jsql 语法定义的查询对象。
• 返回值：返回匹配的对象数组。

查询语法详解

基本类型（Primitives）

基本类型用于匹配单个或多个字段。例如：

{ name: "John" } // 匹配 name 字段等于 "John" 的对象
{ name: "John", age: 30 } // 匹配 name 字段等于 "John" 且 age 字段等于 30 的对象

修饰符（Modifiers）

修饰符用于修改查询行为，如否定、逻辑连接和文本搜索。

• 否定（Negation）：

  { name: "John", _not: true } // 匹配 name 字段不等于 "John" 的对象
  

• 逻辑连接（Join）：

  { name: "John", age: 30, _join: "OR" } // 匹配 name 字段等于 "John" 或 age 字段等于 30 的对象
  

• 文本搜索（Text Searching）：

  { name: "davi", _text: true } // 匹配 name 字段包含 "davi" 的对象
  

复合类型（Composites）

复合类型用于将多个基本类型组合在一起。例如：

{ terms: [{ name: "John" }, { age: 30 }] } // 匹配 name 字段等于 "John" 或 age 字段等于 30 的对象

4. 项目安装方式

使用 npm 安装

npm install jsql

使用 yarn 安装

yarn add jsql

手动下载

您也可以从 GitHub 仓库手动下载源代码并将其添加到您的项目中。

git clone https://github.com/deitch/searchjs.git

下载后，将 searchjs 文件夹复制到您的项目中，并在代码中引入：

const searchjs = require('./path/to/searchjs');

通过以上步骤，您可以成功安装并使用 jsql 项目。