Utilisez le SDK Tablestore pour Python pour faire correspondre les valeurs de champ ou les jetons commençant par une chaîne spécifiée.
Prérequis
Installez le SDK Tablestore pour Python et initialisez le client.
Description
Une requête par préfixe fait correspondre les valeurs de champ ou les jetons commençant par la chaîne de recherche. Pour un champ Keyword, la valeur complète du champ doit commencer par la chaîne de recherche. Pour un champ Text, une ligne correspond si l'un des jetons commence par la chaîne de recherche. La chaîne de recherche n'est pas tokenisée. La correspondance est sensible à la casse. Lors de l'appel à la méthode search, définissez le type de requête sur PrefixQuery. Pour plus d'informations sur les types de champs, consultez la section Types de chaînes.
PrefixQuery(field_name, prefix, weight=None)L'exemple suivant interroge les lignes dont le champ category commence par book- et renvoie jusqu'à 10 lignes ainsi que le nombre total de lignes correspondantes.
query = PrefixQuery("category", "book-")
search_query = SearchQuery(
query,
limit=10,
get_total_count=True,
)
response = client.search(
"example_table",
"example_index",
search_query,
ColumnsToGet(return_type=ColumnReturnType.ALL),
)
print(response.total_count)
for row in response.rows:
print(row)Paramètres
Requête de recherche
La méthode search accepte les paramètres suivants.
|
Nom |
Type |
Description |
|
table_name (obligatoire) |
|
Nom de la table de données. |
|
index_name (obligatoire) |
|
Nom de l'index de recherche. |
|
search_query (obligatoire) |
|
Condition de requête et configurations courantes. |
|
columns_to_get (facultatif) |
|
Configuration des colonnes à renvoyer. Si ce paramètre est omis, seules les colonnes de clé primaire sont renvoyées. |
|
routing_keys (facultatif) |
|
Liste des valeurs de clé primaire pour les champs de routage personnalisé. Ce paramètre est inutile si le routage personnalisé n'est pas configuré. |
|
timeout_s (facultatif) |
|
Délai d'expiration de la requête en secondes. À défaut, le délai d'expiration configuré au niveau du client s'applique. |
Configuration de la requête
Le paramètre search_query est de type SearchQuery et contient les paramètres suivants.
|
Nom |
Type |
Description |
|
query (obligatoire) |
|
Condition de requête. Définissez ce paramètre sur |
|
sort (facultatif) |
|
Ordre de tri des résultats. Pour plus d'informations, consultez la section Tri et pagination des résultats. |
|
get_total_count (facultatif) |
|
Indique s'il faut renvoyer le nombre total de lignes correspondantes. Valeur par défaut : |
|
next_token (facultatif) |
|
Jeton de pagination. Affectez à ce paramètre la valeur |
|
offset (facultatif) |
|
Décalage de départ de la requête actuelle. Utilisez ce paramètre pour une pagination superficielle. |
|
limit (facultatif) |
|
Nombre maximal de lignes à renvoyer. Si ce paramètre est défini sur |
|
aggs (facultatif) |
|
Configurations d'agrégation. Pour plus d'informations, consultez la section Agrégation. |
|
group_bys (facultatif) |
|
Configurations de regroupement. Pour plus d'informations, consultez la section Agrégation. |
|
collapse_field (facultatif) |
|
Configuration de réduction des résultats, qui supprime les doublons selon un champ spécifié. Pour plus d'informations, consultez la section Réduction des résultats de requête. |
|
highlight (facultatif) |
|
Configuration de résumé et de mise en surbrillance pour les champs |
Condition de requête
Le paramètre search_query.query est de type PrefixQuery et contient les paramètres suivants.
|
Nom |
Type |
Description |
|
field_name (obligatoire) |
|
Nom du champ |
|
prefix (obligatoire) |
|
Chaîne de recherche. Pour un champ |
|
weight (facultatif) |
|
Poids de pertinence de la condition de requête. La valeur doit être un nombre à virgule flottante positif. Ce paramètre n'affecte ni la correspondance ni le nombre de lignes renvoyées. Il influence l'ordre uniquement lorsque les résultats sont triés par score de pertinence. Valeur par défaut : |
Colonnes de retour
Le paramètre columns_to_get est de type ColumnsToGet et contient les paramètres suivants.
|
Nom |
Type |
Description |
|
column_names (facultatif) |
|
Noms des colonnes d'attribut à renvoyer. Spécifiez ce paramètre uniquement lorsque |
|
return_type (facultatif) |
|
Mode de retour des colonnes. |
Réponse
La méthode search renvoie un objet SearchResponse. Le tableau suivant décrit les champs principaux.
|
Champ |
Type |
Description |
|
rows |
|
Lignes renvoyées par la requête actuelle. Le nombre de lignes ne dépasse pas la valeur de |
|
next_token |
|
Jeton pour la page suivante. Si ce champ n'est pas vide, transmettez-le à la requête suivante pour poursuivre la lecture. |
|
total_count |
|
Nombre de lignes correspondantes. La valeur dépend de la configuration de |
|
is_all_succeed |
|
Indique si toutes les partitions d'index ont été interrogées. Si la valeur est |
|
agg_results |
|
Résultats d'agrégation. Ce champ est vide si |
|
group_by_results |
|
Résultats de regroupement. Ce champ est vide si |
|
search_hits |
|
Occurrences de recherche, incluant des informations étendues telles que les scores de pertinence, les mises en surbrillance et les lignes enfants correspondantes. |
Réponse compatible avec les tuples
À partir de la version 5.2.0 du SDK Tablestore pour Python, les API de recherche renvoient des objets de réponse au lieu de tuples. Les versions 5.1.0 et antérieures renvoient directement des tuples. Dans les versions 5.2.1 et ultérieures, vous pouvez appeler SearchResponse.v1_response() pour obtenir un tuple compatible avec les versions précédentes. Pour le nouveau code, accédez directement aux attributs de SearchResponse afin d'éviter les erreurs de déballage si les champs de réponse sont étendus.
(
rows,
next_token,
total_count,
is_all_succeed,
agg_results,
group_by_results,
search_hits,
) = response.v1_response()