Skip to content

Commit

Permalink
Var docs installation fixes (#4340) (#4366)
Browse files Browse the repository at this point in the history
* Docs installation page fixes

* other docs fixes

* vad docs fixes

* escape vector star char
  • Loading branch information
vga91 authored Feb 25, 2025
1 parent 3e2d19a commit e1b4dfe
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 16 deletions.
13 changes: 2 additions & 11 deletions docs/asciidoc/guides.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,10 @@

== Awesome Procedures on Cypher (APOC)

include::../readme.adoc[tags=intro-text,leveloffset=+2]
include::../../readme.adoc[tags=intro-text,leveloffset=+2]

include::../readme.adoc[tags=calling-procedures]
include::../../readme.adoc[tags=calling-procedures]

== Helpers

=== Built-in Help Command

include::overview.adoc[tags=help]

=== Built-in Package and Procedure Count

include::overview.adoc[tags=procedurecount]

== APOC Guides by Section

Expand Down
2 changes: 1 addition & 1 deletion docs/asciidoc/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ include::partial$generated-documentation/nav.adoc[]
* xref:background-operations/index.adoc[]
** xref::background-operations/apoc-load-directory-async.adoc[]
** xref:background-operations/triggers.adoc[]
** xref::background-operations/triggers.adoc[]
* xref:database-introspection/index.adoc[]
** xref::database-introspection/config.adoc[]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[[apoc-load-directory-async]]
= Directory listeners

The apoc.load.directory.async procedures are used for managing triggers.
Each trigger consists of a listener observing one or more folders which will trigger the execution of a custom cypher query.
The following procedures can be used to add, remove and list triggers:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[[triggers]]
= Trigger Extended procedures

APOC Core provides a set of procedures for running Cypher queries that are called when data in Neo4j is changed (created, updated, deleted).

https://neo4j.com/docs/apoc/current/background-operations/triggers/[See here for more info].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ to be used in `*.get` and `.*query` procedures, except for the `apoc.vectordb.cu

Therefore, to store the vector info, we can execute the `CALL apoc.vectordb.configure(vectorName, keyConfig, databaseName, $configMap)`,
where `vectorName` can be "QDRANT", "CHROMA", "PINECONE", "MILVUS" or "WEAVIATE",
that indicates info to be reused respectively by `apoc.vectordb.qdrant.*`, `apoc.vectordb.chroma.*` and `apoc.vectordb.weaviate.*`.
that indicates info to be reused respectively by `apoc.vectordb.qdrant.\*`,`apoc.vectordb.chroma.*` and `apoc.vectordb.weaviate.*`.

Then `keyConfig` is the configuration name, `databaseName` is the database where the config will be set,

Expand Down
2 changes: 1 addition & 1 deletion docs/asciidoc/modules/ROOT/partials/neo4j-desktop.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
APOC Extended cannot be installed via the `Plugins` tab.
The present "APOC" box installs APOC core instead, that is:

image::{img}/desktop-apoc.jpg[width=500]
image::desktop-apoc.jpg[width=500]

In order to install APOC Extended, we necessarily have to download the compatible version https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases[from here],
and the put it manually into the `$NEO4J_HOME/plugins` folder.
Expand Down
4 changes: 2 additions & 2 deletions docs/asciidoc/modules/ROOT/partials/restricted.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[WARNING]
====
// tag::warnings[]
// tag::restricted[]
The Extended APOC library contains over 150 functions and procedures.
It is *not* recommended to load all of these into the dbms, but instead use the principle of least privilege.
Expand Down Expand Up @@ -30,5 +30,5 @@ Please note that if you have APOC Core installed,
the same goes for the `dbms.security.procedures.allowlist` one,
so setting `dbms.security.procedures.unrestricted=package.name.*` will unrestrict both Extended and Core procedures / functions.
// end::warnings[]
// end::restricted[]
====
Binary file removed docs/images/desktop-apoc.jpg
Binary file not shown.

0 comments on commit e1b4dfe

Please sign in to comment.