Skip to content

fix: (datastore) add imports to snippets #12601

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 3 commits into from
Sep 20, 2024
Merged

fix: (datastore) add imports to snippets #12601

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
567c92b
add imports to snippets
daniel-sanche Sep 17, 2024
fc778d6
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Sep 17, 2024
ec9128d
added missing import
daniel-sanche Sep 17, 2024
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
91 changes: 62 additions & 29 deletions datastore/cloud-client/snippets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

import argparse
from collections import defaultdict
import datetime
from pprint import pprint

from google.api_core.client_options import ClientOptions
import google.cloud.exceptions
from google.cloud import datastore # noqa: I100
from google.cloud.datastore.query import PropertyFilter


def _preamble():
Expand Down Expand Up @@ -214,6 +206,8 @@ def entity_with_parent(client):

def properties(client):
# [START datastore_properties]
import datetime

key = client.key("Task")
task = datastore.Entity(key, exclude_from_indexes=("description",))
task.update(
Expand Down Expand Up @@ -386,7 +380,11 @@ def unindexed_property_query(client):

# [START datastore_unindexed_property_query]
query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("description", "=", "Learn Cloud Datastore"))
query.add_filter(
filter=datastore.query.PropertyFilter(
"description", "=", "Learn Cloud Datastore"
)
)
# [END datastore_unindexed_property_query]

return list(query.fetch())
Expand All @@ -398,8 +396,8 @@ def basic_query(client):

# [START datastore_basic_query]
query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("done", "=", False))
query.add_filter(filter=PropertyFilter("priority", ">=", 4))
query.add_filter(filter=datastore.query.PropertyFilter("done", "=", False))
query.add_filter(filter=datastore.query.PropertyFilter("priority", ">=", 4))
query.order = ["-priority"]
# [END datastore_basic_query]

Expand Down Expand Up @@ -503,7 +501,7 @@ def property_filter(client):

# [START datastore_property_filter]
query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("done", "=", False))
query.add_filter(filter=datastore.query.PropertyFilter("done", "=", False))
# [END datastore_property_filter]

return list(query.fetch())
Expand All @@ -515,8 +513,8 @@ def composite_filter(client):

# [START datastore_composite_filter]
query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("done", "=", False))
query.add_filter(filter=PropertyFilter("priority", "=", 4))
query.add_filter(filter=datastore.query.PropertyFilter("done", "=", False))
query.add_filter(filter=datastore.query.PropertyFilter("priority", "=", 4))
# [END datastore_composite_filter]

return list(query.fetch())
Expand All @@ -538,6 +536,8 @@ def key_filter(client):

def ascending_sort(client):
# Create the entity that we're going to query.
import datetime

task = upsert(client)
task["created"] = datetime.datetime.now(tz=datetime.timezone.utc)
client.put(task)
Expand All @@ -552,6 +552,8 @@ def ascending_sort(client):

def descending_sort(client):
# Create the entity that we're going to query.
import datetime

task = upsert(client)
task["created"] = datetime.datetime.now(tz=datetime.timezone.utc)
client.put(task)
Expand All @@ -566,6 +568,8 @@ def descending_sort(client):

def multi_sort(client):
# Create the entity that we're going to query.
import datetime

task = upsert(client)
task["created"] = datetime.datetime.now(tz=datetime.timezone.utc)
client.put(task)
Expand Down Expand Up @@ -620,23 +624,31 @@ def kindless_query(client):

def inequality_range(client):
# [START datastore_inequality_range]
import datetime

start_date = datetime.datetime(1990, 1, 1)
end_date = datetime.datetime(2000, 1, 1)
query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("created", ">", start_date))
query.add_filter(filter=PropertyFilter("created", "<", end_date))
query.add_filter(filter=datastore.query.PropertyFilter("created", ">", start_date))
query.add_filter(filter=datastore.query.PropertyFilter("created", "<", end_date))
# [END datastore_inequality_range]

return list(query.fetch())


def inequality_invalid(client):
import google.cloud.exceptions

try:
# [START datastore_inequality_invalid]
import datetime

start_date = datetime.datetime(1990, 1, 1)
query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("created", ">", start_date))
query.add_filter(filter=PropertyFilter("priority", ">", 3))
query.add_filter(
filter=datastore.query.PropertyFilter("created", ">", start_date)
)
query.add_filter(filter=datastore.query.PropertyFilter("priority", ">", 3))
# [END datastore_inequality_invalid]

return list(query.fetch())
Expand All @@ -647,13 +659,15 @@ def inequality_invalid(client):

def equal_and_inequality_range(client):
# [START datastore_equal_and_inequality_range]
import datetime

