├── .github
    ├── snippet-bot.yml
    ├── flakybot.yaml
    ├── ISSUE_TEMPLATE
    │   ├── support_request.md
    │   ├── feature_request.md
    │   └── bug_report.md
    ├── header-checker-lint.yml
    ├── workflows
    │   ├── mypy.yml
    │   ├── lint.yml
    │   ├── docs.yml
    │   └── unittest.yml
    ├── PULL_REQUEST_TEMPLATE.md
    ├── auto-label.yaml
    ├── blunderbuss.yml
    ├── CODEOWNERS
    └── CONTRIBUTING.md
├── testing
    ├── constraints-3.10.txt
    ├── constraints-3.11.txt
    ├── constraints-3.12.txt
    ├── constraints-3.13.txt
    ├── constraints-3.9.txt
    ├── constraints-3.14.txt
    ├── constraints-3.8.txt
    ├── .gitignore
    └── constraints-3.7.txt
├── tests
    ├── system
    │   ├── __init__.py
    │   ├── utils
    │   │   ├── __init__.py
    │   │   └── clear_datastore.py
    │   ├── index.yaml
    │   ├── _helpers.py
    │   ├── conftest.py
    │   ├── test_allocate_reserve_ids.py
    │   └── test_read_consistency.py
    ├── __init__.py
    ├── unit
    │   ├── __init__.py
    │   ├── gapic
    │   │   ├── __init__.py
    │   │   ├── datastore_v1
    │   │   │   └── __init__.py
    │   │   └── datastore_admin_v1
    │   │   │   └── __init__.py
    │   ├── test_packaging.py
    │   ├── test__gapic.py
    │   └── test_query_profile.py
    └── doctests.py
├── docs
    ├── changelog.md
    ├── keys.rst
    ├── batches.rst
    ├── helpers.rst
    ├── queries.rst
    ├── entities.rst
    ├── client.rst
    ├── aggregations.rst
    ├── transactions.rst
    ├── usage.html
    ├── admin_client.rst
    ├── _static
    │   └── custom.css
    ├── summary_overview.md
    ├── index.rst
    ├── _templates
    │   └── layout.html
    └── UPGRADING.md
├── .release-please-manifest.json
├── samples
    └── snippets
    │   ├── requirements.txt
    │   ├── schedule-export
    │       ├── requirements.txt
    │       ├── requirements-test.txt
    │       ├── README.md
    │       ├── noxfile_config.py
    │       ├── main.py
    │       └── schedule_export_test.py
    │   ├── requirements-test.txt
    │   └── noxfile_config.py
├── google
    └── cloud
    │   ├── datastore
    │       ├── py.typed
    │       ├── version.py
    │       ├── gapic_version.py
    │       ├── _app_engine_key.proto
    │       ├── _gapic.py
    │       ├── __init__.py
    │       ├── _app_engine_key_pb2.py
    │       └── query_profile.py
    │   ├── datastore_admin
    │       ├── py.typed
    │       ├── gapic_version.py
    │       └── __init__.py
    │   ├── datastore_v1
    │       ├── py.typed
    │       ├── services
    │       │   ├── __init__.py
    │       │   └── datastore
    │       │   │   ├── transports
    │       │   │       ├── README.rst
    │       │   │       └── __init__.py
    │       │   │   └── __init__.py
    │       ├── gapic_version.py
    │       ├── types
    │       │   ├── __init__.py
    │       │   ├── aggregation_result.py
    │       │   └── query_profile.py
    │       └── gapic_metadata.json
    │   └── datastore_admin_v1
    │       ├── py.typed
    │       ├── services
    │           ├── __init__.py
    │           └── datastore_admin
    │           │   ├── transports
    │           │       ├── README.rst
    │           │       └── __init__.py
    │           │   └── __init__.py
    │       ├── gapic_version.py
    │       ├── types
    │           ├── __init__.py
    │           └── index.py
    │       └── gapic_metadata.json
├── .kokoro
    ├── samples
    │   ├── lint
    │   │   ├── periodic.cfg
    │   │   ├── presubmit.cfg
    │   │   ├── continuous.cfg
    │   │   └── common.cfg
    │   ├── python3.7
    │   │   ├── presubmit.cfg
    │   │   ├── continuous.cfg
    │   │   ├── periodic.cfg
    │   │   ├── periodic-head.cfg
    │   │   └── common.cfg
    │   ├── python3.8
    │   │   ├── presubmit.cfg
    │   │   ├── continuous.cfg
    │   │   ├── periodic.cfg
    │   │   ├── periodic-head.cfg
    │   │   └── common.cfg
    │   ├── python3.9
    │   │   ├── presubmit.cfg
    │   │   ├── continuous.cfg
    │   │   ├── periodic.cfg
    │   │   ├── periodic-head.cfg
    │   │   └── common.cfg
    │   ├── python3.10
    │   │   ├── continuous.cfg
    │   │   ├── presubmit.cfg
    │   │   ├── periodic.cfg
    │   │   ├── periodic-head.cfg
    │   │   └── common.cfg
    │   ├── python3.11
    │   │   ├── continuous.cfg
    │   │   ├── presubmit.cfg
    │   │   ├── periodic.cfg
    │   │   ├── periodic-head.cfg
    │   │   └── common.cfg
    │   ├── python3.12
    │   │   ├── continuous.cfg
    │   │   ├── presubmit.cfg
    │   │   ├── periodic.cfg
    │   │   ├── periodic-head.cfg
    │   │   └── common.cfg
    │   ├── python3.13
    │   │   ├── continuous.cfg
    │   │   ├── presubmit.cfg
    │   │   ├── periodic.cfg
    │   │   ├── periodic-head.cfg
    │   │   └── common.cfg
    │   └── python3.14
    │   │   ├── continuous.cfg
    │   │   ├── presubmit.cfg
    │   │   ├── periodic.cfg
    │   │   ├── periodic-head.cfg
    │   │   └── common.cfg
    ├── presubmit
    │   ├── system-3.12.cfg
    │   ├── system-3.14.cfg
    │   ├── prerelease-deps.cfg
    │   ├── presubmit.cfg
    │   └── common.cfg
    ├── continuous
    │   ├── prerelease-deps.cfg
    │   ├── continuous.cfg
    │   └── common.cfg
    ├── trampoline.sh
    ├── test-samples-against-head.sh
    ├── populate-secrets.sh
    ├── test-samples.sh
    ├── build.sh
    └── test-samples-impl.sh
├── SECURITY.md
├── scripts
    ├── readme-gen
    │   ├── templates
    │   │   ├── auth.tmpl.rst
    │   │   ├── auth_api_key.tmpl.rst
    │   │   ├── install_deps.tmpl.rst
    │   │   ├── install_portaudio.tmpl.rst
    │   │   └── README.tmpl.rst
    │   └── readme_gen.py
    └── decrypt-secrets.sh
├── renovate.json
├── mypy.ini
├── release-please-config.json
├── .gitignore
├── MANIFEST.in
├── pylint.config.py
├── .flake8
├── .coveragerc
├── .repo-metadata.json
├── .librarian
    ├── generator-input
    │   ├── .repo-metadata.json
    │   ├── librarian.py
    │   └── setup.py
    └── state.yaml
├── .pre-commit-config.yaml
├── .trampolinerc
├── librarian.py
├── UPGRADING.md
├── setup.py
└── CODE_OF_CONDUCT.md


/.github/snippet-bot.yml:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/testing/constraints-3.10.txt:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/testing/constraints-3.11.txt:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/testing/constraints-3.12.txt:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/testing/constraints-3.13.txt:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/testing/constraints-3.9.txt:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/tests/system/__init__.py:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/docs/changelog.md:
--------------------------------------------------------------------------------
1 | ../CHANGELOG.md


--------------------------------------------------------------------------------
/tests/system/utils/__init__.py:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/.github/flakybot.yaml:
--------------------------------------------------------------------------------
1 | issuePriority: p2
2 | 


--------------------------------------------------------------------------------
/testing/constraints-3.14.txt:
--------------------------------------------------------------------------------
1 | grpcio >= 1.75.1


--------------------------------------------------------------------------------
/.release-please-manifest.json:
--------------------------------------------------------------------------------
1 | {
2 |     ".": "2.21.0"
3 | }


--------------------------------------------------------------------------------
/testing/constraints-3.8.txt:
--------------------------------------------------------------------------------
1 | google-api-core==2.14.0
2 | 


--------------------------------------------------------------------------------
/samples/snippets/requirements.txt:
--------------------------------------------------------------------------------
1 | google-cloud-datastore==2.20.0


--------------------------------------------------------------------------------
/testing/.gitignore:
--------------------------------------------------------------------------------
1 | test-env.sh
2 | service-account.json
3 | client-secrets.json


--------------------------------------------------------------------------------
/samples/snippets/schedule-export/requirements.txt:
--------------------------------------------------------------------------------
1 | google-cloud-datastore==2.20.0
2 | 


--------------------------------------------------------------------------------
/docs/keys.rst:
--------------------------------------------------------------------------------
1 | Keys
2 | ~~~~
3 | 
4 | .. automodule:: google.cloud.datastore.key
5 |   :members:
6 |   :show-inheritance:
7 | 


--------------------------------------------------------------------------------
/google/cloud/datastore/py.typed:
--------------------------------------------------------------------------------
1 | # Marker file for PEP 561.
2 | # The google-cloud-datastore package uses inline types.
3 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_admin/py.typed:
--------------------------------------------------------------------------------
1 | # Marker file for PEP 561.
2 | # The google-cloud-datastore package uses inline types.
3 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_v1/py.typed:
--------------------------------------------------------------------------------
1 | # Marker file for PEP 561.
2 | # The google-cloud-datastore package uses inline types.
3 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_admin_v1/py.typed:
--------------------------------------------------------------------------------
1 | # Marker file for PEP 561.
2 | # The google-cloud-datastore package uses inline types.
3 | 


--------------------------------------------------------------------------------
/docs/batches.rst:
--------------------------------------------------------------------------------
1 | Batches
2 | ~~~~~~~
3 | 
4 | .. automodule:: google.cloud.datastore.batch
5 |   :members:
6 |   :show-inheritance:
7 | 


--------------------------------------------------------------------------------
/docs/helpers.rst:
--------------------------------------------------------------------------------
1 | Helpers
2 | ~~~~~~~
3 | 
4 | .. automodule:: google.cloud.datastore.helpers
5 |   :members:
6 |   :show-inheritance:
7 | 


--------------------------------------------------------------------------------
/docs/queries.rst:
--------------------------------------------------------------------------------
1 | Queries
2 | ~~~~~~~
3 | 
4 | .. automodule:: google.cloud.datastore.query
5 |   :members:
6 |   :show-inheritance:
7 | 


--------------------------------------------------------------------------------
/samples/snippets/schedule-export/requirements-test.txt:
--------------------------------------------------------------------------------
1 | pytest===7.4.3; python_version == '3.7'
2 | pytest==8.3.2; python_version >= '3.8'


--------------------------------------------------------------------------------
/docs/entities.rst:
--------------------------------------------------------------------------------
1 | Entities
2 | ~~~~~~~~
3 | 
4 | .. automodule:: google.cloud.datastore.entity
5 |   :members:
6 |   :show-inheritance:
7 | 


--------------------------------------------------------------------------------
/docs/client.rst:
--------------------------------------------------------------------------------
1 | Datastore Client
2 | ================
3 | 
4 | .. automodule:: google.cloud.datastore.client
5 |   :members:
6 |   :show-inheritance:
7 | 


--------------------------------------------------------------------------------
/docs/aggregations.rst:
--------------------------------------------------------------------------------
1 | Aggregations
2 | ~~~~~~~~~~~~
3 | 
4 | .. automodule:: google.cloud.datastore.aggregation
5 |   :members:
6 |   :show-inheritance:
7 | 


--------------------------------------------------------------------------------
/.kokoro/samples/lint/periodic.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "False"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/lint/presubmit.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/lint/continuous.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.7/presubmit.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.8/presubmit.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.9/presubmit.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/docs/transactions.rst:
--------------------------------------------------------------------------------
1 | Transactions
2 | ~~~~~~~~~~~~
3 | 
4 | .. automodule:: google.cloud.datastore.transaction
5 |   :members:
6 |   :show-inheritance:
7 |   :inherited-members:
8 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.10/continuous.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.10/presubmit.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.11/continuous.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.11/presubmit.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.12/continuous.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.12/presubmit.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.13/continuous.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.13/presubmit.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.14/continuous.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.14/presubmit.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.7/continuous.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.7/periodic.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "False"
6 | }
7 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.8/continuous.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.8/periodic.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "False"
6 | }
7 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.9/continuous.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "True"
6 | }


--------------------------------------------------------------------------------
/.kokoro/samples/python3.9/periodic.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "False"
6 | }
7 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.10/periodic.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "False"
6 | }
7 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.11/periodic.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "False"
6 | }
7 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.12/periodic.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "False"
6 | }
7 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.13/periodic.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "False"
6 | }
7 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.14/periodic.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | env_vars: {
4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
5 |     value: "False"
6 | }
7 | 


--------------------------------------------------------------------------------
/.kokoro/presubmit/system-3.12.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | # Only run this nox session.
4 | env_vars: {
5 |     key: "NOX_SESSION"
6 |     value: "system-3.12"
7 | }


--------------------------------------------------------------------------------
/.kokoro/presubmit/system-3.14.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | # Only run this nox session.
4 | env_vars: {
5 |     key: "NOX_SESSION"
6 |     value: "system-3.14"
7 | }


--------------------------------------------------------------------------------
/docs/usage.html:
--------------------------------------------------------------------------------
1 | <html>
2 | <head>
3 |  <meta http-equiv="refresh" content="1; url=./index.html:" />
4 |  <script>
5 |    window.location.href = "./index.html"
6 |  </script>
7 | </head>
8 | </html>
9 | 


--------------------------------------------------------------------------------
/docs/admin_client.rst:
--------------------------------------------------------------------------------
1 | Datastore Admin Client
2 | ======================
3 | 
4 | .. automodule:: google.cloud.datastore_admin_v1.services.datastore_admin.client
5 |   :members:
6 |   :show-inheritance:
7 | 


--------------------------------------------------------------------------------
/.kokoro/continuous/prerelease-deps.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | # Only run this nox session.
4 | env_vars: {
5 |     key: "NOX_SESSION"
6 |     value: "prerelease_deps"
7 | }
8 | 


--------------------------------------------------------------------------------
/.kokoro/presubmit/prerelease-deps.cfg:
--------------------------------------------------------------------------------
1 | # Format: //devtools/kokoro/config/proto/build.proto
2 | 
3 | # Only run this nox session.
4 | env_vars: {
5 |     key: "NOX_SESSION"
6 |     value: "prerelease_deps"
7 | }
8 | 


--------------------------------------------------------------------------------
/samples/snippets/requirements-test.txt:
--------------------------------------------------------------------------------
1 | backoff===1.11.1; python_version < "3.7"
2 | backoff==2.2.1; python_version >= "3.7"
3 | pytest===7.4.3; python_version == '3.7'
4 | pytest==8.3.2; python_version >= '3.8'
5 | flaky==3.8.1
6 | 


--------------------------------------------------------------------------------
/.kokoro/continuous/continuous.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | # Disable system tests.
 4 | env_vars: {
 5 |     key: "RUN_SYSTEM_TESTS"
 6 |     value: "false"
 7 | }
 8 | 
 9 | env_vars: {
10 |     key: "NOX_SESSION"
11 |     value: "blacken doctests format"
12 | }
13 | 


--------------------------------------------------------------------------------
/.kokoro/presubmit/presubmit.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | # Disable system tests.
 4 | env_vars: {
 5 |     key: "RUN_SYSTEM_TESTS"
 6 |     value: "false"
 7 | }
 8 | 
 9 | env_vars: {
10 |     key: "NOX_SESSION"
11 |     value: "blacken doctests format"
12 | }
13 | 


--------------------------------------------------------------------------------
/samples/snippets/schedule-export/README.md:
--------------------------------------------------------------------------------
1 | # Scheduling Datastore exports with Cloud Functions and Cloud Scheduler
2 | 
3 | This sample application demonstrates how to schedule exports of your Datastore entities. To deploy this sample, see:
4 | 
5 | [Scheduling exports](https://cloud.google.com/datastore/docs/schedule-export)
6 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.10/periodic-head.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | env_vars: {
 4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
 5 |     value: "True"
 6 | }
 7 | 
 8 | env_vars: {
 9 |     key: "TRAMPOLINE_BUILD_FILE"
10 |     value: "github/python-datastore/.kokoro/test-samples-against-head.sh"
11 | }
12 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.11/periodic-head.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | env_vars: {
 4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
 5 |     value: "True"
 6 | }
 7 | 
 8 | env_vars: {
 9 |     key: "TRAMPOLINE_BUILD_FILE"
10 |     value: "github/python-datastore/.kokoro/test-samples-against-head.sh"
11 | }
12 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.12/periodic-head.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | env_vars: {
 4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
 5 |     value: "True"
 6 | }
 7 | 
 8 | env_vars: {
 9 |     key: "TRAMPOLINE_BUILD_FILE"
10 |     value: "github/python-datastore/.kokoro/test-samples-against-head.sh"
11 | }
12 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.13/periodic-head.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | env_vars: {
 4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
 5 |     value: "True"
 6 | }
 7 | 
 8 | env_vars: {
 9 |     key: "TRAMPOLINE_BUILD_FILE"
10 |     value: "github/python-datastore/.kokoro/test-samples-against-head.sh"
11 | }
12 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.14/periodic-head.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | env_vars: {
 4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
 5 |     value: "True"
 6 | }
 7 | 
 8 | env_vars: {
 9 |     key: "TRAMPOLINE_BUILD_FILE"
10 |     value: "github/python-datastore/.kokoro/test-samples-against-head.sh"
11 | }
12 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.7/periodic-head.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | env_vars: {
 4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
 5 |     value: "True"
 6 | }
 7 | 
 8 | env_vars: {
 9 |     key: "TRAMPOLINE_BUILD_FILE"
10 |     value: "github/python-datastore/.kokoro/test-samples-against-head.sh"
11 | }
12 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.8/periodic-head.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | env_vars: {
 4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
 5 |     value: "True"
 6 | }
 7 | 
 8 | env_vars: {
 9 |     key: "TRAMPOLINE_BUILD_FILE"
10 |     value: "github/python-datastore/.kokoro/test-samples-against-head.sh"
11 | }
12 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.9/periodic-head.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | env_vars: {
 4 |     key: "INSTALL_LIBRARY_FROM_SOURCE"
 5 |     value: "True"
 6 | }
 7 | 
 8 | env_vars: {
 9 |     key: "TRAMPOLINE_BUILD_FILE"
10 |     value: "github/python-datastore/.kokoro/test-samples-against-head.sh"
11 | }
12 | 


--------------------------------------------------------------------------------
/SECURITY.md:
--------------------------------------------------------------------------------
1 | # Security Policy
2 | 
3 | To report a security issue, please use [g.co/vulnz](https://g.co/vulnz).
4 | 
5 | The Google Security Team will respond within 5 working days of your report on g.co/vulnz.
6 | 
7 | We use g.co/vulnz for our intake, and do coordination and disclosure here using GitHub Security Advisory to privately discuss and fix the issue.
8 | 


--------------------------------------------------------------------------------
/scripts/readme-gen/templates/auth.tmpl.rst:
--------------------------------------------------------------------------------
 1 | Authentication
 2 | ++++++++++++++
 3 | 
 4 | This sample requires you to have authentication setup. Refer to the
 5 | `Authentication Getting Started Guide`_ for instructions on setting up
 6 | credentials for applications.
 7 | 
 8 | .. _Authentication Getting Started Guide:
 9 |     https://cloud.google.com/docs/authentication/getting-started
10 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/support_request.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Support request
3 | about: If you have a support contract with Google, please create an issue in the Google Cloud Support console.
4 | 
5 | ---
6 | 
7 | **PLEASE READ**: If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/) instead of filing on GitHub. This will ensure a timely response.
8 | 


--------------------------------------------------------------------------------
/renovate.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "extends": [
 3 |     "config:base",
 4 |     "group:all",
 5 |     ":preserveSemverRanges",
 6 |     ":disableDependencyDashboard"
 7 |   ],
 8 |   "ignorePaths": [".pre-commit-config.yaml", ".kokoro/requirements.txt", "setup.py", ".github/workflows/unittest.yml"],
 9 |   "pip_requirements": {
10 |     "fileMatch": ["requirements-test.txt", "samples/[\\S/]*constraints.txt", "samples/[\\S/]*constraints-test.txt"]
11 |   }
12 | }
13 | 


--------------------------------------------------------------------------------
/.github/header-checker-lint.yml:
--------------------------------------------------------------------------------
 1 | {"allowedCopyrightHolders": ["Google LLC"],
 2 |  "allowedLicenses": ["Apache-2.0", "MIT", "BSD-3"],
 3 |  "ignoreFiles": ["**/requirements.txt", "**/requirements-test.txt", "**/__init__.py", "samples/**/constraints.txt", "samples/**/constraints-test.txt"],
 4 |  "sourceFileExtensions": [
 5 |  	"ts", 
 6 |  	"js", 
 7 |  	"java", 
 8 |  	"sh", 
 9 |  	"Dockerfile", 
10 |  	"yaml", 
11 |  	"py",
12 |  	"html",
13 |  	"txt"
14 |  ]
15 | }


--------------------------------------------------------------------------------
/docs/_static/custom.css:
--------------------------------------------------------------------------------
 1 | div#python2-eol {
 2 | 	border-color: red;
 3 | 	border-width: medium;
 4 | }
 5 | 
 6 | /* Ensure minimum width for 'Parameters' / 'Returns' column */
 7 | dl.field-list > dt {
 8 |     min-width: 100px
 9 | }
10 | 
11 | /* Insert space between methods for readability */
12 | dl.method {
13 | 	padding-top: 10px;
14 | 	padding-bottom: 10px
15 | }
16 | 
17 | /* Insert empty space between classes */
18 | dl.class {
19 | 	padding-bottom: 50px
20 | }
21 | 


--------------------------------------------------------------------------------
/testing/constraints-3.7.txt:
--------------------------------------------------------------------------------
 1 | # This constraints file is used to check that lower bounds
 2 | # are correct in setup.py
 3 | # List *all* library dependencies and extras in this file.
 4 | # Pin the version to the lower bound.
 5 | #
 6 | # e.g., if setup.py has "foo >= 1.14.0, < 2.0.0dev",
 7 | # Then this file should have foo==1.14.0
 8 | google-api-core==1.34.0
 9 | google-auth==2.14.1
10 | google-cloud-core==1.4.0
11 | proto-plus==1.22.0
12 | libcst==0.2.5
13 | protobuf==3.20.2
14 | 


--------------------------------------------------------------------------------
/scripts/readme-gen/templates/auth_api_key.tmpl.rst:
--------------------------------------------------------------------------------
 1 | Authentication
 2 | ++++++++++++++
 3 | 
 4 | Authentication for this service is done via an `API Key`_. To obtain an API
 5 | Key:
 6 | 
 7 | 1. Open the `Cloud Platform Console`_
 8 | 2. Make sure that billing is enabled for your project.
 9 | 3. From the **Credentials** page, create a new **API Key** or use an existing
10 |    one for your project.
11 | 
12 | .. _API Key:
13 |     https://developers.google.com/api-client-library/python/guide/aaa_apikeys
14 | .. _Cloud Console: https://console.cloud.google.com/project?_
15 | 


--------------------------------------------------------------------------------
/.github/workflows/mypy.yml:
--------------------------------------------------------------------------------
 1 | on:
 2 |   pull_request:
 3 |     branches:
 4 |       - main
 5 | name: mypy
 6 | jobs:
 7 |   mypy:
 8 |     runs-on: ubuntu-latest
 9 |     steps:
10 |     - name: Checkout
11 |       uses: actions/checkout@v4
12 |     - name: Setup Python
13 |       uses: actions/setup-python@v5
14 |       with:
15 |         python-version: "3.14"
16 |     - name: Install nox
17 |       run: |
18 |         python -m pip install --upgrade setuptools pip wheel
19 |         python -m pip install nox
20 |     - name: Run mypy
21 |       run: |
22 |         nox -s mypy
23 | 


