Some features; (aliyun#67)

Author: xjtushilei

README-EN.md

@@ -13,6 +13,18 @@
 
 
 ## Version Feature Updates
+- Version: 5.5.0
+  - Search: GroupByDateHistogram
+  - GroupByHistogram Support Offset Parameter
+  - DescribeTable API Support IndexSyncPhase
+  - DescribeSearchIndex Support IndexStatus
+  - Search: GroupByGeoGrid
+  - Search: Function Score
+  - Search: KnnVectorQuery
+  - Search: Highlight
+  - Nested Query Highlight
+  - Search: GroupByComposite
+  - Field Sort Support Missing Field Parameter
 - Version: 5.4.1
   - fix wrong time unit in default_retry_policy.js
 - Version: 5.3.1

README.md

@@ -13,6 +13,18 @@
 
 
 ## 版本特性
+- 版本: 5.5.0
+  - Search 新增：GroupByDateHistogram 功能
+  - GroupByHistogram 支持 offset 参数
+  - DescribeTable API 新增 IndexSyncPhase 返回
+  - DescribeSearchIndex 新增 IndexStatus 返回
+  - Search 新增：GroupByGeoGrid 功能
+  - Search 新增：完整 Function Score 功能
+  - Search 新增：KnnVectoryQuery 功能
+  - Search 新增：Highlight 功能
+  - Nested Query 支持 Highlight 参数
+  - Search 新增：GroupByComposite 功能
+  - Field Sort 支持 Missing Field 参数
 - 版本：5.4.1
   - 修复默认重试策略中的默认值
 - 版本：5.3.1

lib/protocol/decoder.js

@@ -31,6 +31,14 @@ TableStore.decoder = {
     },
     decodeDescribeTable: function (buffers) {
         var response = tsProtos.DescribeTableResponse.decode(buffers);
+        for (var i in response.indexMetas) {
+            var indexMeta = response.indexMetas[i];
+            if (indexMeta.indexSyncPhase === tsProtos.IndexSyncPhase.ISP_INCR) {
+                response.indexMetas[i].indexSyncPhase = TableStore.SyncPhase.INCR;
+            } else {
+                response.indexMetas[i].indexSyncPhase = TableStore.SyncPhase.FULL;
+            }
+        }
         return response;
     },
     _parseRowItem: function (row) {
@@ -66,7 +74,7 @@ TableStore.decoder = {
     decodeGetRange: function (buffers) {
         var returnResp = {};
         var response = tsProtos.GetRangeResponse.decode(buffers);
-        
+
         returnResp.consumed = response.consumed;
         response.rows.limit = response.rows.offset + response.rows.length;
         if (response.rows && response.rows.limit > response.rows.offset) {
@@ -85,11 +93,11 @@ TableStore.decoder = {
         } else {
             returnResp.nextStartPrimaryKey = null;
         }
-        
+
         returnResp.compressType = response.compressType;
         returnResp.dataBlockType = response.dataBlockType;
         returnResp.nextToken = response.nextToken;
-        
+
         return returnResp;
     },
     decodeBatchGetRow: function (buffers) {
@@ -215,8 +223,31 @@ TableStore.decoder = {
                 }
             }
         }
+        response.indexStatus = TableStore.decoder._parseIndexStatus(response.indexStatus);
         return response;
     },
+    _parseIndexStatus: function (indexStatus) {
+        var parseIndexStatus = {
+            statusDescription: indexStatus.statusDescription
+        }
+        switch (indexStatus.status) {
+            case tsSearchProtos.IndexStatusEnum.PENDING: {
+                parseIndexStatus.status = TableStore.IndexStatus.PENDING;
+                break;
+            }
+            case tsSearchProtos.IndexStatusEnum.FAILED: {
+                parseIndexStatus.status = TableStore.IndexStatus.FAILED;
+                break;
+            }
+            case tsSearchProtos.IndexStatusEnum.RUNNING: {
+                parseIndexStatus.status = TableStore.IndexStatus.RUNNING;
+                break;
+            }
+            default:
+                parseIndexStatus.status = TableStore.IndexStatus.UNKNOWN;
+        }
+        return parseIndexStatus;
+    },
     decodeUpdateSearchIndex: function (buffers) {
         return tsSearchProtos.UpdateSearchIndexResponse.decode(buffers);
     },
@@ -253,8 +284,66 @@ TableStore.decoder = {
             result.groupBys = TableStore.decoder._parseGroupBys(response.groupBys);
         }
 
+        result.searchHits = [];
+        if(response.rows.length !== response.searchHits.length && response.searchHits.length !== 0) {
+            console.log("the row count is not equal to search extra result item count in server response body, ignore the search extra result items.");
+        } else {
+            for (var i in response.searchHits) {
+                result.searchHits.push(TableStore.decoder._parseSearchHit(response.searchHits[i], response.rows[i]));
+            }
+        }
+        if (response.consumed) {
+            result.consumed = response.consumed;
+        }
+        if (response.reservedConsumed) {
+            result.reservedConsumed = response.reservedConsumed;
+        }
+
         return result;
     },
+    _parseSearchHit(searchHit, row) {
+        var parseSearchHit = {
+            row: row,
+        }
+        if (searchHit.nestedDocOffset) {
+            parseSearchHit.nestedDocOffset = searchHit.nestedDocOffset;
+        }
+        if (searchHit.score) {
+            parseSearchHit.score = searchHit.score;
+        }
+        if (searchHit.highlightResult) {
+            parseSearchHit.highlightResultItem = TableStore.decoder._parseHighlightResultItem(searchHit);
+        }
+        parseSearchHit.searchInnerHits = new Map();
+        for (var item in searchHit.searchInnerHits) {
+            var searchInnerHit = searchHit.searchInnerHits[item];
+            parseSearchHit.searchInnerHits.set(searchInnerHit.path, TableStore.decoder._parseSearchInnerHit(searchInnerHit))
+        }
+        return parseSearchHit;
+    },
+    _parseSearchInnerHit(searchInnerHit) {
+        var parseSearchInnerHit = {
+            path: searchInnerHit.path,
+        }
+        parseSearchInnerHit.subSearchHits = [];
+        for (var item in searchInnerHit.searchHits) {
+            parseSearchInnerHit.subSearchHits.push(this._parseSearchHit(searchInnerHit.searchHits[item], null));
+        }
+        return parseSearchInnerHit;
+    },
+    _parseHighlightResultItem(searchHit) {
+        var highlightFields = new Map();
+        for (var item in searchHit.highlightResult.highlightFields) {
+            var parseHighlightField = {
+                fragments: searchHit.highlightResult.highlightFields[item].fieldFragments,
+            }
+            highlightFields.set(searchHit.highlightResult.highlightFields[item].fieldName, parseHighlightField)
+        }
+        var parseHighlightResultItem={
+            highlightFields: highlightFields
+        }
+        return parseHighlightResultItem;
+    },
     _parseSearchVariant(bytes) {
         let inputStream = new TableStore.PlainBufferInputStream(bytes);
         let codedInputStream = new TableStore.PlainBufferCodedInputStream(inputStream);
@@ -457,6 +546,54 @@ TableStore.decoder = {
                     items: resultItems,
                 };
             }
+            case tsSearchProtos.GroupByType.GROUP_BY_DATE_HISTOGRAM: {
+                let groupByDateHistogramResult = tsSearchProtos.GroupByDateHistogramResult.decode(groupByResultBody);
+                let resultItems = [];
+                TableStore.util.arrayEach(groupByDateHistogramResult.groupByDateHistogramItems, function (item) {
+                    let itemResult = {
+                        timeStamp: item.timestamp,
+                        rowCount: item.rowCount,
+                    };
+                    TableStore.decoder._parseSubAggAndGroupByResult(itemResult, item);
+                    resultItems.push(itemResult);
+                });
+                return {
+                    items: resultItems,
+                };
+            }
+            case tsSearchProtos.GroupByType.GROUP_BY_GEO_GRID: {
+                let groupByGeoGridResult = tsSearchProtos.GroupByGeoGridResult.decode(groupByResultBody);
+                let resultItems = [];
+                TableStore.util.arrayEach(groupByGeoGridResult.groupByGeoGridResultItems, function (item) {
+                    let itemResult = {
+                        key: item.key,
+                        rowCount: item.rowCount,
+                        geoGrid: item.geoGrid,
+                    };
+                    TableStore.decoder._parseSubAggAndGroupByResult(itemResult, item);
+                    resultItems.push(itemResult);
+                });
+                return {
+                    items: resultItems,
+                };
+            }
+            case tsSearchProtos.GroupByType.GROUP_BY_COMPOSITE: {
+                let groupByCompositeResult = tsSearchProtos.GroupByCompositeResult.decode(groupByResultBody);
+                let resultItems = [];
+                TableStore.util.arrayEach(groupByCompositeResult.groupByCompositeResultItems, function (item) {
+                    let itemResult = {
+                        keys: item.keys,
+                        rowCount: item.rowCount,
+                    };
+                    TableStore.decoder._parseSubAggAndGroupByResult(itemResult, item);
+                    resultItems.push(itemResult);
+                });
+                return {
+                    sourceNames: groupByCompositeResult.sourceGroupByNames,
+                    nextToken: groupByCompositeResult.nextToken || null,
+                    items: resultItems,
+                };
+            }
             default:
                 throw new Error("not exist groupByType: " + groupByType);
         }