Skip to content

Commit 696e2ba

Browse files
authored
Restructure index section (#500)
This will hopefully remove some confusion for users around just showing off the command vs an example as well as removing examples for index providers when only one provider exists. It also updates the links to not mention `administration` as the index chapter does not live in the administration chapter.
1 parent 9fab0ab commit 696e2ba

File tree

7 files changed

+728
-1083
lines changed

7 files changed

+728
-1083
lines changed

modules/ROOT/pages/clauses/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ These comprise clauses used to manage databases, schema and security; further de
2121
m| xref::administration/databases.adoc[CREATE \| DROP \| START \| STOP DATABASE]
2222
| Create, drop, start or stop a database.
2323

24-
m| xref::indexes-for-search-performance.adoc#administration-indexes-syntax[CREATE \| DROP INDEX]
24+
m| xref::indexes-for-search-performance.adoc#indexes-syntax[CREATE \| DROP INDEX]
2525
| Create or drop an index on all nodes with a particular label and property.
2626

2727
m| xref::constraints/syntax.adoc[CREATE \| DROP CONSTRAINT]

modules/ROOT/pages/deprecations-additions-removals-compatibility.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3389,7 +3389,7 @@ label:new[]
33893389
DROP INDEX name
33903390
----
33913391
a|
3392-
xref:indexes-for-search-performance.adoc#administration-indexes-drop-an-index[New command] for dropping an index by name.
3392+
xref:indexes-for-search-performance.adoc#indexes-drop-an-index[New command] for dropping an index by name.
33933393

33943394

33953395
a|

modules/ROOT/pages/indexes-for-full-text-search.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:description: This chapter describes how to use full-text indexes, to enable full-text search.
22

3-
[[administration-indexes-fulltext-search]]
3+
[[indexes-fulltext-search]]
44
= Full-text search index
55

66
[abstract]
@@ -40,13 +40,13 @@ In contrast to xref::indexes-for-search-performance.adoc[other indexes], a full-
4040

4141
* applied to more than one label.
4242
* applied to more than one relationship type.
43-
* applied to more than one property at a time (similar to a xref::indexes-for-search-performance.adoc#administration-indexes-create-a-composite-range-index-for-nodes[_composite index_]) but with an important difference:
43+
* applied to more than one property at a time (similar to a xref::indexes-for-search-performance.adoc#indexes-create-a-composite-range-index-for-nodes[_composite index_]) but with an important difference:
4444
While a composite index applies only to entities that match the indexed label and _all_ of the indexed properties, full-text index will index entities that have at least one of the indexed labels or relationship types, and at least one of the indexed properties.
4545

4646
For information on how to configure full-text indexes, refer to link:{neo4j-docs-base-uri}/operations-manual/{page-version}/performance/index-configuration#index-configuration-fulltext[Operations Manual -> Indexes to support full-text search].
4747

4848

49-
[[administration-indexes-fulltext-search-manage]]
49+
[[indexes-fulltext-search-manage]]
5050
== Full-text search procedures
5151

5252
Full-text indexes are managed through commands and used through built-in procedures, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/reference/procedures[Operations Manual -> Procedures] for a complete reference.
@@ -89,12 +89,12 @@ Create a relationship full-text index for the given relationship types and prope
8989

9090
| Listing all full-text indexes.
9191
| `SHOW FULLTEXT INDEXES`
92-
| Lists all full-text indexes, see xref::indexes-for-search-performance.adoc#administration-indexes-list-indexes[the `SHOW INDEXES` command] for details.
92+
| Lists all full-text indexes, see xref::indexes-for-search-performance.adoc#indexes-list-indexes[the `SHOW INDEXES` command] for details.
9393

9494
|===
9595

9696

97-
[[administration-indexes-fulltext-search-create-and-configure]]
97+
[[indexes-fulltext-search-create-and-configure]]
9898
== Create and configure full-text indexes
9999

100100
Full-text indexes are created with the `CREATE FULLTEXT INDEX` command.
@@ -247,7 +247,7 @@ Added 1 index.
247247
======
248248

249249

250-
[[administration-indexes-fulltext-search-query]]
250+
[[indexes-fulltext-search-query]]
251251
== Query full-text indexes
252252

253253
Full-text indexes will, in addition to any exact matches, also return _approximate_ matches to a given query.
@@ -375,7 +375,7 @@ RETURN node.title, node.description, score
375375
A complete description of the Lucene query syntax can be found in the link:https://lucene.apache.org/core/8_2_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package.description[Lucene documentation].
376376

377377

378-
[[administration-indexes-fulltext-search-text-array-properties]]
378+
[[indexes-fulltext-search-text-array-properties]]
379379
== Handling of Text Array properties
380380

381381
If the indexed property contains a text array, each element of this array is analyzed independently and all produced terms are associated with the same property name.
@@ -443,10 +443,10 @@ RETURN
443443
======
444444

445445

446-
[[administration-indexes-fulltext-search-drop]]
446+
[[indexes-fulltext-search-drop]]
447447
== Drop full-text indexes
448448

449-
A full-text node index is dropped by using the xref::indexes-for-search-performance.adoc#administration-indexes-drop-an-index[same command as for other indexes], `DROP INDEX`.
449+
A full-text node index is dropped by using the xref::indexes-for-search-performance.adoc#indexes-drop-an-index[same command as for other indexes], `DROP INDEX`.
450450

451451

452452
.+DROP INDEX+

0 commit comments

Comments
 (0)