21.17. Batch operations

Note: You cannot use this resource to execute Cypher queries with USING PERIODIC COMMIT.

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

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

Execute multiple operations in batch streaming

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