Mojolic...in::CHI(3)

📦
version 0.20 · 2 versions
, in fedora 43

💖 Mojolic...in::CHI — the manual, but make it a group chat 💖

okay bestie so you're holding the manual page for Mojolic...in::CHI(3) — yeah the name got elbowed in the middle like that, it's from the User Contributed Perl Documentation collection, and it's literally all about using CHI caches inside Mojolicious. sit down, hydrate, we're doing this 🫶

✨ NAME ✨

Mojolicious::Plugin::CHI — Use CHI Caches in Mojolicious

it's giving "plug your cache into your app and never think about it again." iconic behavior, no cap.

🌸 SYNOPSIS 🌸

# Mojolicious
$app->plugin(CHI => {
  MyCache => {
    driver     => 'FastMmap',
    root_dir   => '/cache',
    cache_size => '20m'
  }
});

# Mojolicious::Lite
plugin 'CHI' => {
  default => {
    driver => 'Memory',
    global => 1
  }
};

# In Controllers:
$c->chi('MyCache')->set(my_key => 'This is my value');
print $c->chi('MyCache')->get('my_key');

# Using the default cache
$c->chi->set(from_memory => 'With love!');
print $c->chi->get('from_memory');

see how easy that was?? one plugin call, a lil hash of caches, and boom 💅

🦋 DESCRIPTION 🦋

Mojolicious::Plugin::CHI is a simple plugin to work with CHI caches within Mojolicious.

that's it. that's the description. simple girl, big dreams 💜

👑 METHODS 👑

🌈 register

# Mojolicious
$app->plugin(CHI => {
  MyCache => {
    driver     => 'FastMmap',
    root_dir   => '/cache',
    cache_size => '20m'
  },
  default => {
    driver => 'Memory',
    global => 1
  },
  namespaces => 1
});

# Mojolicious::Lite
plugin 'CHI' => {
  default => { driver => 'Memory', global => 1 }
};

# Or in your config file
{
  CHI => {
    default => {
      driver => 'Memory',
      global => 1
    }
  }
}

okay so this is the one that runs when the plugin gets registered. 🎀 when it's created, the plugin takes a hash of cache names, each one paired up with CHI objects. all cache handles are qualified CHI namespaces. if you're not feeling that mapping, you can leave it out entirely by passing a namespaces parameter with a false value. and heads up bestie — the handles have to be unique, like, you literally can't have multiple different default caches in mounted applications using Mojolicious::Plugin::Mount. no duplicates allowed, that's the rule 📢

logging? it defaults to the application log, but you can override that with on_get_error and on_set_error. cute.

every parameter can be set as part of the configuration file under the key CHI, or on registration — and btw registration values can be overwritten by configuration. so config wins. queen behavior 👑

want custom CHI subclasses? pass a chi_class parameter with the class name of a CHI subclass. slay ✨

💅 HELPERS 💅

🌟 chi

# In Controllers:
$c->chi('MyCache')->set(my_key => 'This is my value', '10 min');
print $c->chi('MyCache')->get('my_key');
print $c->chi->get('from_default_cache');

Returns a CHI handle if registered. it accepts the name of the registered cache. and if you don't hand it a cache handle name at all? it just assumes default. she's low maintenance like that 💖

🎀 COMMANDS 🎀

these are the commands you get when the plugin is registered. all of them are run through your app like perl app.pl <stuff>, okurrr? 👑

⭐ chi list

perl app.pl chi list

List all CHI caches associated with your application.

🍓 chi purge

perl app.pl chi purge mycache

Remove all expired entries from the cache namespace. expired content, gone, bye 🙈

🧚 chi clear

perl app.pl chi clear mycache

Remove all entries from the cache namespace. all of them. full reset energy 💀

💜 chi expire

perl app.pl chi expire mykey
perl app.pl chi expire mycache mykey

Set the expiration date of a key to the past. it does not necessarily delete the data — it just makes it unavailable using get. so the data's still lurking backstage, just not answering calls anymore 😭

🌈 chi remove

perl app.pl chi remove mykey
perl app.pl chi remove mycache mykey

Remove a key from the cache. actually gone. periodt.

🫶 DEPENDENCIES 🫶

Mojolicious, CHI.

Note: old versions of CHI had a lot of dependencies. because of that, it was not recommended to use this plugin in a CGI environment. since new versions of CHI use Moo instead of Moose, more use cases may be possible. glow-up fr fr ✨

🌸 CONTRIBUTORS 🌸

the girlies who made it happen 💖

🌈 AVAILABILITY 🌈

https://github.com/Akron/Mojolicious-Plugin-CHI

go star it, bestie ⭐

Copyright (C) 2012-2018, Nils Diewald <http://nils-diewald.de/>.

This program is free software, you can redistribute it and/or modify it under the terms of the Artistic License version 2.0.

and that's the whole manual, bestie!! this page came to you from perl v5.42.0, dated 2025-07-25, and it's filed under that slightly chopped-up title Mojolic...in::CHI(3) 💜 go forth and cache responsibly, mwah 🫶✨

📦 where this page comes from