21.19. 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.70. 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/83/properties",
  "body" : {
    "age" : 1
  },
  "id" : 0
}, {
  "method" : "GET",
  "to" : "/node/83",
  "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/83/properties"
}, {
  "id" : 1,
  "body" : {
    "extensions" : { },
    "outgoing_relationships" : "http://localhost:7474/db/data/node/83/relationships/out",
    "labels" : "http://localhost:7474/db/data/node/83/labels",
    "traverse" : "http://localhost:7474/db/data/node/83/traverse/{returnType}",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/83/relationships/all/{-list|&|types}",
    "self" : "http://localhost:7474/db/data/node/83",
    "property" : "http://localhost:7474/db/data/node/83/properties/{key}",
    "properties" : "http://localhost:7474/db/data/node/83/properties",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/83/relationships/out/{-list|&|types}",
    "incoming_relationships" : "http://localhost:7474/db/data/node/83/relationships/in",
    "create_relationship" : "http://localhost:7474/db/data/node/83/relationships",
    "paged_traverse" : "http://localhost:7474/db/data/node/83/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "all_relationships" : "http://localhost:7474/db/data/node/83/relationships/all",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/83/relationships/in/{-list|&|types}",
    "metadata" : {
      "id" : 83,
      "labels" : [ ]
    },
    "data" : {
      "age" : 1
    }
  },
  "from" : "/node/83"
}, {
  "id" : 2,
  "location" : "http://localhost:7474/db/data/node/84",
  "body" : {
    "extensions" : { },
    "outgoing_relationships" : "http://localhost:7474/db/data/node/84/relationships/out",
    "labels" : "http://localhost:7474/db/data/node/84/labels",
    "traverse" : "http://localhost:7474/db/data/node/84/traverse/{returnType}",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/84/relationships/all/{-list|&|types}",
    "self" : "http://localhost:7474/db/data/node/84",
    "property" : "http://localhost:7474/db/data/node/84/properties/{key}",
    "properties" : "http://localhost:7474/db/data/node/84/properties",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/84/relationships/out/{-list|&|types}",
    "incoming_relationships" : "http://localhost:7474/db/data/node/84/relationships/in",
    "create_relationship" : "http://localhost:7474/db/data/node/84/relationships",
    "paged_traverse" : "http://localhost:7474/db/data/node/84/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "all_relationships" : "http://localhost:7474/db/data/node/84/relationships/all",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/84/relationships/in/{-list|&|types}",
    "metadata" : {
      "id" : 84,
      "labels" : [ ]
    },
    "data" : {
      "age" : 1
    }
  },
  "from" : "/node"
}, {
  "id" : 3,
  "location" : "http://localhost:7474/db/data/node/85",
  "body" : {
    "extensions" : { },
    "outgoing_relationships" : "http://localhost:7474/db/data/node/85/relationships/out",
    "labels" : "http://localhost:7474/db/data/node/85/labels",
    "traverse" : "http://localhost:7474/db/data/node/85/traverse/{returnType}",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/85/relationships/all/{-list|&|types}",
    "self" : "http://localhost:7474/db/data/node/85",
    "property" : "http://localhost:7474/db/data/node/85/properties/{key}",
    "properties" : "http://localhost:7474/db/data/node/85/properties",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/85/relationships/out/{-list|&|types}",
    "incoming_relationships" : "http://localhost:7474/db/data/node/85/relationships/in",
    "create_relationship" : "http://localhost:7474/db/data/node/85/relationships",
    "paged_traverse" : "http://localhost:7474/db/data/node/85/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "all_relationships" : "http://localhost:7474/db/data/node/85/relationships/all",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/85/relationships/in/{-list|&|types}",
    "metadata" : {
      "id" : 85,
      "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.71. 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/75",
  "body" : {
    "extensions" : { },
    "outgoing_relationships" : "http://localhost:7474/db/data/node/75/relationships/out",
    "labels" : "http://localhost:7474/db/data/node/75/labels",
    "traverse" : "http://localhost:7474/db/data/node/75/traverse/{returnType}",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/75/relationships/all/{-list|&|types}",
    "self" : "http://localhost:7474/db/data/node/75",
    "property" : "http://localhost:7474/db/data/node/75/properties/{key}",
    "properties" : "http://localhost:7474/db/data/node/75/properties",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/75/relationships/out/{-list|&|types}",
    "incoming_relationships" : "http://localhost:7474/db/data/node/75/relationships/in",
    "create_relationship" : "http://localhost:7474/db/data/node/75/relationships",
    "paged_traverse" : "http://localhost:7474/db/data/node/75/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "all_relationships" : "http://localhost:7474/db/data/node/75/relationships/all",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/75/relationships/in/{-list|&|types}",
    "metadata" : {
      "id" : 75,
      "labels" : [ ]
    },
    "data" : {
      "name" : "bob"
    }
  },
  "from" : "/node"
}, {
  "id" : 1,
  "location" : "http://localhost:7474/db/data/node/76",
  "body" : {
    "extensions" : { },
    "outgoing_relationships" : "http://localhost:7474/db/data/node/76/relationships/out",
    "labels" : "http://localhost:7474/db/data/node/76/labels",
    "traverse" : "http://localhost:7474/db/data/node/76/traverse/{returnType}",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/76/relationships/all/{-list|&|types}",
    "self" : "http://localhost:7474/db/data/node/76",
    "property" : "http://localhost:7474/db/data/node/76/properties/{key}",
    "properties" : "http://localhost:7474/db/data/node/76/properties",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/76/relationships/out/{-list|&|types}",
    "incoming_relationships" : "http://localhost:7474/db/data/node/76/relationships/in",
    "create_relationship" : "http://localhost:7474/db/data/node/76/relationships",
    "paged_traverse" : "http://localhost:7474/db/data/node/76/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "all_relationships" : "http://localhost:7474/db/data/node/76/relationships/all",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/76/relationships/in/{-list|&|types}",
    "metadata" : {
      "id" : 76,
      "labels" : [ ]
    },
    "data" : {
      "age" : 12
    }
  },
  "from" : "/node"
}, {
  "id" : 3,
  "location" : "http://localhost:7474/db/data/relationship/58",
  "body" : {
    "extensions" : { },
    "start" : "http://localhost:7474/db/data/node/75",
    "property" : "http://localhost:7474/db/data/relationship/58/properties/{key}",
    "self" : "http://localhost:7474/db/data/relationship/58",
    "properties" : "http://localhost:7474/db/data/relationship/58/properties",
    "type" : "KNOWS",
    "end" : "http://localhost:7474/db/data/node/76",
    "metadata" : {
      "id" : 58,
      "type" : "KNOWS"
    },
    "data" : {
      "since" : "2010"
    }
  },
  "from" : "http://localhost:7474/db/data/node/75/relationships"
}, {
  "id" : 4,
  "location" : "http://localhost:7474/db/data/index/relationship/my_rels/since/2010/58",
  "body" : {
    "extensions" : { },
    "start" : "http://localhost:7474/db/data/node/75",
    "property" : "http://localhost:7474/db/data/relationship/58/properties/{key}",
    "self" : "http://localhost:7474/db/data/relationship/58",
    "properties" : "http://localhost:7474/db/data/relationship/58/properties",
    "type" : "KNOWS",
    "end" : "http://localhost:7474/db/data/node/76",
    "metadata" : {
      "id" : 58,
      "type" : "KNOWS"
    },
    "data" : {
      "since" : "2010"
    },
    "indexed" : "http://localhost:7474/db/data/index/relationship/my_rels/since/2010/58"
  },
  "from" : "/index/relationship/my_rels"
} ]

Execute multiple operations in batch streaming

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