From c5bd50acb2e50f4359e8f32b5b1238da0fbc68ff Mon Sep 17 00:00:00 2001 From: Ved misra <47312748+misraved@users.noreply.github.com> Date: Tue, 12 Dec 2023 23:04:55 +0530 Subject: [PATCH] Improve table docs (#65) --- .github/workflows/steampipe-anywhere.yml | 12 + README.md | 24 +- docs/LICENSE | 402 +++++++++++++++++++++++ docs/index.md | 8 +- docs/tables/googlesheets_cell.md | 232 +++++++++++-- docs/tables/googlesheets_sheet.md | 72 +++- docs/tables/googlesheets_spreadsheet.md | 73 +++- docs/tables/{sheet_name}.md | 67 +++- 8 files changed, 835 insertions(+), 55 deletions(-) create mode 100644 .github/workflows/steampipe-anywhere.yml create mode 100644 docs/LICENSE diff --git a/.github/workflows/steampipe-anywhere.yml b/.github/workflows/steampipe-anywhere.yml new file mode 100644 index 0000000..05092d6 --- /dev/null +++ b/.github/workflows/steampipe-anywhere.yml @@ -0,0 +1,12 @@ +name: Release Steampipe Anywhere Components + +on: + push: + tags: + - 'v*' + + +jobs: + anywhere_publish_workflow: + uses: turbot/steampipe-workflows/.github/workflows/steampipe-anywhere.yml@main + secrets: inherit diff --git a/README.md b/README.md index 2bb42b9..ecfb24a 100644 --- a/README.md +++ b/README.md @@ -132,6 +132,18 @@ where +------|--------------+ ``` +## Engines + +This plugin is available for the following engines: + +| Engine | Description +|---------------|------------------------------------------ +| [Steampipe](https://steampipe.io/docs) | The Steampipe CLI exposes APIs and services as a high-performance relational database, giving you the ability to write SQL-based queries to explore dynamic data. Mods extend Steampipe's capabilities with dashboards, reports, and controls built with simple HCL. The Steampipe CLI is a turnkey solution that includes its own Postgres database, plugin management, and mod support. +| [Postgres FDW](https://steampipe.io/docs/steampipe_postgres/index) | Steampipe Postgres FDWs are native Postgres Foreign Data Wrappers that translate APIs to foreign tables. Unlike Steampipe CLI, which ships with its own Postgres server instance, the Steampipe Postgres FDWs can be installed in any supported Postgres database version. +| [SQLite Extension](https://steampipe.io/docs//steampipe_sqlite/index) | Steampipe SQLite Extensions provide SQLite virtual tables that translate your queries into API calls, transparently fetching information from your API or service as you request it. +| [Export](https://steampipe.io/docs/steampipe_export/index) | Steampipe Plugin Exporters provide a flexible mechanism for exporting information from cloud services and APIs. Each exporter is a stand-alone binary that allows you to extract data using Steampipe plugins without a database. +| [Turbot Pipes](https://turbot.com/pipes/docs) | Turbot Pipes is the only intelligence, automation & security platform built specifically for DevOps. Pipes provide hosted Steampipe database instances, shared dashboards, snapshots, and more. + ## Developing Prerequisites: @@ -171,11 +183,17 @@ Further reading: - [Writing plugins](https://steampipe.io/docs/develop/writing-plugins) - [Writing your first table](https://steampipe.io/docs/develop/writing-your-first-table) -## Contributing +## Open Source & Contributing + +This repository is published under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) (source code) and [CC BY-NC-ND](https://creativecommons.org/licenses/by-nc-nd/2.0/) (docs) licenses. Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). We look forward to collaborating with you! + +[Steampipe](https://steampipe.io) is a product produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source). + +## Get Involved -Please see the [contribution guidelines](https://github.com/turbot/steampipe/blob/main/CONTRIBUTING.md) and our [code of conduct](https://github.com/turbot/steampipe/blob/main/CODE_OF_CONDUCT.md). All contributions are subject to the [Apache 2.0 open source license](https://github.com/turbot/steampipe-plugin-googlesheets/blob/main/LICENSE). +**[Join #steampipe on Slack →](https://turbot.com/community/join)** -`help wanted` issues: +Want to help but don't know where to start? Pick up one of the `help wanted` issues: - [Steampipe](https://github.com/turbot/steampipe/labels/help%20wanted) - [Google Sheets Plugin](https://github.com/turbot/steampipe-plugin-googlesheets/labels/help%20wanted) diff --git a/docs/LICENSE b/docs/LICENSE new file mode 100644 index 0000000..236ac28 --- /dev/null +++ b/docs/LICENSE @@ -0,0 +1,402 @@ +Attribution-NonCommercial-NoDerivatives 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 +International Public License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-NonCommercial-NoDerivatives 4.0 International Public +License ("Public License"). To the extent this Public License may be +interpreted as a contract, You are granted the Licensed Rights in +consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the +Licensor receives from making the Licensed Material available under +these terms and conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + c. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + d. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + e. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + f. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + g. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + h. NonCommercial means not primarily intended for or directed towards + commercial advantage or monetary compensation. For purposes of + this Public License, the exchange of the Licensed Material for + other material subject to Copyright and Similar Rights by digital + file-sharing or similar means is NonCommercial provided there is + no payment of monetary compensation in connection with the + exchange. + + i. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + k. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part, for NonCommercial purposes only; and + + b. produce and reproduce, but not Share, Adapted Material + for NonCommercial purposes only. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties, including when + the Licensed Material is used other than for NonCommercial + purposes. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material, You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + For the avoidance of doubt, You do not have permission under + this Public License to Share Adapted Material. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database for NonCommercial purposes + only and provided You do not Share Adapted Material; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index b9947c4..e5ad91a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,13 +8,14 @@ short_name: "googlesheets" description: "Steampipe plugin for query data from Google Sheets." og_description: "Query Google Sheets with SQL! Open source CLI. No DB required." og_image: "/images/plugins/turbot/googlesheets-social-graphic.png" +engines: ["steampipe", "sqlite", "postgres", "export"] --- # Google Sheets + Steampipe [Google Sheets](https://www.google.com/sheets/about) is an online spreadsheet app that lets you create and format spreadsheets and work with other people. -[Steampipe](https://steampipe.io) is an open source CLI to instantly query cloud APIs using SQL. +[Steampipe](https://steampipe.io) is an open-source zero-ETL engine to instantly query cloud APIs using SQL. Query all the sheets in your spreadsheet: @@ -199,11 +200,6 @@ spreadsheet, which is a public spreadsheet maintained by the Steampipe team. All of our examples in this document, and in our table documents, are based on this sample spreadsheet. -## Get involved - -- Open source: https://github.com/turbot/steampipe-plugin-googlesheets -- Community: [Join #steampipe on Slack →](https://turbot.com/community/join) - ## Advanced configuration options ### Authenticate using OAuth client diff --git a/docs/tables/googlesheets_cell.md b/docs/tables/googlesheets_cell.md index 803c4b8..4ff67a1 100644 --- a/docs/tables/googlesheets_cell.md +++ b/docs/tables/googlesheets_cell.md @@ -1,7 +1,15 @@ -# Table: googlesheets_cell +--- +title: "Steampipe Table: googlesheets_cell - Query Google Sheets Cells using SQL" +description: "Allows users to query Google Sheets Cells, providing detailed information about each cell in a Google Sheet." +--- -Query cell data from sheets in a Google Sheets spreadsheet. Cells that have no -data, i.e., no value or formula, will not be returned. +# Table: googlesheets_cell - Query Google Sheets Cells using SQL + +Google Sheets is a web-based spreadsheet program that is part of Google's office suite of web applications. It allows users to create, update, and modify spreadsheets and share the data live online. The cells in Google Sheets are the smallest and most basic unit of a spreadsheet, storing individual data points that can be manipulated and analyzed. + +## Table Usage Guide + +The `googlesheets_cell` table offers insights into the data points stored in the cells of a Google Sheet. As a data analyst or data scientist, you can dig into cell-specific details using this table, including the cell's value, format, and associated metadata. Use it to extract and analyze data from Google Sheets, such as cell values, formulas, and formatting details, to facilitate data analysis and reporting. All examples below can be used with the [Google Sheets Plugin - Sample School Data](https://docs.google.com/spreadsheets/d/11iXfj-RHpFsil7_hNK-oQjCqmBLlDfCvju2AOF-ieb4) @@ -10,21 +18,32 @@ spreadsheet, which is a public spreadsheet maintained by the Steampipe team. ## Examples ### Query cells in all sheets +Explore the content of all your Google Sheets by identifying the specific cell and its corresponding value. This can be useful for auditing data or tracking changes across multiple spreadsheets. -```sql +```sql+postgres select sheet_name, cell, value from - googlesheets_cell + googlesheets_cell; ``` -### Query cells in a specific sheet +```sql+sqlite +select + sheet_name, + cell, + value +from + googlesheets_cell; +``` +### Query cells in a specific sheet +Explore which cells in a specific Google Sheets document contain certain values. This is useful for quickly finding and analyzing data in large spreadsheets, such as a list of students. You can query all cells from a specific sheet using the `sheet_name` column: -```sql + +```sql+postgres select sheet_name, cell, @@ -35,11 +54,23 @@ where sheet_name = 'Students'; ``` -### Query a range of cells +```sql+sqlite +select + sheet_name, + cell, + value +from + googlesheets_cell +where + sheet_name = 'Students'; +``` +### Query a range of cells +Explore which values are stored in a specific range of cells in a Google Sheets document. This can be useful for understanding the content and organization of your data without having to manually search through the sheet. Using the [A1 notation](https://developers.google.com/sheets/api/guides/concepts#expandable-1), you can query specific cells using the `range` column: -```sql + +```sql+postgres select sheet_name, cell, @@ -50,11 +81,36 @@ where range = 'Students!B1:C2'; ``` -### Query a specific cell +```sql+sqlite +select + sheet_name, + cell, + value +from + googlesheets_cell +where + range = 'Students!B1:C2'; +``` +### Query a specific cell +This example illustrates how you can pinpoint specific information within a Google Sheets document. It's particularly useful when you need to quickly access a particular cell's value within a larger spreadsheet, such as a student's information in an educational setting. You can query a specific cell with the `sheet_name`, `row`, and `col` columns: -```sql + +```sql+postgres +select + sheet_name, + cell, + value +from + googlesheets_cell +where + sheet_name = 'Students' + and row = 2 + and col = 'A'; +``` + +```sql+sqlite select sheet_name, cell, @@ -69,7 +125,7 @@ where Or you can use [A1 notation](https://developers.google.com/sheets/api/guides/concepts#expandable-1) with the `range` column: -```sql +```sql+postgres select sheet_name, cell, @@ -80,11 +136,35 @@ where range = 'Students!A2'; ``` -### Query cells in a row +```sql+sqlite +select + sheet_name, + cell, + value +from + googlesheets_cell +where + range = 'Students!A2'; +``` +### Query cells in a row +Determine the content of specific cells within a Google Sheets document. This is useful for quickly accessing and understanding key data without having to manually search through the entire document. Similar to the examples above, you can also query a specific row using the `sheet_name` and `row` columns: -```sql + +```sql+postgres +select + sheet_name, + cell, + value +from + googlesheets_cell +where + sheet_name = 'Students' + and row = 1; +``` + +```sql+sqlite select sheet_name, cell, @@ -98,7 +178,7 @@ where Or by using [A1 notation](https://developers.google.com/sheets/api/guides/concepts#expandable-1) with the `range` column: -```sql +```sql+postgres select sheet_name, cell, @@ -109,11 +189,35 @@ where range = 'Students!1:1'; ``` -### Query cells in a column +```sql+sqlite +select + sheet_name, + cell, + value +from + googlesheets_cell +where + range = 'Students!1:1'; +``` +### Query cells in a column +Determine the areas in which specific data is stored in a Google Sheets document. This is useful in scenarios where you need to identify and analyze the information contained in a particular column of a specific sheet, such as a list of student names. Specific columns can also be queried using the `sheet_name` and `col` columns: -```sql + +```sql+postgres +select + sheet_name, + cell, + value +from + googlesheets_cell +where + sheet_name = 'Students' + and col = 'A'; +``` + +```sql+sqlite select sheet_name, cell, @@ -127,7 +231,18 @@ where Or with [A1 notation](https://developers.google.com/sheets/api/guides/concepts#expandable-1) and the `range` column: -```sql +```sql+postgres +select + sheet_name, + cell, + value +from + googlesheets_cell +where + range = 'Students!A:A'; +``` + +```sql+sqlite select sheet_name, cell, @@ -139,8 +254,22 @@ where ``` ### List cells with hyperlink information +Identify instances where cells contain hyperlinks in a Google Sheets document, specifically within the 'Students' sheet. This could be useful for quickly locating linked resources or references within a large dataset. + +```sql+postgres +select + sheet_name, + cell, + value, + hyperlink +from + googlesheets_cell +where + sheet_name = 'Students' + and hyperlink is not null; +``` -```sql +```sql+sqlite select sheet_name, cell, @@ -154,8 +283,22 @@ where ``` ### List cells with a formula +Explore which cells within the 'Employees' sheet contain a formula. This can be useful for identifying calculations or automated data within your spreadsheet. + +```sql+postgres +select + sheet_name, + cell, + value, + formula +from + googlesheets_cell +where + sheet_name = 'Employees' + and formula is not null; +``` -```sql +```sql+sqlite select sheet_name, cell, @@ -169,8 +312,23 @@ where ``` ### List cells with formula parse errors +Discover the segments that contain formula parsing errors within your Google Sheets. This is particularly useful for identifying and rectifying any errors in your data calculations, ensuring the accuracy and integrity of your data. -```sql +```sql+postgres +select + sheet_name, + cell, + value, + formula +from + googlesheets_cell +where + sheet_name = 'Employees' + and formula is not null + and value in ('#N/A', '#DIV/0!', '#VALUE!', '#REF!', '#NAME?', '#NUM!', '#ERROR!', '#NULL!'); +``` + +```sql+sqlite select sheet_name, cell, @@ -187,10 +345,11 @@ where ## Advanced examples ### Query cells in a specific sheet using `range` - +Explore the specific content within a Google Sheets document by targeting a particular sheet, in this case 'Students'. This is useful for extracting and analyzing data from a specific part of your Google Sheets document without having to sift through irrelevant information. In [A1 notation](https://developers.google.com/sheets/api/guides/concepts#expandable-1), just the sheet name can be passed in as the `range` to return all cells from that sheet: -```sql + +```sql+postgres select sheet_name, cell, @@ -201,13 +360,25 @@ where range = 'Students'; ``` -### Query cells using [R1C1 notation](https://developers.google.com/sheets/api/guides/concepts#expandable-2) +```sql+sqlite +select + sheet_name, + cell, + value +from + googlesheets_cell +where + range = 'Students'; +``` +### Query cells using [R1C1 notation](https://developers.google.com/sheets/api/guides/concepts#expandable-2) +Explore the values of specific cells in a Google Sheets document, specifically targeting the 'Students' sheet. This is useful for analyzing data within a specified range, such as identifying student information in the first column. In addition to [A1 notation](https://developers.google.com/sheets/api/guides/concepts#expandable-1), the `range` column also supports [R1C1 notation](https://developers.google.com/sheets/api/guides/concepts#expandable-2). For instance, to get the first five cells in the first column: -```sql + +```sql+postgres select sheet_name, cell, @@ -217,3 +388,14 @@ from where range = 'Students!R1C1:R5C1'; ``` + +```sql+sqlite +select + sheet_name, + cell, + value +from + googlesheets_cell +where + range = 'Students!R1C1:R5C1'; +``` \ No newline at end of file diff --git a/docs/tables/googlesheets_sheet.md b/docs/tables/googlesheets_sheet.md index 27cefe2..7df4d1d 100644 --- a/docs/tables/googlesheets_sheet.md +++ b/docs/tables/googlesheets_sheet.md @@ -1,12 +1,31 @@ -# Table: googlesheets_sheet +--- +title: "Steampipe Table: googlesheets_sheet - Query Google Sheets Sheets using SQL" +description: "Allows users to query Sheets in Google Sheets, specifically the metadata and content of each sheet, providing insights into the structure of Google Sheets documents." +--- -Retrieves information of a sheet in the given spreadsheet. +# Table: googlesheets_sheet - Query Google Sheets Sheets using SQL + +Google Sheets is a web-based application that allows users to create, update and modify spreadsheets and share the data live online. The Sheets within Google Sheets are individual tabs of a document, where data is input and organized. Each sheet contains cells, and the data within these cells can be manipulated using formulas, functions, and data validation rules. + +## Table Usage Guide + +The `googlesheets_sheet` table provides insights into Sheets within Google Sheets. As a data analyst, explore sheet-specific details through this table, including metadata, content, and associated cell data. Utilize it to uncover information about sheets, such as their structure, the data they contain, and the relationships between different data points. ## Examples ### Basic info +Explore which Google Sheets are available in your account and their respective identifiers. This can be beneficial for managing and tracking your documents systematically. + +```sql+postgres +select + title, + sheet_id, + spreadsheet_id +from + googlesheets_sheet; +``` -```sql +```sql+sqlite select title, sheet_id, @@ -16,8 +35,22 @@ from ``` ### Get information about a specific sheet +Explore which Google Sheets contain specific information by identifying instances where the title matches a certain term. This allows you to quickly locate and analyze data within a vast collection of spreadsheets. + +```sql+postgres +select + title, + sheet_id, + spreadsheet_id, + hidden, + sheet_type +from + googlesheets_sheet +where + title = 'Students'; +``` -```sql +```sql+sqlite select title, sheet_id, @@ -31,8 +64,9 @@ where ``` ### List hidden sheets +Uncover the details of hidden sheets within your Google Sheets. This query is useful for identifying which sheets are hidden, allowing you to better manage and organize your data. -```sql +```sql+postgres select title, sheet_id, @@ -45,9 +79,23 @@ where hidden; ``` +```sql+sqlite +select + title, + sheet_id, + spreadsheet_id, + hidden, + sheet_type +from + googlesheets_sheet +where + hidden = 1; +``` + ### List sheets with protected ranges +Explore which Google Sheets contain protected ranges. This can be useful to identify instances where data is safeguarded, helping to maintain data integrity and control access. -```sql +```sql+postgres select title, sheet_id, @@ -58,3 +106,15 @@ from where protected_ranges is not null; ``` + +```sql+sqlite +select + title, + sheet_id, + spreadsheet_id, + protected_ranges +from + googlesheets_sheet +where + protected_ranges is not null; +``` \ No newline at end of file diff --git a/docs/tables/googlesheets_spreadsheet.md b/docs/tables/googlesheets_spreadsheet.md index c790e4e..cf516ca 100644 --- a/docs/tables/googlesheets_spreadsheet.md +++ b/docs/tables/googlesheets_spreadsheet.md @@ -1,12 +1,34 @@ -# Table: googlesheets_spreadsheet +--- +title: "Steampipe Table: googlesheets_spreadsheet - Query Google Sheets Spreadsheets using SQL" +description: "Allows users to query Google Sheets Spreadsheets, specifically extracting data from spreadsheets, including metadata, content, and sharing permissions." +--- -Retrieves information of the given spreadsheet. +# Table: googlesheets_spreadsheet - Query Google Sheets Spreadsheets using SQL + +Google Sheets is a web-based application that allows users to create, update, and modify spreadsheets and share the data live online. The service is part of the Google Suite of applications and is designed to be a free, web-based alternative to traditional spreadsheet software such as Microsoft Excel. Google Sheets allows multiple users to collaborate in real-time, providing a platform for data manipulation and analysis. + +## Table Usage Guide + +The `googlesheets_spreadsheet` table provides insights into the spreadsheets within Google Sheets. As a data analyst, explore spreadsheet-specific details through this table, including metadata, content, and sharing permissions. Utilize it to uncover information about spreadsheets, such as those shared with specific users, the content of the spreadsheets, and the metadata associated with each spreadsheet. ## Examples ### Basic info +Explore which Google Sheets spreadsheets have been recently modified, owned, shared, starred, or linked on the web. This can help in managing access and tracking changes to important documents. + +```sql+postgres +select + name, + modified_time, + owned_by_me, + shared, + starred, + web_view_link +from + googlesheets_spreadsheet; +``` -```sql +```sql+sqlite select name, modified_time, @@ -19,8 +41,9 @@ from ``` ### Get information about last modifying user +Explore which user last modified a Google Sheets spreadsheet and when the modification occurred. This can be useful for tracking changes and maintaining accountability in collaborative environments. -```sql +```sql+postgres select name as spreadsheet_name, last_modifying_user ->> 'displayName' as user_display_name, @@ -30,9 +53,20 @@ from googlesheets_spreadsheet; ``` +```sql+sqlite +select + name as spreadsheet_name, + json_extract(last_modifying_user, '$.displayName') as user_display_name, + json_extract(last_modifying_user, '$.emailAddress') as user_email_address, + modified_time +from + googlesheets_spreadsheet; +``` + ### Check if current user has capability to edit the spreadsheet +Explore the access rights of the current user to understand if they have the necessary permissions to edit a Google Sheets spreadsheet. This can be useful in managing user permissions and ensuring data integrity. -```sql +```sql+postgres select name as spreadsheet_name, web_view_link, @@ -44,9 +78,22 @@ from googlesheets_spreadsheet; ``` +```sql+sqlite +select + name as spreadsheet_name, + web_view_link, + case + when json_extract(capabilities, '$.canEdit') is null then 0 + else json_extract(capabilities, '$.canEdit') + end as can_edit +from + googlesheets_spreadsheet; +``` + ### Get sharing info with permissions +Explore the sharing details and permissions of your Google Sheets spreadsheets. This query can help you understand who has access to your documents, their roles, and whether they can discover files, providing a comprehensive view of your document's security. -```sql +```sql+postgres select name, permission ->> 'type' as grantee_type, @@ -59,3 +106,17 @@ from googlesheets_spreadsheet, jsonb_array_elements(permissions) as permission; ``` + +```sql+sqlite +select + name, + json_extract(permission.value, '$.type') as grantee_type, + json_extract(permission.value, '$.displayName') as grantee_display_name, + json_extract(permission.value, '$.emailAddress') as email_address, + json_extract(permission.value, '$.domain') as domain_address, + json_extract(permission.value, '$.role') as role, + json_extract(permission.value, '$.allowFileDiscovery') as allow_file_discovery +from + googlesheets_spreadsheet, + json_each(permissions) as permission; +``` \ No newline at end of file diff --git a/docs/tables/{sheet_name}.md b/docs/tables/{sheet_name}.md index f6b181a..a3fcde6 100644 --- a/docs/tables/{sheet_name}.md +++ b/docs/tables/{sheet_name}.md @@ -1,4 +1,15 @@ -# Table: {sheet_name} +--- +title: "Steampipe Table: {sheet_name} - Query Google Sheets using SQL" +description: "Allows users to query data within Google Sheets, providing insights into cell values, formulas, and formatting. It enables users to analyze and manipulate spreadsheet data using SQL." +--- + +# Table: {sheet_name} - Query Google Sheets using SQL + +Google Sheets is a web-based spreadsheet program that is part of Google's office software suite within Google Drive. Users can create, edit, and collaborate on spreadsheets online while also being able to preserve various data in cells, including text, numerical values, dates, and formulas. It provides features like real-time editing, chat, and commenting, making it a powerful tool for teams to collaborate and share data. + +## Table Usage Guide + +The `{sheet_name}` table provides insights into the data stored in Google Sheets. As a data analyst, you can explore cell-specific details through this table, including text, numerical values, dates, and formulas. Utilize it to uncover information about cells, such as their values, the formulas used in them, and their formatting, enabling you to analyze and manipulate spreadsheet data using SQL. Query cell data from sheets in a Google Sheets spreadsheet in CSV format. A table is automatically created to represent each sheet mentioned in the @@ -27,7 +38,14 @@ This plugin will create 4 tables: For the tables that were created, these can be queried directly: -```sql +```sql+postgres +select + * +from + "Students"; +``` + +```sql+sqlite select * from @@ -84,24 +102,33 @@ To get details for a specific table, inspect it by name: ``` ### Query a sheet - +Explore the complete data of all students. This can be useful for understanding the overall student demographics or for conducting broad analyses. Given the sheet `Students`, the query requires identifier quotes: -```sql + +```sql+postgres select * from "Students"; ``` -### Query specific columns +```sql+sqlite +select + * +from + "Students"; +``` +### Query specific columns +Explore which students are studying under which major, providing a quick overview of the student body's academic interests. Columns are always in text form when read from Google Sheets. The column names come from the first row of the sheet. If your column names are complex, use identifier quotes: -```sql + +```sql+postgres select "Student Name", "Major" @@ -109,11 +136,20 @@ from "Students"; ``` -### Casting column data for analysis +```sql+sqlite +select + "Student Name", + "Major" +from + "Students"; +``` +### Casting column data for analysis +The query is designed to analyze and transform book data for clearer understanding and further processing. It can be used to convert raw data into a more readable format, such as changing the issue date into a timestamp and verifying the authenticity of the books. Text columns can be easily cast to other types: -```sql + +```sql+postgres select "Name" as book_name, "Author" as author, @@ -126,6 +162,19 @@ from "Books"; ``` +```sql+sqlite +select + "Name" as book_name, + "Author" as author, + "Issued By" as issued_by, + case + when "Issue Date" <> '' then datetime("Issue Date") + end as issued_at, + "Verified" = 'true' as verified +from + "Books"; +``` + ## Table Restrictions and Notes - CSV tables will only be created for sheets that have data in cell `A1`. @@ -158,4 +207,4 @@ Running `.inspect "Employees"` then results in: | Joining Date | text | Field 8. | | Profile Image | text | Field 2. | +---------------+------+-------------+ -``` +``` \ No newline at end of file