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  /  Mysql_xdevapi

Chapter 5 Mysql_xdevapi

Table of Contents

5.1 Installing/Configuring
5.1.1 Requirements
5.1.2 Installation
5.1.3 Runtime Configuration
5.1.4 Building / Compiling From Source
5.2 Predefined Constants
5.3 Examples
5.4 Mysql_xdevapi Functions
5.4.1 expression
5.4.2 getSession
5.5 BaseResult interface
5.5.1 BaseResult::getWarnings
5.5.2 BaseResult::getWarningsCount
5.6 Client class
5.6.1 mysql_xdevapi\Client::close
5.6.2 Client::__construct
5.6.3 Client::getClient
5.7 Collection class
5.7.1 Collection::add
5.7.2 Collection::addOrReplaceOne
5.7.3 Collection::__construct
5.7.4 Collection::count
5.7.5 Collection::createIndex
5.7.6 Collection::dropIndex
5.7.7 Collection::existsInDatabase
5.7.8 Collection::find
5.7.9 Collection::getName
5.7.10 Collection::getOne
5.7.11 Collection::getSchema
5.7.12 Collection::getSession
5.7.13 Collection::modify
5.7.14 Collection::remove
5.7.15 Collection::removeOne
5.7.16 Collection::replaceOne
5.8 CollectionAdd class
5.8.1 CollectionAdd::__construct
5.8.2 CollectionAdd::execute
5.9 CollectionFind class
5.9.1 CollectionFind::bind
5.9.2 CollectionFind::__construct
5.9.3 CollectionFind::execute
5.9.4 CollectionFind::fields
5.9.5 CollectionFind::groupBy
5.9.6 CollectionFind::having
5.9.7 CollectionFind::limit
5.9.8 CollectionFind::lockExclusive
5.9.9 CollectionFind::lockShared
5.9.10 CollectionFind::offset
5.9.11 CollectionFind::sort
5.10 CollectionModify class
5.10.1 CollectionModify::arrayAppend
5.10.2 CollectionModify::arrayInsert
5.10.3 CollectionModify::bind
5.10.4 CollectionModify::__construct
5.10.5 CollectionModify::execute
5.10.6 CollectionModify::limit
5.10.7 CollectionModify::patch
5.10.8 CollectionModify::replace
5.10.9 CollectionModify::set
5.10.10 CollectionModify::skip
5.10.11 CollectionModify::sort
5.10.12 CollectionModify::unset
5.11 CollectionRemove class
5.11.1 CollectionRemove::bind
5.11.2 CollectionRemove::__construct
5.11.3 CollectionRemove::execute
5.11.4 CollectionRemove::limit
5.11.5 CollectionRemove::sort
5.12 ColumnResult class
5.12.1 ColumnResult::__construct
5.12.2 ColumnResult::getCharacterSetName
5.12.3 ColumnResult::getCollationName
5.12.4 ColumnResult::getColumnLabel
5.12.5 ColumnResult::getColumnName
5.12.6 ColumnResult::getFractionalDigits
5.12.7 ColumnResult::getLength
5.12.8 ColumnResult::getSchemaName
5.12.9 ColumnResult::getTableLabel
5.12.10 ColumnResult::getTableName
5.12.11 ColumnResult::getType
5.12.12 ColumnResult::isNumberSigned
5.12.13 ColumnResult::isPadded
5.13 CrudOperationBindable interface
5.13.1 CrudOperationBindable::bind
5.14 CrudOperationLimitable interface
5.14.1 CrudOperationLimitable::limit
5.15 CrudOperationSkippable interface
5.15.1 CrudOperationSkippable::skip
5.16 CrudOperationSortable interface
5.16.1 CrudOperationSortable::sort
5.17 DatabaseObject interface
5.17.1 DatabaseObject::existsInDatabase
5.17.2 DatabaseObject::getName
5.17.3 DatabaseObject::getSession
5.18 DocResult class
5.18.1 DocResult::__construct
5.18.2 DocResult::fetchAll
5.18.3 DocResult::fetchOne
5.18.4 DocResult::getWarnings
5.18.5 DocResult::getWarningsCount
5.19 Exception class
5.20 Executable interface
5.20.1 Executable::execute
5.21 ExecutionStatus class
5.21.1 ExecutionStatus::__construct
5.22 Expression class
5.22.1 Expression::__construct
5.23 Result class
5.23.1 Result::__construct
5.23.2 Result::getAffectedItemsCount
5.23.3 Result::getAutoIncrementValue
5.23.4 Result::getGeneratedIds
5.23.5 Result::getWarnings
5.23.6 Result::getWarningsCount
5.24 RowResult class
5.24.1 RowResult::__construct
5.24.2 RowResult::fetchAll
5.24.3 RowResult::fetchOne
5.24.4 RowResult::getColumnsCount
5.24.5 RowResult::getColumnNames
5.24.6 RowResult::getColumns
5.24.7 RowResult::getWarnings
5.24.8 RowResult::getWarningsCount
5.25 Schema class
5.25.1 Schema::__construct
5.25.2 Schema::createCollection
5.25.3 Schema::dropCollection
5.25.4 Schema::existsInDatabase
5.25.5 Schema::getCollection
5.25.6 Schema::getCollectionAsTable
5.25.7 Schema::getCollections
5.25.8 Schema::getName
5.25.9 Schema::getSession
5.25.10 Schema::getTable
5.25.11 Schema::getTables
5.26 SchemaObject interface
5.26.1 SchemaObject::getSchema
5.27 Session class
5.27.1 Session::close
5.27.2 Session::commit
5.27.3 Session::__construct
5.27.4 Session::createSchema
5.27.5 Session::dropSchema
5.27.6 Session::generateUUID
5.27.7 Session::getDefaultSchema
5.27.8 Session::getSchema
5.27.9 Session::getSchemas
5.27.10 Session::getServerVersion
5.27.11 Session::listClients
5.27.12 Session::quoteName
5.27.13 Session::releaseSavepoint
5.27.14 Session::rollback
5.27.15 Session::rollbackTo
5.27.16 Session::setSavepoint
5.27.17 Session::sql
5.27.18 Session::startTransaction
5.28 SqlStatement class
5.28.1 SqlStatement::bind
5.28.2 SqlStatement::__construct
5.28.3 SqlStatement::execute
5.28.4 SqlStatement::getNextResult
5.28.5 SqlStatement::getResult
5.28.6 SqlStatement::hasMoreResults
5.29 SqlStatementResult class
5.29.1 SqlStatementResult::__construct
5.29.2 SqlStatementResult::fetchAll
5.29.3 SqlStatementResult::fetchOne
5.29.4 SqlStatementResult::getAffectedItemsCount
5.29.5 SqlStatementResult::getColumnsCount
5.29.6 SqlStatementResult::getColumnNames
5.29.7 SqlStatementResult::getColumns
5.29.8 SqlStatementResult::getGeneratedIds
5.29.9 SqlStatementResult::getLastInsertId
5.29.10 SqlStatementResult::getWarnings
5.29.11 SqlStatementResult::getWarningsCount
5.29.12 SqlStatementResult::hasData
5.29.13 SqlStatementResult::nextResult
5.30 Statement class
5.30.1 Statement::__construct
5.30.2 Statement::getNextResult
5.30.3 Statement::getResult
5.30.4 Statement::hasMoreResults
5.31 Table class
5.31.1 Table::__construct
5.31.2 Table::count
5.31.3 Table::delete
5.31.4 Table::existsInDatabase
5.31.5 Table::getName
5.31.6 Table::getSchema
5.31.7 Table::getSession
5.31.8 Table::insert
5.31.9 Table::isView
5.31.10 Table::select
5.31.11 Table::update
5.32 TableDelete class
5.32.1 TableDelete::bind
5.32.2 TableDelete::__construct
5.32.3 TableDelete::execute
5.32.4 TableDelete::limit
5.32.5 TableDelete::orderby
5.32.6 TableDelete::where
5.33 TableInsert class
5.33.1 TableInsert::__construct
5.33.2 TableInsert::execute
5.33.3 TableInsert::values
5.34 TableSelect class
5.34.1 TableSelect::bind
5.34.2 TableSelect::__construct
5.34.3 TableSelect::execute
5.34.4 TableSelect::groupBy
5.34.5 TableSelect::having
5.34.6 TableSelect::limit
5.34.7 TableSelect::lockExclusive
5.34.8 TableSelect::lockShared
5.34.9 TableSelect::offset
5.34.10 TableSelect::orderby
5.34.11 TableSelect::where
5.35 TableUpdate class
5.35.1 TableUpdate::bind
5.35.2 TableUpdate::__construct
5.35.3 TableUpdate::execute
5.35.4 TableUpdate::limit
5.35.5 TableUpdate::orderby
5.35.6 TableUpdate::set
5.35.7 TableUpdate::where
5.36 Warning class
5.36.1 Warning::__construct

Copyright 1997-2020 the PHP Documentation Group.

This extension provides access to the MySQL Document Store via the X DevAPI. The X DevAPI is a common API provided by multiple MySQL Connectors providing easy access to relational tables as well as collections of documents, which are represented in JSON, from a API with CRUD-style operations.

The X DevAPI uses the X Protocol, the new generation client-server protocol of the MySQL 8.0 server.

For general information about the MySQL Document Store, please refer to the MySQL Document Store chapter in the MySQL manual.