slonik-interceptor-query-cache 3.1.0 → 3.3.0

package/README.md

@@ -18,17 +18,33 @@ Which queries are cached is controlled using cache attributes. Cache attributes
 
 ## Cache attributes
 
-|Cache attribute|Description|Required?|Format|Default|
-|---|---|---|---|---|
-|`@cache-ttl`|Number (in seconds) to cache the query for.|Yes|`/^d+$/`|N/A|
-|`@cache-key`|Cache key that uniquelly identifies the query.|No|`/^[$A-Za-z0-9\-_:]+$/`|`$bodyHash:$valueHash`|
-|`@cache-discard-empty`|If set to `true`, then `storage.set` is not invoked when query produces no results.|No|`/^(false|true)$/`|`false`|
+#### `@cache-ttl`
 
-### `@cache-key`
+|Required|Format|Default|
+|---|---|---|
+|Yes|`/^d+$/`|N/A|
 
-Overrides the default cache key that uniquely identifies the query.
+Number (in seconds) to cache the query for.
 
-If present, `$bodyHash` is substituted with the hash of the query (comments and white-spaces are stripped before hashing the query). `$valueHash` is substituted with the hash of the parameter values.
+#### `@cache-key`
+
+|Required|Format|Default|
+|---|---|---|
+|No|`/^[$A-Za-z0-9\-_:]+$/`|`$bodyHash:$valueHash`|
+
+Cache key that uniquely identifies the query.
+
+If present, `$bodyHash` is substituted with the hash of the query (comments and white-spaces are stripped before hashing the query).
+
+If present, `$valueHash` is substituted with the hash of the parameter values.
+
+#### `@cache-discard-empty`
+
+|Required|Format|Default|
+|---|---|---|
+|No|`/^(false\|true)$/`|`false`|
+
+If set to `true`, then `storage.set` is not invoked when query produces no results.
 
 ### Example usage
 
@@ -64,7 +80,11 @@ const pool = await createPool('postgres://', {
     }),
   ]
 });
+```
 
+These are example queries:
+
+```ts
 // Caches the query results based on a combination of the query hash and the parameter value hash.
 await connection.any(sql`
   -- @cache-ttl 60
@@ -76,6 +96,18 @@ await connection.any(sql`
     code_alpha_2 = ${countryCode}
 `);
 
+// Does not cache the result when query produces no results.
+await connection.any(sql`
+  -- @cache-ttl 60
+  -- @cache-discard-empty true
+  SELECT
+    id,
+    code_alpha_2
+  FROM country
+  WHERE
+    code_alpha_2 = ${countryCode}
+`);
+
 // Caches the query results based only on the parameter value hash.
 await connection.any(sql`
   -- @cache-ttl 60

package/package.json

@@ -67,5 +67,5 @@
     "test:ava": "nyc ava --verbose --serial"
   },
   "typings": "./dist/src/index.d.ts",
-  "version": "3.1.0"
+  "version": "3.3.0"
 }