Usage QueryBuilder
import 'package:in_app_query/in_app_query.dart';
void main() {
List<Map<String, dynamic>> data = [
{
"id": "id_1",
'username': 'daniel_white',
'email': 'daniel_white@example.com',
'age': 43,
'country': 'India'
},
{
"id": "id_2",
'username': 'olivia_adams',
'email': 'olivia_adams@hotmail.com',
'age': 57,
'country': 'Japan'
},
{
"id": "id_3",
'username': 'olivia_adams',
'email': 'olivia_adams@test.com',
'age': 36,
'country': 'Brazil'
},
{
"id": "id_4",
'username': 'olivia_adams',
'email': 'olivia_adams@demo.com',
'age': 53,
'country': 'Japan'
},
{
"id": "id_5",
'username': 'peter_brown',
'email': 'peter_brown@gmail.com',
'age': 57,
'country': 'China'
},
{
"id": "id_6",
'username': 'olivia_adams',
'email': 'olivia_adams@yahoo.com',
'age': 30,
'country': 'Brazil'
},
{
"id": "id_7",
'username': 'emma_smith',
'email': 'emma_smith@example.com',
'age': 49,
'country': 'Germany'
},
{
"id": "id_8",
'username': 'olivia_adams',
'email': 'olivia_adams@demo.com',
'age': 53,
'country': 'Canada'
},
{
"id": "id_9",
'username': 'peter_brown',
'email': 'peter_brown@hotmail.com',
'age': 65,
'country': 'Brazil'
},
{
"id": "id_10",
'username': 'sarah_carter',
'email': 'sarah_carter@gmail.com',
'age': 55,
'country': 'Japan'
},
{
"id": "id_11",
'username': null,
'email': 'sarah_carter@gmail.com',
'age': 55,
'country': 'Japan'
},
{
"id": "id_12",
'username': 'olivia_adams',
'email': 'olivia_adams@demo.com',
'age': null,
'country': 'US'
},
{
"id": "id_13",
'username': 'olivia_adams',
'email': 'olivia_adams@yahoo.com',
'age': 53,
'country': 'Australia'
},
];
_queryTest(data);
_sortingTest(data);
_selectionTest();
_pagination(data);
}
void _queryTest(List<Map<String, dynamic>> data) {
// Simple query
var simple = QueryBuilder(data)
// .where('username', isNull: true)
// .where('username', isNull: false)
.where('username', isEqualTo: "olivia_adams")
// .where('username', isNotEqualTo: "daniel_white")
// .where('age', isGreaterThan: 60)
// .where('age', isGreaterThanOrEqualTo: 60)
// .where('age', isLessThan: 60)
.where('age', isLessThanOrEqualTo: 50)
// .where('posts', arrayContains: "a")
// .where('posts', arrayContains: "x")
// .where('posts', arrayContainsAny: ["a", "x"])
// .where('posts', arrayContainsAny: ["x", "y"])
// .where('posts', arrayNotContains: "x")
// .where('posts', arrayNotContains: "a")
// .where('posts', arrayNotContainsAny: ["a", "x"])
// .where('posts', arrayNotContainsAny: ["a", "b"])
.build();
simple.output(
"Query output(simple): Query by username == olivia_adams and age <= 50");
/*
Query output(simple): Query by username == olivia_adams and age <= 50
{id: id_3, username: olivia_adams, email: olivia_adams@test.com, age: 36, country: Brazil}
{id: id_6, username: olivia_adams, email: olivia_adams@yahoo.com, age: 30, country: Brazil}
*/
// complex query
var complex = QueryBuilder(data)
.where(const Filter.or([
Filter("age", isEqualTo: 30),
Filter('age', isEqualTo: 53),
Filter('age', isEqualTo: 63),
Filter('country', isEqualTo: "Japan"),
]))
.where(const Filter.and([
Filter('country', isEqualTo: "Japan"),
Filter('username', isEqualTo: "olivia_adams"),
]))
.build();
complex.output("Query output(filter): Query with OR and AND condition");
/*
Query output(filter): Query with OR and AND condition
{id: id_4, username: olivia_adams, email: olivia_adams@demo.com, age: 53, country: Japan}
{id: id_2, username: olivia_adams, email: olivia_adams@hotmail.com, age: 57, country: Japan}
*/
}
void _sortingTest(List<Map<String, dynamic>> data) {
var result = QueryBuilder(data)
.orderBy("username")
.orderBy("email")
.orderBy("age", descending: true)
.orderBy("country")
.build();
result.output(
"Sorted output: Sorted by username(asc), email(asc), age(des) and country(asc)");
/*
Sorted output: Sorted by username(asc), email(asc), age(des) and country(asc)
{id: id_1, username: daniel_white, email: daniel_white@example.com, age: 43, country: India}
{id: id_7, username: emma_smith, email: emma_smith@example.com, age: 49, country: Germany}
{id: id_8, username: olivia_adams, email: olivia_adams@demo.com, age: 53, country: Canada}
{id: id_4, username: olivia_adams, email: olivia_adams@demo.com, age: 53, country: Japan}
{id: id_12, username: olivia_adams, email: olivia_adams@demo.com, age: null, country: US}
{id: id_2, username: olivia_adams, email: olivia_adams@hotmail.com, age: 57, country: Japan}
{id: id_3, username: olivia_adams, email: olivia_adams@test.com, age: 36, country: Brazil}
{id: id_13, username: olivia_adams, email: olivia_adams@yahoo.com, age: 53, country: Australia}
{id: id_6, username: olivia_adams, email: olivia_adams@yahoo.com, age: 30, country: Brazil}
{id: id_5, username: peter_brown, email: peter_brown@gmail.com, age: 57, country: China}
{id: id_9, username: peter_brown, email: peter_brown@hotmail.com, age: 65, country: Brazil}
{id: id_10, username: sarah_carter, email: sarah_carter@gmail.com, age: 55, country: Japan}
{id: id_11, username: null, email: sarah_carter@gmail.com, age: 55, country: Japan}
*/
}
void _selectionTest() {
List<Map<String, dynamic>> data = [
{'username': 'alice', 'age': 25, 'country': 'USA'},
{'username': 'bob', 'age': 30, 'country': 'Canada'},
{'username': 'charlie', 'age': 35, 'country': 'Australia'},
{'username': 'daniel', 'age': 40, 'country': 'UK'},
{'username': 'emma', 'age': 45, 'country': 'Germany'}
];
// Data selection with QueryBuilder like endAt
var endAt = QueryBuilder(data).endAt(['daniel']).build();
endAt.output("Selection output: endAt");
/*
Selection output: endAt
{username: alice, age: 25, country: USA}
{username: bob, age: 30, country: Canada}
{username: charlie, age: 35, country: Australia}
{username: daniel, age: 40, country: UK}
*/
// Data selection with QueryBuilder like startAtDocument
var endAtDocument = QueryBuilder(data).endAtDocument(
{'username': 'daniel', 'age': 40, 'country': 'UK'}).build();
endAtDocument.output("Selection output: endAtDocument");
/*
Selection output: endAtDocument
{username: alice, age: 25, country: USA}
{username: bob, age: 30, country: Canada}
{username: charlie, age: 35, country: Australia}
{username: daniel, age: 40, country: UK}
*/
// Data selection with QueryBuilder like endBefore
var endBefore = QueryBuilder(data).endBefore(['daniel']).build();
endBefore.output("Selection output: endBefore");
/*
Selection output: endBefore
{username: alice, age: 25, country: USA}
{username: bob, age: 30, country: Canada}
{username: charlie, age: 35, country: Australia}
*/
// Data selection with QueryBuilder like endBeforeDocument
var endBeforeDocument = QueryBuilder(data).endBeforeDocument(
{'username': 'daniel', 'age': 40, 'country': 'UK'}).build();
endBeforeDocument.output("Selection output: endBeforeDocument");
/*
Selection output: endBeforeDocument
{username: alice, age: 25, country: USA}
{username: bob, age: 30, country: Canada}
{username: charlie, age: 35, country: Australia}
*/
// Data selection with QueryBuilder like startAt
var startAt = QueryBuilder(data).startAt(['bob']).build();
startAt.output("Selection output: startAt");
/*
Selection output: startAt
{username: bob, age: 30, country: Canada}
{username: charlie, age: 35, country: Australia}
{username: daniel, age: 40, country: UK}
{username: emma, age: 45, country: Germany}
*/
// Data selection with QueryBuilder like startAtDocument
var startAtDocument = QueryBuilder(data).startAtDocument(
{'username': 'bob', 'age': 30, 'country': 'Canada'}).build();
startAtDocument.output("Selection output: startAtDocument");
/*
Selection output: startAtDocument
{username: bob, age: 30, country: Canada}
{username: charlie, age: 35, country: Australia}
{username: daniel, age: 40, country: UK}
{username: emma, age: 45, country: Germany}
*/
// Data selection with QueryBuilder like startAfter
var startAfter = QueryBuilder(data).startAfter(['bob']).build();
startAfter.output("Selection output: startAfter");
/*
Selection output: startAfter
{username: charlie, age: 35, country: Australia}
{username: daniel, age: 40, country: UK}
{username: emma, age: 45, country: Germany}
*/
// Data selection with QueryBuilder like startAfterDocument
var startAfterDocument = QueryBuilder(data).startAfterDocument(
{'username': 'bob', 'age': 30, 'country': 'Canada'}).build();
startAfterDocument.output("Selection output: startAfterDocument");
/*
Selection output: startAfterDocument
{username: charlie, age: 35, country: Australia}
{username: daniel, age: 40, country: UK}
{username: emma, age: 45, country: Germany}
*/
// Data selection with QueryBuilder like startAt and endAt
var startAtEndAt = QueryBuilder(data).startAt(
["bob", 30],
).endAt(
['daniel', 40],
).build();
startAtEndAt.output("Selection output: startAtEndAt");
/*
Selection output: startAtEndAt
{username: bob, age: 30, country: Canada}
{username: charlie, age: 35, country: Australia}
{username: daniel, age: 40, country: UK}
*/
// Data selection with QueryBuilder like startAtDocument and endAtDocument
var startAtDocumentEndAtDocument = QueryBuilder(data).startAtDocument(
{'username': 'bob', 'age': 30, 'country': 'Canada'},
).endAtDocument(
{'username': 'daniel', 'age': 40, 'country': 'UK'},
).build();
startAtDocumentEndAtDocument
.output("Selection output: startAtDocumentEndAtDocument");
/*
Selection output: startAtDocumentEndAtDocument
{username: bob, age: 30, country: Canada}
{username: charlie, age: 35, country: Australia}
{username: daniel, age: 40, country: UK}
*/
// Data selection with QueryBuilder like startAfter and endBefore
var startAfterEndBefore = QueryBuilder(data).startAfter(
["bob", 30],
).endBefore(
['daniel', 40],
).build();
startAfterEndBefore.output("Selection output: startAfterEndBefore");
/*
Selection output: startAfterEndBefore
{username: charlie, age: 35, country: Australia}
*/
// Data selection with QueryBuilder like startAfterDocument and endBeforeDocument
var startAfterDocumentEndBeforeDocument =
QueryBuilder(data).startAfterDocument(
{'username': 'bob', 'age': 30, 'country': 'Canada'},
).endBeforeDocument(
{'username': 'daniel', 'age': 40, 'country': 'UK'},
).build();
startAfterDocumentEndBeforeDocument
.output("Selection output: startAfterDocumentEndBeforeDocument");
/*
Selection output: startAfterDocumentEndBeforeDocument
{username: charlie, age: 35, country: Australia}
*/
}
void _pagination(List<Map<String, dynamic>> data) {
// Simple pagination
var simple = QueryBuilder(data)
.where("username", isNull: false)
.where("country", isEqualTo: "Japan")
.orderBy("age", descending: true)
.limit(3)
.build();
simple.output("Pagination output: simple");
/*
Pagination output: simple:
{id: id_2, username: olivia_adams, email: olivia_adams@hotmail.com, age: 57, country: Japan}
{id: id_10, username: sarah_carter, email: sarah_carter@gmail.com, age: 55, country: Japan}
{id: id_4, username: olivia_adams, email: olivia_adams@demo.com, age: 53, country: Japan}
*/
// Complex pagination
var pagination = QueryBuilder(data)
.where("username", isNull: false)
.startAfter(["id_3"])
.limit(3)
.build();
pagination.output("Pagination output: selection");
/*
Pagination output: complex
{id: id_4, username: olivia_adams, email: olivia_adams@demo.com, age: 53, country: Japan}
{id: id_5, username: peter_brown, email: peter_brown@gmail.com, age: 57, country: China}
{id: id_6, username: olivia_adams, email: olivia_adams@yahoo.com, age: 30, country: Brazil}
*/
}
extension on List {
void output(String name) {
print('\n$name');
forEach(print);
}
}
