ExistsQuery也叫NULL查询或者空值查询,一般用于判断稀疏数据中某一行的某一列是否存在。例如查询所有数据中address列不为空的行。

说明
  • 如果需要查询某一列为空,则ExistsQuery需要和BoolQuery中的mustNotQueries结合使用。
  • 以下情况会认为某一列不存在,以city列为例说明。
    • city列在多元索引中的数据类型为keyword(或其他基础类型),如果数据表中某行数据不存在city列,则多元索引认为该行数据的city列不存在。
    • city列在多元索引中的数据类型为keyword(或其他基础类型)数组,如果数据表中某行数据的city列为空数组,即"city" = "[]",则多元索引认为该行数据的city列不存在。

前提条件

  • 已初始化Client。具体操作,请参见初始化
  • 已创建数据表并写入数据。
  • 已在数据表上创建多元索引。具体操作,请参见创建多元索引

参数

参数 说明
fieldName 列名。
query 设置查询类型为TableStore.QueryType.EXISTS_QUERY。
getTotalCount 是否返回匹配的总行数,默认为false,表示不返回。

返回匹配的总行数会影响查询性能。

tableName 数据表名称。
indexName 多元索引名称。
columnsToGet 是否返回所有列。
  • 当设置returnType为TableStore.ColumnReturnType.RETURN_SPECIFIED时,需要通过returnNames指定返回的列。
  • 当设置returnType为TableStore.ColumnReturnType.RETURN_ALL时,表示返回所有列。
  • 当设置returnType为TableStore.ColumnReturnType.RETURN_ALL_FROM_INDEX时,表示返回多元索引中的所有列。.
  • 当设置returnType为TableStore.ColumnReturnType.RETURN_NONE时,表示不返回所有列,只返回主键列。

示例

client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, //如果只为了获取行数,无需获取具体数据,可以设置limit=0,即不返回任意一行数据。
        query: {
            queryType: TableStore.QueryType.EXISTS_QUERY,
                        query: {
                                fieldName: "pic_des"
                        },
        },
        getTotalCount: true //结果中的TotalCount可以表示表中数据的总行数,默认为false,表示不返回。
    },
    columnToGet: { //返回列设置,可设置为RETURN_SPECIFIED(自定义返回列)、RETURN_ALL(返回所有列)、RETURN_ALL_FROM_INDEX(返回多元索引中的所有列)、RETURN_NONE(不返回)。
        returnType: TableStore.ColumnReturnType.RETURN_SPECIFIED,
        returnNames: ["Col_1", "Col_2", "Col_3"]
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});