--------------------------------------------------------------------------------
/.github/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
1 | Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
2 | - [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/python-datastore/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
3 | - [ ] Ensure the tests and linter pass
4 | - [ ] Code coverage does not decrease (if any source code was changed)
5 | - [ ] Appropriate docs were updated (if necessary)
6 | 
7 | Fixes #<issue_number_goes_here> 🦕
8 | 


--------------------------------------------------------------------------------
/mypy.ini:
--------------------------------------------------------------------------------
 1 | [mypy]
 2 | python_version = 3.10
 3 | namespace_packages = True
 4 | ignore_missing_imports = True
 5 | 
 6 | [mypy-google.cloud.datastore._app_engine_key_pb2]
 7 | ignore_errors = True
 8 | 
 9 | # TODO(https://github.com/googleapis/gapic-generator-python/issues/2410):
10 | # Remove once this generator bug is fixed
11 | [mypy-google.cloud.datastore_v1.services.datastore.async_client]
12 | ignore_errors = True
13 | 
14 | # TODO(https://github.com/googleapis/gapic-generator-python/issues/2410):
15 | # Remove once this generator bug is fixed
16 | [mypy-google.cloud.datastore_v1.services.datastore.client]
17 | ignore_errors = True
18 | 


--------------------------------------------------------------------------------
/.github/workflows/lint.yml:
--------------------------------------------------------------------------------
 1 | on:
 2 |   pull_request:
 3 |     branches:
 4 |       - main
 5 | name: lint
 6 | jobs:
 7 |   lint:
 8 |     runs-on: ubuntu-latest
 9 |     steps:
10 |     - name: Checkout
11 |       uses: actions/checkout@v4
12 |     - name: Setup Python
13 |       uses: actions/setup-python@v5
14 |       with:
15 |         python-version: "3.14"
16 |     - name: Install nox
17 |       run: |
18 |         python -m pip install --upgrade setuptools pip wheel
19 |         python -m pip install nox
20 |     - name: Run lint
21 |       run: |
22 |         nox -s lint
23 |     - name: Run lint_setup_py
24 |       run: |
25 |         nox -s lint_setup_py
26 | 


--------------------------------------------------------------------------------
/tests/__init__.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | 


--------------------------------------------------------------------------------
/tests/unit/__init__.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | 


--------------------------------------------------------------------------------
/google/cloud/datastore/version.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2020 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #     http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | __version__ = "2.23.0"
16 | 


--------------------------------------------------------------------------------
/tests/unit/gapic/__init__.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | 


--------------------------------------------------------------------------------
/tests/unit/gapic/datastore_v1/__init__.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_v1/services/__init__.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | 


--------------------------------------------------------------------------------
/tests/unit/gapic/datastore_admin_v1/__init__.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_admin_v1/services/__init__.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_v1/services/datastore/transports/README.rst:
--------------------------------------------------------------------------------
 1 | 
 2 | transport inheritance structure
 3 | _______________________________
 4 | 
 5 | `DatastoreTransport` is the ABC for all transports.
 6 | - public child `DatastoreGrpcTransport` for sync gRPC transport (defined in `grpc.py`).
 7 | - public child `DatastoreGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`).
 8 | - private child `_BaseDatastoreRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`).
 9 | - public child `DatastoreRestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`).
10 | 


--------------------------------------------------------------------------------
/google/cloud/datastore/gapic_version.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2020 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #     http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | __version__ = "2.23.0"  # {x-release-please-version}
16 | 


--------------------------------------------------------------------------------
/release-please-config.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "$schema":
 3 | "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
 4 |     "packages": {
 5 |         ".": {
 6 |             "release-type": "python",
 7 |             "extra-files": [
 8 |                 "google/cloud/datastore/gapic_version.py",
 9 |                 "google/cloud/datastore_admin/gapic_version.py",
10 |                 "google/cloud/datastore_admin_v1/gapic_version.py",
11 |                 "google/cloud/datastore_v1/gapic_version.py"
12 |             ]
13 |         }
14 |     },
15 |     "release-type": "python",
16 |     "plugins": [
17 |         {
18 |             "type": "sentence-case"
19 |         }
20 |     ],
21 |     "initial-version": "2.10.0"
22 | }


--------------------------------------------------------------------------------
/google/cloud/datastore_admin_v1/services/datastore_admin/transports/README.rst:
--------------------------------------------------------------------------------
 1 | 
 2 | transport inheritance structure
 3 | _______________________________
 4 | 
 5 | `DatastoreAdminTransport` is the ABC for all transports.
 6 | - public child `DatastoreAdminGrpcTransport` for sync gRPC transport (defined in `grpc.py`).
 7 | - public child `DatastoreAdminGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`).
 8 | - private child `_BaseDatastoreAdminRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`).
 9 | - public child `DatastoreAdminRestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`).
10 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_v1/gapic_version.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | __version__ = "2.23.0"  # {x-release-please-version}
17 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_admin/gapic_version.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | __version__ = "2.23.0"  # {x-release-please-version}
17 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_admin_v1/gapic_version.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | __version__ = "2.23.0"  # {x-release-please-version}
17 | 


--------------------------------------------------------------------------------
/.github/auto-label.yaml:
--------------------------------------------------------------------------------
 1 | # Copyright 2024 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #     http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | requestsize:
15 |   enabled: true
16 | 
17 | path:
18 |   pullrequest: true
19 |   paths:
20 |     samples: "samples"
21 | 


--------------------------------------------------------------------------------
/.github/blunderbuss.yml:
--------------------------------------------------------------------------------
 1 | # Blunderbuss config
 2 | #
 3 | # This file controls who is assigned for pull requests and issues.
 4 | # Note: This file is autogenerated. To make changes to the assignee
 5 | # team, please update `codeowner_team` in `.repo-metadata.json`.
 6 | assign_issues:
 7 |   - googleapis/cloud-native-db-dpes
 8 |   - googleapis/api-datastore-sdk
 9 |   - googleapis/api-firestore-partners
10 | 
11 | assign_issues_by:
12 |   - labels:
13 |       - "samples"
14 |     to:
15 |       - googleapis/python-samples-reviewers
16 |       - googleapis/cloud-native-db-dpes
17 |       - googleapis/api-datastore-sdk
18 |       - googleapis/api-firestore-partners
19 | 
20 | assign_prs:
21 |   - googleapis/cloud-native-db-dpes
22 |   - googleapis/api-datastore-sdk
23 |   - googleapis/api-firestore-partners
24 | 


--------------------------------------------------------------------------------
/docs/summary_overview.md:
--------------------------------------------------------------------------------
 1 | [
 2 | This is a templated file. Adding content to this file may result in it being
 3 | reverted. Instead, if you want to place additional content, create an
 4 | "overview_content.md" file in `docs/` directory. The Sphinx tool will
 5 | pick up on the content and merge the content.
 6 | ]: #
 7 | 
 8 | # Google Cloud Datastore API
 9 | 
10 | Overview of the APIs available for Google Cloud Datastore API.
11 | 
12 | ## All entries
13 | 
14 | Classes, methods and properties & attributes for
15 | Google Cloud Datastore API.
16 | 
17 | [classes](https://cloud.google.com/python/docs/reference/datastore/latest/summary_class.html)
18 | 
19 | [methods](https://cloud.google.com/python/docs/reference/datastore/latest/summary_method.html)
20 | 
21 | [properties and
22 | attributes](https://cloud.google.com/python/docs/reference/datastore/latest/summary_property.html)
23 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_v1/services/datastore/__init__.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | from .client import DatastoreClient
17 | from .async_client import DatastoreAsyncClient
18 | 
19 | __all__ = (
20 |     "DatastoreClient",
21 |     "DatastoreAsyncClient",
22 | )
23 | 


--------------------------------------------------------------------------------
/.kokoro/continuous/common.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | # Build logs will be here
 4 | action {
 5 |   define_artifacts {
 6 |     regex: "**/*sponge_log.xml"
 7 |   }
 8 | }
 9 | 
10 | # Download trampoline resources.
11 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
12 | 
13 | # Download resources for system tests (service account key, etc.)
14 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/google-cloud-python"
15 | 
16 | # Use the trampoline script to run in docker.
17 | build_file: "python-datastore/.kokoro/trampoline.sh"
18 | 
19 | # Configure the docker image for kokoro-trampoline.
20 | env_vars: {
21 |     key: "TRAMPOLINE_IMAGE"
22 |     value: "gcr.io/cloud-devrel-kokoro-resources/python-multi"
23 | }
24 | env_vars: {
25 |     key: "TRAMPOLINE_BUILD_FILE"
26 |     value: "github/python-datastore/.kokoro/build.sh"
27 | }
28 | 


--------------------------------------------------------------------------------
/.kokoro/presubmit/common.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | # Build logs will be here
 4 | action {
 5 |   define_artifacts {
 6 |     regex: "**/*sponge_log.xml"
 7 |   }
 8 | }
 9 | 
10 | # Download trampoline resources.
11 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
12 | 
13 | # Download resources for system tests (service account key, etc.)
14 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/google-cloud-python"
15 | 
16 | # Use the trampoline script to run in docker.
17 | build_file: "python-datastore/.kokoro/trampoline.sh"
18 | 
19 | # Configure the docker image for kokoro-trampoline.
20 | env_vars: {
21 |     key: "TRAMPOLINE_IMAGE"
22 |     value: "gcr.io/cloud-devrel-kokoro-resources/python-multi"
23 | }
24 | env_vars: {
25 |     key: "TRAMPOLINE_BUILD_FILE"
26 |     value: "github/python-datastore/.kokoro/build.sh"
27 | }
28 | 


--------------------------------------------------------------------------------
/tests/system/index.yaml:
--------------------------------------------------------------------------------
 1 | indexes:
 2 | 
 3 | - kind: Character
 4 |   ancestor: yes
 5 |   properties:
 6 |   - name: appearances
 7 | 
 8 | - kind: Character
 9 |   ancestor: yes
10 |   properties:
11 |   - name: alive
12 | 
13 | - kind: Character
14 |   ancestor: yes
15 |   properties:
16 |   - name: family
17 |   - name: appearances
18 | 
19 | - kind: Character
20 |   ancestor: yes
21 |   properties:
22 |   - name: name
23 |   - name: family
24 | 
25 | - kind: Character
26 |   properties:
27 |   - name: alive
28 |   - name: appearances
29 | 
30 | - kind: Character
31 |   properties:
32 |   - name: Character
33 |   - name: appearances
34 | 
35 | - kind: Character
36 |   ancestor: yes
37 |   properties:
38 |     - name: alive
39 |     - name: family
40 |     - name: appearances
41 | 
42 | - kind: Character
43 |   ancestor: yes
44 |   properties:
45 |     - name: family
46 |     - name: appearances
47 | 
48 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_admin_v1/services/datastore_admin/__init__.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | from .client import DatastoreAdminClient
17 | from .async_client import DatastoreAdminAsyncClient
18 | 
19 | __all__ = (
20 |     "DatastoreAdminClient",
21 |     "DatastoreAdminAsyncClient",
22 | )
23 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | *.py[cod]
 2 | *.sw[op]
 3 | 
 4 | # C extensions
 5 | *.so
 6 | 
 7 | # Packages
 8 | *.egg
 9 | *.egg-info
10 | dist
11 | build
12 | eggs
13 | .eggs
14 | parts
15 | bin
16 | var
17 | sdist
18 | develop-eggs
19 | .installed.cfg
20 | lib
21 | lib64
22 | __pycache__
23 | 
24 | # Installer logs
25 | pip-log.txt
26 | 
27 | # Unit test / coverage reports
28 | .coverage
29 | .nox
30 | .cache
31 | .pytest_cache
32 | 
33 | 
34 | # Mac
35 | .DS_Store
36 | 
37 | # JetBrains
38 | .idea
39 | 
40 | # VS Code
41 | .vscode
42 | 
43 | # emacs
44 | *~
45 | 
46 | # Built documentation
47 | docs/_build
48 | bigquery/docs/generated
49 | docs.metadata
50 | 
51 | # Virtual environment
52 | env/
53 | venv/
54 | 
55 | # Test logs
56 | coverage.xml
57 | *sponge_log.xml
58 | 
59 | # System test environment variables.
60 | system_tests/local_test_setup
61 | 
62 | # Make sure a generated file isn't accidentally committed.
63 | pylintrc
64 | pylintrc.test
65 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Feature request
 3 | about: Suggest an idea for this library
 4 | 
 5 | ---
 6 | 
 7 | Thanks for stopping by to let us know something could be better!
 8 | 
 9 | **PLEASE READ**: If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/) instead of filing on GitHub. This will ensure a timely response.
10 | 
11 |  **Is your feature request related to a problem? Please describe.**
12 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13 |  **Describe the solution you'd like**
14 | A clear and concise description of what you want to happen.
15 |  **Describe alternatives you've considered**
16 | A clear and concise description of any alternative solutions or features you've considered.
17 |  **Additional context**
18 | Add any other context or screenshots about the feature request here.
19 | 


--------------------------------------------------------------------------------
/MANIFEST.in:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | #
 3 | # Copyright 2024 Google LLC
 4 | #
 5 | # Licensed under the Apache License, Version 2.0 (the "License");
 6 | # you may not use this file except in compliance with the License.
 7 | # You may obtain a copy of the License at
 8 | #
 9 | #     https://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | 
17 | # Generated by synthtool. DO NOT EDIT!
18 | include README.rst LICENSE
19 | recursive-include google *.json *.proto py.typed
20 | recursive-include tests *
21 | global-exclude *.py[co]
22 | global-exclude __pycache__
23 | 
24 | # Exclude scripts for samples readmegen
25 | prune scripts/readme-gen
26 | 


--------------------------------------------------------------------------------
/pylint.config.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2017 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #     http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | """This module is used to configure gcp-devrel-py-tools run-pylint."""
16 | 
17 | # Library configuration
18 | 
19 | # library_additions = {}
20 | # library_replacements = {}
21 | 
22 | # Test configuration
23 | 
24 | # test_additions = copy.deepcopy(library_additions)
25 | # test_replacements = copy.deepcopy(library_replacements)
26 | 


--------------------------------------------------------------------------------
/.kokoro/samples/lint/common.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | # Build logs will be here
 4 | action {
 5 |   define_artifacts {
 6 |     regex: "**/*sponge_log.xml"
 7 |   }
 8 | }
 9 | 
10 | # Specify which tests to run
11 | env_vars: {
12 |     key: "RUN_TESTS_SESSION"
13 |     value: "lint"
14 | }
15 | 
16 | env_vars: {
17 |     key: "TRAMPOLINE_BUILD_FILE"
18 |     value: "github/python-datastore/.kokoro/test-samples.sh"
19 | }
20 | 
21 | # Configure the docker image for kokoro-trampoline.
22 | env_vars: {
23 |     key: "TRAMPOLINE_IMAGE"
24 |     value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker"
25 | }
26 | 
27 | # Download secrets for samples
28 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
29 | 
30 | # Download trampoline resources.
31 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
32 | 
33 | # Use the trampoline script to run in docker.
34 | build_file: "python-datastore/.kokoro/trampoline_v2.sh"


--------------------------------------------------------------------------------
/.flake8:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | #
 3 | # Copyright 2024 Google LLC
 4 | #
 5 | # Licensed under the Apache License, Version 2.0 (the "License");
 6 | # you may not use this file except in compliance with the License.
 7 | # You may obtain a copy of the License at
 8 | #
 9 | #     https://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | 
17 | # Generated by synthtool. DO NOT EDIT!
18 | [flake8]
19 | ignore = E203, E231, E266, E501, W503
20 | exclude =
21 |   # Exclude generated code.
22 |   **/proto/**
23 |   **/gapic/**
24 |   **/services/**
25 |   **/types/**
26 |   *_pb2.py
27 | 
28 |   # Standard linting exemptions.
29 |   **/.nox/**
30 |   __pycache__,
31 |   .git,
32 |   *.pyc,
33 |   conf.py
34 | 


--------------------------------------------------------------------------------
/.github/CODEOWNERS:
--------------------------------------------------------------------------------
 1 | # Code owners file.
 2 | # This file controls who is tagged for review for any given pull request.
 3 | #
 4 | # For syntax help see:
 5 | # https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax
 6 | # Note: This file is autogenerated. To make changes to the codeowner team, please update .repo-metadata.json.
 7 | 
 8 | # @googleapis/yoshi-python @googleapis/cloud-native-db-dpes @googleapis/api-datastore-sdk @googleapis/api-firestore-partners are the default owners for changes in this repo
 9 | *     @googleapis/yoshi-python @googleapis/cloud-native-db-dpes @googleapis/api-datastore-sdk @googleapis/api-firestore-partners
10 | 
11 | # @googleapis/python-samples-reviewers @googleapis/cloud-native-db-dpes @googleapis/api-datastore-sdk @googleapis/api-firestore-partners are the default owners for samples changes
12 | /samples/   @googleapis/python-samples-reviewers @googleapis/cloud-native-db-dpes @googleapis/api-datastore-sdk @googleapis/api-firestore-partners
13 | 


--------------------------------------------------------------------------------
/.github/workflows/docs.yml:
--------------------------------------------------------------------------------
 1 | on:
 2 |   pull_request:
 3 |     branches:
 4 |       - main
 5 | name: docs
 6 | jobs:
 7 |   docs:
 8 |     runs-on: ubuntu-latest
 9 |     steps:
10 |     - name: Checkout
11 |       uses: actions/checkout@v4
12 |     - name: Setup Python
13 |       uses: actions/setup-python@v5
14 |       with:
15 |         python-version: "3.10"
16 |     - name: Install nox
17 |       run: |
18 |         python -m pip install --upgrade setuptools pip wheel
19 |         python -m pip install nox
20 |     - name: Run docs
21 |       run: |
22 |         nox -s docs
23 |   docfx:
24 |     runs-on: ubuntu-latest
25 |     steps:
26 |     - name: Checkout
27 |       uses: actions/checkout@v4
28 |     - name: Setup Python
29 |       uses: actions/setup-python@v5
30 |       with:
31 |         python-version: "3.10"
32 |     - name: Install nox
33 |       run: |
34 |         python -m pip install --upgrade setuptools pip wheel
35 |         python -m pip install nox
36 |     - name: Run docfx
37 |       run: |
38 |         nox -s docfx
39 | 


--------------------------------------------------------------------------------
/scripts/readme-gen/templates/install_deps.tmpl.rst:
--------------------------------------------------------------------------------
 1 | Install Dependencies
 2 | ++++++++++++++++++++
 3 | 
 4 | #. Clone python-docs-samples and change directory to the sample directory you want to use.
 5 | 
 6 |     .. code-block:: bash
 7 | 
 8 |         $ git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
 9 | 
10 | #. Install `pip`_ and `virtualenv`_ if you do not already have them. You may want to refer to the `Python Development Environment Setup Guide`_ for Google Cloud Platform for instructions.
11 | 
12 |    .. _Python Development Environment Setup Guide:
13 |        https://cloud.google.com/python/setup
14 | 
15 | #. Create a virtualenv. Samples are compatible with Python 3.7+.
16 | 
17 |     .. code-block:: bash
18 | 
19 |         $ virtualenv env
20 |         $ source env/bin/activate
21 | 
22 | #. Install the dependencies needed to run the samples.
23 | 
24 |     .. code-block:: bash
25 | 
26 |         $ pip install -r requirements.txt
27 | 
28 | .. _pip: https://pip.pypa.io/
29 | .. _virtualenv: https://virtualenv.pypa.io/
30 | 


--------------------------------------------------------------------------------
/google/cloud/datastore/_app_engine_key.proto:
--------------------------------------------------------------------------------
 1 | // Copyright 2017 Google LLC
 2 | //
 3 | // Licensed under the Apache License, Version 2.0 (the "License");
 4 | // you may not use this file except in compliance with the License.
 5 | // You may obtain a copy of the License at
 6 | //
 7 | //     http://www.apache.org/licenses/LICENSE-2.0
 8 | //
 9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 | 
15 | syntax = "proto2";
16 | 
17 | message Reference {
18 |   required string app = 13;
19 |   optional string name_space = 20;
20 |   required Path path = 14;
21 |   optional string database_id = 23;
22 | }
23 | 
24 | message Path {
25 |   repeated group Element = 1 {
26 |     required string type = 2;
27 |     optional int64 id = 3;
28 |     optional string name = 4;
29 |   }
30 | }
31 | 


--------------------------------------------------------------------------------
/.coveragerc:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | #
 3 | # Copyright 2020 Google LLC
 4 | #
 5 | # Licensed under the Apache License, Version 2.0 (the "License");
 6 | # you may not use this file except in compliance with the License.
 7 | # You may obtain a copy of the License at
 8 | #
 9 | #     https://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | 
17 | [run]
18 | branch = True
19 | [report]
20 | fail_under = 100
21 | show_missing = True
22 | omit =
23 |   google/__init__.py
24 |   google/cloud/__init__.py
25 |   google/cloud/datastore_v1/__init__.py
26 |   google/cloud/datastore_admin_v1/__init__.py
27 |   */site-packages/*.py
28 | exclude_lines =
29 |     # Re-enable the standard pragma
30 |     pragma: NO COVER
31 |     # Ignore debug-only repr
32 |     def __repr__
33 | 


--------------------------------------------------------------------------------
/.kokoro/trampoline.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | # Copyright 2024 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #      http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | 
16 | set -eo pipefail
17 | 
18 | # Always run the cleanup script, regardless of the success of bouncing into
19 | # the container.
20 | function cleanup() {
21 |     chmod +x ${KOKORO_GFILE_DIR}/trampoline_cleanup.sh
22 |     ${KOKORO_GFILE_DIR}/trampoline_cleanup.sh
23 |     echo "cleanup";
24 | }
25 | trap cleanup EXIT
26 | 
27 | $(dirname $0)/populate-secrets.sh # Secret Manager secrets.
28 | python3 "${KOKORO_GFILE_DIR}/trampoline_v1.py"


--------------------------------------------------------------------------------
/.kokoro/test-samples-against-head.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | # Copyright 2024 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     https://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | 
16 | # A customized test runner for samples.
17 | #
18 | # For periodic builds, you can specify this file for testing against head.
19 | 
20 | # `-e` enables the script to automatically fail when a command fails
21 | # `-o pipefail` sets the exit code to the rightmost comment to exit with a non-zero
22 | set -eo pipefail
23 | # Enables `**` to include files nested inside sub-folders
24 | shopt -s globstar
25 | 
26 | exec .kokoro/test-samples-impl.sh
27 | 


--------------------------------------------------------------------------------
/.repo-metadata.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "datastore",
 3 |     "name_pretty": "Google Cloud Datastore",
 4 |     "product_documentation": "https://cloud.google.com/datastore",
 5 |     "client_documentation": "https://cloud.google.com/python/docs/reference/datastore/latest",
 6 |     "issue_tracker": "https://issuetracker.google.com/savedsearches/559768",
 7 |     "release_level": "stable",
 8 |     "language": "python",
 9 |     "library_type": "GAPIC_COMBO",
10 |     "repo": "googleapis/python-datastore",
11 |     "distribution_name": "google-cloud-datastore",
12 |     "api_id": "datastore.googleapis.com",
13 |     "default_version": "v1",
14 |     "codeowner_team": "@googleapis/cloud-native-db-dpes @googleapis/api-datastore-sdk @googleapis/api-firestore-partners",
15 |     "api_shortname": "datastore",
16 |     "api_description": "is a fully managed, schemaless database for\nstoring non-relational data. Cloud Datastore automatically scales with\nyour users and supports ACID transactions, high availability of reads and\nwrites, strong consistency for reads and ancestor queries, and eventual\nconsistency for all other queries."
17 | }
18 | 


--------------------------------------------------------------------------------
/docs/index.rst:
--------------------------------------------------------------------------------
 1 | .. include:: README.rst
 2 | 
 3 | .. note::
 4 | 
 5 |    Because the Datastore client uses the :mod:`grpcio` library by default
 6 |    and uses third-party :mod:`requests` library if the GRPC is disabled,
 7 |    clients are safe to share instances across threads.  In multiprocessing
 8 |    scenarios, the best practice is to create client instances *after*
 9 |    :class:`multiprocessing.Pool` or :class:`multiprocessing.Process` invokes
10 |    :func:`os.fork`.
11 | 
12 | API Reference
13 | -------------
14 | .. toctree::
15 |   :maxdepth: 2
16 | 
17 |   client
18 |   entities
19 |   keys
20 |   queries
21 |   aggregations
22 |   transactions
23 |   batches
24 |   helpers
25 |   admin_client
26 | 
27 | Migration Guide
28 | ---------------
29 | 
30 | See the guide below for instructions on migrating to the 2.x release of this library.
31 | 
32 | .. toctree::
33 |     :maxdepth: 2
34 | 
35 |     UPGRADING
36 | 
37 | Changelog
38 | ---------
39 | 
40 | For a list of all ``google-cloud-datastore`` releases:
41 | 
42 | .. toctree::
43 |   :maxdepth: 2
44 | 
45 |   changelog
46 | 
47 | .. toctree::
48 |   :hidden:
49 | 
50 |   summary_overview.md
51 | 


--------------------------------------------------------------------------------
/.librarian/generator-input/.repo-metadata.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "datastore",
 3 |     "name_pretty": "Google Cloud Datastore",
 4 |     "product_documentation": "https://cloud.google.com/datastore",
 5 |     "client_documentation": "https://cloud.google.com/python/docs/reference/datastore/latest",
 6 |     "issue_tracker": "https://issuetracker.google.com/savedsearches/559768",
 7 |     "release_level": "stable",
 8 |     "language": "python",
 9 |     "library_type": "GAPIC_COMBO",
10 |     "repo": "googleapis/python-datastore",
11 |     "distribution_name": "google-cloud-datastore",
12 |     "api_id": "datastore.googleapis.com",
13 |     "default_version": "v1",
14 |     "codeowner_team": "@googleapis/cloud-native-db-dpes @googleapis/api-datastore-sdk @googleapis/api-firestore-partners",
15 |     "api_shortname": "datastore",
16 |     "api_description": "is a fully managed, schemaless database for\nstoring non-relational data. Cloud Datastore automatically scales with\nyour users and supports ACID transactions, high availability of reads and\nwrites, strong consistency for reads and ancestor queries, and eventual\nconsistency for all other queries."
17 | }
18 | 


--------------------------------------------------------------------------------
/.pre-commit-config.yaml:
--------------------------------------------------------------------------------
 1 | # Copyright 2024 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | # http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | #
15 | # See https://pre-commit.com for more information
16 | # See https://pre-commit.com/hooks.html for more hooks
17 | repos:
18 | -   repo: https://github.com/pre-commit/pre-commit-hooks
19 |     rev: v4.0.1
20 |     hooks:
21 |     -   id: trailing-whitespace
22 |     -   id: end-of-file-fixer
23 |     -   id: check-yaml
24 | -   repo: https://github.com/psf/black
25 |     rev: 23.7.0
26 |     hooks:
27 |     - id: black
28 | -   repo: https://github.com/pycqa/flake8
29 |     rev: 6.1.0
30 |     hooks:
31 |     - id: flake8
32 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.10/common.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | # Build logs will be here
 4 | action {
 5 |   define_artifacts {
 6 |     regex: "**/*sponge_log.xml"
 7 |   }
 8 | }
 9 | 
