# Mysql_xdevapi

# Introduction

Cette extension fournit un accès au Document Store de MySQL à travers la DevAPI X. La DevAPI X est une API commune fournie par plusieurs connecteurs MySQL fournissant un accès facile aux tables relationnelles aussi bien qu'aux collections de documents, qui sont représentés en JSON, depuis une API avec des opérations de style CRUD.

La DevAPI de X utilise le protocole X, le protocole nouvelle génération client-serveur du serveur MySQL 8.0.

Pour des informations générales sur MySQL Document Store, se référer au chapitre » MySQL Document Store du manuel MySQL.

- Installation/Configuration
  - Pré-requis
  - Installation
  - Configuration à l'exécution
  - Compiler à partir des sources
- Constantes pré-définies
- Historique des modifications
- Exemples
- Fonctions Mysql_xdevapi
  - expression — Lie une expression à une variable de requête préparée
  - getSession — Connecte à un serveur MySQL
- mysql_xdevapi\BaseResult — Interface BaseResult
  - BaseResult::getWarnings — Récupère les avertissements de la dernière opération
  - BaseResult::getWarningsCount — Récupère le nombre d'avertissements de la dernière opération
- mysql_xdevapi\Client — La classe Client
  - mysql_xdevapi\Client::close — Ferme le client
  - Client::__construct — Constructeur du client
  - Client::getClient — Renvoie la session client
- mysql_xdevapi\Collection — Classe Collection
  - Collection::add — Ajoute un document à la collection
  - Collection::addOrReplaceOne — Ajoute ou remplace un document de la collection
  - Collection::__construct — Constructeur de Collection
  - Collection::count — Renvoie le nombre de documents
  - Collection::createIndex — Créer un index de collection
  - Collection::dropIndex — Supprime un index de collection
  - Collection::existsInDatabase — Vérifie si la collection existe dans la base de données
  - Collection::find — Recherche de document
  - Collection::getName — Renvoie le nom de la collection
  - Collection::getOne — Renvoie un document
  - Collection::getSchema — Renvoie l'objet schéma
  - Collection::getSession — Renvoie l'objet session
  - Collection::modify — Modifie les documents de la collection
  - Collection::remove — Enlève des documents de la collection
  - Collection::removeOne — Enlève un document de la collection
  - Collection::replaceOne — Remplace un document de la collection
- mysql_xdevapi\CollectionAdd — Classe CollectionAdd
  - CollectionAdd::__construct — Constructeur de CollectionAdd
  - CollectionAdd::execute — Exécute la déclaration
- mysql_xdevapi\CollectionFind — Classe CollectionFind
  - CollectionFind::bind — Lie une valeur à un paramètre de requête
  - CollectionFind::__construct — Constructeur de CollectionFind
  - CollectionFind::execute — Exécute la déclaration
  - CollectionFind::fields — Définit le filtre de champ de document
  - CollectionFind::groupBy — Définit les critères de regroupement
  - CollectionFind::having — Définit la condition pour les fonctions d'agrégation
  - CollectionFind::limit — Limite le nombre de documents retournés
  - CollectionFind::lockExclusive — Exécute l'opération avec un VERROU EXCLUSIF
  - CollectionFind::lockShared — Exécute l'opération avec un VERROU PARTAGE
  - CollectionFind::offset — Ignore un nombre donné d'éléments à retourner
  - CollectionFind::sort — Définit les critères de tri
- mysql_xdevapi\CollectionModify — Classe CollectionModify
  - CollectionModify::arrayAppend — Ajoute un élément à un champ de tableau
  - CollectionModify::arrayInsert — Insère un élément dans un champ de tableau
  - CollectionModify::bind — Lie une valeur à un paramètre de requête
  - CollectionModify::__construct — Constructeur de CollectionModify
  - CollectionModify::execute — Exécute l'opération de modification
  - CollectionModify::limit — Limite le nombre de documents modifiés
  - CollectionModify::patch — Corrige un document
  - CollectionModify::replace — Remplace un champ de document
  - CollectionModify::set — Définit un attribut de document
  - CollectionModify::skip — Ignore les éléments
  - CollectionModify::sort — Définit les critères de tri
  - CollectionModify::unset — Supprime la valeur des champs de document
- mysql_xdevapi\CollectionRemove — Classe CollectionRemove
  - CollectionRemove::bind — Lie une valeur à un paramètre
  - CollectionRemove::__construct — Constructeur de CollectionRemove
  - CollectionRemove::execute — Exécute l'opération de suppression
  - CollectionRemove::limit — Limite le nombre de documents à supprimer
  - CollectionRemove::sort — Définit le critère de tri
