19.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:

batch-request-api.png

Figure 19.67. Final Graph

Final-Graph-Execute-multiple-operations-in-batch.svg

Example request

  • POST http://localhost:7474/db/data/batch
  • Accept: application/json; charset=UTF-8
  • Content-Type: application/json 
[ {
  "method" : "PUT",
  "to" : "/node/351/properties",
  "body" : {
    "age" : 1
  },
  "id" : 0
}, {
  "method" : "GET",
  "to" : "/node/351",
  "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/351/properties"
}, {
  "id" : 1,
  "body" : {
    "extensions" : {
    },
    "outgoing_relationships" : "http://localhost:7474/db/data/node/351/relationships/out",
    "labels" : "http://localhost:7474/db/data/node/351/labels",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/351/relationships/all/{-list|&|types}",
    "traverse" : "http://localhost:7474/db/data/node/351/traverse/{returnType}",
    "self" : "http://localhost:7474/db/data/node/351",
    "property" : "http://localhost:7474/db/data/node/351/properties/{key}",
    "properties" : "http://localhost:7474/db/data/node/351/properties",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/351/relationships/out/{-list|&|types}",
    "incoming_relationships" : "http://localhost:7474/db/data/node/351/relationships/in",
    "create_relationship" : "http://localhost:7474/db/data/node/351/relationships",
    "paged_traverse" : "http://localhost:7474/db/data/node/351/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "all_relationships" : "http://localhost:7474/db/data/node/351/relationships/all",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/351/relationships/in/{-list|&|types}",
    "metadata" : {
      "id" : 351,
      "labels" : [ ]
    },
    "data" : {
      "age" : 1
    }
  },
  "from" : "/node/351"
}, {
  "id" : 2,
  "location" : "http://localhost:7474/db/data/node/352",
  "body" : {
    "extensions" : {
    },
    "outgoing_relationships" : "http://localhost:7474/db/data/node/352/relationships/out",
    "labels" : "http://localhost:7474/db/data/node/352/labels",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/352/relationships/all/{-list|&|types}",
    "traverse" : "http://localhost:7474/db/data/node/352/traverse/{returnType}",
    "self" : "http://localhost:7474/db/data/node/352",
    "property" : "http://localhost:7474/db/data/node/352/properties/{key}",
    "properties" : "http://localhost:7474/db/data/node/352/properties",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/352/relationships/out/{-list|&|types}",
    "incoming_relationships" : "http://localhost:7474/db/data/node/352/relationships/in",
    "create_relationship" : "http://localhost:7474/db/data/node/352/relationships",
    "paged_traverse" : "http://localhost:7474/db/data/node/352/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "all_relationships" : "http://localhost:7474/db/data/node/352/relationships/all",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/352/relationships/in/{-list|&|types}",
    "metadata" : {
      "id" : 352,
      "labels" : [ ]
    },
    "data" : {
      "age" : 1
    }
  },
  "from" : "/node"
}, {
  "id" : 3,
  "location" : "http://localhost:7474/db/data/node/353",
  "body" : {
    "extensions" : {
    },
    "outgoing_relationships" : "http://localhost:7474/db/data/node/353/relationships/out",
    "labels" : "http://localhost:7474/db/data/node/353/labels",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/353/relationships/all/{-list|&|types}",
    "traverse" : "http://localhost:7474/db/data/node/353/traverse/{returnType}",
    "self" : "http://localhost:7474/db/data/node/353",
    "property" : "http://localhost:7474/db/data/node/353/properties/{key}",
    "properties" : "http://localhost:7474/db/data/node/353/properties",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/353/relationships/out/{-list|&|types}",
    "incoming_relationships" : "http://localhost:7474/db/data/node/353/relationships/in",
    "create_relationship" : "http://localhost:7474/db/data/node/353/relationships",
    "paged_traverse" : "http://localhost:7474/db/data/node/353/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "all_relationships" : "http://localhost:7474/db/data/node/353/relationships/all",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/353/relationships/in/{-list|&|types}",
    "metadata" : {
      "id" : 353,
      "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 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/343",
  "body" : {
    "extensions" : {
    },
    "outgoing_relationships" : "http://localhost:7474/db/data/node/343/relationships/out",
    "labels" : "http://localhost:7474/db/data/node/343/labels",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/343/relationships/all/{-list|&|types}",
    "traverse" : "http://localhost:7474/db/data/node/343/traverse/{returnType}",
    "self" : "http://localhost:7474/db/data/node/343",
    "property" : "http://localhost:7474/db/data/node/343/properties/{key}",
    "properties" : "http://localhost:7474/db/data/node/343/properties",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/343/relationships/out/{-list|&|types}",
    "incoming_relationships" : "http://localhost:7474/db/data/node/343/relationships/in",
    "create_relationship" : "http://localhost:7474/db/data/node/343/relationships",
    "paged_traverse" : "http://localhost:7474/db/data/node/343/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "all_relationships" : "http://localhost:7474/db/data/node/343/relationships/all",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/343/relationships/in/{-list|&|types}",
    "metadata" : {
      "id" : 343,
      "labels" : [ ]
    },
    "data" : {
      "name" : "bob"
    }
  },
  "from" : "/node"
}, {
  "id" : 1,
  "location" : "http://localhost:7474/db/data/node/344",
  "body" : {
    "extensions" : {
    },
    "outgoing_relationships" : "http://localhost:7474/db/data/node/344/relationships/out",
    "labels" : "http://localhost:7474/db/data/node/344/labels",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/344/relationships/all/{-list|&|types}",
    "traverse" : "http://localhost:7474/db/data/node/344/traverse/{returnType}",
    "self" : "http://localhost:7474/db/data/node/344",
    "property" : "http://localhost:7474/db/data/node/344/properties/{key}",
    "properties" : "http://localhost:7474/db/data/node/344/properties",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/344/relationships/out/{-list|&|types}",
    "incoming_relationships" : "http://localhost:7474/db/data/node/344/relationships/in",
    "create_relationship" : "http://localhost:7474/db/data/node/344/relationships",
    "paged_traverse" : "http://localhost:7474/db/data/node/344/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "all_relationships" : "http://localhost:7474/db/data/node/344/relationships/all",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/344/relationships/in/{-list|&|types}",
    "metadata" : {
      "id" : 344,
      "labels" : [ ]
    },
    "data" : {
      "age" : 12
    }
  },
  "from" : "/node"
}, {
  "id" : 3,
  "location" : "http://localhost:7474/db/data/relationship/202",
  "body" : {
    "extensions" : {
    },
    "start" : "http://localhost:7474/db/data/node/343",
    "property" : "http://localhost:7474/db/data/relationship/202/properties/{key}",
    "self" : "http://localhost:7474/db/data/relationship/202",
    "properties" : "http://localhost:7474/db/data/relationship/202/properties",
    "type" : "KNOWS",
    "end" : "http://localhost:7474/db/data/node/344",
    "metadata" : {
      "id" : 202,
      "type" : "KNOWS"
    },
    "data" : {
      "since" : "2010"
    }
  },
  "from" : "http://localhost:7474/db/data/node/343/relationships"
}, {
  "id" : 4,
  "location" : "http://localhost:7474/db/data/index/relationship/my_rels/since/2010/202",
  "body" : {
    "extensions" : {
    },
    "start" : "http://localhost:7474/db/data/node/343",
    "property" : "http://localhost:7474/db/data/relationship/202/properties/{key}",
    "self" : "http://localhost:7474/db/data/relationship/202",
    "properties" : "http://localhost:7474/db/data/relationship/202/properties",
    "type" : "KNOWS",
    "end" : "http://localhost:7474/db/data/node/344",
    "metadata" : {
      "id" : 202,
      "type" : "KNOWS"
    },
    "data" : {
      "since" : "2010"
    },
    "indexed" : "http://localhost:7474/db/data/index/relationship/my_rels/since/2010/202"
  },
  "from" : "/index/relationship/my_rels"
} ]

Execute multiple operations in batch streaming

Figure 19.69. Final Graph

Final-Graph-execute-multiple-operations-in-batch-streaming.svg

Example request

  • POST http://localhost:7474/db/data/batch
  • Accept: application/json
  • Content-Type: application/json
  • X-Stream: true 
[ {
  "method" : "PUT",
  "to" : "/node/139/properties",
  "body" : {
    "age" : 1
  },
  "id" : 0
}, {
  "method" : "GET",
  "to" : "/node/139",
  "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/139/properties",
  "body" : null,
  "status" : 204
}, {
  "id" : 1,
  "from" : "/node/139",
  "body" : {
    "extensions" : {
    },
    "outgoing_relationships" : "http://localhost:7474/db/data/node/139/relationships/out",
    "labels" : "http://localhost:7474/db/data/node/139/labels",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/139/relationships/all/{-list|&|types}",
    "traverse" : "http://localhost:7474/db/data/node/139/traverse/{returnType}",
    "self" : "http://localhost:7474/db/data/node/139",
    "property" : "http://localhost:7474/db/data/node/139/properties/{key}",
    "properties" : "http://localhost:7474/db/data/node/139/properties",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/139/relationships/out/{-list|&|types}",
    "incoming_relationships" : "http://localhost:7474/db/data/node/139/relationships/in",
    "create_relationship" : "http://localhost:7474/db/data/node/139/relationships",
    "paged_traverse" : "http://localhost:7474/db/data/node/139/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "all_relationships" : "http://localhost:7474/db/data/node/139/relationships/all",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/139/relationships/in/{-list|&|types}",
    "metadata" : {
      "id" : 139,
      "labels" : [ ]
    },
    "data" : {
      "age" : 1
    }
  },
  "status" : 200
}, {
  "id" : 2,
  "from" : "/node",
  "body" : {
    "extensions" : {
    },
    "outgoing_relationships" : "http://localhost:7474/db/data/node/140/relationships/out",
    "labels" : "http://localhost:7474/db/data/node/140/labels",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/140/relationships/all/{-list|&|types}",
    "traverse" : "http://localhost:7474/db/data/node/140/traverse/{returnType}",
    "self" : "http://localhost:7474/db/data/node/140",
    "property" : "http://localhost:7474/db/data/node/140/properties/{key}",
    "properties" : "http://localhost:7474/db/data/node/140/properties",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/140/relationships/out/{-list|&|types}",
    "incoming_relationships" : "http://localhost:7474/db/data/node/140/relationships/in",
    "create_relationship" : "http://localhost:7474/db/data/node/140/relationships",
    "paged_traverse" : "http://localhost:7474/db/data/node/140/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "all_relationships" : "http://localhost:7474/db/data/node/140/relationships/all",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/140/relationships/in/{-list|&|types}",
    "metadata" : {
      "id" : 140,
      "labels" : [ ]
    },
    "data" : {
      "age" : 1
    }
  },
  "location" : "http://localhost:7474/db/data/node/140",
  "status" : 201
}, {
  "id" : 3,
  "from" : "/node",
  "body" : {
    "extensions" : {
    },
    "outgoing_relationships" : "http://localhost:7474/db/data/node/141/relationships/out",
    "labels" : "http://localhost:7474/db/data/node/141/labels",
    "all_typed_relationships" : "http://localhost:7474/db/data/node/141/relationships/all/{-list|&|types}",
    "traverse" : "http://localhost:7474/db/data/node/141/traverse/{returnType}",
    "self" : "http://localhost:7474/db/data/node/141",
    "property" : "http://localhost:7474/db/data/node/141/properties/{key}",
    "properties" : "http://localhost:7474/db/data/node/141/properties",
    "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/141/relationships/out/{-list|&|types}",
    "incoming_relationships" : "http://localhost:7474/db/data/node/141/relationships/in",
    "create_relationship" : "http://localhost:7474/db/data/node/141/relationships",
    "paged_traverse" : "http://localhost:7474/db/data/node/141/paged/traverse/{returnType}{?pageSize,leaseTime}",
    "all_relationships" : "http://localhost:7474/db/data/node/141/relationships/all",
    "incoming_typed_relationships" : "http://localhost:7474/db/data/node/141/relationships/in/{-list|&|types}",
    "metadata" : {
      "id" : 141,
      "labels" : [ ]
    },
    "data" : {
      "age" : 1
    }
  },
  "location" : "http://localhost:7474/db/data/node/141",
  "status" : 201
} ]