PHP 7.4.0RC4 Released!

CollectionFind::offset

(No version information available, might only be in Git)

CollectionFind::offsetSkip given number of elements to be returned

Description

public mysql_xdevapi\CollectionFind::offset ( integer $position ) : mysql_xdevapi\CollectionFind

Skip (offset) these number of elements that otherwise would be returned by the find operation. Use with the limit() method.

Defining an offset larger than the result set size results in an empty set.

Parameters

position

Number of elements to skip for the limit() operation.

Return Values

A CollectionFind object that can be used for additional processing.

Examples

Example #1 mysql_xdevapi\CollectionFind::offset() example

<?php
$session 
mysql_xdevapi\getSession("mysqlx://user:password@localhost");
$session->sql("DROP DATABASE IF EXISTS addressbook")->execute();
$session->sql("CREATE DATABASE addressbook")->execute();

$schema $session->getSchema("addressbook");
$create $schema->createCollection("people");
$create
  
->add('{"name": "Alfred", "age": 18, "job": "Butler"}')
  ->
execute();
$create
  
->add('{"name": "Reginald", "age": 42, "job": "Butler"}')
  ->
execute();

// ...

$collection $schema->getCollection("people");

$result $collection
  
->find()
  ->
sort('age asc')
  ->
offset(1)
  ->
limit(1)
  ->
execute();

var_dump($result->fetchAll());
?>

The above example will output something similar to:

array(1) {
  [0]=>
  array(4) {
    ["_id"]=>
    string(28) "00005b6b536100000000000000f3"
    ["age"]=>
    int(42)
    ["job"]=>
    string(6) "Butler"
    ["name"]=>
    string(8) "Reginald"
  }
}
add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top