database.js•12 kB
/**
* database.js
*
* 数据库操作核心模块
* 提供与uniCloud数据库交互的JQL操作接口
*
* JQL (JSON Query Language) 是uniCloud提供的类MongoDB查询语法
* 详情参考：https://uniapp.dcloud.net.cn/uniCloud/jql.html
*/
import { getDbServiceUrl, getRequestTimeout } from './config.js';
// 获取数据库服务URL和请求超时时间
const DEFAULT_DB_URL = getDbServiceUrl();
const REQUEST_TIMEOUT = getRequestTimeout();
/**
* 执行数据库查询操作
*
* @param {string} collection - 集合名称
* @param {object} where - 查询条件(JQL格式)
* @param {object} [options] - 查询选项
* @param {object} [options.field] - 指定返回字段
* @param {object} [options.orderBy] - 排序条件
* @param {number} [options.limit] - 返回数量限制
* @param {number} [options.skip] - 跳过记录数
* @param {string} [dbUrl] - 自定义数据库服务URL
* @returns {Promise<object>} 查询结果
*/
async function queryDatabase(
collection,
where,
options = {},
dbUrl = DEFAULT_DB_URL
) {
try {
// 创建请求控制器，用于超时处理
const controller = new AbortController();
const timeoutId = setTimeout(() => controller.abort(), REQUEST_TIMEOUT);
// 使用传入的dbUrl或默认URL
const targetUrl = dbUrl || DEFAULT_DB_URL;
// console.log('查询操作使用URL:', targetUrl);
// 发送请求
const response = await fetch(targetUrl, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
operation: {
collection,
action: 'query',
where,
field: options.field,
orderBy: options.orderBy,
limit: options.limit,
skip: options.skip,
},
}),
signal: controller.signal,
});
clearTimeout(timeoutId);
const result = await response.json();
// 处理响应结果
if (result.code !== 0) {
throw new Error(result.msg || '查询失败');
}
return result.data;
} catch (error) {
// 超时错误特殊处理
if (error.name === 'AbortError') {
throw new Error(`查询超时: 请求超过${REQUEST_TIMEOUT}毫秒`);
}
throw new Error(`查询错误: ${error.message}`);
}
}
/**
* 执行数据库添加操作
*
* @param {string} collection - 集合名称
* @param {object} data - 要添加的数据(JQL格式)
* @param {string} [dbUrl] - 自定义数据库服务URL
* @returns {Promise<object>} 操作结果
*/
async function addToDatabase(collection, data, dbUrl = DEFAULT_DB_URL) {
try {
const controller = new AbortController();
const timeoutId = setTimeout(() => controller.abort(), REQUEST_TIMEOUT);
// 使用传入的dbUrl或默认URL
const targetUrl = dbUrl || DEFAULT_DB_URL;
// console.log('添加操作使用URL:', targetUrl);
const response = await fetch(targetUrl, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
operation: {
collection,
action: 'insert',
data,
},
}),
signal: controller.signal,
});
clearTimeout(timeoutId);
const result = await response.json();
if (result.code !== 0) {
throw new Error(result.msg || '添加失败');
}
return result.data;
} catch (error) {
if (error.name === 'AbortError') {
throw new Error(`添加超时: 请求超过${REQUEST_TIMEOUT}毫秒`);
}
throw new Error(`添加错误: ${error.message}`);
}
}
/**
* 执行数据库更新操作
*
* @param {string} collection - 集合名称
* @param {object} where - 查询条件(JQL格式)
* @param {object} data - 要更新的数据(JQL格式)
* @param {string} [dbUrl] - 自定义数据库服务URL
* @returns {Promise<object>} 操作结果
*/
async function updateDatabase(collection, where, data, dbUrl = DEFAULT_DB_URL) {
try {
const controller = new AbortController();
const timeoutId = setTimeout(() => controller.abort(), REQUEST_TIMEOUT);
// 使用传入的dbUrl或默认URL
const targetUrl = dbUrl || DEFAULT_DB_URL;
// console.log('更新操作使用URL:', targetUrl);
const response = await fetch(targetUrl, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
operation: {
collection,
action: 'update',
where,
data,
},
}),
signal: controller.signal,
});
clearTimeout(timeoutId);
const result = await response.json();
if (result.code !== 0) {
throw new Error(result.msg || '更新失败');
}
return result.data;
} catch (error) {
if (error.name === 'AbortError') {
throw new Error(`更新超时: 请求超过${REQUEST_TIMEOUT}毫秒`);
}
throw new Error(`更新错误: ${error.message}`);
}
}
/**
* 执行数据库删除操作
*
* @param {string} collection - 集合名称
* @param {object} where - 查询条件(JQL格式)
* @param {string} [dbUrl] - 自定义数据库服务URL
* @returns {Promise<object>} 操作结果
*/
async function removeFromDatabase(collection, where, dbUrl = DEFAULT_DB_URL) {
try {
const controller = new AbortController();
const timeoutId = setTimeout(() => controller.abort(), REQUEST_TIMEOUT);
// 使用传入的dbUrl或默认URL
const targetUrl = dbUrl || DEFAULT_DB_URL;
// console.log('删除操作使用URL:', targetUrl);
const response = await fetch(targetUrl, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
operation: {
collection,
action: 'delete',
where,
},
}),
signal: controller.signal,
});
clearTimeout(timeoutId);
const result = await response.json();
if (result.code !== 0) {
throw new Error(result.msg || '删除失败');
}
return result.data;
} catch (error) {
if (error.name === 'AbortError') {
throw new Error(`删除超时: 请求超过${REQUEST_TIMEOUT}毫秒`);
}
throw new Error(`删除错误: ${error.message}`);
}
}
/**
* MCP工具处理函数
*/
/**
* 处理查询工具请求
*
* @param {object} params - 工具参数
* @param {string} [dbUrl] - 自定义数据库服务URL
* @returns {object} 工具响应
*/
async function handleQueryTool(params, dbUrl) {
const { collection, where, field, orderBy, limit, skip } = params;
try {
const options = {
field: field || undefined,
orderBy: orderBy || undefined,
limit: limit || undefined,
skip: skip || undefined,
};
const data = await queryDatabase(collection, where, options, dbUrl);
return {
content: [{ type: 'text', text: JSON.stringify(data, null, 2) }],
};
} catch (error) {
return {
content: [{ type: 'text', text: error.message }],
isError: true,
};
}
}
/**
* 处理添加工具请求
*
* @param {object} params - 工具参数
* @param {string} [dbUrl] - 自定义数据库服务URL
* @returns {object} 工具响应
*/
async function handleAddTool(params, dbUrl) {
const { collection, data } = params;
try {
const result = await addToDatabase(collection, data, dbUrl);
return {
content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
};
} catch (error) {
return {
content: [{ type: 'text', text: error.message }],
isError: true,
};
}
}
/**
* 处理更新工具请求
*
* @param {object} params - 工具参数
* @param {string} [dbUrl] - 自定义数据库服务URL
* @returns {object} 工具响应
*/
async function handleUpdateTool(params, dbUrl) {
const { collection, where, data } = params;
try {
const result = await updateDatabase(collection, where, data, dbUrl);
return {
content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
};
} catch (error) {
return {
content: [{ type: 'text', text: error.message }],
isError: true,
};
}
}
/**
* 处理删除工具请求
*
* @param {object} params - 工具参数
* @param {string} [dbUrl] - 自定义数据库服务URL
* @returns {object} 工具响应
*/
async function handleRemoveTool(params, dbUrl) {
const { collection, where } = params;
try {
const result = await removeFromDatabase(collection, where, dbUrl);
return {
content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
};
} catch (error) {
return {
content: [{ type: 'text', text: error.message }],
isError: true,
};
}
}
/**
* 获取帮助提示内容
*
* @returns {object} 提示内容
*/
function getHelpPrompt() {
return {
messages: [
{
role: 'user',
content: {
type: 'text',
text: `UniCloudDB-MCP 提供以下JQL数据库操作工具:
1. query - 查询数据库记录
参数: collection(集合名称), where(查询条件), field(可选，返回字段),
orderBy(可选，排序条件), limit(可选，返回数量), skip(可选，跳过记录数)
2. add - 添加数据库记录
参数: collection(集合名称), data(要添加的数据)
3. update - 更新数据库记录
参数: collection(集合名称), where(查询条件), data(要更新的数据)
4. remove - 删除数据库记录
参数: collection(集合名称), where(查询条件)
所有工具均使用JQL格式进行数据库操作，支持与MongoDB类似的查询语法。
更多JQL语法详情请参考: https://uniapp.dcloud.net.cn/uniCloud/jql.html`,
},
},
],
};
}
/**
* 获取工具定义及其参数结构
*
* @param {object} z - zod验证模块
* @param {object} options - 选项参数
* @param {string} options.dbServiceUrl - 从环境变量获取的数据库服务URL
* @returns {object} 工具定义对象
*/
function getToolDefinitions(z, options = {}) {
// 如果有传入dbServiceUrl则优先使用，否则使用配置
const dbServiceUrl = options.dbServiceUrl || DEFAULT_DB_URL;
return {
// 查询工具
queryTool: {
name: 'query',
params: {
collection: z.string().describe('集合名称'),
where: z.record(z.any()).describe('查询条件 (JQL格式)'),
field: z.record(z.any()).optional().describe('返回字段 (可选)'),
orderBy: z
.object({
field: z.string(),
order: z.enum(['asc', 'desc']),
})
.optional()
.describe('排序条件 (可选)'),
limit: z.number().optional().describe('限制返回数量 (可选)'),
skip: z.number().optional().describe('跳过记录数 (可选)'),
},
handler: (params) => handleQueryTool(params, dbServiceUrl),
},
// 添加工具
addTool: {
name: 'add',
params: {
collection: z.string().describe('集合名称'),
data: z.record(z.any()).describe('要添加的数据 (object/array)'),
},
handler: (params) => handleAddTool(params, dbServiceUrl),
},
// 更新工具
updateTool: {
name: 'update',
params: {
collection: z.string().describe('集合名称'),
where: z.record(z.any()).describe('查询条件 (JQL格式)'),
data: z.record(z.any()).describe('要更新的数据 (object)'),
},
handler: (params) => handleUpdateTool(params, dbServiceUrl),
},
// 删除工具
removeTool: {
name: 'remove',
params: {
collection: z.string().describe('集合名称'),
where: z.record(z.any()).describe('查询条件 (JQL格式)'),
},
handler: (params) => handleRemoveTool(params, dbServiceUrl),
},
};
}
// 统一导出所有方法
export {
queryDatabase,
addToDatabase,
updateDatabase,
removeFromDatabase,
handleQueryTool,
handleAddTool,
handleUpdateTool,
handleRemoveTool,
getHelpPrompt,
getToolDefinitions,
};