Consulta de la descripción de un índice de búsqueda - Tablestore

Después de crear un índice de búsqueda para una tabla de datos, puede llamar a la operación DescribeSearchIndex para consultar su descripción, incluida la información sobre los campos y las configuraciones del índice.

Requisitos previos

Una instancia de OTSClient inicializada. Para obtener más información, consulte Initialize an OTSClient instance.
Una tabla de datos creada con datos escritos. Para obtener más información, consulte Create a data table y Write data.
Un índice de búsqueda creado para la tabla de datos. Para obtener más información, consulte Create a search index.

Operación de 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	Descripción
table_name	El nombre de la tabla de datos.
index_name	El nombre del índice de búsqueda.

Ejemplo

A continuación se muestra el código de ejemplo que indica cómo consultar la descripción de un índice de búsqueda.

$request = array(
    'table_name' => 'php_sdk_test',
    'index_name' => 'php_sdk_test_search_index'
);
$response = $otsClient->describeSearchIndex($request);

Referencias

Si un índice de búsqueda existente ya no cumple con sus requisitos, cree uno nuevo, modifique el esquema del índice actual para agregar, eliminar o cambiar campos de índice, o ajuste la configuración de TTL del índice. Para obtener más información, consulte Create a search index y Dynamically modify the schema of a search index.