Using Google Sheets with Eloquent

Packages

March 20th, 2020

laravel-excel.png

Eloquent Sheets is a package by Ed Grosvenor that lets you work with Google Sheets via Eloquent models:

This package provides an Eloquent model that sits on top of a Google Sheet. In order for it to work, there are two things your sheet needs to have. One is a heading row that holds the name of your columns. This defaults to row 1 (the top row) but it can be any row in the sheet. The other is a primary key column. Eloquent assumes that your primary key column is named id. If it’s not, set it in your model like you would normally.

Going through the readme will get you set up, and once you have a generated model class, it will look something like the following example:

use Grosv\EloquentSheets\SheetModel;

class YourGoogleSheetsModel extends SheetModel
{
    // The id of the spreadsheet
    protected $spreadsheetId = '1HxNqqLtc614UVLoTLEItfvcdcOm3URBEM2Zkr36Z1rE';
    // The id of the sheet within the spreadsheet (gid=xxxxx on the URL)
    protected $sheetId = '0';
    // The row containing the names of your columns (eg. id, name, email, phone)
    protected $headerRow = '1';
}

With the Google Sheet model, you can use basic eloquent features; however, the model can only use read and list methods at this time. Update and insert won’t work, but this package does provide a way to read sheet data via Eloquent. Insert and update functionality might be added in the future.

If you’d like to learn more about this package, check it out on GitHub at grosv/eloquent-sheets.

Filed in:

Paul Redmond

Full stack web developer. Author of Lumen Programming Guide and Docker for PHP Developers.