CINXE.COM

<!doctype html> <html lang="en"> <head> <title>Redis - L2 cache | Ebean ORM</title> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <link rel="shortcut icon" href="/images/favicon.ico"> <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto|Source+Sans+Pro|Ubuntu&display=swap"> <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" crossorigin="anonymous"> <link rel="stylesheet" href="/css/reset3.css"> <link rel="stylesheet" href="/css/site3.css"> <link rel="stylesheet" href="/css/pygments3.css"> </head> <body> <div id="main"> <div id="banner"> <header> <nav id="top"> <h1 id="breadcrumb"> <a class="nav-logo" href="/"><img src="/images/logo-200.png" height="35"></a>  <a href="/docs">Documentation</a> / <a href="/docs/database">Database platforms</a> / Redis - L2 cache </h1> <ul> <li><a onclick="toggleTheme();" title="switch dark light theme"></a></li> </ul> </nav> </header> </div> <div class="grid grid-docs"> <aside> <nav class="side"> <ul> <li class="nav0 "> <a href="/docs/getting-started">Getting started</a> </li> <li class="nav0 "> <a href="/docs/intro">Introduction</a> </li> <li class="nav0 active"> <a class="active" href="/docs">Documentation</a> <ul> <li class="nav1 "> <a href="/docs/best-practice">Best practice</a> </li> <li class="nav1 "> <a href="/docs/query">Query</a> </li> <li class="nav1 "> <a href="/docs/persist">Persist</a> </li> <li class="nav1 "> <a href="/docs/transactions">Transactions</a> </li> <li class="nav1 "> <a href="/docs/mapping">Mapping</a> </li> <li class="nav1 "> <a href="/docs/ddl-generation">DDL & Migrations</a> </li> <li class="nav1 "> <a href="/docs/logging">Logging</a> </li> <li class="nav1 "> <a href="/docs/testing">Testing</a> </li> <li class="nav1 "> <a href="/docs/read-replicas">Read Replicas</a> </li> <li class="nav1 active"> <a class="active" href="/docs/database">Database platforms</a> <ul class="nav"> <li > <a href="/docs/database/postgres">Postgres</a> </li> <li > <a href="/docs/database/h2">H2</a> </li> <li > <a href="/docs/database/mysql">MySql</a> </li> <li > <a href="/docs/database/mariadb">MariaDB</a> </li> <li > <a href="/docs/database/sqlserver">SQL Server</a> </li> <li > <a href="/docs/database/oracle">Oracle</a> </li> <li > <a href="/docs/database/db2">DB2</a> </li> <li > <a href="/docs/database/hana">SAP Hana</a> </li> <li > <a href="/docs/database/sqlite">Sqlite</a> </li> <li > <a href="/docs/database/clickhouse">ClickHouse</a> </li> <li > <a href="/docs/database/cockroach">Cockroach</a> </li> <li > <a href="/docs/database/yugabyte">YugabyteDB</a> </li> <li > <a href="/docs/database/nuodb">NuoDB</a> </li> <li > <a href="/docs/database/elasticsearch">ElasticSearch</a> </li> <li class="active"> <a class="active" href="/docs/database/redis">Redis</a> </li> </ul> </li> <li class="nav1 "> <a href="/docs/multi-database">Multiple databases</a> </li> <li class="nav1 "> <a href="/docs/kotlin">Kotlin</a> </li> <li><a href="/docs/tuning">Tuning</a></li> <li class="nav1 "> <a href="/docs/features">Features</a> </li> </ul> </li> <li class="nav0 "> <a href="/support">Getting help</a> </li> <li class="nav0 "> <a target="_blank" href="/apidoc/13">API Javadoc</a> </li> <li class="nav0 "> <a href="/videos">Videos</a> </li> <li class="nav0 "> <a href="/docs/upgrading">Upgrading</a> </li> <li class="nav0 "> <a href="/releases">Releases</a> </li> </ul> </nav> </aside> <article> <form action="https://www.google.com/search" method="get" class="inline-form"> <input type="hidden" name="as_sitesearch" value="ebean.io"> <div id="page-search"> <div class="input-group"> <input class="frm" name="q" id="searchinput" type="text" placeholder="Search... (press 's' to focus)" data-placeholder-focus="Search... (use '↑', '↓' and '⏎' to select results)" data-placeholder-blur="Search... (press 's' to focus)" autocomplete="off"> <div class="input-group-btn"> <button class="frm" type="submit"></button> </div> </div> <div id="page-search-results" style="display: none;"> <ul id="search-results-container" class="search-results"><li class=" active"><a href="/docs" title="Docs">Docs Documentation </a></li><li class="">And 101 more...</li></ul> </div> </div> </form> <h2>Redis - L2 cache</h2> Configure the redis server to use by setting <code>ebean.redis</code> properties in <code>main/resources/application.yaml</code> like below: Note that for property configuration to work when we programmatically create Database via DatabaseFactory and DatabaseConfig, then we need to make sure that we use <code>DatabaseConfig.loadFromProperties()</code> to load the properties. <div class="syntax yml"><div class="highlight"><pre>ebean: redis: server: test-server port: 99 minIdle: 2 maxIdle: 20 maxTotal: 20 maxWaitMillis: 300 </pre></div> </div> For testing purposes set <code>ebean.test.redis</code> property to <code>latest</code> in in <code>test/resources/application-test.yaml</code>. This will get ebean-test to automatically start a redis docker container for use with L2 caching. <div class="syntax yml"><div class="highlight"><pre>ebean: test: redis: latest platform: h2 # h2, postgres, mysql, oracle, sqlserver, sqlite ddlMode: dropCreate # none | dropCreate | migrations | create dbName: my_app </pre></div> </div> <h2>ebean-redis dependency</h2> Add <code>ebean-redis</code> as a dependency. This will automatically register itself with ebean as the L2 cache service. <div class="syntax xml"><div class="highlight"><pre><dependency> <groupId>io.ebean</groupId> <artifactId>ebean-redis</artifactId> <version>14.1.0</version> </dependency> </pre></div> </div> <h2>@Cache</h2> Entity beans annotated with <code>@Cache</code> will now use redis for L2 caching. <div class="syntax java"><div class="highlight"><pre>@Cache(enableQueryCache = true, nearCache = true, naturalKey = "name") @Entity public class Person extends EBase { public enum Status { NEW, ACTIVE, INACTIVE } @Index(unique = true) String name; Status status; LocalDate localDate; String notes; public Person(String name) { this.name = name; this.status = Status.NEW; } ... } </pre></div> </div> <h2 id="starting">Docker container</h2> We can programmatically start a docker container version of Redis. The below uses <code>ebean-test-docker</code> dependency which already comes with <code>ebean-test</code>. If we do not have a dependency on <code>ebean-test</code> then add <code>io.ebean:ebean-test-docker:5.0</code> as a dependency. <div class="syntax java"><div class="highlight"><pre>package main; import io.ebean.docker.commands.RedisContainer; public class Main { public static void main(String[] args) { RedisContainer container = RedisContainer.newBuilder("latest") .build(); container.start(); } } </pre></div> </div> <nav class="next"> <a href="https://github.com/ebean-orm/website-source/blob/master/docs/database/elasticsearch/index.html"> Edit Page</a> <a href="/docs/database/postgres" class="btn btn-info">Next: Postgres</a> </nav> </article> </div> </div> <script src="https://code.jquery.com/jquery-3.4.1.slim.min.js" integrity="sha384-J6qa4849blE2+poT4WnyKhv5vZF5SrPo0iEjwBvKU7imGFAV0wwj1yYfoRSJoZ+n" crossorigin="anonymous"></script> <script src="/js/site3.js"></script> <script src="/js/search3.js"></script> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-75181644-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-75181644-1'); </script> </body> </html>