This page (revision-1) was last changed on 29-Nov-2024 16:16 by UnknownAuthor

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Page revision history

Version Date Modified Size Author Changes ... Change note

Page References

Incoming links Outgoing links
Simple Paged Results Control
Simple Paged Results Control

Version management

Difference between version and

At line 1 added 78 lines
!!! Overview
The simple paged results control is a [SupportedControl] that can be attached to a search operation to indicate that only a subset of the results should be returned.
The simple paged results control is defined in [RFC 2696].
[{$pagename}] may be used to iterate through the search results a page at a time.
Similar to the virtual list view control with the exception that it doesn't require the results to be sorted and can only be used to iterate sequentially through the search results.
[{$pagename}] may be useful when:
* the LDAP client has limited resources
* on very large result sets where the client may not be able to process the entire result set from a given LDAP query
* or when the LDAP client is connected over a low-bandwidth connection.
* there are limits set on the LDAP server as when using [Microsoft Active Directory] and [MaxPageSize] is exceeded.
The same control is used for both the [SearchRequest] and [SearchResultDone] messages.
[{$pagename}] has an OID of [1.2.840.113556.1.4.319], and the value is encoded as follows:
{{{
realSearchControlValue ::= SEQUENCE {
size INTEGER (0..maxInt),
-- requested page size from client
-- result set size estimate from server
cookie OCTET STRING
}
}}}
!! An [Example] [LDAPSEARCH]
[{$pagename}] allows a search operation to return only a subset of the results at a time. It can be used to iterate through the search results a page at a time.
[{$pagename}] is similar to the Virtual List View Control with the exception that it does not require the results to be sorted and can only be used to iterate sequentially through the search results.
Use the ldapsearch command with the --simplePageSize option.
The following command also uses the --countEntries option to mark each page.
%%prettify
{{{
$ ldapsearch --hostname localhost --port 1389 --bindDN "cn=Directory Manager" --bindPassword password --searchScope sub --baseDN dc=example,dc=com --simplePageSize 2 --countEntries "(objectclass=*)"
dn: ou=Groups,dc=example,dc=com
objectClass: organizationalunit
objectClass: top
ou: Groups
dn: ou=People,dc=example,dc=com
objectClass: organizationalunit
objectClass: top
ou: People
# Total number of matching entries: 2
dn: ou=Special Users,dc=example,dc=com
objectClass: organizationalUnit
objectClass: top
description: Special Administrative Accounts
ou: Special Users
dn: ou=Company Servers,dc=example,dc=com
objectClass: organizationalUnit
objectClass: top
description: Standard branch for Company Server registration
ou: Company Servers
# Total number of matching entries: 2
dn: ou=Contractors,dc=example,dc=com
objectClass: organizationalUnit
objectClass: top
ou: Contractors
ou: Product Testing
ou: Product Development
ou: Accounting
# Total number of matching entries: 1
}}}For [Example], [Microsoft Active Directory] have a default server-side limit of 1000 entries, controlled by the [MaxPageSize] within the [LDAP policy in Active Directory], of results that are returned in a single request. If the results of a query exceed the [MaxPageSize] value, the Paged Results control is used with a page size equal to or less than the server-side limit in order to retrieve all of the results of the query.
!! More Information
There might be more information for this subject on one of the following:
[{ReferringPagesPlugin before='*' after='\n' }]
This page (revision-1) was last changed on 29-Nov-2024 16:16 by UnknownAuthorTop