Bulk Documents

10min

POST /{appname}/data/{servicename}/_bulkAllows the client to submit an array of JSON documents to hyper for batch loading into the data service. A bulk update can handle inserting, updating, and deleting documents. Use  _deleted: true flag to delete a record. It is also important to note that you need to supply an _id for each document. 
ParametersPathappname - string - path parameters 
servicename - value requirements 
See ﻿Parameters﻿
Request BodyThe request body takes an array of objects in JSON.
Bulk Request Payload LimitWhen submitting bulk documents, the request payload size limit is 10MB.
JSON
|
[
  { "_id": "1001", "type": "movie", "title": "Ghostbusters", _update: true },
  { "_id": "1002", "type": "movie", "title": "Ghostbusters 2" },
  { "_id": "1003", "type": "movie", "title": "Groundhog Day" },
  { "_id": "1004", "type": "movie", "title": "Scrooged" },
  { "_id": "1005", "type": "movie", "title": "Caddyshack", _deleted: true },
  { "_id": "1006", "type": "movie", "title": "Meatballs" },
  { "_id": "1007", "type": "movie", "title": "Stripes" },
  { "_id": "1008", "type": "movie", "title": "What about Bob?" },
  { "_id": "1009", "type": "movie", "title": "Life Aquatic" },
]

[
  { "_id": "1001", "type": "movie", "title": "Ghostbusters", _update: true },
  { "_id": "1002", "type": "movie", "title": "Ghostbusters 2" },
  { "_id": "1003", "type": "movie", "title": "Groundhog Day" },
  { "_id": "1004", "type": "movie", "title": "Scrooged" },
  { "_id": "1005", "type": "movie", "title": "Caddyshack", _deleted: true },
  { "_id": "1006", "type": "movie", "title": "Meatballs" },
  { "_id": "1007", "type": "movie", "title": "Stripes" },
  { "_id": "1008", "type": "movie", "title": "What about Bob?" },
  { "_id": "1009", "type": "movie", "title": "Life Aquatic" },
]
﻿
Examples (Bulk Insert/Update)
Don't forget!Be sure to set your HYPER environment variable with the value of your hyper app's connection string.
Node.js
Curl
|
import { connect } from 'hyper-connect'

const hyper = connect(process.env.HYPER)

const doc1 = {
  _id: 'book-1',
  type: 'book',
  name: 'Dune',
  author: 'Frank Herbert',
  published: '1965',
  _update: true
}

const doc2 = {
  _id: 'book-2',
  type: 'book',
  name: 'The Hobbit',
  author: 'J.R.R Tolkien',
  published: '1937',
}

const result = await hyper.data.bulk([doc1, doc2])

console.log(result)
import { connect } from 'hyper-connect'

const hyper = connect(process.env.HYPER)

const doc1 = {
  _id: 'book-1',
  type: 'book',
  name: 'Dune',
  author: 'Frank Herbert',
  published: '1965',
  _update: true
}

const doc2 = {
  _id: 'book-2',
  type: 'book',
  name: 'The Hobbit',
  author: 'J.R.R Tolkien',
  published: '1937',
}

const result = await hyper.data.bulk([doc1, doc2])

console.log(result)
﻿
Example (Bulk Delete)Node.js
Curl
|
import { connect } from 'hyper-connect'

const hyper = connect(process.env.HYPER)

const doc1 = {
  _id: 'book-1',
  type: 'book',
  name: 'Dune',
  author: 'Frank Herbert',
  published: '1965',
  _deleted: true
}

const doc2 = {
  _id: 'book-2',
  type: 'book',
  name: 'The Hobbit',
  author: 'J.R.R Tolkien',
  published: '1937',
  _deleted: true
}

const result = await hyper.data.bulk([doc1, doc2])

console.log(result)
import { connect } from 'hyper-connect'

const hyper = connect(process.env.HYPER)

const doc1 = {
  _id: 'book-1',
  type: 'book',
  name: 'Dune',
  author: 'Frank Herbert',
  published: '1965',
  _deleted: true
}

const doc2 = {
  _id: 'book-2',
  type: 'book',
  name: 'The Hobbit',
  author: 'J.R.R Tolkien',
  published: '1937',
  _deleted: true
}

const result = await hyper.data.bulk([doc1, doc2])

console.log(result)
﻿
ResponsesStatus Code
Description
Example Response
200
Successfully returned results for your query
{"ok": true, "results": [{"id": '1', "ok": true}, ....]}
500
Error occurred trying to run your query
{"ok": false, "msg": ""}
Need Help?Need Help?You can always reach out to our support team for any additional assistance on slack.
﻿

Updated 24 Mar 2022

Did this page help you?

Yes

Delete a Document

Query Selectors

Docs powered by archbee

TABLE OF CONTENTS

POST /{appname}/data/{servicename}/_bulk

Parameters

Path

Request Body

Bulk Request Payload Limit

Examples (Bulk Insert/Update)

Don't forget!

Example (Bulk Delete)

Responses

Need Help?Need Help?

Status Code	Description	Example Response
200	Successfully returned results for your query	{"ok": true, "results": [{"id": '1', "ok": true}, ....]}
500	Error occurred trying to run your query	{"ok": false, "msg": ""}