mas-nedb

2.0.1 • Public • Published

Mas-Nedb

Mas-Nedb 是基于 NeDB 数据库的一个 Node.js 库封装,旨在提供更简洁的 API 和方便的数据操作功能。该库允许你轻松地创建、管理和查询数据,无需依赖外部数据库服务器。

注意

该文档说明基于 gpt 生成,有问题请反馈

安装

你可以使用 npm 来安装 Mas-Nedb:

npm install mas-nedb

使用示例

以下是一个使用 Mas-Nedb 库的示例:

const masNedb = require("mas-nedb");

// 设置数据库列表
const dbList = [
  { name: "users", path: "./data/users.db" },
  { name: "products", path: "./data/products.db" },
];

// 设置数据库列表
masNedb.setDbList(dbList);

// 使用数据库
const db = masNedb.db();

// 插入数据
db.use("users")
  .insert({ name: "John Doe", age: 30 })
  .then((data) => {
    console.log("插入成功", data);
  })
  .catch((error) => {
    console.error(error);
  });

// 查询数据
db.use("users")
  .select({ age: { $gte: 25 } })
  .then((data) => {
    console.log("查询结果", data);
  })
  .catch((error) => {
    console.error(error);
  });

// 更新数据
db.use("users")
  .update({ name: "John Doe" }, { age: 35 })
  .then((numUpdated) => {
    console.log("更新成功", numUpdated, "条数据");
  })
  .catch((error) => {
    console.error(error);
  });

// 删除数据
db.use("users")
  .delete({ age: { $lt: 20 } })
  .then((numRemoved) => {
    console.log("删除成功", numRemoved, "条数据");
  })
  .catch((error) => {
    console.error(error);
  });

API 参考

masNedb.setDbList(arr)

设置数据库列表。

  • arr:DbList[],包含数据库名称和路径的对象数组。

masNedb.db()

返回数据库对象。

db.use(name)

指定要操作的数据库表。

  • name:string,数据库表的名称。

db.insert(data)

插入单个数据。

  • data:{},要插入的数据对象。

db.insertArray(data)

插入多个数据。

  • data:[],要插入的数据对象数组。

db.select(where, findOne)

查询数据。

  • where:Function | {},查询条件。可以是一个函数或对象。
  • findOne:Boolean,是否只返回一个匹配的结果,默认为false

db.delete(where, multi)

删除数据。

  • where:Function | {},删除条件。可以是一个函数或对象。
  • multi:Boolean,是否删除多条数据,默认为false

db.update(where, data, options)

更新数据。

  • where:Function | {},限制条件。可以是一个函数或对象。
  • data:{},要更新的数据对象。
  • options:updateOptions,更新选项,包括multiupsert属性。
updateOptions
  • multi:Boolean,是否允许修改多条文档,默认为`
{
  multi: false, // 是否允许修改多条文档,默认为false
  upsert: false // 没有找到对应数据时,是否自动插入,默认为false
}

注意事项

  • 在使用db.use(name)之前,确保已经调用了masNedb.setDbList(arr)来设置数据库列表。
  • 在执行操作之前,先调用db.use(name)来指定要操作的数据库表。
  • 如果未指定数据库表或操作的数据格式错误,会抛出错误。
  • 所有操作都返回 Promise 对象,可以使用.then().catch()来处理操作结果或错误。

总结

Mas-Nedb 是一个基于 NeDB 数据库的简洁封装库,提供了简单易用的 API 和便捷的数据操作功能。通过使用 Mas-Nedb,你可以轻松地在 Node.js 应用程序中管理和查询数据,无需依赖外部数据库服务器。请参考 API 参考部分获取更详细的方法和选项说明。

注意:以上代码示例是基于你提供的代码进行修改和整理的,如果你的代码存在问题或需求有特殊要求,请提供更多信息以便进行适当调整。

Package Sidebar

Install

npm i mas-nedb

Weekly Downloads

2

Version

2.0.1

License

ISC

Unpacked Size

12.5 kB

Total Files

5

Last publish

Collaborators

  • tingxi8087