Infoblox::Cursor - Manages paged searches.


NAME

Infoblox::Cursor - Manages paged searches.


DESCRIPTION

This class enables users to conduct database searches returning large datasets in an object-by-object manner.


CONSTRUCTOR

 my $cursor=$session->new_cursor(
                                fetch_size     => 200,
                                object         => "Infoblox::DNS::AllRecords",
                                return_methods => ['name'],
                                name           => ".*"
                               );


METHODS

This section describes all the methods that you can use when creating a cursor used for paged searches.

fetch_size( )

This method is used to set the amount of records returned from the back-end to the client for every request. Larger values will cause less requests to be sent to the back-end and more memory used on the client-side; smaller values will cause more requests.

The default value is 100.

other parameters

Other parameters for this constructor are any valid search parameters as described in Infoblox::Session->search()

Supported object types

Paged search is supported for the following object types:

Infoblox::DNS::AllRecords
Infoblox::DNS::Zone
Infoblox::DHCP::FixedAddr
Infoblox::DHCP::Network
Infoblox::DNS::Host
Infoblox::DNS::Record::A
Infoblox::DNS::Record::AAAA
Infoblox::DNS::Record::PTR
Infoblox::DNS::Record::TXT
Infoblox::DNS::Record::MX
Infoblox::DNS::Record::SRV
Infoblox::DNS::Record::CNAME
Infoblox::DNS::Record::DNAME


SAMPLE CODE

The following sample code demonstrates how to execute a paged search.

 #PROGRAM STARTS: Include all the modules that will be used
    $cursor=$session->new_cursor(
                                 fetch_size => 100,
                                 object => "Infoblox::DNS::AllRecords",
                                 name   => '.*',
                                );
    while ($current_record = $cursor->fetch()) {
        # $current_record will contain a matching record object
    }


AUTHOR

Infoblox Inc. http://www.infoblox.com/


SEE ALSO

Infoblox::Session, Infoblox::Session->search()


COPYRIGHT

Copyright (c) 2017 Infoblox Inc.