Skip to content
MilvusNode SDK
Sections

Upsert entities

Markdown

Copy for agent

Connection and CORS help

Use HTTPS for remote clusters or HTTP on loopback. Requests go directly from your browser to the endpoint. Run List collections to populate the collection selector. When copying an authenticated cURL command, set MILVUS_TOKEN in your shell.

For cross-origin requests, configure the endpoint to answer OPTIONS and allow the docs origin, POST, Content-Type, and Authorization if you use a token. Try the copied cURL command to troubleshoot outside the browser.

POST/v2/vectordb/entities/upsert

{
  "dbName": "default",
  "collectionName": "books",
  "data": [
    {
      "id": 101,
      "title": "Invisible Cities",
      "vector": [
        0.1,
        0.2,
        0.3,
        0.4
      ]
    }
  ]
}

Example response

{
  "code": 0,
  "data": {
    "upsertCount": 1,
    "upsertIds": [
      101
    ]
  },
  "cost": 0
}
cURL command
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/entities/upsert' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${MILVUS_TOKEN}" \
  --data-raw '{
  "dbName": "default",
  "collectionName": "books",
  "data": [
    {
      "id": 101,
      "title": "Invisible Cities",
      "vector": [
        0.1,
        0.2,
        0.3,
        0.4
      ]
    }
  ]
}'

Insert new rows or replace rows with matching primary keys. Use partialUpdate to update selected fields.

Request fields

dbName string
Database name. Operations on collections use default when omitted.
collectionName string (required)
Name of the collection.
partitionName string
Name of the partition.
data array of object (required)
Array of entity objects keyed by field name.
partialUpdate boolean
Update only the provided fields of existing entities.
fieldOps array of object
Per-field operations for a partial upsert, such as appending array elements.

See HttpClient.upsert for the Node.js SDK method.