Tablestore:検索インデックスを作成する

デフォルト設定を使用して検索インデックスを作成する

次のサンプルコードは、デフォルト設定を使用して検索インデックスを作成する方法の例を示しています。この例では、検索インデックスは、Keyword 型の col_keyword フィールド、Long 型の col_long フィールド、および Vector 型の col_vector フィールドで構成されています。

func createSearchIndex(client *tablestore.TableStoreClient) {
    request := &tablestore.CreateSearchIndexRequest{}
    request.TableName = "<TABLE_NAME>"
    request.IndexName = "<SEARCH_INDEX_NAME>"
    request.IndexSchema = &tablestore.IndexSchema{
        FieldSchemas: []*tablestore.FieldSchema{
            {
                FieldName:        proto.String("col_keyword"),
                FieldType:        tablestore.FieldType_KEYWORD, // 文字列型。
                Index:            proto.Bool(true),
                EnableSortAndAgg: proto.Bool(true),
            },
            {
                FieldName:        proto.String("col_long"),
                FieldType:        tablestore.FieldType_LONG, // Long 型。
                Index:            proto.Bool(true),
                EnableSortAndAgg: proto.Bool(true),
            },
            {
                FieldName: proto.String("col_vector"),
                FieldType: tablestore.FieldType_VECTOR, // Vector 型。
                Index:     proto.Bool(true),
                VectorOptions: &tablestore.VectorOptions{
                    VectorDataType:   tablestore.VectorDataType_FLOAT_32.Enum(),
                    Dimension:        proto.Int32(4), // ベクター次元数を 4 に設定し、ベクターの距離測定アルゴリズムをドット積アルゴリズムに設定します。
                    VectorMetricType: tablestore.VectorMetricType_DOT_PRODUCT.Enum(),
                },
            },
        },
    }
    _, err := client.CreateSearchIndex(request)
    if err != nil {
        fmt.Println("Failed to create searchIndex with error:", err) // 検索インデックスの作成に失敗しました。エラー:
        return
    }
}

IndexSort パラメーターを指定して検索インデックスを作成する

次のサンプルコードは、IndexSort パラメーターを指定して検索インデックスを作成する方法の例を示しています。この例では、検索インデックスは、Keyword 型の col1 フィールドと Long 型の col2 フィールドで構成されています。

func createSearchIndex_withIndexSort(client *tablestore.TableStoreClient){
    request := &tablestore.CreateSearchIndexRequest{}
    request.TableName = "<TABLE_NAME>" // データテーブルの名前を指定します。
    request.IndexName = "<SEARCH_INDEX_NAME>" // 検索インデックスの名前を指定します。

    schemas := []*tablestore.FieldSchema{}
    field1 := &tablestore.FieldSchema{
        FieldName: proto.String("col1"), // proto.String メソッドを呼び出して、フィールドの名前を指定します。このメソッドは、文字列ポインターを要求するために使用されます。
        FieldType: tablestore.FieldType_KEYWORD, // フィールドの型を指定します。
        Index:     proto.Bool(true), // フィールドのインデックス作成を有効にします。
        EnableSortAndAgg: proto.Bool(true), // ソートと集約を有効にします。
    }
    field2 := &tablestore.FieldSchema{
        FieldName: proto.String("col2"),
        FieldType: tablestore.FieldType_LONG,
        Index:     proto.Bool(true),
        EnableSortAndAgg: proto.Bool(true),
    }

    schemas = append(schemas, field1, field2)
    request.IndexSchema = &tablestore.IndexSchema{
        FieldSchemas: schemas, // 検索インデックスに含まれるフィールドを指定します。
        IndexSort: &search.Sort{ // インデックスの事前ソート設定を指定します。データは、col2 フィールドの値に基づいて昇順でソートされ、次に col1 フィールドの値に基づいて降順でソートされます。
            Sorters: []search.Sorter{
                &search.FieldSort{
                    FieldName: "col2",
                    Order:     search.SortOrder_ASC.Enum(),
                },
                &search.FieldSort{
                    FieldName: "col1",
                    Order:     search.SortOrder_DESC.Enum(),
                },
            },
        },
    }
    resp, err := client.CreateSearchIndex(request) // クライアントを呼び出して、検索インデックスを作成します。
    if err != nil {
        fmt.Println("error :", err) // エラー:
        return
    }
    fmt.Println("CreateSearchIndex finished, requestId:", resp.ResponseInfo.RequestId) // CreateSearchIndex が完了しました。リクエスト ID:
}

TTL を指定して検索インデックスを作成する

