Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix and add links from Index and Constraints pages to Privileges section in Ops Manual #791

Merged
merged 3 commits into from
Nov 22, 2023
Merged

fix and add links from Index and Constraints pages to Privileges section in Ops Manual #791

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f737dfe
fix and add links to privileges section
JPryce-Aklundh Nov 22, 2023
1528eda
add info to fulltext table
JPryce-Aklundh Nov 22, 2023
92aa236
Merge branch 'dev' into fix_privilege_links
JPryce-Aklundh Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/ROOT/pages/constraints/syntax.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ List constraints in the database, either all or filtered on constraint type.

[NOTE]
====
Listing constraints requires the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/database-administration/#access-control-database-administration-constraints[`DROP CONSTRAINT` privilege][`SHOW CONSTRAINTS` privilege].
Listing constraints requires the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/database-administration/#access-control-database-administration-constraints[`SHOW CONSTRAINTS` privilege].
====

The simple version of the command allows for a `WHERE` clause and will give back the default set of output columns:
Expand Down
8 changes: 7 additions & 1 deletion modules/ROOT/pages/indexes-for-full-text-search.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ The commands and procedures for full-text indexes are listed in the table below:
| Create full-text node index.
| `+CREATE FULLTEXT INDEX ...+`
| Create a node full-text index for the given labels and properties.
See the xref:indexes-for-search-performance.adoc#indexes-create-indexes[`CREATE INDEX`] command for more details.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how much that page has on fulltext but it covers it in general at least


| Create full-text relationship index.
| `+CREATE FULLTEXT INDEX ...+`
Expand All @@ -77,14 +78,16 @@ Create a relationship full-text index for the given relationship types and prope
| Drop full-text index.
| `+DROP INDEX ...+`
| Drop the specified index.
See the xref:indexes-for-search-performance.adoc#indexes-drop-indexes[`DROP INDEX`] command for more details.


| Eventually consistent indexes.
| https://neo4j.com/docs/operations-manual/current/reference/procedures/#procedure_db_index_fulltext_awaiteventuallyconsistentindexrefresh[`db.index.fulltext.awaitEventuallyConsistentIndexRefresh`]
| Wait for the updates from recently committed transactions to be applied to any eventually-consistent full-text indexes.

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

|===

Expand All @@ -96,6 +99,8 @@ Full-text indexes are created with the `CREATE FULLTEXT INDEX` command.
An index can be given a unique name when created (or get a generated one), which is used to reference the specific index when querying or dropping it.
A full-text index applies to a list of labels or a list of relationship types, for node and relationship indexes respectively, and then a list of property names.

Creating a full-text index requires link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/database-administration/#access-control-database-administration-index[the `CREATE INDEX` privilege].

