MQL项目安装与配置指南

MQL项目安装与配置指南

mql MQL tool is designed to generate SQL queries directly from natural language inputs. 项目地址: https://gitcode.com/gh_mirrors/mq/mql

1. 项目基础介绍

MQL（My Query Language）是一款将自然语言查询转换为可执行SQL查询的强大工具。它使得即使是不懂编程的用户也能够通过自然语言提问，获取到相应的SQL查询语句。MQL项目的主要编程语言包括Python、TypeScript和JavaScript。

2. 项目使用的关键技术和框架

• 自然语言处理（NLP）: MQL利用NLP技术理解用户的自然语言输入，并将其转换为SQL查询。
• PostgreSQL: 项目后端使用PostgreSQL数据库存储和管理数据。
• Docker: 使用Docker容器化技术简化部署和环境配置。
• OpenAI API: 利用OpenAI的API来增强自然语言处理的能力。

3. 项目安装和配置准备工作

在开始安装前，请确保您的系统满足以下要求：

• Docker：确保已经安装了Docker环境。
• PostgreSQL：需要安装PostgreSQL数据库。
• Python：安装Python环境及其相关依赖。
• Node.js：安装Node.js环境。

详细安装步骤

步骤 1: 克隆项目

首先，使用Git克隆项目到本地：

git clone https://github.com/shurutech/mql.git
cd mql

步骤 2: 配置Docker

编辑server/Dockerfile文件，将您的OPENAI_API_KEY环境变量添加到文件中：

ENV OPENAI_API_KEY YOUR_TOKEN_HERE

步骤 3: 设置环境变量

编辑server/.env文件，配置数据库连接信息：

DATABASE_URL=postgresql://<role_name>:<password>@<host>:5432/mql
TEST_DATABASE_URL=postgresql://<role_name>:<password>@<host>:5432/mql_test

如果数据库是本地主机，<host>应设置为localhost。

步骤 4: 数据库设置

在PostgreSQL命令行客户端中运行以下命令，创建角色和数据库：

CREATE ROLE <role_name> WITH superuser;
ALTER ROLE <role_name> WITH LOGIN PASSWORD '<password>';

CREATE DATABASE mql WITH OWNER <role_name>;
CREATE DATABASE mql_test WITH OWNER <role_name>;

接着，创建vector扩展：

\c mql
CREATE EXTENSION vector;

步骤 5: 安装项目依赖

在项目目录中运行以下命令安装依赖：

make install

步骤 6: 启动服务

启动Docker服务：

make up

步骤 7: 访问MQL仪表板

安装完成后，你可以通过浏览器访问MQL仪表板：

http://localhost:3000

使用默认的用户信息登录测试：

• 邮箱：admin@example.com
• 密码：admin

以上就是MQL项目的详细安装和配置指南。按照以上步骤操作后，你将能够成功部署并运行MQL项目。

mql MQL tool is designed to generate SQL queries directly from natural language inputs. 项目地址: https://gitcode.com/gh_mirrors/mq/mql