Deploying to master from @ JanusGraph/janusgraph@213b754 🚀

Author: ntisseyre

master/changelog/index.html

@@ -908,6 +908,26 @@
     Label Constraint
   </a>
 
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#inlining-vertex-properties-into-a-composite-index" class="md-nav__link">
+    Inlining vertex properties into a Composite Index
+  </a>
+  
+    <nav class="md-nav" aria-label="Inlining vertex properties into a Composite Index">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#usage" class="md-nav__link">
+    Usage
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
 
           <li class="md-nav__item">
@@ -2161,6 +2181,26 @@
     Label Constraint
   </a>
 
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#inlining-vertex-properties-into-a-composite-index" class="md-nav__link">
+    Inlining vertex properties into a Composite Index
+  </a>
+  
+    <nav class="md-nav" aria-label="Inlining vertex properties into a Composite Index">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#usage" class="md-nav__link">
+    Usage
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
 
           <li class="md-nav__item">
@@ -2523,6 +2563,43 @@ <h3 id="label-constraint">Label Constraint</h3>
 index with label restriction is defined as unique, the uniqueness
 constraint only applies to properties on vertices or edges for the
 specified label.</p>
+<h3 id="inlining-vertex-properties-into-a-composite-index">Inlining vertex properties into a Composite Index</h3>
+<p>Inlining vertex properties into a Composite Index structure can offer significant performance and efficiency benefits.</p>
+<ol>
+<li>
+<p><strong>Performance Improvements</strong>
+Faster Querying: Inlining vertex properties directly within the index allows the search engine to retrieve all relevant data from the index itself. 
+This means, queries don’t need to make additional calls to data stores to fetch full vertex information, significantly reducing lookup time.</p>
+</li>
+<li>
+<p><strong>Data Locality</strong>
+In distributed storages, having inlined properties ensures that more complete data exists within individual partitions or shards.
+This reduces cross-node network calls and improves the overall query performance by ensuring data is more local to the request being processed.</p>
+</li>
+<li>
+<p><strong>Cost of Indexing vs. Storage Trade-off</strong>
+While inlining properties increases the size of the index (potentially leading to more extensive index storage requirements), 
+it is often a worthwhile trade-off for performance, mainly when query speed is critical. 
+This is a typical pattern in systems optimized for read-heavy workloads.</p>
+</li>
+</ol>
+<h4 id="usage">Usage</h4>
+<p>In order to take advantage of the inlined properties feature, JanusGraph Transaction should be set to use <code>.propertyPrefetching(false)</code></p>
+<p>Example:</p>
+<div class="highlight"><pre><span></span><code><span class="c1">//Build index</span>
+<span class="n">mgmt</span><span class="o">.</span><span class="na">buildIndex</span><span class="o">(</span><span class="s2">&quot;composite&quot;</span><span class="o">,</span><span class="w"> </span><span class="n">Vertex</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
+<span class="w">    </span><span class="o">.</span><span class="na">addKey</span><span class="o">(</span><span class="n">idKey</span><span class="o">)</span>
+<span class="w">    </span><span class="o">.</span><span class="na">addInlinePropertyKey</span><span class="o">(</span><span class="n">nameKey</span><span class="o">)</span>
+<span class="w">    </span><span class="o">.</span><span class="na">buildCompositeIndex</span><span class="o">()</span>
+<span class="n">mgmt</span><span class="o">.</span><span class="na">commit</span><span class="o">()</span>
+
+<span class="c1">//Query</span>
+<span class="n">tx</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">graph</span><span class="o">.</span><span class="na">buildTransaction</span><span class="o">()</span>
+<span class="w">    </span><span class="o">.</span><span class="na">propertyPrefetching</span><span class="o">(</span><span class="kc">false</span><span class="o">)</span><span class="w"> </span><span class="c1">//this is important</span>
+<span class="w">    </span><span class="o">.</span><span class="na">start</span><span class="o">()</span>
+
+<span class="n">tx</span><span class="o">.</span><span class="na">traversal</span><span class="o">().</span><span class="na">V</span><span class="o">().</span><span class="na">has</span><span class="o">(</span><span class="s2">&quot;id&quot;</span><span class="o">,</span><span class="w"> </span><span class="mi">100</span><span class="o">).</span><span class="na">next</span><span class="o">().</span><span class="na">value</span><span class="o">(</span><span class="s2">&quot;name&quot;</span><span class="o">)</span>
+</code></pre></div>
 <h3 id="composite-versus-mixed-indexes">Composite versus Mixed Indexes</h3>
 <ol>
 <li>