# Mysql_xdevapi

# Введение

Модуль обеспечивает доступ к хранилищу документов MySQL через X DevAPI. X DevAPI - это общий API, предоставляемый несколькими коннекторами MySQL, обеспечивающий лёгкий доступ к реляционным таблицам, а также к коллекциям документов, которые представлены в JSON, из API с операциями в стиле CRUD.

X DevAPI использует X Protocol, клиент-серверный протокол нового поколения сервера MySQL 8.0.

Для получения общей информации о хранилище документов MySQL, пожалуйста, обратитесь к главе » Хранилище документов MySQL в руководстве MySQL.

- Установка и настройка
  - Требования
  - Установка
  - Настройка во время выполнения
  - Сборка / Компиляция из исходного кода
- Предопределённые константы
- Список изменений
- Примеры
- Функции Mysql_xdevapi
  - expression — Связывает подготовленные переменные утверждения в качестве параметров
  - getSession — Подключается к серверу MySQL
- mysql_xdevapi\BaseResult — Интерфейс BaseResult
  - BaseResult::getWarnings — Получает предупреждения последней операции
  - BaseResult::getWarningsCount — Получает количество предупреждений последней операции
- mysql_xdevapi\Client — Класс Client
  - mysql_xdevapi\Client::close — Закрытие клиента
  - Client::__construct — Конструктор класса Client
  - Client::getClient — Получает сеанс клиента
- mysql_xdevapi\Collection — Класс Collection
  - Collection::add — Добавляет документ в коллекцию
  - Collection::addOrReplaceOne — Добавляет или заменяет документ коллекции
  - Collection::__construct — Конструктор класса Collection
  - Collection::count — Получает количество документов
  - Collection::createIndex — Создаёт индекс для коллекции
  - Collection::dropIndex — Удаляет индекс коллекции
  - Collection::existsInDatabase — Проверяет, существует ли коллекция в базе данных
  - Collection::find — Ищет документ
  - Collection::getName — Получает название коллекции
  - Collection::getOne — Получает один документ
  - Collection::getSchema — Возвращает объект Schema
  - Collection::getSession — Возвращает объект Session
  - Collection::modify — Изменяет документы коллекции
  - Collection::remove — Удаляет документы коллекции
  - Collection::removeOne — Удаляет один документ из коллекции
  - Collection::replaceOne — Заменяет один документ коллекции
- mysql_xdevapi\CollectionAdd — Класс CollectionAdd
  - CollectionAdd::__construct — Конструктор класса CollectionAdd
  - CollectionAdd::execute — Выполняет утверждение
- mysql_xdevapi\CollectionFind — Класс CollectionFind
  - CollectionFind::bind — Привязывает значение к заполнителю запроса
  - CollectionFind::__construct — Конструктор класса CollectionFind
  - CollectionFind::execute — Выполняет утверждение
  - CollectionFind::fields — Устанавливает фильтр поля документа
  - CollectionFind::groupBy — Устанавливает критерии группировки
  - CollectionFind::having — Устанавливает условие для агрегатных функций
  - CollectionFind::limit — Ограничивает количество возвращаемых документов
  - CollectionFind::lockExclusive — Выполняет операцию с EXCLUSIVE LOCK
  - CollectionFind::lockShared — Выполняет операцию с SHARED LOCK
  - CollectionFind::offset — Пропускает указанное количество возвращаемых элементов
  - CollectionFind::sort — Устанавливает критерии сортировки
- mysql_xdevapi\CollectionModify — Класс CollectionModify
  - CollectionModify::arrayAppend — Добавляет элемент в поле массива
  - CollectionModify::arrayInsert — Добавляет элемент в поле массива
  - CollectionModify::bind — Привязывает значение к заполнителю запроса
  - CollectionModify::__construct — Конструктор класса CollectionModify
  - CollectionModify::execute — Выполняет операцию изменения
  - CollectionModify::limit — Ограничивает количество изменяемых документов
  - CollectionModify::patch — Исправляет документ
  - CollectionModify::replace — Заменяет поле документа
  - CollectionModify::set — Устанавливает атрибут документа
  - CollectionModify::skip — Пропускает элементы
  - CollectionModify::sort — Устанавливает критерии сортировки
  - CollectionModify::unset — Сбрасывает значение полей документа
- mysql_xdevapi\CollectionRemove — Класс CollectionRemove
  - CollectionRemove::bind — Привязывает значение к заполнителю
  - CollectionRemove::__construct — Конструктор класса CollectionRemove
  - CollectionRemove::execute — Выполняет операцию удаления
  - CollectionRemove::limit — Ограничивает количество документов для удаления
  - CollectionRemove::sort — Устанавливает критерии сортировки
