Skip to content

Commit

Permalink
Update internal links
Browse files Browse the repository at this point in the history
  • Loading branch information
kgolubic committed Aug 31, 2023
1 parent 5458ab4 commit 2e6b50b
Show file tree
Hide file tree
Showing 12 changed files with 33 additions and 29 deletions.
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ With the help of the [How-to guides](how-to-guides/overview.md) you can learn ho

### 3. Check the reference guide

Don't forget to check the [Reference guide](/gqlalchemy/reference) if you want to find out which methods GQLAlchemy has and how to use it. If the reference guide is not clear enough, head over to the [GQLAlchemy repository](https://github.com/memgraph/gqlalchemy) and inspect the source code. While you're there, feel free to give us a star or contribute to this open-source Python library.
Don't forget to check the [Reference guide](reference/gqlalchemy/overview.md) if you want to find out which methods GQLAlchemy has and how to use it. If the reference guide is not clear enough, head over to the [GQLAlchemy repository](https://github.com/memgraph/gqlalchemy) and inspect the source code. While you're there, feel free to give us a star or contribute to this open-source Python library.
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ data is located, here are two guides on how to import it to Memgraph:
```

!!! info
The features below aren’t included in the default GQLAlchemy installation. To use them, make sure to [install GQLAlchemy](/gqlalchemy/installation) with the relevant optional dependencies.
The features below aren’t included in the default GQLAlchemy installation. To use them, make sure to [install GQLAlchemy](../../installation.md) with the relevant optional dependencies.

## Loading a CSV file from the local file system

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> To learn how to import table data from a file to the Memgraph database, head
> over to the [How to import table
> data](/how-to-guides/loaders/import-table-data-to-graph-database.md) guide.
> data](import-table-data-to-graph-database.md) guide.
If you want to read from a file system not currently supported by
**GQLAlchemy**, or use a file type currently not readable, you can implement
Expand All @@ -17,7 +17,7 @@ respectively.
```

!!! info
The features below aren’t included in the default GQLAlchemy installation. To use them, make sure to [install GQLAlchemy](/gqlalchemy/installation) with the relevant optional dependencies.
The features below aren’t included in the default GQLAlchemy installation. To use them, make sure to [install GQLAlchemy](../../installation.md) with the relevant optional dependencies.

