Caching

The cache { } builder allows you to change Kord's caching settings. Kord Extensions provides some additional default settings over Kord's own:

• Creates a lruCache, for caching up to 10,000 recent messages.
• Changes the default caching strategy to cacheWithCachingRestFallback, which means that Kord will cache all entities retrieved via REST calls, as well as those provided by the gateway.

ExtensibleBot(TOKEN) {
    // ...

    cache {
        cachedMessages = 10_000
        defaultStrategy = EntitySupplyStrategy.cacheWithCachingRestFallback
    }
}

warning

Kord doesn't automatically cache all types of data. For situations where this doesn't happen, cacheWithCachingRestFallback may result in incomplete data.

For example, if a staff member bans a user from a guild, and you don't yet have all the guild's bans in the cache, Kord will only keep track of bans that the bot has seen happen.

If this is a problem for you, then you have a few options:

1. Fill the cache yourself. For example, for guild members, you could configure the members { } builder to request all guild members from the gateway and set up the required intents.
2. Change the default strategy to cacheWithRestFallback, which won't cache anything retrieved via REST calls.
3. Temporarily use another supply strategy when retrieving these types of data. For example, you could use something like guild.withStrategy(EntitySupplyStrategy.cachingRest).bans.
4. Use one of the equivalent fetch functions to skip the cache entirely.

For most purposes, the first approach will likely be the most sensible, but the correct approach will heavily depend on your bot and how you need the cache to function.

Builders

kord { ... }Receiver: KordCacheBuilder

Register a callback to directly configure Kord's cache, and prevent automatic configuration of the message cache. If you call this and you need message caching, be sure to configure it yourself.

Lambda Arguments

resourcesType: ClientResources

Kord object representing its configuration, including your bot's token and application ID.

transformCache { ... }Receiver: Kord

Register a callback to modify Kord's data cache settings, allowing you to work with Kord's DataCache before it connects to Discord.

Lambda Arguments

cacheType: DataCache

Kord object representing its cache.

Properties

var cachedMessagesType: Int?Default: 10_000

Number of recent messages Kord's cache should store by default.

You can disable automatic configuration of the message cache by setting this to 0 or null, or by manually configuring the cache using the kord builder.

var defaultStrategyType: EntitySupplyStrategyDefault: cacheWithCachingRestFallback

The caching strategy used by Kord by default.