Create search indexes

Prerequisites

• A Tablestore client is initialized. For more information, see Initialization.
• A data table is created for which the value of the timeToLive parameter is set to -1 and the value of the maxVersions parameter is set to 1.

Parameters

Examples

• Create a search index
  The following sample code shows how to create a search index that consists of the Col_Keyword and Col_Long columns. Set the type of data in Col_Keyword to String and Col_Long to Long.

  
  private static void createSearchIndex(SyncClient client) {
      CreateSearchIndexRequest request = new CreateSearchIndexRequest();
      request.setTableName(tableName); // Specify the name of the data table. 
      request.setIndexName(indexName); // Specify the name of the search index. 
      IndexSchema indexSchema = new IndexSchema();
      indexSchema.setFieldSchemas(Arrays.asList(
              new FieldSchema("Col_Keyword", FieldType.KEYWORD) // Specify the name and type of the field. 
                      .setIndex(true) // Enable indexing. 
                      .setEnableSortAndAgg(true) // Enable sorting and aggregation. 
                      .setStore(true), // Specify that the value of the field is stored in the search index. 
              new FieldSchema("Col_Long", FieldType.LONG)
                      .setIndex(true)
                      .setEnableSortAndAgg(true)
                      .setStore(true)));
      request.setIndexSchema(indexSchema);
      client.createSearchIndex(request); // Call a client to create the search index. 
  }

• Create a search index with indexSort specified

  private static void createSearchIndexWithIndexSort(SyncClient client) {
      CreateSearchIndexRequest request = new CreateSearchIndexRequest();
      request.setTableName(tableName);
      request.setIndexName(indexName);
      IndexSchema indexSchema = new IndexSchema();
      indexSchema.setFieldSchemas(Arrays.asList(
              new FieldSchema("Col_Keyword", FieldType.KEYWORD).setIndex(true).setEnableSortAndAgg(true).setStore(true),
              new FieldSchema("Col_Long", FieldType.LONG).setIndex(true).setEnableSortAndAgg(true).setStore(true),
              new FieldSchema("Col_Text", FieldType.TEXT).setIndex(true).setStore(true),
              new FieldSchema("Timestamp", FieldType.LONG).setIndex(true).setEnableSortAndAgg(true).setStore(true)));
      // Presort data by the Timestamp column. You must enable indexing and set enableSortAndAgg to true for the Timestamp column. 
      indexSchema.setIndexSort(new Sort(
              Arrays.<Sort.Sorter>asList(new FieldSort("Timestamp", SortOrder.ASC))));
      request.setIndexSchema(indexSchema);
      client.createSearchIndex(request);
  }

• Create a search index with the TTL specified
  Notice Make sure that updates to the data table are prohibited.

  // Use Tablestore SDK for Java V5.12.0 or later to create a search index. 
  public void createIndexWithTTL() {
      int days = 7;
      CreateSearchIndexRequest createRequest = new CreateSearchIndexRequest();
      createRequest.setTableName(tableName);
      createRequest.setIndexName(indexName);
      createRequest.setIndexSchema(indexSchema);
      // Specify the TTL for the search index. 
      createRequest.setTimeToLiveInDays(days);
      client.createSearchIndex(createRequest);
  }

• Create a search index with virtual columns specified
  The following sample code shows how to create a search index that contains columns Col_Keyword and Col_Long. Each of the columns has a virtual column. The virtual column of the Col_Keyword column is Col_Keyword_Virtual_Long and that of the Col_Long column is Col_Long_Virtual_Keyword. The Col_Keyword_Virtual_Long column is mapped to the Col_Keyword column in the data table, and the Col_Long_Virtual_Keyword column is mapped to the Col_Long column in the data table.

  private static void createSearchIndex(SyncClient client) {
      CreateSearchIndexRequest request = new CreateSearchIndexRequest();
      request.setTableName(tableName); // Specify the name of the data table. 
      request.setIndexName(indexName); // Specify the name of the search index. 
      IndexSchema indexSchema = new IndexSchema();
      indexSchema.setFieldSchemas(Arrays.asList(
          new FieldSchema("Col_Keyword", FieldType.KEYWORD) // Specify the name and type of the field. 
              .setIndex(true) // Enable indexing. 
              .setEnableSortAndAgg(true) // Enable sorting and aggregation. 
              .setStore(true),
          new FieldSchema("Col_Keyword_Virtual_Long", FieldType.LONG) // Specify the name and type of the field. 
              .setIndex(true)
              .setEnableSortAndAgg(true)
              .setStore(true)
              .setVirtualField(true) // Specify whether the field is a virtual column. 
              .setSourceFieldName("Col_Keyword"), // Specify name of the source field to which the virtual column is mapped in the data table. 
          new FieldSchema("Col_Long", FieldType.LONG)
              .setIndex(true)
              .setEnableSortAndAgg(true)
              .setStore(true),
          new FieldSchema("Col_Long_Virtual_Keyword", FieldType.KEYWORD)
              .setIndex(true)
              .setEnableSortAndAgg(true)
              .setStore(true)
              .setVirtualField(true)
              .setSourceFieldName("Col_Long")));
      request.setIndexSchema(indexSchema);
      client.createSearchIndex(request); // Call a client to create the search index. 
  }