Get a list of documents
This action performs a query to get a list of documents from a Firestore collection, according to the provided query filters.
Inputs and Settings
Collection
The name or ID of the collection you want to get documents from.
Query type
Either "list" or "count". This will define the type of query you want to perform and will affect which values will be returned from the backend operation.
Query sort / order by options
You can choose a field to order your list of document from, at query level, specifying the sort direction (descending = yes | ascending = no).
When doing a sorted query for the first time, you might be confronted with an alert asking you to create an index for that query. That's a Firestore feature that creates different indexes for the database, which makes queries lighting fast.
Query filters (list) (count)
This options allow you to choose fields from which to filter your query.
Available query operators
You can read more on the Cloud Firestore documentation.
<
Gets values less than the provided input (must be of type number or date)
<=
Gets values less than or equal to the provided input (must be of type number or date)
==
Gets values equal to the provided input.
>
Gets values greater than the provided input (must be of type number or date).
>=
Gets values greater than or equal to the provided input (must be of type number or date).
array-contains
Gets values where the field of type array/list has the value provided as input.
array-contains-any
Gets values where the field of type array/list any of the array of values provided as input.
in
Gets values where the field value is present on the array of values provided as input.
not-in
Gets values where the field value is not present on the array of values provided as input.
Firestore supports only one filter of type "array-contains", "array-contains-any", "in" or "not-in" per query. If you try to use more than one, the first one will be considered by the plugin, but the other's will be ignored.
Firestore does not offer "text" filters like the Bubble "contains keywords" option, because of the way they structure the database using indexes. For this kind os searches they recomend the use of external services like Algolia.
Types of filter values
Since Bubble is not flexible on the type of data we can define on plugins, the best way to implement our plugin was to work with texts. So each value you put on query values must be interpreted the right way to perform the Firestore Query. Defining a "query filter value type" can help us get it right.
So here are the types of query filter values:
auto
The plugin will try to infer the type from the input you provided.
text
Treated as a text value.
number
Treated as a number value.
boolean (true/false)
Treated as a true or false (yes/no) value.
date
Treated as a Date type. The plugin will convert the value to a Date.
array
Treated as a list in JavaScript format (e.g. ["item1", "item2", "item3"]). If you need to use it on Bubble's lists, you can apply the ":format as text" message to the list, to build the array string into that format.
reference (coll/doc_id)
Treated as a document reference. Document references are always handled by the plugin as paths to a document. For instance, if you want to get the reference for a document from the "tasks" collection with an id "1234", you should right "tasks/1234"
Returned Values
List of documents
A list of document JSON strings, that can be provided to repeating groups and then, on each cell, extracted through a Firestore Data Extractor to get the values from the document fields.
Docs IDs
A list of texts contains the IDs of the document fetched from a "List" or "List and Count" type of queries.
Field Value Lists (1, 2, 3...)
Lists of fields you chose to retrieve from the documents list, with filters already applied.
Count
If the type of query is "count", this state will store the result of the couting operation.
Last updated