---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: gsheets
excerpt: |
  DuckDB Community Extensions
  Read and write Google Sheets using SQL

extension:
  name: gsheets
  description: Read and write Google Sheets using SQL
  version: 0.0.9
  language: C++
  build: cmake
  license: MIT
  excluded_platforms: "windows_amd64_rtools;windows_amd64_mingw;wasm_mvp;wasm_eh;wasm_threads"
  maintainers:
    - archiewood
    - mharrisb1

repo:
  github: evidence-dev/duckdb_gsheets
  ref: a209d8a42c8e35cd571467dd7ae2eb65fcb96f75

docs:
  hello_world: |
    -- Authenticate with Google Account in the browser (easiest)
    CREATE SECRET (TYPE gsheet);

    -- OR create a secret with your Google API access token (boring, see extension docs)
    CREATE SECRET (
      TYPE gsheet, 
      PROVIDER access_token, 
      TOKEN '<your_token>'
    );

    -- Read a spreadsheet by full URL
    FROM read_gsheet('https://docs.google.com/spreadsheets/d/11QdEasMWbETbFVxry-SsD8jVcdYIT1zBQszcF84MdE8/edit');

    -- Read a spreadsheet by full URL, implicitly
    FROM 'https://docs.google.com/spreadsheets/d/11QdEasMWbETbFVxry-SsD8jVcdYIT1zBQszcF84MdE8/edit';

    -- Read a spreadsheet by spreadsheet id
    FROM read_gsheet('11QdEasMWbETbFVxry-SsD8jVcdYIT1zBQszcF84MdE8');

    -- Read a spreadsheet with no header row
    SELECT * FROM read_gsheet('11QdEasMWbETbFVxry-SsD8jVcdYIT1zBQszcF84MdE8', headers=false);

    -- Read all values in as varchar, skipping type inference
    SELECT * FROM read_gsheet('11QdEasMWbETbFVxry-SsD8jVcdYIT1zBQszcF84MdE8', all_varchar=true);

    -- Read a sheet other than the first sheet using the sheet name
    SELECT * FROM read_gsheet('11QdEasMWbETbFVxry-SsD8jVcdYIT1zBQszcF84MdE8', sheet='Sheet2');

    -- Read a sheet other than the first sheet using the sheet id in the URL
    SELECT * FROM read_gsheet('https://docs.google.com/spreadsheets/d/11QdEasMWbETbFVxry-SsD8jVcdYIT1zBQszcF84MdE8/edit?gid=644613997#gid=644613997');

    -- Write a spreadsheet from a table by spreadsheet id
    COPY <table_name> TO '11QdEasMWbETbFVxry-SsD8jVcdYIT1zBQszcF84MdE8' (FORMAT gsheet);

    -- Write a spreadsheet from a table by full URL
    COPY <table_name> TO 'https://docs.google.com/spreadsheets/d/11QdEasMWbETbFVxry-SsD8jVcdYIT1zBQszcF84MdE8/edit?usp=sharing' (FORMAT gsheet);

    -- Create a sheet if it doesn't already exist
    COPY <table_name> TO 'https://docs.google.com/spreadsheets/d/11QdEasMWbETbFVxry-SsD8jVcdYIT1zBQszcF84MdE8/edit' (FORMAT gsheet, sheet 'Woot', create_if_not_exists true);

    -- Write a spreadsheet to a specific sheet using the sheet id in the URL
    COPY <table_name> TO 'https://docs.google.com/spreadsheets/d/11QdEasMWbETbFVxry-SsD8jVcdYIT1zBQszcF84MdE8/edit?gid=1295634987#gid=1295634987' (FORMAT gsheet);

  extended_description: |
    The DuckDB GSheets Extension allows reading and writing of data in Google Sheets from DuckDB.
    For detailed setup and usage instructions, visit the docs at [duckdb-gsheets.com](https://duckdb-gsheets.com).

extension_star_count: 359
extension_star_count_pretty: 359
extension_download_count: 191209
extension_download_count_pretty: 191.2k
image: '/images/community_extensions/social_preview/preview_community_extension_gsheets.png'
layout: community_extension_doc
---
### Compatibility Matrix

This table covers all DuckDB releases that have not reached [end-of-life](https://duckdb.org/release_calendar), including LTS releases, and shows the 2 most recent patch releases of each. Older patch releases are not listed, but the extension may be available for them as well.

<div class="extension_compatibility_table"></div>

| Platform | 1.4.4 | 1.4.5 | 1.5.5 | 1.5.6 | 2.0.0 |
| :--- | :---: | :---: | :---: | :---: | :---: |
| Linux AMD64 | ✅ | ✅ | ✅ | ✅ | ❌ |
| Linux ARM64 | ✅ | ✅ | ✅ | ✅ | ❌ |
| macOS AMD64 | ✅ | ✅ | ✅ | ✅ | ❌ |
| macOS ARM64 | ✅ | ✅ | ✅ | ✅ | ❌ |
| Windows AMD64 | ✅ | ✅ | ✅ | ✅ | ❌ |
| Windows ARM64 | ❌ | ❌ | ❌ | ❌ | ❌ |
| WebAssembly | ❌ | ❌ | ❌ | ❌ | ❌ |

### Installing and Loading
```sql
INSTALL {{ page.extension.name }} FROM community;
LOAD {{ page.extension.name }};
```

{% if page.docs.hello_world %}
### Example
```sql
{{ page.docs.hello_world }}```
{% endif %}

{% if page.docs.extended_description %}
### About {{ page.extension.name }}
{{ page.docs.extended_description }}
{% endif %}
### Added Functions

<div class="extension_functions_table"></div>

| function_name | function_type | description | comment | examples |
|---------------|---------------|-------------|---------|----------|
| read_gsheet   | table         | NULL        | NULL    |          |

### Overloaded Functions

<div class="extension_functions_table"></div>

This extension does not add any function overloads.

### Added Types

<div class="extension_types_table"></div>

This extension does not add any types.

### Added Settings

<div class="extension_settings_table"></div>

This extension does not add any settings.