Skip to content

Commit 2b77f89

Browse files
authored
[run-llama#12713] Fix documentation for Postgres classes (run-llama#12714)
[run-llama#12713] Updating documentation for Postgres classes to remove mongodb references
1 parent de6f22f commit 2b77f89

File tree

4 files changed

+22
-16
lines changed
  • llama-index-core/llama_index/core/storage
  • llama-index-integrations/storage
    • docstore/llama-index-storage-docstore-postgres/llama_index/storage/docstore/postgres
    • kvstore/llama-index-storage-kvstore-postgres/llama_index/storage/kvstore/postgres

4 files changed

+22
-16
lines changed

llama-index-core/llama_index/core/storage/docstore/postgres_docstore.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@
66

77

88
class PostgresDocumentStore(KVDocumentStore):
9-
"""Mongo Document (Node) store.
9+
"""Postgres Document (Node) store.
1010
11-
A MongoDB store for Document and Node objects.
11+
A Postgres store for Document and Node objects.
1212
1313
Args:
14-
mongo_kvstore (MongoDBKVStore): MongoDB key-value store
14+
postgres_kvstore (PostgresKVStore): Postgres key-value store
1515
namespace (str): namespace for the docstore
16+
batch_size (int): batch size for bulk operations
1617
1718
"""
1819

llama-index-core/llama_index/core/storage/kvstore/postgres_kvstore.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,13 @@ class PostgresKVStore(BaseKVStore):
5555
"""Postgres Key-Value store.
5656
5757
Args:
58-
mongo_client (Any): MongoDB client
59-
uri (Optional[str]): MongoDB URI
60-
host (Optional[str]): MongoDB host
61-
port (Optional[int]): MongoDB port
62-
db_name (Optional[str]): MongoDB database name
58+
connection_string (str): psycopg2 connection string
59+
async_connection_string (str): asyncpg connection string
60+
table_name (str): table name
61+
schema_name (Optional[str]): schema name
62+
perform_setup (Optional[bool]): perform table setup
63+
debug (Optional[bool]): debug mode
64+
use_jsonb (Optional[bool]): use JSONB data type for storage
6365
"""
6466

6567
connection_string: str

llama-index-integrations/storage/docstore/llama-index-storage-docstore-postgres/llama_index/storage/docstore/postgres/base.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@
66

77

88
class PostgresDocumentStore(KVDocumentStore):
9-
"""Mongo Document (Node) store.
9+
"""Postgres Document (Node) store.
1010
11-
A MongoDB store for Document and Node objects.
11+
A Postgres store for Document and Node objects.
1212
1313
Args:
14-
mongo_kvstore (MongoDBKVStore): MongoDB key-value store
14+
postgres_kvstore (PostgresKVStore): Postgres key-value store
1515
namespace (str): namespace for the docstore
16+
batch_size (int): batch size for bulk operations
1617
1718
"""
1819

llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-postgres/llama_index/storage/kvstore/postgres/base.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,13 @@ class PostgresKVStore(BaseKVStore):
5555
"""Postgres Key-Value store.
5656
5757
Args:
58-
mongo_client (Any): MongoDB client
59-
uri (Optional[str]): MongoDB URI
60-
host (Optional[str]): MongoDB host
61-
port (Optional[int]): MongoDB port
62-
db_name (Optional[str]): MongoDB database name
58+
connection_string (str): psycopg2 connection string
59+
async_connection_string (str): asyncpg connection string
60+
table_name (str): table name
61+
schema_name (Optional[str]): schema name
62+
perform_setup (Optional[bool]): perform table setup
63+
debug (Optional[bool]): debug mode
64+
use_jsonb (Optional[bool]): use JSONB data type for storage
6365
"""
6466

6567
connection_string: str

0 commit comments

Comments
 (0)