Documentation Home
MySQL PHP API
Download this Manual
PDF (US Ltr) - 2.5Mb
PDF (A4) - 2.4Mb
HTML Download (TGZ) - 250.9Kb
HTML Download (Zip) - 258.4Kb


MySQL PHP API  /  ...  /  Schema::getCollection

5.25.5 Schema::getCollection

Copyright 1997-2019 the PHP Documentation Group.

  • Schema::getCollection

    Get collection from schema

Description

public mysql_xdevapi\Collection mysql_xdevapi\Schema::getCollection(string name);

Get a collection from the schema.

Parameters

name

Collection name to retrieve.

Return Values

The Collection object for the selected collection.

Examples

Example 5.103 Schema::getCollection example

<?php
$session = mysql_xdevapi\getSession("mysqlx://user:password@localhost");

$session->sql("DROP DATABASE IF EXISTS food")->execute();
$session->sql("CREATE DATABASE food")->execute();

$schema = $session->getSchema("food");
$schema->createCollection("trees");

// ...

$trees = $schema->getCollection("trees");

var_dump($trees);

The above example will output something similar to:

object(mysql_xdevapi\Collection)#3 (1) {
  ["name"]=>
  string(5) "trees"
}