Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update limitations about json query support and django version support. #729

Merged
merged 4 commits into from Oct 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 7 additions & 8 deletions README.rst
Expand Up @@ -80,14 +80,13 @@ Windows
Supported versions
~~~~~~~~~~~~~~~~~~

At the moment, this library only supports `Django 2.2
<https://docs.djangoproject.com/en/2.2/>`__. It also requires Python version
3.6 or later.

This package follows a common versioning convention for Django plugins: the
major and minor version components of this package should match the installed
version of Django. That is, ``django-google-spanner~=2.2`` works with
``Django~=2.2``.
The library supports `Django 2.2
<https://docs.djangoproject.com/en/2.2/>`_, and `Django 3.2
<https://docs.djangoproject.com/en/3.2/>`_.
Both versions are long-term support (LTS) releases for the
`Django project<https://www.djangoproject.com/download/#supported-versions>_`.
The minimum required Python version is 3.6.


Installing the package
~~~~~~~~~~~~~~~~~~~~~~
Expand Down
Binary file modified assets/internals.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/overview.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 5 additions & 4 deletions docs/limitations.rst
Expand Up @@ -158,8 +158,9 @@ Example:

More details about this issue can be tracked `here <https://code.djangoproject.com/ticket/33052>`_.

Support for Json field is currently not there
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This library currently does not support json. For more info on json support support follow this `github issue <https://github.com/googleapis/python-spanner-django/issues/707>`_.
Support for query inside JSONfield is currently not there
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We have also added support for JSON object storage and retrieval with Django 3.2.x support in v2.2.1b4 release,
but querying inside the JSONfield is not supported in the current `django-google-spanner` release.
This feature is being worked on and can be tracked `here <https://github.com/googleapis/python-spanner-django/issues/716>`_.