database

Author: hjlarry
Version: 0.0.3
Type: extension
Repo: https://github.com/hjlarry/dify-plugin-database
Feature Request: issues

Be Carefull!

The sql_execute tool can run any SQL query; for enhanced security, always use a read-only database account.

Description

A database tool make it easy to query data from existing databases.

You can get different format of data, like json, csv, yaml, xlsx, html, md etc. Also support use a url to get those data.

Usage

1. Input a databaseURI for Authorization. Now support mysql, postgresql, sqlite, example format:

mysql+pymysql://root:123456@localhost:3306/test
postgresql+psycopg2://postgres:123456@localhost:5432/test
sqlite:///test.db

2. Use the SQL Execute tool to query data from the database.

The OUTPUT FORMAT is used to specify the format of the output data. If you don't specify it, the default format is json and will output in the json variable of workflow node. md will output in the text variable, other format will create file and output in the files variable.

If you input the DB URI field, it will overwrite the default authorization uri, so this will be useful if you want to use different databases in the same workflow.

3. Use the Text to SQL tool can transform user input to a valid sql query.

This tool will use the default prompt here to generate a sql query. If you specify the TABLES field, it will only get those tables' schema into the LLM context.

4. Use the endpoint tool to get the data from a url request.

example url request format:

curl -X POST 'https://daemon-plugin.dify.dev/o3wvwZfYFLU5iGopr5CxYmGaM5mWV7xf/sql' -H 'Content-Type: application/json' -d '{"query":"select * from test", "format": "md"}'

Changelog

0.0.3

1. add cryptography to requirements.txt to support mysql 8.1 sha256 link
2. remove database uri setting of the endpoint
3. add a db_uri to support link to multiple databases
4. change the output of sql_execute tool to a form format
5. change the tables of text2sql tool to a llm format
6. fix sql query being converted to lowercase issue