Array-contains queries in Firebase - Commands & Configuration

Introduction

Sometimes you want to find documents in a database where a list includes a specific item. Array-contains queries let you search for documents that have a certain value inside an array field.

When you want to find users who have a specific skill listed in their profile.

When you need to get all orders that include a particular product ID in their items array.

When you want to filter posts that have a certain tag in their tags array.

When you want to check if a chat message includes a specific emoji in its reactions array.

When you want to find events that include a certain participant in their attendees list.

Commands

This command queries the 'users' collection to find all documents where the 'skills' array contains the value 'javascript'.

Terminal

firebase firestore:query --collection=users --where="skills array-contains 'javascript'"

Expected Output

Document ID: user123

name: Alice

skills: ["javascript", "python", "html"]



Document ID: user456

name: Bob

skills: ["java", "javascript", "css"]

→

--collection - Specifies which collection to query.

→

--where - Defines the condition for filtering documents.

This command finds all orders where the 'items' array includes the product ID 'product789'.

Terminal

firebase firestore:query --collection=orders --where="items array-contains 'product789'"

Expected Output

Document ID: order001

customer: John

items: ["product123", "product789"]



Document ID: order002

customer: Jane

items: ["product789", "product456"]

→

--collection - Specifies which collection to query.

→

--where - Defines the condition for filtering documents.

Key Concept

If you remember nothing else from this pattern, remember: array-contains queries let you find documents where a specific value exists inside an array field.

Common Mistakes

Using '==' instead of 'array-contains' to search inside arrays.

The '==' operator checks for exact matches, not values inside arrays, so it won't find documents where the value is inside an array.

Use 'array-contains' in the where clause to search for a value inside an array field.

Trying to use 'array-contains' on fields that are not arrays.

The query will fail or return no results because the field is not an array type.

Ensure the field you query with 'array-contains' is actually an array in your documents.

Summary

Use 'array-contains' in Firestore queries to find documents where an array field includes a specific value.

Run queries with the --where flag specifying 'array-contains' to filter documents by array contents.

Always check that the field you query is an array to avoid errors or empty results.

Practice

1.

What does the array-contains query operator do in Firebase Firestore?

easy

A. Finds documents where an array field includes a specific value

B. Finds documents where a string field contains a substring

C. Finds documents where a number field is greater than a value

D. Finds documents where a field is missing

Solution

1. Step 1: Understand the purpose of array-contains

   This operator is designed to check if an array field in a document contains a specific value.

2. Step 2: Compare with other query types

   Other options describe different query operators, but only array-contains matches arrays including a value.

3. Final Answer:

   Finds documents where an array field includes a specific value -> Option A

4. Quick Check:

   array-contains = finds value in array [OK]

Hint: Remember: array-contains checks for one value inside an array [OK]

Common Mistakes:

• Confusing array-contains with substring search
• Using array-contains on non-array fields
• Thinking it works with multiple values at once

2.

Which of the following is the correct syntax to query documents where the tags array contains the value "urgent"?

const query = firestore.collection('tasks').where(____);

easy

A. "tags", "contains", "urgent"

B. "tags", "==", "urgent"

C. "tags", "array-contains-any", ["urgent"]

D. "tags", "array-contains", "urgent"

Solution

1. Step 1: Recall the correct operator for single value in array

   The operator is "array-contains" to check if an array includes a specific value.

2. Step 2: Check syntax format

   The syntax is .where("field", "array-contains", value). "tags", "array-contains", "urgent" matches this exactly.

3. Final Answer:

   "tags", "array-contains", "urgent" -> Option D

4. Quick Check:

   Correct syntax uses array-contains [OK]

Hint: Use "array-contains" for single value array queries [OK]

Common Mistakes:

• Using == instead of array-contains for arrays
• Confusing array-contains with array-contains-any
• Using non-existent operator "contains"

3.

Given the following documents in a Firestore collection projects:

[{ id: 1, members: ["alice", "bob"] }, { id: 2, members: ["carol"] }, { id: 3, members: ["bob", "dave"] }]

What will the query firestore.collection('projects').where('members', 'array-contains', 'bob').get() return?

medium

A. Documents with id 2 only

B. Documents with id 1 only

C. Documents with id 1 and 3

D. No documents

Solution

1. Step 1: Identify documents where 'members' array contains 'bob'

   Document 1 has members ["alice", "bob"] which includes "bob". Document 3 has ["bob", "dave"] which also includes "bob". Document 2 does not.

2. Step 2: Determine query result

   The query returns documents 1 and 3 because their 'members' arrays contain "bob".

3. Final Answer:

   Documents with id 1 and 3 -> Option C

4. Quick Check:

   array-contains 'bob' = docs 1 and 3 [OK]

Hint: Check which arrays include the value exactly [OK]

Common Mistakes:

• Including documents without the value
• Confusing array-contains with array-contains-any
• Assuming partial matches inside strings

4.

What is wrong with this Firestore query?

firestore.collection('orders').where('items', 'array-contains', ['apple', 'banana'])

The items field is an array of strings.

medium

A. You cannot use an array as the value with array-contains

B. The operator should be 'array-contains-any' instead

C. The field 'items' must be a string, not an array

D. The query syntax is correct

Solution

1. Step 1: Understand array-contains value type

   The 'array-contains' operator expects a single value, not an array, to check inside the array field.

2. Step 2: Identify correct usage

   Passing an array as the value causes an error. To check multiple values, 'array-contains-any' is used instead.

3. Final Answer:

   You cannot use an array as the value with array-contains -> Option A

4. Quick Check:

   array-contains needs single value, not array [OK]

Hint: array-contains accepts only one value, not arrays [OK]

Common Mistakes:

• Passing an array as the value to array-contains
• Confusing array-contains with array-contains-any
• Assuming array-contains works like 'in' operator

5.

You want to find all documents in the events collection where the attendees array contains both "john" and "jane". Which approach is correct?

hard

A. Use a single query with array-contains-any and pass both names

B. Use two queries with array-contains for each name and merge results client-side

C. Use a single query with array-contains and pass an array of both names

D. Use a query with where('attendees', '==', ['john', 'jane'])

Solution

1. Step 1: Understand limitations of array-contains and array-contains-any

   array-contains checks for one value in array; array-contains-any checks if array contains any of multiple values but not all.

2. Step 2: Find correct method to get documents containing both values

   Since Firestore does not support querying for multiple values all present in one array in a single query, you must run two queries with array-contains and combine results client-side.

3. Final Answer:

   Use two queries with array-contains for each name and merge results client-side -> Option B

4. Quick Check:

   Multiple array-contains queries combined client-side [OK]

Hint: Firestore can't query multiple array-contains in one query [OK]

Common Mistakes:

• Using array-contains-any expecting all values matched
• Passing array of values to array-contains
• Using equality check on arrays