# Mysql_xdevapi

# Introducción

Esta extensión proporciona acceso al Document Store de MySQL a través de la DevAPI X. La DevAPI X es una API común proporcionada por varios MySQL Connectors que permiten un acceso fácil a las tablas relacionales así como a las colecciones de documentos, que se representan en JSON, desde una API con operaciones de estilo CRUD.

La DevAPI de X utiliza el protocolo X, el protocolo de nueva generación cliente-servidor de MySQL servidor 8.0.

Para información general sobre MySQL Document Store, consulte el capítulo » MySQL Document Store del manual de MySQL.

- Instalación/Configuración
  - Requerimientos
  - Instalación
  - Configuración en tiempo de ejecución
  - Compilar a partir de las fuentes
- Constantes predefinidas
- Registro de cambios
- Ejemplos
- Funciones Mysql_xdevapi
  - expression — Vincula una expresión a una variable de consulta preparada
  - getSession — Conecta a un servidor MySQL
- mysql_xdevapi\BaseResult — Interfaz BaseResult
  - BaseResult::getWarnings — Recupera los avisos de la última operación
  - BaseResult::getWarningsCount — Recupera el número de advertencias de la última operación
- mysql_xdevapi\Client — La clase Client
  - mysql_xdevapi\Client::close — Cierra el cliente
  - Client::__construct — Constructor del cliente
  - Client::getClient — Devuelve la sesión del cliente
- mysql_xdevapi\Collection — Clase Collection
  - Collection::add — Añade un documento a la colección
  - Collection::addOrReplaceOne — Añade o reemplaza un documento de la colección
  - Collection::__construct — Constructor de Collection
  - Collection::count — Devuelve el número de documentos
  - Collection::createIndex — Crear un índice de colección
  - Collection::dropIndex — Elimina un índice de colección
  - Collection::existsInDatabase — Verifica si la colección existe en la base de datos
  - Collection::find — Búsqueda de documento
  - Collection::getName — Devuelve el nombre de la colección
  - Collection::getOne — Devuelve un documento
  - Collection::getSchema — Devuelve el objeto esquema
  - Collection::getSession — Devuelve el objeto session
  - Collection::modify — Modifica los documentos de la colección
  - Collection::remove — Elimina documentos de la colección
  - Collection::removeOne — Elimina un documento de la colección
  - Collection::replaceOne — Reemplaza un documento de la colección
- mysql_xdevapi\CollectionAdd — Clase CollectionAdd
  - CollectionAdd::__construct — Constructor de CollectionAdd
  - CollectionAdd::execute — Ejecuta la declaración
- mysql_xdevapi\CollectionFind — Clase CollectionFind
  - CollectionFind::bind — Liga un valor a un argumento de consulta
  - CollectionFind::__construct — Constructor de CollectionFind
  - CollectionFind::execute — Ejecuta la declaración
  - CollectionFind::fields — Define el filtro de campo de documento
  - CollectionFind::groupBy — Define los criterios de agrupación
  - CollectionFind::having — Define la condición para las funciones de agregación
  - CollectionFind::limit — Limita el número de documentos devueltos
  - CollectionFind::lockExclusive — Ejecuta la operación con un BLOQUEO EXCLUSIVO
  - CollectionFind::lockShared — Ejecuta la operación con un BLOQUEO COMPARTIDO
  - CollectionFind::offset — Ignorar un número dado de elementos a devolver
  - CollectionFind::sort — Define los criterios de ordenación
- mysql_xdevapi\CollectionModify — Clase CollectionModify
  - CollectionModify::arrayAppend — Añade un elemento a un campo de array
  - CollectionModify::arrayInsert — Inserta un elemento en un campo de array
  - CollectionModify::bind — Liga un valor a un parámetro de consulta
  - CollectionModify::__construct — Constructor de CollectionModify
  - CollectionModify::execute — Ejecuta la operación de modificación
  - CollectionModify::limit — Limita el número de documentos modificados
  - CollectionModify::patch — Corrige un documento
  - CollectionModify::replace — Reemplaza un campo de documento
  - CollectionModify::set — Define un atributo de documento
  - CollectionModify::skip — Ignorar los elementos
  - CollectionModify::sort — Define los criterios de ordenación
  - CollectionModify::unset — Elimina el valor de los campos del documento
- mysql_xdevapi\CollectionRemove — Clase CollectionRemove
  - CollectionRemove::bind — Liga un valor a un argumento
  - CollectionRemove::__construct — Constructor de CollectionRemove
  - CollectionRemove::execute — Ejecuta la operación de eliminación
  - CollectionRemove::limit — Limita el número de documentos a eliminar
  - CollectionRemove::sort — Define el criterio de ordenación
