Skip to content

Latest commit

 

History

History
70 lines (54 loc) · 2.08 KB

CACHING.md

File metadata and controls

70 lines (54 loc) · 2.08 KB
Raw

Caching

The EXACT server supports two types of caching in combination with all Django supported caching technologies.

Settings.py or Settings_base.py

By default, EXACT uses the LocMemCache unique-snowflake, but please use a dedicated caching server for optimal performance.

Example for using Redis with Docker

CACHES = {
    "default": {
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "redis://redis:6379/1", # "redis://127.0.0.1:6379/1", 
        "OPTIONS": {
            "MAX_ENTRIES": 1000,
            "CLIENT_CLASS": "django_redis.client.DefaultClient", 
            "COMPRESSOR": "django_redis.compressors.zlib.ZlibCompressor",
        },
        "KEY_PREFIX": os.environ.get("SQL_DATABASE", default='exact')
    },
    "tiles_cache": {
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "redis://redis:6379/1", # "redis://127.0.0.1:6379/1",
        "OPTIONS": {
            "MAX_ENTRIES": 100000,
            "CLIENT_CLASS": "django_redis.client.DefaultClient", 
            "COMPRESSOR": "django_redis.compressors.zlib.ZlibCompressor",
        },
        "KEY_PREFIX": os.environ.get("SQL_DATABASE", default='exact')
    },
}

Passiv caching

If caching is enabled in the settings.py, static resources like thumbnails and image tiles are cached and served from the cache.

Active caching

Tiles and images can be cached manually by using the REST API.

from exact_sync.v1.api.images_api import ImagesApi
from exact_sync.v1.configuration import Configuration
from exact_sync.v1.api_client import ApiClient

configuration = Configuration()
configuration.username = 'exact'
configuration.password = 'exact'
configuration.host = "http://127.0.0.1:8000"

client = ApiClient(configuration)
images_api = ImagesApi(client)

image_id=1
result = images_api.update_image_cache(id=image_id, mem_size_mb=20)

Syntax

{{baseUrl}}/api/v1/images/images/{id}/update_image_cache/

Body:
mem_size_mb: int default=5
z_dimension: int default=1
frame: int default=1