Skip to content

Add OR snippets #430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 30, 2025
+181 −1
Merged

Add OR snippets #430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
183ce4d
Add OR snippets
morganchen12 Mar 3, 2023
3a2fc21
fix bad query
morganchen12 Mar 21, 2023
fdee208
Merge branch 'master' into mc/count
morganchen12 Oct 30, 2025
b114e8c
fix mismatched name
morganchen12 Oct 30, 2025
fcd4e44
update Firestore and fix build errors
morganchen12 Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion firestore/app/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ dependencies {
implementation("androidx.multidex:multidex:2.0.1")

// Import the BoM for the Firebase platform
implementation(platform("com.google.firebase:firebase-bom:34.4.0"))
implementation(platform("com.google.firebase:firebase-bom:34.5.0"))

// Declare the dependency for the Cloud Firestore library
// When using the BoM, you don't specify versions in Firebase library dependencies
Expand Down
90 changes: 90 additions & 0 deletions firestore/app/src/main/java/com/google/example/firestore/DocSnippets.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import com.google.firebase.firestore.EventListener;
import com.google.firebase.firestore.FieldPath;
import com.google.firebase.firestore.FieldValue;
import com.google.firebase.firestore.Filter;
import com.google.firebase.firestore.FirebaseFirestore;
import com.google.firebase.firestore.FirebaseFirestoreException;
import com.google.firebase.firestore.FirebaseFirestoreSettings;
Expand Down Expand Up @@ -1370,6 +1371,95 @@ public void onComplete(@NonNull Task<AggregateQuerySnapshot> task) {
// [END count_aggregate_query]
}

public void orQuery() {
CollectionReference collection = db.collection("cities");
// [START or_queries]
Query query = collection.where(Filter.and(
Filter.equalTo("state", "CA"),
Filter.or(
Filter.equalTo("capital", true),
Filter.greaterThanOrEqualTo("population", 1000000)
)
));
// [END or_queries]
}

public void orQueryDisjunctions() {
CollectionReference collection = db.collection("cities");

// [START one_disjunction]
collection.whereEqualTo("a", 1);
// [END one_disjunction]

// [START two_disjunctions]
collection.where(Filter.or(
Filter.equalTo("a", 1),
Filter.equalTo("b", 2)
));
// [END two_disjunctions]

// [START four_disjunctions]
collection.where(Filter.or(
Filter.and(
Filter.equalTo("a", 1),
Filter.equalTo("c", 3)
),
Filter.and(
Filter.equalTo("a", 1),
Filter.equalTo("d", 4)
),
Filter.and(
Filter.equalTo("b", 2),
Filter.equalTo("c", 3)
),
Filter.and(
Filter.equalTo("b", 2),
Filter.equalTo("d", 4)
)
));
// [END four_disjunctions]

// [START four_disjunctions_compact]
collection.where(Filter.and(
Filter.or(
Filter.equalTo("a", 1),
Filter.equalTo("b", 2)
),
Filter.or(
Filter.equalTo("c", 3),
Filter.equalTo("d", 4)
)
));
// [END four_disjunctions_compact]

// [START 20_disjunctions]
collection.where(Filter.or(
Filter.inArray("a", Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)),
Filter.inArray("b", Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 10))
));
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately there's currently a bug in the backend which prevents this query from being served -- Even though it is a valid query (it's valid to have one IN operator per disjunction).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can add this to the snippet registry and then exclude it from devsite for now.

// [END 20_disjunctions]

// [START 10_disjunctions]
collection.where(Filter.and(
Filter.inArray("a", Arrays.asList(1, 2, 3, 4, 5)),
Filter.or(
Filter.equalTo("b", 2),
Filter.equalTo("c", 3)
)
));
// [END 10_disjunctions]
}

public void illegalDisjunctions() {
CollectionReference collection = db.collection("cities");
// [START 50_disjunctions]
collection.where(Filter.and(
Filter.inArray("a", Arrays.asList(1, 2, 3, 4, 5)),
Filter.inArray("b", Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 10))
));
// [END 50_disjunctions]
}

public void sumAggregateCollection() {
// [START sum_aggregate_collection]
Query query = db.collection("cities");
Expand Down
90 changes: 90 additions & 0 deletions firestore/app/src/main/java/com/google/example/firestore/kotlin/DocSnippets.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import com.google.firebase.firestore.AggregateField
import com.google.firebase.firestore.AggregateSource
import com.google.firebase.firestore.DocumentChange
import com.google.firebase.firestore.FieldValue
import com.google.firebase.firestore.Filter
import com.google.firebase.firestore.FirebaseFirestore
import com.google.firebase.firestore.FirebaseFirestoreException
import com.google.firebase.firestore.MetadataChanges
Expand Down Expand Up @@ -1142,6 +1143,95 @@ abstract class DocSnippets(val db: FirebaseFirestore) {
// [END count_aggregate_query]
}

fun orQuery() {
val collection = db.collection("cities")
// [START or_queries]
val query = collection.where(Filter.and(
Filter.equalTo("state", "CA"),
Filter.or(
Filter.equalTo("capital", true),
Filter.greaterThanOrEqualTo("population", 1000000)
)
))
// [END or_queries]
}

fun orQueryDisjunctions() {
val collection = db.collection("cities")

// [START one_disjunction]
collection.whereEqualTo("a", 1)
// [END one_disjunction]

// [START two_disjunctions]
collection.where(Filter.or(
Filter.equalTo("a", 1),
Filter.equalTo("b", 2)
))
// [END two_disjunctions]

// [START four_disjunctions]
collection.where(Filter.or(
Filter.and(
Filter.equalTo("a", 1),
Filter.equalTo("c", 3)
),
Filter.and(
Filter.equalTo("a", 1),
Filter.equalTo("d", 4)
),
Filter.and(
Filter.equalTo("b", 2),
Filter.equalTo("c", 3)
),
Filter.and(
Filter.equalTo("b", 2),
Filter.equalTo("d", 4)
)
))
// [END four_disjunctions]

// [START four_disjunctions_compact]
collection.where(Filter.and(
Filter.or(
Filter.equalTo("a", 1),
Filter.equalTo("b", 2)
),
Filter.or(
Filter.equalTo("c", 3),
Filter.equalTo("d", 4)
)
))
// [END four_disjunctions_compact]

// [START 20_disjunctions]
collection.where(Filter.or(
Filter.inArray("a", listOf(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)),
Filter.inArray("b", listOf(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)),
))
// [END 20_disjunctions]

// [START 10_disjunctions]
collection.where(Filter.and(
Filter.inArray("a", listOf(1, 2, 3, 4, 5)),
Filter.or(
Filter.equalTo("b", 2),
Filter.equalTo("c", 3)
)
))
// [END 10_disjunctions]
}

fun illegalDisjunctions() {
val collection = db.collection("cities")
// [START 50_disjunctions]
collection.where(Filter.and(
Filter.inArray("a", listOf(1, 2, 3, 4, 5)),
Filter.inArray("b", listOf(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)),
));
// [END 50_disjunctions]
}

fun sumAggregateCollection() {
// [START sum_aggregate_collection]
val query = db.collection("cities")
Expand Down