README

An BigQuery for CakePHP 5.x

Installing via composer

Install composer and run:

composer require giginc/cakephp5-driver-bigquery

Defining a connection

Now, you need to set the connection in your config/app.php file:

 'Datasources' => [
...
    'bigquery' => [
        'className' => 'Giginc\BigQuery\Database\Connection',
        'driver' => 'Giginc\BigQuery\Database\Driver\BigQuery',
        'projectId' => env('BIGQUERY_PROJECT_ID', 'project_id'),
        'dataSet' => env('BIGQUERY_DATASET', 'dataset'),
        'keyFile' => [], // Console. Ex: json_decode(file_get_contents($path), true).
        'keyFilePath' => null, //The full path to your service account credentials .json file retrieved.
        'requestTimeout' => 0, // Defaults to 0 with REST and 60 with gRPC.
        'retries' => 3, // Number of retries for a failed request. Defaults to 3.
        'location' => 'us', // If provided, determines the default geographic location used when creating datasets and managing jobs.
        'maximumBytesBilled' => 1000000,
    ],

],

Models

After that, you need to load Giginc\BigQuery\ORM\Table in your tables class:

Table

//src/Model/Table/ProductsTable.php
namespace App\Model\Table;

use Giginc\BigQuery\ORM\Table;

/**
 * ProductsTable Table
 *
 * @uses Table
 * @package Table
 */
class ProductsTable extends Table
{
    public function initialize(array $config): void
    {
        parent::initialize($config);

        $this->setTable('products_%Y%m%d');
        $this->setSchema([
            [
                "name" => "name",
                "type" => "STRING",
                "mode" => "NULLABLE",
            ],[
                "name" => "description",
                "type" => "STRING",
                "mode" => "NULLABLE",
            ],[
                "name" => "count",
                "type" => "INTEGER",
                "mode" => "NULLABLE",
            ],[
                "name" => "created_at",
                "type" => "DATETIME",
                "mode" => "NULLABLE",
            ],
        ]);
    }

    public static function defaultConnectionName(): string
    {
        return 'bigquery';
    }

    public function findOk($query, array $options)
    {
        $query = $query
            ->where([
                'status' => 'ok',
            ]);

        return $query;
    }
}

Entity

//src/Model/Entity/Product.php
namespace App\Model\Entity;

use Cake\ORM\Entity;

/**
 * Product Entity
 *
 * @uses Entity
 * @package Entity
 */
class Product extends Entity
{
    protected $_accessible = [
        '*' => true,
        'id' => false,
    ];

    protected $_virtual = [
    ];
}

## Controllers

```php
namespace App\Controller;

use App\Controller\AppController;

/**
 * Pages Controller
 *
 * @property \App\Model\Table\PagesTable $Pages
 *
 * @method \App\Model\Entity\Review[]|\Cake\Datasource\ResultSetInterface paginate($object = null, array $settings = [])
 */
class PagesController extends AppController
{
    /**
     * Index method
     *
     * @access public
     * @return \Cake\Http\Response|void
     */
    public function index()
    {
        // select
        $data = $this->fetchTable('Products')->date('2021-04-12')
            ->bqFind()
            ->fields([
                'name',
                'description',
                'MAX(count) AS max',
                'COUNT(*) AS count',
            ])
            ->where([
                'name' => 'iphone',
                'count >' => 0,
            ])
            ->group(['name', 'description'])
            ->order(['name' => 'DESC'])
            ->limit(5)
            ->all();

        // insert
        $this->fetchTable('Products')->insert([
            'name' => 'iPhoneXR',
            'description' => 'iPhoneXR',
            'created_at' => '2021-04-21',
        ]);
    }
}

LICENSE

The MIT License (MIT) Copyright (c) 2026