From 107425c68d54e9efbbfdf4ea7727f50c76a5a712 Mon Sep 17 00:00:00 2001 From: Christopher Jones Date: Fri, 29 Aug 2025 00:32:45 +1000 Subject: [PATCH] docs: fix basic Oracle example issues such as capitalization (#32730) **Description:** fix capitalization and basic issues in https://python.langchain.com/docs/integrations/document_loaders/oracleadb_loader/ Signed-off-by: Christopher Jones --- .../document_loaders/oracleadb_loader.ipynb | 119 +++++++++++------- 1 file changed, 73 insertions(+), 46 deletions(-) diff --git a/docs/docs/integrations/document_loaders/oracleadb_loader.ipynb b/docs/docs/integrations/document_loaders/oracleadb_loader.ipynb index b1f6577254a..02405461cc3 100644 --- a/docs/docs/integrations/document_loaders/oracleadb_loader.ipynb +++ b/docs/docs/integrations/document_loaders/oracleadb_loader.ipynb @@ -2,67 +2,91 @@ "cells": [ { "cell_type": "markdown", + "metadata": { + "collapsed": false, + "jupyter": { + "outputs_hidden": false + } + }, "source": [ "# Oracle Autonomous Database\n", "\n", - "Oracle autonomous database is a cloud database that uses machine learning to automate database tuning, security, backups, updates, and other routine management tasks traditionally performed by DBAs.\n", + "Oracle Autonomous Database is a cloud database that uses machine learning to automate database tuning, security, backups, updates, and other routine management tasks traditionally performed by DBAs.\n", "\n", - "This notebook covers how to load documents from oracle autonomous database, the loader supports connection with connection string or tns configuration.\n", + "This notebook covers how to load documents from Oracle Autonomous Database.\n", "\n", "## Prerequisites\n", - "1. Database runs in a 'Thin' mode:\n", - " https://python-oracledb.readthedocs.io/en/latest/user_guide/appendix_b.html\n", - "2. `pip install oracledb`:\n", - " https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html" - ], - "metadata": { - "collapsed": false - } + "1. Install python-oracledb:\n", + "\n", + " `pip install oracledb`\n", + " \n", + " See [Installing python-oracledb](https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html).\n", + "\n", + "2. A database that python-oracledb's default 'Thin' mode can connected to. This is true of Oracle Autonomous Database, see [python-oracledb Architecture](https://python-oracledb.readthedocs.io/en/latest/user_guide/introduction.html#architecture).\n" + ] }, { "cell_type": "markdown", + "metadata": { + "collapsed": false, + "jupyter": { + "outputs_hidden": false + } + }, "source": [ "## Instructions" - ], - "metadata": { - "collapsed": false - } + ] }, { "cell_type": "code", "execution_count": null, + "metadata": { + "collapsed": false, + "jupyter": { + "outputs_hidden": false + } + }, "outputs": [], "source": [ "pip install oracledb" - ], - "metadata": { - "collapsed": false - } + ] }, { "cell_type": "code", "execution_count": null, + "metadata": { + "collapsed": false, + "jupyter": { + "outputs_hidden": false + } + }, "outputs": [], "source": [ "from langchain_community.document_loaders import OracleAutonomousDatabaseLoader\n", "from settings import s" - ], - "metadata": { - "collapsed": false - } + ] }, { "cell_type": "markdown", - "source": [ - "With mutual TLS authentication (mTLS), wallet_location and wallet_password are required to create the connection, user can create connection by providing either connection string or tns configuration details." - ], "metadata": { - "collapsed": false - } + "collapsed": false, + "jupyter": { + "outputs_hidden": false + } + }, + "source": [ + "With mutual TLS authentication (mTLS), wallet_location and wallet_password parameters are required to create the connection. See python-oracledb documentation [Connecting to Oracle Cloud Autonomous Databases](https://python-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#connecting-to-oracle-cloud-autonomous-databases)." + ] }, { "cell_type": "code", "execution_count": null, + "metadata": { + "collapsed": false, + "jupyter": { + "outputs_hidden": false + } + }, "outputs": [], "source": [ "SQL_QUERY = \"select prod_id, time_id from sh.costs fetch first 5 rows only\"\n", @@ -89,24 +113,30 @@ " wallet_password=s.PASSWORD,\n", ")\n", "doc_2 = doc_loader_2.load()" - ], - "metadata": { - "collapsed": false - } + ] }, { "cell_type": "markdown", - "source": [ - "With TLS authentication, wallet_location and wallet_password are not required.\n", - "Bind variable option is provided by argument \"parameters\"." - ], "metadata": { - "collapsed": false - } + "collapsed": false, + "jupyter": { + "outputs_hidden": false + } + }, + "source": [ + "With 1-way TLS authentication, only the database credentials and connection string are required to establish a connection.\n", + "The example below also shows passing bind variable values with the argument \"parameters\"." + ] }, { "cell_type": "code", "execution_count": null, + "metadata": { + "collapsed": false, + "jupyter": { + "outputs_hidden": false + } + }, "outputs": [], "source": [ "SQL_QUERY = \"select channel_id, channel_desc from sh.channels where channel_desc = :1 fetch first 5 rows only\"\n", @@ -131,31 +161,28 @@ " parameters=[\"Direct Sales\"],\n", ")\n", "doc_4 = doc_loader_4.load()" - ], - "metadata": { - "collapsed": false - } + ] } ], "metadata": { "kernelspec": { - "display_name": "Python 3", + "display_name": "Python 3 (ipykernel)", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", - "version": 2 + "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", - "pygments_lexer": "ipython2", - "version": "2.7.6" + "pygments_lexer": "ipython3", + "version": "3.12.11" } }, "nbformat": 4, - "nbformat_minor": 0 + "nbformat_minor": 4 }