10 | # Specify which tests to run
11 | env_vars: {
12 |     key: "RUN_TESTS_SESSION"
13 |     value: "py-3.10"
14 | }
15 | 
16 | # Declare build specific Cloud project.
17 | env_vars: {
18 |     key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
19 |     value: "python-docs-samples-tests-310"
20 | }
21 | 
22 | env_vars: {
23 |     key: "TRAMPOLINE_BUILD_FILE"
24 |     value: "github/python-datastore/.kokoro/test-samples.sh"
25 | }
26 | 
27 | # Configure the docker image for kokoro-trampoline.
28 | env_vars: {
29 |     key: "TRAMPOLINE_IMAGE"
30 |     value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker"
31 | }
32 | 
33 | # Download secrets for samples
34 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
35 | 
36 | # Download trampoline resources.
37 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
38 | 
39 | # Use the trampoline script to run in docker.
40 | build_file: "python-datastore/.kokoro/trampoline_v2.sh"


--------------------------------------------------------------------------------
/.kokoro/samples/python3.11/common.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | # Build logs will be here
 4 | action {
 5 |   define_artifacts {
 6 |     regex: "**/*sponge_log.xml"
 7 |   }
 8 | }
 9 | 
10 | # Specify which tests to run
11 | env_vars: {
12 |     key: "RUN_TESTS_SESSION"
13 |     value: "py-3.11"
14 | }
15 | 
16 | # Declare build specific Cloud project.
17 | env_vars: {
18 |     key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
19 |     value: "python-docs-samples-tests-311"
20 | }
21 | 
22 | env_vars: {
23 |     key: "TRAMPOLINE_BUILD_FILE"
24 |     value: "github/python-datastore/.kokoro/test-samples.sh"
25 | }
26 | 
27 | # Configure the docker image for kokoro-trampoline.
28 | env_vars: {
29 |     key: "TRAMPOLINE_IMAGE"
30 |     value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker"
31 | }
32 | 
33 | # Download secrets for samples
34 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
35 | 
36 | # Download trampoline resources.
37 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
38 | 
39 | # Use the trampoline script to run in docker.
40 | build_file: "python-datastore/.kokoro/trampoline_v2.sh"


--------------------------------------------------------------------------------
/.kokoro/samples/python3.12/common.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | # Build logs will be here
 4 | action {
 5 |   define_artifacts {
 6 |     regex: "**/*sponge_log.xml"
 7 |   }
 8 | }
 9 | 
10 | # Specify which tests to run
11 | env_vars: {
12 |     key: "RUN_TESTS_SESSION"
13 |     value: "py-3.12"
14 | }
15 | 
16 | # Declare build specific Cloud project.
17 | env_vars: {
18 |     key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
19 |     value: "python-docs-samples-tests-312"
20 | }
21 | 
22 | env_vars: {
23 |     key: "TRAMPOLINE_BUILD_FILE"
24 |     value: "github/python-datastore/.kokoro/test-samples.sh"
25 | }
26 | 
27 | # Configure the docker image for kokoro-trampoline.
28 | env_vars: {
29 |     key: "TRAMPOLINE_IMAGE"
30 |     value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker"
31 | }
32 | 
33 | # Download secrets for samples
34 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
35 | 
36 | # Download trampoline resources.
37 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
38 | 
39 | # Use the trampoline script to run in docker.
40 | build_file: "python-datastore/.kokoro/trampoline_v2.sh"


--------------------------------------------------------------------------------
/.kokoro/samples/python3.7/common.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | # Build logs will be here
 4 | action {
 5 |   define_artifacts {
 6 |     regex: "**/*sponge_log.xml"
 7 |   }
 8 | }
 9 | 
10 | # Specify which tests to run
11 | env_vars: {
12 |     key: "RUN_TESTS_SESSION"
13 |     value: "py-3.7"
14 | }
15 | 
16 | # Declare build specific Cloud project.
17 | env_vars: {
18 |     key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
19 |     value: "python-docs-samples-tests-py37"
20 | }
21 | 
22 | env_vars: {
23 |     key: "TRAMPOLINE_BUILD_FILE"
24 |     value: "github/python-datastore/.kokoro/test-samples.sh"
25 | }
26 | 
27 | # Configure the docker image for kokoro-trampoline.
28 | env_vars: {
29 |     key: "TRAMPOLINE_IMAGE"
30 |     value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker"
31 | }
32 | 
33 | # Download secrets for samples
34 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
35 | 
36 | # Download trampoline resources.
37 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
38 | 
39 | # Use the trampoline script to run in docker.
40 | build_file: "python-datastore/.kokoro/trampoline_v2.sh"


--------------------------------------------------------------------------------
/.kokoro/samples/python3.8/common.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | # Build logs will be here
 4 | action {
 5 |   define_artifacts {
 6 |     regex: "**/*sponge_log.xml"
 7 |   }
 8 | }
 9 | 
10 | # Specify which tests to run
11 | env_vars: {
12 |     key: "RUN_TESTS_SESSION"
13 |     value: "py-3.8"
14 | }
15 | 
16 | # Declare build specific Cloud project.
17 | env_vars: {
18 |     key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
19 |     value: "python-docs-samples-tests-py38"
20 | }
21 | 
22 | env_vars: {
23 |     key: "TRAMPOLINE_BUILD_FILE"
24 |     value: "github/python-datastore/.kokoro/test-samples.sh"
25 | }
26 | 
27 | # Configure the docker image for kokoro-trampoline.
28 | env_vars: {
29 |     key: "TRAMPOLINE_IMAGE"
30 |     value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker"
31 | }
32 | 
33 | # Download secrets for samples
34 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
35 | 
36 | # Download trampoline resources.
37 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
38 | 
39 | # Use the trampoline script to run in docker.
40 | build_file: "python-datastore/.kokoro/trampoline_v2.sh"


--------------------------------------------------------------------------------
/.kokoro/samples/python3.9/common.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | # Build logs will be here
 4 | action {
 5 |   define_artifacts {
 6 |     regex: "**/*sponge_log.xml"
 7 |   }
 8 | }
 9 | 
10 | # Specify which tests to run
11 | env_vars: {
12 |     key: "RUN_TESTS_SESSION"
13 |     value: "py-3.9"
14 | }
15 | 
16 | # Declare build specific Cloud project.
17 | env_vars: {
18 |     key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
19 |     value: "python-docs-samples-tests-py39"
20 | }
21 | 
22 | env_vars: {
23 |     key: "TRAMPOLINE_BUILD_FILE"
24 |     value: "github/python-datastore/.kokoro/test-samples.sh"
25 | }
26 | 
27 | # Configure the docker image for kokoro-trampoline.
28 | env_vars: {
29 |     key: "TRAMPOLINE_IMAGE"
30 |     value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker"
31 | }
32 | 
33 | # Download secrets for samples
34 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
35 | 
36 | # Download trampoline resources.
37 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
38 | 
39 | # Use the trampoline script to run in docker.
40 | build_file: "python-datastore/.kokoro/trampoline_v2.sh"


--------------------------------------------------------------------------------
/.kokoro/samples/python3.13/common.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | # Build logs will be here
 4 | action {
 5 |   define_artifacts {
 6 |     regex: "**/*sponge_log.xml"
 7 |   }
 8 | }
 9 | 
10 | # Specify which tests to run
11 | env_vars: {
12 |     key: "RUN_TESTS_SESSION"
13 |     value: "py-3.13"
14 | }
15 | 
16 | # Declare build specific Cloud project.
17 | env_vars: {
18 |     key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
19 |     value: "python-docs-samples-tests-313"
20 | }
21 | 
22 | env_vars: {
23 |     key: "TRAMPOLINE_BUILD_FILE"
24 |     value: "github/python-datastore/.kokoro/test-samples.sh"
25 | }
26 | 
27 | # Configure the docker image for kokoro-trampoline.
28 | env_vars: {
29 |     key: "TRAMPOLINE_IMAGE"
30 |     value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker"
31 | }
32 | 
33 | # Download secrets for samples
34 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
35 | 
36 | # Download trampoline resources.
37 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
38 | 
39 | # Use the trampoline script to run in docker.
40 | build_file: "python-datastore/.kokoro/trampoline_v2.sh"
41 | 


--------------------------------------------------------------------------------
/.kokoro/samples/python3.14/common.cfg:
--------------------------------------------------------------------------------
 1 | # Format: //devtools/kokoro/config/proto/build.proto
 2 | 
 3 | # Build logs will be here
 4 | action {
 5 |   define_artifacts {
 6 |     regex: "**/*sponge_log.xml"
 7 |   }
 8 | }
 9 | 
10 | # Specify which tests to run
11 | env_vars: {
12 |     key: "RUN_TESTS_SESSION"
13 |     value: "py-3.14"
14 | }
15 | 
16 | # Declare build specific Cloud project.
17 | env_vars: {
18 |     key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
19 |     value: "python-docs-samples-tests-314"
20 | }
21 | 
22 | env_vars: {
23 |     key: "TRAMPOLINE_BUILD_FILE"
24 |     value: "github/python-datastore/.kokoro/test-samples.sh"
25 | }
26 | 
27 | # Configure the docker image for kokoro-trampoline.
28 | env_vars: {
29 |     key: "TRAMPOLINE_IMAGE"
30 |     value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker"
31 | }
32 | 
33 | # Download secrets for samples
34 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
35 | 
36 | # Download trampoline resources.
37 | gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
38 | 
39 | # Use the trampoline script to run in docker.
40 | build_file: "python-datastore/.kokoro/trampoline_v2.sh"
41 | 


--------------------------------------------------------------------------------
/.github/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # How to Contribute
 2 | 
 3 | We'd love to accept your patches and contributions to this project. There are
 4 | just a few small guidelines you need to follow.
 5 | 
 6 | ## Contributor License Agreement
 7 | 
 8 | Contributions to this project must be accompanied by a Contributor License
 9 | Agreement. You (or your employer) retain the copyright to your contribution;
10 | this simply gives us permission to use and redistribute your contributions as
11 | part of the project. Head over to <https://cla.developers.google.com/> to see
12 | your current agreements on file or to sign a new one.
13 | 
14 | You generally only need to submit a CLA once, so if you've already submitted one
15 | (even if it was for a different project), you probably don't need to do it
16 | again.
17 | 
18 | ## Code reviews
19 | 
20 | All submissions, including submissions by project members, require review. We
21 | use GitHub pull requests for this purpose. Consult
22 | [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
23 | information on using pull requests.
24 | 
25 | ## Community Guidelines
26 | 
27 | This project follows [Google's Open Source Community
28 | Guidelines](https://opensource.google.com/conduct/).
29 | 


--------------------------------------------------------------------------------
/.librarian/state.yaml:
--------------------------------------------------------------------------------
 1 | image: us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/python-librarian-generator@sha256:b8058df4c45e9a6e07f6b4d65b458d0d059241dd34c814f151c8bf6b89211209
 2 | libraries:
 3 |   - id: google-cloud-datastore
 4 |     version: 2.23.0
 5 |     last_generated_commit: 659ea6e98acc7d58661ce2aa7b4cf76a7ef3fd42
 6 |     apis:
 7 |       - path: google/datastore/v1
 8 |         service_config: datastore_v1.yaml
 9 |       - path: google/datastore/admin/v1
10 |         service_config: datastore_v1.yaml
11 |     source_roots:
12 |       - .
13 |     preserve_regex: []
14 |     remove_regex:
15 |       - ^google/cloud/datastore_v1
16 |       - ^google/cloud/datastore_admin
17 |       - ^google/cloud/datastore_admin_v1
18 |       - ^tests/unit/gapic
19 |       - ^tests/__init__.py
20 |       - ^tests/unit/__init__.py
21 |       - ^.pre-commit-config.yaml
22 |       - ^.repo-metadata.json
23 |       - ^.trampolinerc
24 |       - ^SECURITY.md
25 |       - ^noxfile.py
26 |       - ^owlbot.py
27 |       - ^renovate.json
28 |       - ^samples/AUTHORING_GUIDE.md
29 |       - ^samples/CONTRIBUTING.md
30 |       - ^samples/generated_samples
31 |       - ^scripts/fixup_
32 |       - ^setup.py
33 |       - ^README.rst
34 |       - ^docs/README.rst
35 |       - ^docs/summary_overview.md
36 |     tag_format: v{version}
37 | 


--------------------------------------------------------------------------------
/scripts/readme-gen/templates/install_portaudio.tmpl.rst:
--------------------------------------------------------------------------------
 1 | Install PortAudio
 2 | +++++++++++++++++
 3 | 
 4 | Install `PortAudio`_. This is required by the `PyAudio`_ library to stream
 5 | audio from your computer's microphone. PyAudio depends on PortAudio for cross-platform compatibility, and is installed differently depending on the
 6 | platform.
 7 | 
 8 | * For Mac OS X, you can use `Homebrew`_::
 9 | 
10 |       brew install portaudio
11 | 
12 |   **Note**: if you encounter an error when running `pip install` that indicates
13 |   it can't find `portaudio.h`, try running `pip install` with the following
14 |   flags::
15 | 
16 |       pip install --global-option='build_ext' \
17 |           --global-option='-I/usr/local/include' \
18 |           --global-option='-L/usr/local/lib' \
19 |           pyaudio
20 | 
21 | * For Debian / Ubuntu Linux::
22 | 
23 |       apt-get install portaudio19-dev python-all-dev
24 | 
25 | * Windows may work without having to install PortAudio explicitly (it will get
26 |   installed with PyAudio).
27 | 
28 | For more details, see the `PyAudio installation`_ page.
29 | 
30 | 
31 | .. _PyAudio: https://people.csail.mit.edu/hubert/pyaudio/
32 | .. _PortAudio: http://www.portaudio.com/
33 | .. _PyAudio installation:
34 |   https://people.csail.mit.edu/hubert/pyaudio/#downloads
35 | .. _Homebrew: http://brew.sh
36 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Bug report
 3 | about: Create a report to help us improve
 4 | 
 5 | ---
 6 | 
 7 | Thanks for stopping by to let us know something could be better!
 8 | 
 9 | **PLEASE READ**: If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/) instead of filing on GitHub. This will ensure a timely response.
10 | 
11 | Please run down the following list and make sure you've tried the usual "quick fixes":
12 | 
13 |   - Search the issues already opened: https://github.com/googleapis/python-datastore/issues
14 |   - Search StackOverflow: https://stackoverflow.com/questions/tagged/google-cloud-platform+python
15 | 
16 | If you are still having issues, please be sure to include as much information as possible:
17 | 
18 | #### Environment details
19 | 
20 |   - OS type and version:
21 |   - Python version: `python --version`
22 |   - pip version: `pip --version`
23 |   - `google-cloud-datastore` version: `pip show google-cloud-datastore`
24 | 
25 | #### Steps to reproduce
26 | 
27 |   1. ?
28 |   2. ?
29 | 
30 | #### Code example
31 | 
32 | ```python
33 | # example
34 | ```
35 | 
36 | #### Stack trace
37 | ```
38 | # example
39 | ```
40 | 
41 | Making sure to follow these steps will guarantee the quickest resolution possible.
42 | 
43 | Thanks!
44 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_v1/services/datastore/transports/__init__.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | from collections import OrderedDict
17 | from typing import Dict, Type
18 | 
19 | from .base import DatastoreTransport
20 | from .grpc import DatastoreGrpcTransport
21 | from .grpc_asyncio import DatastoreGrpcAsyncIOTransport
22 | from .rest import DatastoreRestTransport
23 | from .rest import DatastoreRestInterceptor
24 | 
25 | 
26 | # Compile a registry of transports.
27 | _transport_registry = OrderedDict()  # type: Dict[str, Type[DatastoreTransport]]
28 | _transport_registry["grpc"] = DatastoreGrpcTransport
29 | _transport_registry["grpc_asyncio"] = DatastoreGrpcAsyncIOTransport
30 | _transport_registry["rest"] = DatastoreRestTransport
31 | 
32 | __all__ = (
33 |     "DatastoreTransport",
34 |     "DatastoreGrpcTransport",
35 |     "DatastoreGrpcAsyncIOTransport",
36 |     "DatastoreRestTransport",
37 |     "DatastoreRestInterceptor",
38 | )
39 | 


--------------------------------------------------------------------------------
/tests/unit/test_packaging.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2023 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #      http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | import os
16 | import subprocess
17 | import sys
18 | 
19 | 
20 | def test_namespace_package_compat(tmp_path):
21 |     # The ``google`` namespace package should not be masked
22 |     # by the presence of ``google-cloud-datastore``.
23 |     google = tmp_path / "google"
24 |     google.mkdir()
25 |     google.joinpath("othermod.py").write_text("")
26 |     env = dict(os.environ, PYTHONPATH=str(tmp_path))
27 |     cmd = [sys.executable, "-m", "google.othermod"]
28 |     subprocess.check_call(cmd, env=env)
29 | 
30 |     # The ``google.cloud`` namespace package should not be masked
31 |     # by the presence of ``google-cloud-datastore``.
32 |     google_cloud = tmp_path / "google" / "cloud"
33 |     google_cloud.mkdir()
34 |     google_cloud.joinpath("othermod.py").write_text("")
35 |     env = dict(os.environ, PYTHONPATH=str(tmp_path))
36 |     cmd = [sys.executable, "-m", "google.cloud.othermod"]
37 |     subprocess.check_call(cmd, env=env)
38 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_admin_v1/services/datastore_admin/transports/__init__.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | from collections import OrderedDict
17 | from typing import Dict, Type
18 | 
19 | from .base import DatastoreAdminTransport
20 | from .grpc import DatastoreAdminGrpcTransport
21 | from .grpc_asyncio import DatastoreAdminGrpcAsyncIOTransport
22 | from .rest import DatastoreAdminRestTransport
23 | from .rest import DatastoreAdminRestInterceptor
24 | 
25 | 
26 | # Compile a registry of transports.
27 | _transport_registry = OrderedDict()  # type: Dict[str, Type[DatastoreAdminTransport]]
28 | _transport_registry["grpc"] = DatastoreAdminGrpcTransport
29 | _transport_registry["grpc_asyncio"] = DatastoreAdminGrpcAsyncIOTransport
30 | _transport_registry["rest"] = DatastoreAdminRestTransport
31 | 
32 | __all__ = (
33 |     "DatastoreAdminTransport",
34 |     "DatastoreAdminGrpcTransport",
35 |     "DatastoreAdminGrpcAsyncIOTransport",
36 |     "DatastoreAdminRestTransport",
37 |     "DatastoreAdminRestInterceptor",
38 | )
39 | 


--------------------------------------------------------------------------------
/.kokoro/populate-secrets.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | # Copyright 2024 Google LLC.
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #      http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | 
16 | set -eo pipefail
17 | 
18 | function now { date +"%Y-%m-%d %H:%M:%S" | tr -d '\n' ;}
19 | function msg { println "$*" >&2 ;}
20 | function println { printf '%s\n' "$(now) $*" ;}
21 | 
22 | 
23 | # Populates requested secrets set in SECRET_MANAGER_KEYS from service account:
24 | # kokoro-trampoline@cloud-devrel-kokoro-resources.iam.gserviceaccount.com
25 | SECRET_LOCATION="${KOKORO_GFILE_DIR}/secret_manager"
26 | msg "Creating folder on disk for secrets: ${SECRET_LOCATION}"
27 | mkdir -p ${SECRET_LOCATION}
28 | for key in $(echo ${SECRET_MANAGER_KEYS} | sed "s/,/ /g")
29 | do
30 |   msg "Retrieving secret ${key}"
31 |   docker run --entrypoint=gcloud \
32 |     --volume=${KOKORO_GFILE_DIR}:${KOKORO_GFILE_DIR} \
33 |     gcr.io/google.com/cloudsdktool/cloud-sdk \
34 |     secrets versions access latest \
35 |     --project cloud-devrel-kokoro-resources \
36 |     --secret ${key} > \
37 |     "${SECRET_LOCATION}/${key}"
38 |   if [[ $? == 0 ]]; then
39 |     msg "Secret written to ${SECRET_LOCATION}/${key}"
40 |   else
41 |     msg "Error retrieving secret ${key}"
42 |   fi
43 | done
44 | 


--------------------------------------------------------------------------------
/tests/system/_helpers.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2021 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #     http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | import os
16 | 
17 | from google.cloud import datastore
18 | from google.cloud.datastore.client import DATASTORE_DATASET
19 | from test_utils.system import unique_resource_id
20 | 
21 | _DATASTORE_DATABASE = "SYSTEM_TESTS_DATABASE"
22 | TEST_DATABASE = os.getenv(_DATASTORE_DATABASE, "system-tests-named-db")
23 | EMULATOR_DATASET = os.getenv(DATASTORE_DATASET)
24 | 
25 | 
26 | def unique_id(prefix, separator="-"):
27 |     return f"{prefix}{unique_resource_id(separator)}"
28 | 
29 | 
30 | _SENTINEL = object()
31 | 
32 | 
33 | def clone_client(base_client, namespace=_SENTINEL, database=_SENTINEL):
34 |     if namespace is _SENTINEL:
35 |         namespace = base_client.namespace
36 | 
37 |     if database is _SENTINEL:
38 |         database = base_client.database
39 | 
40 |     kwargs = {}
41 |     if EMULATOR_DATASET is None:
42 |         kwargs["credentials"] = base_client._credentials
43 | 
44 |     return datastore.Client(
45 |         project=base_client.project,
46 |         database=database,
47 |         namespace=namespace,
48 |         _http=base_client._http,
49 |         **kwargs,
50 |     )
51 | 


--------------------------------------------------------------------------------
/docs/_templates/layout.html:
--------------------------------------------------------------------------------
 1 | 
 2 | {% extends "!layout.html" %}
 3 | {%- block content %}
 4 | {%- if theme_fixed_sidebar|lower == 'true' %}
 5 |   <div class="document">
 6 |     {{ sidebar() }}
 7 |     {%- block document %}
 8 |       <div class="documentwrapper">
 9 |       {%- if render_sidebar %}
10 |         <div class="bodywrapper">
11 |       {%- endif %}
12 | 
13 |           {%- block relbar_top %}
14 |             {%- if theme_show_relbar_top|tobool %}
15 |               <div class="related top">
16 |                 &nbsp;
17 |                 {{- rellink_markup () }}
18 |               </div>
19 |             {%- endif %}
20 |           {% endblock %}
21 | 
22 |           <div class="body" role="main">
23 |           	<div class="admonition" id="python2-eol"> 
24 |           	 As of January 1, 2020 this library no longer supports Python 2 on the latest released version. 
25 |           	 Library versions released prior to that date will continue to be available. For more information please
26 |           	 visit <a href="https://cloud.google.com/python/docs/python2-sunset/">Python 2 support on Google Cloud</a>.
27 |           	</div>
28 |             {% block body %} {% endblock %}
29 |           </div>
30 | 
31 |           {%- block relbar_bottom %}
32 |             {%- if theme_show_relbar_bottom|tobool %}
33 |               <div class="related bottom">
34 |                 &nbsp;
35 |                 {{- rellink_markup () }}
36 |               </div>
37 |             {%- endif %}
38 |           {% endblock %}
39 | 
40 |       {%- if render_sidebar %}
41 |         </div>
42 |       {%- endif %}
43 |       </div>
44 |     {%- endblock %}
45 |     <div class="clearer"></div>
46 |   </div>
47 | {%- else %}
48 | {{ super() }}
49 | {%- endif %}
50 | {%- endblock %}
51 | 


--------------------------------------------------------------------------------
/.kokoro/test-samples.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | # Copyright 2024 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     https://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | 
16 | # The default test runner for samples.
17 | #
18 | # For periodic builds, we rewinds the repo to the latest release, and
19 | # run test-samples-impl.sh.
20 | 
21 | # `-e` enables the script to automatically fail when a command fails
22 | # `-o pipefail` sets the exit code to the rightmost comment to exit with a non-zero
23 | set -eo pipefail
24 | # Enables `**` to include files nested inside sub-folders
25 | shopt -s globstar
26 | 
27 | # Run periodic samples tests at latest release
28 | if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"periodic"* ]]; then
29 |     # preserving the test runner implementation.
30 |     cp .kokoro/test-samples-impl.sh "${TMPDIR}/test-samples-impl.sh"
31 |     echo "--- IMPORTANT IMPORTANT IMPORTANT ---"
32 |     echo "Now we rewind the repo back to the latest release..."
33 |     LATEST_RELEASE=$(git describe --abbrev=0 --tags)
34 |     git checkout $LATEST_RELEASE
35 |     echo "The current head is: "
36 |     echo $(git rev-parse --verify HEAD)
37 |     echo "--- IMPORTANT IMPORTANT IMPORTANT ---"
38 |     # move back the test runner implementation if there's no file.
39 |     if [ ! -f .kokoro/test-samples-impl.sh ]; then
40 | 	cp "${TMPDIR}/test-samples-impl.sh" .kokoro/test-samples-impl.sh
41 |     fi
42 | fi
43 | 
44 | exec .kokoro/test-samples-impl.sh
45 | 


