Após criar um índice de busca para uma tabela de dados, chame a operação DescribeSearchIndex para consultar a descrição desse índice. A resposta inclui informações sobre os campos e as configurações do índice de busca.
Pré-requisitos
Instância OTSClient inicializada. Para mais informações, consulte Inicializar uma instância OTSClient.
Tabela de dados criada com dados gravados. Para mais informações, consulte Criar uma tabela de dados e Gravar dados.
Índice de busca criado para a tabela de dados. Para mais informações, consulte Criar um índice de busca.
Operação da API
/**
* Query the description of a search index that is created for a table.
* @api
*
* @param [] $request
* The request parameter, which is the table name.
* @return [] The response.
* @throws OTSClientException The exception that is thrown when a parameter error occurs or the Tablestore server returns a verification error.
* @throws OTSServerException The exception that is thrown when the Tablestore server returns an error.
* @example "src/examples/DescribeSearchIndex.php" 20
*/
public function describeSearchIndex(array $request)
Parâmetros
|
Parâmetro |
Descrição |
|
table_name |
Nome da tabela de dados. |
|
index_name |
Nome do índice de busca. |
Exemplo
O código a seguir mostra como consultar a descrição de um índice de busca.
$request = array(
'table_name' => 'php_sdk_test',
'index_name' => 'php_sdk_test_search_index'
);
$response = $otsClient->describeSearchIndex($request);
Referências
Se o índice de busca atual não atender mais aos seus requisitos, crie um novo índice, modifique o esquema do índice existente para adicionar, remover ou alterar campos, ou ajuste a configuração de TTL. Para mais informações, consulte Criar um índice de busca e Modificar dinamicamente o esquema de um índice de busca.