Skip to content

Cache

In-memory key-value cache with TTL support.

4 modules

ModuleDescription
Limpar CacheLimpar todas as entradas de cache ou filtrar por padrão
Excluir CacheExcluir uma entrada de cache por chave
Obter CacheObter um valor do cache por chave
Definir CacheDefinir um valor no cache com TTL opcional

Modules

Limpar Cache

cache.clear

Limpar todas as entradas de cache ou filtrar por padrão

Parameters:

NameTypeRequiredDefaultDescription
patternstringNo*Padrão glob para corresponder às chaves (ex.: "user:", padrão "" limpa tudo)
backendstringNomemoryBackend de cache a ser usado
redis_urlstringNoredis://localhost:6379URL de conexão do Redis

Output:

FieldTypeDescription
cleared_countnumberNúmero de entradas de cache limpas
backendstringO backend usado

Excluir Cache

cache.delete

Excluir uma entrada de cache por chave

Parameters:

NameTypeRequiredDefaultDescription
keystringYes-A chave do cache para excluir
backendstringNomemoryBackend de cache a ser usado
redis_urlstringNoredis://localhost:6379URL de conexão do Redis

Output:

FieldTypeDescription
keystringA chave do cache
deletedbooleanSe a chave foi encontrada e excluída
backendstringO backend usado

Obter Cache

cache.get

Obter um valor do cache por chave

Parameters:

NameTypeRequiredDefaultDescription
keystringYes-A chave do cache para buscar
backendstringNomemoryBackend de cache a ser usado
redis_urlstringNoredis://localhost:6379URL de conexão do Redis

Output:

FieldTypeDescription
keystringA chave do cache
valueanyO valor em cache (nulo se não encontrado)
hitbooleanSe a chave foi encontrada no cache
backendstringO backend usado

Definir Cache

cache.set

Definir um valor no cache com TTL opcional

Parameters:

NameTypeRequiredDefaultDescription
keystringYes-A chave do cache para armazenar o valor
valuestringYes-O valor a ser armazenado (qualquer valor serializável em JSON)
ttlnumberNo0Tempo de vida em segundos (0 = sem expiração)
backendstringNomemoryBackend de cache a ser usado
redis_urlstringNoredis://localhost:6379URL de conexão do Redis

Output:

FieldTypeDescription
keystringA chave do cache
storedbooleanSe o valor foi armazenado com sucesso
ttlnumberO TTL em segundos (0 = sem expiração)
backendstringO backend usado

Released under the Apache 2.0 License.