zjy-sqlite-manage使用文档v1

以下是一个关于如何在uniapp项目中使用SQLite数据库的文档。这个文档将介绍如何使用你提供的数据库操作函数来管理SQLite数据库。

---

# uniapp项目中的SQLite数据库操作指南

## 1. 引言

SQLite是一个轻量级的数据库，广泛用于移动应用中。在uniapp项目中，可以通过内置的`plus.sqlite`对象来操作SQLite数据库。本指南将介绍如何使用这些函数来创建、查询、更新和删除数据库中的数据。

## 2. 函数概览

### 2.1 数据库操作

- `openDb(name)`: 打开或创建一个SQLite数据库。

- `init(name, tableSqls)`: 初始化数据库，包括创建表。

- `getTable(name)`: 获取数据库中所有表的名称。

- `getCount(name, tabName)`: 获取指定表中的数据总条数。

- `isTable(name, tabName)`: 检查指定表是否存在。

- `closeSQL(name)`: 关闭数据库。

- `isOpen(name)`: 检查数据库是否已打开。

- `delTable(name, tabName)`: 删除指定的表。

### 2.2 数据操作

- `addTab(name, sql)`: 创建一个新表。

- `addTabItem(name, tabName, obj)`: 向表中添加一条新数据。

- `updateSQL(name, tabName, setData, setName, setVal)`: 更新表中的数据。

- `delData(name, tabName, setData)`: 删除表中的数据。

- `mergeSql(name, tabName, tabs)`: 合并数据到表中。

- `getDataList(name, tabName, num, size, byName, byType)`: 获取分页数据。

- `selectDataList(name, tabName, setData, byName, byType)`: 查询表中的数据。

- `selectCount(name, tabName, setData)`: 查询符合条件的数据条数。

## 3. 使用示例

### 3.1 打开数据库

```javascript

openDb('myDatabase').then(() => {

  console.log('数据库已打开');

});

```

### 3.2 初始化数据库

```javascript

const tableSqls = [

  { tableName: 'users', sql: 'CREATE TABLE users(id INTEGER PRIMARY KEY, name TEXT)' },

  // 其他表的配置

];

init('myDatabase', tableSqls);

```

### 3.3 添加数据

```javascript

addTabItem('myDatabase', 'users', { id: 1, name: 'John Doe' }).then(() => {

  console.log('数据已添加');

});

```

### 3.4 查询数据

```javascript

selectDataList('myDatabase', 'users').then(data => {

  console.log('查询结果：', data);

});

```

## 4. 注意事项

- 确保在操作数据库之前已经正确打开了数据库。

- 所有数据库操作函数都返回Promise，因此可以使用async/await进行异步操作。

- 在执行数据库操作时，注意处理可能出现的错误。

## 5. 结语

通过本指南，你应该能够熟悉如何在uniapp项目中使用SQLite数据库。这些函数为数据库操作提供了便捷的方式，使得开发更加高效。

以下是一个关于 `selectDataList` 函数的Markdown格式文档：

---

# `selectDataList(name, tabName, setData, byName, byType)`

## 描述

`selectDataList` 函数用于查询数据库表中的数据。

## 参数

- `name`: 数据库的名称。

- `tabName`: 要查询的表的名称。

- `setData`: 一个对象，包含查询条件。如果这个对象为空或 `{}`，则查询将返回表中的所有数据。

- `byName`: 要排序的列名。如果提供这个参数，则查询结果将根据这个列名进行排序。

- `byType`: 排序类型，可以是 `'asc'` 或 `'desc'`，分别表示升序或降序排序。

## 返回值

返回查询结果。

## 示例

```javascript

selectDataList('myDatabase', 'users', { id: 1 }, 'name', 'asc').then(data => {

  console.log('查询结果：', data);

});

```

在这个示例中，我们查询名为 `users` 的表，只返回 `id` 等于 1 的数据，并按照 `name` 列升序排列。

## 注意事项

- 在调用 `selectDataList` 函数之前，确保数据库已成功打开。

- 正确处理可能出现的错误。

---

这个Markdown文档提供了 `selectDataList` 函数的简要描述、参数说明、返回值、示例用法和注意事项。