Exportación masiva de documentos: búsquedas con scroll - OpenSearch

Las búsquedas normales devuelven un máximo de 5,000 documentos. Si necesita más resultados para su análisis, utilice búsquedas con scroll para recuperar conjuntos de resultados más grandes.

Parámetros

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Valor válido	Valor predeterminado	Descripción
scroll	STRING	Sí	Puede establecer un valor en unidades de semanas, días, horas, minutos o segundos.		Periodo de validez del ID de scroll que se devuelve para la siguiente ejecución de la búsqueda con scroll, en unidades de semanas (w), días (d), horas (h), minutos (m) o segundos (s). Ejemplo: 1m.
search_type	STRING	Sí	scan		Tipo de búsqueda con scroll. Especifique este parámetro solo para la primera búsqueda con scroll. Para las búsquedas posteriores, utilice el parámetro scroll_id en su lugar.
scroll_id	STRING	Sí			ID que devuelve la búsqueda con scroll. La primera búsqueda con scroll solo devuelve un ID de scroll sin resultados. Utilice este ID para ejecutar nuevamente la búsqueda con scroll y obtener resultados. En las búsquedas posteriores, este ID es tanto un parámetro de solicitud obligatorio como un parámetro de respuesta devuelto.
fetch_fields	STRING				Campos que se devuelven en los resultados de búsqueda.

Parámetros de respuesta

Parámetro	Tipo	Descripción
status	STRING	Resultado de la ejecución de la solicitud. Valores válidos: OK y FAIL. Si el valor es FAIL, solucione los errores según el código de error.
request_id	STRING	ID de la solicitud, utilizado para la solución de problemas.
result	STRING	Resultados de la búsqueda, que incluyen los parámetros searchtime, total, num, viewtotal, items, facet y scroll_id.
errors	STRING	Información de error. El parámetro error_message indica el mensaje de error. Para obtener más información, consulte Error codes.

Nota

Los resultados de las búsquedas con scroll solo admiten los formatos fullJSON y JSON.

Respuestas de ejemplo

Respuesta de la primera ejecución de una búsqueda con scroll:

{
    "status": "OK",
    "request_id": "150150574119953661605242",
    "result": {
        "searchtime": 0.005029,
        "total": 1,
        "num": 0,
        "viewtotal": 1,
        "scroll_id": "eJxtUMtuhDAM/BrvOYQC5cABdulvRFFIirsm2TpBavv1Ndut1EMlS36NZ0Y2ZHMxbueceAjIuWCMnrPjRITLyfzZm83y9V QVGT8x80U3PxQNUqieVZV1/an4ItbTUBPSx5wgXqKdvOSbmuKR8ZYjGWWirB4tvToAiX7u3G2eCNK77vnz8GlGPAV6suKBeqxAn0OiTd7NGEnesspyoyFLF6hecn4JUKjVgp0K3FnkfMfIyPoDuYWegX9GeYOpicY9TG8gwOSuBL04X1 MMg3ROwCesLlG6X7a2o=",
        "items": [],
        "facet": []
    },
    "errors": [],
    "tracer": ""
}

Respuesta de una ejecución posterior de la búsqueda con scroll:

{
    "status": "OK",
    "request_id": "150150574119952551519970",
    "result": {
        "searchtime": 0.006293,
        "total": 1,
        "num": 1,
        "viewtotal": 1,
        "scroll_id": "eJxNT9tugzAM/RrznIRC4YEHaNlvRFFIhteQtE6Qtn39TNdJk2z5dnx8rIPJRdudcqKhl60Uir2Vp06ISv8b6s3QbZCVzpaCdp93XXBzg2wEW9MJ2dWq8q7YVXt0YckDLlBP0WyOw31N8YgYizZEnAUsjkx4VT4k8zexpjiNS/XYHX0NNkWP71BfVyxQjxLUxSfazFH4PYSPnCL3iMniDZq3jN98aFRCgGrZniy8/itkBHWGuYVeQH+B+QzTCUZ1NJ9gj4FVMfrQPr8Y+Hk+dgU14fIDVhtfTw==",
        "items": [
            {
                "fields": {
                    "cate_id": "0",
                    "float_arr": "0",
                    "id": "1",
                    "int_arr": "0",
                    "literal_arr": "Search",
                    "name": "Search",
                    "phone": "1381111****",
                    "index_name": "app_schema_demo"
                },
                "property": {},
                "attribute": {},
                "variableValue": {},
                "sortExprValues": [
                    "1"
                ]
            }
        ],
        "facet": []
    },
    "errors": [],
    "tracer": ""
}

Notas de uso

Las búsquedas con scroll admiten ordenamiento basado en un solo campo de tipo INT. La versión de la API de OpenSearch y de los SDK de OpenSearch debe ser V3.
Las búsquedas con scroll recuperan todos los resultados coincidentes y no son compatibles con las cláusulas aggregate y distinct, las cláusulas rank ni el análisis de consultas.
El parámetro start en la cláusula config no surte efecto en las búsquedas con scroll. Se utiliza el valor predeterminado 0, por lo que no puede omitir páginas. Cada conjunto de resultados puede contener un máximo de 500 documentos.
Especifique el parámetro hit en la primera búsqueda con scroll para establecer la cantidad de documentos por conjunto de resultados. Los cambios en el parámetro hit en búsquedas con scroll posteriores no surten efecto.
La primera búsqueda con scroll solo devuelve un ID de scroll. Utilice este ID para ejecutar nuevamente la búsqueda con scroll y obtener los datos de los documentos.
Para determinar si ocurrió un error, compruebe el código y el mensaje de error en lugar de la información de estado. Para obtener más información, consulte Error codes.
Si una búsqueda con scroll devuelve un mensaje de error que indica caducidad, significa que el periodo de validez de la solicitud de scroll expiró. Modifique el parámetro scroll.

Código de demostración del SDK

Nota

Nota:

El parámetro start en la cláusula config no surte efecto en las búsquedas con scroll. Utilice el parámetro hit en la cláusula config para especificar la cantidad de documentos por conjunto de resultados.
Las búsquedas con scroll no admiten las cláusulas aggregate, distinct ni rank. Las búsquedas con scroll admiten ordenamiento basado en un solo campo de tipo INT.
No se admiten búsquedas con scroll entre aplicaciones.
Si el valor del parámetro scroll_id en una solicitud no es válido, se produce un error.
Los resultados de las búsquedas con scroll solo admiten los formatos fullJSON y JSON.
La primera búsqueda con scroll solo devuelve un ID de scroll. Utilice este ID para ejecutar nuevamente la búsqueda con scroll y obtener los datos de los documentos.

Código de demostración relacionado con búsquedas con scroll en OpenSearch SDK for Java:

Demo code for implementing regular scroll searches

Demo code for implementing iterative scroll searches

Código de demostración para implementar búsquedas con scroll en OpenSearch SDK for PHP:

Demo code for implementing scroll queries

Operaciones de API relacionadas con búsquedas con scroll

Initiate search requests