- mysql_xdevapi\ColumnResult — Classe ColumnResult
  - ColumnResult::__construct — Constructeur de ColumnResult
  - ColumnResult::getCharacterSetName — Renvoie le jeu de caractères
  - ColumnResult::getCollationName — Renvoie le nom de la collation
  - ColumnResult::getColumnLabel — Renvoie l'étiquette de colonne
  - ColumnResult::getColumnName — Renvoie le nom de la colonne
  - ColumnResult::getFractionalDigits — Renvoie la longueur des chiffres fractionnels
  - ColumnResult::getLength — Renvoie la longueur du champ
  - ColumnResult::getSchemaName — Renvoie le nom du schéma
  - ColumnResult::getTableLabel — Renvoie l'étiquette de table
  - ColumnResult::getTableName — Renvoie le nom de la table
  - ColumnResult::getType — Renvoie le type de colonne
  - ColumnResult::isNumberSigned — Renvoie si le type est signé
  - ColumnResult::isPadded — Vérifie si le champ a un remplissage
- mysql_xdevapi\CrudOperationBindable — Interface CrudOperationBindable
  - CrudOperationBindable::bind — Lie une valeur à un espace réservé
- mysql_xdevapi\CrudOperationLimitable — Interface CrudOperationLimitable
  - CrudOperationLimitable::limit — Définit la limite de résultats
- mysql_xdevapi\CrudOperationSkippable — Interface CrudOperationSkippable
  - CrudOperationSkippable::skip — Le nombre d'opérations à ignorer
- mysql_xdevapi\CrudOperationSortable — Interface CrudOperationSortable
  - CrudOperationSortable::sort — Trie les résultats
- mysql_xdevapi\DatabaseObject — Interface DatabaseObject
  - DatabaseObject::existsInDatabase — Vérifie si l'objet existe dans la base de données
  - DatabaseObject::getName — Renvoie le nom de l'objet
  - DatabaseObject::getSession — Renvoie le nom de la session
- mysql_xdevapi\DocResult — Classe DocResult
  - DocResult::__construct — Constructeur de DocResult
  - DocResult::fetchAll — Renvoie toutes les lignes
  - DocResult::fetchOne — Renvoie une ligne
  - DocResult::getWarnings — Renvoie les avertissements de la dernière opération
  - DocResult::getWarningsCount — Renvoie le nombre d'avertissements de la dernière opération
- mysql_xdevapi\Exception — Classe Exception
- mysql_xdevapi\Executable — Interface Executable
  - Executable::execute — Exécute une déclaration
- mysql_xdevapi\ExecutionStatus — Classe ExecutionStatus
  - ExecutionStatus::__construct — Constructeur d'ExecutionStatus
- mysql_xdevapi\Expression — Classe Expression
  - Expression::__construct — Constructeur d'Expression
- mysql_xdevapi\Result — Classe Result
  - Result::__construct — Constructeur de Result
  - Result::getAffectedItemsCount — Renvoie le nombre de lignes affectées
  - Result::getAutoIncrementValue — Renvoie la valeur auto-incrémentée
  - Result::getGeneratedIds — Renvoie les ID générés
  - Result::getWarnings — Renvoie les avertissements de la dernière opération
  - Result::getWarningsCount — Renvoie le nombre d'avertissements de la dernière opération
- mysql_xdevapi\RowResult — Classe RowResult
  - RowResult::__construct — Constructeur de RowResult
  - RowResult::fetchAll — Renvoie toutes les lignes du résultat
  - RowResult::fetchOne — Renvoie une ligne du résultat
  - RowResult::getColumnsCount — Renvoie le nombre de colonnes
  - RowResult::getColumnNames — Renvoie le nom de toutes les colonnes
  - RowResult::getColumns — Renvoie les métadonnées des colonnes
  - RowResult::getWarnings — Renvoie les avertissements de la dernière opération
  - RowResult::getWarningsCount — Renvoie le nombre d'avertissements de la dernière opération
- mysql_xdevapi\Schema — Classe Schema
  - Schema::__construct — Constructeur de schema
  - Schema::createCollection — Ajoute une collection au schéma
  - Schema::dropCollection — Supprime une collection du schéma
  - Schema::existsInDatabase — Vérifie si l'objet existe dans la base de données
  - Schema::getCollection — Renvoie une collection du schéma
  - Schema::getCollectionAsTable — Renvoie une collection en tant qu'objet Table
  - Schema::getCollections — Renvoie toutes les collections du schéma
  - Schema::getName — Renvoie le nom du schéma
  - Schema::getSession — Renvoie la session du schéma
  - Schema::getTable — Renvoie la table du schéma
  - Schema::getTables — Renvoie les tables du schéma
- mysql_xdevapi\SchemaObject — Interface SchemaObject
  - SchemaObject::getSchema — Renvoie l'objet schéma
- mysql_xdevapi\Session — Classe Session
  - Session::close — Ferme la session
  - Session::commit — Valide la transaction
  - Session::__construct — Description du constructeur
  - Session::createSchema — Créer un nouveau schéma
  - Session::dropSchema — Supprime un schéma
  - Session::generateUUID — Renvoie un nouvel UUID
  - Session::getDefaultSchema — Renvoie le nom du schéma par défaut
  - Session::getSchema — Renvoie un nouvel objet schéma
  - Session::getSchemas — Renvoie les schémas
  - Session::getServerVersion — Renvoie la version du serveur
  - Session::listClients — Renvoie la liste des clients
  - Session::quoteName — Ajoute des guillemets
  - Session::releaseSavepoint — Libère le point de sauvegarde
  - Session::rollback — Annule la transaction
  - Session::rollbackTo — Annule la transaction jusqu'au point de sauvegarde
  - Session::setSavepoint — Créer un point de sauvegarde
  - Session::sql — Créer une requête SQL
  - Session::startTransaction — Démarre une transaction
