Review of the page Defining a schema #512

lidiazuin · 2025-12-18T10:02:33Z

No description provided.

AlexicaWright

Also very useful! Left some comments!

AlexicaWright · 2025-12-18T14:30:37Z

modules/ROOT/pages/cypher/schema.adoc

-= Defining a schema
-
+This guide explains how to define a schema by using indexes and constraints.
+While Neo4j is often described as _schema optional_, indexes and constraints can be introduced when desired, in order to gain performance or xref:data-modeling/index.adoc[modeling] benefits.


Suggested change

While Neo4j is often described as _schema optional_, indexes and constraints can be introduced when desired, in order to gain performance or xref:data-modeling/index.adoc[modeling] benefits.

While Neo4j is often described as _schema optional_, indexes and constraints can be added when needed, either for performance optimization or xref:data-modeling/index.adoc[modeling] benefits.

I don't really understand what modelling has to do with this?

Not sure either, it's from the original content. Should we remove it?

I mean, it IS related. Maybe it can be rephrased to make it clearer?

AlexicaWright · 2025-12-18T14:32:14Z

modules/ROOT/pages/cypher/schema.adoc

 == Example graph

-First create some data to use for our examples:
+After you create a link:https://neo4j.com/product/auradb/?ref=docs-nav-get-started[free Aura instance], use the "Connect" button and select "Query". 


It does read a bit weird "After you create..." like it's a prerequisite, but it's not stated anywhere that it is.

We were using the same instruction for previous tutorials, but since this is a guide, maybe it's better to write this differently.

AlexicaWright · 2025-12-18T14:33:38Z

modules/ROOT/pages/cypher/schema.adoc


-The main reason for using indexes in a graph database is to find the starting point of a graph traversal.
+The main reason for using link:https://neo4j.com/docs/cypher-manual/current/indexes/[indexes] in a graph database is to find the starting point of a graph traversal.
 Once that starting point is found, the traversal relies on in-graph structures to achieve high performance.


To achieve high performance?

This still sounds strange, "to achieve high performance". What "in-graph"structures" are you referring to? The actual graph structure (vs relational tables)?

modules/ROOT/pages/cypher/schema.adoc

AlexicaWright · 2025-12-18T14:48:24Z

modules/ROOT/pages/cypher/schema.adoc

+
+=== Find constraints
+
+First, you need to create a constraint.


This header says "Find restraint". It seems counterintuitive to have to create something in order to find it.
Maybe we should have an example of how to create a constraint first and then how to find it?

modules/ROOT/pages/cypher/schema.adoc

Co-authored-by: Jessica Wright <[email protected]>

AlexicaWright

Taking shape! Some more comments.

AlexicaWright · 2026-01-08T09:50:25Z

modules/ROOT/pages/cypher/schema.adoc


-The main reason for using indexes in a graph database is to find the starting point of a graph traversal.
+The main reason for using link:https://neo4j.com/docs/cypher-manual/current/indexes/[indexes] in a graph database is to find the starting point of a graph traversal.
 Once that starting point is found, the traversal relies on in-graph structures to achieve high performance.


This still sounds strange, "to achieve high performance". What "in-graph"structures" are you referring to? The actual graph structure (vs relational tables)?

AlexicaWright · 2026-01-08T09:53:39Z

modules/ROOT/pages/cypher/schema.adoc

-The main reason for using indexes in a graph database is to find the starting point of a graph traversal.
+The main reason for using link:https://neo4j.com/docs/cypher-manual/current/indexes/[indexes] in a graph database is to find the starting point of a graph traversal and thus achieve high performance.
 Once that starting point is found, the traversal relies on in-graph structures to achieve high performance.
+Moreover, indexes can be added at any point.


Suggested change

Moreover, indexes can be added at any point.

Indexes can be added at any point.

"Moreover" sounds very formal and the sentence that follows doesn't really strengthen the first paragraph, it just adds information. I'd suggest to just move the sentence to a new line for the same effect, but make it sound less formal.

AlexicaWright · 2026-01-08T09:56:54Z

modules/ROOT/pages/cypher/schema.adoc

-This is one of several options for query tuning, described in detail in link:{neo4j-docs-base-uri}/cypher-manual/current/query-tuning[Cypher manual -> Query tuning].
-====
+In most cases, it is not necessary to specify which index to use when querying for data, as the appropriate indexes are used automatically.
+However, you can still use index hints to specify which index to use in a particular query.


Maybe add something on why you'd want to do that when it's already done automagically?

AlexicaWright · 2026-01-08T10:55:37Z

modules/ROOT/pages/cypher/schema.adoc

+
+[source, cypher]
+--
 SHOW INDEXES YIELD name, labelsOrTypes, properties, type


That's incorrect syntax, use just SHOW INDEXES and you'll get ALL the details.

AlexicaWright · 2026-01-08T12:56:05Z

modules/ROOT/pages/cypher/schema.adoc

