From 2f43ad6c81cc26cdd3c29bbc7531cf87867c8ad5 Mon Sep 17 00:00:00 2001
From: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>
Date: Wed, 10 Jul 2024 12:31:04 +0200
Subject: [PATCH] Update docs (#315)

* Update docs

* update reference guide
---
 docs/reference/gqlalchemy/connection.md       |  5 ++
 docs/reference/gqlalchemy/disk_storage.md     |  5 ++
 docs/reference/gqlalchemy/exceptions.md       |  5 ++
 .../graph_algorithms/integrated_algorithms.md |  5 ++
 .../graph_algorithms/query_builder.md         |  5 ++
 .../graph_algorithms/query_modules.md         |  5 ++
 docs/reference/gqlalchemy/instance_runner.md  |  7 +-
 docs/reference/gqlalchemy/models.md           |  5 ++
 .../query_builders/declarative_base.md        |  5 ++
 .../query_builders/memgraph_query_builder.md  |  7 +-
 .../export/graph_transporter.md               |  5 ++
 .../transformations/export/transporter.md     |  5 ++
 .../importing/graph_importer.md               |  5 ++
 .../transformations/importing/loaders.md      |  7 +-
 .../translators/dgl_translator.md             |  5 ++
 .../translators/nx_translator.md              |  5 ++
 .../translators/pyg_translator.md             |  5 ++
 .../transformations/translators/translator.md |  5 ++
 docs/reference/gqlalchemy/utilities.md        |  5 ++
 .../gqlalchemy/vendors/database_client.md     |  5 ++
 docs/reference/gqlalchemy/vendors/memgraph.md | 83 +++++++++++++++++++
 docs/reference/gqlalchemy/vendors/neo4j.md    |  5 ++
 22 files changed, 191 insertions(+), 3 deletions(-)

diff --git a/docs/reference/gqlalchemy/connection.md b/docs/reference/gqlalchemy/connection.md
index 0b690491..a2606070 100644
--- a/docs/reference/gqlalchemy/connection.md
+++ b/docs/reference/gqlalchemy/connection.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: connection
+title: gqlalchemy.connection
+---
+
 ## Connection Objects
 
 ```python
diff --git a/docs/reference/gqlalchemy/disk_storage.md b/docs/reference/gqlalchemy/disk_storage.md
index 87c4a885..16dacf5c 100644
--- a/docs/reference/gqlalchemy/disk_storage.md
+++ b/docs/reference/gqlalchemy/disk_storage.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: disk_storage
+title: gqlalchemy.disk_storage
+---
+
 ## OnDiskPropertyDatabase Objects
 
 ```python
diff --git a/docs/reference/gqlalchemy/exceptions.md b/docs/reference/gqlalchemy/exceptions.md
index 722a21e9..bf8ada6f 100644
--- a/docs/reference/gqlalchemy/exceptions.md
+++ b/docs/reference/gqlalchemy/exceptions.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: exceptions
+title: gqlalchemy.exceptions
+---
+
 #### connection\_handler
 
 ```python
diff --git a/docs/reference/gqlalchemy/graph_algorithms/integrated_algorithms.md b/docs/reference/gqlalchemy/graph_algorithms/integrated_algorithms.md
index 7fd5ec88..ad2350bd 100644
--- a/docs/reference/gqlalchemy/graph_algorithms/integrated_algorithms.md
+++ b/docs/reference/gqlalchemy/graph_algorithms/integrated_algorithms.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: integrated_algorithms
+title: gqlalchemy.graph_algorithms.integrated_algorithms
+---
+
 ## IntegratedAlgorithm Objects
 
 ```python
diff --git a/docs/reference/gqlalchemy/graph_algorithms/query_builder.md b/docs/reference/gqlalchemy/graph_algorithms/query_builder.md
index a946d6d8..4a668b6e 100644
--- a/docs/reference/gqlalchemy/graph_algorithms/query_builder.md
+++ b/docs/reference/gqlalchemy/graph_algorithms/query_builder.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: query_builder
+title: gqlalchemy.graph_algorithms.query_builder
+---
+
 ## MemgraphQueryBuilder Objects
 
 ```python
diff --git a/docs/reference/gqlalchemy/graph_algorithms/query_modules.md b/docs/reference/gqlalchemy/graph_algorithms/query_modules.md
index 8bb31560..14d4521c 100644
--- a/docs/reference/gqlalchemy/graph_algorithms/query_modules.md
+++ b/docs/reference/gqlalchemy/graph_algorithms/query_modules.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: query_modules
+title: gqlalchemy.graph_algorithms.query_modules
+---
+
 ## QueryModule Objects
 
 ```python
diff --git a/docs/reference/gqlalchemy/instance_runner.md b/docs/reference/gqlalchemy/instance_runner.md
index 3078e8f1..08e32b57 100644
--- a/docs/reference/gqlalchemy/instance_runner.md
+++ b/docs/reference/gqlalchemy/instance_runner.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: instance_runner
+title: gqlalchemy.instance_runner
+---
+
 #### wait\_for\_port
 
 ```python
@@ -27,7 +32,7 @@ Wait for a TCP port to become available.
 #### wait\_for\_docker\_container
 
 ```python
-def wait_for_docker_container(container: "docker.Container",
+def wait_for_docker_container(container,
                               delay: float = 0.01,
                               timeout: float = 5.0,
                               backoff: int = 2) -> None
diff --git a/docs/reference/gqlalchemy/models.md b/docs/reference/gqlalchemy/models.md
index 020be2c9..a2043eef 100644
--- a/docs/reference/gqlalchemy/models.md
+++ b/docs/reference/gqlalchemy/models.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: models
+title: gqlalchemy.models
+---
+
 ## TriggerEventType Objects
 
 ```python
diff --git a/docs/reference/gqlalchemy/query_builders/declarative_base.md b/docs/reference/gqlalchemy/query_builders/declarative_base.md
index ef291835..cb222e5d 100644
--- a/docs/reference/gqlalchemy/query_builders/declarative_base.md
+++ b/docs/reference/gqlalchemy/query_builders/declarative_base.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: declarative_base
+title: gqlalchemy.query_builders.declarative_base
+---
+
 ## WhereConditionPartialQuery Objects
 
 ```python
diff --git a/docs/reference/gqlalchemy/query_builders/memgraph_query_builder.md b/docs/reference/gqlalchemy/query_builders/memgraph_query_builder.md
index 5a67f1cb..c9ae1852 100644
--- a/docs/reference/gqlalchemy/query_builders/memgraph_query_builder.md
+++ b/docs/reference/gqlalchemy/query_builders/memgraph_query_builder.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: memgraph_query_builder
+title: gqlalchemy.query_builders.memgraph_query_builder
+---
+
 ## QueryBuilder Objects
 
 ```python
@@ -14,7 +19,7 @@ Load data from a CSV file by executing a Cypher query for each row.
 
 **Arguments**:
 
-- `path` - A string representing the path to the CSV file.
+- `path` - A string representing the path to the CSV file. If beginning with `http://`, `https://`, or `ftp://`, the CSV file will be fetched over the network.
 - `header` - A bool indicating if the CSV file starts with a header row.
 - `row` - A string representing the name of the variable for iterating
   over each row.
diff --git a/docs/reference/gqlalchemy/transformations/export/graph_transporter.md b/docs/reference/gqlalchemy/transformations/export/graph_transporter.md
index 1dd40df1..7955690d 100644
--- a/docs/reference/gqlalchemy/transformations/export/graph_transporter.md
+++ b/docs/reference/gqlalchemy/transformations/export/graph_transporter.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: graph_transporter
+title: gqlalchemy.transformations.export.graph_transporter
+---
+
 ## GraphTransporter Objects
 
 ```python
diff --git a/docs/reference/gqlalchemy/transformations/export/transporter.md b/docs/reference/gqlalchemy/transformations/export/transporter.md
index 228a2ac6..a3e33688 100644
--- a/docs/reference/gqlalchemy/transformations/export/transporter.md
+++ b/docs/reference/gqlalchemy/transformations/export/transporter.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: transporter
+title: gqlalchemy.transformations.export.transporter
+---
+
 ## Transporter Objects
 
 ```python
diff --git a/docs/reference/gqlalchemy/transformations/importing/graph_importer.md b/docs/reference/gqlalchemy/transformations/importing/graph_importer.md
index 0a9edaed..74eceedb 100644
--- a/docs/reference/gqlalchemy/transformations/importing/graph_importer.md
+++ b/docs/reference/gqlalchemy/transformations/importing/graph_importer.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: graph_importer
+title: gqlalchemy.transformations.importing.graph_importer
+---
+
 ## GraphImporter Objects
 
 ```python
diff --git a/docs/reference/gqlalchemy/transformations/importing/loaders.md b/docs/reference/gqlalchemy/transformations/importing/loaders.md
index afb2262b..8aaab696 100644
--- a/docs/reference/gqlalchemy/transformations/importing/loaders.md
+++ b/docs/reference/gqlalchemy/transformations/importing/loaders.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: loaders
+title: gqlalchemy.transformations.importing.loaders
+---
+
 ## ForeignKeyMapping Objects
 
 ```python
@@ -43,7 +48,7 @@ Many to many mapping is intended to be used in case of associative tables.
 - `foreign_key_from` - Describes the source of the relationship.
 - `foreign_key_to` - Describes the destination of the relationship.
 - `label` - Label to be applied to the newly created relationship.
-- `properties` - List of properties that will be added to the relationship created from this object (Optional).
+- `properties` - Properties that will be added to the relationship created from this object (Optional).
 
 ## TableMapping Objects
 
diff --git a/docs/reference/gqlalchemy/transformations/translators/dgl_translator.md b/docs/reference/gqlalchemy/transformations/translators/dgl_translator.md
index 42bfc91f..0c7a2fc1 100644
--- a/docs/reference/gqlalchemy/transformations/translators/dgl_translator.md
+++ b/docs/reference/gqlalchemy/transformations/translators/dgl_translator.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: dgl_translator
+title: gqlalchemy.transformations.translators.dgl_translator
+---
+
 ## DGLTranslator Objects
 
 ```python
diff --git a/docs/reference/gqlalchemy/transformations/translators/nx_translator.md b/docs/reference/gqlalchemy/transformations/translators/nx_translator.md
index 462f48db..6c4afc06 100644
--- a/docs/reference/gqlalchemy/transformations/translators/nx_translator.md
+++ b/docs/reference/gqlalchemy/transformations/translators/nx_translator.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: nx_translator
+title: gqlalchemy.transformations.translators.nx_translator
+---
+
 ## NetworkXCypherBuilder Objects
 
 ```python
diff --git a/docs/reference/gqlalchemy/transformations/translators/pyg_translator.md b/docs/reference/gqlalchemy/transformations/translators/pyg_translator.md
index e6e16d8f..78b82c5d 100644
--- a/docs/reference/gqlalchemy/transformations/translators/pyg_translator.md
+++ b/docs/reference/gqlalchemy/transformations/translators/pyg_translator.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: pyg_translator
+title: gqlalchemy.transformations.translators.pyg_translator
+---
+
 ## PyGTranslator Objects
 
 ```python
diff --git a/docs/reference/gqlalchemy/transformations/translators/translator.md b/docs/reference/gqlalchemy/transformations/translators/translator.md
index e36f8a23..233a530e 100644
--- a/docs/reference/gqlalchemy/transformations/translators/translator.md
+++ b/docs/reference/gqlalchemy/transformations/translators/translator.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: translator
+title: gqlalchemy.transformations.translators.translator
+---
+
 ## Translator Objects
 
 ```python
diff --git a/docs/reference/gqlalchemy/utilities.md b/docs/reference/gqlalchemy/utilities.md
index 58776e7f..e522d67b 100644
--- a/docs/reference/gqlalchemy/utilities.md
+++ b/docs/reference/gqlalchemy/utilities.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: utilities
+title: gqlalchemy.utilities
+---
+
 #### to\_cypher\_value
 
 ```python
diff --git a/docs/reference/gqlalchemy/vendors/database_client.md b/docs/reference/gqlalchemy/vendors/database_client.md
index 5286737c..eab44496 100644
--- a/docs/reference/gqlalchemy/vendors/database_client.md
+++ b/docs/reference/gqlalchemy/vendors/database_client.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: database_client
+title: gqlalchemy.vendors.database_client
+---
+
 ## DatabaseClient Objects
 
 ```python
diff --git a/docs/reference/gqlalchemy/vendors/memgraph.md b/docs/reference/gqlalchemy/vendors/memgraph.md
index 4ebde5d8..100c67dd 100644
--- a/docs/reference/gqlalchemy/vendors/memgraph.md
+++ b/docs/reference/gqlalchemy/vendors/memgraph.md
@@ -1,3 +1,41 @@
+---
+sidebar_label: memgraph
+title: gqlalchemy.vendors.memgraph
+---
+
+#### create\_transaction
+
+```python
+def create_transaction(transaction_data) -> MemgraphTransaction
+```
+
+Create a MemgraphTransaction object from transaction data.
+
+**Arguments**:
+
+- `transaction_data` _dict_ - A dictionary containing transaction data.
+
+**Returns**:
+
+- `MemgraphTransaction` - A MemgraphTransaction object.
+
+#### create\_terminated\_transaction
+
+```python
+def create_terminated_transaction(
+        transaction_data) -> MemgraphTerminatedTransaction
+```
+
+Create a MemgraphTerminatedTransaction object from transaction data.
+
+**Arguments**:
+
+- `transaction_data` _dict_ - A dictionary containing transaction data.
+
+**Returns**:
+
+- `MemgraphTerminatedTransaction` - A MemgraphTerminatedTransaction object.
+
 ## Memgraph Objects
 
 ```python
@@ -241,3 +279,48 @@ Load power_bi stream query module.
 
 - `Memgraph` - Memgraph instance
 
+#### get\_storage\_mode
+
+```python
+def get_storage_mode() -> str
+```
+
+Returns the storage mode of the Memgraph instance.
+
+#### set\_storage\_mode
+
+```python
+def set_storage_mode(storage_mode: MemgraphStorageMode) -> None
+```
+
+Sets the storage mode of the Memgraph instance.
+
+#### get\_transactions
+
+```python
+def get_transactions() -> List[MemgraphTransaction]
+```
+
+Get all transactions in the database.
+
+**Returns**:
+
+- `List[MemgraphTransaction]` - A list of MemgraphTransaction objects.
+
+#### terminate\_transactions
+
+```python
+def terminate_transactions(
+        transaction_ids: List[str]) -> List[MemgraphTerminatedTransaction]
+```
+
+Terminate transactions in the database.
+
+**Arguments**:
+
+- `transaction_ids` _List[str]_ - A list of transaction ids to terminate.
+
+**Returns**:
+
+- `List[MemgraphTerminatedTransaction]` - A list of MemgraphTerminatedTransaction objects with info on their status.
+
diff --git a/docs/reference/gqlalchemy/vendors/neo4j.md b/docs/reference/gqlalchemy/vendors/neo4j.md
index f4720333..7fe42802 100644
--- a/docs/reference/gqlalchemy/vendors/neo4j.md
+++ b/docs/reference/gqlalchemy/vendors/neo4j.md
@@ -1,3 +1,8 @@
+---
+sidebar_label: neo4j
+title: gqlalchemy.vendors.neo4j
+---
+
 ## Neo4j Objects
 
 ```python