使用CreateSearchIndex接口在數據表上創建一個多元索引。一個數據表支持創建多個多元索引。創建多元索引時,您需要將要查詢的字段添加到多元索引中,您還可以配置多元索引路由鍵、預排序等高級選項。
前提條件
已初始化Client。具體操作,請參見初始化OTSClient。
已創建數據表,且數據表的數據生命周期(TimeToLive)必須為-1,最大版本數(MaxVersions)必須為1。
注意事項
創建多元索引時,多元索引中字段的數據類型必須與數據表中字段的數據類型相匹配。更多信息,請參見數據類型映射。
參數
創建多元索引時,需要指定數據表名稱(TableName)、多元索引名稱(IndexName)和索引的結構信息(IndexSchema),其中IndexSchema包含FieldSchemas(Index的所有字段的設置)、IndexSetting(索引設置)和IndexSort(索引預排序設置)。詳細參數說明請參見下表。
參數 | 說明 |
TableName | 數據表名稱。 |
IndexName | 多元索引名稱。 |
FieldSchemas | FieldSchema的列表,每個FieldSchema包含如下內容:
|
IndexSetting | 索引設置,包含RoutingFields設置。 RoutingFields(可選):自定義路由字段。可以選擇部分主鍵列作為路由字段,在進行索引數據寫入時,會根據路由字段的值計算索引數據的分布位置,路由字段的值相同的記錄會被索引到相同的數據分區中。 |
IndexSort | 索引預排序設置,包含Sorters設置。如果不設置,則默認按照主鍵排序。 說明 含有Nested類型的索引不支持IndexSort,沒有預排序。 Sorters(必選):索引的預排序方式,支持按照主鍵排序和字段值排序。關于排序的更多信息,請參見排序和翻頁。
|
TimeToLive | 可選參數,默認值為-1。數據生命周期(TTL),即數據的保存時間。 當數據的保存時間超過設置的數據生命周期時,系統會自動清理超過數據生命周期的數據。 數據生命周期至少為86400秒(一天)或-1(數據永不過期)。 |
示例
創建多元索引時使用默認配置
以下示例用于創建一個多元索引。該多元索引包含Keyword_type_col(Keyword類型)、Long_type_col(Long類型)和Text_type_col(TEXT類型)三列。并且開啟排序與統計聚合功能。
/// <summary>
/// 創建一個多元索引,包含Keyword_type_col、Long_type_col、Text_type_col三個屬性列,類型分別設置為不分詞字符串(Keyword)、整型(Long)、分詞字符串(Text)。
/// </summary>
/// <param name="otsClient"></param>
public static void CreateSearchIndex(OTSClient otsClient)
{
//設置數據表名稱和多元索引名稱。
CreateSearchIndexRequest request = new CreateSearchIndexRequest(TableName, IndexName);
List<FieldSchema> FieldSchemas = new List<FieldSchema>() {
new FieldSchema(Keyword_type_col,FieldType.KEYWORD){ //設置字段名和字段類型。
index =true, //設置開啟索引。
EnableSortAndAgg =true //設置開啟排序與統計聚合功能。
},
new FieldSchema(Long_type_col,FieldType.LONG){ index=true,EnableSortAndAgg=true},
new FieldSchema(Text_type_col,FieldType.TEXT){ index=true}
};
request.IndexSchame = new IndexSchema()
{
FieldSchemas = FieldSchemas
};
//調用client創建多元索引。
CreateSearchIndexResponse response = otsClient.CreateSearchIndex(request);
Console.WriteLine("Searchindex is created: " + IndexName);
}
創建多元索引時指定IndexSort
以下示例用于創建一個多元索引,多元索引包含Keyword_type_col、Long_type_col、Text_type_col三列,類型分別設置為字符串(Keyword)、整型(Long)、分詞字符串(TEXT)。同時配置按照Long_type_col列進行預排序。
/// <summary>
/// 創建一個多元索引,包含Keyword_type_col、Long_type_col、Text_type_col三個屬性列,類型分別設置為不分詞字符串(Keyword)、整型(Long)、分詞字符串(Text)。
/// </summary>
/// <param name="otsClient"></param>
public static void CreateSearchIndexWithIndexSort(OTSClient otsClient)
{
//設置數據表名稱和多元索引名稱。
CreateSearchIndexRequest request = new CreateSearchIndexRequest(TableName, IndexName);
List<FieldSchema> FieldSchemas = new List<FieldSchema>() {
new FieldSchema(Keyword_type_col,FieldType.KEYWORD){ //設置字段名和字段類型。
index =true, //設置開啟索引。
EnableSortAndAgg =true //設置開啟排序與統計聚合功能。
},
new FieldSchema(Long_type_col,FieldType.LONG){ index=true,EnableSortAndAgg=true},
new FieldSchema(Text_type_col,FieldType.TEXT){ index=true}
};
request.IndexSchame = new IndexSchema()
{
FieldSchemas = FieldSchemas,
//按照Long_type_col列進行預排序,Long_type_col列必須建立索引且開啟EnableSortAndAgg。
IndexSort = new DataModel.Search.Sort.Sort()
{
Sorters = new List<DataModel.Search.Sort.ISorter>
{
new DataModel.Search.Sort.FieldSort(Long_type_col, DataModel.Search.Sort.SortOrder.ASC)
}
}
};
CreateSearchIndexResponse response = otsClient.CreateSearchIndex(request);
Console.WriteLine("Searchindex is created: " + IndexName);
}
創建一個包含日期列和虛擬列的多元索引
以下示例用于創建一個多元索引,該多元索引包含pk0(Keyword類型)、pk1(Long類型)、date_col(Date類型)、geo_col(Geo-Point類型)和col0_v1(Text類)字段。其中虛擬列col0_v1的原始列為col0。返回結果按照pk1列進行升序排序。
/// <summary>
/// 創建一個包含日期列和虛擬列的多元索引。
/// </summary>
/// <param name="otsClient"></param>
public static void CreateSearchIndex(OTSClient otsClient)
{
List<FieldSchema> fieldSchemas = new List<FieldSchema> {
new FieldSchema("pk0", FieldType.KEYWORD)
{
index = true,
EnableSortAndAgg = true
},
new FieldSchema("pk1", FieldType.LONG)
{
index = true,
EnableSortAndAgg = true
},
new FieldSchema("date_col", FieldType.DATE)
{
index = true,
DateFormats = new List<string>(){
"yyyy-MM-dd'T'HH:mm:ss.SSSSSS",
"yyyy-MM-dd'T'HH:mm:ss.SSS"
}
},
new FieldSchema("geo_col", FieldType.GEO_POINT)
{
index = true,
EnableSortAndAgg = true
},
new FieldSchema("col0_v1", FieldType.TEXT)
{
index = true,
Analyzer = Analyzer.Split,
AnalyzerParameter = new SingleWordAnalyzerParameter(true, true),
IsVirtualField = true,
SourceFieldNames = new List<string> { "col0" }
},
};
CreateSearchIndexRequest request = new CreateSearchIndexRequest(TableName, IndexName);
request.IndexSchame = new IndexSchema()
{
FieldSchemas = fieldSchemas,
IndexSort = new Sort(new List<ISorter> { new FieldSort("pk1", SortOrder.ASC) })
};
request.TimeToLive = -1;
otsClient.CreateSearchIndex(request);
}
常見問題
相關文檔
創建多元索引后,您可以選擇合適的查詢類型進行多維度數據查詢。多元索引查詢類型包括精確查詢、多詞精確查詢、全匹配查詢、匹配查詢、短語匹配查詢、前綴查詢、范圍查詢、通配符查詢、地理位置查詢、多條件組合查詢、嵌套類型查詢和列存在性查詢。
當通過Search接口查詢數據時,如果要對結果集進行排序或者翻頁,您可以使用排序和翻頁功能來實現。具體操作,請參見排序和翻頁。
當通過Search接口查詢數據時,如果要按照某一列對結果集做折疊,使對應類型的數據在結果展示中只出現一次,您可以使用折疊(去重)功能來實現。具體操作,請參見折疊(去重)。
如果要進行數據分析,例如求最值、求和、統計行數等,您可以使用Search接口的統計聚合功能或者SQL查詢來實現。具體操作,請參見統計聚合和SQL查詢。
如果要快速導出數據,而不關心整個結果集的順序時,您可以使用ParallelScan接口和ComputeSplits接口實現多并發導出數據。具體操作,請參見并發導出數據。
如果要在多元索引中新增、更新或者刪除索引列,您可以使用動態修改schema功能實現。具體操作,請參見動態修改schema。
如果要獲取某個數據表關聯的所有多元索引的列表信息,您可以使用列出多元索引列表功能實現。具體操作,請參見列出多元索引列表。
如果要查詢多元索引的描述信息,包括多元索引的字段信息和索引配置等,您可以使用查詢多元索引描述信息功能實現。具體操作,請參見查詢多元索引描述信息。
如果不再需要使用多元索引,您可以刪除多元索引。具體操作,請參見刪除多元索引。