Skip to content

CHANGELOG.md

Latest commit

 

History

History
178 lines (120 loc) · 5.24 KB

CHANGELOG.md

File metadata and controls

178 lines (120 loc) · 5.24 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.2.8 - 2021-10-26

Fixed

  • Validate special characters in document ID and ensure get_by_id/get_by_doc_id raises ModelNotFoundError in case of such issues. Especially an uneven number of slashes could raise a ValueError. Saving a model can now raise an InvalidDocumentID exception in case the ID is invalid.

0.2.7 - 2021-10-25

Fixed

  • get_by_id/get_by_doc_id with an empty string raises a ModelNotFoundError instead of leaking a google.api_core.exceptions.InvalidArgument exception.

0.2.6 - 2021-09-20

Added

  • Support for subcollections

Fixed

  • Fixing support for _ prefixed document ID attributes

0.2.5 - 2021-08-20

Added

  • Support for customizing the field used to hold the document ID. By subclassing the AsyncBareModel/BareModel it's possible to use any field for the document ID, not just the id, which is used by AsyncModel/Model.

Changed

  • Update grpcio to ^1.39.0 which fixes a problem with emulator support on Windows.
  • Pre-commit hooks for keeping line-endings consistent.

Fixed

  • Incorrect links in CHANGELOG.md

0.2.4 - 2021-05-24

Fixed

  • Allow firedantic to be used with older versions of google-cloud-firestore that works with the firestore emulator on Windows.

0.2.3 - 2021-05-21

Added

  • firedantic.operators with operators as constants to avoid gotchas with filters like not-in and array_contains. Preferable way to build queries is to import firedantic.operators as op and then use op.NOT_IN, op.ARRAY_CONTAINS, op.GTE and so on.

Fixed

  • Fix filter bug affecting array_contains and array_contains_any
  • Update pydantic to ^1.8.2 that fixes CVE-2021-29510

0.2.2 - 2021-04-29

Added

  • Helpers for truncating collections

Changed

  • Make the filter optional for find and find_one

0.2.1 - 2021-03-31

Changed

  • Update google-cloud-firestore to 2.1.0 that supports async with firestore emulator. Using an officially released version of google-cloud-firestore from PyPI will also make it possible to get this release of firedantic uploaded to PyPI.

0.2.0 - 2021-03-29

Added

  • New AsyncModel that supports async and await syntax.

Changed

  • Refactor file structure; models.py no longer exists, so make sure to import Model directly from firedantic: from firedantic import Model
  • Update google-cloud-firestore. The 2.0.2 version has an issue with running in async mode against the emulator, that has been fixed in the git master, but not included in any official release yet. Using the latest master (pinned to the commit hash). In case you are using poetry to install firedantic, please be aware that poetry has an issue with updating from a pypi package to a git commit. The simplest work-around is to after updating firedantic (and thus also google-cloud-firestore) delete the virtualenv and then run poetry install again
  • Update pydantic to 1.8.1 and grpcio to 1.36.1
  • Fixes for Mypy errors and warnings
  • Updated examples in README

0.1.4 - 2020-12-08

Added

  • Model.find to do more complex queries supporting all Firestore operators

0.1.3 - 2020-11-09

Changed

  • Respect model's aliases when saving a model

Added

  • CollectionNotDefined error
  • truncate_collection class method for Model

0.1.2 - 2020-09-21

Changed

  • Update README.md
  • Add imports to root level init
  • Update CHANGELOG.md
  • Bump version

0.1.1 - 2020-09-21

Removed

  • .nvmrc
  • .prettierrc.yaml

Updated

  • README.md with build status badge
  • Only run deploy to PyPi on Python 3.6 environment
  • CHANGELOG.md
  • Bump version

0.1.0 - 2020-09-21

Added

  • Project files
  • CHANGELOG.md

Changed

  • Update README.md
  • Update .gitignore