Cursor 클래스

Cursor 클래스는 현재 설정된 검색결과에 커서를 제공하여 사용자가 지정하는 기준에 따라 다음 세트를 검색할 수 있도록 합니다. 커서를 사용하면 색인이 업데이트될 때 페이지 매김 성능과 일관성이 향상됩니다.

다음은 커서를 사용하여 다음 결과 페이지를 가져오는 방법을 보여 줍니다.

# Get the first set of results, and return a cursor with that result set.
# The first cursor tells the API to return cursors in the SearchResults object.
results = index.search(search.Query(query_string='some stuff',
    options=search.QueryOptions(cursor=search.Cursor()))

# Get the next set of results with a cursor.
results = index.search(search.Query(query_string='some stuff',
    options=search.QueryOptions(cursor=results.cursor)))

SearchResults의 ScoredDocuments 중 어느 하나에서라도 검색을 계속하려면 Cursor.per_result를 True로 설정합니다.

# get the first set of results, the first cursor is used to specify
# that cursors are to be returned in the SearchResults.
results = index.search(search.Query(query_string='some stuff',
    options=search.QueryOptions(cursor=Cursor(per_result=True)))

# this shows how to access the per_document cursors returned from a search
per_document_cursor = None
for scored_document in results:
    per_document_cursor = scored_document.cursor

# get the next set of results
results = index.search(search.Query(query_string='some stuff',
    options=search.QueryOptions(cursor=per_document_cursor)))

커서는 Cursor를 재구성하는 데 사용될 수 있는 웹 안전 문자열로 캐시될 수 있습니다. 예를 들면 다음과 같습니다.

next_cursor = results.cursor
next_cursor_url_safe = next_cursor.web_safe_string

// save next_cursor_url_safe
...
// extract next_cursor_url_safe

results = index.search(
    search.Query(query_string,
        cursor=search.Cursor(web_safe_string=next_cursor_url_safe)))

생성자

Cursor 클래스의 생성자는 다음과 같이 정의됩니다.

class Cursor(web_safe_string=None, per_result=False)

Cursor 클래스의 인스턴스를 생성합니다.

인수

per_result

true이면 SearchResults의 ScoredDocument마다 커서가 반환됩니다. false이면 모든 SearchResults에 대해 단일 커서가 반환됩니다. QueryOptions.offset를 사용하는 경우 다음 오프셋(있는 경우) 계산은 사용자 책임이므로 무시됩니다.

web_safe_string

다음 결과 세트를 가져오기 위해 검색 서비스에서 해석될 검색 서비스에서 반환된 커서 문자열입니다.

결과 값

Cursor 클래스의 새 인스턴스입니다.

예외

ValueError

API에서 제공된 web_safe_string가 요구되는 형식이 아닌 경우

속성

Cursor 클래스의 인스턴스에는 다음 속성이 있습니다.

per_result

결과의 각 ScoredDocument에 대해 커서 반환 여부를 반환합니다.

web_safe_string

검색 서비스에서 생성된 커서 문자열을 반환합니다.