-
Notifications
You must be signed in to change notification settings - Fork 15.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Add how-to guide for SQLDatabaseLoader
#27696
base: master
Are you sure you want to change the base?
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
3811746
to
458cc87
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Submitting just a few comments from self-review.
"cell_type": "markdown", | ||
"metadata": {}, | ||
"source": [ | ||
"# SQL Database\n", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"# SQL Database\n", | |
"# SQLDatabaseLoader\n", |
"For talking to the database, the document loader uses the [SQLDatabase]\n", | ||
"utility from the LangChain integration toolkit.\n", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"For talking to the database, the document loader uses the [SQLDatabase]\n", | |
"utility from the LangChain integration toolkit.\n", | |
"For talking to the database, the document loader uses the [SQLDatabase]\n", | |
"utility.\n", |
"\n", | ||
"[SQLAlchemy]: https://www.sqlalchemy.org/\n", | ||
"[SQLAlchemy dialects]: https://docs.sqlalchemy.org/en/latest/dialects/\n", | ||
"[SQLDatabase]: https://python.langchain.com/docs/integrations/toolkits/sql_database\n", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Linking to the SQLDatabase Toolkit was probably wrong, so let's better link to the Utility instead?
"[SQLDatabase]: https://python.langchain.com/docs/integrations/toolkits/sql_database\n", | |
"[SQLDatabase]: https://python.langchain.com/api_reference/community/utilities/langchain_community.utilities.sql_database.SQLDatabase.html\n", |
Is there a better piece of dedicated documentation about this component elsewhere in the documentation tree, i.e. are you advising to use a different target link here?
SQLDatabaseLoader
SQLDatabaseLoader
Hi @amotl, thank you for taking the initiative to improve the how-to guides! We don't have good guidelines yet for the how-to guides, but if you can browse through a few (https://python.langchain.com/docs/how_to/), you may get a bit of a sense of the format:
|
Thank you for your guidance, Eugene. I will rework the patch according to your suggestions, and come back afterwards. The same guidelines will probably also apply to GH-27713. Both pieces of documentation are coming from initially being conceived around LangChain <0.1 times, where blueprints from other how-to documents have not been so elaborate yet. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
I would appreciate additional reviewers
@kneth: The ingredients of this patch need further love, as outlined by @eyurtsev. That's why we toggled it into draft mode again. Relevant patches are welcome. |
SQLDatabaseLoader
.SQLDatabaseLoader
document loader #18281Dear Eugene,
coming from GH-16246/GH-18281, this patch adds missing documentation that has still been included in crate-workbench#1. We wanted to break it out of that patch, in order to further minimise its size before submitting it.
With kind regards,
Andreas.
NB: Can I also humbly ask you to review/exercise this for validity, @simonprickett or @kneth? I think the demonstrated code should work with recent vanilla versions of LangChain, with all of SQLite, PostgreSQL, and CrateDB.