- mysql_xdevapi\ColumnResult — Класс ColumnResult
  - ColumnResult::__construct — Конструктор класса ColumnResult
  - ColumnResult::getCharacterSetName — Получает набор символов
  - ColumnResult::getCollationName — Получает имя сопоставления
  - ColumnResult::getColumnLabel — Получает метку столбца
  - ColumnResult::getColumnName — Получает название столбца
  - ColumnResult::getFractionalDigits — Получает дробную длину цифры
  - ColumnResult::getLength — Получает длину поля столбца
  - ColumnResult::getSchemaName — Получает название схемы
  - ColumnResult::getTableLabel — Получает метку таблицы
  - ColumnResult::getTableName — Получает название таблицы
  - ColumnResult::getType — Получает тип столбца
  - ColumnResult::isNumberSigned — Проверяет, задан ли числу знак
  - ColumnResult::isPadded — Проверяет, дополняется ли
- mysql_xdevapi\CrudOperationBindable — Интерфейс CrudOperationBindable
  - CrudOperationBindable::bind — Привязывает значение к заполнителю
- mysql_xdevapi\CrudOperationLimitable — Интерфейс CrudOperationLimitable
  - CrudOperationLimitable::limit — Устанавливает лимит результата
- mysql_xdevapi\CrudOperationSkippable — Интерфейс CrudOperationSkippable
  - CrudOperationSkippable::skip — Количество операций для пропуска
- mysql_xdevapi\CrudOperationSortable — Интерфейс CrudOperationSortable
  - CrudOperationSortable::sort — Сортирует результаты
- mysql_xdevapi\DatabaseObject — Интерфейс DatabaseObject
  - DatabaseObject::existsInDatabase — Проверяет, существует ли объект в базе данных
  - DatabaseObject::getName — Получает имя объекта
  - DatabaseObject::getSession — Получает имя сессии
- mysql_xdevapi\DocResult — Класс DocResult
  - DocResult::__construct — Конструктор DocResult
  - DocResult::fetchAll — Получить все строки
  - DocResult::fetchOne — Получить одну строку
  - DocResult::getWarnings — Получить предупреждения с последней операции
  - DocResult::getWarningsCount — Получить количество предупреждений с последней операции
- mysql_xdevapi\Exception — Класс Exception
- mysql_xdevapi\Executable — Интерфейс Executable
  - Executable::execute — Выполняет утверждение
- mysql_xdevapi\ExecutionStatus — Класс ExecutionStatus
  - ExecutionStatus::__construct — Конструктор класса ExecutionStatus
- mysql_xdevapi\Expression — Класс Expression
  - Expression::__construct — Конструктор класса Expression
- mysql_xdevapi\Result — Класс Result
  - Result::__construct — Конструктор класса Result
  - Result::getAffectedItemsCount — Получает количество затронутых строк
  - Result::getAutoIncrementValue — Получает значение автоинкремента
  - Result::getGeneratedIds — Получает сгенерированные идентификаторы
  - Result::getWarnings — Получает предупреждения последней операции
  - Result::getWarningsCount — Получает количество предупреждений последней операции
- mysql_xdevapi\RowResult — Класс RowResult
  - RowResult::__construct — Конструктор класса RowResult
  - RowResult::fetchAll — Получает все строки из результата
  - RowResult::fetchOne — Получает строку из результата
  - RowResult::getColumnsCount — Получает количество столбцов
  - RowResult::getColumnNames — Получает все имена столбцов
  - RowResult::getColumns — Получает метаданные столбца
  - RowResult::getWarnings — Получает предупреждения последней операции
  - RowResult::getWarningsCount — Получает количество предупреждений последней операции
- mysql_xdevapi\Schema — Класс Schema
  - Schema::__construct — Конструктор класса Schema
  - Schema::createCollection — Добавляет коллекцию в схему
  - Schema::dropCollection — Удаляет коллекции из схемы
  - Schema::existsInDatabase — Проверяет, существует ли в базе данных
  - Schema::getCollection — Получает коллекцию из схемы
  - Schema::getCollectionAsTable — Получает коллекцию как объект класса Table
  - Schema::getCollections — Получает все коллекции схемы
  - Schema::getName — Получает имя схемы
  - Schema::getSession — Получает сессию схемы
  - Schema::getTable — Получает таблицу схемы
  - Schema::getTables — Получает таблицы схемы
- mysql_xdevapi\SchemaObject — Интерфейс SchemaObject
  - SchemaObject::getSchema — Получает объект схемы
- mysql_xdevapi\Session — Класс Session
  - Session::close — Закрывает сессию
  - Session::commit — Фиксирует транзакцию
  - Session::__construct — Описание конструктора
  - Session::createSchema — Создаёт новую схему
  - Session::dropSchema — Удаляет схему
  - Session::generateUUID — Получает новый UUID
  - Session::getDefaultSchema — Получает имя схемы по умолчанию
  - Session::getSchema — Получает новый объект схемы
  - Session::getSchemas — Получает схемы
  - Session::getServerVersion — Получает версию сервера
  - Session::listClients — Получает список клиентов
  - Session::quoteName — Добавляет кавычки
  - Session::releaseSavepoint — Отменяет установленную точку сохранения
  - Session::rollback — Откатывает транзакцию
  - Session::rollbackTo — Откатывает транзакцию до точки сохранения
  - Session::setSavepoint — Создаёт точку сохранения
  - Session::sql — Создаёт SQL-запрос
  - Session::startTransaction — Начинает транзакцию