--------------------------------------------------------------------------------
/google/cloud/datastore/_gapic.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2017 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #     http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | """Helpers for making API requests via gapic / gRPC."""
16 | 
17 | from grpc import insecure_channel
18 | from urllib.parse import urlparse
19 | 
20 | from google.cloud._helpers import make_secure_channel
21 | from google.cloud._http import DEFAULT_USER_AGENT
22 | from google.cloud.datastore_v1.services.datastore import client as datastore_client
23 | from google.cloud.datastore_v1.services.datastore.transports import grpc
24 | 
25 | 
26 | def make_datastore_api(client):
27 |     """Create an instance of the GAPIC Datastore API.
28 | 
29 |     :type client: :class:`~google.cloud.datastore.client.Client`
30 |     :param client: The client that holds configuration details.
31 | 
32 |     :rtype: :class:`.datastore.v1.datastore_client.DatastoreClient`
33 |     :returns: A datastore API instance with the proper credentials.
34 |     """
35 |     parse_result = urlparse(client._base_url)
36 |     host = parse_result.netloc
37 |     if parse_result.scheme == "https":
38 |         channel = make_secure_channel(client._credentials, DEFAULT_USER_AGENT, host)
39 |     else:
40 |         channel = insecure_channel(host)
41 | 
42 |     transport = grpc.DatastoreGrpcTransport(channel=channel)
43 |     return datastore_client.DatastoreClient(
44 |         transport=transport, client_info=client._client_info
45 |     )
46 | 


--------------------------------------------------------------------------------
/.trampolinerc:
--------------------------------------------------------------------------------
 1 | # Copyright 2024 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #      http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | # Add required env vars here.
16 | required_envvars+=(
17 | )
18 | 
19 | # Add env vars which are passed down into the container here.
20 | pass_down_envvars+=(
21 |     "NOX_SESSION"
22 |     ###############
23 |     # Docs builds
24 |     ###############
25 |     "STAGING_BUCKET"
26 |     "V2_STAGING_BUCKET"
27 |     ##################
28 |     # Samples builds
29 |     ##################
30 |     "INSTALL_LIBRARY_FROM_SOURCE"
31 |     "RUN_TESTS_SESSION"
32 |     "BUILD_SPECIFIC_GCLOUD_PROJECT"
33 |     # Target directories.
34 |     "RUN_TESTS_DIRS"
35 |     # The nox session to run.
36 |     "RUN_TESTS_SESSION"
37 | )
38 | 
39 | # Prevent unintentional override on the default image.
40 | if [[ "${TRAMPOLINE_IMAGE_UPLOAD:-false}" == "true" ]] && \
41 |    [[ -z "${TRAMPOLINE_IMAGE:-}" ]]; then
42 |    echo "Please set TRAMPOLINE_IMAGE if you want to upload the Docker image."
43 |    exit 1
44 | fi
45 | 
46 | # Define the default value if it makes sense.
47 | if [[ -z "${TRAMPOLINE_IMAGE_UPLOAD:-}" ]]; then
48 |     TRAMPOLINE_IMAGE_UPLOAD=""
49 | fi
50 | 
51 | if [[ -z "${TRAMPOLINE_IMAGE:-}" ]]; then
52 |     TRAMPOLINE_IMAGE=""
53 | fi
54 | 
55 | if [[ -z "${TRAMPOLINE_DOCKERFILE:-}" ]]; then
56 |     TRAMPOLINE_DOCKERFILE=""
57 | fi
58 | 
59 | if [[ -z "${TRAMPOLINE_BUILD_FILE:-}" ]]; then
60 |     TRAMPOLINE_BUILD_FILE=""
61 | fi
62 | 


--------------------------------------------------------------------------------
/scripts/decrypt-secrets.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | # Copyright 2024 Google LLC All rights reserved.
 4 | #
 5 | # Licensed under the Apache License, Version 2.0 (the "License");
 6 | # you may not use this file except in compliance with the License.
 7 | # You may obtain a copy of the License at
 8 | #
 9 | #     http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | 
17 | DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
18 | ROOT=$( dirname "$DIR" )
19 | 
20 | # Work from the project root.
21 | cd $ROOT
22 | 
23 | # Prevent it from overriding files.
24 | # We recommend that sample authors use their own service account files and cloud project.
25 | # In that case, they are supposed to prepare these files by themselves.
26 | if [[ -f "testing/test-env.sh" ]] || \
27 |        [[ -f "testing/service-account.json" ]] || \
28 |        [[ -f "testing/client-secrets.json" ]]; then
29 |     echo "One or more target files exist, aborting."
30 |     exit 1
31 | fi
32 | 
33 | # Use SECRET_MANAGER_PROJECT if set, fallback to cloud-devrel-kokoro-resources.
34 | PROJECT_ID="${SECRET_MANAGER_PROJECT:-cloud-devrel-kokoro-resources}"
35 | 
36 | gcloud secrets versions access latest --secret="python-docs-samples-test-env" \
37 |        --project="${PROJECT_ID}" \
38 |        > testing/test-env.sh
39 | gcloud secrets versions access latest \
40 |        --secret="python-docs-samples-service-account" \
41 |        --project="${PROJECT_ID}" \
42 |        > testing/service-account.json
43 | gcloud secrets versions access latest \
44 |        --secret="python-docs-samples-client-secrets" \
45 |        --project="${PROJECT_ID}" \
46 |        > testing/client-secrets.json
47 | 


--------------------------------------------------------------------------------
/samples/snippets/noxfile_config.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2022 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #      http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | # Default TEST_CONFIG_OVERRIDE for python repos.
16 | 
17 | # You can copy this file into your directory, then it will be imported from
18 | # the noxfile.py.
19 | 
20 | # The source of truth:
21 | # https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/noxfile_config.py
22 | 
23 | TEST_CONFIG_OVERRIDE = {
24 |     # You can opt out from the test for specific Python versions.
25 |     "ignored_versions": [],
26 |     # Old samples are opted out of enforcing Python type hints
27 |     # All new samples should feature them
28 |     "enforce_type_hints": False,
29 |     # An envvar key for determining the project id to use. Change it
30 |     # to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a
31 |     # build specific Cloud project. You can also use your own string
32 |     # to use your own Cloud project.
33 |     "gcloud_project_env": "BUILD_SPECIFIC_GCLOUD_PROJECT",
34 |     # 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT',
35 |     # If you need to use a specific version of pip,
36 |     # change pip_version_override to the string representation
37 |     # of the version number, for example, "20.2.4"
38 |     "pip_version_override": None,
39 |     # A dictionary you want to inject into your test. Don't put any
40 |     # secrets here. These values will override predefined values.
41 |     "envs": {},
42 | }
43 | 


--------------------------------------------------------------------------------
/samples/snippets/schedule-export/noxfile_config.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2022 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #      http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | # Default TEST_CONFIG_OVERRIDE for python repos.
16 | 
17 | # You can copy this file into your directory, then it will be imported from
18 | # the noxfile.py.
19 | 
20 | # The source of truth:
21 | # https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/noxfile_config.py
22 | 
23 | TEST_CONFIG_OVERRIDE = {
24 |     # You can opt out from the test for specific Python versions.
25 |     "ignored_versions": [],
26 |     # Old samples are opted out of enforcing Python type hints
27 |     # All new samples should feature them
28 |     "enforce_type_hints": False,
29 |     # An envvar key for determining the project id to use. Change it
30 |     # to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a
31 |     # build specific Cloud project. You can also use your own string
32 |     # to use your own Cloud project.
33 |     "gcloud_project_env": "BUILD_SPECIFIC_GCLOUD_PROJECT",
34 |     # 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT',
35 |     # If you need to use a specific version of pip,
36 |     # change pip_version_override to the string representation
37 |     # of the version number, for example, "20.2.4"
38 |     "pip_version_override": None,
39 |     # A dictionary you want to inject into your test. Don't put any
40 |     # secrets here. These values will override predefined values.
41 |     "envs": {},
42 | }
43 | 


--------------------------------------------------------------------------------
/.kokoro/build.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | # Copyright 2024 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     https://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | 
16 | set -eo pipefail
17 | 
18 | CURRENT_DIR=$(dirname "${BASH_SOURCE[0]}")
19 | 
20 | if [[ -z "${PROJECT_ROOT:-}" ]]; then
21 |   PROJECT_ROOT=$(realpath "${CURRENT_DIR}/..")
22 | fi
23 | 
24 | pushd "${PROJECT_ROOT}"
25 | 
26 | # Disable buffering, so that the logs stream through.
27 | export PYTHONUNBUFFERED=1
28 | 
29 | # Debug: show build environment
30 | env | grep KOKORO
31 | 
32 | # Setup service account credentials.
33 | if [[ -f "${KOKORO_GFILE_DIR}/service-account.json" ]]
34 | then
35 |   export GOOGLE_APPLICATION_CREDENTIALS=${KOKORO_GFILE_DIR}/service-account.json
36 | fi
37 | 
38 | # Setup project id.
39 | if [[ -f "${KOKORO_GFILE_DIR}/project-id.json" ]]
40 | then
41 |   export PROJECT_ID=$(cat "${KOKORO_GFILE_DIR}/project-id.json")
42 | fi
43 | 
44 | # If this is a continuous build, send the test log to the FlakyBot.
45 | # See https://github.com/googleapis/repo-automation-bots/tree/main/packages/flakybot.
46 | if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"continuous"* ]]; then
47 |   cleanup() {
48 |     chmod +x $KOKORO_GFILE_DIR/linux_amd64/flakybot
49 |     $KOKORO_GFILE_DIR/linux_amd64/flakybot
50 |   }
51 |   trap cleanup EXIT HUP
52 | fi
53 | 
54 | # If NOX_SESSION is set, it only runs the specified session,
55 | # otherwise run all the sessions.
56 | if [[ -n "${NOX_SESSION:-}" ]]; then
57 |   python3 -m nox -s ${NOX_SESSION:-}
58 | else
59 |   python3 -m nox
60 | fi
61 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_admin_v1/types/__init__.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | from .datastore_admin import (
17 |     CommonMetadata,
18 |     CreateIndexRequest,
19 |     DatastoreFirestoreMigrationMetadata,
20 |     DeleteIndexRequest,
21 |     EntityFilter,
22 |     ExportEntitiesMetadata,
23 |     ExportEntitiesRequest,
24 |     ExportEntitiesResponse,
25 |     GetIndexRequest,
26 |     ImportEntitiesMetadata,
27 |     ImportEntitiesRequest,
28 |     IndexOperationMetadata,
29 |     ListIndexesRequest,
30 |     ListIndexesResponse,
31 |     Progress,
32 |     OperationType,
33 | )
34 | from .index import (
35 |     Index,
36 | )
37 | from .migration import (
38 |     MigrationProgressEvent,
39 |     MigrationStateEvent,
40 |     MigrationState,
41 |     MigrationStep,
42 | )
43 | 
44 | __all__ = (
45 |     "CommonMetadata",
46 |     "CreateIndexRequest",
47 |     "DatastoreFirestoreMigrationMetadata",
48 |     "DeleteIndexRequest",
49 |     "EntityFilter",
50 |     "ExportEntitiesMetadata",
51 |     "ExportEntitiesRequest",
52 |     "ExportEntitiesResponse",
53 |     "GetIndexRequest",
54 |     "ImportEntitiesMetadata",
55 |     "ImportEntitiesRequest",
56 |     "IndexOperationMetadata",
57 |     "ListIndexesRequest",
58 |     "ListIndexesResponse",
59 |     "Progress",
60 |     "OperationType",
61 |     "Index",
62 |     "MigrationProgressEvent",
63 |     "MigrationStateEvent",
64 |     "MigrationState",
65 |     "MigrationStep",
66 | )
67 | 


--------------------------------------------------------------------------------
/scripts/readme-gen/readme_gen.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python
 2 | 
 3 | # Copyright 2024 Google LLC
 4 | #
 5 | # Licensed under the Apache License, Version 2.0 (the "License");
 6 | # you may not use this file except in compliance with the License.
 7 | # You may obtain a copy of the License at
 8 | #
 9 | #      http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | 
17 | """Generates READMEs using configuration defined in yaml."""
18 | 
19 | import argparse
20 | import io
21 | import os
22 | import subprocess
23 | 
24 | import jinja2
25 | import yaml
26 | 
27 | 
28 | jinja_env = jinja2.Environment(
29 |     trim_blocks=True,
30 |     loader=jinja2.FileSystemLoader(
31 |         os.path.abspath(os.path.join(os.path.dirname(__file__), "templates"))
32 |     ),
33 |     autoescape=True,
34 | )
35 | 
36 | README_TMPL = jinja_env.get_template("README.tmpl.rst")
37 | 
38 | 
39 | def get_help(file):
40 |     return subprocess.check_output(["python", file, "--help"]).decode()
41 | 
42 | 
43 | def main():
44 |     parser = argparse.ArgumentParser()
45 |     parser.add_argument("source")
46 |     parser.add_argument("--destination", default="README.rst")
47 | 
48 |     args = parser.parse_args()
49 | 
50 |     source = os.path.abspath(args.source)
51 |     root = os.path.dirname(source)
52 |     destination = os.path.join(root, args.destination)
53 | 
54 |     jinja_env.globals["get_help"] = get_help
55 | 
56 |     with io.open(source, "r") as f:
57 |         config = yaml.load(f)
58 | 
59 |     # This allows get_help to execute in the right directory.
60 |     os.chdir(root)
61 | 
62 |     output = README_TMPL.render(config)
63 | 
64 |     with io.open(destination, "w") as f:
65 |         f.write(output)
66 | 
67 | 
68 | if __name__ == "__main__":
69 |     main()
70 | 


--------------------------------------------------------------------------------
/tests/system/conftest.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2021 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #     http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | import pytest
16 | import requests
17 | 
18 | from google.cloud import datastore
19 | from . import _helpers
20 | 
21 | 
22 | @pytest.fixture(scope="session")
23 | def in_emulator():
24 |     return _helpers.EMULATOR_DATASET is not None
25 | 
26 | 
27 | @pytest.fixture(scope="session")
28 | def database_id(request):
29 |     return request.param
30 | 
31 | 
32 | @pytest.fixture(scope="session")
33 | def test_namespace():
34 |     return _helpers.unique_id("ns")
35 | 
36 | 
37 | @pytest.fixture(scope="session")
38 | def datastore_client(test_namespace, database_id):
39 |     if _helpers.TEST_DATABASE is not None:
40 |         database_id = _helpers.TEST_DATABASE
41 |     if _helpers.EMULATOR_DATASET is not None:
42 |         http = requests.Session()  # Un-authorized.
43 |         client = datastore.Client(
44 |             project=_helpers.EMULATOR_DATASET,
45 |             database=database_id,
46 |             namespace=test_namespace,
47 |             _http=http,
48 |         )
49 |     else:
50 |         client = datastore.Client(database=database_id, namespace=test_namespace)
51 | 
52 |     assert client.database == database_id
53 |     return client
54 | 
55 | 
56 | @pytest.fixture(scope="function")
57 | def entities_to_delete(datastore_client):
58 |     entities_to_delete = []
59 | 
60 |     yield entities_to_delete
61 | 
62 |     with datastore_client.transaction():
63 |         datastore_client.delete_multi(entities_to_delete)
64 | 


--------------------------------------------------------------------------------
/.github/workflows/unittest.yml:
--------------------------------------------------------------------------------
 1 | on:
 2 |   pull_request:
 3 |     branches:
 4 |       - main
 5 | name: unittest
 6 | jobs:
 7 |   unit:
 8 |     # TODO(https://github.com/googleapis/gapic-generator-python/issues/2303): use `ubuntu-latest` once this bug is fixed.
 9 |     # Use ubuntu-22.04 until Python 3.7 is removed from the test matrix
10 |     # https://docs.github.com/en/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners#standard-github-hosted-runners-for-public-repositories
11 |     runs-on: ubuntu-22.04
12 |     strategy:
13 |       matrix:
14 |         python: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12', '3.13', '3.14']
15 |     steps:
16 |     - name: Checkout
17 |       uses: actions/checkout@v4
18 |     - name: Setup Python
19 |       uses: actions/setup-python@v5
20 |       with:
21 |         python-version: ${{ matrix.python }}
22 |     - name: Install nox
23 |       run: |
24 |         python -m pip install --upgrade setuptools pip wheel
25 |         python -m pip install nox
26 |     - name: Run unit tests
27 |       env:
28 |         COVERAGE_FILE: .coverage-${{ matrix.python }}
29 |       run: |
30 |         nox -s unit-${{ matrix.python }}
31 |     - name: Upload coverage results
32 |       uses: actions/upload-artifact@v4
33 |       with:
34 |         name: coverage-artifact-${{ matrix.python }}
35 |         path: .coverage-${{ matrix.python }}
36 |         include-hidden-files: true
37 | 
38 |   cover:
39 |     runs-on: ubuntu-latest
40 |     needs:
41 |         - unit
42 |     steps:
43 |     - name: Checkout
44 |       uses: actions/checkout@v4
45 |     - name: Setup Python
46 |       uses: actions/setup-python@v5
47 |       with:
48 |         python-version: "3.14"
49 |     - name: Install coverage
50 |       run: |
51 |         python -m pip install --upgrade setuptools pip wheel
52 |         python -m pip install coverage
53 |     - name: Download coverage results
54 |       uses: actions/download-artifact@v4
55 |       with:
56 |         path: .coverage-results/
57 |     - name: Report coverage results
58 |       run: |
59 |         find .coverage-results -type f -name '*.zip' -exec unzip {} \;
60 |         coverage combine .coverage-results/**/.coverage*
61 |         coverage report --show-missing --fail-under=100
62 | 


--------------------------------------------------------------------------------
/samples/snippets/schedule-export/main.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2021 Google LLC All Rights Reserved.
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #     http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | import base64
16 | import json
17 | import os
18 | 
19 | from google.cloud import datastore_admin_v1
20 | 
21 | project_id = os.environ.get("GCP_PROJECT")
22 | client = datastore_admin_v1.DatastoreAdminClient()
23 | 
24 | 
25 | def datastore_export(event, context):
26 |     """Triggers a Datastore export from a Cloud Scheduler job.
27 | 
28 |     Args:
29 |         event (dict): event[data] must contain a json object encoded in
30 |             base-64. Cloud Scheduler encodes payloads in base-64 by default.
31 |             Object must include a 'bucket' value and can include 'kinds'
32 |             and 'namespaceIds' values.
33 |         context (google.cloud.functions.Context): The Cloud Functions event
34 |             metadata.
35 |     """
36 |     if "data" in event:
37 |         # Triggered via Cloud Scheduler, decode the inner data field of the json payload.
38 |         json_data = json.loads(base64.b64decode(event["data"]).decode("utf-8"))
39 |     else:
40 |         # Otherwise, for instance if triggered via the Cloud Console on a Cloud Function, the event is the data.
41 |         json_data = event
42 | 
43 |     bucket = json_data["bucket"]
44 |     entity_filter = datastore_admin_v1.EntityFilter()
45 | 
46 |     if "kinds" in json_data:
47 |         entity_filter.kinds = json_data["kinds"]
48 | 
49 |     if "namespaceIds" in json_data:
50 |         entity_filter.namespace_ids = json_data["namespaceIds"]
51 | 
52 |     export_request = datastore_admin_v1.ExportEntitiesRequest(
53 |         project_id=project_id, output_url_prefix=bucket, entity_filter=entity_filter
54 |     )
55 |     operation = client.export_entities(request=export_request)
56 |     response = operation.result()
57 |     print(response)
58 | 


--------------------------------------------------------------------------------
/librarian.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2018 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #     http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | """This script is used to synthesize generated parts of this library."""
16 | from pathlib import Path
17 | from typing import List, Optional
18 | 
19 | import synthtool as s
20 | from synthtool import gcp
21 | from synthtool.languages import python
22 | 
23 | common = gcp.CommonTemplates()
24 | 
25 | # This library ships clients for two different APIs,
26 | # Datastore and Datastore Admin
27 | datastore_default_version = "v1"
28 | datastore_admin_default_version = "v1"
29 | 
30 | for library in s.get_staging_dirs(datastore_default_version):
31 |     s.move(library / f"google/cloud/datastore_{library.name}")
32 |     s.move(library / "tests/")
33 |     s.move(library / "scripts")
34 | 
35 | for library in s.get_staging_dirs(datastore_admin_default_version):
36 | 
37 |     s.move(library / f"google/cloud/datastore_admin")
38 |     s.move(library / f"google/cloud/datastore_admin_{library.name}")
39 |     s.move(library / "tests")
40 |     s.move(library / "scripts")
41 | 
42 | s.remove_staging_dirs()
43 | 
44 | # ----------------------------------------------------------------------------
45 | # Add templated files
46 | # ----------------------------------------------------------------------------
47 | templated_files = common.py_library(
48 |     microgenerator=True,
49 |     split_system_tests=True,
50 |     # six required by (but not installed by) google-cloud-core < v2.0.0
51 |     unit_test_external_dependencies=["six"],
52 |     system_test_external_dependencies=["six"],
53 |     cov_level=100,
54 |     unit_test_python_versions=["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"],
55 |     default_python_version="3.14",
56 |     system_test_python_versions=["3.14"],
57 | )
58 | s.move(
59 |     templated_files,
60 |     excludes=["docs/multiprocessing.rst", ".coveragerc", ".github/**", ".kokoro/**"],
61 | )
62 | 
63 | python.py_samples(skip_readmes=True)
64 | 
65 | s.shell.run(["nox", "-s", "blacken"], hide_output=False)
66 | 


--------------------------------------------------------------------------------
/.librarian/generator-input/librarian.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2018 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #     http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | """This script is used to synthesize generated parts of this library."""
16 | from pathlib import Path
17 | from typing import List, Optional
18 | 
19 | import synthtool as s
20 | from synthtool import gcp
21 | from synthtool.languages import python
22 | 
23 | common = gcp.CommonTemplates()
24 | 
25 | # This library ships clients for two different APIs,
26 | # Datastore and Datastore Admin
27 | datastore_default_version = "v1"
28 | datastore_admin_default_version = "v1"
29 | 
30 | for library in s.get_staging_dirs(datastore_default_version):
31 |     s.move(library / f"google/cloud/datastore_{library.name}")
32 |     s.move(library / "tests/")
33 |     s.move(library / "scripts")
34 | 
35 | for library in s.get_staging_dirs(datastore_admin_default_version):
36 | 
37 |     s.move(library / f"google/cloud/datastore_admin")
38 |     s.move(library / f"google/cloud/datastore_admin_{library.name}")
39 |     s.move(library / "tests")
40 |     s.move(library / "scripts")
41 | 
42 | s.remove_staging_dirs()
43 | 
44 | # ----------------------------------------------------------------------------
45 | # Add templated files
46 | # ----------------------------------------------------------------------------
47 | templated_files = common.py_library(
48 |     microgenerator=True,
49 |     split_system_tests=True,
50 |     # six required by (but not installed by) google-cloud-core < v2.0.0
51 |     unit_test_external_dependencies=["six"],
52 |     system_test_external_dependencies=["six"],
53 |     cov_level=100,
54 |     unit_test_python_versions=["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"],
55 |     default_python_version="3.14",
56 |     system_test_python_versions=["3.14"],
57 | )
58 | s.move(
59 |     templated_files,
60 |     excludes=["docs/multiprocessing.rst", ".coveragerc", ".github/**", ".kokoro/**"],
61 | )
62 | 
63 | python.py_samples(skip_readmes=True)
64 | 
65 | s.shell.run(["nox", "-s", "blacken"], hide_output=False)
66 | 


