docs: document the export module for JSON graph export - #1717
Draft
imilinovic wants to merge 1 commit into
Draft
Conversation
Adds a page for export.json_data / json_all / json_graph, and points export_util's JSON procedures at it, since the two write different formats: export_util's is the round trip for import_util, export's is the interchange format for other systems. Also covers the compatibility aliases, whose contract changed: apoc.export.json.all and .graph now resolve to the new module.
imilinovic
added
the
feature
imilinovic
added
the
feature
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Release note
Documents the new
exportquery module —export.json_data,export.json_allandexport.json_graph— which writes or streams a graph as JSON in the standard interchange format. Also documents that theapoc.export.json.allandapoc.export.json.graphcompatibility aliases now resolve to it, which changes their result columns and, for.graph, their arguments.Related product PRs
PRs from product repo this doc page is related to:
memgraph/memgraph#4531
Checklist:
bugfixorfeaturelabel, based on the product PR type you're documentingWhat changed
advanced-algorithms/available-algorithms/exportcovering the three procedures, the config map, the three output shapes, the 12 result columns and the compatibility aliases.export_utilgains a note pointing at it, because the two modules write different JSON:export_util's is the round-trip formatimport_utilreads back,export's is the interchange format. That distinction is the thing most likely to trip a user up.Two behaviours worth a reviewer's eye, both documented as callouts:
YIELD *returns the columns alphabetically rather than in declared order, and enum properties cannot be exported.