- mysql_xdevapi\ColumnResult — Clase ColumnResult
  - ColumnResult::__construct — Constructor de ColumnResult
  - ColumnResult::getCharacterSetName — Devuelve el conjunto de caracteres
  - ColumnResult::getCollationName — Devuelve el nombre de la intercalación
  - ColumnResult::getColumnLabel — Devuelve la etiqueta de columna
  - ColumnResult::getColumnName — Devuelve el nombre de la columna
  - ColumnResult::getFractionalDigits — Devuelve la longitud de los dígitos fraccionarios
  - ColumnResult::getLength — Devuelve la longitud del campo
  - ColumnResult::getSchemaName — Devuelve el nombre del esquema
  - ColumnResult::getTableLabel — Devuelve la etiqueta de la tabla
  - ColumnResult::getTableName — Devuelve el nombre de la tabla
  - ColumnResult::getType — Devuelve el tipo de columna
  - ColumnResult::isNumberSigned — Indica si el tipo es signado
  - ColumnResult::isPadded — Verifica si el campo tiene un relleno
- mysql_xdevapi\CrudOperationBindable — Interfaz CrudOperationBindable
  - CrudOperationBindable::bind — Liga un valor a un espacio reservado
- mysql_xdevapi\CrudOperationLimitable — Interfaz CrudOperationLimitable
  - CrudOperationLimitable::limit — Define el límite de resultados
- mysql_xdevapi\CrudOperationSkippable — Interfaz CrudOperationSkippable
  - CrudOperationSkippable::skip — El número de operaciones a ignorar
- mysql_xdevapi\CrudOperationSortable — Interfaz CrudOperationSortable
  - CrudOperationSortable::sort — Ordena los resultados
- mysql_xdevapi\DatabaseObject — Interfaz DatabaseObject
  - DatabaseObject::existsInDatabase — Verifica si el objeto existe en la base de datos
  - DatabaseObject::getName — Devuelve el nombre del objeto
  - DatabaseObject::getSession — Devuelve el nombre de la sesión
- mysql_xdevapi\DocResult — Clase DocResult
  - DocResult::__construct — Constructor de DocResult
  - DocResult::fetchAll — Devuelve todas las filas
  - DocResult::fetchOne — Devuelve una fila
  - DocResult::getWarnings — Devuelve los avisos de la última operación
  - DocResult::getWarningsCount — Devuelve el número de advertencias de la última operación
- mysql_xdevapi\Exception — Clase Exception
- mysql_xdevapi\Executable — Interfaz Executable
  - Executable::execute — Ejecuta una declaración
- mysql_xdevapi\ExecutionStatus — Clase ExecutionStatus
  - ExecutionStatus::__construct — Constructor de ExecutionStatus
- mysql_xdevapi\Expression — Clase Expression
  - Expression::__construct — Constructor de Expression
- mysql_xdevapi\Result — Clase Result
  - Result::__construct — Constructor de Result
  - Result::getAffectedItemsCount — Devuelve el número de filas afectadas
  - Result::getAutoIncrementValue — Devuelve el valor auto-incrementado
  - Result::getGeneratedIds — Devuelve los ID generados
  - Result::getWarnings — Devuelve las advertencias de la última operación
  - Result::getWarningsCount — Devuelve el número de advertencias de la última operación
- mysql_xdevapi\RowResult — Clase RowResult
  - RowResult::__construct — Constructor de RowResult
  - RowResult::fetchAll — Devuelve todas las filas del resultado
  - RowResult::fetchOne — Devuelve una fila del resultado
  - RowResult::getColumnsCount — Devuelve el número de columnas
  - RowResult::getColumnNames — Devuelve el nombre de todas las columnas
  - RowResult::getColumns — Devuelve los metadatos de las columnas
  - RowResult::getWarnings — Devuelve las advertencias de la última operación
  - RowResult::getWarningsCount — Devuelve el número de advertencias de la última operación
- mysql_xdevapi\Schema — Clase Schema
  - Schema::__construct — Constructor de schema
  - Schema::createCollection — Añade una colección al esquema
  - Schema::dropCollection — Elimina una colección del esquema
  - Schema::existsInDatabase — Verifica si el objeto existe en la base de datos
  - Schema::getCollection — Devuelve una colección del esquema
  - Schema::getCollectionAsTable — Devuelve una colección como objeto Table
  - Schema::getCollections — Devuelve todas las colecciones del esquema
  - Schema::getName — Devuelve el nombre del esquema
  - Schema::getSession — Devuelve la sesión del esquema
  - Schema::getTable — Devuelve la tabla del esquema
  - Schema::getTables — Devuelve las tablas del esquema
- mysql_xdevapi\SchemaObject — Interfaz SchemaObject
  - SchemaObject::getSchema — Devuelve el objeto esquema
- mysql_xdevapi\Session — Clase Session
  - Session::close — Cierra la sesión
  - Session::commit — Valida la transacción
  - Session::__construct — Descripción del constructor
  - Session::createSchema — Crear un nuevo esquema
  - Session::dropSchema — Elimina un esquema
  - Session::generateUUID — Devuelve un nuevo UUID
  - Session::getDefaultSchema — Devuelve el nombre del esquema predeterminado
  - Session::getSchema — Devuelve un nuevo objeto esquema
  - Session::getSchemas — Devuelve los esquemas
  - Session::getServerVersion — Devuelve la versión del servidor
  - Session::listClients — Devuelve la lista de clientes
  - Session::quoteName — Añade comillas
  - Session::releaseSavepoint — Libera el punto de salvaguarda
  - Session::rollback — Revierte la transacción
  - Session::rollbackTo — Anula la transacción hasta el punto de salvaguarda
  - Session::setSavepoint — Crear un punto de salvaguarda
  - Session::sql — Crear una consulta SQL
  - Session::startTransaction — Inicia una transacción
