From a1ae5e30a86ae9f483316915a9d44bb51e750e8d Mon Sep 17 00:00:00 2001
From: babyfish-ct <babyfish.ct@gmail.com>
Date: Fri, 22 Sep 2023 23:36:43 +0800
Subject: [PATCH] Add comment to example

---
 .../example/kt/graphql/cfg/cache/CacheConfig.kt  | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/example/kotlin/jimmer-sql-graphql-kt/src/main/kotlin/org/babyfish/jimmer/example/kt/graphql/cfg/cache/CacheConfig.kt b/example/kotlin/jimmer-sql-graphql-kt/src/main/kotlin/org/babyfish/jimmer/example/kt/graphql/cfg/cache/CacheConfig.kt
index f4bc27ad3f..9429e153cf 100644
--- a/example/kotlin/jimmer-sql-graphql-kt/src/main/kotlin/org/babyfish/jimmer/example/kt/graphql/cfg/cache/CacheConfig.kt
+++ b/example/kotlin/jimmer-sql-graphql-kt/src/main/kotlin/org/babyfish/jimmer/example/kt/graphql/cfg/cache/CacheConfig.kt
@@ -35,7 +35,21 @@ class CacheConfig {
     ): KCacheFactory {
 
         val redisTemplate = RedisCaches.cacheRedisTemplate(connectionFactory);
-        
+
+        /*
+         * Single-view caches:
+         *      - All object caches
+         *      - `Book.store`
+         *      - `Book.authors`
+         *      - `TreeNode.parent`
+         *      - `TreeNode.childNodes`
+         *
+         * Multiple-view caches:
+         *      - `BookStore.books`
+         *      - `Author.books`
+         *      - `BookStore.avgPrice`
+         *      - `BookStore.newestBooks`
+         */
         return object : AbstractKCacheFactory() {
 
             // Id -> Object