\Phinx\Db\AdapterAdapterInterface

getVersions()

getVersions() : array

Get all migrated version numbers.

Returns

getVersionLog()

getVersionLog() : array

Get all migration log entries, indexed by version number.

Returns

setOptions()

setOptions(array  $options) : \Phinx\Db\Adapter\AdapterInterface

Set adapter configuration options.

Parameters

Returns

getOptions()

getOptions() : array

Get all adapter options.

Returns

hasOption()

hasOption(string  $name) : boolean

Check if an option has been set.

Parameters

Returns

getOption()

getOption(string  $name) : mixed

Get a single adapter option, or null if the option does not exist.

Parameters

Returns

setInput()

setInput(\think\console\Input  $input) : \Phinx\Db\Adapter\AdapterInterface

Sets the console input.

Parameters

Returns

getInput()

getInput() : \think\console\Input

Gets the console input.

Returns

setOutput()

setOutput(\think\console\Output  $output) : \Phinx\Db\Adapter\AdapterInterface

Sets the console output.

Parameters

Returns

getOutput()

getOutput() : \think\console\Output

Gets the console output.

Returns

migrated()

migrated(\Phinx\Migration\MigrationInterface  $migration, string  $direction, integer  $startTime, integer  $endTime) : \Phinx\Db\Adapter\AdapterInterface

Records a migration being run.

Parameters

Returns

toggleBreakpoint()

toggleBreakpoint(\Phinx\Migration\MigrationInterface  $migration) : \Phinx\Db\Adapter\AdapterInterface

Toggle a migration breakpoint.

Parameters

Returns

resetAllBreakpoints()

resetAllBreakpoints() : integer

Reset all migration breakpoints.

Returns

The number of breakpoints reset

hasSchemaTable()

hasSchemaTable() : boolean

Does the schema table exist?

Returns

createSchemaTable()

createSchemaTable() : void

Creates the schema table.

getAdapterType()

getAdapterType() : string

Returns the adapter type.

Returns

connect()

connect() : void

Initializes the database connection.

Throws

\RuntimeException

When the requested database driver is not installed.

disconnect()

disconnect() : void

Closes the database connection.

hasTransactions()

hasTransactions() : boolean

Does the adapter support transactions?

Returns

beginTransaction()

beginTransaction() : void

Begin a transaction.

commitTransaction()

commitTransaction() : void

Commit a transaction.

rollbackTransaction()

rollbackTransaction() : void

Rollback a transaction.

execute()

execute(string  $sql) : integer

Executes a SQL statement and returns the number of affected rows.

Parameters

Returns

query()

query(string  $sql) : array

Executes a SQL statement and returns the result as an array.

Parameters

Returns

fetchRow()

fetchRow(string  $sql) : array

Executes a query and returns only one row as an array.

Parameters

Returns

fetchAll()

fetchAll(string  $sql) : array

Executes a query and returns an array of rows.

Parameters

Returns

insert()

insert(\Phinx\Db\Table  $table, array  $row) : void

Inserts data into a table.

Parameters

quoteTableName()

quoteTableName(string  $tableName) : string

Quotes a table name for use in a query.

Parameters

Returns

quoteColumnName()

quoteColumnName(string  $columnName) : string

Quotes a column name for use in a query.

Parameters

Returns

hasTable()

hasTable(string  $tableName) : boolean

Checks to see if a table exists.

Parameters

Returns

createTable()

createTable(\Phinx\Db\Table  $table) : void

Creates the specified database table.

Parameters

renameTable()

renameTable(string  $tableName, string  $newName) : void

Renames the specified database table.

Parameters

dropTable()

dropTable(string  $tableName) : void

Drops the specified database table.

Parameters

getColumns()

getColumns(string  $tableName) : array<mixed,\Phinx\Db\Table\Column>

Returns table columns

Parameters

Returns

hasColumn()

hasColumn(string  $tableName, string  $columnName) : boolean

Checks to see if a column exists.

Parameters

Returns

addColumn()

addColumn(\Phinx\Db\Table  $table, \Phinx\Db\Table\Column  $column) : void

Adds the specified column to a database table.

Parameters

renameColumn()

renameColumn(string  $tableName, string  $columnName, string  $newColumnName) : void

Renames the specified column.

Parameters

changeColumn()

changeColumn(string  $tableName, string  $columnName, \Phinx\Db\Table\Column  $newColumn) : \Phinx\Db\Table

Change a table column type.

Parameters

Returns

dropColumn()

dropColumn(string  $tableName, string  $columnName) : void

Drops the specified column.

Parameters

hasIndex()

hasIndex(string  $tableName, mixed  $columns) : boolean

Checks to see if an index exists.

Parameters

Returns

hasIndexByName()

hasIndexByName(string  $tableName, string  $indexName) : boolean

Checks to see if an index specified by name exists.

Parameters

Returns

addIndex()

addIndex(\Phinx\Db\Table  $table, \Phinx\Db\Table\Index  $index) : void

Adds the specified index to a database table.

Parameters

dropIndex()

dropIndex(string  $tableName, mixed  $columns) : void

Drops the specified index from a database table.

Parameters

dropIndexByName()

dropIndexByName(string  $tableName, string  $indexName) : void

Drops the index specified by name from a database table.

Parameters

hasForeignKey()

hasForeignKey(string  $tableName, array<mixed,string>  $columns, string  $constraint = null) : boolean

Checks to see if a foreign key exists.

Parameters

Returns

addForeignKey()

addForeignKey(\Phinx\Db\Table  $table, \Phinx\Db\Table\ForeignKey  $foreignKey) : void

Adds the specified foreign key to a database table.

Parameters

dropForeignKey()

dropForeignKey(string  $tableName, array<mixed,string>  $columns, string  $constraint = null) : void

Drops the specified foreign key from a database table.

Parameters

getColumnTypes()

getColumnTypes() : array

Returns an array of the supported Phinx column types.

Returns

isValidColumnType()

isValidColumnType(\Phinx\Db\Table\Column  $column) : boolean

Checks that the given column is of a supported type.

Parameters

Returns

getSqlType()

getSqlType(string  $type, integer  $limit = null) : string

Converts the Phinx logical type to the adapter's SQL type.

Parameters

Returns

createDatabase()

createDatabase(string  $name, array  $options = array()) : void

Creates a new database.

Parameters

hasDatabase()

hasDatabase(string  $name) : boolean

Checks to see if a database exists.

Parameters

Returns

dropDatabase()

dropDatabase(string  $name) : void

Drops the specified database.

Parameters