- mysql_xdevapi\SqlStatement — Clase SqlStatement
  - SqlStatement::bind — Liga los argumentos de la instrucción
  - SqlStatement::__construct — Descripción del constructor
  - SqlStatement::execute — Ejecuta la operación
  - SqlStatement::getNextResult — Devuelve el resultado siguiente
  - SqlStatement::getResult — Devuelve el resultado
  - SqlStatement::hasMoreResults — Verifica si hay más resultados
- mysql_xdevapi\SqlStatementResult — Clase SqlStatementResult
  - SqlStatementResult::__construct — Descripción del constructor
  - SqlStatementResult::fetchAll — Devuelve todas las filas del resultado
  - SqlStatementResult::fetchOne — Devuelve una sola línea
  - SqlStatementResult::getAffectedItemsCount — Devuelve el número de filas afectadas
  - SqlStatementResult::getColumnsCount — Devuelve el número de columnas
  - SqlStatementResult::getColumnNames — Devuelve el nombre de las columnas
  - SqlStatementResult::getColumns — Devuelve las columnas
  - SqlStatementResult::getGeneratedIds — Devuelve los identificadores generados
  - SqlStatementResult::getLastInsertId — Devuelve el ID de la última inserción
  - SqlStatementResult::getWarnings — Devuelve las advertencias de la última operación
  - SqlStatementResult::getWarningsCount — Devuelve el número de advertencias de la última operación
  - SqlStatementResult::hasData — Verifica si el resultado contiene datos
  - SqlStatementResult::nextResult — Devuelve el resultado siguiente
- mysql_xdevapi\Statement — Clase Statement
  - Statement::__construct — Descripción del constructor
  - Statement::getNextResult — Devuelve el resultado siguiente
  - Statement::getResult — Devuelve el resultado
  - Statement::hasMoreResults — Verifica si hay más resultados
- mysql_xdevapi\Table — Clase Table
  - Table::__construct — Constructor de Table
  - Table::count — Devuelve el número de filas
  - Table::delete — Elimina filas de la tabla
  - Table::existsInDatabase — Verifica si la tabla existe en la base de datos
  - Table::getName — Devuelve el nombre de la tabla
  - Table::getSchema — Devuelve el esquema de la tabla
  - Table::getSession — Devuelve la sesión de la tabla
  - Table::insert — Inserta filas en una tabla
  - Table::isView — Devuelve si la tabla es una vista
  - Table::select — Selecciona filas en una tabla
  - Table::update — Actualiza las filas de la tabla
- mysql_xdevapi\TableDelete — Clase TableDelete
  - TableDelete::bind — Liga los argumentos de la petición de eliminación
  - TableDelete::__construct — Constructor de TableDelete
  - TableDelete::execute — Ejecuta la consulta de eliminación
  - TableDelete::limit — Limita las filas eliminadas
  - TableDelete::orderby — Define los criterios de ordenación de la eliminación
  - TableDelete::where — Define la condición de búsqueda para la eliminación
- mysql_xdevapi\TableInsert — Clase TableInsert
  - TableInsert::__construct — Constructor de TableInsert
  - TableInsert::execute — Ejecuta una consulta de inserción
  - TableInsert::values — Añade valores de fila
- mysql_xdevapi\TableSelect — Clase TableSelect
  - TableSelect::bind — Liga los argumentos de la petición select
  - TableSelect::__construct — Constructor de TableSelect
  - TableSelect::execute — Ejecuta una declaración select
  - TableSelect::groupBy — Define los criterios de agrupación de la selección
  - TableSelect::having — Define la condición de agrupamiento
  - TableSelect::limit — Limita las filas seleccionadas
  - TableSelect::lockExclusive — Ejecuta EXCLUSIVE LOCK
  - TableSelect::lockShared — Ejecuta SHARED LOCK
  - TableSelect::offset — Define el desplazamiento del límite
  - TableSelect::orderby — Define los criterios de ordenación de la selección
  - TableSelect::where — Define los criterios de búsqueda de la selección
- mysql_xdevapi\TableUpdate — Clase TableUpdate
  - TableUpdate::bind — Liga los argumentos de la solicitud de actualización
  - TableUpdate::__construct — Constructor de TableUpdate
  - TableUpdate::execute — Ejecuta la consulta de actualización
  - TableUpdate::limit — Limita el número de filas actualizadas
  - TableUpdate::orderby — Define los criterios de ordenación
  - TableUpdate::set — Añade un campo a actualizar
  - TableUpdate::where — Define el filtro de búsqueda
- mysql_xdevapi\Warning — Clase Warning
  - Warning::__construct — Constructor de Warning

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open