README

Tip

This package is forked from schulzefelix/laravel-bigquery and enhanced with support for the latest versions of Laravel and PHP. If the version you want to use is already supported in the original repository, it's recommended to use the original version.

Using this package you can easily interact with the Google BigQuery API.

Install

This package can be installed through Composer.

composer require hankz/laravel-google-bigquery

Optionally, you can publish the config file of this package with this command:

php artisan vendor:publish --provider="SchulzeFelix\BigQuery\BigQueryServiceProvider"

The following config file will be published in config/bigquery.php

return [

    /*
    |--------------------------------------------------------------------------
    | Application Credentials
    |--------------------------------------------------------------------------
    |
    | Path to the Service Account Credentials JSON File
    |
    | https://googlecloudplatform.github.io/google-cloud-php/#/docs/google-cloud/v0.35.0/guides/authentication
    |
    */

    'application_credentials' => env('GOOGLE_CLOUD_APPLICATION_CREDENTIALS'),


    /*
    | OPTIONAL:
    | Use keyFile to use a json config from the current environment.
    | For example secrets in laravel vapor
    |
    | https://docs.vapor.build/1.0/projects/environments.html#secrets
    */
    //'keyFile' => json_decode(trim(env('GOOGLE_CLOUD_APPLICATION_CREDENTIALS')), true),

    /*
    |--------------------------------------------------------------------------
    | Project ID
    |--------------------------------------------------------------------------
    |
    | The Project Name is a user-friendly name,
    | while the Project ID is required by the Google Cloud client libraries to authenticate API requests.
    |
    */

    'project_id' => env('GOOGLE_CLOUD_PROJECT_ID'),

    /*
    |--------------------------------------------------------------------------
    | Client Auth Cache Store
    |--------------------------------------------------------------------------
    |
    | This option controls the auth cache connection that gets used.
    |
    | Supported: "apc", "array", "database", "file", "memcached", "redis"
    |
    */

    'auth_cache_store' => 'file',

    /*
    |--------------------------------------------------------------------------
    | Client Options
    |--------------------------------------------------------------------------
    |
    | Here you may configure additional parameters that
    | the underlying BigQueryClient will use.
    |
    | Optional parameters: "authCacheOptions", "authHttpHandler", "httpHandler", "retries", "scopes", "returnInt64AsObject"
    */

    'client_options' => [
        'retries' => 3, // Default
    ],

    /*
    |--------------------------------------------------------------------------
    | Dataset location
    |--------------------------------------------------------------------------
    |
    | Specify the dataset location.
    |
    | Supported values can be found at https://cloud.google.com/bigquery/docs/locations
    |
    */

    'location' => '',
];

Usage

This package just initialize the BigQuery connection, you can use every method like in Google's API. You can use the provided Facade or retrieve the it from the IoC Container.

BigQuery::apiMethod();

app('bigquery')->apiMethod();

Here are two basic example to create a dataset and check for existence of a table

Create Dataset

$dataset = BigQuery::createDataset('myNewDataSet');

Check Existence Of A Table

BigQuery::dataset(myNewDataSet)->table('aTable')->exists());

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ vendor/bin/phpunit

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email github@schulze.co instead of using the issue tracker.

Credits

License

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

hankz / laravel-google-bigquery

Maintainers

Details