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


MySQL PHP API  /  ...  /  Collection::getSchema

5.6.11 Collection::getSchema

Copyright 1997-2019 the PHP Documentation Group.

  • Collection::getSchema

    Get schema object

Description

public Schema Object mysql_xdevapi\Collection::getSchema();

Retrieve the schema object that contains the collection.

Parameters

This function has no parameters.

Return Values

The schema object on success, or NULL if the object cannot be retrieved for the given collection.

Examples

Example 5.20 mysql_xdevapi\Collection::getSchema 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");
$collection = $schema->createCollection("people");

var_dump($collection->getSchema());
?>

The above example will output something similar to:


object(mysql_xdevapi\Schema)#9 (1) {
  ["name"]=>
  string(11) "addressbook"
}