CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.7 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.7
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
      • Dialect
      • Driver
      • Exception
      • Expression
      • Log
      • Retry
      • Schema
      • Statement
      • Type
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Interface DriverInterface

Interface for database driver.

Namespace: Cake\Database

Method Summary

  • beginTransaction() public

    Starts a transaction.

  • commitTransaction() public

    Commits a transaction.

  • compileQuery() public

    Transforms the passed query to this Driver's dialect and returns an instance of the transformed query and the full compiled SQL string.

  • connect() public

    Establishes a connection to the database server.

  • disableAutoQuoting() public @method
  • disableForeignKeySQL() public

    Get the SQL for disabling foreign keys.

  • disconnect() public

    Disconnects from database server.

  • enableAutoQuoting() public

    Sets whether or not this driver should automatically quote identifiers in queries.

  • enableForeignKeySQL() public

    Get the SQL for enabling foreign keys.

  • enabled() public

    Returns whether php is able to use this driver for connecting to database.

  • getConnection() public

    Returns correct connection resource or object that is internally used.

  • isAutoQuotingEnabled() public

    Returns whether or not this driver should automatically quote identifiers in queries.

  • isConnected() public

    Checks whether or not the driver is connected.

  • lastInsertId() public

    Returns last id generated for a table or sequence in database.

  • newCompiler() public

    Returns an instance of a QueryCompiler.

  • prepare() public

    Prepares a sql statement to be executed.

  • queryTranslator() public

    Returns a callable function that will be used to transform a passed Query object. This function, in turn, will return an instance of a Query object that has been transformed to accommodate any specificities of the SQL dialect in use.

  • quote() public

    Returns a value in a safe representation to be used in a query string

  • quoteIdentifier() public

    Quotes a database identifier (a column name, table name, etc..) to be used safely in queries without the risk of using reserved words.

  • releaseSavePointSQL() public

    Get the SQL for releasing a save point.

  • rollbackSavePointSQL() public

    Get the SQL for rollingback a save point.

  • rollbackTransaction() public

    Rollbacks a transaction.

  • savePointSQL() public

    Get the SQL for creating a save point.

  • schema() public

    Returns the schema name that's being used.

  • schemaDialect() public

    Get the schema dialect.

  • schemaValue() public

    Escapes values for use in schema definitions.

  • setConnection() public

    Set the internal connection object.

  • supportsDynamicConstraints() public

    Returns whether the driver supports adding or dropping constraints to already created tables.

  • supportsQuoting() public

    Checks if the driver supports quoting.

  • supportsSavePoints() public

    Returns whether this driver supports save points for nested transactions.

Method Detail

beginTransaction() ¶ public

beginTransaction(): bool

Starts a transaction.

Returns
bool

commitTransaction() ¶ public

commitTransaction(): bool

Commits a transaction.

Returns
bool

compileQuery() ¶ public

compileQuery(Cake\Database\Query $query, Cake\Database\ValueBinder $generator): array

Transforms the passed query to this Driver's dialect and returns an instance of the transformed query and the full compiled SQL string.

Parameters
Cake\Database\Query $query

The query to compile.

Cake\Database\ValueBinder $generator

The value binder to use.

Returns
array

connect() ¶ public

connect(): bool

Establishes a connection to the database server.

Returns
bool

disableAutoQuoting() ¶ public @method

disableAutoQuoting(): $this
Returns
$this

disableForeignKeySQL() ¶ public

disableForeignKeySQL(): string

Get the SQL for disabling foreign keys.

Returns
string

disconnect() ¶ public

disconnect(): void

Disconnects from database server.

Returns
void

enableAutoQuoting() ¶ public

enableAutoQuoting(bool $enable = true): $this

Sets whether or not this driver should automatically quote identifiers in queries.

Parameters
bool $enable optional

Whether to enable auto quoting

Returns
$this

enableForeignKeySQL() ¶ public

