README

Laravel-OCI8

Laravel-OCI8 is an Oracle Database Driver package for Laravel. Laravel-OCI8 is an extension of Illuminate/Database that uses OCI8 extension to communicate with Oracle. Thanks to @taylorotwell.

Documentations

• You will find user-friendly and updated documentation here: Laravel-OCI8 Docs
• All about oracle and php:The Underground PHP and Oracle Manual

Laravel Version Compatibility

Quick Installation

composer require yajra/laravel-oci8:^13

Larastan / PHPStan

This package includes an optional PHPStan/Larastan extension for OCI8-specific DB methods. Include it in your phpstan.neon if you want those methods recognized during static analysis.

includes:
    - vendor/yajra/laravel-oci8/extension.neon

Service Provider (Optional on Laravel 5.5+)

Once Composer has installed or updated your packages you need to register Laravel-OCI8. Open up config/app.php and find the providers key and add:

Yajra\Oci8\Oci8ServiceProvider::class,

Configuration (OPTIONAL)

Finally you can optionally publish a configuration file by running the following Artisan command. If config file is not publish, the package will automatically use what is declared on your .env file database configuration.

php artisan vendor:publish --tag=oracle

This will copy the configuration file to config/oracle.php.

Note: For Laravel Lumen configuration, make sure you have a config/database.php file on your project and append the configuration below:

'oracle' => [
    'driver'         => 'oracle',
    'tns'            => env('DB_TNS', ''),
    'host'           => env('DB_HOST', ''),
    'port'           => env('DB_PORT', '1521'),
    'database'       => env('DB_DATABASE', ''),
    'service_name'   => env('DB_SERVICE_NAME', ''),
    'username'       => env('DB_USERNAME', ''),
    'password'       => env('DB_PASSWORD', ''),
    'charset'        => env('DB_CHARSET', 'AL32UTF8'),
    'prefix'         => env('DB_PREFIX', ''),
    'prefix_schema'  => env('DB_SCHEMA_PREFIX', ''),
    'edition'        => env('DB_EDITION', 'ora$base'),
    'server_version' => env('DB_SERVER_VERSION', '11g'),
    'load_balance'   => env('DB_LOAD_BALANCE', 'yes'),
    'connect_timeout' => env('DB_CONNECT_TIMEOUT', ''),
    'retry_count'    => env('DB_RETRY_COUNT', '3'), // 12c and above only
    'retry_delay'    => env('DB_RETRY_DELAY', '1'), // 12c and above only
    'transport_connect_timeout' => env('DB_TRANSPORT_CONNECT_TIMEOUT', '60'), // 12c and above only
    'expire_time'    => env('DB_EXPIRE_TIME', '0'), // 19c and above only
    'dynamic'        => [],
    'max_name_len'   => env('ORA_MAX_NAME_LEN', 30),
],

Then, you can set connection data in your .env files:

DB_CONNECTION=oracle
DB_HOST=oracle.host
DB_PORT=1521
DB_SERVICE_NAME=orcl
DB_DATABASE=xe
DB_USERNAME=hr
DB_PASSWORD=hr
DB_CONNECT_TIMEOUT=10
DB_RETRY_COUNT=3
DB_RETRY_DELAY=1
DB_TRANSPORT_CONNECT_TIMEOUT=60
DB_EXPIRE_TIME=0

If you want to connect to a cluster containing multiple hosts, you can either set tns manually or set host as a comma-separated array and configure other fields as you wish:

DB_CONNECTION=oracle
DB_HOST=oracle1.host, oracle2.host
DB_PORT=1521
DB_SERVICE_NAME=orcl
DB_LOAD_BALANCE=no
DB_DATABASE=xe
DB_USERNAME=hr
DB_PASSWORD=hr

If you need to connect with the service name instead of tns, you can use the configuration below:

'oracle' => [
    'driver' => 'oracle',
    'host' => 'oracle.host',
    'port' => '1521',
    'database' => 'xe',
    'service_name' => 'sid_alias',
    'username' => 'hr',
    'password' => 'hr',
    'charset' => '',
    'prefix' => '',
]

In some cases you may wish to set the connection parameters dynamically in your app. For instance, you may access more than one database, or your users may already have their own accounts on the Oracle database:

'oracle' => [
    'driver' => 'oracle',
    'host' => 'oracle.host',
    'port' => '1521',
    'service_name' => 'sid_alias',
    'prefix' => 'schemaowner',
    'dynamic' => [App\Models\Oracle\Config::class, 'dynamicConfig'],
]

The callback function in your app must be static and accept a reference to the $config[] array (which will already be populated with values set in the config file):

namespace App\Models\Oracle;

class Config {

    public static function dynamicConfig(&$config) {

        if (Illuminate\Support\Facades\Auth::check()) {
            $config['username'] = App\Oracle\Config::getOraUser();
            $config['password'] = App\Oracle\Config::getOraPass();
        }

    }
}

Then run your laravel installation...

Oracle versions

To set this version use DB_SERVER_VERSION env variable or change server_version variable in the oracle.php config.

11g

This is the baseline, if no version is set, this version is assumed.

12c

• Use fetch/offset where possible instead of rownumber.
• Use identity instead of seqvence/trigger for ids when using laravel's scheme builder. (#944)
• JoinLateral support (#989)

12cR2

• In whereLike use binary ci for case insensitivity. (#945)

19c

• JSON path updates with query builder update(['options->path' => $value]). (#1007)

21c

• Use native json type instead of clob in schema builder. (#983)

Oracle Max Name Length

By default, DB object name are limited to 30 characters. To increase the limit, you can set the ORA_MAX_NAME_LEN=128 in your .env file.

Note: this config requires Oracle 12c02 or higher.

[Laravel 5.2++] Oracle User Provider

When using oracle, we may encounter a problem on authentication because oracle queries are case sensitive by default. By using this oracle user provider, we will now be able to avoid user issues when logging in and doing a forgot password failure because of case sensitive search.

To use, just update auth.php config and set the driver to oracle

'providers' => [
    'users' => [
        'driver' => 'oracle',
        'model' => App\User::class,
    ],
]

JSON support

Laravel-OCI8 provides JSON query support for Oracle databases.

⚠️This requires Oracle 12c02 or higher.

JSON path updates using Laravel's update(['json->key' => ...]) syntax are supported on Oracle 19c or higher:

DB::table('users')
    ->where('id', $id)
    ->update(['options->profile->settings->theme' => 'dark']);

Only one JSON path may be updated for the same JSON column in a single update() call. Use separate update() calls for multiple paths, matching Laravel's PostgreSQL and MariaDB grammar behavior.

On Oracle versions below 19c, JSON path updates are not supported. Modify the full JSON document in the application and save the column value instead.

Laravel Builder Compatibility

The tables below cover Laravel 13 builder operations whose behavior depends on the database driver. General fluent helpers inherited from Laravel follow their normal behavior. Unsupported operations throw an exception (or have no Oracle compiler); No-op options are accepted but do not change the generated Oracle SQL.

Schema Builder

Query Builder

Credits

• Arjay Angeles
• Jimmy Felder
• All Contributors

License

The MIT License (MIT). Please see License File for more information.