Skip to content

Commit 4caff7a

Browse files
authored
update class names
1 parent 4303462 commit 4caff7a

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

Async explainer.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ This foundation ensures the core database interactions are fast and scalable.
1515

1616
To cater to different application architectures while maintaining performance, we provide two classes:
1717

18-
1. **`AsyncPGVectorstore` (Core Asynchronous Implementation):**
18+
1. **`AsyncPGVectorStore` (Core Asynchronous Implementation):**
1919
* This class contains the pure `async/await` logic for all database operations using `asyncpg`.
2020
* It's designed for **direct use within asynchronous applications**. Users working in an `asyncio` environment can `await` its methods for maximum efficiency and direct control within the event loop.
2121
* It represents the fundamental, non-blocking way of interacting with the database.
2222

23-
2. **`PGVectorstore` (Synchronous Interface / Asynchronous Internals):**
23+
2. **`PGVectorStore` (Synchronous Interface / Asynchronous Internals):**
2424
* This class provides both asynchronous & synchronous APIs.
25-
* When one of its methods is called, it internally invokes the corresponding `async` method from `AsyncPGVectorstore`.
25+
* When one of its methods is called, it internally invokes the corresponding `async` method from `AsyncPGVectorStore`.
2626
* It **manages the execution of this underlying asynchronous logic**, handling the necessary `asyncio` event loop interactions (e.g., starting/running the coroutine) behind the scenes.
2727
* This allows users of synchronous codebases to leverage the performance benefits of the asynchronous core without needing to rewrite their application structure.
2828

@@ -31,8 +31,8 @@ To cater to different application architectures while maintaining performance, w
3131
This two-class structure provides significant advantages:
3232

3333
- **Interface Flexibility:** Developers can **choose the interface that best fits their needs**:
34-
* Use `PGVectorstore` for easy integration into existing synchronous applications.
35-
* Use `AsyncPGVectorstore` for optimal performance and integration within `asyncio`-based applications.
36-
- **Ease of Use:** `PGVectorstore` offers a familiar synchronous programming model, hiding the complexity of managing async execution from the end-user.
34+
* Use `PGVectorStore` for easy integration into existing synchronous applications.
35+
* Use `AsyncPGVectorStore` for optimal performance and integration within `asyncio`-based applications.
36+
- **Ease of Use:** `PGVectorStore` offers a familiar synchronous programming model, hiding the complexity of managing async execution from the end-user.
3737
- **Robustness:** The clear separation helps prevent common errors associated with mixing synchronous and asynchronous code incorrectly, such as blocking the event loop from synchronous calls within an async context.
38-
- **Efficiency for Async Users:** `AsyncPGVectorstore` provides a direct path for async applications, avoiding any potential overhead from the sync-to-async bridging layer present in `PGVectorstore`.
38+
- **Efficiency for Async Users:** `AsyncPGVectorStore` provides a direct path for async applications, avoiding any potential overhead from the sync-to-async bridging layer present in `PGVectorStore`.

0 commit comments

Comments
 (0)