MemGQL: connectors + schema-graph model docs#1685
Open
DavIvek wants to merge 7 commits into
Open
Conversation
Update the MemGQL docs for the schema-graph model that replaces the old connector-bound flow. - New Schema File page: the --schema JSON (connectors + graphs, with the vertices/edges/attributes/metaFields mapping format), minimal + full examples. - Reference: rewrite Graph Management to the real DDL surface (ADD CONNECTOR, CREATE GRAPH FROM, ALTER GRAPH SET READ/CACHE, SHOW ...); replace the old nodes/id_column mapping schema with a pointer to the Schema File page. - Multiple Graphs, Quick Start, Docker Compose, and the public/private use case: registration, lifecycle, caching, and examples moved to the new flow. - Oracle + SQL Server connector pages: ADD MAPPING / old mapping -> new flow. - Changelog: Unreleased breaking-change + new-feature entries. Removes all references to the retired statements (ADD GRAPH ON CONNECTOR, ADD MAPPING, CONNECT ... AS, USE CONNECTION, SET DEFAULT CONNECTION, UNADD GRAPH, ALTER GRAPH SET CONNECTOR/GRAPH/MAPPING) and the legacy nodes/edges mapping format. Verified against the feat/global-schema binary (DDL, routing, error cases, --schema boot).
Document the schema-file boot (docker run ... --schema=/data/schema.json) as the simplest way to start a federated instance — in the Schema File "Booting" section and as the "easiest" path atop Quick Start's Multi-Connection Mode. Verified the binary honors --schema and BOLT_LISTEN_ADDR=0.0.0.0 (host-reachable).
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Format every JSON block (fenced code blocks + the mapping-file heredocs) with standard 2-space indentation so the schema and mapping examples are easier to read. Reformatting only — the JSON content is unchanged.
- Prefer USE-free queries throughout: drop unnecessary `USE` clauses and the USE-free explanatory comments. `USE` is kept only where it belongs — the query-model page (cross-backend joins, composites, disambiguation), the no-label cleanup query, and the reference. Verified USE-free single-graph and cross-graph UNION routing against a running instance (identical results to the explicit-USE baseline). - Quick Start's Multi-Connection Mode is now schema-first: show a schema file, boot from it, query, then add more connectors/graphs at runtime. - public/private demo: give the `friend_of` table an `id` column so the FRIEND_OF edge mapping (metaFields.id) and the insert/traverse steps work.
- Quick Start: the schema-file setup gets its own section, "Connecting your data with a schema file" (it was left under "Mapping File" when the multi/single-connector mode framing was dropped); the statements reference is now a top-level section. Mapping File intro no longer says "translates into SQL joins". - Schema File: "How it works" trimmed to two conceptual bullets — dropped the hash-join / GQL->SQL / per-query-executor internals. - Multiple Graphs: "cross-backend hash join" -> "cross-backend join". - Reference: MAPPING_FILE marked required in the single-connector config tables.
…-dashes - Rename the "USE-free routing" concept to plain "routing": section heading `## USE-free routing` -> `## Routing`, all `#use-free-routing` links -> `#routing`, and the term in prose (incl. historical changelog entries; terminology only, shipped facts unchanged). - Booting from a schema file is now Docker-only; drop the bare `bolt_server --schema=...` invocation. - Reduce em-dashes in authored prose across the schema-file, quick-start, multiple-graphs, reference, connector, and use-case pages. Data markers in SHOW SCHEMA/SHOW GRAPHS output and historical release notes are left as-is.
… link The "Connecting your data with a schema file" quick-start section mapped a social/User/FOLLOWS graph that didn't match the tutorial's seeded data, so the sample query returned nothing. Map the seeded Developer/Language/WRITES labels instead so the query returns rows, note it reuses the running Memgraph, and reframe the runtime step as an illustrative example. Also repoint the connect.mdx link from the removed quick-start#multi-connection-mode anchor.
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.
Updates the MemGQL docs for the connectors + schema-graph model.
USEclause is needed.ALTER GRAPH … SET CACHE).This PR can be merged once new version of https://github.com/memgraph/zero gets released.