-Constraints are used to make sure that the data adheres to the rules of the domain.
-For example:
+link:https://neo4j.com/docs/cypher-manual/current/constraints/[Constraints] are used to make sure that the data adheres to the rules of the domain.
+They can be property uniqueness contraints, property existence, property type, or key constraints.


Suggested change

They can be property uniqueness contraints, property existence, property type, or key constraints.

They can be property uniqueness, property existence, property type, or key constraints.

AlexicaWright · 2026-01-08T12:57:04Z

modules/ROOT/pages/cypher/schema.adoc

+
+|===
+
+Constraints can be added to databases that already have data in them.


Is this to say that they cannot be added to empty dbs?

AlexicaWright · 2026-01-08T12:57:48Z

modules/ROOT/pages/cypher/schema.adoc

+|===
+
+Constraints can be added to databases that already have data in them.
+However, this requires that the existing data complies with the constraint that is being added.


What happens if existing data does not comply with an added constraint?

modules/ROOT/pages/cypher/schema.adoc

AlexicaWright · 2026-01-08T13:07:10Z

modules/ROOT/pages/cypher/schema.adoc

+--
 CREATE CONSTRAINT constraint_example_1 FOR (movie:Movie) REQUIRE movie.title IS UNIQUE
----
+--


Maybe worth mentioning that when you create some constraints, a corresponding index is automatically created? This constraint results in a range index on the title property of movie nodes. If you run SHOW INDEXES after you create the constraint, you can see it.

Some constraints, as in specific cases, or any constraint? Because if it's only some, then it might need more explanation, and I guess it's better to keep it short in the GSG

AlexicaWright · 2026-01-12T10:17:36Z

modules/ROOT/pages/cypher/schema.adoc

-If there is existing data in the database, it will take some time for an index to come online.
-====
+link:https://neo4j.com/docs/cypher-manual/current/indexes/[Indexes] are used for speeding up data retrieval and thus improve performance.
+They can be added at any point.


Suggested change

They can be added at any point.

They can be added at any time.

AlexicaWright · 2026-01-12T10:26:49Z

modules/ROOT/pages/cypher/schema.adoc

-It is possible to specify which index to use in a particular query, using _index hints_.
-This is one of several options for query tuning, described in detail in link:{neo4j-docs-base-uri}/cypher-manual/current/query-tuning[Cypher manual -> Query tuning].
-====
+In most cases, it is not necessary to specify which index to use when querying for data, as the appropriate indexes are used automatically.


Suggested change

In most cases, it is not necessary to specify which index to use when querying for data, as the appropriate indexes are used automatically.

Cypher's query planner automatically selects the appropriate index to use for your query.

Only in exceptional cases do you need to specify which index to use.

See link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/search-performance-indexes/index-hints/[Cypher Manual -> Index hints for the Cypher planner] for more information.

neo4j-docops-agent · 2026-01-12T10:37:03Z

This PR includes documentation updates
View the updated docs at https://neo4j-docs-getting-started-512.surge.sh

Updated pages:

Review of the page Defining a schema

d2c27ab

lidiazuin requested a review from AlexicaWright December 18, 2025 10:02

lidiazuin added the cherry-pick-this-to-main label Dec 18, 2025

AlexicaWright reviewed Dec 18, 2025

View reviewed changes

lidiazuin and others added 2 commits December 18, 2025 16:01

Apply suggestions from code review

c623efd

Co-authored-by: Jessica Wright <[email protected]>

updates after review

2732742

lidiazuin requested a review from AlexicaWright January 7, 2026 08:14

AlexicaWright reviewed Jan 8, 2026

View reviewed changes

updates after review

ad698fd

lidiazuin requested a review from AlexicaWright January 12, 2026 09:37

update

e410c6a

AlexicaWright reviewed Jan 12, 2026

View reviewed changes

update after review

8bbfead

lidiazuin requested a review from AlexicaWright January 12, 2026 11:09

	While Neo4j is often described as _schema optional_, indexes and constraints can be introduced when desired, in order to gain performance or xref:data-modeling/index.adoc[modeling] benefits.
	While Neo4j is often described as _schema optional_, indexes and constraints can be added when needed, either for performance optimization or xref:data-modeling/index.adoc[modeling] benefits.

	Moreover, indexes can be added at any point.
	Indexes can be added at any point.

	They can be property uniqueness contraints, property existence, property type, or key constraints.
	They can be property uniqueness, property existence, property type, or key constraints.


		\|===

		Constraints can be added to databases that already have data in them.

	They can be added at any point.
	They can be added at any time.

-In most cases, it is not necessary to specify which index to use when querying for data, as the appropriate indexes are used automatically.
+Cypher's query planner automatically selects the appropriate index to use for your query.
+Only in exceptional cases do you need to specify which index to use.
+See link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/search-performance-indexes/index-hints/[Cypher Manual -> Index hints for the Cypher planner] for more information.

Review of the page Defining a schema #512

Are you sure you want to change the base?

Review of the page Defining a schema #512

Uh oh!

Conversation

lidiazuin commented Dec 18, 2025

Uh oh!

AlexicaWright left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AlexicaWright left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neo4j-docops-agent commented Jan 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants