node-tds 技术文档

1. 安装指南

node-tds 是一个用于连接 Microsoft SQL Server 数据库的 Node.js 客户端。以下是安装 node-tds 的步骤：

1. 确保您的系统中已安装 Node.js。

2. 打开命令行工具，执行以下命令：

   npm install tds
   

   这将自动下载并安装 node-tds 库及其依赖项。

2. 项目使用说明

node-tds 提供了一套用于连接和操作 SQL Server 数据库的 API。以下是基本的使用方法：

连接数据库

首先，您需要创建一个连接到 SQL Server 数据库的连接对象。以下是创建连接的基本代码：

const tds = require('tds');

// 创建连接配置
const config = {
  user: 'your_username',
  password: 'your_password',
  server: 'your_server',
  options: {
    database: 'your_database',
    encrypt: true,
    enableArithAbort: true
  }
};

// 创建连接
const connection = new tds.Connection(config);

执行查询

一旦连接成功，您可以执行 SQL 查询：

connection.on('connect', function(err) {
  if (err) {
    console.error(err);
    return;
  }

  connection.execSql('SELECT * FROM your_table', function(err, recordset) {
    if (err) {
      console.error(err);
      return;
    }

    console.dir(recordset);
    connection.close();
  });
});

关闭连接

在执行完所有操作后，请确保关闭数据库连接：

connection.close();

3. 项目API使用文档

以下是 node-tds 的一些主要 API：

Connection 类

• new tds.Connection(config)：创建一个新的连接对象。
• connection.on('connect', callback)：当连接成功时触发。
• connection.execSql(query, callback)：执行 SQL 查询。

Recordset 类

• recordset.toArray(callback)：将结果集转换为数组。
• recordset.forEach(callback)：遍历结果集中的每条记录。

Error 类

• error.message：错误消息。
• error.code：错误代码。

4. 项目安装方式

项目的安装方式已在“1. 安装指南”中详细说明。简要概述如下：

1. 确保您的系统中已安装 Node.js。

2. 打开命令行工具，执行以下命令：

   npm install tds
   

以上是 node-tds 的基本使用方法和 API 文档。希望本文能够帮助您更好地了解和使用这个项目。