--------------------------------------------------------------------------------
/tests/system/test_allocate_reserve_ids.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2011 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #     http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | import pytest
16 | import warnings
17 | 
18 | from . import _helpers
19 | 
20 | 
21 | @pytest.mark.parametrize("database_id", [None, _helpers.TEST_DATABASE], indirect=True)
22 | def test_client_allocate_ids(datastore_client, database_id):
23 |     num_ids = 10
24 |     allocated_keys = datastore_client.allocate_ids(
25 |         datastore_client.key("Kind"),
26 |         num_ids,
27 |     )
28 |     assert len(allocated_keys) == num_ids
29 | 
30 |     unique_ids = set()
31 |     for key in allocated_keys:
32 |         unique_ids.add(key.id)
33 |         assert key.name is None
34 |         assert key.id is not None
35 | 
36 |     assert len(unique_ids) == num_ids
37 | 
38 | 
39 | @pytest.mark.parametrize("database_id", [None, _helpers.TEST_DATABASE], indirect=True)
40 | def test_client_reserve_ids_sequential(datastore_client, database_id):
41 |     num_ids = 10
42 |     key = datastore_client.key("Kind", 1234)
43 | 
44 |     # Smoke test to make sure it doesn't blow up. No return value or
45 |     # verifiable side effect to verify.
46 |     datastore_client.reserve_ids_sequential(key, num_ids)
47 | 
48 | 
49 | @pytest.mark.parametrize("database_id", [None, _helpers.TEST_DATABASE], indirect=True)
50 | def test_client_reserve_ids_deprecated(datastore_client, database_id):
51 |     num_ids = 10
52 |     key = datastore_client.key("Kind", 1234)
53 | 
54 |     with warnings.catch_warnings(record=True) as warned:
55 |         datastore_client.reserve_ids(key, num_ids)
56 | 
57 |     assert len(warned) == 1
58 |     assert warned[0].category is DeprecationWarning
59 |     assert "reserve_ids_sequential" in str(warned[0].message)
60 | 
61 | 
62 | @pytest.mark.parametrize("database_id", [None, _helpers.TEST_DATABASE], indirect=True)
63 | def test_client_reserve_ids_multi(datastore_client, database_id):
64 |     key1 = datastore_client.key("Kind", 1234)
65 |     key2 = datastore_client.key("Kind", 1235)
66 | 
67 |     # Smoke test to make sure it doesn't blow up. No return value or
68 |     # verifiable side effect to verify.
69 |     datastore_client.reserve_ids_multi([key1, key2])
70 | 


--------------------------------------------------------------------------------
/samples/snippets/schedule-export/schedule_export_test.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2019 Google LLC All Rights Reserved.
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #     http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | import base64
16 | from unittest.mock import Mock
17 | 
18 | import main
19 | 
20 | mock_context = Mock()
21 | mock_context.event_id = "617187464135194"
22 | mock_context.timestamp = "2020-04-15T22:09:03.761Z"
23 | 
24 | 
25 | def test_datastore_export(capsys):
26 |     # Test an export without an entity filter
27 |     bucket = "gs://my-bucket"
28 |     json_string = '{{ "bucket": "{bucket}" }}'.format(bucket=bucket)
29 | 
30 |     # Encode data like Cloud Scheduler
31 |     data = bytes(json_string, "utf-8")
32 |     data_encoded = base64.b64encode(data)
33 |     event = {"data": data_encoded}
34 | 
35 |     # Mock the Datastore service
36 |     mockDatastore = Mock()
37 |     main.client = mockDatastore
38 | 
39 |     # Call tested function
40 |     main.datastore_export(event, mock_context)
41 |     out, err = capsys.readouterr()
42 |     export_args = mockDatastore.export_entities.call_args[1]
43 |     # Assert request includes test values
44 |     assert export_args["request"].output_url_prefix == bucket
45 | 
46 | 
47 | def test_datastore_export_entity_filter(capsys):
48 |     # Test an export with an entity filter
49 |     bucket = "gs://my-bucket"
50 |     kinds = "Users,Tasks"
51 |     namespaceIds = "Customer831,Customer157"
52 |     json_string = '{{ "bucket": "{bucket}", "kinds": "{kinds}", "namespaceIds": "{namespaceIds}" }}'.format(
53 |         bucket=bucket, kinds=kinds, namespaceIds=namespaceIds
54 |     )
55 | 
56 |     # Encode data like Cloud Scheduler
57 |     data = bytes(json_string, "utf-8")
58 |     data_encoded = base64.b64encode(data)
59 |     event = {"data": data_encoded}
60 | 
61 |     # Mock the Datastore service
62 |     mockDatastore = Mock()
63 |     main.client = mockDatastore
64 | 
65 |     # Call tested function
66 |     main.datastore_export(event, mock_context)
67 |     out, err = capsys.readouterr()
68 |     export_args = mockDatastore.export_entities.call_args[1]
69 |     # Assert request includes test values
70 | 
71 |     assert export_args["request"].output_url_prefix == bucket
72 |     assert export_args["request"].entity_filter.kinds == kinds
73 |     assert export_args["request"].entity_filter.namespace_ids == namespaceIds
74 | 


