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, // 長整数型
                Index:            proto.Bool(true), // インデックスを有効にする
                EnableSortAndAgg: proto.Bool(true), // ソートと集計を有効にする
            },
            {
                FieldName: proto.String("col_vector"),
                FieldType: tablestore.FieldType_VECTOR, // ベクトル型
                Index:     proto.Bool(true), // インデックスを有効にする
                VectorOptions: &tablestore.VectorOptions{
                    VectorDataType:   tablestore.VectorDataType_FLOAT_32.Enum(), // ベクトルのデータ型をfloat32に設定
                    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)
}

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)
}

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

次のサンプルコードは、ハイライト機能を有効にして検索インデックスを作成する方法の例を示しています。この例では、検索インデックスは、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, // 長整数型
                Index:            proto.Bool(true), // インデックスを有効にする
                EnableSortAndAgg: proto.Bool(true), // ソートと集計を有効にする
            },
            {// ネストされていないフィールドのハイライト機能を有効にします。
                FieldName: proto.String("col_text"),
                FieldType: tablestore.FieldType_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
    }
}