You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-7Lines changed: 12 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,10 @@
1
-
# pgcachewatch
2
-
pgcachewatch is a Python library crafted to empower applications with real-time PostgreSQL event notifications for efficient cache invalidation, directly leveraging existing PostgreSQL infrastructure. This approach eliminates the need for additional technologies for cache management, simplifying your stack while enhancing performance and real-time data consistency.
PGCacheWatch is a Python library crafted to empower applications with real-time PostgreSQL event notifications for efficient cache invalidation, directly leveraging existing PostgreSQL infrastructure. This approach eliminates the need for additional technologies for cache management, simplifying your stack while enhancing performance and real-time data consistency.
3
8
4
9
## Key Advantages
5
10
-**Leverage Existing Infrastructure**: Utilizes PostgreSQL's native NOTIFY/LISTEN capabilities for event-driven cache invalidation, avoiding the overhead of integrating external caching systems.
@@ -8,20 +13,20 @@ pgcachewatch is a Python library crafted to empower applications with real-time
8
13
-**Simple Yet Powerful API**: Designed with simplicity in mind, offering a straightforward setup process and an intuitive API for managing cache invalidation logic.
9
14
10
15
## Installation
11
-
To install pgcachewatch, run the following command in your terminal:
16
+
To install PGCacheWatch, run the following command in your terminal:
12
17
```bash
13
18
pip install pgcachewatch
14
19
```
15
20
16
-
## Using pgcachewatch
21
+
## Using PGCacheWatch
17
22
### Setting Up
18
-
Initialize PostgreSQL triggers to emit NOTIFY events on data changes. pgcachewatch provides utility scripts for easy trigger setup
23
+
Initialize PostgreSQL triggers to emit NOTIFY events on data changes. PGCacheWatch provides utility scripts for easy trigger setup
19
24
```bash
20
-
pgcachewatch install --tables your_table_names
25
+
pgcachewatch install <tables-to-cache>
21
26
```
22
27
23
28
### FastAPI Example
24
-
Example showing how to use pgcachewatch for cache invalidation in a FastAPI app
29
+
Example showing how to use PGCacheWatch for cache invalidation in a FastAPI app
0 commit comments