Changelog¶
2.19.0 (2024-09-20)¶
Features¶
2.18.0 (2024-08-26)¶
Features¶
Bug Fixes¶
2.17.2 (2024-08-13)¶
Bug Fixes¶
2.17.1 (2024-08-09)¶
Bug Fixes¶
2.17.0 (2024-07-12)¶
Features¶
2.16.1 (2024-04-17)¶
Bug Fixes¶
Documentation¶
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 serviceFirestoreAdmin
(fc7b906)A new method
DeleteBackup
is added to serviceFirestoreAdmin
(fc7b906)A new method
DeleteBackupSchedule
is added to serviceFirestoreAdmin
(fc7b906)A new method
GetBackup
is added to serviceFirestoreAdmin
(fc7b906)A new method
GetBackupSchedule
is added to serviceFirestoreAdmin
(fc7b906)A new method
ListBackups
is added to serviceFirestoreAdmin
(fc7b906)A new method
ListBackupSchedules
is added to serviceFirestoreAdmin
(fc7b906)A new method
RestoreDatabase
is added to serviceFirestoreAdmin
(fc7b906)A new method
UpdateBackupSchedule
is added to serviceFirestoreAdmin
(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 VectorSearch API (fc7b906)
Bug Fixes¶
Documentation¶
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¶
2.14.0 (2023-12-13)¶
Features¶
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¶
Documentation¶
2.13.1 (2023-11-06)¶
Bug Fixes¶
2.13.0 (2023-10-23)¶
Features¶
Bug Fixes¶
Documentation¶
Minor formatting (41b5ea0)
2.12.0 (2023-08-07)¶
Features¶
Bug Fixes¶
Documentation¶
Minor formatting and grammar (eb4fe8e)
2.11.1 (2023-04-26)¶
Bug Fixes¶
2.11.0 (2023-04-03)¶
Features¶
2.10.1 (2023-03-23)¶
Documentation¶
2.10.0 (2023-02-21)¶
Features¶
Bug Fixes¶
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¶
2.8.0 (2023-01-10)¶
Features¶
2.7.3 (2022-12-08)¶
Bug Fixes¶
Documentation¶
2.7.2 (2022-10-10)¶
Bug Fixes¶
2.7.1 (2022-09-29)¶
Bug Fixes¶
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¶
2.6.0 (2022-07-15)¶
Features¶
add audience parameter (40dce54)
Bug Fixes¶
2.5.3 (2022-06-02)¶
Documentation¶
2.5.2 (2022-06-01)¶
Bug Fixes¶
2.5.1 (2022-05-30)¶
Bug Fixes¶
2.5.0 (2022-05-05)¶
Features¶
Documentation¶
2.4.0 (2022-03-08)¶
Features¶
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)
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)
Documentation¶
2.3.4 (2021-09-30)¶
Bug Fixes¶
improper types in pagers generation (4434415)
2.3.3 (2021-09-24)¶
Bug Fixes¶
Performance Improvements¶
2.3.2 (2021-09-09)¶
Bug Fixes¶
2.3.1 (2021-08-30)¶
Bug Fixes¶
2.3.0 (2021-08-18)¶
Features¶
Bug Fixes¶
Documentation¶
2.2.0 (2021-07-22)¶
Features¶
Bug Fixes¶
Documentation¶
2.1.3 (2021-06-15)¶
Bug Fixes¶
2.1.2 (2021-06-14)¶
Documentation¶
2.1.1 (2021-05-03)¶
Bug Fixes¶
2.1.0 (2021-03-30)¶
Features¶
Bug Fixes¶
Documentation¶
2.0.2 (2020-12-05)¶
Bug Fixes¶
2.0.1 (2020-11-12)¶
Bug Fixes¶
Documentation¶
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 retry/timeout to manual surface (#222) (db5f286), closes #221
add support for not-in and not-eq query operators (#202) (1d09f21)
Begin using new microgenerator for v2 firestore (#91) (e0add08)
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
async_document docs to match expected usecase (#129) (f26f222)
coverage to 99p (8ddfe1d)
harden version data gathering against DistributionNotFound (#212) (20b7260)
name parameter to indicate snapshot support (#169) (be98897), closes #56
recover watch stream on more error types (#9995) (af5fd1d), closes #L817
Support more Python sequence types when encoding to Protobuf (#21) (b1c5987)
firestore: fix get and getall method of transaction (#16) (de3aca0)
respect transform values passed into collection.add (#7072) (c643d91), closes #6826
update resume token for restarting BiDi streams (#10282) (61ec5a2)
firestore: simplify ‘Collection.add’, avoid spurious API call (#9634) (20f093e), closes #9629
Reverts¶
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)
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: 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¶
Bug Fixes¶
Documentation¶
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¶
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)
Begin using new microgenerator for v2 firestore (#91) (e0add08)
use
DatetimeWithNanoseconds
throughout library (#116) (1801ba2)
Bug Fixes¶
async_document docs to match expected usecase (#129) (f26f222)
coverage to 99p (8ddfe1d)
recover watch stream on more error types (#9995) (af5fd1d), closes #L817
respect transform values passed into collection.add (#7072) (c643d91), closes #6826
Support more Python sequence types when encoding to Protobuf (#21) (b1c5987)
update resume token for restarting BiDi streams (#10282) (61ec5a2)
firestore: fix get and getall method of transaction (#16) (de3aca0)
firestore: simplify ‘Collection.add’, avoid spurious API call (#9634) (20f093e), closes #9629
Documentation¶
add python 2 sunset banner to documentation (#9036) (819d154)
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¶
1.9.0 (2020-08-13)¶
Features¶
1.8.1 (2020-07-07)¶
Bug Fixes¶
1.8.0 (2020-07-06)¶
Features¶
Bug Fixes¶
Documentation¶
1.7.0 (2020-05-18)¶
Features¶
Bug Fixes¶
1.6.2 (2020-01-31)¶
Bug Fixes¶
1.6.1¶
01-02-2020 10:35 PST
Implementation Changes¶
Documentation¶
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¶
New Features¶
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¶
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
inWatch._compute_snapshot
. (#8809)Treat
None
as EOF inWatch.on_snapshot
. (#8687)Fix V1
Client.collections
method. (#8718)Avoid adding
prefix
to update mask for transforms used inupdate
. (#8701)Add
should_terminate
predicate for clean BiDi shutdown. (#8650)
Dependencies¶
Bump minimum version for google-api-core to 1.14.0. (#8709)
Documentation¶
Internal / Testing Changes¶
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¶
Documentation¶
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¶
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¶
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¶
Documentation¶
Internal / Testing Changes¶
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
fromgoogle.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¶
Documentation¶
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
andapi_core
dependencies to latest versions.
0.30.0¶
10-15-2018 09:04 PDT
New Features¶
Implementation Changes¶
Documentation¶
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 ongoogle-api-core
(#4221, #4280)
PyPI: https://pypi.org/project/google-cloud-firestore/0.28.0/