- mysql_xdevapi\SqlStatement — Класс SqlStatement
  - SqlStatement::bind — Связывает параметры утверждения
  - SqlStatement::__construct — Описание конструктора
  - SqlStatement::execute — Выполняет операцию
  - SqlStatement::getNextResult — Получает следующий результат
  - SqlStatement::getResult — Получает результат
  - SqlStatement::hasMoreResults — Проверяет, есть ли ещё результаты
- mysql_xdevapi\SqlStatementResult — Класс SqlStatementResult
  - SqlStatementResult::__construct — Описание конструктора
  - SqlStatementResult::fetchAll — Получает все строки из результата
  - SqlStatementResult::fetchOne — Получает одну строку
  - SqlStatementResult::getAffectedItemsCount — Получает затронутое количество строк
  - SqlStatementResult::getColumnsCount — Получает количество столбцов
  - SqlStatementResult::getColumnNames — Получает имена столбцов
  - SqlStatementResult::getColumns — Получает столбцы
  - SqlStatementResult::getGeneratedIds — Получает сгенерированные идентификаторы
  - SqlStatementResult::getLastInsertId — Получает последний идентификатор вставки
  - SqlStatementResult::getWarnings — Получает предупреждения от последней операции
  - SqlStatementResult::getWarningsCount — Получает количество предупреждений от последней операции
  - SqlStatementResult::hasData — Проверяет, есть ли у результата данные
  - SqlStatementResult::nextResult — Получает следующий результат
- mysql_xdevapi\Statement — Класс Statement
  - Statement::__construct — Описание конструктора
  - Statement::getNextResult — Получает следующий результат
  - Statement::getResult — Получает результат
  - Statement::hasMoreResults — Проверяет, есть ли ещё результаты
- mysql_xdevapi\Table — Класс Table
  - Table::__construct — Конструктор Table
  - Table::count — Получить количество строк
  - Table::delete — Удалить строки из таблицы
  - Table::existsInDatabase — Проверить, существует ли таблица в базе данных
  - Table::getName — Получить имя таблицы
  - Table::getSchema — Получить схему таблицы
  - Table::getSession — Получить таблицу сессий
  - Table::insert — Вставить строки таблицы
  - Table::isView — Проверить, является ли таблица представлением
  - Table::select — Выбрать строки из таблицы
  - Table::update — Обновить строки в таблице
- mysql_xdevapi\TableDelete — Класс TableDelete
  - TableDelete::bind — Связывает параметры запроса удаления
  - TableDelete::__construct — Конструктор класса TableDelete
  - TableDelete::execute — Выполняет запрос на удаление
  - TableDelete::limit — Ограничивает строки для удаления
  - TableDelete::orderby — Устанавливает критерии сортировки удаления
  - TableDelete::where — Устанавливает условие поиска для удаления
- mysql_xdevapi\TableInsert — Класс TableInsert
  - TableInsert::__construct — Конструктор класса TableInsert
  - TableInsert::execute — Выполняет запрос вставки
  - TableInsert::values — Добавляет значения вставки строки
- mysql_xdevapi\TableSelect — Класс TableSelect
  - TableSelect::bind — Привязывает параметры запроса выборки
  - TableSelect::__construct — Конструктор класса TableSelect
  - TableSelect::execute — Выполняет оператор выборки
  - TableSelect::groupBy — Устанавливает критерии группировки выборки
  - TableSelect::having — Устанавливает выбор с условием
  - TableSelect::limit — Ограничивает выбранные строки
  - TableSelect::lockExclusive — Выполняет EXCLUSIVE LOCK
  - TableSelect::lockShared — Выполняет SHARED LOCK
  - TableSelect::offset — Устанавливает предел смещения
  - TableSelect::orderby — Устанавливает критерии сортировки выборки
  - TableSelect::where — Устанавливает условие поиска выборки
- mysql_xdevapi\TableUpdate — Класс TableUpdate
  - TableUpdate::bind — Привязывает параметры запроса на обновление
  - TableUpdate::__construct — Конструктор класса TableUpdate
  - TableUpdate::execute — Выполняет запрос на обновление
  - TableUpdate::limit — Ограничивает количество строк для обновления
  - TableUpdate::orderby — Устанавливает критерии сортировки
  - TableUpdate::set — Добавляет поле для обновления
  - TableUpdate::where — Устанавливает фильтр поиска
- mysql_xdevapi\Warning — Класс Warning
  - Warning::__construct — Конструктор класса Warning

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