diff --git a/pages/memgraph-lab/features/graph-schema.mdx b/pages/memgraph-lab/features/graph-schema.mdx index 2879ff562..89ec77119 100644 --- a/pages/memgraph-lab/features/graph-schema.mdx +++ b/pages/memgraph-lab/features/graph-schema.mdx @@ -7,7 +7,6 @@ import {CommunityLinks} from '/components/social-card/CommunityLinks' # Graph schema - If you need to check the data model of the data currently in the database, you can generate a **graph schema** that will show all the node types and relationships between them. @@ -23,7 +22,6 @@ If you're connected to a Memgraph instance running with the flag](/querying/schema#run-time-schema-tracking), you'll see the types for each node and relationship property. - ## Generate a graph schema To generate the graph schema, navigate to the **Graph schema** tab in the @@ -38,7 +36,6 @@ reverse-engineering an unknown data structure. ![](/pages/data-visualization/features/graph-schema/graph-schema.png) - ## Inspect properties Once the schema is generated, you can click on any node or relationship type in @@ -55,4 +52,30 @@ uniform or varies between entries. ![](/pages/data-visualization/features/graph-schema/schema-properties.png) +### Descriptions (Memgraph & Lab 3.10+) + +You can see and edit **descriptions** on node labels, relationship types, and their +properties directly within the schema view. + +> **Availability:** +> - **Memgraph**: version 3.10 and above +> - **Memgraph Lab**: version 3.10 and above + +This feature helps you document your data model by adding helpful notes or +clarifications to any node label, relationship type, or property. Descriptions +you add are saved and displayed to anyone viewing the schema, making +collaboration and understanding of the graph structure easier. It's a powerful +way to document your graph data model and ensure all users share the same +up-to-date understanding of your schema. + +![](/pages/data-visualization/features/graph-schema/schema-descriptions.png) + +**Tip:** If you've added descriptions to node labels, relationship types, or +properties, you'll also see them when running regular Cypher queries and +viewing the results in the graph view-not just in the schema tab. This is +useful for providing extra context while exploring data, as the descriptions +appear directly alongside the schema elements in your query results. + +![](/pages/data-visualization/features/graph-schema/query-descriptions.png) + diff --git a/public/pages/data-visualization/features/graph-schema/graph-schema.png b/public/pages/data-visualization/features/graph-schema/graph-schema.png index fbd4bd912..fd9729dcf 100644 Binary files a/public/pages/data-visualization/features/graph-schema/graph-schema.png and b/public/pages/data-visualization/features/graph-schema/graph-schema.png differ diff --git a/public/pages/data-visualization/features/graph-schema/query-descriptions.png b/public/pages/data-visualization/features/graph-schema/query-descriptions.png new file mode 100644 index 000000000..63fd24ee8 Binary files /dev/null and b/public/pages/data-visualization/features/graph-schema/query-descriptions.png differ diff --git a/public/pages/data-visualization/features/graph-schema/schema-descriptions.png b/public/pages/data-visualization/features/graph-schema/schema-descriptions.png new file mode 100644 index 000000000..a6766fa2d Binary files /dev/null and b/public/pages/data-visualization/features/graph-schema/schema-descriptions.png differ diff --git a/public/pages/data-visualization/features/graph-schema/schema-properties.png b/public/pages/data-visualization/features/graph-schema/schema-properties.png index 06c396ffe..9565903b7 100644 Binary files a/public/pages/data-visualization/features/graph-schema/schema-properties.png and b/public/pages/data-visualization/features/graph-schema/schema-properties.png differ