CollectionFind::offset

返される要素の数から、与えられた数をスキップする

説明

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

find 操作によって返されたはずの要素から、指定された数の要素(offset) をスキップします。 limit() メソッドと一緒に使います。

結果セットのサイズとよりも大きな offset を指定すると、空の結果セットが返されます。

パラメータ

position: limit() 操作のためにスキップする要素の数

戻り値

追加の操作に使える CollectionFind オブジェクトを返します。

例

例1 mysql_xdevapi\CollectionFind::offset の例

<?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());
?>

上の例の出力は、たとえば以下のようになります。

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