> For the complete documentation index, see [llms.txt](https://ifanr.gitbook.io/baas-js-sdk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ifanr.gitbook.io/baas-js-sdk/android-sdk/schema/query.md). # 查询数据项 ## 数据类型对应查询操作符表 | 数据类型 | 可使用的查询操作 | 说明 | | --------- | ------------------------------------------------------------------------- | ------------------------------------------------ | | String | =, in, notIn, !=, isNull, isNotNull, contains, matches, exists, notExists | | | Number | =, >, >=, <, <=, !=, in, notIn, isNull, isNotNull, exists, notExists | | | array | =, in, notIn, isNull, isNotNull, arrayContains, exists, notExists | file、object、date 类型的 array 不支持查询操作。如果进行查询，会返回空数组 | | Boolean | =, exists, notExists, isNull, isNotNull | | | Calendar | =, >, >=, <, <=, exists, notExists, isNull, isNotNull | | | CloudFile | isNull, isNotNull, exists, notExists | | | Object | =, hasKey, isNull, isNotNull, exists, notExists | | | pointer | =, in, notIn, !=, isNull, isNotNull, exists, notExists | | > **info** file、object、date 类型的 array 不支持查询操作。如果进行查询，会返回空数组 ## 操作步骤 1.通过 `tableName` 实例化一个 `Table` 对象，操作该对象即相当于操作对应的数据表 `Table table = new Table("tableName");` 2.示例化一个 `Query` 对象，在该对象上添加查询条件 `Query query = new Query();` 查看下面的文档，了解目前支持的查询条件 3.支持查询条件并执行查找操作 `PagedList records = table.query(query);` > **info** 注意：知晓云的 api URL 长度限定为 16386，超出则返回 502，请在构造查询条件时注意长度控制，如 in 操作符后边的数组长度、match 操作符后边的字符串长度等。 ## 示例 **请求示例** ```java Table table = new Table("tableName"); Where where = new Where(); // 设置查询条件（比较、字符串包含、组合等） // where.equalTo("key", "value") Query query = new Query(); // 设置分页、排序等 // query.orderBy("create_at") query.put(where); // 同步版本 try { PagedList records = table.query(query); // 操作成功 } catch (Exception e) { // 操作失败 } // 异步查询 table.queryInBackground(query, new Callback>() { @Override public void onSuccess(@Nullable PagedList recordPagedList) { // 查询成功，拿到数据集 } @Override public void onFailure(Exception e) { // 查询失败了 } }); ``` 异常请参考[异常](/baas-js-sdk/android-sdk/error-code.md) 常见的 HttpException.code ： | code | 可能的原因 | | ---- | ------------------------------------------ | | 400 | 1. 指定/过滤输出字段的字段名有误、2. GEO 查询参数有误、3. 查询语法错误 | | 404 | 数据表不存在 | ## 比较查询 operator 包含 =, !=, <, <=, >, >= ```java where.equalTo("key", "value"); where.lessThan("key", "value"); where.lessThanOrEqualTo("key", "value"); where.greaterThan("key", "value"); where.greaterThanOrEqualTo("key", "value"); where.notEqualTo("key", "value"); ``` ## 多个查询条件 当存在多个查询条件时，它们之间默认为 AND 关系，查询返回满足所有条件的记录，如下示例： ```java // 查询满足 key >= 10 & key != 5 的记录 where.greaterThanOrEqualTo("key", 10); where.notEqualTo("key", 5); ``` 多个查询条件之间需要更复杂的组合关系，可以查看以下 `组合查询` 小节。 ## 字符串查询 查询返回满足包含相应字符串的记录，如下示例： ```java // 例：{"name": "apple"} where.contains("name", "apple") // 查询name字段包含'apple'的记录，能正确匹配 where.contains("name", "app") // 查询name字段包含'app'的记录，能正确匹配 where.contains("name", "apple123") // 查询name字段包含'apple123'的记录，不能正确匹配 ``` 也支持正则匹配 ([正则表达式相关知识](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Guide/Regular_Expressions) )： ```java /* 以查找名字为例，name 字段必须为 string 类型 */ Where where = new Where(); // 查找 以 foo 开头的名字 where.matches("name", "^foo.*"); /* 以查找手机号码为例，phoneNumber 字段必须为 string 类型 */ // 查找 以 188 开头的手机号码 where.matches("phoneNumber", "^188\\d*"); // 查找 以 708 结尾的手机号码 where.matches("phoneNumber", "\\d*708$"); // 查找 以 188 开头的手机号码，以 708 结尾的手机号码 where.matches("phoneNumber", "^188\\d*708$"); ``` ## 正则匹配示例 ```java /* 以查找名字为例，name 字段必须为 string 类型 */ Where where = new Where(); // 查找 以 foo 开头的名字 where.matches("name", "^foo.*"); /* 以查找手机号码为例，phoneNumber 字段必须为 string 类型 */ // 查找 以 188 开头的手机号码 where.matches("phoneNumber", "^188\\d*"); // 查找 以 708 结尾的手机号码 where.matches("phoneNumber", "\\d*708$"); // 查找 以 188 开头的手机号码，以 708 结尾的手机号码 where.matches("phoneNumber", "^188\\d*708$"); ``` ## 数组查询 field 的类型不限制，field 的 value 含有 array 中的一个或多个 ```java where.containedIn(fieldName, array) ``` field 的类型不限制，field 的 value 不含有 array 中的任何一个 ```java where.notContainedIn(fieldName, array) ``` field 的类型必须为数组, field 的 value 包含 array 中的每一个 ( \* sdk version >= v1.1.1 ) ```java where.arrayContains(fieldName, array) ``` 如果希望查找数组中只包含指定数组中所有的值的记录，可以使用比较查询 ```java where.equalTo(fieldName, array) ``` **请求示例** ```java /* color 是类型为字符串的字段，desc 是类型为数组的字段 */ List array = Arrays.asList('green', 'red', 'yellow'); // 查询 color 是 green 或 red 或 yellow 的记录 where.containedIn('color', array); // 查询 desc 中包含 green 或 red 或 yellow 的记录 where.containedIn('desc', array); // 查询 color 不是 green、red 和 yellow 的记录 where.notContainedIn('color', array); // 查询 desc 中不包含 green、red 和 yellow 的记录 where.notContainedIn('desc', array); // 查询 desc 中包含 green、red 和 yellow 的记录 where.contains('desc', array); // 查询 desc 中只包含 green、red 和 yellow 的记录 where.equalTo('desc', array); ``` ## null 和 exists 查询 ```java where.isNull('name'); // 查询字段是否为 null where.isNotNull('name'); // 查询字段是否不为 null where.exists("name"); // 查询字段是否存在 where.notExists("name"); // 查询字段是否不存在 ``` ## hasKey 查询 （仅限 object 类型） **参数说明** | 参数 | 类型 | 必填 | 说明 | | ----- | ------ | -- | ------------------------------- | | key | String | 是 | 在数据表中的类型必须是 Object | | value | String | 是 | 需要检测的属性名, 只能包含字母、数字和下划线，必须以字母开头 | **示例代码** 假设数据表有如下数据行 ```javascript [ { 'id': '59a3c2b5afb7766a5ec6e84e', name: '战争与和平', publisherInfo: { name: 'abc出版社', }, }, { 'id': '59a3c2b5afb7766a5ec6e84g', name: '西游记', publisherInfo: { name: 'efg出版社', location: '广东省广州市天河区五山路 100 号' }, }, ] ``` 查询字段 publisherInfo 中存在 location 属性的数据行 ```java where.hasKey('publisherInfo', 'location') ``` 查询结果 ```javascript [ { 'id': '59a3c2b5afb7766a5ec6e84g', name: '西游记', publisherInfo: { name: 'efg出版社', location: '广东省广州市天河区五山路 100 号' }, } ] ``` 注意：目前暂不支持查询内嵌属性 假设数据行如下 ```javascript [ { 'id': '59a3c2b5afb7766a5ec6e84g', name: '西游记', publisherInfo: { abc: { name: 'efg出版社', location: '广东省广州市天河区五山路 100 号' } }, } ] ``` 则下面的查询语句是非法的 ```java where.hasKey('publisherInfo', 'abc.location') ``` ## 组合查询 ```java Where where1 = new Where(); where1.isNull("name"); Where where2 = new Where(); where2.greaterThan("price", 10); // and Where where = Where.and(where1, where2); // or Where where = Where.or(where1, where2); ``` ## 复杂组合查询 ```java Where where1 = new Where(); where1.isNull("name"); Where where2 = new Where(); where2.greaterThan("price", 10); Where where3 = new Where(); where3.greaterThan("amout", 3); // where1 和 where2 是 and，然后与 where3 进行 or Where finial = Where.or(Where.and(where1, where2), where3); Query query = new Query(); query.put(finial); ``` ## 获取符合筛选条件的数据总数 ```java Table table = new Table("Products"); Query query = new Query(); table.countInBackground(query, new BaseCallback() { @Override public void onSuccess(Integer integer) { // success } @Override public void onFailure(Throwable e) { // fail } }); ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://ifanr.gitbook.io/baas-js-sdk/android-sdk/schema/query.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.