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
Content-Type:
application/json
[ { "method" : "PUT", "to" : "/node/239/properties", "body" : { "age" : 1 }, "id" : 0 }, { "method" : "GET", "to" : "/node/239", "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
[ { "id" : 0, "from" : "/node/239/properties" }, { "id" : 1, "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/239/relationships/out", "labels" : "http://localhost:7474/db/data/node/239/labels", "all_typed_relationships" : "http://localhost:7474/db/data/node/239/relationships/all/{-list|&|types}", "traverse" : "http://localhost:7474/db/data/node/239/traverse/{returnType}", "self" : "http://localhost:7474/db/data/node/239", "property" : "http://localhost:7474/db/data/node/239/properties/{key}", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/239/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/239/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/239/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/239/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/239/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/239/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/239/relationships/in/{-list|&|types}", "data" : { "age" : 1 } }, "from" : "/node/239" }, { "id" : 2, "location" : "http://localhost:7474/db/data/node/240", "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/240/relationships/out", "labels" : "http://localhost:7474/db/data/node/240/labels", "all_typed_relationships" : "http://localhost:7474/db/data/node/240/relationships/all/{-list|&|types}", "traverse" : "http://localhost:7474/db/data/node/240/traverse/{returnType}", "self" : "http://localhost:7474/db/data/node/240", "property" : "http://localhost:7474/db/data/node/240/properties/{key}", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/240/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/240/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/240/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/240/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/240/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/240/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/240/relationships/in/{-list|&|types}", "data" : { "age" : 1 } }, "from" : "/node" }, { "id" : 3, "location" : "http://localhost:7474/db/data/node/241", "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/241/relationships/out", "labels" : "http://localhost:7474/db/data/node/241/labels", "all_typed_relationships" : "http://localhost:7474/db/data/node/241/relationships/all/{-list|&|types}", "traverse" : "http://localhost:7474/db/data/node/241/traverse/{returnType}", "self" : "http://localhost:7474/db/data/node/241", "property" : "http://localhost:7474/db/data/node/241/properties/{key}", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/241/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/241/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/241/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/241/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/241/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/241/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/241/relationships/in/{-list|&|types}", "data" : { "age" : 1 } }, "from" : "/node" } ]
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
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
[ { "id" : 0, "location" : "http://localhost:7474/db/data/node/232", "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/232/relationships/out", "labels" : "http://localhost:7474/db/data/node/232/labels", "all_typed_relationships" : "http://localhost:7474/db/data/node/232/relationships/all/{-list|&|types}", "traverse" : "http://localhost:7474/db/data/node/232/traverse/{returnType}", "self" : "http://localhost:7474/db/data/node/232", "property" : "http://localhost:7474/db/data/node/232/properties/{key}", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/232/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/232/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/232/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/232/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/232/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/232/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/232/relationships/in/{-list|&|types}", "data" : { "name" : "bob" } }, "from" : "/node" }, { "id" : 1, "location" : "http://localhost:7474/db/data/node/233", "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/233/relationships/out", "labels" : "http://localhost:7474/db/data/node/233/labels", "all_typed_relationships" : "http://localhost:7474/db/data/node/233/relationships/all/{-list|&|types}", "traverse" : "http://localhost:7474/db/data/node/233/traverse/{returnType}", "self" : "http://localhost:7474/db/data/node/233", "property" : "http://localhost:7474/db/data/node/233/properties/{key}", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/233/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/233/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/233/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/233/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/233/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/233/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/233/relationships/in/{-list|&|types}", "data" : { "age" : 12 } }, "from" : "/node" }, { "id" : 3, "location" : "http://localhost:7474/db/data/relationship/143", "body" : { "extensions" : { }, "start" : "http://localhost:7474/db/data/node/232", "property" : "http://localhost:7474/db/data/relationship/143/properties/{key}", "self" : "http://localhost:7474/db/data/relationship/143", "properties" : "http://localhost:7474/db/data/relationship/143/properties", "type" : "KNOWS", "end" : "http://localhost:7474/db/data/node/233", "data" : { "since" : "2010" } }, "from" : "http://localhost:7474/db/data/node/232/relationships" }, { "id" : 4, "location" : "http://localhost:7474/db/data/index/relationship/my_rels/since/2010/143", "body" : { "extensions" : { }, "start" : "http://localhost:7474/db/data/node/232", "property" : "http://localhost:7474/db/data/relationship/143/properties/{key}", "self" : "http://localhost:7474/db/data/relationship/143", "properties" : "http://localhost:7474/db/data/relationship/143/properties", "type" : "KNOWS", "end" : "http://localhost:7474/db/data/node/233", "data" : { "since" : "2010" }, "indexed" : "http://localhost:7474/db/data/index/relationship/my_rels/since/2010/143" }, "from" : "/index/relationship/my_rels" } ]
Example request
POST
http://localhost:7474/db/data/batch
Accept:
application/json
Content-Type:
application/json
X-Stream:
true
[ { "method" : "PUT", "to" : "/node/62/properties", "body" : { "age" : 1 }, "id" : 0 }, { "method" : "GET", "to" : "/node/62", "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
[ { "id" : 0, "from" : "/node/62/properties", "body" : null, "status" : 204 }, { "id" : 1, "from" : "/node/62", "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/62/relationships/out", "labels" : "http://localhost:7474/db/data/node/62/labels", "all_typed_relationships" : "http://localhost:7474/db/data/node/62/relationships/all/{-list|&|types}", "traverse" : "http://localhost:7474/db/data/node/62/traverse/{returnType}", "self" : "http://localhost:7474/db/data/node/62", "property" : "http://localhost:7474/db/data/node/62/properties/{key}", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/62/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/62/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/62/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/62/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/62/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/62/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/62/relationships/in/{-list|&|types}", "data" : { "age" : 1 } }, "status" : 200 }, { "id" : 2, "from" : "/node", "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/63/relationships/out", "labels" : "http://localhost:7474/db/data/node/63/labels", "all_typed_relationships" : "http://localhost:7474/db/data/node/63/relationships/all/{-list|&|types}", "traverse" : "http://localhost:7474/db/data/node/63/traverse/{returnType}", "self" : "http://localhost:7474/db/data/node/63", "property" : "http://localhost:7474/db/data/node/63/properties/{key}", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/63/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/63/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/63/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/63/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/63/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/63/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/63/relationships/in/{-list|&|types}", "data" : { "age" : 1 } }, "location" : "http://localhost:7474/db/data/node/63", "status" : 201 }, { "id" : 3, "from" : "/node", "body" : { "extensions" : { }, "outgoing_relationships" : "http://localhost:7474/db/data/node/64/relationships/out", "labels" : "http://localhost:7474/db/data/node/64/labels", "all_typed_relationships" : "http://localhost:7474/db/data/node/64/relationships/all/{-list|&|types}", "traverse" : "http://localhost:7474/db/data/node/64/traverse/{returnType}", "self" : "http://localhost:7474/db/data/node/64", "property" : "http://localhost:7474/db/data/node/64/properties/{key}", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/64/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/64/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/64/relationships/in", "create_relationship" : "http://localhost:7474/db/data/node/64/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/64/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/64/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/64/relationships/in/{-list|&|types}", "data" : { "age" : 1 } }, "location" : "http://localhost:7474/db/data/node/64", "status" : 201 } ]
Copyright © 2013 Neo Technology