--------------------------------------------------------------------------------
/scripts/readme-gen/templates/README.tmpl.rst:
--------------------------------------------------------------------------------
 1 | {# The following line is a lie. BUT! Once jinja2 is done with it, it will
 2 |     become truth! #}
 3 | .. This file is automatically generated. Do not edit this file directly.
 4 | 
 5 | {{product.name}} Python Samples
 6 | ===============================================================================
 7 | 
 8 | .. image:: https://gstatic.com/cloudssh/images/open-btn.png
 9 |    :target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor={{folder}}/README.rst
10 | 
11 | 
12 | This directory contains samples for {{product.name}}. {{product.description}}
13 | 
14 | {{description}}
15 | 
16 | .. _{{product.name}}: {{product.url}}
17 | 
18 | {% if required_api_url %}
19 | To run the sample, you need to enable the API at: {{required_api_url}}
20 | {% endif %}
21 | 
22 | {% if required_role %}
23 | To run the sample, you need to have `{{required_role}}` role.
24 | {% endif %}
25 | 
26 | {{other_required_steps}}
27 | 
28 | {% if setup %}
29 | Setup
30 | -------------------------------------------------------------------------------
31 | 
32 | {% for section in setup %}
33 | 
34 | {% include section + '.tmpl.rst' %}
35 | 
36 | {% endfor %}
37 | {% endif %}
38 | 
39 | {% if samples %}
40 | Samples
41 | -------------------------------------------------------------------------------
42 | 
43 | {% for sample in samples %}
44 | {{sample.name}}
45 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
46 | 
47 | {% if not sample.hide_cloudshell_button %}
48 | .. image:: https://gstatic.com/cloudssh/images/open-btn.png
49 |    :target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor={{folder}}/{{sample.file}},{{folder}}/README.rst
50 | {% endif %}
51 | 
52 | 
53 | {{sample.description}}
54 | 
55 | To run this sample:
56 | 
57 | .. code-block:: bash
58 | 
59 |     $ python {{sample.file}}
60 | {% if sample.show_help %}
61 | 
62 |     {{get_help(sample.file)|indent}}
63 | {% endif %}
64 | 
65 | 
66 | {% endfor %}
67 | {% endif %}
68 | 
69 | {% if cloud_client_library %}
70 | 
71 | The client library
72 | -------------------------------------------------------------------------------
73 | 
74 | This sample uses the `Google Cloud Client Library for Python`_.
75 | You can read the documentation for more details on API usage and use GitHub
76 | to `browse the source`_ and  `report issues`_.
77 | 
78 | .. _Google Cloud Client Library for Python:
79 |     https://googlecloudplatform.github.io/google-cloud-python/
80 | .. _browse the source:
81 |     https://github.com/GoogleCloudPlatform/google-cloud-python
82 | .. _report issues:
83 |     https://github.com/GoogleCloudPlatform/google-cloud-python/issues
84 | 
85 | {% endif %}
86 | 
87 | .. _Google Cloud SDK: https://cloud.google.com/sdk/


--------------------------------------------------------------------------------
/google/cloud/datastore/__init__.py:
--------------------------------------------------------------------------------
 1 | # Copyright 2014 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #     http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | """Shortcut methods for getting set up with Google Cloud Datastore.
16 | 
17 | You'll typically use these to get started with the API:
18 | 
19 | .. doctest:: constructors
20 | 
21 |    >>> from google.cloud import datastore
22 |    >>>
23 |    >>> client = datastore.Client()
24 |    >>> key = client.key('EntityKind', 1234)
25 |    >>> key
26 |    <Key('EntityKind', 1234), project=...>
27 |    >>> entity = datastore.Entity(key)
28 |    >>> entity['question'] = u'Life, universe?'  # Explicit unicode for text
29 |    >>> entity['answer'] = 42
30 |    >>> entity
31 |    <Entity('EntityKind', 1234) {'question': 'Life, universe?', 'answer': 42}>
32 |    >>> query = client.query(kind='EntityKind')
33 | 
34 | The main concepts with this API are:
35 | 
36 | - :class:`~google.cloud.datastore.client.Client`
37 |   which represents a project (string), database (string), and namespace
38 |   (string) bundled with a connection and has convenience methods for
39 |   constructing objects with that project/database/namespace.
40 | 
41 | - :class:`~google.cloud.datastore.entity.Entity`
42 |   which represents a single entity in the datastore
43 |   (akin to a row in relational database world).
44 | 
45 | - :class:`~google.cloud.datastore.key.Key`
46 |   which represents a pointer to a particular entity in the datastore
47 |   (akin to a unique identifier in relational database world).
48 | 
49 | - :class:`~google.cloud.datastore.query.Query`
50 |   which represents a lookup or search over the rows in the datastore.
51 | 
52 | - :class:`~google.cloud.datastore.transaction.Transaction`
53 |   which represents an all-or-none transaction and enables consistency
54 |   when race conditions may occur.
55 | """
56 | 
57 | 
58 | from google.cloud.datastore.version import __version__
59 | from google.cloud.datastore.batch import Batch
60 | from google.cloud.datastore.client import Client
61 | from google.cloud.datastore.entity import Entity
62 | from google.cloud.datastore.key import Key
63 | from google.cloud.datastore.query import Query
64 | from google.cloud.datastore.query_profile import ExplainOptions
65 | from google.cloud.datastore.transaction import Transaction
66 | 
67 | __all__ = [
68 |     "__version__",
69 |     "Batch",
70 |     "Client",
71 |     "Entity",
72 |     "Key",
73 |     "Query",
74 |     "ExplainOptions",
75 |     "Transaction",
76 | ]
77 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_v1/types/__init__.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | # Copyright 2025 Google LLC
  3 | #
  4 | # Licensed under the Apache License, Version 2.0 (the "License");
  5 | # you may not use this file except in compliance with the License.
  6 | # You may obtain a copy of the License at
  7 | #
  8 | #     http://www.apache.org/licenses/LICENSE-2.0
  9 | #
 10 | # Unless required by applicable law or agreed to in writing, software
 11 | # distributed under the License is distributed on an "AS IS" BASIS,
 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 13 | # See the License for the specific language governing permissions and
 14 | # limitations under the License.
 15 | #
 16 | from .aggregation_result import (
 17 |     AggregationResult,
 18 |     AggregationResultBatch,
 19 | )
 20 | from .datastore import (
 21 |     AllocateIdsRequest,
 22 |     AllocateIdsResponse,
 23 |     BeginTransactionRequest,
 24 |     BeginTransactionResponse,
 25 |     CommitRequest,
 26 |     CommitResponse,
 27 |     LookupRequest,
 28 |     LookupResponse,
 29 |     Mutation,
 30 |     MutationResult,
 31 |     PropertyMask,
 32 |     PropertyTransform,
 33 |     ReadOptions,
 34 |     ReserveIdsRequest,
 35 |     ReserveIdsResponse,
 36 |     RollbackRequest,
 37 |     RollbackResponse,
 38 |     RunAggregationQueryRequest,
 39 |     RunAggregationQueryResponse,
 40 |     RunQueryRequest,
 41 |     RunQueryResponse,
 42 |     TransactionOptions,
 43 | )
 44 | from .entity import (
 45 |     ArrayValue,
 46 |     Entity,
 47 |     Key,
 48 |     PartitionId,
 49 |     Value,
 50 | )
 51 | from .query import (
 52 |     AggregationQuery,
 53 |     CompositeFilter,
 54 |     EntityResult,
 55 |     Filter,
 56 |     FindNearest,
 57 |     GqlQuery,
 58 |     GqlQueryParameter,
 59 |     KindExpression,
 60 |     Projection,
 61 |     PropertyFilter,
 62 |     PropertyOrder,
 63 |     PropertyReference,
 64 |     Query,
 65 |     QueryResultBatch,
 66 | )
 67 | from .query_profile import (
 68 |     ExecutionStats,
 69 |     ExplainMetrics,
 70 |     ExplainOptions,
 71 |     PlanSummary,
 72 | )
 73 | 
 74 | __all__ = (
 75 |     "AggregationResult",
 76 |     "AggregationResultBatch",
 77 |     "AllocateIdsRequest",
 78 |     "AllocateIdsResponse",
 79 |     "BeginTransactionRequest",
 80 |     "BeginTransactionResponse",
 81 |     "CommitRequest",
 82 |     "CommitResponse",
 83 |     "LookupRequest",
 84 |     "LookupResponse",
 85 |     "Mutation",
 86 |     "MutationResult",
 87 |     "PropertyMask",
 88 |     "PropertyTransform",
 89 |     "ReadOptions",
 90 |     "ReserveIdsRequest",
 91 |     "ReserveIdsResponse",
 92 |     "RollbackRequest",
 93 |     "RollbackResponse",
 94 |     "RunAggregationQueryRequest",
 95 |     "RunAggregationQueryResponse",
 96 |     "RunQueryRequest",
 97 |     "RunQueryResponse",
 98 |     "TransactionOptions",
 99 |     "ArrayValue",
100 |     "Entity",
101 |     "Key",
102 |     "PartitionId",
103 |     "Value",
104 |     "AggregationQuery",
105 |     "CompositeFilter",
106 |     "EntityResult",
107 |     "Filter",
108 |     "FindNearest",
109 |     "GqlQuery",
110 |     "GqlQueryParameter",
111 |     "KindExpression",
112 |     "Projection",
113 |     "PropertyFilter",
114 |     "PropertyOrder",
115 |     "PropertyReference",
116 |     "Query",
117 |     "QueryResultBatch",
118 |     "ExecutionStats",
119 |     "ExplainMetrics",
120 |     "ExplainOptions",
121 |     "PlanSummary",
122 | )
123 | 


--------------------------------------------------------------------------------
/google/cloud/datastore/_app_engine_key_pb2.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | 
 3 | # Copyright 2020 Google LLC
 4 | #
 5 | # Licensed under the Apache License, Version 2.0 (the "License");
 6 | # you may not use this file except in compliance with the License.
 7 | # You may obtain a copy of the License at
 8 | #
 9 | #     http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | 
17 | # Generated by the protocol buffer compiler.  DO NOT EDIT!
18 | # source: google/cloud/datastore/_app_engine_key.proto
19 | """Generated protocol buffer code."""
20 | from google.protobuf import descriptor as _descriptor
21 | from google.protobuf import descriptor_pool as _descriptor_pool
22 | from google.protobuf import message as _message
23 | from google.protobuf import reflection as _reflection
24 | from google.protobuf import symbol_database as _symbol_database
25 | 
26 | # @@protoc_insertion_point(imports)
27 | 
28 | _sym_db = _symbol_database.Default()
29 | 
30 | 
31 | DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
32 |     b'\n,google/cloud/datastore/_app_engine_key.proto"V\n\tReference\x12\x0b\n\x03\x61pp\x18\r \x02(\t\x12\x12\n\nname_space\x18\x14 \x01(\t\x12\x13\n\x04path\x18\x0e \x02(\x0b\x32\x05.Path\x12\x13\n\x0b\x64\x61tabase_id\x18\x17 \x01(\t"Y\n\x04Path\x12\x1e\n\x07\x65lement\x18\x01 \x03(\n2\r.Path.Element\x1a\x31\n\x07\x45lement\x12\x0c\n\x04type\x18\x02 \x02(\t\x12\n\n\x02id\x18\x03 \x01(\x03\x12\x0c\n\x04name\x18\x04 \x01(\t'
33 | )
34 | 
35 | 
36 | _REFERENCE = DESCRIPTOR.message_types_by_name["Reference"]
37 | _PATH = DESCRIPTOR.message_types_by_name["Path"]
38 | _PATH_ELEMENT = _PATH.nested_types_by_name["Element"]
39 | Reference = _reflection.GeneratedProtocolMessageType(
40 |     "Reference",
41 |     (_message.Message,),
42 |     {
43 |         "DESCRIPTOR": _REFERENCE,
44 |         "__module__": "google.cloud.datastore._app_engine_key_pb2"
45 |         # @@protoc_insertion_point(class_scope:Reference)
46 |     },
47 | )
48 | _sym_db.RegisterMessage(Reference)
49 | 
50 | Path = _reflection.GeneratedProtocolMessageType(
51 |     "Path",
52 |     (_message.Message,),
53 |     {
54 |         "Element": _reflection.GeneratedProtocolMessageType(
55 |             "Element",
56 |             (_message.Message,),
57 |             {
58 |                 "DESCRIPTOR": _PATH_ELEMENT,
59 |                 "__module__": "google.cloud.datastore._app_engine_key_pb2"
60 |                 # @@protoc_insertion_point(class_scope:Path.Element)
61 |             },
62 |         ),
63 |         "DESCRIPTOR": _PATH,
64 |         "__module__": "google.cloud.datastore._app_engine_key_pb2"
65 |         # @@protoc_insertion_point(class_scope:Path)
66 |     },
67 | )
68 | _sym_db.RegisterMessage(Path)
69 | _sym_db.RegisterMessage(Path.Element)
70 | 
71 | if _descriptor._USE_C_DESCRIPTORS == False:  # pragma: NO COVER
72 |     DESCRIPTOR._options = None
73 |     _REFERENCE._serialized_start = 48
74 |     _REFERENCE._serialized_end = 134
75 |     _PATH._serialized_start = 136
76 |     _PATH._serialized_end = 225
77 |     _PATH_ELEMENT._serialized_start = 176
78 |     _PATH_ELEMENT._serialized_end = 225
79 | # @@protoc_insertion_point(module_scope)
80 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_admin_v1/gapic_metadata.json:
--------------------------------------------------------------------------------
  1 |  {
  2 |   "comment": "This file maps proto services/RPCs to the corresponding library clients/methods",
  3 |   "language": "python",
  4 |   "libraryPackage": "google.cloud.datastore_admin_v1",
  5 |   "protoPackage": "google.datastore.admin.v1",
  6 |   "schema": "1.0",
  7 |   "services": {
  8 |     "DatastoreAdmin": {
  9 |       "clients": {
 10 |         "grpc": {
 11 |           "libraryClient": "DatastoreAdminClient",
 12 |           "rpcs": {
 13 |             "CreateIndex": {
 14 |               "methods": [
 15 |                 "create_index"
 16 |               ]
 17 |             },
 18 |             "DeleteIndex": {
 19 |               "methods": [
 20 |                 "delete_index"
 21 |               ]
 22 |             },
 23 |             "ExportEntities": {
 24 |               "methods": [
 25 |                 "export_entities"
 26 |               ]
 27 |             },
 28 |             "GetIndex": {
 29 |               "methods": [
 30 |                 "get_index"
 31 |               ]
 32 |             },
 33 |             "ImportEntities": {
 34 |               "methods": [
 35 |                 "import_entities"
 36 |               ]
 37 |             },
 38 |             "ListIndexes": {
 39 |               "methods": [
 40 |                 "list_indexes"
 41 |               ]
 42 |             }
 43 |           }
 44 |         },
 45 |         "grpc-async": {
 46 |           "libraryClient": "DatastoreAdminAsyncClient",
 47 |           "rpcs": {
 48 |             "CreateIndex": {
 49 |               "methods": [
 50 |                 "create_index"
 51 |               ]
 52 |             },
 53 |             "DeleteIndex": {
 54 |               "methods": [
 55 |                 "delete_index"
 56 |               ]
 57 |             },
 58 |             "ExportEntities": {
 59 |               "methods": [
 60 |                 "export_entities"
 61 |               ]
 62 |             },
 63 |             "GetIndex": {
 64 |               "methods": [
 65 |                 "get_index"
 66 |               ]
 67 |             },
 68 |             "ImportEntities": {
 69 |               "methods": [
 70 |                 "import_entities"
 71 |               ]
 72 |             },
 73 |             "ListIndexes": {
 74 |               "methods": [
 75 |                 "list_indexes"
 76 |               ]
 77 |             }
 78 |           }
 79 |         },
 80 |         "rest": {
 81 |           "libraryClient": "DatastoreAdminClient",
 82 |           "rpcs": {
 83 |             "CreateIndex": {
 84 |               "methods": [
 85 |                 "create_index"
 86 |               ]
 87 |             },
 88 |             "DeleteIndex": {
 89 |               "methods": [
 90 |                 "delete_index"
 91 |               ]
 92 |             },
 93 |             "ExportEntities": {
 94 |               "methods": [
 95 |                 "export_entities"
 96 |               ]
 97 |             },
 98 |             "GetIndex": {
 99 |               "methods": [
100 |                 "get_index"
101 |               ]
102 |             },
103 |             "ImportEntities": {
104 |               "methods": [
105 |                 "import_entities"
106 |               ]
107 |             },
108 |             "ListIndexes": {
109 |               "methods": [
110 |                 "list_indexes"
111 |               ]
112 |             }
113 |           }
114 |         }
115 |       }
116 |     }
117 |   }
118 | }
119 | 


--------------------------------------------------------------------------------
/tests/doctests.py:
--------------------------------------------------------------------------------
  1 | # Copyright 2014 Google LLC
  2 | #
  3 | # Licensed under the Apache License, Version 2.0 (the "License");
  4 | # you may not use this file except in compliance with the License.
  5 | # You may obtain a copy of the License at
  6 | #
  7 | #     http://www.apache.org/licenses/LICENSE-2.0
  8 | #
  9 | # Unless required by applicable law or agreed to in writing, software
 10 | # distributed under the License is distributed on an "AS IS" BASIS,
 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12 | # See the License for the specific language governing permissions and
 13 | # limitations under the License.
 14 | 
 15 | import os
 16 | import pkgutil
 17 | import tempfile
 18 | import unittest
 19 | 
 20 | from google.cloud import datastore
 21 | 
 22 | 
 23 | SPHINX_CONF = """\
 24 | root_doc = "contents"
 25 | 
 26 | extensions = [
 27 |     'sphinx.ext.autodoc',
 28 |     'sphinx.ext.doctest',
 29 | ]
 30 | """
 31 | 
 32 | SPHINX_SECTION_TEMPLATE = """\
 33 | Section %02d
 34 | ===========
 35 | 
 36 | .. automodule:: google.cloud.%s
 37 |   :members:
 38 |   :private-members:
 39 | 
 40 | """
 41 | 
 42 | 
 43 | class TestDoctest(unittest.TestCase):
 44 |     def _submodules(self):
 45 |         pkg_iter = pkgutil.iter_modules(datastore.__path__)
 46 |         result = []
 47 |         for _, mod_name, ispkg in pkg_iter:
 48 |             self.assertFalse(ispkg)
 49 |             result.append(mod_name)
 50 | 
 51 |         self.assertNotIn("__init__", result)
 52 |         return result
 53 | 
 54 |     @staticmethod
 55 |     def _add_section(index, mod_name, file_obj):
 56 |         mod_part = "datastore"
 57 |         if mod_name != "__init__":
 58 |             mod_part += "." + mod_name
 59 |         content = SPHINX_SECTION_TEMPLATE % (index, mod_part)
 60 |         file_obj.write(content)
 61 | 
 62 |     def _make_temp_docs(self, docs_dir):
 63 |         conf_file = os.path.join(docs_dir, "conf.py")
 64 | 
 65 |         with open(conf_file, "w") as file_obj:
 66 |             file_obj.write(SPHINX_CONF)
 67 | 
 68 |         index_file = os.path.join(docs_dir, "contents.rst")
 69 |         datastore_modules = self._submodules()
 70 | 
 71 |         with open(index_file, "w") as file_obj:
 72 |             self._add_section(0, "__init__", file_obj)
 73 |             for index, datastore_module in enumerate(datastore_modules):
 74 |                 self._add_section(index + 1, datastore_module, file_obj)
 75 | 
 76 |     def test_it(self):
 77 |         from sphinx import application
 78 | 
 79 |         with tempfile.TemporaryDirectory(prefix="datastore-") as docs_dir:
 80 |             self._make_temp_docs(docs_dir)
 81 |             outdir = os.path.join(docs_dir, "doctest", "out")
 82 |             doctreedir = os.path.join(docs_dir, "doctest", "doctrees")
 83 | 
 84 |             app = application.Sphinx(
 85 |                 srcdir=docs_dir,
 86 |                 confdir=docs_dir,
 87 |                 outdir=outdir,
 88 |                 doctreedir=doctreedir,
 89 |                 buildername="doctest",
 90 |                 warningiserror=True,
 91 |                 parallel=1,
 92 |                 verbosity=1,
 93 |             )
 94 | 
 95 |             try:
 96 |                 app.build()
 97 |             except Exception:
 98 |                 outfile = os.path.join(outdir, "output.txt")
 99 |                 with open(outfile, "r") as file_obj:
100 |                     output = file_obj.read()
101 |                 print(f"\n\nDoctest output\n--------------\n\n{output}")
102 |                 raise
103 |             else:
104 |                 self.assertEqual(app.statuscode, 0)
105 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_admin/__init__.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # Copyright 2025 Google LLC
 3 | #
 4 | # Licensed under the Apache License, Version 2.0 (the "License");
 5 | # you may not use this file except in compliance with the License.
 6 | # You may obtain a copy of the License at
 7 | #
 8 | #     http://www.apache.org/licenses/LICENSE-2.0
 9 | #
10 | # Unless required by applicable law or agreed to in writing, software
11 | # distributed under the License is distributed on an "AS IS" BASIS,
12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | # See the License for the specific language governing permissions and
14 | # limitations under the License.
15 | #
16 | from google.cloud.datastore_admin import gapic_version as package_version
17 | 
18 | __version__ = package_version.__version__
19 | 
20 | 
21 | from google.cloud.datastore_admin_v1.services.datastore_admin.client import (
22 |     DatastoreAdminClient,
23 | )
24 | from google.cloud.datastore_admin_v1.services.datastore_admin.async_client import (
25 |     DatastoreAdminAsyncClient,
26 | )
27 | 
28 | from google.cloud.datastore_admin_v1.types.datastore_admin import CommonMetadata
29 | from google.cloud.datastore_admin_v1.types.datastore_admin import CreateIndexRequest
30 | from google.cloud.datastore_admin_v1.types.datastore_admin import (
31 |     DatastoreFirestoreMigrationMetadata,
32 | )
33 | from google.cloud.datastore_admin_v1.types.datastore_admin import DeleteIndexRequest
34 | from google.cloud.datastore_admin_v1.types.datastore_admin import EntityFilter
35 | from google.cloud.datastore_admin_v1.types.datastore_admin import ExportEntitiesMetadata
36 | from google.cloud.datastore_admin_v1.types.datastore_admin import ExportEntitiesRequest
37 | from google.cloud.datastore_admin_v1.types.datastore_admin import ExportEntitiesResponse
38 | from google.cloud.datastore_admin_v1.types.datastore_admin import GetIndexRequest
39 | from google.cloud.datastore_admin_v1.types.datastore_admin import ImportEntitiesMetadata
40 | from google.cloud.datastore_admin_v1.types.datastore_admin import ImportEntitiesRequest
41 | from google.cloud.datastore_admin_v1.types.datastore_admin import IndexOperationMetadata
42 | from google.cloud.datastore_admin_v1.types.datastore_admin import ListIndexesRequest
43 | from google.cloud.datastore_admin_v1.types.datastore_admin import ListIndexesResponse
44 | from google.cloud.datastore_admin_v1.types.datastore_admin import Progress
45 | from google.cloud.datastore_admin_v1.types.datastore_admin import OperationType
46 | from google.cloud.datastore_admin_v1.types.index import Index
47 | from google.cloud.datastore_admin_v1.types.migration import MigrationProgressEvent
48 | from google.cloud.datastore_admin_v1.types.migration import MigrationStateEvent
49 | from google.cloud.datastore_admin_v1.types.migration import MigrationState
50 | from google.cloud.datastore_admin_v1.types.migration import MigrationStep
51 | 
52 | __all__ = (
53 |     "DatastoreAdminClient",
54 |     "DatastoreAdminAsyncClient",
55 |     "CommonMetadata",
56 |     "CreateIndexRequest",
57 |     "DatastoreFirestoreMigrationMetadata",
58 |     "DeleteIndexRequest",
59 |     "EntityFilter",
60 |     "ExportEntitiesMetadata",
61 |     "ExportEntitiesRequest",
62 |     "ExportEntitiesResponse",
63 |     "GetIndexRequest",
64 |     "ImportEntitiesMetadata",
65 |     "ImportEntitiesRequest",
66 |     "IndexOperationMetadata",
67 |     "ListIndexesRequest",
68 |     "ListIndexesResponse",
69 |     "Progress",
70 |     "OperationType",
71 |     "Index",
72 |     "MigrationProgressEvent",
73 |     "MigrationStateEvent",
74 |     "MigrationState",
75 |     "MigrationStep",
76 | )
77 | 


--------------------------------------------------------------------------------
/tests/system/utils/clear_datastore.py:
--------------------------------------------------------------------------------
  1 | # Copyright 2014 Google LLC
  2 | #
  3 | # Licensed under the Apache License, Version 2.0 (the "License");
  4 | # you may not use this file except in compliance with the License.
  5 | # You may obtain a copy of the License at
  6 | #
  7 | #     http://www.apache.org/licenses/LICENSE-2.0
  8 | #
  9 | # Unless required by applicable law or agreed to in writing, software
 10 | # distributed under the License is distributed on an "AS IS" BASIS,
 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12 | # See the License for the specific language governing permissions and
 13 | # limitations under the License.
 14 | 
 15 | """Script to populate datastore with system test data."""
 16 | 
 17 | from __future__ import print_function
 18 | 
 19 | import os
 20 | import sys
 21 | 
 22 | from google.cloud import datastore
 23 | 
 24 | 
 25 | FETCH_MAX = 20
 26 | ALL_KINDS = (
 27 |     "Character",
 28 |     "Company",
 29 |     "Kind",
 30 |     "Person",
 31 |     "Post",
 32 |     "uuid_key",
 33 |     "timestamp_key",
 34 |     "LargeCharacter",
 35 |     "Mergejoin",
 36 | )
 37 | TRANSACTION_MAX_GROUPS = 5
 38 | MAX_DEL_ENTITIES = 500
 39 | 
 40 | 
 41 | def get_system_test_db():
 42 |     return os.getenv("SYSTEM_TESTS_DATABASE") or "system-tests-named-db"
 43 | 
 44 | 
 45 | def print_func(message):
 46 |     if os.getenv("GOOGLE_CLOUD_NO_PRINT") != "true":
 47 |         print(message)
 48 | 
 49 | 
 50 | def get_ancestors(entities):
 51 |     # NOTE: A key will always have at least one path element.
 52 |     key_roots = [entity.key.flat_path[:2] for entity in entities]
 53 |     # Return the unique roots.
 54 |     return list(set(key_roots))
 55 | 
 56 | 
 57 | def delete_chunks(client, results):
 58 |     while results:
 59 |         chunk, results = results[:MAX_DEL_ENTITIES], results[MAX_DEL_ENTITIES:]
 60 |         client.delete_multi([result.key for result in chunk])
 61 | 
 62 | 
 63 | def remove_kind(kind, client):
 64 |     query = client.query(kind=kind)
 65 |     query.keys_only()
 66 |     results = list(query.fetch())
 67 | 
 68 |     if not results:
 69 |         return
 70 | 
 71 |     delete_outside_transaction = False
 72 |     with client.transaction():
 73 |         # Now that we have all results, we seek to delete.
 74 |         print_func("Deleting keys:")
 75 |         print_func(results)
 76 | 
 77 |         ancestors = get_ancestors(results)
 78 |         if len(ancestors) > TRANSACTION_MAX_GROUPS:
 79 |             delete_outside_transaction = True
 80 |         else:
 81 |             delete_chunks(client, results)
 82 | 
 83 |     if delete_outside_transaction:
 84 |         delete_chunks(client, results)
 85 | 
 86 | 
 87 | def remove_all_entities(client):
 88 |     query = client.query()
 89 |     results = list(query.fetch())
 90 |     keys = [entity.key for entity in results]
 91 |     client.delete_multi(keys)
 92 | 
 93 | 
 94 | def run(database):
 95 |     kinds = sys.argv[1:]
 96 | 
 97 |     if len(kinds) == 0:
 98 |         kinds = ALL_KINDS
 99 |     print_func(
100 |         "This command will remove all entities from the database "
101 |         + database
102 |         + " for the following kinds:"
103 |     )
104 |     print_func("\n".join("- " + val for val in kinds))
105 |     response = input("Is this OK [y/n]? ")
106 | 
107 |     if response.lower() == "y":
108 |         for namespace in ["", "LargeCharacterEntity", "MergejoinNamespace"]:
109 |             client = datastore.Client(database=database, namespace=namespace)
110 |             for kind in kinds:
111 |                 remove_kind(kind, client)
112 | 
113 |     else:
114 |         print_func("Doing nothing.")
115 | 
116 | 
117 | def main():
118 |     for database in ["", get_system_test_db()]:
119 |         run(database)
120 | 
121 | 
122 | if __name__ == "__main__":
123 |     main()
124 | 


--------------------------------------------------------------------------------
/.kokoro/test-samples-impl.sh:
--------------------------------------------------------------------------------
  1 | #!/bin/bash
  2 | # Copyright 2024 Google LLC
  3 | #
  4 | # Licensed under the Apache License, Version 2.0 (the "License");
  5 | # you may not use this file except in compliance with the License.
  6 | # You may obtain a copy of the License at
  7 | #
  8 | #     https://www.apache.org/licenses/LICENSE-2.0
  9 | #
 10 | # Unless required by applicable law or agreed to in writing, software
 11 | # distributed under the License is distributed on an "AS IS" BASIS,
 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 13 | # See the License for the specific language governing permissions and
 14 | # limitations under the License.
 15 | 
 16 | 
 17 | # `-e` enables the script to automatically fail when a command fails
 18 | # `-o pipefail` sets the exit code to the rightmost comment to exit with a non-zero
 19 | set -eo pipefail
 20 | # Enables `**` to include files nested inside sub-folders
 21 | shopt -s globstar
 22 | 
 23 | # Exit early if samples don't exist
 24 | if ! find samples -name 'requirements.txt' | grep -q .; then
 25 |   echo "No tests run. './samples/**/requirements.txt' not found"
 26 |   exit 0
 27 | fi
 28 | 
 29 | # Disable buffering, so that the logs stream through.
 30 | export PYTHONUNBUFFERED=1
 31 | 
 32 | # Debug: show build environment
 33 | env | grep KOKORO
 34 | 
 35 | # Install nox
 36 | # `virtualenv==20.26.6` is added for Python 3.7 compatibility
 37 | python3.9 -m pip install --upgrade --quiet nox virtualenv==20.26.6
 38 | 
 39 | # Use secrets acessor service account to get secrets
 40 | if [[ -f "${KOKORO_GFILE_DIR}/secrets_viewer_service_account.json" ]]; then
 41 |     gcloud auth activate-service-account \
 42 | 	   --key-file="${KOKORO_GFILE_DIR}/secrets_viewer_service_account.json" \
 43 | 	   --project="cloud-devrel-kokoro-resources"
 44 | fi
 45 | 
 46 | # This script will create 3 files:
 47 | # - testing/test-env.sh
 48 | # - testing/service-account.json
 49 | # - testing/client-secrets.json
 50 | ./scripts/decrypt-secrets.sh
 51 | 
 52 | source ./testing/test-env.sh
 53 | export GOOGLE_APPLICATION_CREDENTIALS=$(pwd)/testing/service-account.json
 54 | 
 55 | # For cloud-run session, we activate the service account for gcloud sdk.
 56 | gcloud auth activate-service-account \
 57 |        --key-file "${GOOGLE_APPLICATION_CREDENTIALS}"
 58 | 
 59 | export GOOGLE_CLIENT_SECRETS=$(pwd)/testing/client-secrets.json
 60 | 
 61 | echo -e "\n******************** TESTING PROJECTS ********************"
 62 | 
 63 | # Switch to 'fail at end' to allow all tests to complete before exiting.
 64 | set +e
 65 | # Use RTN to return a non-zero value if the test fails.
 66 | RTN=0
 67 | ROOT=$(pwd)
 68 | # Find all requirements.txt in the samples directory (may break on whitespace).
 69 | for file in samples/**/requirements.txt; do
 70 |     cd "$ROOT"
 71 |     # Navigate to the project folder.
 72 |     file=$(dirname "$file")
 73 |     cd "$file"
 74 | 
 75 |     echo "------------------------------------------------------------"
 76 |     echo "- testing $file"
 77 |     echo "------------------------------------------------------------"
 78 | 
 79 |     # Use nox to execute the tests for the project.
 80 |     python3.9 -m nox -s "$RUN_TESTS_SESSION"
 81 |     EXIT=$?
 82 | 
 83 |     # If this is a periodic build, send the test log to the FlakyBot.
 84 |     # See https://github.com/googleapis/repo-automation-bots/tree/main/packages/flakybot.
 85 |     if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"periodic"* ]]; then
 86 |       chmod +x $KOKORO_GFILE_DIR/linux_amd64/flakybot
 87 |       $KOKORO_GFILE_DIR/linux_amd64/flakybot
 88 |     fi
 89 | 
 90 |     if [[ $EXIT -ne 0 ]]; then
 91 |       RTN=1
 92 |       echo -e "\n Testing failed: Nox returned a non-zero exit code. \n"
 93 |     else
 94 |       echo -e "\n Testing completed.\n"
 95 |     fi
 96 | 
 97 | done
 98 | cd "$ROOT"
 99 | 
100 | # Workaround for Kokoro permissions issue: delete secrets
101 | rm testing/{test-env.sh,client-secrets.json,service-account.json}
102 | 
103 | exit "$RTN"
104 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_v1/types/aggregation_result.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | # Copyright 2025 Google LLC
  3 | #
  4 | # Licensed under the Apache License, Version 2.0 (the "License");
  5 | # you may not use this file except in compliance with the License.
  6 | # You may obtain a copy of the License at
  7 | #
  8 | #     http://www.apache.org/licenses/LICENSE-2.0
  9 | #
 10 | # Unless required by applicable law or agreed to in writing, software
 11 | # distributed under the License is distributed on an "AS IS" BASIS,
 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 13 | # See the License for the specific language governing permissions and
 14 | # limitations under the License.
 15 | #
 16 | from __future__ import annotations
 17 | 
 18 | from typing import MutableMapping, MutableSequence
 19 | 
 20 | import proto  # type: ignore
 21 | 
 22 | from google.cloud.datastore_v1.types import entity
 23 | from google.cloud.datastore_v1.types import query
 24 | from google.protobuf import timestamp_pb2  # type: ignore
 25 | 
 26 | 
 27 | __protobuf__ = proto.module(
 28 |     package="google.datastore.v1",
 29 |     manifest={
 30 |         "AggregationResult",
 31 |         "AggregationResultBatch",
 32 |     },
 33 | )
 34 | 
 35 | 
 36 | class AggregationResult(proto.Message):
 37 |     r"""The result of a single bucket from a Datastore aggregation query.
 38 | 
 39 |     The keys of ``aggregate_properties`` are the same for all results in
 40 |     an aggregation query, unlike entity queries which can have different
 41 |     fields present for each result.
 42 | 
 43 |     Attributes:
 44 |         aggregate_properties (MutableMapping[str, google.cloud.datastore_v1.types.Value]):
 45 |             The result of the aggregation functions, ex:
 46 |             ``COUNT(*) AS total_entities``.
 47 | 
 48 |             The key is the
 49 |             [alias][google.datastore.v1.AggregationQuery.Aggregation.alias]
 50 |             assigned to the aggregation function on input and the size
 51 |             of this map equals the number of aggregation functions in
 52 |             the query.
 53 |     """
 54 | 
 55 |     aggregate_properties: MutableMapping[str, entity.Value] = proto.MapField(
 56 |         proto.STRING,
 57 |         proto.MESSAGE,
 58 |         number=2,
 59 |         message=entity.Value,
 60 |     )
 61 | 
 62 | 
 63 | class AggregationResultBatch(proto.Message):
 64 |     r"""A batch of aggregation results produced by an aggregation
 65 |     query.
 66 | 
 67 |     Attributes:
 68 |         aggregation_results (MutableSequence[google.cloud.datastore_v1.types.AggregationResult]):
 69 |             The aggregation results for this batch.
 70 |         more_results (google.cloud.datastore_v1.types.QueryResultBatch.MoreResultsType):
 71 |             The state of the query after the current batch. Only
 72 |             COUNT(\*) aggregations are supported in the initial launch.
 73 |             Therefore, expected result type is limited to
 74 |             ``NO_MORE_RESULTS``.
 75 |         read_time (google.protobuf.timestamp_pb2.Timestamp):
 76 |             Read timestamp this batch was returned from.
 77 | 
 78 |             In a single transaction, subsequent query result
 79 |             batches for the same query can have a greater
 80 |             timestamp. Each batch's read timestamp is valid
 81 |             for all preceding batches.
 82 |     """
 83 | 
 84 |     aggregation_results: MutableSequence["AggregationResult"] = proto.RepeatedField(
 85 |         proto.MESSAGE,
 86 |         number=1,
 87 |         message="AggregationResult",
 88 |     )
 89 |     more_results: query.QueryResultBatch.MoreResultsType = proto.Field(
 90 |         proto.ENUM,
 91 |         number=2,
 92 |         enum=query.QueryResultBatch.MoreResultsType,
 93 |     )
 94 |     read_time: timestamp_pb2.Timestamp = proto.Field(
 95 |         proto.MESSAGE,
 96 |         number=3,
 97 |         message=timestamp_pb2.Timestamp,
 98 |     )
 99 | 
100 | 
101 | __all__ = tuple(sorted(__protobuf__.manifest))
102 | 


--------------------------------------------------------------------------------
/.librarian/generator-input/setup.py:
--------------------------------------------------------------------------------
  1 | # Copyright 2018 Google LLC
  2 | #
  3 | # Licensed under the Apache License, Version 2.0 (the "License");
  4 | # you may not use this file except in compliance with the License.
  5 | # You may obtain a copy of the License at
  6 | #
  7 | #     http://www.apache.org/licenses/LICENSE-2.0
  8 | #
  9 | # Unless required by applicable law or agreed to in writing, software
 10 | # distributed under the License is distributed on an "AS IS" BASIS,
 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12 | # See the License for the specific language governing permissions and
 13 | # limitations under the License.
 14 | 
 15 | import io
 16 | import os
 17 | 
 18 | import setuptools
 19 | 
 20 | 
 21 | # Package metadata.
 22 | 
 23 | name = "google-cloud-datastore"
 24 | description = "Google Cloud Datastore API client library"
 25 | 
 26 | # Should be one of:
 27 | # 'Development Status :: 3 - Alpha'
 28 | # 'Development Status :: 4 - Beta'
 29 | # 'Development Status :: 5 - Production/Stable'
 30 | release_status = "Development Status :: 5 - Production/Stable"
 31 | dependencies = [
 32 |     "google-api-core[grpc] >= 1.34.0, <3.0.0,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*",
 33 |     # Exclude incompatible versions of `google-auth`
 34 |     # See https://github.com/googleapis/google-cloud-python/issues/12364
 35 |     "google-auth >= 2.14.1, <3.0.0,!=2.24.0,!=2.25.0",
 36 |     "google-cloud-core >= 1.4.0, <3.0.0",
 37 |     "proto-plus >= 1.22.0, <2.0.0",
 38 |     "proto-plus >= 1.22.2, <2.0.0; python_version>='3.11'",
 39 |     "proto-plus >= 1.25.0, <2.0.0; python_version>='3.13'",
 40 |     "protobuf>=3.20.2,<7.0.0,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5",
 41 |     "grpcio >= 1.38.0, < 2.0.0",
 42 |     "grpcio >= 1.75.1, < 2.0.0; python_version >= '3.14'",
 43 | ]
 44 | extras = {"libcst": "libcst >= 0.2.5"}
 45 | 
 46 | 
 47 | # Setup boilerplate below this line.
 48 | 
 49 | package_root = os.path.abspath(os.path.dirname(__file__))
 50 | 
 51 | version = {}
 52 | with open(os.path.join(package_root, "google/cloud/datastore/gapic_version.py")) as fp:
 53 |     exec(fp.read(), version)
 54 | version = version["__version__"]
 55 | 
 56 | readme_filename = os.path.join(package_root, "README.rst")
 57 | with io.open(readme_filename, encoding="utf-8") as readme_file:
 58 |     readme = readme_file.read()
 59 | 
 60 | # Only include packages under the 'google' namespace. Do not include tests,
 61 | # benchmarks, etc.
 62 | packages = [
 63 |     package
 64 |     for package in setuptools.find_namespace_packages()
 65 |     if package.startswith("google")
 66 | ]
 67 | 
 68 | setuptools.setup(
 69 |     name=name,
 70 |     version=version,
 71 |     description=description,
 72 |     long_description=readme,
 73 |     author="Google LLC",
 74 |     author_email="googleapis-packages@google.com",
 75 |     license="Apache 2.0",
 76 |     url="https://github.com/googleapis/python-datastore",
 77 |     classifiers=[
 78 |         release_status,
 79 |         "Intended Audience :: Developers",
 80 |         "License :: OSI Approved :: Apache Software License",
 81 |         "Programming Language :: Python",
 82 |         "Programming Language :: Python :: 3",
 83 |         "Programming Language :: Python :: 3.7",
 84 |         "Programming Language :: Python :: 3.8",
 85 |         "Programming Language :: Python :: 3.9",
 86 |         "Programming Language :: Python :: 3.10",
 87 |         "Programming Language :: Python :: 3.11",
 88 |         "Programming Language :: Python :: 3.12",
 89 |         "Programming Language :: Python :: 3.13",
 90 |         "Programming Language :: Python :: 3.14",
 91 |         "Operating System :: OS Independent",
 92 |         "Topic :: Internet",
 93 |         "Topic :: Software Development :: Libraries :: Python Modules",
 94 |     ],
 95 |     platforms="Posix; MacOS X; Windows",
 96 |     packages=packages,
 97 |     install_requires=dependencies,
 98 |     extras_require=extras,
 99 |     python_requires=">=3.7",
100 |     include_package_data=True,
101 |     zip_safe=False,
102 | )
103 | 


--------------------------------------------------------------------------------
/docs/UPGRADING.md:
--------------------------------------------------------------------------------
  1 | # 2.0.0 Migration Guide
  2 | 
  3 | The 2.0 release of the `google-cloud-datastore` client is a significant upgrade based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-python), and includes substantial interface changes. Existing code written for earlier versions of this library may require updates to use this version. This document describes the changes that have been made, and what you need to do to update your usage.
  4 | 
  5 | If you experience issues or have questions, please file an [issue](https://github.com/googleapis/python-datastore/issues).
  6 | 
  7 | ## Supported Python Versions
  8 | 
  9 | > **WARNING**: Breaking change
 10 | 
 11 | The 2.0.0 release requires Python 3.6+.
 12 | 
 13 | 
 14 | ## Method Calls
 15 | 
 16 | > **WARNING**: Breaking change
 17 | 
 18 | If you previously were using modules or functions under the namespace
 19 | `google.cloud.datastore_v1.gapic` there is a high likelihood you have incompatible code.
 20 | To assist with this, we have includes some helpful scripts to make some of the code
 21 | modifications required to use 2.0.0.
 22 | 
 23 | * Install the library
 24 | 
 25 | ```py
 26 | python3 -m pip install google-cloud-datastore
 27 | ```
 28 | 
 29 | * The scripts `fixup_datastore_v1_keywords.py` and `fixup_datastore_admin_v1_keywords.py` 
 30 | is shipped with the library. It expects an input directory (with the code to convert)
 31 | and an empty destination directory.
 32 | 
 33 | ```sh
 34 | $ fixup_datastore_v1_keywords.py --input-directory .samples/ --output-directory samples/
 35 | $ fixup_datastore_admin_v1_keywords.py --input-directory .samples/ --output-directory samples/
 36 | ```
 37 | 
 38 | ### More Details
 39 | 
 40 | In `google-cloud-datastore<2.0.0`, parameters required by the API were positional parameters and optional parameters were keyword parameters.
 41 | 
 42 | **Before:**
 43 | ```py
 44 |     def a_method(
 45 |         self,
 46 |         param1,
 47 |         param2,
 48 |         param3,
 49 |         retry=google.api_core.gapic_v1.method.DEFAULT,
 50 |         timeout=google.api_core.gapic_v1.method.DEFAULT,
 51 |         metadata=None,
 52 |     ):
 53 | ```
 54 | 
 55 | In the 2.0.0 release, all methods have a single positional parameter `request`. Method docstrings indicate whether a parameter is required or optional.
 56 | 
 57 | Some methods have additional keyword only parameters. The available parameters depend on the `google.api.method_signature` annotation specified by the API producer.
 58 | 
 59 | 
 60 | **After:**
 61 | ```py
 62 |     def a_method(
 63 |         self,
 64 |         request: RequestType = None,
 65 |         *
 66 |         param1,
 67 |         param2,
 68 |         param3,
 69 |         retry=google.api_core.gapic_v1.method.DEFAULT,
 70 |         timeout=google.api_core.gapic_v1.method.DEFAULT,
 71 |         metadata=None,
 72 |     ):
 73 | ```
 74 | 
 75 | > **NOTE:** The `request` parameter and flattened keyword parameters for the API are mutually exclusive.
 76 | > Passing both will result in an error.
 77 | 
 78 | 
 79 | Both of these calls are valid:
 80 | 
 81 | ```py
 82 | response = client.a_method(
 83 |     request={
 84 |         "param1": param1,
 85 |         "param2": param2,
 86 |         "param3": param3
 87 |     }
 88 | )
 89 | ```
 90 | 
 91 | ```py
 92 | response = client.a_method(
 93 |     param1=param1,
 94 |     param2=param2,
 95 |     param3=param3
 96 | )
 97 | ```
 98 | 
 99 | This call is invalid because it mixes `request` with a keyword argument `param1`. Executing this code
100 | will result in an error.
101 | 
102 | ```py
103 | response = client.a_method(
104 |     request={
105 |         "param1": param1,
106 |         "param2": param2
107 |     },
108 |     param2=param2
109 | )
110 | ```
111 | 
112 | 
113 | 
114 | ## Enums and Types
115 | 
116 | 
117 | > **WARNING**: Breaking change
118 | 
119 | The `enums` submodule has been removed.
120 | 
121 | **Before:**
122 | ```py
123 | from google.cloud import datastore_v1
124 | 
125 | direction = datastore_v1.enums.CommitRequest.Mode.TRANSACTIONAL
126 | ```
127 | 
128 | 
129 | **After:**
130 | ```py
131 | from google.cloud import datastore_v1
132 | 
133 | direction = datastore_v1.types.CommitRequest.Mode.TRANSACTIONAL
134 | ```
135 | 


--------------------------------------------------------------------------------
/UPGRADING.md:
--------------------------------------------------------------------------------
  1 | # 2.0.0 Migration Guide
  2 | 
  3 | The 2.0 release of the `google-cloud-datastore` client is a significant upgrade based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-python), and includes substantial interface changes. Existing code written for earlier versions of this library may require updates to use this version. This document describes the changes that have been made, and what you need to do to update your usage.
  4 | 
  5 | If you experience issues or have questions, please file an [issue](https://github.com/googleapis/python-datastore/issues).
  6 | 
  7 | ## Supported Python Versions
  8 | 
  9 | > **WARNING**: Breaking change
 10 | 
 11 | The 2.0.0 release requires Python 3.6+.
 12 | 
 13 | 
 14 | ## Method Calls
 15 | 
 16 | > **WARNING**: Breaking change
 17 | 
 18 | If you previously were using modules or functions under the namespace
 19 | `google.cloud.datastore_v1.gapic` there is a high likelihood you have incompatible code.
 20 | To assist with this, we have included some helpful scripts to make some of the code
 21 | modifications required to use 2.0.0.
 22 | 
 23 | * Install the library with `libcst`.
 24 | 
 25 | ```py
 26 | python3 -m pip install google-cloud-datastore[libcst]
 27 | ```
 28 | 
 29 | * The scripts `fixup_datastore_v1_keywords.py` and `fixup_datastore_admin_v1_keywords.py` 
 30 | is shipped with the library. It expects an input directory (with the code to convert)
 31 | and an empty destination directory.
 32 | 
 33 | ```sh
 34 | $ fixup_datastore_v1_keywords.py --input-directory .samples/ --output-directory samples/
 35 | $ fixup_datastore_admin_v1_keywords.py --input-directory .samples/ --output-directory samples/
 36 | ```
 37 | 
 38 | ### More Details
 39 | 
 40 | In `google-cloud-datastore<2.0.0`, parameters required by the API were positional parameters and optional parameters were keyword parameters.
 41 | 
 42 | **Before:**
 43 | ```py
 44 |     def a_method(
 45 |         self,
 46 |         param1,
 47 |         param2,
 48 |         param3,
 49 |         retry=google.api_core.gapic_v1.method.DEFAULT,
 50 |         timeout=google.api_core.gapic_v1.method.DEFAULT,
 51 |         metadata=None,
 52 |     ):
 53 | ```
 54 | 
 55 | In the 2.0.0 release, all methods have a single positional parameter `request`. Method docstrings indicate whether a parameter is required or optional.
 56 | 
 57 | Some methods have additional keyword only parameters. The available parameters depend on the `google.api.method_signature` annotation specified by the API producer.
 58 | 
 59 | 
 60 | **After:**
 61 | ```py
 62 |     def a_method(
 63 |         self,
 64 |         request: RequestType = None,
 65 |         *
 66 |         param1,
 67 |         param2,
 68 |         param3,
 69 |         retry=google.api_core.gapic_v1.method.DEFAULT,
 70 |         timeout=google.api_core.gapic_v1.method.DEFAULT,
 71 |         metadata=None,
 72 |     ):
 73 | ```
 74 | 
 75 | > **NOTE:** The `request` parameter and flattened keyword parameters for the API are mutually exclusive.
 76 | > Passing both will result in an error.
 77 | 
 78 | 
 79 | Both of these calls are valid:
 80 | 
 81 | ```py
 82 | response = client.a_method(
 83 |     request={
 84 |         "param1": param1,
 85 |         "param2": param2,
 86 |         "param3": param3
 87 |     }
 88 | )
 89 | ```
 90 | 
 91 | ```py
 92 | response = client.a_method(
 93 |     param1=param1,
 94 |     param2=param2,
 95 |     param3=param3
 96 | )
 97 | ```
 98 | 
 99 | This call is invalid because it mixes `request` with a keyword argument `param1`. Executing this code
100 | will result in an error.
101 | 
102 | ```py
103 | response = client.a_method(
104 |     request={
105 |         "param1": param1,
106 |         "param2": param2
107 |     },
108 |     param2=param2
109 | )
110 | ```
111 | 
112 | 
113 | 
114 | ## Enums and Types
115 | 
116 | 
117 | > **WARNING**: Breaking change
118 | 
119 | The `enums` submodule has been removed.
120 | 
121 | **Before:**
122 | ```py
123 | from google.cloud import datastore_v1
124 | 
125 | direction = datastore_v1.enums.CommitRequest.Mode.TRANSACTIONAL
126 | ```
127 | 
128 | 
129 | **After:**
130 | ```py
131 | from google.cloud import datastore_v1
132 | 
133 | direction = datastore_v1.types.CommitRequest.Mode.TRANSACTIONAL
134 | ```
135 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_v1/gapic_metadata.json:
--------------------------------------------------------------------------------
  1 |  {
  2 |   "comment": "This file maps proto services/RPCs to the corresponding library clients/methods",
  3 |   "language": "python",
  4 |   "libraryPackage": "google.cloud.datastore_v1",
  5 |   "protoPackage": "google.datastore.v1",
  6 |   "schema": "1.0",
  7 |   "services": {
  8 |     "Datastore": {
  9 |       "clients": {
 10 |         "grpc": {
 11 |           "libraryClient": "DatastoreClient",
 12 |           "rpcs": {
 13 |             "AllocateIds": {
 14 |               "methods": [
 15 |                 "allocate_ids"
 16 |               ]
 17 |             },
 18 |             "BeginTransaction": {
 19 |               "methods": [
 20 |                 "begin_transaction"
 21 |               ]
 22 |             },
 23 |             "Commit": {
 24 |               "methods": [
 25 |                 "commit"
 26 |               ]
 27 |             },
 28 |             "Lookup": {
 29 |               "methods": [
 30 |                 "lookup"
 31 |               ]
 32 |             },
 33 |             "ReserveIds": {
 34 |               "methods": [
 35 |                 "reserve_ids"
 36 |               ]
 37 |             },
 38 |             "Rollback": {
 39 |               "methods": [
 40 |                 "rollback"
 41 |               ]
 42 |             },
 43 |             "RunAggregationQuery": {
 44 |               "methods": [
 45 |                 "run_aggregation_query"
 46 |               ]
 47 |             },
 48 |             "RunQuery": {
 49 |               "methods": [
 50 |                 "run_query"
 51 |               ]
 52 |             }
 53 |           }
 54 |         },
 55 |         "grpc-async": {
 56 |           "libraryClient": "DatastoreAsyncClient",
 57 |           "rpcs": {
 58 |             "AllocateIds": {
 59 |               "methods": [
 60 |                 "allocate_ids"
 61 |               ]
 62 |             },
 63 |             "BeginTransaction": {
 64 |               "methods": [
 65 |                 "begin_transaction"
 66 |               ]
 67 |             },
 68 |             "Commit": {
 69 |               "methods": [
 70 |                 "commit"
 71 |               ]
 72 |             },
 73 |             "Lookup": {
 74 |               "methods": [
 75 |                 "lookup"
 76 |               ]
 77 |             },
 78 |             "ReserveIds": {
 79 |               "methods": [
 80 |                 "reserve_ids"
 81 |               ]
 82 |             },
 83 |             "Rollback": {
 84 |               "methods": [
 85 |                 "rollback"
 86 |               ]
 87 |             },
 88 |             "RunAggregationQuery": {
 89 |               "methods": [
 90 |                 "run_aggregation_query"
 91 |               ]
 92 |             },
 93 |             "RunQuery": {
 94 |               "methods": [
 95 |                 "run_query"
 96 |               ]
 97 |             }
 98 |           }
 99 |         },
100 |         "rest": {
101 |           "libraryClient": "DatastoreClient",
102 |           "rpcs": {
103 |             "AllocateIds": {
104 |               "methods": [
105 |                 "allocate_ids"
106 |               ]
107 |             },
108 |             "BeginTransaction": {
109 |               "methods": [
110 |                 "begin_transaction"
111 |               ]
112 |             },
113 |             "Commit": {
114 |               "methods": [
115 |                 "commit"
116 |               ]
117 |             },
118 |             "Lookup": {
119 |               "methods": [
120 |                 "lookup"
121 |               ]
122 |             },
123 |             "ReserveIds": {
124 |               "methods": [
125 |                 "reserve_ids"
126 |               ]
127 |             },
128 |             "Rollback": {
129 |               "methods": [
130 |                 "rollback"
131 |               ]
132 |             },
133 |             "RunAggregationQuery": {
134 |               "methods": [
135 |                 "run_aggregation_query"
136 |               ]
137 |             },
138 |             "RunQuery": {
139 |               "methods": [
140 |                 "run_query"
141 |               ]
142 |             }
143 |           }
144 |         }
145 |       }
146 |     }
147 |   }
148 | }
149 | 


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
  1 | # Copyright 2018 Google LLC
  2 | #
  3 | # Licensed under the Apache License, Version 2.0 (the "License");
  4 | # you may not use this file except in compliance with the License.
  5 | # You may obtain a copy of the License at
  6 | #
  7 | #     http://www.apache.org/licenses/LICENSE-2.0
  8 | #
  9 | # Unless required by applicable law or agreed to in writing, software
 10 | # distributed under the License is distributed on an "AS IS" BASIS,
 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12 | # See the License for the specific language governing permissions and
 13 | # limitations under the License.
 14 | 
 15 | # DO NOT EDIT THIS FILE OUTSIDE OF `.librarian/generator-input`
 16 | # The source of truth for this file is `.librarian/generator-input`
 17 | 
 18 | 
 19 | import io
 20 | import os
 21 | 
 22 | import setuptools
 23 | 
 24 | 
 25 | # Package metadata.
 26 | 
 27 | name = "google-cloud-datastore"
 28 | description = "Google Cloud Datastore API client library"
 29 | 
 30 | # Should be one of:
 31 | # 'Development Status :: 3 - Alpha'
 32 | # 'Development Status :: 4 - Beta'
 33 | # 'Development Status :: 5 - Production/Stable'
 34 | release_status = "Development Status :: 5 - Production/Stable"
 35 | dependencies = [
 36 |     "google-api-core[grpc] >= 1.34.0, <3.0.0,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*",
 37 |     # Exclude incompatible versions of `google-auth`
 38 |     # See https://github.com/googleapis/google-cloud-python/issues/12364
 39 |     "google-auth >= 2.14.1, <3.0.0,!=2.24.0,!=2.25.0",
 40 |     "google-cloud-core >= 1.4.0, <3.0.0",
 41 |     "proto-plus >= 1.22.0, <2.0.0",
 42 |     "proto-plus >= 1.22.2, <2.0.0; python_version>='3.11'",
 43 |     "proto-plus >= 1.25.0, <2.0.0; python_version>='3.13'",
 44 |     "protobuf>=3.20.2,<7.0.0,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5",
 45 |     "grpcio >= 1.38.0, < 2.0.0",
 46 |     "grpcio >= 1.75.1, < 2.0.0; python_version >= '3.14'",
 47 | ]
 48 | extras = {"libcst": "libcst >= 0.2.5"}
 49 | 
 50 | 
 51 | # Setup boilerplate below this line.
 52 | 
 53 | package_root = os.path.abspath(os.path.dirname(__file__))
 54 | 
 55 | version = {}
 56 | with open(os.path.join(package_root, "google/cloud/datastore/gapic_version.py")) as fp:
 57 |     exec(fp.read(), version)
 58 | version = version["__version__"]
 59 | 
 60 | readme_filename = os.path.join(package_root, "README.rst")
 61 | with io.open(readme_filename, encoding="utf-8") as readme_file:
 62 |     readme = readme_file.read()
 63 | 
 64 | # Only include packages under the 'google' namespace. Do not include tests,
 65 | # benchmarks, etc.
 66 | packages = [
 67 |     package
 68 |     for package in setuptools.find_namespace_packages()
 69 |     if package.startswith("google")
 70 | ]
 71 | 
 72 | setuptools.setup(
 73 |     name=name,
 74 |     version=version,
 75 |     description=description,
 76 |     long_description=readme,
 77 |     author="Google LLC",
 78 |     author_email="googleapis-packages@google.com",
 79 |     license="Apache 2.0",
 80 |     url="https://github.com/googleapis/python-datastore",
 81 |     classifiers=[
 82 |         release_status,
 83 |         "Intended Audience :: Developers",
 84 |         "License :: OSI Approved :: Apache Software License",
 85 |         "Programming Language :: Python",
 86 |         "Programming Language :: Python :: 3",
 87 |         "Programming Language :: Python :: 3.7",
 88 |         "Programming Language :: Python :: 3.8",
 89 |         "Programming Language :: Python :: 3.9",
 90 |         "Programming Language :: Python :: 3.10",
 91 |         "Programming Language :: Python :: 3.11",
 92 |         "Programming Language :: Python :: 3.12",
 93 |         "Programming Language :: Python :: 3.13",
 94 |         "Programming Language :: Python :: 3.14",
 95 |         "Operating System :: OS Independent",
 96 |         "Topic :: Internet",
 97 |         "Topic :: Software Development :: Libraries :: Python Modules",
 98 |     ],
 99 |     platforms="Posix; MacOS X; Windows",
100 |     packages=packages,
101 |     install_requires=dependencies,
102 |     extras_require=extras,
103 |     python_requires=">=3.7",
104 |     include_package_data=True,
105 |     zip_safe=False,
106 | )
107 | 


--------------------------------------------------------------------------------
/tests/unit/test__gapic.py:
--------------------------------------------------------------------------------
  1 | # Copyright 2017 Google LLC
  2 | #
  3 | # Licensed under the Apache License, Version 2.0 (the "License");
  4 | # you may not use this file except in compliance with the License.
  5 | # You may obtain a copy of the License at
  6 | #
  7 | #     http://www.apache.org/licenses/LICENSE-2.0
  8 | #
  9 | # Unless required by applicable law or agreed to in writing, software
 10 | # distributed under the License is distributed on an "AS IS" BASIS,
 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12 | # See the License for the specific language governing permissions and
 13 | # limitations under the License.
 14 | 
 15 | import mock
 16 | import pytest
 17 | 
 18 | from google.cloud.datastore.client import _HAVE_GRPC
 19 | 
 20 | 
 21 | @pytest.mark.skipif(not _HAVE_GRPC, reason="No gRPC")
 22 | @mock.patch(
 23 |     "google.cloud.datastore_v1.services.datastore.client.DatastoreClient",
 24 |     return_value=mock.sentinel.ds_client,
 25 | )
 26 | @mock.patch(
 27 |     "google.cloud.datastore_v1.services.datastore.transports.grpc.DatastoreGrpcTransport",
 28 |     return_value=mock.sentinel.transport,
 29 | )
 30 | @mock.patch(
 31 |     "google.cloud.datastore._gapic.make_secure_channel",
 32 |     return_value=mock.sentinel.channel,
 33 | )
 34 | def test_live_api(make_chan, mock_transport, mock_klass):
 35 |     from google.cloud._http import DEFAULT_USER_AGENT
 36 |     from google.cloud.datastore._gapic import make_datastore_api
 37 | 
 38 |     base_url = "https://datastore.googleapis.com:443"
 39 |     client = mock.Mock(
 40 |         _base_url=base_url,
 41 |         _credentials=mock.sentinel.credentials,
 42 |         _client_info=mock.sentinel.client_info,
 43 |         spec=["_base_url", "_credentials", "_client_info"],
 44 |     )
 45 |     ds_api = make_datastore_api(client)
 46 |     assert ds_api is mock.sentinel.ds_client
 47 | 
 48 |     mock_transport.assert_called_once_with(channel=mock.sentinel.channel)
 49 | 
 50 |     make_chan.assert_called_once_with(
 51 |         mock.sentinel.credentials,
 52 |         DEFAULT_USER_AGENT,
 53 |         "datastore.googleapis.com:443",
 54 |     )
 55 | 
 56 |     mock_klass.assert_called_once_with(
 57 |         transport=mock.sentinel.transport, client_info=mock.sentinel.client_info
 58 |     )
 59 | 
 60 | 
 61 | @pytest.mark.skipif(not _HAVE_GRPC, reason="No gRPC")
 62 | @mock.patch(
 63 |     "google.cloud.datastore_v1.services.datastore.client.DatastoreClient",
 64 |     return_value=mock.sentinel.ds_client,
 65 | )
 66 | @mock.patch(
 67 |     "google.cloud.datastore_v1.services.datastore.transports.grpc.DatastoreGrpcTransport",
 68 |     return_value=mock.sentinel.transport,
 69 | )
 70 | @mock.patch(
 71 |     "google.cloud.datastore._gapic.insecure_channel",
 72 |     return_value=mock.sentinel.channel,
 73 | )
 74 | def test_emulator(make_chan, mock_transport, mock_klass):
 75 |     from google.cloud.datastore._gapic import make_datastore_api
 76 | 
 77 |     host = "localhost:8901"
 78 |     base_url = "http://" + host
 79 |     client = mock.Mock(
 80 |         _base_url=base_url,
 81 |         _credentials=mock.sentinel.credentials,
 82 |         _client_info=mock.sentinel.client_info,
 83 |         spec=["_base_url", "_credentials", "_client_info"],
 84 |     )
 85 |     ds_api = make_datastore_api(client)
 86 |     assert ds_api is mock.sentinel.ds_client
 87 | 
 88 |     mock_transport.assert_called_once_with(channel=mock.sentinel.channel)
 89 | 
 90 |     make_chan.assert_called_once_with(host)
 91 | 
 92 |     mock_klass.assert_called_once_with(
 93 |         transport=mock.sentinel.transport, client_info=mock.sentinel.client_info
 94 |     )
 95 | 
 96 | 
 97 | def test_version_from_gapic_version_matches_datastore_version():
 98 |     from google.cloud.datastore import gapic_version
 99 |     from google.cloud.datastore_v1 import gapic_version as gapic_version_v1
100 |     from google.cloud.datastore_admin import gapic_version as gapic_version_admin
101 |     from google.cloud.datastore_admin_v1 import gapic_version as gapic_version_admin_v1
102 | 
103 |     assert gapic_version.__version__ == gapic_version_admin.__version__
104 |     assert gapic_version.__version__ == gapic_version_v1.__version__
105 |     assert gapic_version.__version__ == gapic_version_admin_v1.__version__
106 | 


--------------------------------------------------------------------------------
/tests/system/test_read_consistency.py:
--------------------------------------------------------------------------------
  1 | # Copyright 2022 Google LLC
  2 | #
  3 | # Licensed under the Apache License, Version 2.0 (the "License");
  4 | # you may not use this file except in compliance with the License.
  5 | # You may obtain a copy of the License at
  6 | #
  7 | #     http://www.apache.org/licenses/LICENSE-2.0
  8 | #
  9 | # Unless required by applicable law or agreed to in writing, software
 10 | # distributed under the License is distributed on an "AS IS" BASIS,
 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12 | # See the License for the specific language governing permissions and
 13 | # limitations under the License.
 14 | import pytest
 15 | import time
 16 | 
 17 | from datetime import datetime, timezone
 18 | 
 19 | from google.cloud import datastore
 20 | from . import _helpers
 21 | 
 22 | 
 23 | def _parent_key(datastore_client):
 24 |     return datastore_client.key("Blog", "PizzaMan")
 25 | 
 26 | 
 27 | def _put_entity(datastore_client, entity_id):
 28 |     key = datastore_client.key(
 29 |         "read_time_test", entity_id, parent=_parent_key(datastore_client)
 30 |     )
 31 |     entity = datastore.Entity(key=key)
 32 |     entity["field"] = "old_value"
 33 |     datastore_client.put(entity)
 34 |     return entity
 35 | 
 36 | 
 37 | @pytest.mark.parametrize("database_id", [None, _helpers.TEST_DATABASE], indirect=True)
 38 | def test_get_w_read_time(datastore_client, entities_to_delete, database_id):
 39 |     entity = _put_entity(datastore_client, 1)
 40 |     entities_to_delete.append(entity)
 41 | 
 42 |     # Add some sleep to accommodate server & client clock discrepancy.
 43 |     time.sleep(1)
 44 |     read_time = datetime.now(tz=timezone.utc)
 45 |     time.sleep(1)
 46 | 
 47 |     entity["field"] = "new_value"
 48 |     datastore_client.put(entity)
 49 | 
 50 |     # Get without read_time.
 51 |     retrieved_entity = datastore_client.get(entity.key)
 52 |     assert retrieved_entity["field"] == "new_value"
 53 | 
 54 |     # Directly specify read_time in get request.
 55 |     retrieved_entity_from_read_time = datastore_client.get(
 56 |         entity.key, read_time=read_time
 57 |     )
 58 |     assert retrieved_entity_from_read_time["field"] == "old_value"
 59 | 
 60 |     # Use read_time in a read_only transaction.
 61 |     with datastore_client.transaction(read_only=True, read_time=read_time):
 62 |         retrieved_entity_from_xact = datastore_client.get(entity.key)
 63 |         assert retrieved_entity_from_xact["field"] == "old_value"
 64 | 
 65 | 
 66 | @pytest.mark.parametrize("database_id", [None, _helpers.TEST_DATABASE], indirect=True)
 67 | def test_query_w_read_time(datastore_client, entities_to_delete, database_id):
 68 |     entity0 = _put_entity(datastore_client, 1)
 69 |     entity1 = _put_entity(datastore_client, 2)
 70 |     entity2 = _put_entity(datastore_client, 3)
 71 | 
 72 |     entities_to_delete.append(entity0)
 73 |     entities_to_delete.append(entity1)
 74 |     entities_to_delete.append(entity2)
 75 | 
 76 |     # Add some sleep to accommodate server & client clock discrepancy.
 77 |     time.sleep(1)
 78 |     read_time = datetime.now(tz=timezone.utc)
 79 |     time.sleep(1)
 80 | 
 81 |     entity2["field"] = "new_value"
 82 |     datastore_client.put(entity2)
 83 | 
 84 |     query = datastore_client.query(
 85 |         kind="read_time_test", ancestor=_parent_key(datastore_client)
 86 |     )
 87 |     query = query.add_filter("field", "=", "old_value")
 88 | 
 89 |     # Query without read_time.
 90 |     iterator = query.fetch()
 91 |     page = next(iterator.pages)
 92 |     query_results = list(page)
 93 |     assert len(query_results) == 2
 94 |     assert query_results[0].key == entity0.key
 95 |     assert query_results[1].key == entity1.key
 96 | 
 97 |     # Directly specify read_time in query.
 98 |     iterator_read_time = query.fetch(read_time=read_time)
 99 |     page_read_time = next(iterator_read_time.pages)
100 |     query_results_read_time = list(page_read_time)
101 |     assert len(query_results_read_time) == 3
102 |     assert query_results_read_time[0].key == entity0.key
103 |     assert query_results_read_time[1].key == entity1.key
104 |     assert query_results_read_time[2].key == entity2.key
105 | 
106 |     # Run the query in a read_only transacxtion with read_time.
107 |     with datastore_client.transaction(read_only=True, read_time=read_time):
108 |         iterator_from_xact = query.fetch()
109 |         page_from_xact = next(iterator_from_xact.pages)
110 |         query_results_from_xact = list(page_from_xact)
111 |         assert len(query_results_from_xact) == 3
112 |         assert query_results_from_xact[0].key == entity0.key
113 |         assert query_results_from_xact[1].key == entity1.key
114 |         assert query_results_from_xact[2].key == entity2.key
115 | 


--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
 1 | <!-- # Generated by synthtool. DO NOT EDIT! !-->
 2 | # Code of Conduct
 3 | 
 4 | ## Our Pledge
 5 | 
 6 | In the interest of fostering an open and welcoming environment, we as
 7 | contributors and maintainers pledge to making participation in our project and
 8 | our community a harassment-free experience for everyone, regardless of age, body
 9 | size, disability, ethnicity, gender identity and expression, level of
10 | experience, education, socio-economic status, nationality, personal appearance,
11 | race, religion, or sexual identity and orientation.
12 | 
13 | ## Our Standards
14 | 
15 | Examples of behavior that contributes to creating a positive environment
16 | include:
17 | 
18 | *   Using welcoming and inclusive language
19 | *   Being respectful of differing viewpoints and experiences
20 | *   Gracefully accepting constructive criticism
21 | *   Focusing on what is best for the community
22 | *   Showing empathy towards other community members
23 | 
24 | Examples of unacceptable behavior by participants include:
25 | 
26 | *   The use of sexualized language or imagery and unwelcome sexual attention or
27 |     advances
28 | *   Trolling, insulting/derogatory comments, and personal or political attacks
29 | *   Public or private harassment
30 | *   Publishing others' private information, such as a physical or electronic
31 |     address, without explicit permission
32 | *   Other conduct which could reasonably be considered inappropriate in a
33 |     professional setting
34 | 
35 | ## Our Responsibilities
36 | 
37 | Project maintainers are responsible for clarifying the standards of acceptable
38 | behavior and are expected to take appropriate and fair corrective action in
39 | response to any instances of unacceptable behavior.
40 | 
41 | Project maintainers have the right and responsibility to remove, edit, or reject
42 | comments, commits, code, wiki edits, issues, and other contributions that are
43 | not aligned to this Code of Conduct, or to ban temporarily or permanently any
44 | contributor for other behaviors that they deem inappropriate, threatening,
45 | offensive, or harmful.
46 | 
47 | ## Scope
48 | 
49 | This Code of Conduct applies both within project spaces and in public spaces
50 | when an individual is representing the project or its community. Examples of
51 | representing a project or community include using an official project e-mail
52 | address, posting via an official social media account, or acting as an appointed
53 | representative at an online or offline event. Representation of a project may be
54 | further defined and clarified by project maintainers.
55 | 
56 | This Code of Conduct also applies outside the project spaces when the Project
57 | Steward has a reasonable belief that an individual's behavior may have a
58 | negative impact on the project or its community.
59 | 
60 | ## Conflict Resolution
61 | 
62 | We do not believe that all conflict is bad; healthy debate and disagreement
63 | often yield positive results. However, it is never okay to be disrespectful or
64 | to engage in behavior that violates the project’s code of conduct.
65 | 
66 | If you see someone violating the code of conduct, you are encouraged to address
67 | the behavior directly with those involved. Many issues can be resolved quickly
68 | and easily, and this gives people more control over the outcome of their
69 | dispute. If you are unable to resolve the matter for any reason, or if the
70 | behavior is threatening or harassing, report it. We are dedicated to providing
71 | an environment where participants feel welcome and safe.
72 | 
73 | 
74 | Reports should be directed to *googleapis-stewards@google.com*, the
75 | Project Steward(s) for *Google Cloud Client Libraries*. It is the Project Steward’s duty to
76 | receive and address reported violations of the code of conduct. They will then
77 | work with a committee consisting of representatives from the Open Source
78 | Programs Office and the Google Open Source Strategy team. If for any reason you
79 | are uncomfortable reaching out to the Project Steward, please email
80 | opensource@google.com.
81 | 
82 | We will investigate every complaint, but you may not receive a direct response.
83 | We will use our discretion in determining when and how to follow up on reported
84 | incidents, which may range from not taking action to permanent expulsion from
85 | the project and project-sponsored spaces. We will notify the accused of the
86 | report and provide them an opportunity to discuss it before any action is taken.
87 | The identity of the reporter will be omitted from the details of the report
88 | supplied to the accused. In potentially harmful situations, such as ongoing
89 | harassment or threats to anyone's safety, we may take action without notice.
90 | 
91 | ## Attribution
92 | 
93 | This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
94 | available at
95 | https://www.contributor-covenant.org/version/1/4/code-of-conduct.html


--------------------------------------------------------------------------------
/google/cloud/datastore_v1/types/query_profile.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | # Copyright 2025 Google LLC
  3 | #
  4 | # Licensed under the Apache License, Version 2.0 (the "License");
  5 | # you may not use this file except in compliance with the License.
  6 | # You may obtain a copy of the License at
  7 | #
  8 | #     http://www.apache.org/licenses/LICENSE-2.0
  9 | #
 10 | # Unless required by applicable law or agreed to in writing, software
 11 | # distributed under the License is distributed on an "AS IS" BASIS,
 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 13 | # See the License for the specific language governing permissions and
 14 | # limitations under the License.
 15 | #
 16 | from __future__ import annotations
 17 | 
 18 | from typing import MutableMapping, MutableSequence
 19 | 
 20 | import proto  # type: ignore
 21 | 
 22 | from google.protobuf import duration_pb2  # type: ignore
 23 | from google.protobuf import struct_pb2  # type: ignore
 24 | 
 25 | 
 26 | __protobuf__ = proto.module(
 27 |     package="google.datastore.v1",
 28 |     manifest={
 29 |         "ExplainOptions",
 30 |         "ExplainMetrics",
 31 |         "PlanSummary",
 32 |         "ExecutionStats",
 33 |     },
 34 | )
 35 | 
 36 | 
 37 | class ExplainOptions(proto.Message):
 38 |     r"""Explain options for the query.
 39 | 
 40 |     Attributes:
 41 |         analyze (bool):
 42 |             Optional. Whether to execute this query.
 43 | 
 44 |             When false (the default), the query will be
 45 |             planned, returning only metrics from the
 46 |             planning stages.
 47 | 
 48 |             When true, the query will be planned and
 49 |             executed, returning the full query results along
 50 |             with both planning and execution stage metrics.
 51 |     """
 52 | 
 53 |     analyze: bool = proto.Field(
 54 |         proto.BOOL,
 55 |         number=1,
 56 |     )
 57 | 
 58 | 
 59 | class ExplainMetrics(proto.Message):
 60 |     r"""Explain metrics for the query.
 61 | 
 62 |     Attributes:
 63 |         plan_summary (google.cloud.datastore_v1.types.PlanSummary):
 64 |             Planning phase information for the query.
 65 |         execution_stats (google.cloud.datastore_v1.types.ExecutionStats):
 66 |             Aggregated stats from the execution of the query. Only
 67 |             present when
 68 |             [ExplainOptions.analyze][google.datastore.v1.ExplainOptions.analyze]
 69 |             is set to true.
 70 |     """
 71 | 
 72 |     plan_summary: "PlanSummary" = proto.Field(
 73 |         proto.MESSAGE,
 74 |         number=1,
 75 |         message="PlanSummary",
 76 |     )
 77 |     execution_stats: "ExecutionStats" = proto.Field(
 78 |         proto.MESSAGE,
 79 |         number=2,
 80 |         message="ExecutionStats",
 81 |     )
 82 | 
 83 | 
 84 | class PlanSummary(proto.Message):
 85 |     r"""Planning phase information for the query.
 86 | 
 87 |     Attributes:
 88 |         indexes_used (MutableSequence[google.protobuf.struct_pb2.Struct]):
 89 |             The indexes selected for the query. For example: [
 90 |             {"query_scope": "Collection", "properties": "(foo ASC,
 91 |             **name** ASC)"}, {"query_scope": "Collection", "properties":
 92 |             "(bar ASC, **name** ASC)"} ]
 93 |     """
 94 | 
 95 |     indexes_used: MutableSequence[struct_pb2.Struct] = proto.RepeatedField(
 96 |         proto.MESSAGE,
 97 |         number=1,
 98 |         message=struct_pb2.Struct,
 99 |     )
100 | 
101 | 
102 | class ExecutionStats(proto.Message):
103 |     r"""Execution statistics for the query.
104 | 
105 |     Attributes:
106 |         results_returned (int):
107 |             Total number of results returned, including
108 |             documents, projections, aggregation results,
109 |             keys.
110 |         execution_duration (google.protobuf.duration_pb2.Duration):
111 |             Total time to execute the query in the
112 |             backend.
113 |         read_operations (int):
114 |             Total billable read operations.
115 |         debug_stats (google.protobuf.struct_pb2.Struct):
116 |             Debugging statistics from the execution of the query. Note
117 |             that the debugging stats are subject to change as Firestore
118 |             evolves. It could include: { "indexes_entries_scanned":
119 |             "1000", "documents_scanned": "20", "billing_details" : {
120 |             "documents_billable": "20", "index_entries_billable":
121 |             "1000", "min_query_cost": "0" } }
122 |     """
123 | 
124 |     results_returned: int = proto.Field(
125 |         proto.INT64,
126 |         number=1,
127 |     )
128 |     execution_duration: duration_pb2.Duration = proto.Field(
129 |         proto.MESSAGE,
130 |         number=3,
131 |         message=duration_pb2.Duration,
132 |     )
133 |     read_operations: int = proto.Field(
134 |         proto.INT64,
135 |         number=4,
136 |     )
137 |     debug_stats: struct_pb2.Struct = proto.Field(
138 |         proto.MESSAGE,
139 |         number=5,
140 |         message=struct_pb2.Struct,
141 |     )
142 | 
143 | 
144 | __all__ = tuple(sorted(__protobuf__.manifest))
145 | 


--------------------------------------------------------------------------------
/tests/unit/test_query_profile.py:
--------------------------------------------------------------------------------
  1 | # Copyright 2024 Google LLC
  2 | #
  3 | # Licensed under the Apache License, Version 2.0 (the "License");
  4 | # you may not use this file except in compliance with the License.
  5 | # You may obtain a copy of the License at
  6 | #
  7 | #     http://www.apache.org/licenses/LICENSE-2.0
  8 | #
  9 | # Unless required by applicable law or agreed to in writing, software
 10 | # distributed under the License is distributed on an "AS IS" BASIS,
 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12 | # See the License for the specific language governing permissions and
 13 | # limitations under the License.
 14 | 
 15 | import pytest
 16 | 
 17 | 
 18 | def test_explain_metrics__from_pb():
 19 |     """
 20 |     Test creating an instance of ExplainMetrics from a protobuf.
 21 |     """
 22 |     from google.cloud.datastore.query_profile import (
 23 |         ExplainMetrics,
 24 |         _ExplainAnalyzeMetrics,
 25 |         QueryExplainError,
 26 |         PlanSummary,
 27 |     )
 28 |     from google.cloud.datastore_v1.types import query_profile as query_profile_pb2
 29 |     from google.protobuf import struct_pb2, duration_pb2
 30 | 
 31 |     # test without execution_stats field
 32 |     expected_metrics = query_profile_pb2.ExplainMetrics(
 33 |         plan_summary=query_profile_pb2.PlanSummary(
 34 |             indexes_used=struct_pb2.ListValue(values=[])
 35 |         )
 36 |     )
 37 |     metrics = ExplainMetrics._from_pb(expected_metrics)
 38 |     assert isinstance(metrics, ExplainMetrics)
 39 |     assert isinstance(metrics.plan_summary, PlanSummary)
 40 |     assert metrics.plan_summary.indexes_used == []
 41 |     with pytest.raises(QueryExplainError) as exc:
 42 |         metrics.execution_stats
 43 |     assert "execution_stats not available when explain_options.analyze=False" in str(
 44 |         exc.value
 45 |     )
 46 |     # test with execution_stats field
 47 |     expected_metrics.execution_stats = query_profile_pb2.ExecutionStats(
 48 |         results_returned=1,
 49 |         execution_duration=duration_pb2.Duration(seconds=2),
 50 |         read_operations=3,
 51 |         debug_stats=struct_pb2.Struct(
 52 |             fields={"foo": struct_pb2.Value(string_value="bar")}
 53 |         ),
 54 |     )
 55 |     metrics = ExplainMetrics._from_pb(expected_metrics)
 56 |     assert isinstance(metrics, ExplainMetrics)
 57 |     assert isinstance(metrics, _ExplainAnalyzeMetrics)
 58 |     assert metrics.execution_stats.results_returned == 1
 59 |     assert metrics.execution_stats.execution_duration.total_seconds() == 2
 60 |     assert metrics.execution_stats.read_operations == 3
 61 |     assert metrics.execution_stats.debug_stats == {"foo": "bar"}
 62 | 
 63 | 
 64 | def test_explain_metrics__from_pb_empty():
 65 |     """
 66 |     Test with empty ExplainMetrics protobuf.
 67 |     """
 68 |     from google.cloud.datastore.query_profile import (
 69 |         ExplainMetrics,
 70 |         ExecutionStats,
 71 |         _ExplainAnalyzeMetrics,
 72 |         PlanSummary,
 73 |     )
 74 |     from google.cloud.datastore_v1.types import query_profile as query_profile_pb2
 75 |     from google.protobuf import struct_pb2
 76 | 
 77 |     expected_metrics = query_profile_pb2.ExplainMetrics(
 78 |         plan_summary=query_profile_pb2.PlanSummary(
 79 |             indexes_used=struct_pb2.ListValue(values=[])
 80 |         ),
 81 |         execution_stats=query_profile_pb2.ExecutionStats(),
 82 |     )
 83 |     metrics = ExplainMetrics._from_pb(expected_metrics)
 84 |     assert isinstance(metrics, ExplainMetrics)
 85 |     assert isinstance(metrics, _ExplainAnalyzeMetrics)
 86 |     assert isinstance(metrics.plan_summary, PlanSummary)
 87 |     assert isinstance(metrics.execution_stats, ExecutionStats)
 88 |     assert metrics.plan_summary.indexes_used == []
 89 |     assert metrics.execution_stats.results_returned == 0
 90 |     assert metrics.execution_stats.execution_duration.total_seconds() == 0
 91 |     assert metrics.execution_stats.read_operations == 0
 92 |     assert metrics.execution_stats.debug_stats == {}
 93 | 
 94 | 
 95 | def test_explain_metrics_execution_stats():
 96 |     """
 97 |     Standard ExplainMetrics class should raise exception when execution_stats is accessed.
 98 |     _ExplainAnalyzeMetrics should include the field
 99 |     """
100 |     from google.cloud.datastore.query_profile import (
101 |         ExplainMetrics,
102 |         QueryExplainError,
103 |         _ExplainAnalyzeMetrics,
104 |     )
105 | 
106 |     metrics = ExplainMetrics(plan_summary=object())
107 |     with pytest.raises(QueryExplainError) as exc:
108 |         metrics.execution_stats
109 |     assert "execution_stats not available when explain_options.analyze=False" in str(
110 |         exc.value
111 |     )
112 |     expected_stats = object()
113 |     metrics = _ExplainAnalyzeMetrics(
114 |         plan_summary=object(), _execution_stats=expected_stats
115 |     )
116 |     assert metrics.execution_stats is expected_stats
117 | 
118 | 
119 | def test_explain_options__to_dict():
120 |     """
121 |     Should be able to create a dict representation of ExplainOptions
122 |     """
123 |     from google.cloud.datastore.query_profile import ExplainOptions
124 | 
125 |     assert ExplainOptions(analyze=True)._to_dict() == {"analyze": True}
126 |     assert ExplainOptions(analyze=False)._to_dict() == {"analyze": False}
127 | 


--------------------------------------------------------------------------------
/google/cloud/datastore/query_profile.py:
--------------------------------------------------------------------------------
  1 | # Copyright 2024 Google LLC
  2 | #
  3 | # Licensed under the Apache License, Version 2.0 (the "License");
  4 | # you may not use this file except in compliance with the License.
  5 | # You may obtain a copy of the License at
  6 | #
  7 | #     http://www.apache.org/licenses/LICENSE-2.0
  8 | #
  9 | # Unless required by applicable law or agreed to in writing, software
 10 | # distributed under the License is distributed on an "AS IS" BASIS,
 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12 | # See the License for the specific language governing permissions and
 13 | # limitations under the License.
 14 | from __future__ import annotations
 15 | 
 16 | from typing import Any
 17 | 
 18 | import datetime
 19 | 
 20 | from dataclasses import dataclass
 21 | from google.protobuf.json_format import MessageToDict
 22 | 
 23 | 
 24 | @dataclass(frozen=True)
 25 | class ExplainOptions:
 26 |     """
 27 |     Class used to configure query profiling on a query.
 28 |     Set on a query object using the explain_options attribute at query construction time.
 29 | 
 30 |     :type analyze: bool
 31 |     :param analyze: Whether to execute this query. When false (the default),
 32 |         the query will be planned, returning only metrics from the planning stages.
 33 |         When true, the query will be planned and executed, returning the full
 34 |         query results along with both planning and execution stage metrics.
 35 |     """
 36 | 
 37 |     analyze: bool = False
 38 | 
 39 |     def _to_dict(self):
 40 |         return {"analyze": self.analyze}
 41 | 
 42 | 
 43 | @dataclass(frozen=True)
 44 | class PlanSummary:
 45 |     """
 46 |     Contains planning phase information about a query.
 47 | 
 48 |     :type indexes_used: list[dict[str, Any]]
 49 |     :param indexes_used: The indexes selected for this query.
 50 |     """
 51 | 
 52 |     indexes_used: list[dict[str, Any]]
 53 | 
 54 | 
 55 | @dataclass(frozen=True)
 56 | class ExecutionStats:
 57 |     """
 58 |     Execution phase information about a query.
 59 | 
 60 |     Only available when explain_options.analyze is True.
 61 | 
 62 |     :type results_returned: int
 63 |     :param results_returned: Total number of results returned, including
 64 |         documents, projections, aggregation results, keys.
 65 |     :type execution_duration: datetime.timedelta
 66 |     :param execution_duration: Total time to execute the query in the backend.
 67 |     :type read_operations: int
 68 |     :param read_operations: Total billable read operations.
 69 |     :type debug_stats: dict[str, Any]
 70 |     :param debug_stats: Debugging statistics from the execution of the query.
 71 |         Note that the debugging stats are subject to change as Firestore evolves
 72 |     """
 73 | 
 74 |     results_returned: int
 75 |     execution_duration: datetime.timedelta
 76 |     read_operations: int
 77 |     debug_stats: dict[str, Any]
 78 | 
 79 | 
 80 | @dataclass(frozen=True)
 81 | class ExplainMetrics:
 82 |     """
 83 |     ExplainMetrics contains information about the planning and execution of a query.
 84 | 
 85 |     When explain_options.analyze is false, only plan_summary is available.
 86 |     When explain_options.analyze is true, execution_stats is also available.
 87 | 
 88 |     :type plan_summary: PlanSummary
 89 |     :param plan_summary: Planning phase information about the query.
 90 |     :type execution_stats: ExecutionStats
 91 |     :param execution_stats: Execution phase information about the query.
 92 |     """
 93 | 
 94 |     plan_summary: PlanSummary
 95 | 
 96 |     @staticmethod
 97 |     def _from_pb(metrics_pb):
 98 |         dict_repr = MessageToDict(metrics_pb._pb, preserving_proto_field_name=True)
 99 |         plan_summary = PlanSummary(
100 |             indexes_used=dict_repr.get("plan_summary", {}).get("indexes_used", [])
101 |         )
102 |         if "execution_stats" in dict_repr:
103 |             stats_dict = dict_repr.get("execution_stats", {})
104 |             execution_stats = ExecutionStats(
105 |                 results_returned=int(stats_dict.get("results_returned", 0)),
106 |                 execution_duration=metrics_pb.execution_stats.execution_duration,
107 |                 read_operations=int(stats_dict.get("read_operations", 0)),
108 |                 debug_stats=stats_dict.get("debug_stats", {}),
109 |             )
110 |             return _ExplainAnalyzeMetrics(
111 |                 plan_summary=plan_summary, _execution_stats=execution_stats
112 |             )
113 |         else:
114 |             return ExplainMetrics(plan_summary=plan_summary)
115 | 
116 |     @property
117 |     def execution_stats(self) -> ExecutionStats:
118 |         raise QueryExplainError(
119 |             "execution_stats not available when explain_options.analyze=False."
120 |         )
121 | 
122 | 
123 | @dataclass(frozen=True)
124 | class _ExplainAnalyzeMetrics(ExplainMetrics):
125 |     """
126 |     Subclass of ExplainMetrics that includes execution_stats.
127 |     Only available when explain_options.analyze is True.
128 |     """
129 | 
130 |     plan_summary: PlanSummary
131 |     _execution_stats: ExecutionStats
132 | 
133 |     @property
134 |     def execution_stats(self) -> ExecutionStats:
135 |         return self._execution_stats
136 | 
137 | 
138 | class QueryExplainError(Exception):
139 |     """
140 |     Error returned when there is a problem accessing query profiling information.
141 |     """
142 | 
143 |     pass
144 | 


--------------------------------------------------------------------------------
/google/cloud/datastore_admin_v1/types/index.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | # Copyright 2025 Google LLC
  3 | #
  4 | # Licensed under the Apache License, Version 2.0 (the "License");
  5 | # you may not use this file except in compliance with the License.
  6 | # You may obtain a copy of the License at
  7 | #
  8 | #     http://www.apache.org/licenses/LICENSE-2.0
  9 | #
 10 | # Unless required by applicable law or agreed to in writing, software
 11 | # distributed under the License is distributed on an "AS IS" BASIS,
 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 13 | # See the License for the specific language governing permissions and
 14 | # limitations under the License.
 15 | #
 16 | from __future__ import annotations
 17 | 
 18 | from typing import MutableMapping, MutableSequence
 19 | 
 20 | import proto  # type: ignore
 21 | 
 22 | 
 23 | __protobuf__ = proto.module(
 24 |     package="google.datastore.admin.v1",
 25 |     manifest={
 26 |         "Index",
 27 |     },
 28 | )
 29 | 
 30 | 
 31 | class Index(proto.Message):
 32 |     r"""Datastore composite index definition.
 33 | 
 34 |     Attributes:
 35 |         project_id (str):
 36 |             Output only. Project ID.
 37 |         index_id (str):
 38 |             Output only. The resource ID of the index.
 39 |         kind (str):
 40 |             Required. The entity kind to which this index
 41 |             applies.
 42 |         ancestor (google.cloud.datastore_admin_v1.types.Index.AncestorMode):
 43 |             Required. The index's ancestor mode. Must not be
 44 |             ANCESTOR_MODE_UNSPECIFIED.
 45 |         properties (MutableSequence[google.cloud.datastore_admin_v1.types.Index.IndexedProperty]):
 46 |             Required. An ordered sequence of property names and their
 47 |             index attributes.
 48 | 
 49 |             Requires:
 50 | 
 51 |             - A maximum of 100 properties.
 52 |         state (google.cloud.datastore_admin_v1.types.Index.State):
 53 |             Output only. The state of the index.
 54 |     """
 55 | 
 56 |     class AncestorMode(proto.Enum):
 57 |         r"""For an ordered index, specifies whether each of the entity's
 58 |         ancestors will be included.
 59 | 
 60 |         Values:
 61 |             ANCESTOR_MODE_UNSPECIFIED (0):
 62 |                 The ancestor mode is unspecified.
 63 |             NONE (1):
 64 |                 Do not include the entity's ancestors in the
 65 |                 index.
 66 |             ALL_ANCESTORS (2):
 67 |                 Include all the entity's ancestors in the
 68 |                 index.
 69 |         """
 70 |         ANCESTOR_MODE_UNSPECIFIED = 0
 71 |         NONE = 1
 72 |         ALL_ANCESTORS = 2
 73 | 
 74 |     class Direction(proto.Enum):
 75 |         r"""The direction determines how a property is indexed.
 76 | 
 77 |         Values:
 78 |             DIRECTION_UNSPECIFIED (0):
 79 |                 The direction is unspecified.
 80 |             ASCENDING (1):
 81 |                 The property's values are indexed so as to
 82 |                 support sequencing in ascending order and also
 83 |                 query by <, >, <=, >=, and =.
 84 |             DESCENDING (2):
 85 |                 The property's values are indexed so as to
 86 |                 support sequencing in descending order and also
 87 |                 query by <, >, <=, >=, and =.
 88 |         """
 89 |         DIRECTION_UNSPECIFIED = 0
 90 |         ASCENDING = 1
 91 |         DESCENDING = 2
 92 | 
 93 |     class State(proto.Enum):
 94 |         r"""The possible set of states of an index.
 95 | 
 96 |         Values:
 97 |             STATE_UNSPECIFIED (0):
 98 |                 The state is unspecified.
 99 |             CREATING (1):
