Skip to content

Commit

Permalink
Update connect to Memgraph (#297)
Browse files Browse the repository at this point in the history
* Update connect to Memgraph

* Update link to installation guide

* Remove prerequisite
  • Loading branch information
katarinasupe authored Jan 4, 2024
1 parent eb6d690 commit 98559c8
Showing 1 changed file with 64 additions and 1 deletion.
65 changes: 64 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,70 @@ source](installation.md#source). If you are using [Conda](https://docs.conda.io/

### 2. Connect to Memgraph

Check the [Python quick start guide](https://memgraph.com/docs) to learn how to connect to Memgraph using GQLAlchemy.
**Prerequisites**

To follow this guide, you will need:

- A **running Memgraph instance**. If you need to set up Memgraph, take a look
at the [Installation guide](https://memgraph.com/docs/getting-started/install-memgraph).

**Basic setup**

We'll be using a **Python program** to demonstrate how to connect to a running
Memgraph database instance.<br />

Let's jump in and connect a simple program to Memgraph.

**1.** Create a new directory for your program, for example, `/memgraph_python`
and position yourself in it.<br />

**2.** Create a new Python script and name it `program.py` . Add the following
code to it:

```python
from gqlalchemy import Memgraph

# Make a connection to the database
memgraph = Memgraph(host='127.0.0.1', port=7687)

# Delete all nodes and relationships
query = "MATCH (n) DETACH DELETE n"

# Execute the query
memgraph.execute(query)

# Create a node with the label FirstNode and message property with the value "Hello, World!"
query = """CREATE (n:FirstNode)
SET n.message = '{message}'
RETURN 'Node ' + id(n) + ': ' + n.message AS result""".format(message="Hello, World!")

# Execute the query
results = memgraph.execute_and_fetch(query)

# Print the first member
print(list(results)[0]['result'])
```

!!! note
If the program fails to connect to a Memgraph instance that was started with Docker, you may need to use a different IP address (not the default `localhost` / `127.0.0.1` ) to connect to the instance. You can find the **`CONTAINER_ID`** with `docker ps` and use it in the following command to retrieve the address:
```
docker inspect -f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' CONTAINER_ID
```


**3.** Now, you can run the application with the following command:

```
python ./program.py
```

You should see an output similar to the following:

```
Node 1: Hello, World!
```



### 3. Learn how to use GQLAlchemy

Expand Down

0 comments on commit 98559c8

Please sign in to comment.