[jira] [Commented] (OAK-3728) Document indexes in the index itself

["angela (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/OAK-3728?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15046648#comment-15046648 ] 

angela commented on OAK-3728:
-----------------------------

not quite... ;-)

- authorizableId: to enforce uniqueness constraint. it's not used for lookup by id
- principalName: to enforce uniqueness constraint. in regular usage it's not used for lookup by principal name as the principals exposed by the API have a path attached. only if someone constructs the principal manually the query is used.


> Document indexes in the index itself
> ------------------------------------
>
>                 Key: OAK-3728
>                 URL: https://issues.apache.org/jira/browse/OAK-3728
>             Project: Jackrabbit Oak
>          Issue Type: Improvement
>          Components: query
>            Reporter: Thomas Mueller
>            Assignee: Thomas Mueller
>             Fix For: 1.4
>
>         Attachments: OAK-3728.patch
>
>
> Out-of-the box indexes should be documented, so that people know why they are needed. This is mainly needed for Oak indexes; we don't need to enforce this for user defined indexes. 
> To do that, for each index, a property "info" could be added. Example:
> {noformat}
> /oak:index/nodetype/info = "Oak index used for ..."
> {noformat}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)