enableForeignKeySQL(): string

Get the SQL for enabling foreign keys.

Returns
string

enabled() ¶ public

enabled(): bool

Returns whether php is able to use this driver for connecting to database.

Returns
bool

getConnection() ¶ public

getConnection(): object

Returns correct connection resource or object that is internally used.

Returns
object

isAutoQuotingEnabled() ¶ public

isAutoQuotingEnabled(): bool

Returns whether or not this driver should automatically quote identifiers in queries.

Returns
bool

isConnected() ¶ public

isConnected(): bool

Checks whether or not the driver is connected.

Returns
bool

lastInsertId() ¶ public

lastInsertId(string|null $table = null, string|null $column = null): string|int

Returns last id generated for a table or sequence in database.

Parameters
string|null $table optional

table name or sequence to get last insert value from.

string|null $column optional

the name of the column representing the primary key.

Returns
string|int

newCompiler() ¶ public

newCompiler(): Cake\Database\QueryCompiler

Returns an instance of a QueryCompiler.

Returns
Cake\Database\QueryCompiler

prepare() ¶ public

prepare(string|Cake\Database\Query $query): Cake\Database\StatementInterface

Prepares a sql statement to be executed.

Parameters
string|Cake\Database\Query $query

The query to turn into a prepared statement.

Returns
Cake\Database\StatementInterface

queryTranslator() ¶ public

queryTranslator(string $type): callable

Returns a callable function that will be used to transform a passed Query object. This function, in turn, will return an instance of a Query object that has been transformed to accommodate any specificities of the SQL dialect in use.

Parameters
string $type

The type of query to be transformed (select, insert, update, delete).

Returns
callable

quote() ¶ public

quote(mixed $value, string $type): string

Returns a value in a safe representation to be used in a query string

Parameters
mixed $value

The value to quote.

string $type

Type to be used for determining kind of quoting to perform.

Returns
string

quoteIdentifier() ¶ public

quoteIdentifier(string $identifier): string

Quotes a database identifier (a column name, table name, etc..) to be used safely in queries without the risk of using reserved words.

Parameters
string $identifier

The identifier expression to quote.

Returns
string

releaseSavePointSQL() ¶ public

releaseSavePointSQL(string $name): string

Get the SQL for releasing a save point.

Parameters
string $name

The table name.

Returns
string

rollbackSavePointSQL() ¶ public

rollbackSavePointSQL(string $name): string

Get the SQL for rollingback a save point.

Parameters
string $name

The table name.

Returns
string

rollbackTransaction() ¶ public

rollbackTransaction(): bool

Rollbacks a transaction.

Returns
bool

savePointSQL() ¶ public

savePointSQL(string $name): string

Get the SQL for creating a save point.

Parameters
string $name

The table name.

Returns
string

schema() ¶ public

schema(): string

Returns the schema name that's being used.

Returns
string

schemaDialect() ¶ public

schemaDialect(): Cake\Database\Schema\BaseSchema

Get the schema dialect.

Used by Cake\Database\Schema package to reflect schema and generate schema.

If all the tables that use this Driver specify their own schemas, then this may return null.

Returns
Cake\Database\Schema\BaseSchema

schemaValue() ¶ public

schemaValue(mixed $value): string

Escapes values for use in schema definitions.

Parameters
mixed $value

The value to escape.

Returns
string

setConnection() ¶ public

setConnection(object $connection): $this

Set the internal connection object.

Parameters
object $connection

The connection instance.

Returns
$this

supportsDynamicConstraints() ¶ public

supportsDynamicConstraints(): bool

Returns whether the driver supports adding or dropping constraints to already created tables.

Returns
bool

supportsQuoting() ¶ public

supportsQuoting(): bool

Checks if the driver supports quoting.

Returns
bool

supportsSavePoints() ¶ public

supportsSavePoints(): bool

Returns whether this driver supports save points for nested transactions.

Returns
bool
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs