This repository has been archived by the owner on Sep 18, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 23
[master < convert] write docs for convert module #1029
Open
mpintaric55334
wants to merge
2
commits into
master
Choose a base branch
from
E-add-convert-module
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 @@ | ||
--- | ||
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. | ||
|
||
|
||
```cypher | ||
RETURN convert.str2object('{"key": [1,2,3]}') AS result; | ||
``` | ||
|
||
```plaintext | ||
+----------------------------+ | ||
| result | | ||
+----------------------------+ | ||
| {"key": [1,2,3]} | | ||
+----------------------------+ | ||
``` |
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.