19.17. Batch operations
Execute multiple operations in batch
This lets you execute multiple API calls through a single HTTP call, significantly improving performance for large insert and update operations.
The batch service expects an array of job descriptions as input, each job description describing an action to be performed via the normal server API.
This service is transactional. If any of the operations performed fails (returns a non-2xx HTTP status code), the transaction will be rolled back and all changes will be undone.
Each job description should contain a to
attribute, with a value
relative to the data API root (so http://localhost:7474/db/data/node becomes
just /node), and a method
attribute containing HTTP verb to use.
Optionally you may provide a body
attribute, and an id
attribute to
help you keep track of responses, although responses are guaranteed to be
returned in the same order the job descriptions are received.
The following figure outlines the different parts of the job descriptions:
Example request
-
POST
http://localhost:7474/db/data/batch
-
Accept:
application/json; charset=UTF-8
-
Content-Type:
application/json
[ { "method" : "PUT", "to" : "/node/37/properties", "body" : { "age" : 1 }, "id" : 0 }, { "method" : "GET", "to" : "/node/37", "id" : 1 }, { "method" : "POST", "to" : "/node", "body" : { "age" : 1 }, "id" : 2 }, { "method" : "POST", "to" : "/node", "body" : { "age" : 1 }, "id" : 3 } ]
Example response
-
200:
OK
-
Content-Type:
application/json; charset=UTF-8
[ { "id" : 0, "from" : "/node/37/properties" }, { "id" : 1, "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/37/relationships/out", "labels" : "http://localhost:7474/db/data/node/37/labels", "traverse" : "http://localhost:7474/db/data/node/37/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/37/relationships/all/{-list|&|types}", "self" : "http://localhost:7474/db/data/node/37", "property" : "http://localhost:7474/db/data/node/37/properties/{key}", "properties" : "http://localhost:7474/db/data/node/37/properties", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/37/relationships/out/{-list|&|types}", "incoming_relationships" : "http://localhost:7474/db/data/node/37/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/37/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/37/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/37/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/37/relationships/in/{-list|&|types}", "data" : { "age" : 1 } }, "from" : "/node/37" }, { "id" : 2, "location" : "http://localhost:7474/db/data/node/38", "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/38/relationships/out", "labels" : "http://localhost:7474/db/data/node/38/labels", "traverse" : "http://localhost:7474/db/data/node/38/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/38/relationships/all/{-list|&|types}", "self" : "http://localhost:7474/db/data/node/38", "property" : "http://localhost:7474/db/data/node/38/properties/{key}", "properties" : "http://localhost:7474/db/data/node/38/properties", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/38/relationships/out/{-list|&|types}", "incoming_relationships" : "http://localhost:7474/db/data/node/38/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/38/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/38/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/38/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/38/relationships/in/{-list|&|types}", "data" : { "age" : 1 } }, "from" : "/node" }, { "id" : 3, "location" : "http://localhost:7474/db/data/node/39", "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/39/relationships/out", "labels" : "http://localhost:7474/db/data/node/39/labels", "traverse" : "http://localhost:7474/db/data/node/39/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/39/relationships/all/{-list|&|types}", "self" : "http://localhost:7474/db/data/node/39", "property" : "http://localhost:7474/db/data/node/39/properties/{key}", "properties" : "http://localhost:7474/db/data/node/39/properties", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/39/relationships/out/{-list|&|types}", "incoming_relationships" : "http://localhost:7474/db/data/node/39/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/39/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/39/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/39/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/39/relationships/in/{-list|&|types}", "data" : { "age" : 1 } }, "from" : "/node" } ]
Refer to items created earlier in the same batch job
The batch operation API allows you to refer to the URI returned from a created resource in subsequent job descriptions, within the same batch call.
Use the {[JOB ID]}
special syntax to inject URIs from created resources
into JSON strings in subsequent job descriptions.
Example request
-
POST
http://localhost:7474/db/data/batch
-
Accept:
application/json; charset=UTF-8
-
Content-Type:
application/json
[ { "method" : "POST", "to" : "/node", "id" : 0, "body" : { "name" : "bob" } }, { "method" : "POST", "to" : "/node", "id" : 1, "body" : { "age" : 12 } }, { "method" : "POST", "to" : "{0}/relationships", "id" : 3, "body" : { "to" : "{1}", "data" : { "since" : "2010" }, "type" : "KNOWS" } }, { "method" : "POST", "to" : "/index/relationship/my_rels", "id" : 4, "body" : { "key" : "since", "value" : "2010", "uri" : "{3}" } } ]
Example response
-
200:
OK
-
Content-Type:
application/json; charset=UTF-8
[ { "id" : 0, "location" : "http://localhost:7474/db/data/node/29", "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/29/relationships/out", "labels" : "http://localhost:7474/db/data/node/29/labels", "traverse" : "http://localhost:7474/db/data/node/29/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/29/relationships/all/{-list|&|types}", "self" : "http://localhost:7474/db/data/node/29", "property" : "http://localhost:7474/db/data/node/29/properties/{key}", "properties" : "http://localhost:7474/db/data/node/29/properties", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/29/relationships/out/{-list|&|types}", "incoming_relationships" : "http://localhost:7474/db/data/node/29/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/29/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/29/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/29/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/29/relationships/in/{-list|&|types}", "data" : { "name" : "bob" } }, "from" : "/node" }, { "id" : 1, "location" : "http://localhost:7474/db/data/node/30", "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/30/relationships/out", "labels" : "http://localhost:7474/db/data/node/30/labels", "traverse" : "http://localhost:7474/db/data/node/30/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/30/relationships/all/{-list|&|types}", "self" : "http://localhost:7474/db/data/node/30", "property" : "http://localhost:7474/db/data/node/30/properties/{key}", "properties" : "http://localhost:7474/db/data/node/30/properties", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/30/relationships/out/{-list|&|types}", "incoming_relationships" : "http://localhost:7474/db/data/node/30/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/30/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/30/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/30/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/30/relationships/in/{-list|&|types}", "data" : { "age" : 12 } }, "from" : "/node" }, { "id" : 3, "location" : "http://localhost:7474/db/data/relationship/4", "body" : { "extensions" : { }, "start" : "http://localhost:7474/db/data/node/29", "property" : "http://localhost:7474/db/data/relationship/4/properties/{key}", "self" : "http://localhost:7474/db/data/relationship/4", "properties" : "http://localhost:7474/db/data/relationship/4/properties", "type" : "KNOWS", "end" : "http://localhost:7474/db/data/node/30", "data" : { "since" : "2010" } }, "from" : "http://localhost:7474/db/data/node/29/relationships" }, { "id" : 4, "location" : "http://localhost:7474/db/data/index/relationship/my_rels/since/2010/4", "body" : { "extensions" : { }, "start" : "http://localhost:7474/db/data/node/29", "property" : "http://localhost:7474/db/data/relationship/4/properties/{key}", "self" : "http://localhost:7474/db/data/relationship/4", "properties" : "http://localhost:7474/db/data/relationship/4/properties", "type" : "KNOWS", "end" : "http://localhost:7474/db/data/node/30", "data" : { "since" : "2010" }, "indexed" : "http://localhost:7474/db/data/index/relationship/my_rels/since/2010/4" }, "from" : "/index/relationship/my_rels" } ]
Execute multiple operations in batch streaming
Example request
-
POST
http://localhost:7474/db/data/batch
-
Accept:
application/json
-
Content-Type:
application/json
-
X-Stream:
true
[ { "method" : "PUT", "to" : "/node/411/properties", "body" : { "age" : 1 }, "id" : 0 }, { "method" : "GET", "to" : "/node/411", "id" : 1 }, { "method" : "POST", "to" : "/node", "body" : { "age" : 1 }, "id" : 2 }, { "method" : "POST", "to" : "/node", "body" : { "age" : 1 }, "id" : 3 } ]
Example response
-
200:
OK
-
Content-Type:
application/json; charset=UTF-8
[ { "id" : 0, "from" : "/node/411/properties", "body" : null, "status" : 204 }, { "id" : 1, "from" : "/node/411", "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/411/relationships/out", "labels" : "http://localhost:7474/db/data/node/411/labels", "traverse" : "http://localhost:7474/db/data/node/411/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/411/relationships/all/{-list|&|types}", "self" : "http://localhost:7474/db/data/node/411", "property" : "http://localhost:7474/db/data/node/411/properties/{key}", "properties" : "http://localhost:7474/db/data/node/411/properties", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/411/relationships/out/{-list|&|types}", "incoming_relationships" : "http://localhost:7474/db/data/node/411/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/411/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/411/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/411/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/411/relationships/in/{-list|&|types}", "data" : { "age" : 1 } }, "status" : 200 }, { "id" : 2, "from" : "/node", "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/412/relationships/out", "labels" : "http://localhost:7474/db/data/node/412/labels", "traverse" : "http://localhost:7474/db/data/node/412/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/412/relationships/all/{-list|&|types}", "self" : "http://localhost:7474/db/data/node/412", "property" : "http://localhost:7474/db/data/node/412/properties/{key}", "properties" : "http://localhost:7474/db/data/node/412/properties", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/412/relationships/out/{-list|&|types}", "incoming_relationships" : "http://localhost:7474/db/data/node/412/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/412/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/412/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/412/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/412/relationships/in/{-list|&|types}", "data" : { "age" : 1 } }, "location" : "http://localhost:7474/db/data/node/412", "status" : 201 }, { "id" : 3, "from" : "/node", "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/413/relationships/out", "labels" : "http://localhost:7474/db/data/node/413/labels", "traverse" : "http://localhost:7474/db/data/node/413/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/413/relationships/all/{-list|&|types}", "self" : "http://localhost:7474/db/data/node/413", "property" : "http://localhost:7474/db/data/node/413/properties/{key}", "properties" : "http://localhost:7474/db/data/node/413/properties", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/413/relationships/out/{-list|&|types}", "incoming_relationships" : "http://localhost:7474/db/data/node/413/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/413/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/413/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/413/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/413/relationships/in/{-list|&|types}", "data" : { "age" : 1 } }, "location" : "http://localhost:7474/db/data/node/413", "status" : 201 } ]