php8.5
Home/ Manual/ mysql_xdevapi / collection/ Collection::getSchema

Collection::getSchema

PHP function Edit on GitHub ✎

Get schema object

Description

mysql_xdevapi\Collection::getSchema(): Schema Object

Retrieve the schema object that contains the collection.

Parameters Parameters

Return Values

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

Examples

mysql_xdevapi\Collection::getSchema() example

php
<?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:

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

Source: reference/mysql_xdevapi/mysql_xdevapi/collection/getschema.xml · from the official PHP manual (php/doc-en)