## Implementing a new `FileSystemHandler`

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-guides/ogm.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Through this guide, you will learn how to use GQLAlchemy object graph mapper to:
>have any more questions, join our community and ping us on [Discord](https://discord.gg/memgraph).
!!! info
To test the above features, you must [install GQLAlchemy](/gqlalchemy/installation) and have a running Memgraph instance. If you're unsure how to run Memgraph, check out the Memgraph [Quick start](https://memgraph.com/docs/getting-started)).
To test the above features, you must [install GQLAlchemy](../installation.md) and have a running Memgraph instance. If you're unsure how to run Memgraph, check out the Memgraph [Quick start](https://memgraph.com/docs/getting-started)).

## Map nodes and relationships

Expand Down
4 changes: 2 additions & 2 deletions docs/how-to-guides/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ the following guides:
## Import data from different sources

!!! info
The features below aren’t included in the default GQLAlchemy installation. To use them, make sure to [install GQLAlchemy](/gqlalchemy/installation) with the relevant optional dependencies.
The features below aren’t included in the default GQLAlchemy installation. To use them, make sure to [install GQLAlchemy](../installation.md) with the relevant optional dependencies.


You can translate table data from a file to graph data and import it to
Expand Down Expand Up @@ -73,7 +73,7 @@ As subgraphs are mainly used with Memgraph's query modules (graph algorithms),
QueryBuilder's `call()` method enables specifying the subgraph to use with a
certain algorithm.

- [**Create a graph projection**](/gqlalchemy/how-to-guides/query-builder/graph-projection)
- [**Create a graph projection**](query-builder/graph-projection.md)

## Transform Python graphs into Memgraph graphs

Expand Down
20 changes: 10 additions & 10 deletions docs/how-to-guides/query-builder.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@ Through this guide, you will learn how to use GQLAlchemy query builder to:
>have any more questions, join our community and ping us on [Discord](https://discord.gg/memgraph).
!!! info
To test the above features, you must install [GQLAlchemy](/gqlalchemy/installation) and have a running Memgraph instance. If you're unsure how to run Memgraph, check out the Memgraph [Quick start](https://memgraph.com/docs/getting-started)).
To test the above features, you must install [GQLAlchemy](../installation.md) and have a running Memgraph instance. If you're unsure how to run Memgraph, check out the Memgraph [Quick start](https://memgraph.com/docs/getting-started)).


## Create nodes and relationships

Methods [`create()`](/gqlalchemy/reference/query_builders/declarative_base#create), [`merge()`](/gqlalchemy/reference/query_builders/declarative_base#merge), [`match()`](/gqlalchemy/reference/query_builders/declarative_base#match), [`node()`](/gqlalchemy/reference/query_builders/declarative_base#node), [`to()`](/gqlalchemy/reference/query_builders/declarative_base#to) and [`from_()`](/gqlalchemy/reference/query_builders/declarative_base#from_) are most often used when building a query to create or merge nodes and relationships.
Methods [`create()`](../reference/gqlalchemy/query_builders/declarative_base.md#create), [`merge()`](../reference/gqlalchemy/query_builders/declarative_base.md#merge), [`match()`](../reference/gqlalchemy/query_builders/declarative_base.md#match), [`node()`](../reference/gqlalchemy/query_builders/declarative_base.md#node), [`to()`](../reference/gqlalchemy/query_builders/declarative_base.md#to) and [`from_()`](../reference/gqlalchemy/query_builders/declarative_base.md#from_) are most often used when building a query to create or merge nodes and relationships.

### Create a node

Expand Down Expand Up @@ -254,7 +254,7 @@ Read more about `MERGE` clause in the [Cypher manual](/docs/cypher-manual/clause

## Set or update properties and labels

The [`set_()`](/gqlalchemy/reference/query_builders/declarative_base#set_) method is used to set labels on nodes, and properties on nodes and relationships. When being set, labels and properties can be updated or created, depending on the operator used as the argument of `set_()` method.
The [`set_()`](../reference/gqlalchemy/query_builders/declarative_base.md#set_) method is used to set labels on nodes, and properties on nodes and relationships. When being set, labels and properties can be updated or created, depending on the operator used as the argument of `set_()` method.

### Set a property

Expand Down Expand Up @@ -483,9 +483,9 @@ All the properties in the map (value of the `literal` argument) that are on a gr

## Filter data

You can use the methods [`where()`](/gqlalchemy/reference/query_builders/declarative_base#where), [`where_not()`](/gqlalchemy/reference/query_builders/declarative_base#where_not), [`or_where()`](/gqlalchemy/reference/query_builders/declarative_base#or_where),
[`or_where_not()`](/gqlalchemy/reference/query_builders/declarative_base#or_where_node), [`and_where()`](/gqlalchemy/reference/query_builders/declarative_base#and_where), [`and_where_not()`](/gqlalchemy/reference/query_builders/declarative_base#and_where_not), [`xor_where()`](/gqlalchemy/reference/query_builders/declarative_base#xor_where) and
[`xor_where_not()`](/gqlalchemy/reference/query_builders/declarative_base#xor_where_not) to construct queries that will filter data.
You can use the methods [`where()`](../reference/gqlalchemy/query_builders/declarative_base.md#where), [`where_not()`](../reference/gqlalchemy/query_builders/declarative_base.md#where_not), [`or_where()`](../reference/gqlalchemy/query_builders/declarative_base.md#or_where),
[`or_where_not()`](../reference/gqlalchemy/query_builders/declarative_base.md#or_where_node), [`and_where()`](../reference/gqlalchemy/query_builders/declarative_base.md#and_where), [`and_where_not()`](../reference/gqlalchemy/query_builders/declarative_base.md#and_where_not), [`xor_where()`](../reference/gqlalchemy/query_builders/declarative_base.md#xor_where) and
[`xor_where_not()`](../reference/gqlalchemy/query_builders/declarative_base.md#xor_where_not) to construct queries that will filter data.



Expand Down Expand Up @@ -531,7 +531,7 @@ MATCH (p1:Person)-[:FRIENDS_WITH]->(p2:Person) WHERE p1.name < p2.name RETURN *;
Keyword arguments that can be used in filtering methods are `literal` and `expression`. Usually we use `literal` for property values and `expression` for property names and labels. That is because property names and labels shouldn't be quoted in Cypher statements.

!!! info
You will probably see the `GQLAlchemySubclassNotFoundWarning` warning. This happens if you did not define a Python class which maps to a graph object in the database. To do that, check the [object graph mapper how-to guide](/gqlalchemy/how-to-guides/ogm). To ignore such warnings, you can do the following before query execution:
You will probably see the `GQLAlchemySubclassNotFoundWarning` warning. This happens if you did not define a Python class which maps to a graph object in the database. To do that, check the [object graph mapper how-to guide](ogm.md). To ignore such warnings, you can do the following before query execution:

```python
from gqlalchemy import models
Expand Down Expand Up @@ -750,7 +750,7 @@ Just like in [property comparison](#filter-data-by-property-comparison), it is p

## Return results

You can use the methods [`return_()`](/gqlalchemy/reference/query_builders/declarative_base#return_), [`limit()`](/gqlalchemy/reference/query_builders/declarative_base#limit), [`skip()`](/gqlalchemy/reference/query_builders/declarative_base#skip) and [`order_by()`](/gqlalchemy/reference/query_builders/declarative_base#order_by) to
You can use the methods [`return_()`](../reference/gqlalchemy/query_builders/declarative_base.md#return_), [`limit()`](../reference/gqlalchemy/query_builders/declarative_base.md#limit), [`skip()`](../reference/gqlalchemy/query_builders/declarative_base.md#skip) and [`order_by()`](../reference/gqlalchemy/query_builders/declarative_base.md#order_by) to
construct queries that will return data from the database.

### Return all variables from a query
Expand Down Expand Up @@ -1066,7 +1066,7 @@ ORDER BY n.id ASC, n.name, n.last_name DESC, n.age ASCENDING, n.middle_name DESC

## Delete and remove objects

You can use the methods [`delete()`](/gqlalchemy/reference/query_builders/declarative_base#delete) and [`remove()`](/gqlalchemy/reference/query_builders/declarative_base#remove) to construct queries that will
You can use the methods [`delete()`](../reference/gqlalchemy/query_builders/declarative_base.md#delete) and [`remove()`](../reference/gqlalchemy/query_builders/declarative_base.md#remove) to construct queries that will
remove nodes and relationships or properties and labels.

### Delete a node
Expand Down Expand Up @@ -1162,7 +1162,7 @@ MATCH (p:Person {name: 'Jane'}) REMOVE p.name, p.last_name;

## Call procedures

You can use the methods [`call()`](/gqlalchemy/reference/query_builders/declarative_base#call) and [`yield_()`](/gqlalchemy/reference/query_builders/declarative_base#yield_) to construct queries that will
You can use the methods [`call()`](../reference/gqlalchemy/query_builders/declarative_base.md#call) and [`yield_()`](../reference/gqlalchemy/query_builders/declarative_base.md#yield_) to construct queries that will
call procedure and return results from them.

### Call procedure with no arguments
Expand Down
4 changes: 2 additions & 2 deletions docs/how-to-guides/translators/export-python-graphs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ GQLAlchemy holds translators that can export Memgraph graphs into Python graphs
[![docs-source](https://img.shields.io/badge/source-examples-FB6E00?logo=github&style=for-the-badge)](https://github.com/memgraph/gqlalchemy/tree/main/tests/transformations/translators)
[![docs-source](https://img.shields.io/badge/source-translators-FB6E00?logo=github&style=for-the-badge)](https://github.com/memgraph/gqlalchemy/tree/main/gqlalchemy/transformations/translators)
[![Related - Under the
hood](https://img.shields.io/static/v1?label=Related&message=Under%20the%20hood&color=orange&style=for-the-badge)](/under-the-hood/python-graph-translators.md)
hood](https://img.shields.io/static/v1?label=Related&message=Under%20the%20hood&color=orange&style=for-the-badge)](../../under-the-hood/python-graph-translators.md)

In this guide you will learn how to:
- [**Export data from Memgraph into NetworkX graph**](#export-data-from-memgraph-into-networkx-graph)
Expand Down Expand Up @@ -189,4 +189,4 @@ This means that the DGL graph has the correct number of node and edge types, tot

## Learn more

Head over to the [**Under the hood**](/gqlalchemy/under-the-hood/python-graph-translators) section to read about implementation details. If you want to learn more about using NetworkX with Memgraph with interesting resources and courses, head over to the [**Memgraph for NetworkX developers**](https://memgraph.com/memgraph-for-networkx?utm_source=docs&utm_medium=referral&utm_campaign=networkx_ppp&utm_term=docsgqla%2Bhowto&utm_content=textlink) website. If you have any questions or want to connect with the Memgraph community, [**join our Discord server**](https://www.discord.gg/memgraph).
Head over to the [**Under the hood**](../../under-the-hood/python-graph-translators.md) section to read about implementation details. If you want to learn more about using NetworkX with Memgraph with interesting resources and courses, head over to the [**Memgraph for NetworkX developers**](https://memgraph.com/memgraph-for-networkx?utm_source=docs&utm_medium=referral&utm_campaign=networkx_ppp&utm_term=docsgqla%2Bhowto&utm_content=textlink) website. If you have any questions or want to connect with the Memgraph community, [**join our Discord server**](https://www.discord.gg/memgraph).
4 changes: 2 additions & 2 deletions docs/how-to-guides/translators/import-python-graphs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ GQLAlchemy holds translators that can import Python graphs ([NetworkX](https://n
[![docs-source](https://img.shields.io/badge/source-examples-FB6E00?logo=github&style=for-the-badge)](https://github.com/memgraph/gqlalchemy/tree/main/tests/transformations/translators)
[![docs-source](https://img.shields.io/badge/source-translators-FB6E00?logo=github&style=for-the-badge)](https://github.com/memgraph/gqlalchemy/tree/main/gqlalchemy/transformations/translators)
[![Related - Under the
hood](https://img.shields.io/static/v1?label=Related&message=Under%20the%20hood&color=orange&style=for-the-badge)](/under-the-hood/python-graph-translators.md)
hood](https://img.shields.io/static/v1?label=Related&message=Under%20the%20hood&color=orange&style=for-the-badge)](../../under-the-hood/python-graph-translators.md)

In this guide you will learn how to:
- [**Import NetworkX graph into Memgraph**](#import-networkx-graph-into-memgraph)
Expand Down Expand Up @@ -208,4 +208,4 @@ You can notice that we have nodes labeled with `user` and `movie` and relationsh

## Learn more

Head over to the [**Under the hood**](/gqlalchemy/under-the-hood/python-graph-translators) section to read about implementation details. If you want to learn more about using NetworkX with Memgraph with interesting resources and courses, head over to the [**Memgraph for NetworkX developers**](https://memgraph.com/memgraph-for-networkx?utm_source=docs&utm_medium=referral&utm_campaign=networkx_ppp&utm_term=docsgqla%2Bhowto&utm_content=textlink) website. If you have any questions or want to connect with the Memgraph community, [**join our Discord server**](https://www.discord.gg/memgraph).
Head over to the [**Under the hood**](../../under-the-hood/python-graph-translators.md) section to read about implementation details. If you want to learn more about using NetworkX with Memgraph with interesting resources and courses, head over to the [**Memgraph for NetworkX developers**](https://memgraph.com/memgraph-for-networkx?utm_source=docs&utm_medium=referral&utm_campaign=networkx_ppp&utm_term=docsgqla%2Bhowto&utm_content=textlink) website. If you have any questions or want to connect with the Memgraph community, [**join our Discord server**](https://www.discord.gg/memgraph).
12 changes: 6 additions & 6 deletions docs/import-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Besides that, you can create data directly from code using the [**object graph m

## CSV

To import CSV file into Memgraph via GQLAlchemy, you can use the [`LOAD CSV` clause](/memgraph/import-data/load-csv-clause). That clause can be used by [executing the Cypher query](/memgraph/connect-to-memgraph/drivers/python) or by [building the query with the query builder](how-to-guides/query-builder.md#load-csv-file). Another way of importing CSV data into Memgraph is by [translating it into a graph](/gqlalchemy/how-to-guides/table-to-graph-importer).
To import CSV file into Memgraph via GQLAlchemy, you can use the [`LOAD CSV` clause](/memgraph/import-data/load-csv-clause). That clause can be used by [executing the Cypher query](/memgraph/connect-to-memgraph/drivers/python) or by [building the query with the query builder](how-to-guides/query-builder.md#load-csv-file). Another way of importing CSV data into Memgraph is by [translating it into a graph](how-to-guides/loaders/import-table-data-to-graph-database.md).

## JSON

Expand All @@ -24,22 +24,22 @@ To import JSON files into Memgraph via GQLAlchemy, you can call procedures from

## Parquet, ORC or IPC/Feather/Arrow

To import Parquet, ORC or IPC/Feather/Arrow file into Memgraph via GQLAlchemy, [transform table data from a file into a graph](/gqlalchemy/how-to-guides/table-to-graph-importer).
To import Parquet, ORC or IPC/Feather/Arrow file into Memgraph via GQLAlchemy, [transform table data from a file into a graph](how-to-guides/loaders/import-table-data-to-graph-database.md).

!!! note
If you want to read from a file system not currently supported by GQLAlchemy, or use a file type currently not readable, you can implement your own by [making a custom file system importer](/gqlalchemy/how-to-guides/custom-file-system-importer).
If you want to read from a file system not currently supported by GQLAlchemy, or use a file type currently not readable, you can implement your own by [making a custom file system importer](how-to-guides/loaders/make-a-custom-file-system-importer.md).

## Python graphs - NetworkX, PyG or DGL graph

To import NetworkX, PyG or DGL graph into Memgraph via GQLAlchemy, [transform the source graph into Memgraph graph](/gqlalchemy/how-to-guides/import-python-graphs).
To import NetworkX, PyG or DGL graph into Memgraph via GQLAlchemy, [transform the source graph into Memgraph graph](how-to-guides/translators/import-python-graphs.md).

## Kafka, RedPanda or Pulsar data stream

To consume Kafka, RedPanda or Pulsar data stream, you can write a [appropriate Cypher queries](/memgraph/import-data/data-streams/manage-streams) and [execute](/memgraph/connect-to-memgraph/drivers/python) them, or use GQLAlchemy stream manager for [Kafka, RedPanda](/gqlalchemy/how-to-guides/streams/manage-kafka-streams) or [Pulsar](/gqlalchemy/how-to-guides/streams/manage-pulsar-streams) streams.
To consume Kafka, RedPanda or Pulsar data stream, you can write a [appropriate Cypher queries](/memgraph/import-data/data-streams/manage-streams) and [execute](/memgraph/connect-to-memgraph/drivers/python) them, or use GQLAlchemy stream manager for [Kafka, RedPanda](how-to-guides/streams/kafka-streams.md) or [Pulsar](how-to-guides/streams/pulsar-streams.md) streams.


## Learn more

To learn how to utilize the GQLAlchemy library with Memgraph, check out the [how-to guides](/gqlalchemy/how-to-guides) or sign up for the [Getting started with Memgraph and Python course](https://app.livestorm.co/memgraph/getting-started-with-memgraph-and-python-on-demand).
To learn how to utilize the GQLAlchemy library with Memgraph, check out the [how-to guides](how-to-guides/overview.md) or sign up for the [Getting started with Memgraph and Python course](https://app.livestorm.co/memgraph/getting-started-with-memgraph-and-python-on-demand).


3 changes: 3 additions & 0 deletions docs/reference/gqlalchemy/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# GQLAlchemy Reference

Take a look at methods GQLAlchemy has and how to use it. Choose the content from the menu.
Loading

0 comments on commit 2e6b50b

Please sign in to comment.