The 2.0 release of thegoogle-cloud-firestore client is a significant upgrade based on anext-gen code generator, 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.

If you experience issues or have questions, please file anissue.

Supported Python Versions

WARNING: Breaking change

The 2.0.0 release requires Python 3.6+.

Method Calls

WARNING: Breaking change

If you previously were using modules or functions under the namespacegoogle.cloud.firestore_v1.gapic there is a high likelihood you have incompatible code.To assist with this, we have includes some helpful scripts to make some of the codemodifications required to use 2.0.0.

• Install the library

python3 -m pip install google-cloud-firestore

• The scriptsfixup_firestore_v1_keywords.py andfixup_firestore_admin_v1_keywords.pyis shipped with the library. It expects an input directory (with the code to convert)and an empty destination directory.

$ fixup_firestore_v1_keywords.py --input-directory .samples/ --output-directory samples/$ fixup_firestore_admin_v1_keywords.py --input-directory .samples/ --output-directory samples/

More Details

Ingoogle-cloud-firestore<2.0.0, parameters required by the API were positional parameters and optional parameters were keyword parameters.

Before:

    def a_method(        self,        param1,        param2,        param3,        retry=google.api_core.gapic_v1.method.DEFAULT,        timeout=google.api_core.gapic_v1.method.DEFAULT,        metadata=None,    ):

In the 2.0.0 release, all methods have a single positional parameterrequest. Method docstrings indicate whether a parameter is required or optional.

Some methods have additional keyword only parameters. The available parameters depend on thegoogle.api.method_signature annotation specified by the API producer.

After:

    def a_method(        self,        request: RequestType = None,        *        param1,        param2,        param3,        retry=google.api_core.gapic_v1.method.DEFAULT,        timeout=google.api_core.gapic_v1.method.DEFAULT,        metadata=None,    ):

NOTE: Therequest parameter and flattened keyword parameters for the API are mutually exclusive.Passing both will result in an error.

Both of these calls are valid:

response = client.a_method(    request={        "param1": param1,        "param2": param2,        "param3": param3    })

response = client.a_method(    param1=param1,    param2=param2,    param3=param3)

This call is invalid because it mixesrequest with a keyword argumentparam1. Executing this codewill result in an error.

response = client.a_method(    request={        "param1": param1,        "param2": param2    },    param2=param2)

Enums and Types

WARNING: Breaking change

The submodulesenums andtypes have been removed.

Before:

from google.cloud import firestore_v1direction = firestore_v1.enums.StructuredQuery.Direction.ASCENDING

After:

from google.cloud import firestore_v1direction = firestore_v1.types.StructuredQuery.Direction.ASCENDING