From 2b77f89775840d6b796bcc693f7593d2aebc5fec Mon Sep 17 00:00:00 2001
From: Dan Check <dan.w.check@gmail.com>
Date: Thu, 11 Apr 2024 02:41:28 -0400
Subject: [PATCH] [#12713] Fix documentation for Postgres classes (#12714)
[#12713] Updating documentation for Postgres classes to remove mongodb references
---
.../core/storage/docstore/postgres_docstore.py | 7 ++++---
.../core/storage/kvstore/postgres_kvstore.py | 12 +++++++-----
.../llama_index/storage/docstore/postgres/base.py | 7 ++++---
.../llama_index/storage/kvstore/postgres/base.py | 12 +++++++-----
4 files changed, 22 insertions(+), 16 deletions(-)
diff --git a/llama-index-core/llama_index/core/storage/docstore/postgres_docstore.py b/llama-index-core/llama_index/core/storage/docstore/postgres_docstore.py
index 6cc7964973..f29a87faf9 100644
--- a/llama-index-core/llama_index/core/storage/docstore/postgres_docstore.py
+++ b/llama-index-core/llama_index/core/storage/docstore/postgres_docstore.py
@@ -6,13 +6,14 @@ from llama_index.core.storage.kvstore.postgres_kvstore import PostgresKVStore
class PostgresDocumentStore(KVDocumentStore):
- """Mongo Document (Node) store.
+ """Postgres Document (Node) store.
- A MongoDB store for Document and Node objects.
+ A Postgres store for Document and Node objects.
Args:
- mongo_kvstore (MongoDBKVStore): MongoDB key-value store
+ postgres_kvstore (PostgresKVStore): Postgres key-value store
namespace (str): namespace for the docstore
+ batch_size (int): batch size for bulk operations
"""
diff --git a/llama-index-core/llama_index/core/storage/kvstore/postgres_kvstore.py b/llama-index-core/llama_index/core/storage/kvstore/postgres_kvstore.py
index 4402d7c0b4..966e26df42 100644
--- a/llama-index-core/llama_index/core/storage/kvstore/postgres_kvstore.py
+++ b/llama-index-core/llama_index/core/storage/kvstore/postgres_kvstore.py
@@ -55,11 +55,13 @@ class PostgresKVStore(BaseKVStore):
"""Postgres Key-Value store.
Args:
- mongo_client (Any): MongoDB client
- uri (Optional[str]): MongoDB URI
- host (Optional[str]): MongoDB host
- port (Optional[int]): MongoDB port
- db_name (Optional[str]): MongoDB database name
+ connection_string (str): psycopg2 connection string
+ async_connection_string (str): asyncpg connection string
+ table_name (str): table name
+ schema_name (Optional[str]): schema name
+ perform_setup (Optional[bool]): perform table setup
+ debug (Optional[bool]): debug mode
+ use_jsonb (Optional[bool]): use JSONB data type for storage
"""
connection_string: str
diff --git a/llama-index-integrations/storage/docstore/llama-index-storage-docstore-postgres/llama_index/storage/docstore/postgres/base.py b/llama-index-integrations/storage/docstore/llama-index-storage-docstore-postgres/llama_index/storage/docstore/postgres/base.py
index b9b9ae38cb..abb45da703 100644
--- a/llama-index-integrations/storage/docstore/llama-index-storage-docstore-postgres/llama_index/storage/docstore/postgres/base.py
+++ b/llama-index-integrations/storage/docstore/llama-index-storage-docstore-postgres/llama_index/storage/docstore/postgres/base.py
@@ -6,13 +6,14 @@ from llama_index.storage.kvstore.postgres import PostgresKVStore
class PostgresDocumentStore(KVDocumentStore):
- """Mongo Document (Node) store.
+ """Postgres Document (Node) store.
- A MongoDB store for Document and Node objects.
+ A Postgres store for Document and Node objects.
Args:
- mongo_kvstore (MongoDBKVStore): MongoDB key-value store
+ postgres_kvstore (PostgresKVStore): Postgres key-value store
namespace (str): namespace for the docstore
+ batch_size (int): batch size for bulk operations
"""
diff --git a/llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-postgres/llama_index/storage/kvstore/postgres/base.py b/llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-postgres/llama_index/storage/kvstore/postgres/base.py
index 4402d7c0b4..966e26df42 100644
--- a/llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-postgres/llama_index/storage/kvstore/postgres/base.py
+++ b/llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-postgres/llama_index/storage/kvstore/postgres/base.py
@@ -55,11 +55,13 @@ class PostgresKVStore(BaseKVStore):
"""Postgres Key-Value store.
Args:
- mongo_client (Any): MongoDB client
- uri (Optional[str]): MongoDB URI
- host (Optional[str]): MongoDB host
- port (Optional[int]): MongoDB port
- db_name (Optional[str]): MongoDB database name
+ connection_string (str): psycopg2 connection string
+ async_connection_string (str): asyncpg connection string
+ table_name (str): table name
+ schema_name (Optional[str]): schema name
+ perform_setup (Optional[bool]): perform table setup
+ debug (Optional[bool]): debug mode
+ use_jsonb (Optional[bool]): use JSONB data type for storage
"""
connection_string: str
--
GitLab