From cd5c6fdb8d845e9166f8be225d6aecedeec6911e Mon Sep 17 00:00:00 2001 From: pajh0509 <45146201+pajh0509@users.noreply.github.com> Date: Mon, 4 Mar 2024 11:05:29 -0500 Subject: [PATCH] Fix value for search_after parameter in serach.md (#584) Signed-off-by: pajh0509 --- CHANGELOG.md | 1 + guides/search.md | 22 ++++++++++++++-------- 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 08b118654..5393115b1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -82,6 +82,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ### Deprecated ### Removed ### Fixed +- Fix wrong documentation for file serach.md regarding `search_after` param ([#584](https://github.com/opensearch-project/opensearch-js/pull/584)) ### Security ## [2.3.0] diff --git a/guides/search.md b/guides/search.md index 66108780c..48b2e07bc 100644 --- a/guides/search.md +++ b/guides/search.md @@ -100,24 +100,27 @@ const page_1 = await client.search({ size: 2, body: search_body }); +const documents_1 = page_1.body.hits.hits; const page_2 = await client.search({ index: 'movies', size: 2, body: { ...search_body, - search_after: page_1[page_1.length - 1].sort + search_after: documents_1[documents_1.length - 1].sort } }); +const documents_2 = page_2.body.hits.hits; const page_3 = await client.search({ index: 'movies', size: 2, body: { ...search_body, - search_after: page_2[page_2.length - 1].sort + search_after: documents_2[documents_2.length - 1].sort } -}) +}); +const documents_3 = page_3.body.hits.hits; ``` ### Pagination with scroll When retrieving large amounts of non-real-time data, you can use the `scroll` parameter to paginate through the search results. @@ -162,25 +165,28 @@ const page_1 = await client.search({ size: 2, body: pit_search_body }); -console.log(page_1.body.hits.hits); +const documents_1 = page_1.body.hits.hits; +console.log(documents_1); const page_2 = await client.search({ size: 2, body: { ...pit_search_body, - search_after: page_1[page_1.length - 1].sort + search_after: documents_1[documents_1.length - 1].sort } }); -console.log(page_2.body.hits.hits); +const documents_2 = page_2.body.hits.hits; +console.log(documents_2); const page_3 = await client.search({ size: 2, body: { ...pit_search_body, - search_after: page2[page_2.length-1].sort + search_after: documents_2[documents_2.length-1].sort } }); -console.log(page_3.body.hits.hits); +const documents_3 = page_3.body.hits.hits; +console.log(documents_3); /** Print out the titles of the first 3 pages of results */ console.log(page_1.map(hit => hit._source.title));