[NOTE]
====
More details about the syntax descriptions can be found xref:administration/index.adoc#administration-syntax[here].
Expand Down Expand Up @@ -443,6 +448,7 @@ RETURN

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`.

Dropping a full-text index requires link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/database-administration/#access-control-database-administration-index[the `DROP INDEX` privilege].

.+DROP INDEX+
======
Expand Down
11 changes: 5 additions & 6 deletions modules/ROOT/pages/indexes-for-search-performance.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ The `+CREATE INDEX+` command is optionally idempotent. This mean that its defaul
With `IF NOT EXISTS`, no error is thrown and nothing happens should an index with the same name or same schema and index type already exist.
It may still throw an error if conflicting constraints exist, such as constraints with the same name or schema and backing index type.

Creating an index requires link:{neo4j-docs-base-uri}/operations-manual/{page-version}/database-administration/standard-databases/manage-databases/#manage-databases-stop/authentication-authorization/database-administration/#access-control-database-administration-index[the `CREATE INDEX` privilege].
Creating an index requires link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/database-administration/#access-control-database-administration-index[the `CREATE INDEX` privilege].

[NOTE]
====
Expand Down Expand Up @@ -691,7 +691,7 @@ Full output: `+SHOW INDEXES YIELD *+`.

Listing indexes also allows for `WHERE` and `YIELD` clauses to filter the returned rows and columns.

Listing indexes require link:{neo4j-docs-base-uri}/operations-manual/{page-version}/database-administration/standard-databases/manage-databases/#manage-databases-stop/authentication-authorization/database-administration/#access-control-database-administration-index[the `SHOW INDEX` privilege].
Listing indexes require link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/database-administration/#access-control-database-administration-index[the `SHOW INDEX` privilege].

[discrete]
=== Examples
Expand Down Expand Up @@ -807,7 +807,7 @@ The `DROP INDEX` command is optionally idempotent.
This means that its default behavior is to throw an error if an attempt is made to drop the same index twice.
With `IF EXISTS`, no error is thrown and nothing happens should the index not exist.

Dropping an index requires link:{neo4j-docs-base-uri}/operations-manual/{page-version}/database-administration/standard-databases/manage-databases/#manage-databases-stop/authentication-authorization/database-administration/#access-control-database-administration-index[the `DROP INDEX` privilege].
Dropping an index requires link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/database-administration/#access-control-database-administration-index[the `DROP INDEX` privilege].

[discrete]
=== Examples
Expand Down Expand Up @@ -1110,9 +1110,8 @@ SHOW [ALL \| FULLTEXT \| LOOKUP \| POINT \| RANGE \| TEXT] INDEX[ES]
|===


Creating an index requires link:{neo4j-docs-base-uri}/operations-manual/{page-version}/database-administration/standard-databases/manage-databases/#manage-databases-stop/authentication-authorization/database-administration/#access-control-database-administration-index[the `CREATE INDEX` privilege],
while dropping an index requires link:{neo4j-docs-base-uri}/operations-manual/{page-version}/database-administration/standard-databases/manage-databases/#manage-databases-stop/authentication-authorization/database-administration/#access-control-database-administration-index[the `DROP INDEX` privilege] and
listing indexes require link:{neo4j-docs-base-uri}/operations-manual/{page-version}/database-administration/standard-databases/manage-databases/#manage-databases-stop/authentication-authorization/database-administration/#access-control-database-administration-index[the `SHOW INDEX` privilege].
Creating an index requires link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/database-administration/#access-control-database-administration-index[the `CREATE INDEX` privilege],
while dropping an index requires link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/database-administration/#access-control-database-administration-index[the `DROP INDEX` privilege] and listing indexes require link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/database-administration/#access-control-database-administration-index[the `SHOW INDEX` privilege].

xref:planning-and-tuning/query-tuning/using.adoc[Planner hints and the USING keyword] describes how to make the Cypher planner use specific indexes (especially in cases where the planner would not necessarily have used them).

Expand Down
4 changes: 4 additions & 0 deletions modules/ROOT/pages/indexes-for-vector-search.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ Returns the requested number of approximate nearest neighbor nodes and their sim
You can create vector indexes using the procedure {link-procedures-reference}#procedure_db_index_vector_createNodeIndex[`db.index.vector.createNodeIndex`].
The name of the index must be unique so that you can reference it when xref:#indexes-vector-query[querying] or if you want to xref:indexes-vector-drop[drop] the index.

Creating a vector index requires link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/database-administration/#access-control-database-administration-index[the `CREATE INDEX` privilege].

[IMPORTANT]
====
The index name must be unique among both indexes and constraints.
Expand Down Expand Up @@ -251,6 +253,8 @@ If the query vector itself is not wanted, you can use `WHERE score < 1` to remov

A vector index is dropped by using the xref:indexes-for-search-performance.adoc#indexes-drop-an-index[same command as for other indexes], `DROP INDEX`.

Dropping a vector index requires link:{neo4j-docs-base-uri}/operations-manual/{page-version}/authentication-authorization/database-administration/#access-control-database-administration-index[the `DROP INDEX` privilege].

.+DROP INDEX+
======

Expand Down