Documentation
This guide will get you all set up and ready to use BadgerCache. We'll cover all you need to know about setting up a store.
Before setting up a store, you will need to setup a subscription with a credit card. You will not be charged just to test things as long as you stay in the free tier.
BadgerCache is a managed service that sits ontop of your cache and handles the details of keeping the data up to date. Schedule cron jobs, receive and transform webhook payloads, and refresh your cache keys on demand from an easy UI that includes logs and notifications when things go wrong.
Support
Please contact BadgerCache support with any bugs, problems, or answers not mentioned in this guide.
Basic Terminology
Here are a few terms to understand in reading this documentation.
Store
A store is a single caching environment. Typically, a user will have at least a test and production store.
Cache Key
A cache key is a reference to a key/value pair that represents the cached data. A cache key is connected to a data source.
Data Source
A data source is a connection to a REST or GraphQL API where the data can be retrieved for the cache key.
Task
A task can be setup to recache one or more keys either with a webhook, a scheduled cron job, or on-demand.
Job
A job is a single attempt to recache a cache key. A task that is scoped to 5 cache keys = 5 jobs.
Task Log
Each cache key recached by a task gets a task log which is a record of the success or failure of that particular job.