&reftitle.examples;
The central entry point to the X DevAPI is the mysql_xdevapi\getSession
function, which receives a URI to a MySQL 8.0 Server and returns a
mysql_xdevap\Session object.
Connecting to a MySQL Server
]]>
The session provides full access to the API. For a new MySQL Server installation,
the first step is to create a database schema with a collection
to store data:
Creating a Schema and Collection on the MySQL Server
createSchema("test");
$collection = $schema->createCollection("example");
?>
]]>
When storing data, typically json_encode is used to encode
the data into JSON, which can then be stored inside a collection.
The following example stores data into the collection we created earlier,
and then retrieve parts of it again.
Storing and Retrieving Data
"Marco",
"age" => 19,
"job" => "Programmer"
];
$mike = [
"name" => "Mike",
"age" => 39,
"job" => "Manager"
];
$schema = $session->getSchema("test");
$collection = $schema->getCollection("example");
$collection->add($marco, $mike)->execute();
var_dump($collection->find("name = 'Mike'")->execute()->fetchOne());
?>
]]>
&example.outputs.similar;
string(28) "00005ad66aaf0000000000000003"
["age"]=>
int(39)
["job"]=>
string(7) "Manager"
["name"]=>
string(4) "Mike"
}
]]>
The example demonstrates that the MySQL Server adds an extra field named
_id, which serves as primary key to the document.
The example also demonstrates that retrieved data is sorted alphabetically.
That specific order comes from the efficient binary storage inside the MySQL server, but
it should not be relied upon. Refer to the MySQL JSON datatype documentation for details.
Optionally use PHP's iterators fetch multiple documents:
Fetching and Iterating Multiple Documents
find()->execute());
foreach ($result as $doc) {
echo "${doc["name"]} is a ${doc["job"]}.\n";
}
?>
]]>
&example.outputs.similar;