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.

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

[NOID] Fixes #4066: Implement an apoc.convert.fromYaml function #4184

Merged
merged 7 commits into from
Dec 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 10 additions & 4 deletions LICENSES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ Apache-2.0
curator-client-5.2.0.jar
curator-framework-5.2.0.jar
curator-recipes-5.2.0.jar
docker-java-api-3.2.13.jar
docker-java-transport-3.2.13.jar
docker-java-transport-zerodep-3.2.13.jar
docker-java-api-3.3.6.jar
docker-java-transport-3.3.6.jar
docker-java-transport-zerodep-3.3.6.jar
ehcache-3.3.1.jar
error_prone_annotations-2.18.0.jar
failureaccess-1.0.1.jar
Expand Down Expand Up @@ -103,6 +103,7 @@ Apache-2.0
jackson-databind-2.17.2.jar
jackson-dataformat-cbor-2.17.2.jar
jackson-dataformat-csv-2.17.2.jar
jackson-dataformat-yaml-2.17.0.jar
jackson-datatype-jsr310-2.17.0.jar
jackson-datatype-jsr310-2.17.2.jar
jackson-jaxrs-base-2.15.2.jar
Expand Down Expand Up @@ -133,6 +134,7 @@ Apache-2.0
jffi-1.2.16-native.jar
jffi-1.2.16.jar
jmespath-java-1.12.770.jar
jna-5.13.0.jar
jna-5.9.0.jar
jnr-constants-0.9.9.jar
jnr-ffi-2.1.7.jar
Expand Down Expand Up @@ -220,6 +222,7 @@ Apache-2.0
shiro-crypto-hash-1.13.0.jar
shiro-event-1.13.0.jar
shiro-lang-1.13.0.jar
snakeyaml-2.2.jar
snappy-java-1.1.10.4.jar
token-provider-2.0.3.jar
websocket-api-9.4.53.v20231009.jar
Expand Down Expand Up @@ -3045,6 +3048,7 @@ MIT
bcutil-jdk18on-1.78.jar
cassandra-1.17.6.jar
checker-qual-3.42.0.jar
chromadb-1.19.7.jar
couchbase-1.17.6.jar
database-commons-1.17.6.jar
duct-tape-1.0.8.jar
Expand All @@ -3062,12 +3066,14 @@ MIT
mysql-1.17.6.jar
neo4j-1.17.6.jar
postgresql-1.17.6.jar
qdrant-1.19.7.jar
reactive-streams-1.0.4.jar
slf4j-api-1.7.36.jar
slf4j-api-2.0.11.jar
slf4j-nop-1.7.30.jar
slf4j-reload4j-1.7.36.jar
testcontainers-1.17.6.jar
testcontainers-1.19.7.jar
weaviate-1.19.7.jar
------------------------------------------------------------------------------

The MIT License
Expand Down
15 changes: 11 additions & 4 deletions NOTICE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ Apache-2.0
curator-client-5.2.0.jar
curator-framework-5.2.0.jar
curator-recipes-5.2.0.jar
docker-java-api-3.2.13.jar
docker-java-transport-3.2.13.jar
docker-java-transport-zerodep-3.2.13.jar
docker-java-api-3.3.6.jar
docker-java-transport-3.3.6.jar
docker-java-transport-zerodep-3.3.6.jar
ehcache-3.3.1.jar
error_prone_annotations-2.18.0.jar
failureaccess-1.0.1.jar
Expand Down Expand Up @@ -133,6 +133,7 @@ Apache-2.0
jackson-databind-2.17.2.jar
jackson-dataformat-cbor-2.17.2.jar
jackson-dataformat-csv-2.17.2.jar
jackson-dataformat-yaml-2.17.0.jar
jackson-datatype-jsr310-2.17.0.jar
jackson-datatype-jsr310-2.17.2.jar
jackson-jaxrs-base-2.15.2.jar
Expand Down Expand Up @@ -163,6 +164,7 @@ Apache-2.0
jffi-1.2.16-native.jar
jffi-1.2.16.jar
jmespath-java-1.12.770.jar
jna-5.13.0.jar
jna-5.9.0.jar
jnr-constants-0.9.9.jar
jnr-ffi-2.1.7.jar
Expand Down Expand Up @@ -250,6 +252,7 @@ Apache-2.0
shiro-crypto-hash-1.13.0.jar
shiro-event-1.13.0.jar
shiro-lang-1.13.0.jar
snakeyaml-2.2.jar
snappy-java-1.1.10.4.jar
token-provider-2.0.3.jar
websocket-api-9.4.53.v20231009.jar
Expand Down Expand Up @@ -434,6 +437,7 @@ LGPL 2.1
javassist-3.25.0-GA.jar

LGPL-2.1-or-later
jna-5.13.0.jar
jna-5.9.0.jar

MIT
Expand All @@ -445,6 +449,7 @@ MIT
bcutil-jdk18on-1.78.jar
cassandra-1.17.6.jar
checker-qual-3.42.0.jar
chromadb-1.19.7.jar
couchbase-1.17.6.jar
database-commons-1.17.6.jar
duct-tape-1.0.8.jar
Expand All @@ -462,12 +467,14 @@ MIT
mysql-1.17.6.jar
neo4j-1.17.6.jar
postgresql-1.17.6.jar
qdrant-1.19.7.jar
reactive-streams-1.0.4.jar
slf4j-api-1.7.36.jar
slf4j-api-2.0.11.jar
slf4j-nop-1.7.30.jar
slf4j-reload4j-1.7.36.jar
testcontainers-1.17.6.jar
testcontainers-1.19.7.jar
weaviate-1.19.7.jar

MPL 1.1
javassist-3.25.0-GA.jar
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public static boolean addPropertyToGraphEntity(
return true;
}

static Object[] getPrototypeFor(String type) {
public static Object[] getPrototypeFor(String type) {
switch (type) {
case "INT":
case "LONG":
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
= apoc.convert.fromYaml
:description: This section contains reference documentation for the apoc.convert.fromYaml function.

label:function[] label:apoc-extended[]

[.emphasis]
apoc.convert.fromYaml(value, $config) - Deserializes the YAML string to Neo4j value

== Signature

[source]
----
apoc.convert.fromYaml(value :: STRING, config = {} :: MAP) :: ANY
----

== Input parameters
[.procedures, opts=header]
|===
| Name | Type | Default
|value|STRING|null
|config|MAP|{}
|===

== Config parameters
include::partial$usage/config/apoc.convert.fromYaml.adoc[]

[[yaml-dependencies]]
=== Install dependencies
Note that to use this function, you have to install additional dependencies
which can be downloaded https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/{apoc-release}/apoc-yaml-dependencies-{apoc-release}-all.jar[from this link].


[[usage-apoc.convert.fromYaml]]
== Usage Examples
include::partial$usage/apoc.convert.fromYaml.adoc[]


Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
= apoc.convert.fromYaml
:description: This section contains reference documentation for the apoc.convert.fromYaml function.

label:function[] label:apoc-full[]

[.emphasis]
apoc.convert.fromYaml(value, $config) - Deserializes the YAML string to Neo4j value

== Signature

[source]
----
apoc.convert.fromYaml(value :: STRING, config = {} :: MAP) :: ANY
----

== Input parameters
[.procedures, opts=header]
|===
| Name | Type | Default
|value|STRING|null
|config|MAP|{}
|===

== Config parameters
include::partial$usage/config/apoc.convert.fromYaml.adoc[]

[[yaml-dependencies]]
=== Install dependencies
Note that to use this function, you have to install additional dependencies
which can be downloaded https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/{apoc-release}/apoc-yaml-dependencies-{apoc-release}-all.jar[from this link].


[[usage-apoc.convert.fromYaml]]
== Usage Examples
include::partial$usage/apoc.convert.fromYaml.adoc[]

Original file line number Diff line number Diff line change
Expand Up @@ -118,5 +118,10 @@ apoc.convert.toString(value) \| tries it's best to convert the value to a string
apoc.convert.toStringList(value) \| tries it's best to convert the value to a list of strings
|label:function[]
|label:apoc-core[]
|xref::overview/apoc.convert/apoc.convert.fromYaml.adoc[apoc.convert.fromYaml icon:book[]]

apoc.convert.fromYaml(value, $config) - Deserializes the YAML string to Neo4j value
|label:function[]
|label:apoc-full[]
|===

Original file line number Diff line number Diff line change
Expand Up @@ -676,6 +676,13 @@ apoc.convert.toString(value) \| tries it's best to convert the value to a string
apoc.convert.toStringList(value) \| tries it's best to convert the value to a list of strings
|label:function[]
|label:apoc-core[]

|xref::overview/apoc.convert/apoc.convert.fromYaml.adoc[apoc.convert.fromYaml icon:book[]]

apoc.convert.fromYaml(value, $config) - Deserializes the YAML string to Neo4j value
|label:function[]
|label:apoc-full[]

|===

== xref::overview/apoc.couchbase/index.adoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ This file is generated by DocsTest, so don't change it!
*** xref::overview/apoc.convert/apoc.convert.toSortedJsonMap.adoc[]
*** xref::overview/apoc.convert/apoc.convert.toString.adoc[]
*** xref::overview/apoc.convert/apoc.convert.toStringList.adoc[]
*** xref::overview/apoc.convert/apoc.convert.toYaml.adoc[]
*** xref::overview/apoc.convert/apoc.convert.fromYaml.adoc[]
** xref::overview/apoc.couchbase/index.adoc[]
*** xref::overview/apoc.couchbase/apoc.couchbase.append.adoc[]
*** xref::overview/apoc.couchbase/apoc.couchbase.exists.adoc[]
Expand Down
Loading
Loading