A cláusula config define a posição inicial dos resultados da consulta, a quantidade de itens retornados, o formato de saída e o número de documentos que participam da expressão de ordenação fina.
Sintaxe
|
Parâmetro |
Tipo |
Obrigatório |
Valores válidos |
Valor padrão |
Descrição |
|
start |
int |
Não |
[0, 5000] |
0 |
Retorna documentos a partir da posição inicial especificada nos resultados da busca. |
|
hit |
int |
Não |
[0, 500] |
10 |
Quantidade máxima de documentos a retornar. |
|
format |
string |
Não |
json |
Formato dos documentos retornados. Opções válidas: json e fulljson. O formato fulljson gera mais nós que o json, incluindo variableValue e sortExprValues. |
|
|
rerank_size |
int |
Não |
[0, 2000] |
200 |
Número de documentos por coluna que participam da ordenação fina. |
|
total_rank_size |
int |
Não |
- |
- |
Quantidade de documentos envolvidos na ordenação preliminar. |
|
default_operator |
string |
Não |
'AND' ou 'OR' |
AND |
Operador de consulta padrão. (Nota: Apenas instâncias exclusivas oferecem suporte a este parâmetro.) |
Observações de uso
A cláusula config é opcional.
Separe os pares de parâmetros com vírgulas (,).
Em cada par de parâmetros, separe a chave e o valor com dois pontos (:).
start+hit<=5000. Se a soma ultrapassar 5000, o sistema retorna um erro diretamente, sem gerar resultados. Para paginar mais de 5.000 registros, utilize o scroll method para exportar documentos em lotes e implemente sua própria lógica de paginação.
O parâmetro default_operator pode ser configurado apenas em instâncias exclusivas.
Para definir o parâmetro total_rank_size em um SDK, utilize os métodos a seguir. Java SDK:
config.addToCustomConfig("total_rank_size:200000");. PHP SDK:$params->setCustomConfig('total_rank_size', 200000);.-
Visualize detalhes da ordenação no código:
Método: Adicione o parâmetro format:fulljson à cláusula config.
Nos resultados retornados, sortExprValues indica a pontuação do documento:

sortExprValues é um array que contém os valores dos campos de ordenação definidos na cláusula sort. Exemplo:
sort=-price;-RANKNeste caso, sortExprValues corresponde a [preço, pontuação do documento].
Se a ordenação não for especificada, o valor padrão será a pontuação do documento.
Exemplos
-
Paginação: Exiba 20 resultados por página e recupere os dados da primeira e da segunda página.
#Page 1 config=start:0, hit:20, format:xml #Page 2 config=start:20, hit:20, format:xml -
Defina o número de documentos para ordenação fina como 1000.
config=start:0, hit:20, rerank_size:1000 -
Reduza a quantidade de documentos a recuperar.
config=start:0, hit:20, total_rank_size:100