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

[master < convert] write docs for convert module #1029

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 77 additions & 0 deletions mage/query-modules/python/convert.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
id: convert
title: convert
sidebar_label: convert
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import RunOnSubgraph from '../../templates/_run_on_subgraph.mdx';

export const Highlight = ({children, color}) => (
<span
style={{
backgroundColor: color,
borderRadius: '2px',
color: '#fff',
padding: '0.2rem',
}}>
{children}
</span>
);

Module used for conversion of one data type to another.

[![docs-source](https://img.shields.io/badge/source-convert-FB6E00?logo=github&style=for-the-badge)](https://github.com/memgraph/mage/blob/main/python/convert.py)


| Trait | Value |
| ------------------- | ----------------------------------------------------- |
| **Module type** | <Highlight color="#FB6E00">**util**</Highlight> |
| **Implementation** | <Highlight color="#FB6E00">**Python**</Highlight> |
| **Parallelism** | <Highlight color="#FB6E00">**sequential**</Highlight> |

## Functins

### `str2object(string)`

An inline function that converts the input string to an object the string represents using Python's `json.dumps` function.

#### Input:

- `string: string` ➡ input string that is converted,.

#### Output:

- `mgp.Any` ➡ since the function is inline, the output is not named, and can be of various data types, depending on the content of the string.

#### Usage:

In this case, the string will be converted to a list.

```cypher
RETURN convert.str2object("[1,2,3]") AS result;
```

```plaintext
+----------------------------+
| result |
+----------------------------+
| [1, 2, 3] |
+----------------------------+
```

In this use case, the string will be converted into a map, containing a list.


Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

```cypher
RETURN convert.str2object('{"key": [1,2,3]}') AS result;
```

```plaintext
+----------------------------+
| result |
+----------------------------+
| {"key": [1,2,3]} |
+----------------------------+
```
1 change: 1 addition & 0 deletions mage/templates/_mage_spells.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
| Algorithms | Lang | Description |
| -------------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [conditional_execution](/mage/query-modules/cpp/conditional-execution) | C++ | Define conditions not expressible in Cypher and and use them to control query execution. |
| [convert](/mage/query-modules/python/convert) | Python | A module used for conversion from one data type to another. |
| [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
1 change: 1 addition & 0 deletions sidebars/sidebarsMAGE.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ module.exports = {
"query-modules/cpp/community-detection",
"query-modules/cpp/community-detection-online",
"query-modules/cpp/conditional-execution",
"query-modules/python/convert",
"query-modules/cpp/cycles",
"query-modules/cuda/cugraph",
"query-modules/python/date",
Expand Down
Loading