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:

Figure 19.67. Final Graph

Example request

POST http://localhost:7474/db/data/batch
Accept: application/json; charset=UTF-8
Content-Type: application/json

[ {
  "method" : "PUT",
  "to" : "/node/31/properties",
  "body" : {
    "age" : 1
  },
  "id" : 0
}, {
  "method" : "GET",
  "to" : "/node/31",
  "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/31/properties"
}, {
  "id" : 1,
  "body" : {
    "extensions" : {
    },
    "paged_traverse" : "http://localhost:7474/db/data/node/31/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "labels" : "http://localhost:7474/db/data/node/31/labels",
    "outgoing_relationships" : "http://localhost:7474/db/data/node/31/relationships/out",
    "traverse" : "http://localhost:7474/db/data/node/31/traverse/{returnType}",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/31/relationships/all/{-list|&|types}",
    "property" : "http://localhost:7474/db/data/node/31/properties/{key}",
    "all_relationships" : "http://localhost:7474/db/data/node/31/relationships/all",
    "self" : "http://localhost:7474/db/data/node/31",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/31/relationships/out/{-list|&|types}",
    "properties" : "http://localhost:7474/db/data/node/31/properties",
    "incoming_relationships" : "http://localhost:7474/db/data/node/31/relationships/in",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/31/relationships/in/{-list|&|types}",
    "create_relationship" : "http://localhost:7474/db/data/node/31/relationships",
    "data" : {
      "age" : 1
    }
  },
  "from" : "/node/31"
}, {
  "id" : 2,
  "location" : "http://localhost:7474/db/data/node/32",
  "body" : {
    "extensions" : {
    },
    "paged_traverse" : "http://localhost:7474/db/data/node/32/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "labels" : "http://localhost:7474/db/data/node/32/labels",
    "outgoing_relationships" : "http://localhost:7474/db/data/node/32/relationships/out",
    "traverse" : "http://localhost:7474/db/data/node/32/traverse/{returnType}",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/32/relationships/all/{-list|&|types}",
    "property" : "http://localhost:7474/db/data/node/32/properties/{key}",
    "all_relationships" : "http://localhost:7474/db/data/node/32/relationships/all",
    "self" : "http://localhost:7474/db/data/node/32",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/32/relationships/out/{-list|&|types}",
    "properties" : "http://localhost:7474/db/data/node/32/properties",
    "incoming_relationships" : "http://localhost:7474/db/data/node/32/relationships/in",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/32/relationships/in/{-list|&|types}",
    "create_relationship" : "http://localhost:7474/db/data/node/32/relationships",
    "data" : {
      "age" : 1
    }
  },
  "from" : "/node"
}, {
  "id" : 3,
  "location" : "http://localhost:7474/db/data/node/33",
  "body" : {
    "extensions" : {
    },
    "paged_traverse" : "http://localhost:7474/db/data/node/33/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "labels" : "http://localhost:7474/db/data/node/33/labels",
    "outgoing_relationships" : "http://localhost:7474/db/data/node/33/relationships/out",
    "traverse" : "http://localhost:7474/db/data/node/33/traverse/{returnType}",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/33/relationships/all/{-list|&|types}",
    "property" : "http://localhost:7474/db/data/node/33/properties/{key}",
    "all_relationships" : "http://localhost:7474/db/data/node/33/relationships/all",
    "self" : "http://localhost:7474/db/data/node/33",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/33/relationships/out/{-list|&|types}",
    "properties" : "http://localhost:7474/db/data/node/33/properties",
    "incoming_relationships" : "http://localhost:7474/db/data/node/33/relationships/in",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/33/relationships/in/{-list|&|types}",
    "create_relationship" : "http://localhost:7474/db/data/node/33/relationships",
    "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.

Figure 19.68. Final Graph

Final-Graph-Refer-to-items-created-earlier-in-the-same-batch-job.svg

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/23",
  "body" : {
    "extensions" : {
    },
    "paged_traverse" : "http://localhost:7474/db/data/node/23/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "labels" : "http://localhost:7474/db/data/node/23/labels",
    "outgoing_relationships" : "http://localhost:7474/db/data/node/23/relationships/out",
    "traverse" : "http://localhost:7474/db/data/node/23/traverse/{returnType}",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/23/relationships/all/{-list|&|types}",
    "property" : "http://localhost:7474/db/data/node/23/properties/{key}",
    "all_relationships" : "http://localhost:7474/db/data/node/23/relationships/all",
    "self" : "http://localhost:7474/db/data/node/23",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/23/relationships/out/{-list|&|types}",
    "properties" : "http://localhost:7474/db/data/node/23/properties",
    "incoming_relationships" : "http://localhost:7474/db/data/node/23/relationships/in",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/23/relationships/in/{-list|&|types}",
    "create_relationship" : "http://localhost:7474/db/data/node/23/relationships",
    "data" : {
      "name" : "bob"
    }
  },
  "from" : "/node"
}, {
  "id" : 1,
  "location" : "http://localhost:7474/db/data/node/24",
  "body" : {
    "extensions" : {
    },
    "paged_traverse" : "http://localhost:7474/db/data/node/24/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "labels" : "http://localhost:7474/db/data/node/24/labels",
    "outgoing_relationships" : "http://localhost:7474/db/data/node/24/relationships/out",
    "traverse" : "http://localhost:7474/db/data/node/24/traverse/{returnType}",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/24/relationships/all/{-list|&|types}",
    "property" : "http://localhost:7474/db/data/node/24/properties/{key}",
    "all_relationships" : "http://localhost:7474/db/data/node/24/relationships/all",
    "self" : "http://localhost:7474/db/data/node/24",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/24/relationships/out/{-list|&|types}",
    "properties" : "http://localhost:7474/db/data/node/24/properties",
    "incoming_relationships" : "http://localhost:7474/db/data/node/24/relationships/in",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/24/relationships/in/{-list|&|types}",
    "create_relationship" : "http://localhost:7474/db/data/node/24/relationships",
    "data" : {
      "age" : 12
    }
  },
  "from" : "/node"
}, {
  "id" : 3,
  "location" : "http://localhost:7474/db/data/relationship/3",
  "body" : {
    "extensions" : {
    },
    "start" : "http://localhost:7474/db/data/node/23",
    "property" : "http://localhost:7474/db/data/relationship/3/properties/{key}",
    "self" : "http://localhost:7474/db/data/relationship/3",
    "properties" : "http://localhost:7474/db/data/relationship/3/properties",
    "type" : "KNOWS",
    "end" : "http://localhost:7474/db/data/node/24",
    "data" : {
      "since" : "2010"
    }
  },
  "from" : "http://localhost:7474/db/data/node/23/relationships"
}, {
  "id" : 4,
  "location" : "http://localhost:7474/db/data/index/relationship/my_rels/since/2010/3",
  "body" : {
    "extensions" : {
    },
    "start" : "http://localhost:7474/db/data/node/23",
    "property" : "http://localhost:7474/db/data/relationship/3/properties/{key}",
    "self" : "http://localhost:7474/db/data/relationship/3",
    "properties" : "http://localhost:7474/db/data/relationship/3/properties",
    "type" : "KNOWS",
    "end" : "http://localhost:7474/db/data/node/24",
    "data" : {
      "since" : "2010"
    },
    "indexed" : "http://localhost:7474/db/data/index/relationship/my_rels/since/2010/3"
  },
  "from" : "/index/relationship/my_rels"
} ]

Execute multiple operations in batch streaming

Figure 19.69. Final Graph

Example request

POST http://localhost:7474/db/data/batch
Accept: application/json
Content-Type: application/json
X-Stream: true

[ {
  "method" : "PUT",
  "to" : "/node/100/properties",
  "body" : {
    "age" : 1
  },
  "id" : 0
}, {
  "method" : "GET",
  "to" : "/node/100",
  "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/100/properties",
  "body" : null,
  "status" : 204
}, {
  "id" : 1,
  "from" : "/node/100",
  "body" : {
    "extensions" : {
    },
    "paged_traverse" : "http://localhost:7474/db/data/node/100/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "labels" : "http://localhost:7474/db/data/node/100/labels",
    "outgoing_relationships" : "http://localhost:7474/db/data/node/100/relationships/out",
    "traverse" : "http://localhost:7474/db/data/node/100/traverse/{returnType}",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/100/relationships/all/{-list|&|types}",
    "property" : "http://localhost:7474/db/data/node/100/properties/{key}",
    "all_relationships" : "http://localhost:7474/db/data/node/100/relationships/all",
    "self" : "http://localhost:7474/db/data/node/100",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/100/relationships/out/{-list|&|types}",
    "properties" : "http://localhost:7474/db/data/node/100/properties",
    "incoming_relationships" : "http://localhost:7474/db/data/node/100/relationships/in",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/100/relationships/in/{-list|&|types}",
    "create_relationship" : "http://localhost:7474/db/data/node/100/relationships",
    "data" : {
      "age" : 1
    }
  },
  "status" : 200
}, {
  "id" : 2,
  "from" : "/node",
  "body" : {
    "extensions" : {
    },
    "paged_traverse" : "http://localhost:7474/db/data/node/101/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "labels" : "http://localhost:7474/db/data/node/101/labels",
    "outgoing_relationships" : "http://localhost:7474/db/data/node/101/relationships/out",
    "traverse" : "http://localhost:7474/db/data/node/101/traverse/{returnType}",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/101/relationships/all/{-list|&|types}",
    "property" : "http://localhost:7474/db/data/node/101/properties/{key}",
    "all_relationships" : "http://localhost:7474/db/data/node/101/relationships/all",
    "self" : "http://localhost:7474/db/data/node/101",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/101/relationships/out/{-list|&|types}",
    "properties" : "http://localhost:7474/db/data/node/101/properties",
    "incoming_relationships" : "http://localhost:7474/db/data/node/101/relationships/in",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/101/relationships/in/{-list|&|types}",
    "create_relationship" : "http://localhost:7474/db/data/node/101/relationships",
    "data" : {
      "age" : 1
    }
  },
  "location" : "http://localhost:7474/db/data/node/101",
  "status" : 201
}, {
  "id" : 3,
  "from" : "/node",
  "body" : {
    "extensions" : {
    },
    "paged_traverse" : "http://localhost:7474/db/data/node/102/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "labels" : "http://localhost:7474/db/data/node/102/labels",
    "outgoing_relationships" : "http://localhost:7474/db/data/node/102/relationships/out",
    "traverse" : "http://localhost:7474/db/data/node/102/traverse/{returnType}",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/102/relationships/all/{-list|&|types}",
    "property" : "http://localhost:7474/db/data/node/102/properties/{key}",
    "all_relationships" : "http://localhost:7474/db/data/node/102/relationships/all",
    "self" : "http://localhost:7474/db/data/node/102",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/102/relationships/out/{-list|&|types}",
    "properties" : "http://localhost:7474/db/data/node/102/properties",
    "incoming_relationships" : "http://localhost:7474/db/data/node/102/relationships/in",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/102/relationships/in/{-list|&|types}",
    "create_relationship" : "http://localhost:7474/db/data/node/102/relationships",
    "data" : {
      "age" : 1
    }
  },
  "location" : "http://localhost:7474/db/data/node/102",
  "status" : 201
} ]

The Neo4j Manual v2.0.219.17. Batch operations