I am looking to add a simple search field, would like to use something like
collectionRef.where('name', 'contains', 'searchTerm')
I tried using where('name', '==', '%searchTerm%'), but it didn't return anything.
I agree with #Kuba's answer, But still, it needs to add a small change to work perfectly for search by prefix. here what worked for me
For searching records starting with name queryText
collectionRef
.where('name', '>=', queryText)
.where('name', '<=', queryText+ '\uf8ff')
The character \uf8ff used in the query is a very high code point in the Unicode range (it is a Private Usage Area [PUA] code). Because it is after most regular characters in Unicode, the query matches all values that start with queryText.
Full-Text Search, Relevant Search, and Trigram Search!
UPDATE - 2/17/21 - I created several new Full Text Search Options.
See Code.Build for details.
Also, side note, dgraph now has websockets for realtime... wow, never saw that coming, what a treat! Cloud Dgraph - Amazing!
--Original Post--
A few notes here:
1.) \uf8ff works the same way as ~
2.) You can use a where clause or start end clauses:
ref.orderBy('title').startAt(term).endAt(term + '~');
is exactly the same as
ref.where('title', '>=', term).where('title', '<=', term + '~');
3.) No, it does not work if you reverse startAt() and endAt() in every combination, however, you can achieve the same result by creating a second search field that is reversed, and combining the results.
Example: First you have to save a reversed version of the field when the field is created. Something like this:
// collection
const postRef = db.collection('posts')
async function searchTitle(term) {
// reverse term
const termR = term.split("").reverse().join("");
// define queries
const titles = postRef.orderBy('title').startAt(term).endAt(term + '~').get();
const titlesR = postRef.orderBy('titleRev').startAt(termR).endAt(termR + '~').get();
// get queries
const [titleSnap, titlesRSnap] = await Promise.all([
titles,
titlesR
]);
return (titleSnap.docs).concat(titlesRSnap.docs);
}
With this, you can search the last letters of a string field and the first, just not random middle letters or groups of letters. This is closer to the desired result. However, this won't really help us when we want random middle letters or words. Also, remember to save everything lowercase, or a lowercase copy for searching, so case won't be an issue.
4.) If you have only a few words, Ken Tan's Method will do everything you want, or at least after you modify it slightly. However, with only a paragraph of text, you will exponentially create more than 1MB of data, which is bigger than firestore's document size limit (I know, I tested it).
5.) If you could combine array-contains (or some form of arrays) with the \uf8ff trick, you might could have a viable search that does not reach the limits. I tried every combination, even with maps, and a no go. Anyone figures this out, post it here.
6.) If you must get away from ALGOLIA and ELASTIC SEARCH, and I don't blame you at all, you could always use mySQL, postSQL, or neo4Js on Google Cloud. They are all 3 easy to set up, and they have free tiers. You would have one cloud function to save the data onCreate() and another onCall() function to search the data. Simple...ish. Why not just switch to mySQL then? The real-time data of course! When someone writes DGraph with websocks for real-time data, count me in!
Algolia and ElasticSearch were built to be search-only dbs, so there is nothing as quick... but you pay for it. Google, why do you lead us away from Google, and don't you follow MongoDB noSQL and allow searches?
There's no such operator, allowed ones are ==, <, <=, >, >=.
You can filter by prefixes only, for example for everything that starts between bar and foo you can use
collectionRef
.where('name', '>=', 'bar')
.where('name', '<=', 'foo')
You can use external service like Algolia or ElasticSearch for that.
While Kuba's answer is true as far as restrictions go, you can partially emulate this with a set-like structure:
{
'terms': {
'reebok': true,
'mens': true,
'tennis': true,
'racket': true
}
}
Now you can query with
collectionRef.where('terms.tennis', '==', true)
This works because Firestore will automatically create an index for every field. Unfortunately this doesn't work directly for compound queries because Firestore doesn't automatically create composite indexes.
You can still work around this by storing combinations of words but this gets ugly fast.
You're still probably better off with an outboard full text search.
While Firebase does not explicitly support searching for a term within a string,
Firebase does (now) support the following which will solve for your case and many others:
As of August 2018 they support array-contains query. See: https://firebase.googleblog.com/2018/08/better-arrays-in-cloud-firestore.html
You can now set all of your key terms into an array as a field then query for all documents that have an array that contains 'X'. You can use logical AND to make further comparisons for additional queries. (This is because firebase does not currently natively support compound queries for multiple array-contains queries so 'AND' sorting queries will have to be done on client end)
Using arrays in this style will allow them to be optimized for concurrent writes which is nice! Haven't tested that it supports batch requests (docs don't say) but I'd wager it does since its an official solution.
Usage:
collection("collectionPath").
where("searchTermsArray", "array-contains", "term").get()
Per the Firestore docs, Cloud Firestore doesn't support native indexing or search for text fields in documents. Additionally, downloading an entire collection to search for fields client-side isn't practical.
Third-party search solutions like Algolia and Elastic Search are recommended.
I'm sure Firebase will come out with "string-contains" soon to capture any index[i] startAt in the string...
But
I’ve researched the webs and found this solution thought of by someone else
set up your data like this
state = { title: "Knitting" };
// ...
const c = this.state.title.toLowerCase();
var array = [];
for (let i = 1; i < c.length + 1; i++) {
array.push(c.substring(0, i));
}
firebase
.firestore()
.collection("clubs")
.doc(documentId)
.update({
title: this.state.title,
titleAsArray: array
});
query like this
firebase.firestore()
.collection("clubs")
.where(
"titleAsArray",
"array-contains",
this.state.userQuery.toLowerCase()
)
As of today (18-Aug-2020), there are basically 3 different workarounds, which were suggested by the experts, as answers to the question.
I have tried them all. I thought it might be useful to document my experience with each one of them.
Method-A: Using: (dbField ">=" searchString) & (dbField "<=" searchString + "\uf8ff")
Suggested by #Kuba & #Ankit Prajapati
.where("dbField1", ">=", searchString)
.where("dbField1", "<=", searchString + "\uf8ff");
A.1 Firestore queries can only perform range filters (>, <, >=, <=) on a single field. Queries with range filters on multiple fields are not supported. By using this method, you can't have a range operator in any other field on the db, e.g. a date field.
A.2. This method does NOT work for searching in multiple fields at the same time. For example, you can't check if a search string is in any of the fileds (name, notes & address).
Method-B: Using a MAP of search strings with "true" for each entry in the map, & using the "==" operator in the queries
Suggested by #Gil Gilbert
document1 = {
'searchKeywordsMap': {
'Jam': true,
'Butter': true,
'Muhamed': true,
'Green District': true,
'Muhamed, Green District': true,
}
}
.where(`searchKeywordsMap.${searchString}`, "==", true);
B.1 Obviously, this method requires extra processing every time data is saved to the db, and more importantly, requires extra space to store the map of search strings.
B.2 If a Firestore query has a single condition like the one above, no index needs to be created beforehand. This solution would work just fine in this case.
B.3 However, if the query has another condition, e.g. (status === "active",) it seems that an index is required for each "search string" the user enters. In other words, if a user searches for "Jam" and another user searches for "Butter", an index should be created beforehand for the string "Jam", and another one for "Butter", etc. Unless you can predict all possible users' search strings, this does NOT work - in case of the query has other conditions!
.where(searchKeywordsMap["Jam"], "==", true); // requires an index on searchKeywordsMap["Jam"]
.where("status", "==", "active");
**Method-C: Using an ARRAY of search strings, & the "array-contains" operator
Suggested by #Albert Renshaw & demonstrated by #Nick Carducci
document1 = {
'searchKeywordsArray': [
'Jam',
'Butter',
'Muhamed',
'Green District',
'Muhamed, Green District',
]
}
.where("searchKeywordsArray", "array-contains", searchString);
C.1 Similar to Method-B, this method requires extra processing every time data is saved to the db, and more importantly, requires extra space to store the array of search strings.
C.2 Firestore queries can include at most one "array-contains" or "array-contains-any" clause in a compound query.
General Limitations:
None of these solutions seems to support searching for partial strings. For example, if a db field contains "1 Peter St, Green District", you can't search for the string "strict."
It is almost impossible to cover all possible combinations of expected search strings. For example, if a db field contains "1 Mohamed St, Green District", you may NOT be able to search for the string "Green Mohamed", which is a string having the words in a different order than the order used in the DB field.
There is no one solution that fits all. Each workaround has its limitations. I hope the information above can help you during the selection process between these workarounds.
For a list of Firestore query conditions, please check out the documentation https://firebase.google.com/docs/firestore/query-data/queries.
I have not tried https://fireblog.io/blog/post/firestore-full-text-search, which is suggested by #Jonathan.
Late answer but for anyone who's still looking for an answer, Let's say we have a collection of users and in each document of the collection we have a "username" field, so if want to find a document where the username starts with "al" we can do something like
FirebaseFirestore.getInstance()
.collection("users")
.whereGreaterThanOrEqualTo("username", "al")
I used trigram just like Jonathan said it.
trigrams are groups of 3 letters stored in a database to help with searching. so if I have data of users and I let' say I want to query 'trum' for donald trump I have to store it this way
and I just to recall this way
onPressed: () {
//LET SAY YOU TYPE FOR 'tru' for trump
List<String> search = ['tru', 'rum'];
Future<QuerySnapshot> inst = FirebaseFirestore.instance
.collection("users")
.where('trigram', arrayContainsAny: search)
.get();
print('result=');
inst.then((value) {
for (var i in value.docs) {
print(i.data()['name']);
}
});
that will get correct result no matter what
EDIT 05/2021:
Google Firebase now has an extension to implement Search with Algolia. Algolia is a full text search platform that has an extensive list of features. You are required to have a "Blaze" plan on Firebase and there are fees associated with Algolia queries, but this would be my recommended approach for production applications. If you prefer a free basic search, see my original answer below.
https://firebase.google.com/products/extensions/firestore-algolia-search
https://www.algolia.com
ORIGINAL ANSWER:
The selected answer only works for exact searches and is not natural user search behavior (searching for "apple" in "Joe ate an apple today" would not work).
I think Dan Fein's answer above should be ranked higher. If the String data you're searching through is short, you can save all substrings of the string in an array in your Document and then search through the array with Firebase's array_contains query. Firebase Documents are limited to 1 MiB (1,048,576 bytes) (Firebase Quotas and Limits) , which is about 1 million characters saved in a document (I think 1 character ~= 1 byte). Storing the substrings is fine as long as your document isn't close to 1 million mark.
Example to search user names:
Step 1: Add the following String extension to your project. This lets you easily break up a string into substrings. (I found this here).
extension String {
var length: Int {
return count
}
subscript (i: Int) -> String {
return self[i ..< i + 1]
}
func substring(fromIndex: Int) -> String {
return self[min(fromIndex, length) ..< length]
}
func substring(toIndex: Int) -> String {
return self[0 ..< max(0, toIndex)]
}
subscript (r: Range<Int>) -> String {
let range = Range(uncheckedBounds: (lower: max(0, min(length, r.lowerBound)),
upper: min(length, max(0, r.upperBound))))
let start = index(startIndex, offsetBy: range.lowerBound)
let end = index(start, offsetBy: range.upperBound - range.lowerBound)
return String(self[start ..< end])
}
Step 2: When you store a user's name, also store the result of this function as an array in the same Document. This creates all variations of the original text and stores them in an array. For example, the text input "Apple" would creates the following array: ["a", "p", "p", "l", "e", "ap", "pp", "pl", "le", "app", "ppl", "ple", "appl", "pple", "apple"], which should encompass all search criteria a user might enter. You can leave maximumStringSize as nil if you want all results, however, if there is long text, I would recommend capping it before the document size gets too big - somewhere around 15 works fine for me (most people don't search long phrases anyway).
func createSubstringArray(forText text: String, maximumStringSize: Int?) -> [String] {
var substringArray = [String]()
var characterCounter = 1
let textLowercased = text.lowercased()
let characterCount = text.count
for _ in 0...characterCount {
for x in 0...characterCount {
let lastCharacter = x + characterCounter
if lastCharacter <= characterCount {
let substring = textLowercased[x..<lastCharacter]
substringArray.append(substring)
}
}
characterCounter += 1
if let max = maximumStringSize, characterCounter > max {
break
}
}
print(substringArray)
return substringArray
}
Step 3: You can use Firebase's array_contains function!
[yourDatabasePath].whereField([savedSubstringArray], arrayContains: searchText).getDocuments....
I just had this problem and came up with a pretty simple solution.
String search = "ca";
Firestore.instance.collection("categories").orderBy("name").where("name",isGreaterThanOrEqualTo: search).where("name",isLessThanOrEqualTo: search+"z")
The isGreaterThanOrEqualTo lets us filter out the beginning of our search and by adding a "z" to the end of the isLessThanOrEqualTo we cap our search to not roll over to the next documents.
I actually think the best solution to do this within Firestore is to put all substrings in an array, and just do an array_contains query. This allows you to do substring matching. A bit overkill to store all substrings but if your search terms are short it's very very reasonable.
If you don't want to use a third-party service like Algolia, Firebase Cloud Functions are a great alternative. You can create a function that can receive an input parameter, process through the records server-side and then return the ones that match your criteria.
This worked for me perfectly but might cause performance issues.
Do this when querying firestore:
Future<QuerySnapshot> searchResults = collectionRef
.where('property', isGreaterThanOrEqualTo: searchQuery.toUpperCase())
.getDocuments();
Do this in your FutureBuilder:
return FutureBuilder(
future: searchResults,
builder: (context, snapshot) {
List<Model> searchResults = [];
snapshot.data.documents.forEach((doc) {
Model model = Model.fromDocumet(doc);
if (searchQuery.isNotEmpty &&
!model.property.toLowerCase().contains(searchQuery.toLowerCase())) {
return;
}
searchResults.add(model);
})
};
Following code snippet takes input from user and acquires data starting with the typed one.
Sample Data:
Under Firebase Collection 'Users'
user1: {name: 'Ali', age: 28},
user2: {name: 'Khan', age: 30},
user3: {name: 'Hassan', age: 26},
user4: {name: 'Adil', age: 32}
TextInput: A
Result:
{name: 'Ali', age: 28},
{name: 'Adil', age: 32}
let timer;
// method called onChangeText from TextInput
const textInputSearch = (text) => {
const inputStart = text.trim();
let lastLetterCode = inputStart.charCodeAt(inputStart.length-1);
lastLetterCode++;
const newLastLetter = String.fromCharCode(lastLetterCode);
const inputEnd = inputStart.slice(0,inputStart.length-1) + lastLetterCode;
clearTimeout(timer);
timer = setTimeout(() => {
firestore().collection('Users')
.where('name', '>=', inputStart)
.where('name', '<', inputEnd)
.limit(10)
.get()
.then(querySnapshot => {
const users = [];
querySnapshot.forEach(doc => {
users.push(doc.data());
})
setUsers(users); // Setting Respective State
});
}, 1000);
};
2021 Update
Took a few things from other answers. This one includes:
Multi word search using split (acts as OR)
Multi key search using flat
A bit limited on case-sensitivity, you can solve this by storing duplicate properties in uppercase. Ex: query.toUpperCase() user.last_name_upper
// query: searchable terms as string
let users = await searchResults("Bob Dylan", 'users');
async function searchResults(query = null, collection = 'users', keys = ['last_name', 'first_name', 'email']) {
let querySnapshot = { docs : [] };
try {
if (query) {
let search = async (query)=> {
let queryWords = query.trim().split(' ');
return queryWords.map((queryWord) => keys.map(async (key) =>
await firebase
.firestore()
.collection(collection)
.where(key, '>=', queryWord)
.where(key, '<=', queryWord + '\uf8ff')
.get())).flat();
}
let results = await search(query);
await (await Promise.all(results)).forEach((search) => {
querySnapshot.docs = querySnapshot.docs.concat(search.docs);
});
} else {
// No query
querySnapshot = await firebase
.firestore()
.collection(collection)
// Pagination (optional)
// .orderBy(sortField, sortOrder)
// .startAfter(startAfter)
// .limit(perPage)
.get();
}
} catch(err) {
console.log(err)
}
// Appends id and creates clean Array
const items = [];
querySnapshot.docs.forEach(doc => {
let item = doc.data();
item.id = doc.id;
items.push(item);
});
// Filters duplicates
return items.filter((v, i, a) => a.findIndex(t => (t.id === v.id)) === i);
}
Note: the number of Firebase calls is equivalent to the number of words in the query string * the number of keys you're searching on.
Same as #nicksarno but with a more polished code that doesn't need any extension:
Step 1
func getSubstrings(from string: String, maximumSubstringLenght: Int = .max) -> [Substring] {
let string = string.lowercased()
let stringLength = string.count
let stringStartIndex = string.startIndex
var substrings: [Substring] = []
for lowBound in 0..<stringLength {
for upBound in lowBound..<min(stringLength, lowBound+maximumSubstringLenght) {
let lowIndex = string.index(stringStartIndex, offsetBy: lowBound)
let upIndex = string.index(stringStartIndex, offsetBy: upBound)
substrings.append(string[lowIndex...upIndex])
}
}
return substrings
}
Step 2
let name = "Lorenzo"
ref.setData(["name": name, "nameSubstrings": getSubstrings(from: name)])
Step 3
Firestore.firestore().collection("Users")
.whereField("nameSubstrings", arrayContains: searchText)
.getDocuments...
With Firestore you can implement a full text search but it will still cost more reads than it would have otherwise, and also you'll need to enter and index the data in a particular way, So in this approach you can use firebase cloud functions to tokenise and then hash your input text while choosing a linear hash function h(x) that satisfies the following - if x < y < z then h(x) < h (y) < h(z). For tokenisation you can choose some lightweight NLP Libraries in order to keep the cold start time of your function low that can strip unnecessary words from your sentence. Then you can run a query with less than and greater than operator in Firestore.
While storing your data also, you'll have to make sure that you hash the text before storing it, and store the plain text also as if you change the plain text the hashed value will also change.
Typesense service provide substring search for Firebase Cloud Firestore database.
https://typesense.org/docs/guide/firebase-full-text-search.html
Following is the relevant codes of typesense integration for my project.
lib/utils/typesense.dart
import 'dart:convert';
import 'package:flutter_instagram_clone/model/PostModel.dart';
import 'package:http/http.dart' as http;
class Typesense {
static String baseUrl = 'http://typesense_server_ip:port/';
static String apiKey = 'xxxxxxxx'; // your Typesense API key
static String resource = 'collections/postData/documents/search';
static Future<List<PostModel>> search(String searchKey, int page, {int contentType=-1}) async {
if (searchKey.isEmpty) return [];
List<PostModel> _results = [];
var header = {'X-TYPESENSE-API-KEY': apiKey};
String strSearchKey4Url = searchKey.replaceFirst('#', '%23').replaceAll(' ', '%20');
String url = baseUrl +
resource +
'?q=${strSearchKey4Url}&query_by=postText&page=$page&sort_by=millisecondsTimestamp:desc&num_typos=0';
if(contentType==0)
{
url += "&filter_by=isSelling:false";
} else if(contentType == 1)
{
url += "&filter_by=isSelling:true";
}
var response = await http.get(Uri.parse(url), headers: header);
var data = json.decode(response.body);
for (var item in data['hits']) {
PostModel _post = PostModel.fromTypeSenseJson(item['document']);
if (searchKey.contains('#')) {
if (_post.postText.toLowerCase().contains(searchKey.toLowerCase()))
_results.add(_post);
} else {
_results.add(_post);
}
}
print(_results.length);
return _results;
}
static Future<List<PostModel>> getHubPosts(String searchKey, int page,
{List<String>? authors, bool? isSelling}) async {
List<PostModel> _results = [];
var header = {'X-TYPESENSE-API-KEY': apiKey};
String filter = "";
if (authors != null || isSelling != null) {
filter += "&filter_by=";
if (isSelling != null) {
filter += "isSelling:$isSelling";
if (authors != null && authors.isNotEmpty) {
filter += "&&";
}
}
if (authors != null && authors.isNotEmpty) {
filter += "authorID:$authors";
}
}
String url = baseUrl +
resource +
'?q=${searchKey.replaceFirst('#', '%23')}&query_by=postText&page=$page&sort_by=millisecondsTimestamp:desc&num_typos=0$filter';
var response = await http.get(Uri.parse(url), headers: header);
var data = json.decode(response.body);
for (var item in data['hits']) {
PostModel _post = PostModel.fromTypeSenseJson(item['document']);
_results.add(_post);
}
print(_results.length);
return _results;
}
}
lib/services/hubDetailsService.dart
import 'package:flutter/material.dart';
import 'package:flutter_instagram_clone/model/PostModel.dart';
import 'package:flutter_instagram_clone/utils/typesense.dart';
class HubDetailsService with ChangeNotifier {
String searchKey = '';
List<String>? authors;
bool? isSelling;
int nContentType=-1;
bool isLoading = false;
List<PostModel> hubResults = [];
int _page = 1;
bool isMore = true;
bool noResult = false;
Future initSearch() async {
isLoading = true;
isMore = true;
noResult = false;
hubResults = [];
_page = 1;
List<PostModel> _results = await Typesense.search(searchKey, _page, contentType: nContentType);
for(var item in _results) {
hubResults.add(item);
}
isLoading = false;
if(_results.length < 10) isMore = false;
if(_results.isEmpty) noResult = true;
notifyListeners();
}
Future nextPage() async {
if(!isMore) return;
_page++;
List<PostModel> _results = await Typesense.search(searchKey, _page);
hubResults.addAll(_results);
if(_results.isEmpty) {
isMore = false;
}
notifyListeners();
}
Future refreshPage() async {
isLoading = true;
notifyListeners();
await initSearch();
isLoading = false;
notifyListeners();
}
Future search(String _searchKey) async {
isLoading = true;
notifyListeners();
searchKey = _searchKey;
await initSearch();
isLoading = false;
notifyListeners();
}
}
lib/ui/hub/hubDetailsScreen.dart
import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';
import 'package:flutter_instagram_clone/constants.dart';
import 'package:flutter_instagram_clone/main.dart';
import 'package:flutter_instagram_clone/model/MessageData.dart';
import 'package:flutter_instagram_clone/model/SocialReactionModel.dart';
import 'package:flutter_instagram_clone/model/User.dart';
import 'package:flutter_instagram_clone/model/hubModel.dart';
import 'package:flutter_instagram_clone/services/FirebaseHelper.dart';
import 'package:flutter_instagram_clone/services/HubService.dart';
import 'package:flutter_instagram_clone/services/helper.dart';
import 'package:flutter_instagram_clone/services/hubDetailsService.dart';
import 'package:flutter_instagram_clone/ui/fullScreenImageViewer/FullScreenImageViewer.dart';
import 'package:flutter_instagram_clone/ui/home/HomeScreen.dart';
import 'package:flutter_instagram_clone/ui/hub/editHubScreen.dart';
import 'package:provider/provider.dart';
import 'package:smooth_page_indicator/smooth_page_indicator.dart';
class HubDetailsScreen extends StatefulWidget {
final HubModel hub;
HubDetailsScreen(this.hub);
#override
_HubDetailsScreenState createState() => _HubDetailsScreenState();
}
class _HubDetailsScreenState extends State<HubDetailsScreen> {
late HubDetailsService _service;
List<SocialReactionModel?> _reactionsList = [];
final fireStoreUtils = FireStoreUtils();
late Future<List<SocialReactionModel>> _myReactions;
final scrollController = ScrollController();
bool _isSubLoading = false;
#override
void initState() {
// TODO: implement initState
super.initState();
_service = Provider.of<HubDetailsService>(context, listen: false);
print(_service.isLoading);
init();
}
init() async {
_service.searchKey = "";
if(widget.hub.contentWords.length>0)
{
for(var item in widget.hub.contentWords) {
_service.searchKey += item + " ";
}
}
switch(widget.hub.contentType) {
case 'All':
break;
case 'Marketplace':
_service.isSelling = true;
_service.nContentType = 1;
break;
case 'Post Only':
_service.isSelling = false;
_service.nContentType = 0;
break;
case 'Keywords':
break;
}
for(var item in widget.hub.exceptWords) {
if(item == 'Marketplace') {
_service.isSelling = _service.isSelling != null?true:false;
} else {
_service.searchKey += "-" + item + "";
}
}
if(widget.hub.fromUserType == 'Followers') {
List<User> _followers = await fireStoreUtils.getFollowers(MyAppState.currentUser!.userID);
_service.authors = [];
for(var item in _followers)
_service.authors!.add(item.userID);
}
if(widget.hub.fromUserType == 'Selected') {
_service.authors = widget.hub.fromUserIds;
}
_service.initSearch();
_myReactions = fireStoreUtils.getMyReactions()
..then((value) {
_reactionsList.addAll(value);
});
scrollController.addListener(pagination);
}
void pagination(){
if(scrollController.position.pixels ==
scrollController.position.maxScrollExtent) {
_service.nextPage();
}
}
#override
Widget build(BuildContext context) {
Provider.of<HubDetailsService>(context);
PageController _controller = PageController(
initialPage: 0,
);
return Scaffold(
backgroundColor: Colors.white,
body: RefreshIndicator(
onRefresh: () async {
_service.refreshPage();
},
child: CustomScrollView(
controller: scrollController,
slivers: [
SliverAppBar(
centerTitle: false,
expandedHeight: MediaQuery.of(context).size.height * 0.25,
pinned: true,
backgroundColor: Colors.white,
title: Row(
mainAxisAlignment: MainAxisAlignment.spaceBetween,
children: [
InkWell(
onTap: (){
Navigator.pop(context);
},
child: Container(
width: 35, height: 35,
decoration: BoxDecoration(
color: Colors.white,
borderRadius: BorderRadius.circular(20)
),
child: Center(
child: Icon(Icons.arrow_back),
),
),
),
if(widget.hub.user.userID == MyAppState.currentUser!.userID)
InkWell(
onTap: () async {
var _hub = await push(context, EditHubScreen(widget.hub));
if(_hub != null) {
Navigator.pop(context, true);
}
},
child: Container(
width: 35, height: 35,
decoration: BoxDecoration(
color: Colors.white,
borderRadius: BorderRadius.circular(20)
),
child: Center(
child: Icon(Icons.edit, color: Colors.black, size: 20,),
),
),
),
],
),
automaticallyImplyLeading: false,
flexibleSpace: FlexibleSpaceBar(
collapseMode: CollapseMode.pin,
background: Container(color: Colors.grey,
child: Stack(
children: [
PageView.builder(
controller: _controller,
itemCount: widget.hub.medias.length,
itemBuilder: (context, index) {
Url postMedia = widget.hub.medias[index];
return GestureDetector(
onTap: () => push(
context,
FullScreenImageViewer(
imageUrl: postMedia.url)),
child: displayPostImage(postMedia.url));
}),
if (widget.hub.medias.length > 1)
Padding(
padding: const EdgeInsets.only(bottom: 30.0),
child: Align(
alignment: Alignment.bottomCenter,
child: SmoothPageIndicator(
controller: _controller,
count: widget.hub.medias.length,
effect: ScrollingDotsEffect(
dotWidth: 6,
dotHeight: 6,
dotColor: isDarkMode(context)
? Colors.white54
: Colors.black54,
activeDotColor: Color(COLOR_PRIMARY)),
),
),
),
],
),
)
),
),
_service.isLoading?
SliverFillRemaining(
child: Center(
child: CircularProgressIndicator(),
),
):
SliverList(
delegate: SliverChildListDelegate([
if(widget.hub.userId != MyAppState.currentUser!.userID)
_isSubLoading?
Center(
child: Padding(
padding: EdgeInsets.all(5),
child: CircularProgressIndicator(),
),
):
Padding(
padding: EdgeInsets.symmetric(horizontal: 5),
child: widget.hub.shareUserIds.contains(MyAppState.currentUser!.userID)?
ElevatedButton(
onPressed: () async {
setState(() {
_isSubLoading = true;
});
await Provider.of<HubService>(context, listen: false).unsubscribe(widget.hub);
setState(() {
_isSubLoading = false;
widget.hub.shareUserIds.remove(MyAppState.currentUser!.userID);
});
},
style: ElevatedButton.styleFrom(
primary: Colors.red
),
child: Text(
"Unsubscribe",
),
):
ElevatedButton(
onPressed: () async {
setState(() {
_isSubLoading = true;
});
await Provider.of<HubService>(context, listen: false).subscribe(widget.hub);
setState(() {
_isSubLoading = false;
widget.hub.shareUserIds.add(MyAppState.currentUser!.userID);
});
},
style: ElevatedButton.styleFrom(
primary: Colors.green
),
child: Text(
"Subscribe",
),
),
),
Padding(
padding: EdgeInsets.all(15,),
child: Text(
widget.hub.name,
style: TextStyle(
color: Colors.black,
fontSize: 18,
fontWeight: FontWeight.bold
),
),
),
..._service.hubResults.map((e) {
if(e.isAuction && (e.auctionEnded || DateTime.now().isAfter(e.auctionEndTime??DateTime.now()))) {
return Container();
}
return PostWidget(post: e);
}).toList(),
if(_service.noResult)
Padding(
padding: EdgeInsets.all(20),
child: Text(
'No results for this hub',
style: TextStyle(
fontSize: 18,
fontWeight: FontWeight.bold
),
),
),
if(_service.isMore)
Center(
child: Container(
padding: EdgeInsets.all(5),
child: CircularProgressIndicator(),
),
)
]),
)
],
),
)
);
}
}
You can try using 2 lambdas and S3. These resources are very cheap and you will only be charged once the app has extreme usage ( if the business model is good then high usage -> higher income).
The first lambda will be used to push a text-document mapping to an S3 json file.
the second lambda will basically be your search api, you will use it to query the JSON in s3 and return the results.
The drawback will probably be the latency from s3 to lambda.
I use this with Vue js
query(collection(db,'collection'),where("name",">=",'searchTerm'),where("name","<=","~"))
I also couldn't manage to create a search function to Firebase using the suggestions and Firebase tools so I created my own "field-string contains search-string(substring) check", using the .contains() Kotlin function:
firestoreDB.collection("products")
.get().addOnCompleteListener { task->
if (task.isSuccessful){
val document = task.result
if (!document.isEmpty) {
if (document != null) {
for (documents in document) {
var name = documents.getString("name")
var type = documents.getString("type")
if (name != null && type != null) {
if (name.contains(text, ignoreCase = true) || type.contains(text, ignoreCase = true)) {
// do whatever you want with the document
} else {
showNoProductsMsg()
}
}
}
}
binding.progressBarSearch.visibility = View.INVISIBLE
} else {
showNoProductsMsg()
}
} else{
showNoProductsMsg()
}
}
First, you get ALL the documents in the collection you want, then you filter them using:
for (documents in document) {
var name = documents.getString("name")
var type = documents.getString("type")
if (name != null && type != null) {
if (name.contains(text, ignoreCase = true) || type.contains(text, ignoreCase = true)) {
//do whatever you want with this document
} else {
showNoProductsMsg()
}
}
}
In my case, I filtered them all by the name of the product and its type, then I used the boolean name.contains(string, ignoreCase = true) OR type.contains(string, ignoreCase = true, string is the text I got in the search bar of my app and I recommend you to use ignoreCase = true. With this setence being true, you can do whatever you want with the document.
I guess this is the best workaround since Firestore only supports number and exacts strings queries, so if your code didn't work doing this:
collection.whereGreaterThanOrEqualTo("name", querySearch)
collection.whereLessThanOrEqualTo("name", querySearch)
You're welcome :) because what I did works!
Firebase suggests Algolia or ElasticSearch for Full-Text search, but a cheaper alternative might be MongoDB. The cheapest cluster (approx US$10/mth) allows you to index for full-text.
We can use the back-tick to print out the value of a string. This should work:
where('name', '==', `${searchTerm}`)
Related
My Flutter application needs to listen for any changes in a specific Firestore document.
The process is quite simple and is found here in various solutions:
StackOverflow: flutter-firestore-how-to-listen-for-changes-to-one-document
StackOverflow:can-i-listen-to-a-single-document-in-firestore-with-a-streambuilder
StackOverflow:using-stream-building-with-a-specific-firestore-document
StackOverflow: how-to-get-a-specific-firestore-document-with-a-streambuilder
Medium: how-to-get-data-from-firestore-and-show-it-on-flutterbuilder-or-streambuilder-e05
These are all solutions to using a Stream & StreamBuilder and listening for any changes.
Commonly one uses this approach:
Stream<UserModel?> getFirestoreUser(String uid) {
return FirebaseFirestore.instance.collection('users').doc(uid).snapshots().map((event) => event.data()).map((event) => event == null ? null : UserModel.fromJson(event));
}
where:
UserModel has a fromJson(Map<String, dynamic>) factory constructor
and where there exists a users collection with the document ID being uid.
Stream returns a Stream<UserModel?> that can be used later by a Provider.of<UserModel?>(context) or in a StreamBuider<UserModel?>
Problem:
TL;DR - after a Firestore().getCurrentUser(uid) stream is updated (directly, or manually using firestore emulator and changing the document values), the StreamBuilder<UserModel?> below doesn't update.
At all points in app lifecycle (authenticated or not), the stream always returns null (however manually invoking the stream with .first returns the user content, but .last just hangs). See below for more info.
Link to github project.
To get started:
Throw in your own gooogle-services.json file into android/app folder
change all references for com.flutterprojects.myapp to ${your google-services.json package name}
Use local emulator to update firestore changes
More Details:
My issue uses a similar approach, yet the Stream doesn't return anything. My Flutter widget LoggedIn() is used when the FirebaseAuth.instance.currentUser is valid (i.e. not null)
class LoggedIn extends StatelessWidget{
#override
Widget build(BuildContext context) {
// TODO: implement build
return StreamBuilder<UserModel?>(
builder: (context, snapshot) {
print("Checking UserModel from stream provider");
if (snapshot.data == null) {
print("UserModel is null");
return UiLogin();
}
print("UserModel is NOT null");
return UiHome();
},
);
}
}
After a successful authentication, the text Checking UserModel from stream provider is printed to the console, then UserModel is null. At no point does UserModel is NOT null get shown.
After successful authentication (i.e. user registered & document updated), I have a button that I manually invoke the stream and get the first item:
var currentUser = Firestore().getCurrentUser(FirebaseAuth.instance.currentUser!.uid);
var first = await currentUser.first;
print(first);
which returns the UserModel based on the newly added user information.
When running the following code, execution stops on .last, no error, no crash, no app exit, just stops executing.
var currentUser = Firestore().getCurrentUser(FirebaseAuth.instance.currentUser!.uid);
var last = await currentUser.last;
print(last);
BUT
When adding the following, any changes gets updated and printed to the console
Firestore().getCurrentUser(currentUid).listen((data) {
print("Firestore Data Changed");
print("Firestore change value: $data");
});
This means the StreamBuilder<UserModel?> isn't working correctly, as the Stream<UserModel> events do listen() to changes and acknowledge those changes, but the StreamBuilder<UserModel?> changes do not get affected and consistently returns null.
Am I doing something wrong?
Try if (snapshot.hasData) { print("UserModel is null"); return UiLogin(); }
This is working for me. Maybe the connection states are what's missing.
StreamBuilder(
stream: FirebaseFirestore.instance
.collection('users')
.doc(widget.uid)
.collection('contacts')
.doc(widget.client)
.collection('messages')
.orderBy('timestamp', descending: true)
.snapshots(),
builder: (context, snapshot) {
if (snapshot.hasError)
return Expanded(
child: Center(child: Text('Problem Getting Your Messages')),
);
switch (snapshot.connectionState) {
case ConnectionState.none:
return Text('waiting');
case ConnectionState.waiting:
return Center(child: Text('Waiting'));
case ConnectionState.active:
var snap;
print('active');
if (snapshot.data != null) {
snap = snapshot.data;
}
return Expanded(
child: ListView(
...
);
case ConnectionState.done:
print('done');
return Text('Lost Connection');
}
return Text('NOPE');
},
),
I want to get all the Values of the map which is under "Subjects" field. And I also want to listen if any updates or changes made to those values. I actually want to add al those values and store in a variable. Can someone please tell me how can i achieve this?
Here is the structure of the collection.
This is how im adding the subjects whenever a user enters the subject name
onPressed: () async {
temp = qrdataFeed.text;
int index = qrdataFeed.text.indexOf('-');
subject = qrdataFeed.text.substring(0, index);
print("Subject name is $subject");
numberOfClasses = await FirebaseFirestore.instance
.collection('tutors')
.doc(uid)
.get()
.then((doc) async {
Map<String, dynamic> map = await doc.data();
if (!map.containsKey('Subjects')) {
await tutor_details.doc(uid).set({
'Subjects': {'$subject': initialValue},
}, SetOptions(merge: true));
}
if (doc.data()['Subjects']['$subject'] !=
'$subject') {
if (!map.containsKey('$subject')) {
await tutor_details.doc(uid).set({
'Subjects': {'$subject': initialValue}
}, SetOptions(merge: true));
}
}
var val = await doc.data()['Subjects']['$subject'];
return val;
});
if (!mounted) return;
setState(() {
qrData = qrdataFeed.text;
scanned = true;
print('done');
//if (temp != qrdataFeed.text)
numberOfClasses += 1;
print('$numberOfClasses is printed');
});
await tutor_details.doc(uid).set({
'Subjects': {'$subject': numberOfClasses},
}, SetOptions(merge: true));
}
},
Posting the #NisanthReddy's solution as a Community Wiki for visibility.
A better architecture would be to have one class at the root to handle all your transactions and to also notify any listener in your code.
You should always call this class to update and you can add listeners to this class from any widget you want. This way you will have everything Firestore-related in one place.
I'm new to flutter. I am trying to make an app for myself which can do some calculations for me.
The Situation: When I start the app it starts with the loading screen. While loading it make an API call to get some data which I
will need in the future. And send it to the pages where I need it. This is working fine.
The problem: I have multiple pages in the app. When I return from any other page to the main page the data got vanished. So I
have to make another API call to get the data back. And I don't want
this to happen
What I want: I want that when the data is received it should be stored somewhere locally so that I can use it wherever I want, without making another API call or without an internet connection.
Check the video demo here to understand better
What I am doing:
Loading screen:
class Loading extends StatefulWidget {
#override
_LoadingState createState() => _LoadingState();
}
class _LoadingState extends State<Loading> {
void setupPair() async
{
CurrInfo instance =
CurrInfo(url: 'EUR/USD', flagA: 'eur.png', flagB: 'usd.png');
await instance.getInfo();
if (instance.price != "not connected")
{
Navigator.pushReplacementNamed(context, '/home', arguments: {
'url': instance.url,
'flagA': instance.flagA,
'flagB': instance.flagB,
'price': instance.price,
});
} // I don't want to send this instance, instead I want to store the Received
data locally and access that data from anywhere inside the app
Video else if (instance.price == "not connected") {
Navigator.pushReplacementNamed(context, '/not connected');
}
}
Getting data by making api call:
class CurrInfo {
String url;
String flagA;
String flagB;
String price;
String furl;
Map data;
List info;
CurrInfo({this.url, this.flagA, this.flagB});
Future<void> getInfo() async {
try {
print((url));
furl =
"https://fcsapi.com/api-v2/forex/latest?
symbol=$url&access_key=t58zo1uMFJZlNJxSrSmZv2qIUlSkCk9RAfCLkwnMwt1q1FFS";
Response response = await http
.get(Uri.encodeFull(furl), headers: {"Accept": "application/json"});
data = jsonDecode(response.body);
print(data);
info = data['response'];
print(info);
price = info[0]['price']; // I want to save this price data locally while loading so that I
don't have to make another API call to get it back and it should be
updated when I refresh the page
print("string price : $price");
} catch (e) {
price = "not connected";
print('error is : $e & $price');
}}}
How i'm using this data where i need :
Map data = {};
String ofData;
Expanded(flex: 1,
child: Text( ${data['url']}',
style: TextStyle(
fontSize: 25,
fontWeight: FontWeight.bold),
textAlign: TextAlign.start,
),
),
Expanded( flex: 1,
child: Text('${data['price']}',
style: TextStyle(fontSize: 18),
textAlign: TextAlign.end,
),
),
Check out full code here to understand better
you can use this package shared_preferences: ^0.5.12+2 to store data locally on phone
I recently started using Flutter for app development. I am trying to make a simple notepad app from scratch as part of the learning assignment. can anyone help me where I am making the mistake or if I am missing any fundamental concept? Thanks in advance, below are the details of the issue.
I wrote a database_helper class and a function to show all elements in the database as a list.
//code from Database_Helper.dart
//get the total number of rows in DB.
Future<int> getCount() async {
Database db = await this.database;
List<Map<String, dynamic>> x =
await db.rawQuery('SELECT COUNT (*) from $ideaTable');
int result = Sqflite.firstIntValue(x);
return result;
}
//get total rows in db as <list <map>>
Future<List<Map<String, dynamic>>> getIdeaMapList() async {
Database db = await this.database;
var result = await db.rawQuery('SELECT * FROM $ideaTable ');
return result;
}
//converting list<map> to list<Ideas> // Ideas being defined class.
Future<List<Idea>> getIdeaList() async {
var ideaMapList = await getIdeaMapList(); // Get 'Map List' from database
int count =
ideaMapList.length; // Count the number of map entries in db table
List<Idea> ideaList = List<Idea>();
// For loop to create a 'todo List' from a 'Map List'
for (int i = 0; i < count; i++) {
ideaList.add(Idea.fromMapObject(ideaMapList[i]));
}
return ideaList;
}
}
the database helper object is created in main file and list is shown as vertical Listview using ShowIdea class as shown below.
class _ShowideasState extends State<Showideas> {
DatabaseHelper _databaseHelper = new DatabaseHelper();
List<Idea> listideas;
#override
Widget build(BuildContext context) {
debugPrint('micheal jackson: listideaslength');
if (listideas == null) {
updatelistideas();
}
int j = listideas.length;
debugPrint('micheal jackson: $j listideaslength');
return Container(
child: ListView.builder(
itemCount: listideas.length,
itemBuilder: (BuildContext context, int position) {
return Card(
color: Colors.green[200],
elevation: 2.0,
child: Column(
children: <Widget>[
Text(this.listideas[position].iTitle),
Text(this.listideas[position].iText),
Text(this.listideas[position].date),
],
),
);
}),
);
}
void updatelistideas() async {
listideas = await _databaseHelper.getIdeaList();
int i = listideas.length;
debugPrint('ideaslength: $i listideaslength');
}
}
the following logs
2020-08-23 20:36:51.866 24126-24169/com.example.myprojet01 I/flutter: micheal jackson: listideaslength
2020-08-23 20:36:51.868 24126-24169/com.example.myprojet01 I/flutter: movieTitle: get database list
2020-08-23 20:36:52.358 24126-24169/com.example.myprojet01 I/flutter: idea list length in db: 5
2020-08-23 20:36:52.358 24126-24169/com.example.myprojet01 I/flutter: ideaslength: 5 listideaslength
but the widget is not rendered and shows a red screen with error 'getter length was called on null'.
══╡ EXCEPTION CAUGHT BY WIDGETS LIBRARY ╞═══════════════════════════════════════════════════════════
The following NoSuchMethodError was thrown building Showideas(dirty, state: _ShowideasState#193ad):
The getter 'length' was called on null.
Receiver: null
Tried calling: length
The relevant error-causing widget was:
Showideas
if the app is hot reloaded without any changes.
The following logs add up and the screen turns white and is overflowed.
2020-08-23 20:36:56.041 24126-24169/com.example.myprojet01 I/flutter: micheal jackson: listideaslength
2020-08-23 20:36:56.041 24126-24169/com.example.myprojet01 I/flutter: micheal jackson: 5 listideaslength
Try the code below :
void updatelistideas() async {
final ideas = await _databaseHelper.getIdeaList();
setState(() {
listideas = ideas;
});
int i = listideas.length;
debugPrint('ideaslength: $i listideaslength');
}
and change this :
itemCount: listideas.length,
to
itemCount: null == listideas ? 0 : listideas.length,
I'm lost with cloud funtions.
I'm trying to read from a table when new entry is written. Then parse some data from this table, and create a new object in a new table.
But I'm lost in some concepts with CF, and node...
At this moment I have the listeners to the table:
exports.createEventInvitation = functions.database
.ref('event/{eventStartDate}/{eventId}/')
.onWrite((change, context) => {
const event = change.after.val();
const eventUsersList = event.userList;
...
})
The object event looks like this:
Event :{ conversationId: '8f6eb2b9-0cbb-4135-b6b6-c9f02c9aa91e',
sharifyEventData:
{ acceptationManual: false,
address: 'ADDRESS FROM USER',
adminProfileImageUrl: 'url_image',
description: 'Description',
eventEmoji: '💬',
finalDate: '2019-11-12',
finalHour: '09:30',
headerImageUrl: '',
initialDate: '2019-11-12',
initialHour: '09:00',
eventType: 'BEER',
title: ''},
eventID: '5f49ff65-bd98-45cb-a554-55da5c3c2f16',
userList: { LeiUlbDlNKWwF6QPgnQiFTE03gt2: true },
userType: 'NORMAL' }
I have to loop over the userlist to check which ID is the owner of the event. But I'm not able to loop it properly.
I tried to get the value like:
const userList = new Map()
const eventUsersList = event.userList
for( var entry in eventUsersList){
if(entry[1]){
userList.set(entry[0],3)
}
}
console.log('UserListInvitation:' + util.inspect(userList, {showHidden: false, depth: null}))
And I achieved something like:
UserListInvitation:Map { 'L' => 3 }
But I'm missing something, because it seems I'm only taken the first letter of the key.
Also I tried:
for( var entryKey in eventUsersList.keys){
if(eventUsersList[entryKey]){
userList.set(entryKey,3)
}
}
And this It's returning nothing
What I'm missing?
If I understood you properly then the following code should work:
const userList = new Map()
const eventUsersList = event.userList
for( var key in eventUsersList){
if(eventUsersList[key]){ // Safety check
userList.set(key, 3) // key-value?
}
}