Skip to content
This repository has been archived by the owner on Sep 18, 2023. It is now read-only.

Commit

Permalink
[master < T946] Add update of the do module to docs (#946)
Browse files Browse the repository at this point in the history
* Add update of the do module to docs

* Update mage/query-modules/cpp/conditional-execution.md

Co-authored-by: Vlasta <[email protected]>

* Update mage/query-modules/cpp/conditional-execution.md

Co-authored-by: Vlasta <[email protected]>

* Update link

---------

Co-authored-by: Vlasta <[email protected]>
Co-authored-by: kgolubic <[email protected]>
  • Loading branch information
3 people authored Jul 21, 2023
1 parent 0606187 commit a187bbe
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 4 deletions.
2 changes: 1 addition & 1 deletion mage/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_label: Changelog
### Features and improvements

- The [new conditional execution
module](/query-modules/python/conditional-execution.md ) lets you define
module](/query-modules/cpp/conditional-execution.md) lets you define
conditions not expressible in Cypher and and use them to control query
execution. [#203](https://github.com/memgraph/mage/pull/203)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ and use it to control query execution.
| Trait | Value |
| ------------------ | ----------------------------------------------------- |
| **Module type** | <Highlight color="#FB6E00">**module**</Highlight> |
| **Implementation** | <Highlight color="#FB6E00">**Python**</Highlight> |
| **Implementation** | <Highlight color="#FB6E00">**C++**</Highlight> |
| **Parallelism** | <Highlight color="#FB6E00">**sequential**</Highlight> |

## Procedures
Expand Down Expand Up @@ -70,6 +70,12 @@ Parameters are prefixed with `$` like `$param_name`. For examples, see

* `value: Map` ➡ Contains the result record of the executed query. Each `value` corresponds to one result record.

:::caution
Currently, the module supports only those returning records that contain `string`, `integer`, `double` or `boolean` primitives.
Queries in the `conditionals` or in the `else_query` arguments, which get executed and return other types of data, will
result in an exception.
:::

#### Usage:

```cypher
Expand Down Expand Up @@ -105,6 +111,12 @@ Parameters are prefixed with `$` like `$param_name`. For examples, see

* `value: Map` ➡ Contains the result record of the executed query. Each `value` corresponds to one result record.

:::caution
Currently, the module supports only those returning records that contain `string`, `integer`, `double` or `boolean` primitives.
Queries in the `conditionals` or in the `else_query` arguments, which get executed and return other types of data, will
result in an exception.
:::

#### Usage:

```cypher
Expand Down
2 changes: 1 addition & 1 deletion mage/templates/_mage_spells.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@

| Algorithms | Lang | Description |
| -------------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [conditional_execution](/mage/query-modules/python/conditional-execution) | Python | Define conditions not expressible in Cypher and and use them to control query execution. |
| [conditional_execution](/mage/query-modules/cpp/conditional-execution) | C++ | Define conditions not expressible in Cypher and and use them to control query execution. |
| [export_util](/mage/query-modules/python/export-util) | Python | A module for exporting the graph database in different formats (JSON). |
| [graph_analyzer](/mage/query-modules/python/graph-analyzer) | Python | This Graph Analyzer query module offers insights about the stored graph or a subgraph. |
| [graph_util](/mage/query-modules/cpp/graph-util) | C++ | A module with common graph algorithms and graph manipulation utilities |
Expand Down
2 changes: 1 addition & 1 deletion sidebars/sidebarsMAGE.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ module.exports = {
"query-modules/cpp/bridges",
"query-modules/cpp/community-detection",
"query-modules/cpp/community-detection-online",
"query-modules/python/conditional-execution",
"query-modules/cpp/conditional-execution",
"query-modules/cpp/cycles",
"query-modules/cuda/cugraph",
"query-modules/cpp/degree-centrality",
Expand Down

0 comments on commit a187bbe

Please sign in to comment.