summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNalin Dahyabhai <nalin.dahyabhai@pobox.com>2008-12-03 13:25:42 -0500
committerNalin Dahyabhai <nalin.dahyabhai@pobox.com>2008-12-03 13:25:42 -0500
commit1e8c429821c54142aff9e580023629246cc97c5c (patch)
tree869a5afa767e83b494346ee2bf6512d404a65cc2
parente73a4337188d3e1dd7bb0e55f90ec4a25e56ccae (diff)
downloadslapi-nis-1e8c429821c54142aff9e580023629246cc97c5c.tar.gz
slapi-nis-1e8c429821c54142aff9e580023629246cc97c5c.tar.xz
slapi-nis-1e8c429821c54142aff9e580023629246cc97c5c.zip
- point out that attributes which are used to hold DNs should be indexed
-rw-r--r--doc/format-specifiers.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/format-specifiers.txt b/doc/format-specifiers.txt
index 4b700ac..c20471a 100644
--- a/doc/format-specifiers.txt
+++ b/doc/format-specifiers.txt
@@ -170,6 +170,9 @@ And here's how various expressions evaluate for ''cn=group'':
%deref("member","foo") -> no values
%deref("member","uid") -> (bob,pete)
+Because the plugin attempts to track updates, the ''THISATTRIBUTE''
+attribute should be indexed.
+
=== deref_r ===
deref_r(''ATTRIBUTE''[,''OTHERATTRIBUTE''[...]],''VALUEATTRIBUTE'')
@@ -253,6 +256,9 @@ Here's another example:
The result list is pulled from this set of entries.
+Because the plugin attempts to track updates, every attribute used here
+(except for ''VALUEATTRIBUTE'') should be indexed.
+
=== referred ===
referred(''SET'',''THATATTRIBUTE'',''THATOTHERATTRIBUTE'')
@@ -281,6 +287,9 @@ And here's how various expressions evaluate for ''cn=group'', if
%referred("SET","memberof","foo") -> no values
%referred("SET","memberof","uid") -> (bob,pete)
+Because the plugin performs searches internally, ''THATATTRIBUTE''
+should be indexed.
+
=== referred_r ===
referred_r(''SET'',''ATTRIBUTE''[,''OTHERSET'',''OTHERATTRIBUTE''[,...],''VALUEATTRIBUTE'')
@@ -318,6 +327,9 @@ the entries with ''uid'' values are in a set named ''people'':
%referred("people","memberof","foo") -> no values
%referred("people","memberof","uid") -> (bob,pete)
+Because the plugin performs searches internally, every attribute used
+here (except for ''VALUEATTRIBUTE'') should be indexed.
+
=== merge ===
merge(''SEPARATOR'',''EXPRESSION''[,...])