database/readme.md

# Database Tool

Contributor: [Xuanhe Zhou](https://github.com/zhouxh19)

### API Functions

- *get_database_schema*: obtain the information of target tables 
- *select_database_data*: fetch the query results from a database instance
- *rewrite_sql*: transform a sql query into an semantic-equivalent but execution-efficient sql

### Dataset

- Text2SQL Dataset

    - *./data/tpch10x/text2res_multi_table.json*: relativley complex database queries (2-6 tables)
    - *./data/tpch10x/text2res_single_table.json*: basic database queries

- SQL Optimization Dataset

    - Samples for *[sql rewrite](https://github.com/TsinghuaDatabaseGroup/lmdb/tree/main/query_rewrite/data)*

    - Samples for *[index tuning](https://github.com/TsinghuaDatabaseGroup/lmdb/tree/main/index_tuning/data)*

### Setup

1. Follow the steps in [main readme](https://github.com/OpenBMB/swarms.tools/blob/main/README.md)


2. Rename config.ini.template into my_config.ini

3. Configure the adopted LLM model in the 84th line of ../../agent/singletool.py, e.g., 

```bash
    self.llm = OpenAI(model_name="gpt-3.5-turbo", temperature=0.0, openai_api_key=key)
```

4. Modify database settings in my_config.ini, e.g.,

```bash
    [{db_system}]
    host = 127.0.0.1
    port = 5432
    user = postgres
    password = postgres
    dbname = postgres
```

And rename *config.ini* into *my_config.ini*.

Note. {db_system} must match with that in ./api.py

4. Modify and run the test.py script to test the tool