From 31d8696525e93108757fc8659182fcd7b90954b4 Mon Sep 17 00:00:00 2001 From: Averi Kitsch Date: Fri, 25 Oct 2024 13:03:46 -0700 Subject: [PATCH 1/2] docs: add benefits to readme --- README.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.rst b/README.rst index dc45371c..261d26aa 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,14 @@ Cloud SQL for PostgreSQL for LangChain |preview| |pypi| |versions| +The **Cloud SQL for PostgreSQL for LangChain** package provides a first class experience for connecting to +Cloud SQL instances from the LangChain ecosystem while providing the following benefits: + +- **Simplified & Secure Connections**: easily and securely create shared connection pools to connect to Google Cloud databases utilizing IAM for authorization and database authentication without needing to manage SSL certificates, configure firewall rules, or enable authorized networks. +- **Improved performance & Simplified management**: use a single-table schema can lead to faster query execution, especially for large collections. +- **Improved metadata handling**: store metadata in columns instead of JSON, resulting in significant performance improvements. +- **Clear separation**: clearly separate table and extension creation, allowing for distinct permissions and streamlined workflows. + - `Client Library Documentation`_ - `Product Documentation`_ From df96d30f1800fcd5f2fc0fd5c838015d9faee42c Mon Sep 17 00:00:00 2001 From: Averi Kitsch Date: Fri, 25 Oct 2024 13:13:18 -0700 Subject: [PATCH 2/2] update formatting --- README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 261d26aa..9f76d6b5 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,9 @@ Cloud SQL for PostgreSQL for LangChain |preview| |pypi| |versions| +- `Client Library Documentation`_ +- `Product Documentation`_ + The **Cloud SQL for PostgreSQL for LangChain** package provides a first class experience for connecting to Cloud SQL instances from the LangChain ecosystem while providing the following benefits: @@ -11,9 +14,6 @@ Cloud SQL instances from the LangChain ecosystem while providing the following b - **Improved metadata handling**: store metadata in columns instead of JSON, resulting in significant performance improvements. - **Clear separation**: clearly separate table and extension creation, allowing for distinct permissions and streamlined workflows. -- `Client Library Documentation`_ -- `Product Documentation`_ - .. |preview| image:: https://img.shields.io/badge/support-preview-orange.svg :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels .. |pypi| image:: https://img.shields.io/pypi/v/langchain-google-cloud-sql-pg.svg