-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revert "[develop < T0048-GA] Update and extend code documentation (#116…
…)" This reverts commit 58750b7.
- Loading branch information
Showing
12 changed files
with
150 additions
and
704 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
--- | ||
sidebar_label: connection | ||
title: gqlalchemy.connection | ||
--- | ||
|
||
## Connection Objects | ||
|
||
```python | ||
class Connection(ABC) | ||
``` | ||
|
||
#### execute | ||
|
||
```python | ||
@abstractmethod | ||
def execute(query: str) -> None | ||
``` | ||
|
||
Executes Cypher query without returning any results. | ||
|
||
#### execute\_and\_fetch | ||
|
||
```python | ||
@abstractmethod | ||
def execute_and_fetch(query: str) -> Iterator[Dict[str, Any]] | ||
``` | ||
|
||
Executes Cypher query and returns iterator of results. | ||
|
||
#### is\_active | ||
|
||
```python | ||
@abstractmethod | ||
def is_active() -> bool | ||
``` | ||
|
||
Returns True if connection is active and can be used | ||
|
||
#### create | ||
|
||
```python | ||
@staticmethod | ||
def create(**kwargs) -> "Connection" | ||
``` | ||
|
||
Creates an instance of a connection. | ||
|
||
## MemgraphConnection Objects | ||
|
||
```python | ||
class MemgraphConnection(Connection) | ||
``` | ||
|
||
#### execute | ||
|
||
```python | ||
def execute(query: str) -> None | ||
``` | ||
|
||
Executes Cypher query without returning any results. | ||
|
||
#### execute\_and\_fetch | ||
|
||
```python | ||
def execute_and_fetch(query: str) -> Iterator[Dict[str, Any]] | ||
``` | ||
|
||
Executes Cypher query and returns iterator of results. | ||
|
||
#### is\_active | ||
|
||
```python | ||
def is_active() -> bool | ||
``` | ||
|
||
Returns True if connection is active and can be used | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.