AMLSim
/
jars
/janusgraph-1.0.0
/javadocs
/org
/janusgraph
/graphdb
/database
/cache
/KCVSCacheInvalidationService.html
| <!-- NewPage --> | |
| <html lang="en"> | |
| <head> | |
| <!-- Generated by javadoc (1.8.0_382) on Sat Oct 21 16:38:51 UTC 2023 --> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <title>KCVSCacheInvalidationService (JanusGraph-Core: Core Library for JanusGraph 1.0.0 API)</title> | |
| <meta name="date" content="2023-10-21"> | |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> | |
| <script type="text/javascript" src="../../../../../script.js"></script> | |
| </head> | |
| <body> | |
| <script type="text/javascript"><!-- | |
| try { | |
| if (location.href.indexOf('is-external=true') == -1) { | |
| parent.document.title="KCVSCacheInvalidationService (JanusGraph-Core: Core Library for JanusGraph 1.0.0 API)"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10}; | |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; | |
| var altColor = "altColor"; | |
| var rowColor = "rowColor"; | |
| var tableTab = "tableTab"; | |
| var activeTableTab = "activeTableTab"; | |
| </script> | |
| <noscript> | |
| <div>JavaScript is disabled on your browser.</div> | |
| </noscript> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <div class="topNav"><a name="navbar.top"> | |
| <!-- --> | |
| </a> | |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> | |
| <a name="navbar.top.firstrow"> | |
| <!-- --> | |
| </a> | |
| <ul class="navList" title="Navigation"> | |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> | |
| <li><a href="package-summary.html">Package</a></li> | |
| <li class="navBarCell1Rev">Class</li> | |
| <li><a href="class-use/KCVSCacheInvalidationService.html">Use</a></li> | |
| <li><a href="package-tree.html">Tree</a></li> | |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> | |
| <li><a href="../../../../../index-all.html">Index</a></li> | |
| <li><a href="../../../../../help-doc.html">Help</a></li> | |
| </ul> | |
| </div> | |
| <div class="subNav"> | |
| <ul class="navList"> | |
| <li><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html" title="interface in org.janusgraph.graphdb.database.cache"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../org/janusgraph/graphdb/database/cache/MetricInstrumentedSchemaCache.html" title="class in org.janusgraph.graphdb.database.cache"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../index.html?org/janusgraph/graphdb/database/cache/KCVSCacheInvalidationService.html" target="_top">Frames</a></li> | |
| <li><a href="KCVSCacheInvalidationService.html" target="_top">No Frames</a></li> | |
| </ul> | |
| <ul class="navList" id="allclasses_navbar_top"> | |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> | |
| </ul> | |
| <div> | |
| <script type="text/javascript"> | |
| </script> | |
| </div> | |
| <div> | |
| <ul class="subNavList"> | |
| <li>Summary: </li> | |
| <li>Nested | </li> | |
| <li>Field | </li> | |
| <li><a href="#constructor.summary">Constr</a> | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li>Field | </li> | |
| <li><a href="#constructor.detail">Constr</a> | </li> | |
| <li><a href="#method.detail">Method</a></li> | |
| </ul> | |
| </div> | |
| <a name="skip.navbar.top"> | |
| <!-- --> | |
| </a></div> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <!-- ======== START OF CLASS DATA ======== --> | |
| <div class="header"> | |
| <div class="subTitle">org.janusgraph.graphdb.database.cache</div> | |
| <h2 title="Class KCVSCacheInvalidationService" class="title">Class KCVSCacheInvalidationService</h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <ul class="inheritance"> | |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> | |
| <li> | |
| <ul class="inheritance"> | |
| <li>org.janusgraph.graphdb.database.cache.KCVSCacheInvalidationService</li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <dl> | |
| <dt>All Implemented Interfaces:</dt> | |
| <dd><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html" title="interface in org.janusgraph.graphdb.database.cache">CacheInvalidationService</a></dd> | |
| </dl> | |
| <hr> | |
| <br> | |
| <pre>public class <span class="typeNameLabel">KCVSCacheInvalidationService</span> | |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> | |
| implements <a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html" title="interface in org.janusgraph.graphdb.database.cache">CacheInvalidationService</a></pre> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="summary"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="constructor.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Constructor Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> | |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colOne" scope="col">Constructor and Description</th> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/database/cache/KCVSCacheInvalidationService.html#KCVSCacheInvalidationService-org.janusgraph.diskstorage.keycolumnvalue.cache.KCVSCache-org.janusgraph.diskstorage.keycolumnvalue.cache.KCVSCache-org.janusgraph.graphdb.idmanagement.IDManager-">KCVSCacheInvalidationService</a></span>(<a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/cache/KCVSCache.html" title="class in org.janusgraph.diskstorage.keycolumnvalue.cache">KCVSCache</a> edgeStore, | |
| <a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/cache/KCVSCache.html" title="class in org.janusgraph.diskstorage.keycolumnvalue.cache">KCVSCache</a> indexStore, | |
| <a href="../../../../../org/janusgraph/graphdb/idmanagement/IDManager.html" title="class in org.janusgraph.graphdb.idmanagement">IDManager</a> idManager)</code> </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| <!-- ========== METHOD SUMMARY =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="method.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> | |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier and Type</th> | |
| <th class="colLast" scope="col">Method and Description</th> | |
| </tr> | |
| <tr id="i0" class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/database/cache/KCVSCacheInvalidationService.html#clearDBCache--">clearDBCache</a></span>()</code> | |
| <div class="block">Clears both `edgeStore` cache and `indexStore` cache fully.</div> | |
| </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/database/cache/KCVSCacheInvalidationService.html#clearEdgeStoreCache--">clearEdgeStoreCache</a></span>()</code> | |
| <div class="block">Clears `edgeStore` cache fully</div> | |
| </td> | |
| </tr> | |
| <tr id="i2" class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/database/cache/KCVSCacheInvalidationService.html#clearIndexStoreCache--">clearIndexStoreCache</a></span>()</code> | |
| <div class="block">Clears `indexStore` cache fully</div> | |
| </td> | |
| </tr> | |
| <tr id="i3" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/database/cache/KCVSCacheInvalidationService.html#forceClearExpiredKeysInEdgeStoreCache--">forceClearExpiredKeysInEdgeStoreCache</a></span>()</code> | |
| <div class="block">Instead of waiting for a probabilistic invalidation it triggers all cached queries scan and invalidation in `edgeStore`.</div> | |
| </td> | |
| </tr> | |
| <tr id="i4" class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/database/cache/KCVSCacheInvalidationService.html#forceClearExpiredKeysInIndexStoreCache--">forceClearExpiredKeysInIndexStoreCache</a></span>()</code> | |
| <div class="block">Instead of waiting for a probabilistic invalidation it triggers all cached queries scan and invalidation in `indexStore`.</div> | |
| </td> | |
| </tr> | |
| <tr id="i5" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/database/cache/KCVSCacheInvalidationService.html#forceInvalidateVertexInEdgeStoreCache-java.lang.Object-">forceInvalidateVertexInEdgeStoreCache</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> vertexId)</code> | |
| <div class="block">Marks a vertex as expired in `edgeStore` cache (<a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#markVertexAsExpiredInEdgeStore-java.lang.Object-"><code>CacheInvalidationService.markVertexAsExpiredInEdgeStore(Object)</code></a>) and triggers force | |
| clear of expired cache (i.e.</div> | |
| </td> | |
| </tr> | |
| <tr id="i6" class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/database/cache/KCVSCacheInvalidationService.html#forceInvalidateVerticesInEdgeStoreCache-java.lang.Iterable-">forceInvalidateVerticesInEdgeStoreCache</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> vertexIds)</code> | |
| <div class="block">Marks vertices as expired in `edgeStore` cache (<a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#markVertexAsExpiredInEdgeStore-java.lang.Object-"><code>CacheInvalidationService.markVertexAsExpiredInEdgeStore(Object)</code></a>) and triggers force | |
| clear of expired cache (i.e.</div> | |
| </td> | |
| </tr> | |
| <tr id="i7" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/database/cache/KCVSCacheInvalidationService.html#markKeyAsExpiredInEdgeStore-org.janusgraph.diskstorage.StaticBuffer-">markKeyAsExpiredInEdgeStore</a></span>(<a href="../../../../../org/janusgraph/diskstorage/StaticBuffer.html" title="interface in org.janusgraph.diskstorage">StaticBuffer</a> key)</code> | |
| <div class="block">Marks specific key as expired in `edgeStore` cache.</div> | |
| </td> | |
| </tr> | |
| <tr id="i8" class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/database/cache/KCVSCacheInvalidationService.html#markKeyAsExpiredInIndexStore-org.janusgraph.diskstorage.StaticBuffer-">markKeyAsExpiredInIndexStore</a></span>(<a href="../../../../../org/janusgraph/diskstorage/StaticBuffer.html" title="interface in org.janusgraph.diskstorage">StaticBuffer</a> key)</code> | |
| <div class="block">Marks specific key as expired in `indexStore` cache.</div> | |
| </td> | |
| </tr> | |
| <tr id="i9" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/janusgraph/graphdb/database/cache/KCVSCacheInvalidationService.html#markVertexAsExpiredInEdgeStore-java.lang.Object-">markVertexAsExpiredInEdgeStore</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> vertexId)</code> | |
| <div class="block">Marks specific vertex as expired in `edgeStore` cache.</div> | |
| </td> | |
| </tr> | |
| </table> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> | |
| <!-- --> | |
| </a> | |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> | |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="details"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="constructor.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Constructor Detail</h3> | |
| <a name="KCVSCacheInvalidationService-org.janusgraph.diskstorage.keycolumnvalue.cache.KCVSCache-org.janusgraph.diskstorage.keycolumnvalue.cache.KCVSCache-org.janusgraph.graphdb.idmanagement.IDManager-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>KCVSCacheInvalidationService</h4> | |
| <pre>public KCVSCacheInvalidationService(<a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/cache/KCVSCache.html" title="class in org.janusgraph.diskstorage.keycolumnvalue.cache">KCVSCache</a> edgeStore, | |
| <a href="../../../../../org/janusgraph/diskstorage/keycolumnvalue/cache/KCVSCache.html" title="class in org.janusgraph.diskstorage.keycolumnvalue.cache">KCVSCache</a> indexStore, | |
| <a href="../../../../../org/janusgraph/graphdb/idmanagement/IDManager.html" title="class in org.janusgraph.graphdb.idmanagement">IDManager</a> idManager)</pre> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="method.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Detail</h3> | |
| <a name="markVertexAsExpiredInEdgeStore-java.lang.Object-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>markVertexAsExpiredInEdgeStore</h4> | |
| <pre>public void markVertexAsExpiredInEdgeStore(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> vertexId)</pre> | |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#markVertexAsExpiredInEdgeStore-java.lang.Object-">CacheInvalidationService</a></code></span></div> | |
| <div class="block">Marks specific vertex as expired in `edgeStore` cache. | |
| It will make sure that any retrieved properties and edges associated with this vertex will be invalidated in vertex cache. | |
| <p> | |
| Warning! This doesn't invalidate `indexStore` cache. Thus, any queries which are using indices may still return | |
| stale data. See <a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#markKeyAsExpiredInIndexStore-org.janusgraph.diskstorage.StaticBuffer-"><code>CacheInvalidationService.markKeyAsExpiredInIndexStore(StaticBuffer)</code></a> JavaDoc to learn how to invalidate data for | |
| `indexStore`.</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#markVertexAsExpiredInEdgeStore-java.lang.Object-">markVertexAsExpiredInEdgeStore</a></code> in interface <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html" title="interface in org.janusgraph.graphdb.database.cache">CacheInvalidationService</a></code></dd> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>vertexId</code> - vertex id to expire in `edgeStore` cache</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="markKeyAsExpiredInEdgeStore-org.janusgraph.diskstorage.StaticBuffer-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>markKeyAsExpiredInEdgeStore</h4> | |
| <pre>public void markKeyAsExpiredInEdgeStore(<a href="../../../../../org/janusgraph/diskstorage/StaticBuffer.html" title="interface in org.janusgraph.diskstorage">StaticBuffer</a> key)</pre> | |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#markKeyAsExpiredInEdgeStore-org.janusgraph.diskstorage.StaticBuffer-">CacheInvalidationService</a></code></span></div> | |
| <div class="block">Marks specific key as expired in `edgeStore` cache. | |
| It will make sure that any retrieved properties and edges associated with this key will be invalidated in vertex cache. | |
| <p> | |
| Warning! This doesn't invalidate `indexStore` cache. Thus, any queries which are using indices may still return | |
| stale data. See <a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#markKeyAsExpiredInIndexStore-org.janusgraph.diskstorage.StaticBuffer-"><code>CacheInvalidationService.markKeyAsExpiredInIndexStore(StaticBuffer)</code></a> JavaDoc to learn how to invalidate data for | |
| `indexStore`. | |
| <p> | |
| <a href="../../../../../org/janusgraph/graphdb/idmanagement/IDManager.html#getKey-java.lang.Object-"><code>IDManager.getKey(Object)</code></a> can be used to form a `key` from vertex id. | |
| Alternatively, a method <a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#markVertexAsExpiredInEdgeStore-java.lang.Object-"><code>CacheInvalidationService.markVertexAsExpiredInEdgeStore(Object)</code></a> can be used which converts vertex id into | |
| the `key` before passing the key to this method. | |
| <p> | |
| In case vertices invalidation is needed by processing transaction logs via <a href="../../../../../org/janusgraph/core/log/ChangeState.html" title="interface in org.janusgraph.core.log"><code>ChangeState</code></a> | |
| then the method <a href="../../../../../org/janusgraph/core/log/ChangeState.html#getVertices-org.janusgraph.core.log.Change-"><code>ChangeState.getVertices(Change)</code></a> can be used to retrieve all | |
| changed vertices and passing their ids to <a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#markVertexAsExpiredInEdgeStore-java.lang.Object-"><code>CacheInvalidationService.markVertexAsExpiredInEdgeStore(Object)</code></a>.</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#markKeyAsExpiredInEdgeStore-org.janusgraph.diskstorage.StaticBuffer-">markKeyAsExpiredInEdgeStore</a></code> in interface <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html" title="interface in org.janusgraph.graphdb.database.cache">CacheInvalidationService</a></code></dd> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>key</code> - key to expire in `edgeStore` cache</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="markKeyAsExpiredInIndexStore-org.janusgraph.diskstorage.StaticBuffer-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>markKeyAsExpiredInIndexStore</h4> | |
| <pre>public void markKeyAsExpiredInIndexStore(<a href="../../../../../org/janusgraph/diskstorage/StaticBuffer.html" title="interface in org.janusgraph.diskstorage">StaticBuffer</a> key)</pre> | |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#markKeyAsExpiredInIndexStore-org.janusgraph.diskstorage.StaticBuffer-">CacheInvalidationService</a></code></span></div> | |
| <div class="block">Marks specific key as expired in `indexStore` cache. | |
| It will make sure that any retrieved data associated with this key will be invalidated in index cache. | |
| <p> | |
| Warning! This doesn't invalidate `edgeStore` cache. Thus, trying to return properties or edges for the vertex | |
| may still return stale data. See <a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#markKeyAsExpiredInEdgeStore-org.janusgraph.diskstorage.StaticBuffer-"><code>CacheInvalidationService.markKeyAsExpiredInEdgeStore(StaticBuffer)</code></a> JavaDoc to learn how to invalidate | |
| data for `edgeStore`. | |
| <p> | |
| `key` is the encoded key of <a href="../../../../../org/janusgraph/graphdb/database/index/IndexUpdate.html" title="class in org.janusgraph.graphdb.database.index"><code>IndexUpdate</code></a> which can be retrieved via | |
| <a href="../../../../../org/janusgraph/graphdb/database/index/IndexUpdate.html#getKey--"><code>IndexUpdate.getKey()</code></a>. To form the `IndexUpdate` it is possible to use | |
| <a href="../../../../../org/janusgraph/graphdb/database/IndexSerializer.html#getIndexUpdates-org.janusgraph.graphdb.internal.InternalRelation-"><code>IndexSerializer.getIndexUpdates(InternalRelation)</code></a> or | |
| <a href="../../../../../org/janusgraph/graphdb/database/IndexSerializer.html#getIndexUpdates-org.janusgraph.graphdb.internal.InternalVertex-java.util.Collection-"><code>IndexSerializer.getIndexUpdates(InternalVertex, Collection)</code></a>. | |
| <p> | |
| Usually updated vertices and relations (edges or properties) can be found in retrieved mutation logs which are | |
| passed via <a href="../../../../../org/janusgraph/core/log/ChangeState.html" title="interface in org.janusgraph.core.log"><code>ChangeState</code></a> (described in `Transaction Log` documentation of JanusGraph). | |
| <p> | |
| It is also possible to trigger `indexStore` invalidation by forming a vertex and a property yourself. | |
| For example, below method can be used to trigger `indexStore` invalidation for updated property if | |
| previous value, new value, property name, and vertex id are known. | |
| <pre> | |
| public void invalidateUpdatedVertexProperty(StandardJanusGraph graph, long vertexIdUpdated, String propertyNameUpdated, Object previousPropertyValue, Object newPropertyValue){ | |
| JanusGraphTransaction tx = graph.newTransaction(); | |
| JanusGraphManagement graphMgmt = graph.openManagement(); | |
| PropertyKey propertyKey = graphMgmt.getPropertyKey(propertyNameUpdated); | |
| CacheVertex cacheVertex = new CacheVertex((StandardJanusGraphTx) tx, vertexIdUpdated, ElementLifeCycle.Loaded); | |
| StandardVertexProperty propertyPreviousVal = new StandardVertexProperty(propertyKey.longId(), propertyKey, cacheVertex, previousPropertyValue, ElementLifeCycle.Removed); | |
| StandardVertexProperty propertyNewVal = new StandardVertexProperty(propertyKey.longId(), propertyKey, cacheVertex, newPropertyValue, ElementLifeCycle.New); | |
| IndexSerializer indexSerializer = graph.getIndexSerializer(); | |
| Collection<IndexUpdate> indexUpdates = indexSerializer.getIndexUpdates(cacheVertex, Arrays.asList(propertyPreviousVal, propertyNewVal)); | |
| CacheInvalidationService invalidationService = graph.getDBCacheInvalidationService(); | |
| for(IndexUpdate indexUpdate : indexUpdates){ | |
| StaticBuffer keyToInvalidate = (StaticBuffer) indexUpdate.getKey(); | |
| invalidationService.markKeyAsExpiredInIndexStore(keyToInvalidate); | |
| } | |
| invalidationService.forceClearExpiredKeysInIndexStoreCache(); | |
| invalidationService.forceInvalidateVertexInEdgeStoreCache(vertexIdUpdated); | |
| graphMgmt.rollback(); | |
| tx.rollback(); | |
| } | |
| </pre></div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#markKeyAsExpiredInIndexStore-org.janusgraph.diskstorage.StaticBuffer-">markKeyAsExpiredInIndexStore</a></code> in interface <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html" title="interface in org.janusgraph.graphdb.database.cache">CacheInvalidationService</a></code></dd> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>key</code> - key to expire in `indexStore` cache</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="forceClearExpiredKeysInEdgeStoreCache--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>forceClearExpiredKeysInEdgeStoreCache</h4> | |
| <pre>public void forceClearExpiredKeysInEdgeStoreCache()</pre> | |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#forceClearExpiredKeysInEdgeStoreCache--">CacheInvalidationService</a></code></span></div> | |
| <div class="block">Instead of waiting for a probabilistic invalidation it triggers all cached queries scan and invalidation in `edgeStore`. | |
| This will remove any cached expired data.</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#forceClearExpiredKeysInEdgeStoreCache--">forceClearExpiredKeysInEdgeStoreCache</a></code> in interface <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html" title="interface in org.janusgraph.graphdb.database.cache">CacheInvalidationService</a></code></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="forceClearExpiredKeysInIndexStoreCache--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>forceClearExpiredKeysInIndexStoreCache</h4> | |
| <pre>public void forceClearExpiredKeysInIndexStoreCache()</pre> | |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#forceClearExpiredKeysInIndexStoreCache--">CacheInvalidationService</a></code></span></div> | |
| <div class="block">Instead of waiting for a probabilistic invalidation it triggers all cached queries scan and invalidation in `indexStore`. | |
| This will remove any cached expired data.</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#forceClearExpiredKeysInIndexStoreCache--">forceClearExpiredKeysInIndexStoreCache</a></code> in interface <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html" title="interface in org.janusgraph.graphdb.database.cache">CacheInvalidationService</a></code></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="forceInvalidateVertexInEdgeStoreCache-java.lang.Object-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>forceInvalidateVertexInEdgeStoreCache</h4> | |
| <pre>public void forceInvalidateVertexInEdgeStoreCache(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> vertexId)</pre> | |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#forceInvalidateVertexInEdgeStoreCache-java.lang.Object-">CacheInvalidationService</a></code></span></div> | |
| <div class="block">Marks a vertex as expired in `edgeStore` cache (<a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#markVertexAsExpiredInEdgeStore-java.lang.Object-"><code>CacheInvalidationService.markVertexAsExpiredInEdgeStore(Object)</code></a>) and triggers force | |
| clear of expired cache (i.e. <a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#forceClearExpiredKeysInEdgeStoreCache--"><code>CacheInvalidationService.forceClearExpiredKeysInEdgeStoreCache()</code></a>)</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#forceInvalidateVertexInEdgeStoreCache-java.lang.Object-">forceInvalidateVertexInEdgeStoreCache</a></code> in interface <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html" title="interface in org.janusgraph.graphdb.database.cache">CacheInvalidationService</a></code></dd> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>vertexId</code> - vertex id to invalidate in `edgeStore` cache</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="forceInvalidateVerticesInEdgeStoreCache-java.lang.Iterable-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>forceInvalidateVerticesInEdgeStoreCache</h4> | |
| <pre>public void forceInvalidateVerticesInEdgeStoreCache(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> vertexIds)</pre> | |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#forceInvalidateVerticesInEdgeStoreCache-java.lang.Iterable-">CacheInvalidationService</a></code></span></div> | |
| <div class="block">Marks vertices as expired in `edgeStore` cache (<a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#markVertexAsExpiredInEdgeStore-java.lang.Object-"><code>CacheInvalidationService.markVertexAsExpiredInEdgeStore(Object)</code></a>) and triggers force | |
| clear of expired cache (i.e. <a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#forceClearExpiredKeysInEdgeStoreCache--"><code>CacheInvalidationService.forceClearExpiredKeysInEdgeStoreCache()</code></a>)</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#forceInvalidateVerticesInEdgeStoreCache-java.lang.Iterable-">forceInvalidateVerticesInEdgeStoreCache</a></code> in interface <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html" title="interface in org.janusgraph.graphdb.database.cache">CacheInvalidationService</a></code></dd> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>vertexIds</code> - vertex ids to invalidate in `edgeStore` cache</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="clearEdgeStoreCache--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>clearEdgeStoreCache</h4> | |
| <pre>public void clearEdgeStoreCache()</pre> | |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#clearEdgeStoreCache--">CacheInvalidationService</a></code></span></div> | |
| <div class="block">Clears `edgeStore` cache fully</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#clearEdgeStoreCache--">clearEdgeStoreCache</a></code> in interface <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html" title="interface in org.janusgraph.graphdb.database.cache">CacheInvalidationService</a></code></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="clearIndexStoreCache--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>clearIndexStoreCache</h4> | |
| <pre>public void clearIndexStoreCache()</pre> | |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#clearIndexStoreCache--">CacheInvalidationService</a></code></span></div> | |
| <div class="block">Clears `indexStore` cache fully</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#clearIndexStoreCache--">clearIndexStoreCache</a></code> in interface <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html" title="interface in org.janusgraph.graphdb.database.cache">CacheInvalidationService</a></code></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="clearDBCache--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>clearDBCache</h4> | |
| <pre>public void clearDBCache()</pre> | |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#clearDBCache--">CacheInvalidationService</a></code></span></div> | |
| <div class="block">Clears both `edgeStore` cache and `indexStore` cache fully. | |
| It is the same as calling <a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#clearEdgeStoreCache--"><code>CacheInvalidationService.clearEdgeStoreCache()</code></a> and <a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#clearIndexStoreCache--"><code>CacheInvalidationService.clearIndexStoreCache()</code></a></div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html#clearDBCache--">clearDBCache</a></code> in interface <code><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html" title="interface in org.janusgraph.graphdb.database.cache">CacheInvalidationService</a></code></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| </div> | |
| <!-- ========= END OF CLASS DATA ========= --> | |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
| <div class="bottomNav"><a name="navbar.bottom"> | |
| <!-- --> | |
| </a> | |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> | |
| <a name="navbar.bottom.firstrow"> | |
| <!-- --> | |
| </a> | |
| <ul class="navList" title="Navigation"> | |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> | |
| <li><a href="package-summary.html">Package</a></li> | |
| <li class="navBarCell1Rev">Class</li> | |
| <li><a href="class-use/KCVSCacheInvalidationService.html">Use</a></li> | |
| <li><a href="package-tree.html">Tree</a></li> | |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> | |
| <li><a href="../../../../../index-all.html">Index</a></li> | |
| <li><a href="../../../../../help-doc.html">Help</a></li> | |
| </ul> | |
| </div> | |
| <div class="subNav"> | |
| <ul class="navList"> | |
| <li><a href="../../../../../org/janusgraph/graphdb/database/cache/CacheInvalidationService.html" title="interface in org.janusgraph.graphdb.database.cache"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../org/janusgraph/graphdb/database/cache/MetricInstrumentedSchemaCache.html" title="class in org.janusgraph.graphdb.database.cache"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../index.html?org/janusgraph/graphdb/database/cache/KCVSCacheInvalidationService.html" target="_top">Frames</a></li> | |
| <li><a href="KCVSCacheInvalidationService.html" target="_top">No Frames</a></li> | |
| </ul> | |
| <ul class="navList" id="allclasses_navbar_bottom"> | |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> | |
| </ul> | |
| <div> | |
| <script type="text/javascript"> | |
| </script> | |
| </div> | |
| <div> | |
| <ul class="subNavList"> | |
| <li>Summary: </li> | |
| <li>Nested | </li> | |
| <li>Field | </li> | |
| <li><a href="#constructor.summary">Constr</a> | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li>Field | </li> | |
| <li><a href="#constructor.detail">Constr</a> | </li> | |
| <li><a href="#method.detail">Method</a></li> | |
| </ul> | |
| </div> | |
| <a name="skip.navbar.bottom"> | |
| <!-- --> | |
| </a></div> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <p class="legalCopy"><small>Copyright © 2012–2023. All rights reserved.</small></p> | |
| </body> | |
| </html> | |