AdapterInterface.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\DB\Adapter;

use Magento\Framework\DB\Ddl\Table;

interface AdapterInterface
{
    const INDEX_TYPE_PRIMARY = 'primary';

    const INDEX_TYPE_UNIQUE = 'unique';

    const INDEX_TYPE_INDEX = 'index';

    const INDEX_TYPE_FULLTEXT = 'fulltext';

    const FK_ACTION_CASCADE = 'CASCADE';

    const FK_ACTION_SET_NULL = 'SET NULL';

    const FK_ACTION_NO_ACTION = 'NO ACTION';

    const FK_ACTION_RESTRICT = 'RESTRICT';

    const FK_ACTION_SET_DEFAULT = 'SET DEFAULT';

    const INSERT_ON_DUPLICATE = 1;

    const INSERT_IGNORE = 2;
    
    const REPLACE = 4;

    const ISO_DATE_FORMAT = 'yyyy-MM-dd';

    const ISO_DATETIME_FORMAT = 'yyyy-MM-dd HH-mm-ss';

    const INTERVAL_SECOND = 'SECOND';

    const INTERVAL_MINUTE = 'MINUTES';

    const INTERVAL_HOUR = 'HOURS';

    const INTERVAL_DAY = 'DAYS';

    const INTERVAL_MONTH = 'MONTHS';

    const INTERVAL_YEAR = 'YEARS';

    const ERROR_DDL_MESSAGE = 'DDL statements are not allowed in transactions';

    const ERROR_ROLLBACK_INCOMPLETE_MESSAGE = 'Rolled back transaction has not been completed correctly.';

    const ERROR_ASYMMETRIC_ROLLBACK_MESSAGE = 'Asymmetric transaction rollback.';

    const ERROR_ASYMMETRIC_COMMIT_MESSAGE = 'Asymmetric transaction commit.';

    public function beginTransaction();

    public function commit();

    public function rollBack();

    public function newTable($tableName = null, $schemaName = null);

    public function createTable(Table $table);

    public function dropTable($tableName, $schemaName = null);

    public function createTemporaryTable(Table $table);

    public function createTemporaryTableLike($temporaryTableName, $originTableName, $ifNotExists = false);

    public function dropTemporaryTable($tableName, $schemaName = null);

    public function renameTablesBatch(array $tablePairs);

    public function truncateTable($tableName, $schemaName = null);

    public function isTableExists($tableName, $schemaName = null);

    public function showTableStatus($tableName, $schemaName = null);

    public function describeTable($tableName, $schemaName = null);

    public function createTableByDdl($tableName, $newTableName);

    public function modifyColumnByDdl($tableName, $columnName, $definition, $flushData = false, $schemaName = null);

    public function renameTable($oldTableName, $newTableName, $schemaName = null);

    public function addColumn($tableName, $columnName, $definition, $schemaName = null);

    public function changeColumn(
        $tableName,
        $oldColumnName,
        $newColumnName,
        $definition,
        $flushData = false,
        $schemaName = null
    );

    public function modifyColumn($tableName, $columnName, $definition, $flushData = false, $schemaName = null);

    public function dropColumn($tableName, $columnName, $schemaName = null);

    public function tableColumnExists($tableName, $columnName, $schemaName = null);

    public function addIndex($tableName, $indexName, $fields, $indexType = self::INDEX_TYPE_INDEX, $schemaName = null);

    public function dropIndex($tableName, $keyName, $schemaName = null);

    public function getIndexList($tableName, $schemaName = null);

    public function addForeignKey(
        $fkName,
        $tableName,
        $columnName,
        $refTableName,
        $refColumnName,
        $onDelete = self::FK_ACTION_CASCADE,
        $purge = false,
        $schemaName = null,
        $refSchemaName = null
    );

    public function dropForeignKey($tableName, $fkName, $schemaName = null);

    public function getForeignKeys($tableName, $schemaName = null);

    public function select();

    public function insertOnDuplicate($table, array $data, array $fields = []);

    public function insertMultiple($table, array $data);

    public function insertArray($table, array $columns, array $data);

    public function insert($table, array $bind);

    public function insertForce($table, array $bind);

    public function update($table, array $bind, $where = '');

    public function delete($table, $where = '');

    public function query($sql, $bind = []);

    public function fetchAll($sql, $bind = [], $fetchMode = null);

    public function fetchRow($sql, $bind = [], $fetchMode = null);

    public function fetchAssoc($sql, $bind = []);

    public function fetchCol($sql, $bind = []);

    public function fetchPairs($sql, $bind = []);

    public function fetchOne($sql, $bind = []);

    public function quote($value, $type = null);

    public function quoteInto($text, $value, $type = null, $count = null);

    public function quoteIdentifier($ident, $auto = false);

    public function quoteColumnAs($ident, $alias, $auto = false);

    public function quoteTableAs($ident, $alias = null, $auto = false);

    public function formatDate($date, $includeTime = true);

    public function startSetup();

    public function endSetup();

    public function setCacheAdapter(\Magento\Framework\Cache\FrontendInterface $cacheAdapter);

    public function allowDdlCache();

    public function disallowDdlCache();

    public function resetDdlCache($tableName = null, $schemaName = null);

    public function saveDdlCache($tableCacheKey, $ddlType, $data);

    public function loadDdlCache($tableCacheKey, $ddlType);

    public function prepareSqlCondition($fieldName, $condition);

    public function prepareColumnValue(array $column, $value);

    public function getCheckSql($condition, $true, $false);

    public function getIfNullSql($expression, $value = 0);

    public function getConcatSql(array $data, $separator = null);

    public function getLengthSql($string);

    public function getLeastSql(array $data);

    public function getGreatestSql(array $data);

    public function getDateAddSql($date, $interval, $unit);

    public function getDateSubSql($date, $interval, $unit);

    public function getDateFormatSql($date, $format);

    public function getDatePartSql($date);

    public function getSubstringSql($stringExpression, $pos, $len = null);

    public function getStandardDeviationSql($expressionField);

    public function getDateExtractSql($date, $unit);

    public function getTableName($tableName);

    public function getTriggerName($tableName, $time, $event);

    public function getIndexName($tableName, $fields, $indexType = '');

    public function getForeignKeyName($priTableName, $priColumnName, $refTableName, $refColumnName);

    public function disableTableKeys($tableName, $schemaName = null);

    public function enableTableKeys($tableName, $schemaName = null);

    public function insertFromSelect(\Magento\Framework\DB\Select $select, $table, array $fields = [], $mode = false);

    public function selectsByRange($rangeField, \Magento\Framework\DB\Select $select, $stepCount = 100);

    public function updateFromSelect(\Magento\Framework\DB\Select $select, $table);

    public function deleteFromSelect(\Magento\Framework\DB\Select $select, $table);

    public function getTablesChecksum($tableNames, $schemaName = null);

    public function supportStraightJoin();

    public function orderRand(\Magento\Framework\DB\Select $select, $field = null);

    public function forUpdate($sql);

    public function getPrimaryKeyName($tableName, $schemaName = null);

    public function decodeVarbinary($value);

    public function getTransactionLevel();

    public function createTrigger(\Magento\Framework\DB\Ddl\Trigger $trigger);

    public function dropTrigger($triggerName, $schemaName = null);

    public function getTables($likeCondition = null);

    public function getCaseSql($valueName, $casesResults, $defaultValue = null);

    public function getAutoIncrementField($tableName, $schemaName = null);
}