Após criar um índice de pesquisa, você pode usar a operação DescribeSearchIndex para consultar sua descrição, incluindo informações de campos, configuração do índice, informações de faturamento por consumo, data de criação e TTL do índice de pesquisa.
Pré-requisitos
Inicialize uma instância OTSClient. Para obter mais informações, consulte Initialize an OTSClient instance.
Crie uma tabela de dados e grave os dados nela. Para obter mais informações, consulte Create a data table e Write data.
Crie um índice de pesquisa para a tabela de dados. Para obter mais informações, consulte Create a search index.
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 |
O nome da tabela de dados. |
|
index_name |
O nome do índice de pesquisa. |
Exemplo
O exemplo de código a seguir mostra como consultar a descrição de um índice de pesquisa.
$request = array(
'table_name' => 'php_sdk_test',
'index_name' => 'php_sdk_test_search_index'
);
$response = $otsClient->describeSearchIndex($request);
Referências
Se um índice de pesquisa existente não atender mais às suas necessidades, crie um novo índice de pesquisa, modifique o esquema do índice existente para adicionar, remover ou modificar campos de índice, ou ajuste a configuração de TTL do índice de pesquisa. Para obter mais informações, consulte Create a search index e Dynamically modify the schema of a search index.