Class QueryOptions

Class QueryOptions memberikan opsi untuk hasil kueri pasca-pemrosesan berdasarkan kebutuhan aplikasi Anda. Anda membuat class sebagai options dalam argumen Query.options.

Query ditentukan dalam modul google.appengine.api.search.

Pengantar

Class QueryOptions memberikan opsi untuk pasca-pemrosesan hasil untuk kueri tertentu. Opsi mencakup kemampuan untuk mengurutkan hasil, mengontrol kolom dokumen mana yang akan ditampilkan, menghasilkan cuplikan kolom, dan menghitung serta mengurutkan berdasarkan ekspresi penskoran yang kompleks.

Jika Anda ingin mengakses halaman hasil penelusuran secara acak, Anda dapat menggunakan offset:

from google.appengine.api import search
...
# get the first set of results
page_size = 10
results = index.search(search.Query(query_string='some stuff',
    options=search.QueryOptions(limit=page_size))

# calculate pages
pages = results.number_found / page_size

# user chooses page and hence an offset into results
next_page = ith * page_size

# get the search results for that page
results = index.search(search.Query(query_string='some stuff',
    options=search.QueryOptions(limit=page_size, offset=next_page))

Misalnya, fragmen kode berikut meminta penelusuran untuk dokumen dengan first muncul di kolom subject dan good muncul di kolom mana pun, yang menampilkan maksimal 20 dokumen, yang meminta kursor untuk halaman hasil berikutnya , yang menampilkan kursor lain untuk rangkaian hasil berikutnya, mengurutkan berdasarkan subjek dalam urutan menurun, menampilkan kolom penulis, subjek, dan ringkasan, serta konten kolom yang diambil:

...
results = index.search(search.Query(
    query='subject:first good',
    options=search.QueryOptions(
        limit=20,
        cursor=search.Cursor(),
        sort_options=search.SortOptions(
            expressions=[
                search.SortExpression(expression='subject', default_value='')],
            limit=1000),
        returned_fields=['author', 'subject', 'summary'],
        snippeted_fields=['content'])))

Konstruktor

Konstruktor untuk class QueryOptions ditentukan sebagai berikut:

class QueryOptions(limit=20, number_found_accuracy=None, cursor=None, offset=None, sort_options=None, returned_fields=None, ids_only=False, snippeted_fields=None, returned_expressions=None)

Tetapkan opsi yang menentukan hasil kueri penelusuran.

Argumen

batas

Batas jumlah dokumen yang dapat ditampilkan dalam hasil.

number_found_accuracy

Persyaratan akurasi minimum untuk SearchResults.number_found. Jika ditetapkan, objek akan tetap akurat hingga setidaknya angka minimum tersebut. Misalnya, jika ditetapkan ke 100, semua objek SearchResults dengan number_found_accuracy <= 100 akan akurat.

cursor

Kursor yang menjelaskan tempat untuk mendapatkan serangkaian hasil berikutnya, atau memberikan kursor berikutnya di SearchResults.

offset

Offset mewakili jumlah dokumen yang perlu dilewati dalam hasil penelusuran. Ini adalah alternatif penggunaan query cursor. Fungsi ini memungkinkan akses acak ke hasil. Offset lebih mahal (dalam hal jam kerja instance) daripada kursor. Anda dapat menggunakan kursor atau offset, tetapi tidak keduanya. Menggunakan offset berarti tidak ada kursor yang ditampilkan di ScoredDocument.cursor atau ScoredDocument.cursor.

sort_options

Objek SortOptions yang menentukan pengurutan multi-dimensi pada hasil penelusuran.

returned_fields

Nama kolom yang dapat diulang yang akan ditampilkan dalam hasil penelusuran.

ids_only

Hanya tampilkan ID dokumen, jangan tampilkan kolom apa pun.

snippeted_fields

Nama kolom yang dapat diulang untuk cuplikan dan ditampilkan dalam ekspresi hasil penelusuran.

returned_expressions

FieldExpression yang dapat diulang untuk mengevaluasi dan menampilkan hasil penelusuran.

Nilai hasil

Instance baru dari class QueryOptions.

Pengecualian

TypeError

Jika iterator_options atau sort_options yang tidak dikenal diteruskan.

ValueError

Jika ids_only dan returned_fields digunakan bersama-sama.

Properti

Instance class Query memiliki properti berikut:

batas

Menampilkan batas jumlah dokumen yang dapat ditampilkan dalam hasil.

number_found_accuracy

Menampilkan persyaratan akurasi minimum untuk SearchResults.number_found.

cursor

Menampilkan kursor untuk kueri.

offset

Menampilkan jumlah dokumen dalam hasil penelusuran yang akan dilewati.

sort_options

Menampilkan objek SortOptions.

returned_fields

Menampilkan nama kolom yang dapat diulang yang akan ditampilkan dalam hasil penelusuran.

ids_only

Hanya menampilkan di hasil penelusuran.

snippeted_fields

Menampilkan nama kolom yang dapat diulang ke cuplikan dan menampilkan hasil.

returned_expressions

Menampilkan FieldExpression yang dapat diulang untuk ditampilkan dalam hasil.