Skip to content
Snippets Groups Projects
Unverified Commit 2b77f897 authored by Dan Check's avatar Dan Check Committed by GitHub
Browse files

[#12713] Fix documentation for Postgres classes (#12714)

[#12713] Updating documentation for Postgres classes to remove mongodb references
parent de6f22fe
No related branches found
No related tags found
No related merge requests found
...@@ -6,13 +6,14 @@ from llama_index.core.storage.kvstore.postgres_kvstore import PostgresKVStore ...@@ -6,13 +6,14 @@ from llama_index.core.storage.kvstore.postgres_kvstore import PostgresKVStore
class PostgresDocumentStore(KVDocumentStore): 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: Args:
mongo_kvstore (MongoDBKVStore): MongoDB key-value store postgres_kvstore (PostgresKVStore): Postgres key-value store
namespace (str): namespace for the docstore namespace (str): namespace for the docstore
batch_size (int): batch size for bulk operations
""" """
......
...@@ -55,11 +55,13 @@ class PostgresKVStore(BaseKVStore): ...@@ -55,11 +55,13 @@ class PostgresKVStore(BaseKVStore):
"""Postgres Key-Value store. """Postgres Key-Value store.
Args: Args:
mongo_client (Any): MongoDB client connection_string (str): psycopg2 connection string
uri (Optional[str]): MongoDB URI async_connection_string (str): asyncpg connection string
host (Optional[str]): MongoDB host table_name (str): table name
port (Optional[int]): MongoDB port schema_name (Optional[str]): schema name
db_name (Optional[str]): MongoDB database 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 connection_string: str
......
...@@ -6,13 +6,14 @@ from llama_index.storage.kvstore.postgres import PostgresKVStore ...@@ -6,13 +6,14 @@ from llama_index.storage.kvstore.postgres import PostgresKVStore
class PostgresDocumentStore(KVDocumentStore): 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: Args:
mongo_kvstore (MongoDBKVStore): MongoDB key-value store postgres_kvstore (PostgresKVStore): Postgres key-value store
namespace (str): namespace for the docstore namespace (str): namespace for the docstore
batch_size (int): batch size for bulk operations
""" """
......
...@@ -55,11 +55,13 @@ class PostgresKVStore(BaseKVStore): ...@@ -55,11 +55,13 @@ class PostgresKVStore(BaseKVStore):
"""Postgres Key-Value store. """Postgres Key-Value store.
Args: Args:
mongo_client (Any): MongoDB client connection_string (str): psycopg2 connection string
uri (Optional[str]): MongoDB URI async_connection_string (str): asyncpg connection string
host (Optional[str]): MongoDB host table_name (str): table name
port (Optional[int]): MongoDB port schema_name (Optional[str]): schema name
db_name (Optional[str]): MongoDB database 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 connection_string: str
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment