Skip to content

Commit

Permalink
Tweak docs wording for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
JMHReif authored Apr 11, 2022
1 parent e2cb0cc commit 0c03265
Showing 1 changed file with 8 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ This procedure supports the following config parameters:
| relPropertyMappings | Map | `{}` | The mapping rel type/property name/property type for Custom Neo4j types (point date). I.e. { KNOWS: { since: 'Datetime' } }
| compression | `Enum[NONE, BYTES, GZIP, BZIP2, DEFLATE, BLOCK_LZ4, FRAMED_SNAPPY]` | `null` | Allow taking binary data, either not compressed (value: `NONE`) or compressed (other values)
See the xref::overview/apoc.load/apoc.load.csv.adoc#_binary_file[Binary file example]
| nodePropFilter | Map<String, List<String>> | `{}` | A map with key the labels, and value the list of properties keys to filter during the import.
For example `{ User: ['name', 'surname'], Another: ['foo']}` will skip the properties name and surname of nodes with label User, the property foo of (:Another) nodes. +
Note that if a node has multiple labels, in this example (:User:Another {}), will be filtered all properties of both labels, that is 'name', 'surname' and 'foo'. +
We can also pass a key `_all` to filter properties of all nodes, for example `{_all: ['myProp']}`
| relPropFilter | Map<String, List<String>> | `{}` | A map with key the rel-types, and value the list of properties keys to filter during the import.
For example `{ MY_REL: ['foo', 'baz'] }` will skip the properties name and surname of nodes with label User, the properties foo and baz of [:MY_REL] relationship. +
We can also pass a key `_all` to filter properties of all relationships, for example `{_all: ['myProp']}`
| nodePropFilter | Map<String, List<String>> | `{}` | A map with the labels as keys, and the values containing the list of property keys to filter during the import.
For example `{ User: ['name', 'surname'], Another: ['foo']}` will skip the properties name and surname of nodes with label User, and the property foo of (:Another) nodes. +
Note that if a node has multiple labels, as in this example (:User:Another {}), all specified properties of both labels will be filtered ('name', 'surname' and 'foo'). +
We can also pass a key `_all` to filter properties for all nodes, for example `{_all: ['myProp']}`
| relPropFilter | Map<String, List<String>> | `{}` | A map with the relationship types as keys, and the values containing the list of property keys to filter during the import.
For example `{ MY_REL: ['foo', 'baz'] }` will skip the properties `foo` and `baz` of `[:MY_REL]` relationship. +
We can also pass a key `_all` to filter properties of all relationships, for example `{_all: ['myProp']}`.
|===

`nodePropertyMappings` and `relPropertyMappings` support the following Neo4j types:
Expand All @@ -28,4 +28,4 @@ We can also pass a key `_all` to filter properties of all relationships, for exa
* Localdatetime
* Duration
* offsettime
* Zoneddatetime
* Zoneddatetime

0 comments on commit 0c03265

Please sign in to comment.