func createIndexWithTTL(client *tablestore.TableStoreClient) {
    request := &tablestore.CreateSearchIndexRequest{}
    request.TableName = "<TABLE_NAME>"
    request.IndexName = "<SEARCH_INDEX_NAME>"
    schemas := []*tablestore.FieldSchema{}
    field1 := &tablestore.FieldSchema{
        FieldName:        proto.String("col1"), // proto.String メソッドを呼び出して、フィールドの名前を指定します。このメソッドは、文字列ポインターを要求するために使用されます。
        FieldType:        tablestore.FieldType_KEYWORD, // フィールドの型を指定します。
        Index:            proto.Bool(true), // フィールドのインデックス作成を有効にします。
        EnableSortAndAgg: proto.Bool(true), // ソートと集約を有効にします。
    }
    field2 := &tablestore.FieldSchema{
        FieldName:        proto.String("col2"),
        FieldType:        tablestore.FieldType_LONG,
        Index:            proto.Bool(true),
        EnableSortAndAgg: proto.Bool(true),
    }
    schemas = append(schemas, field1, field2)
    request.IndexSchema = &tablestore.IndexSchema{
        FieldSchemas: schemas, // 検索インデックスに含まれるフィールドを指定します。
    }
    request.TimeToLive = proto.Int32(3600 * 24 * 7) // 検索インデックスの TTL を 7 日間に設定します。
    resp, err := client.CreateSearchIndex(request)
    if err != nil {
       fmt.Println("error :", err) // エラー:
       return
   }
    fmt.Println("createIndexWithTTL finished, requestId:", resp.ResponseInfo.RequestId) // createIndexWithTTL が完了しました。リクエスト ID:
}

ハイライト機能を有効にして検索インデックスを作成する

次のサンプルコードは、ハイライト機能を有効にして検索インデックスを作成する方法の例を示しています。この例では、検索インデックスは、Keyword 型の col_keyword フィールド、Long 型の col_long フィールド、Text 型の col_text フィールド、および Nested 型の col_nested フィールドで構成されています。col_nested フィールドは、Text 型の level1_text サブフィールドと Text 型の level2_text サブフィールドで構成されています。この例では、Text 型の col_text フィールド、Text 型の level1_text サブフィールド、および Text 型の level2_text サブフィールドでハイライト機能が有効になっています。

func createSearchIndexwithHighlighting(client *tablestore.TableStoreClient) {
    request := &tablestore.CreateSearchIndexRequest{}
    request.TableName = "<TABLE_NAME>"
    request.IndexName = "<SEARCH_INDEX_NAME>"
    request.IndexSchema = &tablestore.IndexSchema{
        FieldSchemas: []*tablestore.FieldSchema{
            {
                FieldName:        proto.String("col_keyword"),
                FieldType:        tablestore.FieldType_KEYWORD, // 文字列型。
                Index:            proto.Bool(true),
                EnableSortAndAgg: proto.Bool(true),
            },
            {
                FieldName:        proto.String("col_long"),
                FieldType:        tablestore.FieldType_LONG, // Long 型。
                Index:            proto.Bool(true),
                EnableSortAndAgg: proto.Bool(true),
            },
            {// ネストされていないフィールドのハイライト機能を有効にします。
                FieldName: proto.String("col_text"),
                FieldType: tablestore.FieldType_TEXT, // Text 型。
                Index:     proto.Bool(true),
                EnableSortAndAgg: proto.Bool(true),
                EnableHighlighting: proto.Bool(true),
            },
            {// ネストされたフィールドのサブフィールドのハイライト機能を有効にします。
                FieldName: proto.String("col_nested"),
                FieldType: tablestore.FieldType_NESTED,
                FieldSchemas: []*tablestore.FieldSchema{
                    {
                        FieldName:          proto.String("level1_text"),
                        FieldType:          tablestore.FieldType_TEXT,
                        Index:              proto.Bool(true),
                        EnableHighlighting: proto.Bool(true),
                    },
                    {
                        FieldName: proto.String("level1_nested"),
                        FieldType: tablestore.FieldType_NESTED,
                        FieldSchemas: []*tablestore.FieldSchema{
                            {
                                FieldName:          proto.String("level2_text"),
                                FieldType:          tablestore.FieldType_TEXT,
                                Index:              proto.Bool(true),
                                EnableHighlighting: proto.Bool(true),
                            },
                        },
                    },
                },
            },
        },
    }
    _, err := client.CreateSearchIndex(request)
    if err != nil {
        fmt.Println("Failed to create searchIndex with error:", err) // 検索インデックスの作成に失敗しました。エラー:
        return
    }
}