From 6556cfb59af0586ce197ffcd23817272be363242 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <henrik@trineo.org>
Date: Tue, 2 Mar 2021 11:47:54 +0100
Subject: [PATCH] DOC: minor changes
---
CHANGELOG.md | 7 ++++---
src/test/java/org/caosdb/server/query/QueryTest.java | 6 +++++-
2 files changed, 9 insertions(+), 4 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index dceac0e2..b842574a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,9 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
-* `ETag` property for the query. The `ETag` tags a server state and is being
- updated each time the server state is being updated (i.e. the stored entities
- change). This can be used to debug the query cache and also allows a client
+* `ETag` property for the query. The `ETag` is assigned to the query cache
+ each time the cache is cleared (currently whenever the server state is being
+ updated, i.e. the stored entities change).
+ This can be used to debug the query cache and also allows a client
to determine whether the server's state has changed between queries.
* Basic caching for queries. The caching is enabled by default and can be
controlled by the usual "cache" flag.
diff --git a/src/test/java/org/caosdb/server/query/QueryTest.java b/src/test/java/org/caosdb/server/query/QueryTest.java
index 9ca81370..da652cb3 100644
--- a/src/test/java/org/caosdb/server/query/QueryTest.java
+++ b/src/test/java/org/caosdb/server/query/QueryTest.java
@@ -67,7 +67,11 @@ public class QueryTest {
assertEquals(Query.Role.ENTITY, q.getRole());
}
- /** Assure that {@link WriteTransaction#commit()} calls {@link Query#clearCache()}. */
+ /**
+ * Assure that {@link WriteTransaction#commit()} calls {@link Query#clearCache()}.
+ *
+ * Since currently the cache shall be cleared whenever there is a commit.
+ * */
@Test
public void testEtagChangesAfterWrite() {
String old = Query.getETag();
--
GitLab