start_date = datetime.datetime(1990, 1, 1)
end_date = datetime.datetime(2000, 12, 31, 23, 59, 59)
query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("priority", "=", 4))
query.add_filter(filter=PropertyFilter("done", "=", False))
query.add_filter(filter=PropertyFilter("created", ">", start_date))
query.add_filter(filter=PropertyFilter("created", "<", end_date))
query.add_filter(filter=datastore.query.PropertyFilter("priority", "=", 4))
query.add_filter(filter=datastore.query.PropertyFilter("done", "=", False))
query.add_filter(filter=datastore.query.PropertyFilter("created", ">", start_date))
query.add_filter(filter=datastore.query.PropertyFilter("created", "<", end_date))
# [END datastore_equal_and_inequality_range]

return list(query.fetch())
Expand All @@ -662,18 +676,20 @@ def equal_and_inequality_range(client):
def inequality_sort(client):
# [START datastore_inequality_sort]
query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("priority", ">", 3))
query.add_filter(filter=datastore.query.PropertyFilter("priority", ">", 3))
query.order = ["priority", "created"]
# [END datastore_inequality_sort]

return list(query.fetch())


def inequality_sort_invalid_not_same(client):
import google.cloud.exceptions

try:
# [START datastore_inequality_sort_invalid_not_same]
query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("priority", ">", 3))
query.add_filter(filter=datastore.query.PropertyFilter("priority", ">", 3))
query.order = ["created"]
# [END datastore_inequality_sort_invalid_not_same]

Expand All @@ -684,10 +700,12 @@ def inequality_sort_invalid_not_same(client):


def inequality_sort_invalid_not_first(client):
import google.cloud.exceptions

try:
# [START datastore_inequality_sort_invalid_not_first]
query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("priority", ">", 3))
query.add_filter(filter=datastore.query.PropertyFilter("priority", ">", 3))
query.order = ["created", "priority"]
# [END datastore_inequality_sort_invalid_not_first]

Expand All @@ -700,8 +718,8 @@ def inequality_sort_invalid_not_first(client):
def array_value_inequality_range(client):
# [START datastore_array_value_inequality_range]
query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("tag", ">", "learn"))
query.add_filter(filter=PropertyFilter("tag", "<", "math"))
query.add_filter(filter=datastore.query.PropertyFilter("tag", ">", "learn"))
query.add_filter(filter=datastore.query.PropertyFilter("tag", "<", "math"))
# [END datastore_array_value_inequality_range]

return list(query.fetch())
Expand All @@ -710,15 +728,17 @@ def array_value_inequality_range(client):
def array_value_equality(client):
# [START datastore_array_value_equality]
query = client.query(kind="Task")
query.add_filter(filter=PropertyFilter("tag", "=", "fun"))
query.add_filter(filter=PropertyFilter("tag", "=", "programming"))
query.add_filter(filter=datastore.query.PropertyFilter("tag", "=", "fun"))
query.add_filter(filter=datastore.query.PropertyFilter("tag", "=", "programming"))
# [END datastore_array_value_equality]

return list(query.fetch())


def exploding_properties(client):
# [START datastore_exploding_properties]
import datetime

task = datastore.Entity(client.key("Task"))
task.update(
{
Expand Down Expand Up @@ -754,6 +774,8 @@ def transfer_funds(client, from_key, to_key, amount):
# [END datastore_transactional_update]

# [START datastore_transactional_retry]
import google.cloud.exceptions

for _ in range(5):
try:
transfer_funds(client, account1.key, account2.key, 50)
Expand All @@ -769,6 +791,8 @@ def transfer_funds(client, from_key, to_key, amount):

def transactional_get_or_create(client):
# [START datastore_transactional_get_or_create]
import datetime

with client.transaction():
key = client.key(
"Task", datetime.datetime.now(tz=datetime.timezone.utc).isoformat()
Expand Down Expand Up @@ -850,6 +874,8 @@ def property_run_query(client):
upsert(client)

# [START datastore_property_run_query]
from collections import defaultdict

query = client.query(kind="__property__")
query.keys_only()

Expand Down Expand Up @@ -887,6 +913,9 @@ def property_by_kind_run_query(client):

def regional_endpoint():
# [START datastore_regional_endpoints]
from google.cloud import datastore
Copy link

Choose a reason for hiding this comment

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

Why is this the only sample that has this import?

Copy link
Member Author

Choose a reason for hiding this comment

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

All the other ones also include the preamble, which imports datastore and creates the client

from google.api_core.client_options import ClientOptions

ENDPOINT = "https://nam5-datastore.googleapis.com"
client_options = ClientOptions(api_endpoint=ENDPOINT)
client = datastore.Client(client_options=client_options)
Expand Down Expand Up @@ -1006,6 +1035,8 @@ def index_merge_queries(client):


def main(project_id):
from pprint import pprint

client = datastore.Client(project_id)

for name, function in globals().items():
Expand All @@ -1018,6 +1049,8 @@ def main(project_id):


if __name__ == "__main__":
import argparse

parser = argparse.ArgumentParser(
description="Demonstrates datastore API operations."
)
Expand Down
Loading