Archives/langchain
2
0
Fork 1
mirror of https://github.com/hwchase17/langchain synced 2024-11-06 03:20:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update sql chain notebook to clarify use of SQLAlchemy for connections (#2850)

Browse Source 
Have seen questions about whether or not the `SQLDatabaseChain` supports
more than just sqlite, which was unclear in the docs, so tried to
clarify that and how to connect to other dialects.
This commit is contained in:
Jon Luo 2023-04-13 14:46:59 -04:00 committed by GitHub
parent ecc1a0c051
commit f3180f05f9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/modules/chains/examples/sqlite.ipynb
View File

@ -9,9 +9,9 @@
} }
}, },
"source": [ "source": [
"# SQLite example\n", "# SQL Chain example\n",
"\n", "\n",
"This example showcases hooking up an LLM to answer questions over a database." "This example demonstrates the use of the `SQLDatabaseChain` for answering questions over a database."
] ]
}, },
{ {
@ -23,8 +23,10 @@
} }
}, },
"source": [ "source": [
"This uses the example Chinook database.\n", "Under the hood, LangChain uses SQLAlchemy to connect to SQL databases. The `SQLDatabaseChain` can therefore be used with any SQL dialect supported by SQLAlchemy, such as MS SQL, MySQL, MariaDB, PostgreSQL, Oracle SQL, and SQLite. Please refer to the SQLAlchemy documentation for more information about requirements for connecting to your database. For example, a connection to MySQL requires an appropriate connector such as PyMySQL. A URI for a MySQL connection might look like: `mysql+pymysql://user:pass@some_mysql_db_address/db_name`\n",
"To set it up follow the instructions on https://database.guide/2-sample-databases-sqlite/, placing the `.db` file in a notebooks folder at the root of this repository." "\n",
"This demonstration uses SQLite and the example Chinook database.\n",
"To set it up, follow the instructions on https://database.guide/2-sample-databases-sqlite/, placing the `.db` file in a notebooks folder at the root of this repository."
] ]
}, },
{ {
@ -679,7 +681,7 @@
"name": "python", "name": "python",
"nbconvert_exporter": "python", "nbconvert_exporter": "python",
"pygments_lexer": "ipython3", "pygments_lexer": "ipython3",
"version": "3.9.1" "version": "3.10.10"
} }
}, },
"nbformat": 4, "nbformat": 4,