uepg/laravel-sybase

Sybase based Eloquent module extension for Laravel 10.x

4.1.1 2024-12-12 14:45 UTC

README

Packagist Version PHP from Packagist Packagist GitHub contributors GitHub

  • Enables use of multiple kinds of fields.
  • Use default eloquent: works with odbc and dblib!
  • Migrations! (WIP - Work in Progress)

Install

Add the following in the require section of your composer.json:

Laravel >=7.x

"uepg/laravel-sybase": "~4.0"

Update the package dependencies executing:

composer update

Add the following entry to your providers array in config/app.php file, optional in Laravel 5.5 or above:

Uepg\LaravelSybase\SybaseServiceProvider::class,

Add the following entry to your aliases array in config/app.php file, optional in Laravel 5.5 or above:

'UepgBlueprint' => Uepg\LaravelSybase\Database\Schema\Blueprint::class,

Update your config/database.php's default driver with the settings for the sybase or your custom odbc. See the following example:

<?php

...

return [
    ...

    'connections' => [
        ...

        'sybase' => [
            'driver' => 'sybasease',
            'host' => env('DB_HOST', 'sybase.myserver.com'),
            'port' => env('DB_PORT', '5000'),
            'database' => env('DB_DATABASE', 'mydatabase'),
            'username' => env('DB_USERNAME', 'user'),
            'password' => env('DB_PASSWORD', 'password'),
            'charset' => 'utf8',
            'prefix' => '',
            'cache' => true // By default it caches on all connections, if you want some connection not remembered assign `false` (Recommended when modification is performed on tables frequently [development])
        ],

        ...
    ],

    ...
]

Update your .env with the settings for the sybase or your custom odbc. See the following example:

...

DB_CONNECTION=sybase
DB_HOST=sybase.myserver.com
DB_PORT=5000
DB_DATABASE=mydatabase
DB_USERNAME=user
DB_PASSWORD=password

...

Configuration of freetds driver

In Linux systems the driver version must be set in freetds.conf file to the right use of charset pages.

The file is usualy found in /etc/freetds/freetds.conf. Set the configuration at global section as the following example:

[global]
    # TDS protocol version
    tds version = 5.0

Configuring the charset between the database and the application

To configure the charset between the database and the application, add the fields SYBASE_DATABASE_CHARSET and SYBASE_APPLICATION_CHARSET in .env file, see the following example:

SYBASE_DATABASE_CHARSET=CP850
SYBASE_APPLICATION_CHARSET=UTF8

Configuring the cache

As the library consults table information whenever it receives a request, caching can be used to avoid excessive queries

To use the cache, add the fields SYBASE_CACHE_TABLES and SYBASE_CACHE_TABLES_TIME to the .env file, see the following example:

SYBASE_CACHE_TABLES=true
SYBASE_CACHE_TABLES_TIME=3600 # cache table information by `3600` seconds

Setting to use numeric data type

In the migration file you must replace use Illuminate\Database\Schema\Blueprint; with use Uepg\LaravelSybase\Database\Schema\Blueprint;. See the following example:

<?php

use Illuminate\Support\Facades\Schema;
// use Illuminate\Database\Schema\Blueprint;
use Uepg\LaravelSybase\Database\Schema\Blueprint; // or "use UepgBlueprint as Blueprint"
use Illuminate\Database\Migrations\Migration;

class CreateTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('table_name', function (Blueprint $table) {
            $table->numeric('column_name', length, autoIncrement);
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('table_name');
    }
}