- mysql_xdevapi\SqlStatement — Classe SqlStatement
  - SqlStatement::bind — Lie les paramètres de l'instruction
  - SqlStatement::__construct — Description de constructeur
  - SqlStatement::execute — Exécute l'opération
  - SqlStatement::getNextResult — Renvoie le résultat suivant
  - SqlStatement::getResult — Renvoie le résultat
  - SqlStatement::hasMoreResults — Vérifie s'il y a plus de résultats
- mysql_xdevapi\SqlStatementResult — Classe SqlStatementResult
  - SqlStatementResult::__construct — Description de constructeur
  - SqlStatementResult::fetchAll — Renvoie toutes les lignes du résultat
  - SqlStatementResult::fetchOne — Renvoie une seule ligne
  - SqlStatementResult::getAffectedItemsCount — Renvoie le nombre de lignes affectées
  - SqlStatementResult::getColumnsCount — Renvoie le nombre de colonnes
  - SqlStatementResult::getColumnNames — Renvoie le nom des colonnes
  - SqlStatementResult::getColumns — Renvoie les colonnes
  - SqlStatementResult::getGeneratedIds — Renvoie les identifiants générés
  - SqlStatementResult::getLastInsertId — Renvoie l'ID de la dernière insertion
  - SqlStatementResult::getWarnings — Renvoie les avertissements de la dernière opération
  - SqlStatementResult::getWarningsCount — Renvoie le nombre d'avertissements de la dernière opération
  - SqlStatementResult::hasData — Vérifie si le résultat contient des données
  - SqlStatementResult::nextResult — Renvoie le résultat suivant
- mysql_xdevapi\Statement — Classe Statement
  - Statement::__construct — Description de constructeur
  - Statement::getNextResult — Renvoie le résultat suivant
  - Statement::getResult — Renvoie le résultat
  - Statement::hasMoreResults — Vérifie s'il y a d'autres résultats
- mysql_xdevapi\Table — Classe Table
  - Table::__construct — Constructeur de Table
  - Table::count — Renvoie le nombre de lignes
  - Table::delete — Supprime des lignes de la table
  - Table::existsInDatabase — Vérifie si la table existe dans la base de données
  - Table::getName — Renvoie le nom de la table
  - Table::getSchema — Renvoie le schéma de la table
  - Table::getSession — Renvoie la session de la table
  - Table::insert — Insère des lignes dans une table
  - Table::isView — Renvoie si la table est une vue
  - Table::select — Sélectionne des lignes dans une table
  - Table::update — Met à jour les lignes de la table
- mysql_xdevapi\TableDelete — Classe TableDelete
  - TableDelete::bind — Lie les paramètres de la requête de suppression
  - TableDelete::__construct — Constructeur de TableDelete
  - TableDelete::execute — Exécute la requête de suppression
  - TableDelete::limit — Limite les lignes supprimées
  - TableDelete::orderby — Définit les critères de tri de la suppression
  - TableDelete::where — Définit la condition de recherche de suppression
- mysql_xdevapi\TableInsert — Classe TableInsert
  - TableInsert::__construct — Constructeur de TableInsert
  - TableInsert::execute — Exécute une requête d'insertion
  - TableInsert::values — Ajoute des valeurs de ligne
- mysql_xdevapi\TableSelect — Classe TableSelect
  - TableSelect::bind — Lie les paramètres de la requête select
  - TableSelect::__construct — Constructeur de TableSelect
  - TableSelect::execute — Exécute une déclaration select
  - TableSelect::groupBy — Définit les critères de regroupement de la sélection
  - TableSelect::having — Définit la condition de regroupement
  - TableSelect::limit — Limite les lignes sélectionnées
  - TableSelect::lockExclusive — Exécute EXCLUSIVE LOCK
  - TableSelect::lockShared — Exécute SHARED LOCK
  - TableSelect::offset — Définit le décalage de la limite
  - TableSelect::orderby — Définit les critères de tri de la sélection
  - TableSelect::where — Définit les critères de recherche de la sélection
- mysql_xdevapi\TableUpdate — Classe TableUpdate
  - TableUpdate::bind — Lie les paramètres de la requête de mise à jour
  - TableUpdate::__construct — Constructeur de TableUpdate
  - TableUpdate::execute — Exécute la requête de mise à jour
  - TableUpdate::limit — Limite le nombre de lignes mises à jour
  - TableUpdate::orderby — Définit les critères de tri
  - TableUpdate::set — Ajoute un champ à mettre à jour
  - TableUpdate::where — Définit le filtre de recherche
- mysql_xdevapi\Warning — Classe Warning
  - Warning::__construct — Constructeur de Warning

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