https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/YANGTOOLS-570 yangtools <p>DataTree currently does not support enforcing 'unique' statements, provide an implementation.</p> <p>The implementation will need to maintain ssecondary indices based on the these statements, so that the enforcement works correctly.</p> <p>Expose these secondary indices so that they can be used for queries.</p> <p>Operating System: All<br/> Platform: All</p> YANGTOOLS-570

Support unique statement for enforcement and secondary indices

New Feature Highest Confirmed Unresolved Unassigned Robert Varga Wed, 13 Jan 2016 16:16:30 +0000 Thu, 18 Jan 2024 18:20:38 +0000 14.0.0 data-impl 0 4 <p>I assume that the prerequisite is also that the "unique" statement is exposed by the YANG parser (e.g. in ListSchemaNode), which is currently not the case. </p> <p>Will this also be fixed by this bug? Or should a separate bug ticket be submitted?</p> <p>(In reply to Peter Verthez from comment #1)<br/> &gt; I assume that the prerequisite is also that the "unique" statement is<br/> &gt; exposed by the YANG parser (e.g. in ListSchemaNode), which is currently not<br/> &gt; the case. <br/> &gt; <br/> &gt; Will this also be fixed by this bug? Or should a separate bug ticket be<br/> &gt; submitted?</p> <p>Please create a separate bug with dependency to this bug. <br/> Thanks.</p> <p>ok, <a href="https://bugs.opendaylight.org/show_bug.cgi?id=5946" class="external-link" target="_blank" rel="nofollow noopener">https://bugs.opendaylight.org/show_bug.cgi?id=5946</a> submitted</p> <p>From data management perspective, YANG defines two concepts which ensure a logical combination of leaves is unique.</p> <p>The key statement is equivalent to an SQL primary key. Each list entry must have a unique combination of leaves specified by the key statement argument. These leaves must be immediate part of the list entry. Also, much like a SQL primary key, it acts as an index, allowing quick access to specific entries &#8211; which we achieve by storing list items in Maps keyed by NodeIdentifierWithPredicates.</p> <p>The unique statement is similar in that it defines a combination of leaves which has to be unique &#8211; very much like an SQL UNIQUE constraint. There are two differences:</p> <ul class="alternate" type="square"> <li>every container/list can define multiple unique statements (as opposed to a single key)</li> <li>leaves in a unique statement can target any descendant leaf</li> </ul> <p>Given the following model:</p> <p> list foo {<br/> key bar;<br/> leaf bar;</p> <p> container baz </p> { leaf baz; } <p> container qux </p> { leaf qux; } <p> unique "baz/baz qux/qux";<br/> }</p> <p>the implementation challenge is to efficiently detect when a write to 'leaf baz' triggers a constraint violation while allowing it to be over-written with the same value.</p> <p>A naive implementation would require a full scan of 'list bar' to establish if there are any conflicts. This is obviously not feasible if the list has a million entries and most of them do not even have 'leaf baz'.</p> <p>Hence our implementation needs to maintain a set of indices (Maps?) which will allow us to realize that a leaf is part of a unique statement and create the corresponding unique key. This will then need to be looked up to see if a conflicting entry exists.</p> <p>Note that this is a simplistic example, YANG does seem to allow for absolute paths to leaves and nested lists, which are bound to complicate the lookups. For an initial prototype we need to handle the case above and then we can evaluate how to extend it to full compliance.</p> <p>Once we have the indices working internally in the DataTree, we need to think about how to allow users to use them, as a common request from application developers is to read the list entry which matches a unique constraint &#8211; e.g. they know the values of leaves in the unique statement without knowledge of the primary key.</p> <p><a href="https://git.opendaylight.org/gerrit/#/c/40145/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/40145/</a></p> Blocks YANGTOOLS-627 YANGTOOLS-616 Development Epic Link YANGTOOLS-194 External issue ID 4955 External issue URL Issue Type Rank 0|i0281j: