CakePHP 3 Driver for Oracle Database
You can install this plugin into your CakePHP application using Composer.
The recommended way to install Composer packages is:
composer require cakedc/cakephp-oracle-driver
In bootstrap.php load plugin with bootstrap.
Plugin::load('CakeDC/OracleDriver', ['bootstrap' => true]);
- CakePHP 3.2+
- an Oracle PHP extension
- OCI8 (PHP extension built with PHP)
- PDO_OCI (PHP extension built with PHP)
Notes on extensions
For full support, it is recommended to run the
OCI8 extension if possible.
PDO_OCI might be simpler to set up, there are some limitations (e.g.
it doesn't support the stored code layer, so only the SQL layer will be
Here is an example datasource configuration:
<?php return [ 'Datasources' => [ 'default' => [ 'className' => 'CakeDC\OracleDriver\Database\OracleConnection', 'driver' => 'CakeDC\OracleDriver\Database\Driver\OracleOCI', # For OCI8 #'driver' => 'CakeDC\\OracleDriver\\Database\\Driver\\OraclePDO', # For PDO_OCI 'host' => 'oracle11g', # Database host name or IP address //'port' => 'nonstandard_port', # Database port number (default: 1521) 'username' => 'blogs', # Database username 'password' => 'password', # Database password 'database' => 'XE', # Database name (maps to Oracle's `SERVICE_NAME`) 'sid' => '', # Database System ID (maps to Oracle's `SID`) 'instance' => '', # Database instance name (maps to Oracle's `INSTANCE_NAME`) 'pooled' => '', # Database pooling (maps to Oracle's `SERVER=POOLED`) ] ] ];
As you can see, the
driver need switched to Oracle-specific
classes. The driver will depend on whether you want to use
PDO or not. The
database name "XE" in this case, is defined as the
SERVICE_NAME in Oracle's
The above array format is translated into Oracle's
Easy Connection Naming. You can find the logic for this in
For documentation, as well as tutorials, see the docs directory of this repository.
- Provide full compatibility with Phinx based migrations
- Provide compatibility with Oracle database version 12
- Transform data types into native PHP types when returned form the database @todo copy todos to the roadmap
For bugs and feature requests, please use the issues section of this repository.
Commercial support is also available, contact us for more information.
This repository follows the CakeDC Plugin Standard. If you'd like to contribute new features, enhancements or bug fixes to the plugin, please read our Contribution Guidelines for detailed instructions.
Copyright 2016 Cake Development Corporation (CakeDC). All rights reserved.
Licensed under the MIT License. Redistributions of the source code included in this repository must retain the copyright notice found in each file.