Trabajando con datos

Este documento explica cómo se insertan, listan, modifican y eliminan documentos en una colección. También se incluye cómo se pueden filtrar los datos al listar.

Insertar Documentos

Insertar un documento

Para insertar un solo documento en una colección, se utiliza la siguiente petición HTTP:

 1POST /databases/{database}/collections/{collection}/documents
 2Content-Type: application/json
 3X-API-Key: your-api-key
 4
 5{
 6  "document": {
 7    "key1": "value1",
 8    "key2": "value2"
 9  }
10}

Insertar múltiples documentos

Para insertar múltiples documentos en una colección, se utiliza la siguiente petición HTTP:

 1POST /databases/{database}/collections/{collection}/documents/bulk
 2Content-Type: application/json
 3X-API-Key: your-api-key
 4
 5{
 6  "documents": [
 7    {
 8      "key1": "value1",
 9      "key2": "value2"
10    },
11    {
12      "key1": "value3",
13      "key2": "value4"
14    }
15  ]
16}

Listar Documentos

Listar todos los documentos (Full Scan)

Para listar todos los documentos en una colección, se utiliza la siguiente petición HTTP:

1GET /databases/{database}/collections/{collection}/documents
2X-API-Key: your-api-key

Listar documentos con un índice único

Para listar documentos utilizando un índice único, se utiliza la siguiente petición HTTP:

1GET /databases/{database}/collections/{collection}/documents?filter={"key":"value"}
2X-API-Key: your-api-key

Listar documentos con un límite

Para listar documentos con un límite específico, se utiliza la siguiente petición HTTP:

1GET /databases/{database}/collections/{collection}/documents?limit=10
2X-API-Key: your-api-key

Modificar Documentos

Modificar documentos por un escaneo completo

Para modificar documentos mediante un escaneo completo, se utiliza la siguiente petición HTTP:

1PATCH /databases/{database}/collections/{collection}/documents
2Content-Type: application/json
3X-API-Key: your-api-key
4
5{
6  "filter": {"key": "value"},
7  "update": {"$set": {"key": "new_value"}}
8}

Modificar documentos por índice

Para modificar documentos utilizando un índice, se utiliza la siguiente petición HTTP:

1PATCH /databases/{database}/collections/{collection}/documents?filter={"key":"value"}
2Content-Type: application/json
3X-API-Key: your-api-key
4
5{
6  "update": {"$set": {"key": "new_value"}}
7}

Eliminar Documentos

Eliminar documentos por índice

Para eliminar documentos utilizando un índice, se utiliza la siguiente petición HTTP:

1DELETE /databases/{database}/collections/{collection}/documents?filter={"key":"value"}
2X-API-Key: your-api-key

Eliminar documentos por escaneo completo

Para eliminar documentos mediante un escaneo completo, se utiliza la siguiente petición HTTP:

1DELETE /databases/{database}/collections/{collection}/documents
2Content-Type: application/json
3X-API-Key: your-api-key
4
5{
6  "filter": {"key": "value"}
7}