Skip to content

Commit 4eeceab

Browse files
authored
Revise README for Python driver updates (#2298)
Updated README to from psycopg2 to psycopg3 (psycopg)
1 parent dd6deb7 commit 4eeceab

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

drivers/python/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ AGType parser and driver support for [Apache AGE](https://age.apache.org/), grap
2828

2929
### Features
3030
* Unmarshal AGE result data(AGType) to Vertex, Edge, Path
31-
* Cypher query support for Psycopg2 PostgreSQL driver (enables to use cypher queries directly)
31+
* Cypher query support for Psycopg3 PostgreSQL driver (enables to use cypher queries directly)
3232

3333
### Prerequisites
3434
* over Python 3.9
35-
* This module runs on [psycopg2](https://www.psycopg.org/) and [antlr4-python3](https://pypi.org/project/antlr4-python3-runtime/)
35+
* This module runs on [psycopg3](https://www.psycopg.org/) and [antlr4-python3](https://pypi.org/project/antlr4-python3-runtime/)
3636
```
3737
sudo apt-get update
3838
sudo apt-get install python3-dev libpq-dev
@@ -80,7 +80,7 @@ SET search_path = ag_catalog, "$user", public;
8080
```
8181

8282
### Usage
83-
* If you are not familiar with Psycopg2 driver : Go to [Jupyter Notebook : Basic Sample](samples/apache-age-basic.ipynb)
83+
* If you are not familiar with Psycopg driver : Go to [Jupyter Notebook : Basic Sample](samples/apache-age-basic.ipynb)
8484
* Simpler way to access Apache AGE [AGE Sample](samples/apache-age-note.ipynb) in Samples.
8585
* Agtype converting samples: [Agtype Sample](samples/apache-age-agtypes.ipynb) in Samples.
8686

@@ -119,7 +119,7 @@ Here the following value required
119119
Insert From networkx directed graph into an AGE database.
120120
#### Parameters
121121

122-
- `connection` (psycopg2.connect): Connection object to the AGE database.
122+
- `connection` (psycopg.connect): Connection object to the AGE database.
123123

124124
- `G` (networkx.DiGraph): Networkx directed graph to be converted and inserted.
125125

@@ -152,7 +152,7 @@ Converts data from a Apache AGE graph database into a Networkx directed graph.
152152

153153
#### Parameters
154154

155-
- `connection` (psycopg2.connect): Connection object to the PostgreSQL database.
155+
- `connection` (psycopg.connect): Connection object to the PostgreSQL database.
156156
- `graphName` (str): Name of the graph.
157157
- `G` (None | nx.DiGraph): Optional Networkx directed graph. If provided, the data will be added to this graph.
158158
- `query` (str | None): Optional Cypher query to retrieve data from the database.
@@ -167,3 +167,4 @@ Converts data from a Apache AGE graph database into a Networkx directed graph.
167167
# Call the function to convert data into a Networkx graph
168168
graph = age_to_networkx(connection, graphName="MyGraph" )
169169
```
170+

0 commit comments

Comments
 (0)