Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 17 additions & 10 deletions firestore/cloud-client/snippets.py
Original file line number Diff line number Diff line change
Expand Up @@ -487,7 +487,7 @@ def compound_query_single_clause():


def compound_query_valid_multi_clause():
db = firestore.Client()
db = firestore.Client(add_unique_string=False) # Flag for testing purposes, needs index to be precreated
# [START firestore_query_filter_compound_multi_eq]
cities_ref = db.collection("cities")

Expand All @@ -500,6 +500,7 @@ def compound_query_valid_multi_clause():
# [END firestore_query_filter_compound_multi_eq]
print(denver_query)
print(large_us_cities_query)
return denver_query, large_us_cities_query


def compound_query_valid_single_field():
Expand All @@ -525,8 +526,9 @@ def compound_query_invalid_multi_field():
def order_simple_limit():
db = firestore.Client()
# [START firestore_order_simple_limit]
db.collection("cities").order_by("name").limit(3).stream()
query = db.collection("cities").order_by("name").limit(3).stream()
# [END firestore_order_simple_limit]
return query


def order_simple_limit_desc():
Expand All @@ -537,16 +539,18 @@ def order_simple_limit_desc():
results = query.stream()
# [END firestore_query_order_desc_limit]
print(results)
return results


def order_multiple():
db = firestore.Client()
db = firestore.Client(add_unique_string=False) # Flag for testing purposes, needs index to be precreated
# [START firestore_query_order_multi]
cities_ref = db.collection("cities")
cities_ref.order_by("state").order_by(
ordered_city_ref = cities_ref.order_by("state").order_by(
"population", direction=firestore.Query.DESCENDING
)
# [END firestore_query_order_multi]
return ordered_city_ref


def order_where_limit():
Expand All @@ -561,6 +565,7 @@ def order_where_limit():
results = query.stream()
# [END firestore_query_order_limit_field_valid]
print(results)
return results


def order_limit_to_last():
Expand All @@ -571,6 +576,7 @@ def order_limit_to_last():
results = query.get()
# [END firestore_query_order_limit]
print(results)
return results


def order_where_valid():
Expand All @@ -583,10 +589,11 @@ def order_where_valid():
results = query.stream()
# [END firestore_query_order_with_filter]
print(results)
return results


def order_where_invalid():
db = firestore.Client()
db = firestore.Client(add_unique_string=False) # Flag for testing purposes, needs index to be precreated
# [START firestore_query_order_field_invalid]
cities_ref = db.collection("cities")
query = cities_ref.where(filter=FieldFilter("population", ">", 2500000)).order_by(
Expand All @@ -595,6 +602,7 @@ def order_where_invalid():
results = query.stream()
# [END firestore_query_order_field_invalid]
print(results)
return results


def cursor_simple_start_at():
Expand Down Expand Up @@ -628,9 +636,6 @@ def snapshot_cursors():
)
# [END firestore_query_cursor_start_at_document]
results = start_at_snapshot.limit(10).stream()
for doc in results:
print(f"{doc.id}")

return results


Expand Down Expand Up @@ -790,7 +795,7 @@ def on_snapshot(col_snapshot, changes, read_time):


def cursor_multiple_conditions():
db = firestore.Client()
db = firestore.Client(add_unique_string=False) # Flag for testing purposes, needs index to be precreated
# [START firestore_query_cursor_start_at_field_value_multi]
start_at_name = (
db.collection("cities").order_by("name").start_at({"name": "Springfield"})
Expand Down Expand Up @@ -932,7 +937,8 @@ def update_document_increment(db):
def list_document_subcollections():
db = firestore.Client()
# [START firestore_data_get_sub_collections]
collections = db.collection("cities").document("SF").collections()
city_ref = db.collection("cities").document("SF")
collections = city_ref.collections()
for collection in collections:
for doc in collection.stream():
print(f"{doc.id} => {doc.to_dict()}")
Expand Down Expand Up @@ -983,3 +989,4 @@ def regional_endpoint():
for r in cities_query:
print(r)
# [END firestore_regional_endpoint]
return cities_query
Loading