9.23. Google Sheets Connector#
The Google Sheets connector allows reading Google Sheets spreadsheets as tables in Presto.
to mount the Google Sheets connector as the
replacing the properties as appropriate:
connector.name=gsheets credentials-path=/path/to/google-sheets-credentials.json metadata-sheet-id=exampleId
The following configuration properties are available:
||Path to the Google API JSON key file|
||Sheet ID of the spreadsheet, that contains the table mapping|
||Maximum number of spreadsheets to cache, defaults to
||How long to cache spreadsheet data or metadata, defaults to
The connector requires credentials in order to access the Google Sheets API.
- Open the Google Sheets API page and click the Enable button. This takes you to the API manager page.
- Select a project using the drop down menu at the top of the page. Create a new project, if you do not already have one.
- Choose Credentials in the left panel.
- Click Manage service accounts, then create a service account for the connector. On the Create key step, create and download a key in JSON format.
The key file needs to be available on the Presto coordinator and workers.
credentials-path configuration property to point to this file.
The exact name of the file does not matter – it can be named anything.
The metadata sheet is used to map table names to sheet IDs. Create a new metadata sheet. The first row must be a header row containing the following columns in this order:
- Table Name
- Sheet ID
See this example sheet as a reference.
The metadata sheet must be shared with the service account user, the one for which the key credentials file was created. Click the Share button to share the sheet with the email address of the service account.
metadata-sheet-id configuration property to the ID of this sheet.
The service account user must have access to the sheet in order for Presto to query it. Click the Share button to share the sheet with the email address of the service account.
The sheet needs to be mapped to a Presto table name. Specify a table name
(column A) and the sheet ID (column B) in the metadata sheet. To refer
to a specific tab in the sheet, add the tab name after the sheet ID, separated
#. If tab name is not provided, connector loads only 10,000 rows by default from
the first tab in the sheet.
API Usage Limits#
The Google Sheets API has usage limits,
that may impact the usage of this connector. Increasing the cache duration and/or size
may prevent the limit from being reached. Running queries on the
table without a schema and table name filter may lead to hitting the limit, as this requires
fetching the sheet data for every table, unless it is already cached.