Changelog

PyPI History

2.18.0 (2024-08-26)

Features

• Support returning computed distance and set distance thresholds on VectorQueries ( #960 ) ( 5c2192d )

Bug Fixes

• Remove custom retry loop ( #948 ) ( 04bb206 )

2.17.2 (2024-08-13)

Bug Fixes

• Allow protobuf 5.x; require protobuf >=3.20.2 ( #950 ) ( 6f86506 )

• Support async vector search from a collection ( #949 ) ( 6446e29 )

2.17.1 (2024-08-09)

Bug Fixes

• Allow protobuf 5.x ( #919 ) ( 3a13bf9 )

2.17.0 (2024-07-12)

Features

• Support async Vector Search ( #901 ) ( 2de1620 )

• Use generator for stream results ( #926 ) ( 3e5df35 )

2.16.1 (2024-04-17)

Bug Fixes

• reprmethod in vector.py ( #903 ) ( 6886f2b )

Documentation

• Allow 14 week backup retention for Firestore daily backups ( #899 ) ( 9521ded )

2.16.0 (2024-04-02)

Features

• A new message Backup is added ( fc7b906 )

• A new message BackupSchedule is added ( fc7b906 )

• A new message CreateBackupScheduleRequest is added ( fc7b906 )

• A new message DailyRecurrence is added ( fc7b906 )

• A new message DeleteBackupRequest is added ( fc7b906 )

• A new message DeleteBackupScheduleRequest is added ( fc7b906 )

• A new message GetBackupRequest is added ( fc7b906 )

• A new message GetBackupScheduleRequest is added ( fc7b906 )

• A new message ListBackupSchedulesRequest is added ( fc7b906 )

• A new message ListBackupSchedulesResponse is added ( fc7b906 )

• A new message ListBackupsRequest is added ( fc7b906 )

• A new message ListBackupsResponse is added ( fc7b906 )

• A new message RestoreDatabaseMetadata is added ( fc7b906 )

• A new message RestoreDatabaseRequest is added ( fc7b906 )

• A new message UpdateBackupScheduleRequest is added ( fc7b906 )

• A new message WeeklyRecurrence is added ( fc7b906 )

• A new method CreateBackupSchedule is added to service FirestoreAdmin ( fc7b906 )

• A new method DeleteBackup is added to service FirestoreAdmin ( fc7b906 )

• A new method DeleteBackupSchedule is added to service FirestoreAdmin ( fc7b906 )

• A new method GetBackup is added to service FirestoreAdmin ( fc7b906 )

• A new method GetBackupSchedule is added to service FirestoreAdmin ( fc7b906 )

• A new method ListBackups is added to service FirestoreAdmin ( fc7b906 )

• A new method ListBackupSchedules is added to service FirestoreAdmin ( fc7b906 )

• A new method RestoreDatabase is added to service FirestoreAdmin ( fc7b906 )

• A new method UpdateBackupSchedule is added to service FirestoreAdmin ( fc7b906 )

• A new resource_definition firestore.googleapis.com/Backup is added ( fc7b906 )

• A new resource_definition firestore.googleapis.com/BackupSchedule is added ( fc7b906 )

• Add ExplainMetrics field to RunAggregationQueryResponse ( fc7b906 )

• Add ExplainMetrics field to RunQueryResponse ( fc7b906 )

• Add ExplainOptions field to RunAggregationQueryRequest ( fc7b906 )

• Add ExplainOptions field to RunQueryRequest ( fc7b906 )

• Add new types ExplainOptions, ExplainMetrics, PlanSummary, ExecutionStats ( fc7b906 )

• Add Vector Index API ( #894 ) ( c76f087 )

• Add VectorSearch API ( fc7b906 )

• Support Vector Search ( #896 ) ( 08fcaaf )

Bug Fixes

• Add google-auth as a direct dependency ( #875 ) ( ae5ba71 )

Documentation

• Correct BackupSchedule recurrence docs that mentioned specific time of day ( #898 ) ( a8ed3ea )

• Fix docs structure for Firestore ( #868 ) ( 8ddb859 )

2.15.0 (2024-02-20)

Features

• Add DeleteDatabase API and delete protection ( 18f61c2 )

Bug Fixes

• Find emulator project id from environment variable ( afd16e1 )

Documentation

• Fix formatting due to unclosed backtick ( 18f61c2 )

• Improve the documentation on Document.fields ( #831 ) ( 19a55bd )

• Update Database API description ( 18f61c2 )

2.14.0 (2023-12-13)

Features

• Add support for Python 3.12 ( #795 ) ( b301f8b )

• Expose Firestore namespace ID fields in import/export APIs to stable ( 3a624a9 )

• Expose Firestore PITR fields in Database to stable ( 3a624a9 )

• Expose Firestore snapshot_time field in export API to stable ( 3a624a9 )

• Introduce compatibility with native namespace packages ( #792 ) ( 510adce )

• SERVER_TIMESTAMP should survive deep copies ( #820 ) ( #821 ) ( 2b17705 )

Bug Fixes

• Remove used of deprecated datetime.datetime.utcnow() and datetime.utcfromtimestamp() ( 4a74d71 )

• Use retry_async instead of retry in async client ( cae9e46 )

Documentation

• Assorted typo fixes and whitespace updates ( 3a624a9 )

• Deprecate google.cloud.firestore_v1.rate_limiter.utcnow ( 4a74d71 )

2.13.1 (2023-11-06)

Bug Fixes

• Order normalization with descending query ( #788 ) ( dbe8ef7 )

2.13.0 (2023-10-23)

Features

• Sum/Avg aggregation queries ( #715 ) ( 443475b )

Bug Fixes

• Ensure transactions rollback on failure ( #767 ) ( cdaf25b )

• Improve AsyncQuery typing ( #782 ) ( ae1247b )

Documentation

• Minor formatting ( 41b5ea0 )

2.12.0 (2023-08-07)

Features

• Add ApiScope and COLLECTION_RECURSIVE query_scope for Firestore index ( #718 ) ( d8de142 )

• Add bloom filter related proto fields ( #710 ) ( 26ac1cf )

• Add CreateDatabase API ( #724 ) ( 64e4404 )

• Multi db test parametrization ( #717 ) ( 91fc8bb )

• Publish proto definitions for SUM/AVG in Firestore ( #746 ) ( ccadec5 )

Bug Fixes

• Add async context manager return types ( #732 ) ( 2d42731 )

Documentation

• Minor formatting and grammar ( eb4fe8e )

2.11.1 (2023-04-26)

Bug Fixes

• Expose Count, FieldFilter, Or, and And to firestore module ( #706 ) ( 8eb2c88 )

2.11.0 (2023-04-03)

Features

• OR Query implementation ( #698 ) ( 44dd5d6 )

2.10.1 (2023-03-23)

Documentation

• Fix formatting of request arg in docstring ( #700 ) ( 7b09f16 )

2.10.0 (2023-02-21)

Features

• Add OR query support ( #689 ) ( 22af4d7 )

Bug Fixes

• Ordering in limit_to_last ( #692 ) ( cc9dfb3 ), closes #536

• Type hinting in collection.py ( #688 ) ( bfb97c2 )

2.9.1 (2023-01-20)

Bug Fixes

• Add context manager return types ( 5924bdc )

Documentation

• Add documentation for enums ( 5924bdc )

2.9.0 (2023-01-12)

Features

• Support the Count aggregation query ( #673 ) ( dfd4c5d )

2.8.0 (2023-01-10)

Features

• Add support for python 3.11 ( #675 ) ( 2030a9f )

2.7.3 (2022-12-08)

Bug Fixes

• deps:Require google-api-core >=1.34.0, >=2.11.0 ( 626710f )

• Drop usage of pkg_resources ( 626710f )

• Fix timeout default values ( 626710f )

• Fix typehint on AsyncDocumentReference.get() ( #649 ) ( a8d79c8 )

Documentation

• async_client:Fix typo in get_mtls_endpoint_and_cert_source doc ( #662 ) ( b431b4a )

• samples:Snippetgen should call await on the operation coroutine before calling result ( 626710f )

2.7.2 (2022-10-10)

Bug Fixes

• deps:Allow protobuf 3.19.5 ( #648 ) ( 9ffbd75 )

2.7.1 (2022-09-29)

Bug Fixes

• deps:Require protobuf >= 3.20.2 ( #644 ) ( dd7d10b )

2.7.0 (2022-09-13)

Features

• add firestore aggregation query apis to the stable googleapis branch ( f25fd82 )

2.6.1 (2022-08-11)

Bug Fixes

• deps:allow protobuf < 5.0.0 ( #624 ) ( 4baf837 )

• deps:require proto-plus >= 1.22.0 ( 4baf837 )

2.6.0 (2022-07-15)

Features

• add audience parameter ( 40dce54 )

Bug Fixes

• deps:require google-api-core>=1.32.0,>=2.8.0 ( #607 ) ( 40dce54 )

• require python 3.7+ ( #613 ) ( 19accae )

2.5.3 (2022-06-02)

Documentation

• fix changelog header to consistent size ( #597 ) ( 0aca503 )

2.5.2 (2022-06-01)

Bug Fixes

• deps:require protobuf <4.0.0dev ( #598 ) ( 1796592 )

2.5.1 (2022-05-30)

Bug Fixes

• bulk_writer default assignment ( #565 ) ( 843c278 )

• deps:Require proto-plus >=1.20.5 ( #593 ) ( 2281290 ), closes #592

2.5.0 (2022-05-05)

Features

• Enable RunQueryResponse.done ( #572 ) ( 3ec13da )

Documentation

• clarifications for filters ( 4d054b0 )

• fix type in docstring for map fields ( 4d054b0 )

2.4.0 (2022-03-08)

Features

• add api key support ( #523 ) ( 31c943e )

• add context manager support in client ( #470 ) ( 1e1de20 )

• add support for Python 3.10 ( #469 ) ( ddcb099 )

• allow ‘Collection.where( name, in, [hello, world])’ ( #501 ) ( 7d71244 )

• update client libraries to support Database operations ( #513 ) ( 74d8171 )

Bug Fixes

• deps:drop packaging dependency ( 6b5a779 )

• deps:require google-api-core >= 1.28.0 ( 6b5a779 )

• deps:require google-api-core>=1.31.5, >=2.3.2 ( #543 ) ( c214732 )

• fix license text in the unit test ( #535 ) ( 3f1fd36 )

• handle empty last chunk correctly in ‘Query._chunkify’ ( #489 ) ( 3ddc718 )

• hash snapshots using correct type for ‘update_time’ ( #467 ) ( 5e66a73 )

• resolve DuplicateCredentialArgs error when using credentials_file ( 77b9082 )

• stop / start stream after filter mismatch ( #502 ) ( a256752 )

Documentation

• add generated snippets ( #532 ) ( aea2af9 )

• clarify docstring in RunQueryRequest/RunQueryResponse ( #544 ) ( d17febb )

• list oneofs in docstring ( 6b5a779 )

2.3.4 (2021-09-30)

Bug Fixes

• improper types in pagers generation ( 4434415 )

2.3.3 (2021-09-24)

Bug Fixes

• add ‘dict’ annotation type to ‘request’ ( 32bc180 )

• harden ‘query.stream’ against retriable exceptions ( #456 ) ( 0dca32f )

• unbreak query orders w/ non-orderable operators ( #453 ) ( 2dbbba0 )

Performance Improvements

• strip proto wrappers in ‘ helpers.decode {value,dict}’ ( #458 ) ( 335e2c4 )

2.3.2 (2021-09-09)

Bug Fixes

• treat None cursors as a no-op. ( #440 ) ( e7aed0f )

2.3.1 (2021-08-30)

Bug Fixes

• harden lookup of credentials id_token attribute ( #434 ) ( e28272a )

2.3.0 (2021-08-18)

Features

• add bulk writer ( #396 ) ( 98a7753 )

• add recursive delete ( #420 ) ( 813a57b )

• add support for recursive queries ( #407 ) ( eb45a36 )

Bug Fixes

• enable self signed jwt for grpc ( #405 ) ( 8703b48 )

• use insecure grpc channels with emulator ( #402 ) ( 4381ad5 )

• remove unused requirement pytz ( #422 ) ( 539c1d7 )

Documentation

• added generated docs for Bundles ( #416 ) ( 0176cc7 )

• fixed broken links to devsite ( #417 ) ( 1adfc81 )

2.2.0 (2021-07-22)

Features

• add always_use_jwt_access ( #380 ) ( 2ef4194 )

Bug Fixes

• disable always_use_jwt_access ( #385 ) ( 13753e2 )

• reseed RNG for each auto id on 3.6 to avoid collisions ( #388 ) ( 784e8ae )

• update type hint for async_collection.document() ( #370 ) ( ee6a1c2 )

Documentation

• omit mention of Python 2.7 in CONTRIBUTING.rst ( #377 ) ( 23ec468 )

• add “Samples” section to CONTRIBUTING.rst ( #401 ) ( 0f9184d )

2.1.3 (2021-06-15)

Bug Fixes

• add ‘packaging’ dependency ( #372 ) ( 9623a51 ), closes #371

2.1.2 (2021-06-14)

Documentation

• fix broken links in multiprocessing.rst ( #360 ) ( 6e2c899 )

2.1.1 (2021-05-03)

Bug Fixes

• Allow underspecifying a cursor ( #340 ) ( abe9e8a )

• bump minimum versions for google-api-core and proto-plus ( #334 ) ( 08554dc )

2.1.0 (2021-03-30)

Features

• add firestore bundles ( #319 ) ( c54de50 )

• adds synthed bundle protos ( #325 ) ( 8fdf2a8 )

• support using client credentials with emulator ( #269 ) ( dffc580 )

Bug Fixes

• limit data transferred as part of list_documents as we don’t require field data ( #280 ) ( 0386bc4 )

• patch emulator channel to be created accordingly ( #288 ) ( 1a973f3 )

• remove client recv msg limit fix: add enums to types/__init__.py ( #274 ) ( 2b47c00 )

• use correct retry deadline ( #331 ) ( f9586d4 )

• use correct type hint for ‘*path’ args ( #300 ) ( 15b579f )

Documentation

• add documentation for documentsnapshot class ( #263 ) ( 448c965 )

• clarify semantics of ‘merge’ argument to ‘Document.set’ ( #278 ) ( 29c6374 ), closes #277

• trailing whitespace ( #310 ) ( b8192f0 )

• update intersphinx for grpc and auth ( #261 ) ( 1bbd3a0 )

2.0.2 (2020-12-05)

Bug Fixes

• request and flattened params are exclusive, surface transport in generated layer ( #256 ) ( 386e85e ), closes #251 #252

2.0.1 (2020-11-12)

Bug Fixes

• use an insecure channel under emulation ( #254 ) ( 801f827 ), closes #250

Documentation

• update code of conduct ( #253 ) ( 3702dc8 )

2.0.0 (2020-11-06)

⚠ BREAKING CHANGES

• remove support for Python 2.7

• remove v1beta1 surface for v2 (#96)

• Begin using new microgenerator for v2 firestore (#91)

• from firestore-0.30.0 : revert to merge not being an option;

Features

• add client_options to base client class ( #150 ) ( f3bedc1 )

• add inline type hints and pytype ci ( #134 ) ( afff842 )

• add retry/timeout to manual surface ( #222 ) ( db5f286 ), closes #221

• add support for not-in and not-eq query operators ( #202 ) ( 1d09f21 )

• add type hints for method params ( #182 ) ( 9b6c2f3 )

• asyncio microgen batch ( #122 ) ( a4e5b00 )

• asyncio microgen client ( #118 ) ( de4cc44 )

• asyncio microgen collection ( #119 ) ( 6281a67 )

• asyncio microgen document ( #121 ) ( 31faecb )

• asyncio microgen query ( #127 ) ( 178fa2c )

• asyncio microgen transaction ( #123 ) ( 35185a8 )

• asyncio system tests ( #132 ) ( 4256a85 )

• Begin using new microgenerator for v2 firestore ( #91 ) ( e0add08 )

• create async interface ( #61 ) ( eaba25e )

• Create CODEOWNERS ( #40 ) ( a0cbf40 )

• improve type information ( #176 ) ( 30bb3fb )

• integrate limit to last ( #145 ) ( 55da695 ), closes #57

• partition queries ( #210 ) ( 4f75a75 )

• remove v1beta1 surface for v2 ( #96 ) ( b4a8eb9 )

• use ‘update_transforms’ ( #219 ) ( c122e41 ), closes #217

• use DatetimeWithNanoseconds throughout library ( #116 ) ( 1801ba2 )

• firestore:add IN , ARRAY_CONTAINS_ANY operators; update docstrings (via synth) ( #9439 ) ( 107e526 )

• firestore:add v1beta1 deprecation annotation ( #34 ) ( b9e2ab5 )

• firestore:surface new ‘IN’ and ‘ARRAY_CONTAINS_ANY’ operators ( #9541 ) ( 5e9fe4f )

Bug Fixes

• add import message via synth ( #231 ) ( 5fb02e9 ), closes #227 #228 #229

• add mocks to query get tests ( #109 ) ( c4c5bfa )

• async_document docs to match expected usecase ( #129 ) ( f26f222 )

• asyncio microgen client get_all type ( #126 ) ( 9095368 )

• await on to_wrap in AsyncTransactional ( #147 ) ( e640e66 )

• constructor invalid path tests ( #114 ) ( edf7bd1 )

• coverage to 99p ( 8ddfe1d )

• harden version data gathering against DistributionNotFound ( #212 ) ( 20b7260 )

• name parameter to indicate snapshot support ( #169 ) ( be98897 ), closes #56

• pytype client errors ( #146 ) ( eb19712 )

• recover watch stream on more error types ( #9995 ) ( af5fd1d ), closes #L817

• remove six dependency ( #110 ) ( 6e597f2 )

• remove six dependency ( #120 ) ( d82687d )

• remove six dependency ( #98 ) ( b264ccb ), closes #94

• remove unnecessary dependency on libcst ( #220 ) ( cd358db )

• Support more Python sequence types when encoding to Protobuf ( #21 ) ( b1c5987 )

• type hint improvements ( #144 ) ( d30fff8 )

• firestore:fix get and getall method of transaction ( #16 ) ( de3aca0 )

• firestore:fix lint ( #48 ) ( 7fa00c4 )

• respect transform values passed into collection.add ( #7072 ) ( c643d91 ), closes #6826

• update resume token for restarting BiDi streams ( #10282 ) ( 61ec5a2 )

• Update team to be in correct org ( #43 ) ( bef5a3a )

• firestore:simplify ‘Collection.add’, avoid spurious API call ( #9634 ) ( 20f093e ), closes #9629

Reverts

• Revert “Replace relative class refs with fully-qualifed names. (#8039)” (#8095) ( 2441825 ), closes #8039 #8095

• Revert “Do not use easily-misread glyphs in Firestore auto-IDs.” (#4589) ( bbfd2ff ), closes #4589 #4588 #4583 #4107

• Refactor conformance tests. (#6291) ( 4d29c1f ), closes #6291 #6290

Documentation

• add python 2 sunset banner to documentation ( #9036 ) ( 819d154 )

• add upgrading section to index of documentation ( #248 ) ( 55d1356 )

• adds UPGRADING.md, note to readme, to help inform users about migration to v2 ( #245 ) ( 6a8cbdd )

• document admin client ( #174 ) ( f099736 ), closes #30

• fix intersphinx reference to requests ( #9294 ) ( e859f3c )

• fix typo in watch documentation ( #115 ) ( 367ac73 )

• normalize use of support level badges ( #6159 ) ( 6c9f1ac )

• re-add changelog entries lost in V2 switch ( #178 ) ( d4a0f81 ), closes #177

• firestore:add documentation for Document,Collection .on_snapshot ( #9275 ) ( f250443 )

• firestore:add new where operators to docstring ( #9789 ) ( c3864f7 )

• firestore:clarify client threadsafety ( #9254 ) ( 4963eee )

• firestore:remove duplicated word in README ( #9297 ) ( 250024c )

• firestore:standardize use of ‘required’ and ‘optional’ in docstrings; add py2 deprecation warning; add 3.8 unit tests (via synth) ( #10068 ) ( 0f72f2c )

• Remove CI for gh-pages, use googleapis.dev for api_core refs. ( #9085 ) ( c7b3de8 )

• Replace links to ‘/stable/’ with ‘/latest/’. ( #5901 ) ( e2f606e ), closes #5894

2.0.0-dev2 (2020-10-26)

⚠ BREAKING CHANGES

• remove v1beta1 surface for v2 (#96)

• Begin using new microgenerator for v2 firestore (#91)

• from firestore-0.30.0 : revert to merge not being an option;

Features

• add retry / timeout to manual surface ( #222 ) ( db5f286 ), closes #221

• add support for not-in and not-eq query operators ( #202 ) ( 1d09f21 )

• add type hints for method params ( #182 ) ( 9b6c2f3 )

• improve type information ( #176 ) ( 30bb3fb )

• add support for partition queries ( #210 ) ( 4f75a75 )

• use update_transforms for mutations ( #219 ) ( c122e41 ), closes #217

Bug Fixes

• add import message via synth ( #231 ) ( 5fb02e9 ), closes #227 #228 #229

• harden version data gathering against DistributionNotFound ( #212 ) ( 20b7260 )

• name parameter to indicate snapshot support ( #169 ) ( be98897 ), closes #56

• remove unnecessary dependency on libcst ( #220 ) ( cd358db )

Documentation

• document admin client ( #174 ) ( f099736 ), closes #30

• re-add changelog entries lost in V2 switch ( #178 ) ( d4a0f81 ), closes #177

2.0.0-dev1 (2020-08-20)

⚠ BREAKING CHANGES

• remove v1beta1 surface for v2 (#96)

• Begin using new microgenerator for v2 firestore (#91)

• from firestore-0.30.0 : revert to merge not being an option;

Features

• asyncio microgen collection ( #119 ) ( 6281a67 )

• firestore:add IN , ARRAY_CONTAINS_ANY operators; update docstrings (via synth) ( #9439 ) ( 107e526 )

• add client_options to base client class ( #150 ) ( f3bedc1 )

• add inline type hints and pytype ci ( #134 ) ( afff842 )

• asyncio microgen batch ( #122 ) ( a4e5b00 )

• asyncio microgen client ( #118 ) ( de4cc44 )

• asyncio microgen document ( #121 ) ( 31faecb )

• asyncio microgen query ( #127 ) ( 178fa2c )

• asyncio microgen transaction ( #123 ) ( 35185a8 )

• firestore:add v1beta1 deprecation annotation ( #34 ) ( b9e2ab5 )

• firestore:surface new ‘IN’ and ‘ARRAY_CONTAINS_ANY’ operators ( #9541 ) ( 5e9fe4f )

• asyncio system tests ( #132 ) ( 4256a85 )

• Begin using new microgenerator for v2 firestore ( #91 ) ( e0add08 )

• create async interface ( #61 ) ( eaba25e )

• Create CODEOWNERS ( #40 ) ( a0cbf40 )

• integrate limit to last ( #145 ) ( 55da695 ), closes #57

• remove v1beta1 surface for v2 ( #96 ) ( b4a8eb9 )

• use DatetimeWithNanoseconds throughout library ( #116 ) ( 1801ba2 )

Bug Fixes

• add mocks to query get tests ( #109 ) ( c4c5bfa )

• async_document docs to match expected usecase ( #129 ) ( f26f222 )

• asyncio microgen client get_all type ( #126 ) ( 9095368 )

• await on to_wrap in AsyncTransactional ( #147 ) ( e640e66 )

• constructor invalid path tests ( #114 ) ( edf7bd1 )

• coverage to 99p ( 8ddfe1d )

• pytype client errors ( #146 ) ( eb19712 )

• recover watch stream on more error types ( #9995 ) ( af5fd1d ), closes #L817

• remove six dependency ( #110 ) ( 6e597f2 )

• remove six dependency ( #120 ) ( d82687d )

• remove six dependency ( #98 ) ( b264ccb ), closes #94

• respect transform values passed into collection.add ( #7072 ) ( c643d91 ), closes #6826

• Support more Python sequence types when encoding to Protobuf ( #21 ) ( b1c5987 )

• type hint improvements ( #144 ) ( d30fff8 )

• update resume token for restarting BiDi streams ( #10282 ) ( 61ec5a2 )

• firestore:fix get and getall method of transaction ( #16 ) ( de3aca0 )

• firestore:fix lint ( #48 ) ( 7fa00c4 )

• firestore:simplify ‘Collection.add’, avoid spurious API call ( #9634 ) ( 20f093e ), closes #9629

• Update team to be in correct org ( #43 ) ( bef5a3a )

Documentation

• add python 2 sunset banner to documentation ( #9036 ) ( 819d154 )

• fix intersphinx reference to requests ( #9294 ) ( e859f3c )

• firestore:clarify client threadsafety ( #9254 ) ( 4963eee )

• fix typo in watch documentation ( #115 ) ( 367ac73 )

• normalize use of support level badges ( #6159 ) ( 6c9f1ac )

• Remove CI for gh-pages, use googleapis.dev for api_core refs. ( #9085 ) ( c7b3de8 )

• Replace links to ‘/stable/’ with ‘/latest/’. ( #5901 ) ( e2f606e ), closes #5894

• firestore:add documentation for Document,Collection .on_snapshot ( #9275 ) ( f250443 )

• firestore:add new where operators to docstring ( #9789 ) ( c3864f7 )

• firestore:remove duplicated word in README ( #9297 ) ( 250024c )

• firestore:standardize use of ‘required’ and ‘optional’ in docstrings; add py2 deprecation warning; add 3.8 unit tests (via synth) ( #10068 ) ( 0f72f2c )

Tests

• Refactor conformance tests. (#6291) ( 4d29c1f ), closes #6291 #6290

1.9.0 (2020-08-13)

Features

• firestore:add client_options to base class ( #148 ) ( 91d6580 )

1.8.1 (2020-07-07)

Bug Fixes

• #82:Add import back to generated client ( #83 ) ( 2d0ee60 ), closes #82

1.8.0 (2020-07-06)

Features

• support limit to last feature ( #57 ) ( 8c75e21 )

• firestore:add support of emulator to run system tests on emulator ( #31 ) ( 891edc7 )

• firestore:add v1beta1 deprecation annotation ( #34 ) ( b9e2ab5 )

• v1:add batch write ( #62 ) ( 1415bc4 )

Bug Fixes

• Support more Python sequence types when encoding to Protobuf ( #21 ) ( b1c5987 )

• firestore:use specific naming convention ( #58 ) ( c97a168 )

Documentation

• firestore:on_snapshot document changes ( #79 ) ( c556fc5 )

1.7.0 (2020-05-18)

Features

• Create CODEOWNERS ( #40 ) ( a0cbf40 )

Bug Fixes

• firestore:fix get and getall method of transaction ( #16 ) ( de3aca0 )

• Update team to be in correct org ( #43 ) ( bef5a3a )

• firestore:fix lint ( #48 ) ( 7fa00c4 )

1.6.2 (2020-01-31)

Bug Fixes

• update resume token for restarting BiDi streams ( #10282 ) ( 61ec5a2 )

1.6.1

01-02-2020 10:35 PST

Implementation Changes

• Recover watch streams on more error types ( #9995 )

• Simplify ‘Collection.add’ and avoid a spurious API call ( #9634 )

Documentation

• Add new where operators to docstring ( #9789 )

• Change spacing in docs templates (via synth) ( #9750 )

• Add python 2 sunset banner to documentation ( #9036 )

1.6.0

11-06-2019 13:49 PST

New Features

• Surface new ‘IN’ and ‘ARRAY_CONTAINS_ANY’ query operators. ( #9541 )

1.5.0

10-15-2019 06:45 PDT

Implementation Changes

• Expand dotted keys in mappings used as cursors. ( #8568 )

• Tweak GAPIC client configuration (via synth). ( #9173 )

New Features

• Add IN , ARRAY_CONTAINS_ANY operators; update docstrings (via synth). ( #9439 )

• Add COLLECTION_GROUP to Index.QueryScope enum; update docstrings (via synth). ( #9253 )

• Add client_options to v1 client. ( #9048 )

Dependencies

• Pin ‘google-cloud-core >= 1.0.3, < 2.0.0dev’. ( #9445 )

Documentation

• Update README example to use non-deprecated query.get . ( #9235 )

• Remove duplicated word in README. ( #9297 )

• Fix intersphinx reference to requests . ( #9294 )

• Remove CI for gh-pages, use googleapis.dev for api_core refs . ( #9085 )

• Add license file. ( #9109 )

• Fix reference to library name ( #9047 )

• Remove compatability badges from READMEs. ( #9035 )

1.4.0

08-06-2019 11:43 PDT

New Features

• Support emulator in client. ( #8721 )

• Add GAPIC client for Admin V1. ( #8667 )

• Add Transaction.get / Transaction.get_all . ( #8628 )

Implementation Changes

• Remove send/recv msg size limit (via synth). ( #8955 )

• Deprecate v1beta1 API / client. ( #8886 )

• Allow snapshot cursors from other collections for collection group queries. ( #8882 )

• Fix sorting delete_changes in Watch._compute_snapshot . ( #8809 )

• Treat None as EOF in Watch.on_snapshot . ( #8687 )

• Fix V1 Client.collections method. ( #8718 )

• Avoid adding prefix to update mask for transforms used in update . ( #8701 )

• Add should_terminate predicate for clean BiDi shutdown. ( #8650 )

Dependencies

• Bump minimum version for google-api-core to 1.14.0. ( #8709 )

Documentation

• Update intersphinx mapping for requests. ( #8805 )

• Link to googleapis.dev documentation in READMEs. ( #8705 )

• Add compatibility check badges to READMEs. ( #8288 )

Internal / Testing Changes

• Preserve manual change in noxfile (run systests verbosely). ( #8744 )

• Update V1 conformance tests to match new repo / format. ( #8689 )

• Improve cleanups for watch system tests. ( #8638 )

• Avoid sharing top-level collection across test cases / CI runs. ( #8637 )

1.3.0

07-09-2019 13:19 PDT

Implementation Changes

• Add missing transforms to ‘google.cloud.firestore’ shim. ( #8481 )

• Preserve reference to missing documents in ‘Client.get_all’. ( #8472 )

• Add gRPC keepalive to gapic client initialization. ( #8264 )

• Add disclaimer to auto-generated template files. ( #8314 )

• Use correct environment variable to guard the ‘system’ part. ( #7912 )

New Features

• Add ‘client_options’ support, update list method docstrings (via synth). ( #8509 )

• Allow kwargs to be passed to create_channel (via synth). ( #8390 )

• Add ‘FieldPath.documentId()’. ( #8543 )

Documentation

• Fix docstring example for ‘Client.collection_group’. ( #8438 )

• Normalize docstring class refs. ( #8102 )

Internal / Testing Changes

• Pin black version (via synth). ( #8583 )

• All: Add docs job to publish to googleapis.dev. ( #8464 )

• Declare encoding as utf-8 in pb2 files (via synth). ( #8352 )

• Suppress checking ‘cov-fail-under’ in nox default session (via synth). ( #8241 )

• Blacken noxfile.py, setup.py (via synth). ( #8123 )

• Add empty lines (via synth). ( #8058 )

1.2.0

05-16-2019 12:25 PDT

New Features

• Add support for numeric transforms: increment / maximum / minimum . ( #7989 )

• Add client_info support to V1 client. ( #7877 ) and ( #7898 )

Dependencies

• Pin google-cloud-core >= 1.0.0, < 2.0dev . ( #7993 )

Internal / Testing Changes

• Add nox session docs , add routing header to method metadata, reorder methods (via synth).. ( #7771 )

1.1.0

04-30-2019 12:29 PDT

New Features

• Add support for CollectionGroup queries. ( #7758 )

1.0.0

04-30-2019 10:00 PDT

Implementation Changes

• Use parent path for watch on queries. ( #7752 )

• Add routing header to method metadata (via synth). ( #7749 )

0.32.1

04-05-2019 10:51 PDT

Dependencies

• Update google-api-core dependency

0.32.0

04-01-2019 11:44 PDT

Implementation Changes

• Allow passing metadata as part of creating a bidi ( #7514 )

• Remove classifier for Python 3.4 for end-of-life. ( #7535 )

• Rename ‘Query.get’ -> ‘stream’. ( #7284 )

• Remove bogus error checking of query response stream. ( #7206 ) -’increment’ / ‘minimum’ / ‘maximum’ field transform attributes. ( #7129 )

• Respect transform values passed into collection.add ( #7072 )

• Protoc-generated serialization update. ( #7083 )

New Features

• Firestore: Add v1 API version. ( #7494 )

• Add ‘Collection.list_documents’ method. ( #7221 )

• Add ‘DocumentReference.path’ property. ( #7219 )

Documentation

• Updated client library documentation URLs. ( #7307 )

• Fix the docstring example for ‘Query.on_snapshot’. ( #7281 )

• Update copyright headers

Internal / Testing Changes

• Fix typo in proto comments (via synth).

• Prep firestore unit tests for generation from ‘v1’ protos. ( #7437 )

• Copy lintified proto files (via synth). ( #7466 )

• Add clarifying comment to blacken nox target. ( #7392 )

• Add protos as an artifact to library ( #7205 )

0.31.0

12-18-2018 11:20 PST

Implementation Changes

• Implement equality semantics for public types ( #6916 )

• Pick up stub docstring fix in GAPIC generator. ( #6988 )

• Use ‘DatetimeWithNanos’ for converting timestamp messages. ( #6920 )

• Enable use of ‘WriteBatch’ as a context manager. ( #6912 )

• Document timeouts for ‘Query.get’ / ‘Collection.get’. ( #6853 )

• Normalize FieldPath parsing / escaping ( #6904 )

• For queries ordered on __name__ , expand field values to full paths. ( #6829 )

• Import iam.policy from google.api_core . ( #6741 )

• Prevent use of transforms as values passed to ‘Query.where’. ( #6703 )

• ‘Query.select([])’ implies __name__ . ( #6735 )

• Reject invalid paths passed to ‘Query.{select,where,order_by}’ ( #6770 )

• Prevent use of transforms as cursor values. ( #6706 )

• Refactor ‘Document.get’ to use the ‘GetDocument’ API. ( #6534 )

• Pick up enum fixes in the GAPIC generator. ( #6612 )

• Pick up changes to GAPIC client config. ( #6589 )

• Suppress deprecation warnings for ‘assertRaisesRegexp’. ( #6543 )

• Firestore: pick up fixes to GAPIC generator. ( #6523 )

• Fix client_info bug, update docstrings. ( #6412 )

• Block calling ‘DocumentRef.get()’ with a single string. ( #6270 )

New Features

• Impose required semantics for snapshots as cursors: ( #6837 )

• Make cursor-related ‘Query’ methods accept lists ( #6697 )

• Add ‘Client.collections’ method. ( #6650 )

• Add support for ‘ArrayRemove’ / ‘ArrayUnion’ transforms ( #6651 )

• Add support for array_contains query operator. ( #6481 )

• Add Watch Support ( #6191 )

• Remove use of deprecated ‘channel’ argument. ( #6271 )

Dependencies

• Pin ‘google-api_core >= 1.7.0’. ( #6937 )

• Update dependency to google-cloud-core ( #6835 )

• Bump minimum ‘api_core’ version for all GAPIC libs to 1.4.1. ( #6391 )

Documentation

• Document Python 2 deprecation ( #6910 )

• Nnormalize docs for page_size / max_results / page_token . ( #6842 )

• Port changelog from 30.1 branch to main ( #6903 )

• Normalize use of support level badges ( #6159 )

Internal / Testing Changes

• Add driver for listen conformance tests. ( #6935 )

• Add driver for query conformance tests. ( #6839 )

• Update noxfile.

• Blacken libraries ( #6794 )

• Omit local deps ( #6701 )

• Run black at end of synth.py ( #6698 )

• Add templates for flake8, coveragerc, noxfile, and black. ( #6642 )

• Fix delete conformance ( #6559 )

• Add synth metadata. ( #6567 )

• Refactor conformance tests. ( #6291 )

• Import stdlib ABCs from ‘collections.abc’ rather than ‘collections’. ( #6451 )

• Fix path of tests-to-include in MANIFEST.in ( #6381 )

• Fix error from new flake8 version. ( #6320 )

0.30.1

12-11-2018 10:49 PDT

Dependencies

• Update core and api_core dependencies to latest versions.

0.30.0

10-15-2018 09:04 PDT

New Features

• Add Document.collections method. ( #5613 )

• Add merge as an option to DocumentReference.set() ( #4851 )

• Return emtpy snapshot instead of raising NotFound exception ( #5007 )

• Add Field path class ( #4392 )

Implementation Changes

• Avoid overwriting __module__ of messages from shared modules. ( #5364 )

• Don’t omit originally-empty map values when processing timestamps. ( #6050 )

Documentation

• Prep docs for repo split. ( #6000 )

• Docs: Replace links to /stable/ with /latest/ . ( #5901 )

• Document FieldPath.from_string ( #5121 )

Internal / Testing Changes

• Use new Nox ( #6175 )

• Add new conformance tests. ( #6124 )

• Add synth.py . ( #6079 )

• Test document update w/ integer ids ( #5895 )

• Nox: use inplace installs ( #5865 )

• Re-sync with .proto / .textproto files from google-cloud-common. ( #5351 )

• Modify system tests to use prerelease versions of grpcio ( #5304 )

• Add test runs for Python 3.7 and remove 3.4 ( #5295 )

• Fix over-long line. ( #5129 )

• Distinguish FieldPath classes from field path strings ( #4466 )

• Fix bad trove classifier

• Cleanup FieldPath ( #4996 )

• Fix typo in Document.collections docstring. ( #5669 )

• Implement FieldPath.__add__ ( #5149 )

0.29.0

New features

• All non-simple field names are converted into unicode (#4859)

Implementation changes

• The underlying generated code has been re-generated to pick up new features and bugfixes. (#4916)

• The Admin API interface has been temporarily removed.

Dependencies

• Update dependency range for api-core to include v1.0.0 releases (#4944)

• The minimum version for google-api-core has been updated to version 1.0.0. This may cause some incompatibility with older google-cloud libraries, you will need to update those libraries if you have a dependency conflict. (#4944, #4946)

Documentation

• Fixing “Fore” -> “For” typo in README docs. (#4317)

Testing and internal changes

• Install local dependencies when running lint (#4936)

• Re-enable lint for tests, remove usage of pylint (#4921)

• Normalize all setup.py files (#4909)

• System test fix, changed ALREADY_EXISTS and MISSING_ENTITY to DOCUMENT_EXISTS and MISSING_DOCUMENT and updated wording (#4803)

• Cross-language tests (#4359)

• Fix import column lengths pass 79 (#4464)

• Making a nox -s default session for all packages. (#4324)

• Shorten test names (#4321)

0.28.0

Documentation

• Added link to “Python Development Environment Setup Guide” in project README (#4187, h/t to @michaelawyu)

Dependencies

• Upgrading to google-cloud-core >= 0.28.0 and adding dependency on google-api-core (#4221, #4280)

PyPI: https://pypi.org/project/google-cloud-firestore/0.28.0/