100 |                 The index is being created, and cannot be
101 |                 used by queries. There is an active long-running
102 |                 operation for the index. The index is updated
103 |                 when writing an entity.
104 |                 Some index data may exist.
105 |             READY (2):
106 |                 The index is ready to be used.
107 |                 The index is updated when writing an entity.
108 |                 The index is fully populated from all stored
109 |                 entities it applies to.
110 |             DELETING (3):
111 |                 The index is being deleted, and cannot be
112 |                 used by queries. There is an active long-running
113 |                 operation for the index. The index is not
114 |                 updated when writing an entity. Some index data
115 |                 may exist.
116 |             ERROR (4):
117 |                 The index was being created or deleted, but
118 |                 something went wrong. The index cannot by used
119 |                 by queries. There is no active long-running
120 |                 operation for the index, and the most recently
121 |                 finished long-running operation failed. The
122 |                 index is not updated when writing an entity.
123 |                 Some index data may exist.
124 |         """
125 |         STATE_UNSPECIFIED = 0
126 |         CREATING = 1
127 |         READY = 2
128 |         DELETING = 3
129 |         ERROR = 4
130 | 
131 |     class IndexedProperty(proto.Message):
132 |         r"""A property of an index.
133 | 
134 |         Attributes:
135 |             name (str):
136 |                 Required. The property name to index.
137 |             direction (google.cloud.datastore_admin_v1.types.Index.Direction):
138 |                 Required. The indexed property's direction. Must not be
139 |                 DIRECTION_UNSPECIFIED.
140 |         """
141 | 
142 |         name: str = proto.Field(
143 |             proto.STRING,
144 |             number=1,
145 |         )
146 |         direction: "Index.Direction" = proto.Field(
147 |             proto.ENUM,
148 |             number=2,
149 |             enum="Index.Direction",
150 |         )
151 | 
152 |     project_id: str = proto.Field(
153 |         proto.STRING,
154 |         number=1,
155 |     )
156 |     index_id: str = proto.Field(
157 |         proto.STRING,
158 |         number=3,
159 |     )
160 |     kind: str = proto.Field(
161 |         proto.STRING,
162 |         number=4,
163 |     )
164 |     ancestor: AncestorMode = proto.Field(
165 |         proto.ENUM,
166 |         number=5,
167 |         enum=AncestorMode,
168 |     )
169 |     properties: MutableSequence[IndexedProperty] = proto.RepeatedField(
170 |         proto.MESSAGE,
171 |         number=6,
172 |         message=IndexedProperty,
173 |     )
174 |     state: State = proto.Field(
175 |         proto.ENUM,
176 |         number=7,
177 |         enum=State,
178 |     )
179 | 
180 | 
181 | __all__ = tuple(sorted(__protobuf__.manifest))
182 | 


--------------------------------------------------------------------------------