Skip to content

Commit

Permalink
Update docs (#315)
Browse files Browse the repository at this point in the history
* Update docs

* update reference guide
  • Loading branch information
katarinasupe authored Jul 10, 2024
1 parent 2b8e32a commit 2f43ad6
Show file tree
Hide file tree
Showing 22 changed files with 191 additions and 3 deletions.
5 changes: 5 additions & 0 deletions docs/reference/gqlalchemy/connection.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: connection
title: gqlalchemy.connection
---

## Connection Objects

```python
Expand Down
5 changes: 5 additions & 0 deletions docs/reference/gqlalchemy/disk_storage.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: disk_storage
title: gqlalchemy.disk_storage
---

## OnDiskPropertyDatabase Objects

```python
Expand Down
5 changes: 5 additions & 0 deletions docs/reference/gqlalchemy/exceptions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: exceptions
title: gqlalchemy.exceptions
---

#### connection\_handler

```python
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: integrated_algorithms
title: gqlalchemy.graph_algorithms.integrated_algorithms
---

## IntegratedAlgorithm Objects

```python
Expand Down
5 changes: 5 additions & 0 deletions docs/reference/gqlalchemy/graph_algorithms/query_builder.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: query_builder
title: gqlalchemy.graph_algorithms.query_builder
---

## MemgraphQueryBuilder Objects

```python
Expand Down
5 changes: 5 additions & 0 deletions docs/reference/gqlalchemy/graph_algorithms/query_modules.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: query_modules
title: gqlalchemy.graph_algorithms.query_modules
---

## QueryModule Objects

```python
Expand Down
7 changes: 6 additions & 1 deletion docs/reference/gqlalchemy/instance_runner.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: instance_runner
title: gqlalchemy.instance_runner
---

#### wait\_for\_port

```python
Expand Down Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions docs/reference/gqlalchemy/models.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: models
title: gqlalchemy.models
---

## TriggerEventType Objects

```python
Expand Down
5 changes: 5 additions & 0 deletions docs/reference/gqlalchemy/query_builders/declarative_base.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: declarative_base
title: gqlalchemy.query_builders.declarative_base
---

## WhereConditionPartialQuery Objects

```python
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: memgraph_query_builder
title: gqlalchemy.query_builders.memgraph_query_builder
---

## QueryBuilder Objects

```python
Expand All @@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: graph_transporter
title: gqlalchemy.transformations.export.graph_transporter
---

## GraphTransporter Objects

```python
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: transporter
title: gqlalchemy.transformations.export.transporter
---

## Transporter Objects

```python
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: graph_importer
title: gqlalchemy.transformations.importing.graph_importer
---

## GraphImporter Objects

```python
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: loaders
title: gqlalchemy.transformations.importing.loaders
---

## ForeignKeyMapping Objects

```python
Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: dgl_translator
title: gqlalchemy.transformations.translators.dgl_translator
---

## DGLTranslator Objects

```python
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: nx_translator
title: gqlalchemy.transformations.translators.nx_translator
---

## NetworkXCypherBuilder Objects

```python
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: pyg_translator
title: gqlalchemy.transformations.translators.pyg_translator
---

## PyGTranslator Objects

```python
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: translator
title: gqlalchemy.transformations.translators.translator
---

## Translator Objects

```python
Expand Down
5 changes: 5 additions & 0 deletions docs/reference/gqlalchemy/utilities.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: utilities
title: gqlalchemy.utilities
---

#### to\_cypher\_value

```python
Expand Down
5 changes: 5 additions & 0 deletions docs/reference/gqlalchemy/vendors/database_client.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: database_client
title: gqlalchemy.vendors.database_client
---

## DatabaseClient Objects

```python
Expand Down
83 changes: 83 additions & 0 deletions docs/reference/gqlalchemy/vendors/memgraph.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.

5 changes: 5 additions & 0 deletions docs/reference/gqlalchemy/vendors/neo4j.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: neo4j
title: gqlalchemy.vendors.neo4j
---

## Neo4j Objects

```python
Expand Down

0 comments on commit 2f43ad6

Please sign in to comment.