Skip to main content

Provide basic caching utils for endpoints

Project description

Alpha License: LGPL-3 OCA/web-api Translate me on Weblate Try me on Runboat

Technical module provide basic caching configuration and utils for endpoints.

Table of contents

Usage

Example of usage in an endpoint:

# get the name of the cache
cache_name = endpoint._endpoint_cache_make_name("json")
# check if the cache exists
cached = endpoint._endpoint_cache_get(cache_name)
if cached:
    result = cached
else:
    result = json.dumps(env["my.model"]._get_a_very_expensive_computed_result())
    # cache does not exist, create it
    endpoint._endpoint_cache_store(cache_name, result)

resp = Response(result, content_type="application/json", status=200)
result = dict(response=resp)

Known issues / Roadmap

  • Add cache pre-heating

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Camptocamp

Contributors

Maintainers

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

Current maintainer:

simahawk

This module is part of the OCA/web-api project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

File details

Details for the file odoo14_addon_endpoint_cache-14.0.1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo14_addon_endpoint_cache-14.0.1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 100796e0ae9e1c06cec855e8d276e4348d97969817b202c6e5a1d1ec2296d8e9
MD5 a8dc85e824aa7c8a309c06a967490ae6
BLAKE2b-256 f4d21201f5fb4ca0d0a15fb7d1723fbff0bc8095e4cae84d5096a635fc0e9c3a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page