npm 包 pon-task-db 使用教程

阅读时长 3 分钟读完

简介

npm 是 Node.js 的包管理工具。你可以使用它来安装、管理和共享代码包。pon-task-db 是一种 npm 包,它是基于 pon 的一个任务, 提供一个简单的使用数据库的 API。

为什么需要 pon-task-db

有很多跨数据库的 ORM 工具,但是它们涉及到很多概念和设计模式的学习,这使得学习成本很高,因此 pon-task-db 仅提供非常轻量级的 API,方便用户快速、简单地使用数据库。

安装

安装 pon-task-db可以使用 npm:

示例

我们先来看一个简单的连接到 PostgreSQL 数据库的例子,并插入一些数据:

点开这里以获取更多有关 pon 的信息。

API

以下是 pon-task-db 的 API:

db(options, setup)

options

Type: object

返回一个新的 pon 任务。可用的选项在所有支持的数据库之间是一致的。目前,支持的数据库包括:

  • mysql
  • postgresql
  • redshift
  • sqlite
  • mssql

options.dialect

Type: string

方言,必须是:

  • 'mysql'
  • 'postgresql'
  • 'redshift'
  • 'sqlite'
  • 'mssql'

options.db

Type: string

数据库名称

例如,对于 MySQL 数据库:

options.user

Type: string

用户名

options.password

Type: string

密码

options.host

Type: string

连接的主机名称

如果未设置,则将使用“localhost”作为默认值。

options.port

Type: string

连接的端口号

如果未设置,则将使用各种方言的默认端口。

setup

Type: function

在连接到数据库后,回调 setup 函数。该函数将接收一个数据库实例,并返回一个 Promise。返回的 Promise 的解决函数将成为任务的结果。

总结

pon-task-db 提供了一个快速、简单的 API 来使用数据库。像其他 knex 之类的 ORM 工具那样,它不需要你去学习复杂的 API, 只需要简单的了解一下常规 SQL 命令就可以使用它了。它支持多个数据库,在没有耗费大量时间学习 ORM 概念的情况下迅速连接到所需的数据库。

在使用时,需要使用 db 方法定义一个任务,并在回调函数中使用数据库实例。请参阅文档了解更多的选项,这样你就能更轻松、更轻松地使用 pon-task-db 了。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/191060