From de16714a734a83f31ba7d9e963caae9a05c38d3f Mon Sep 17 00:00:00 2001 From: Jon Udell Date: Wed, 20 Dec 2023 20:36:13 -0800 Subject: [PATCH] update README --- README.md | 43 +++++++++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 590e446..de35fed 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,23 @@ -![image](https://hub.steampipe.io/images/plugins/turbot/csv-social-graphic.png) +![image](https://hub.steampipe.io/images/plugins/turbot/odbc-social-graphic.png) -# CSV Plugin for Steampipe +# ODBC Plugin for Steampipe -Use SQL to query data from CSV files. +Use SQL to query data from ODBC data sources. -- **[Get started →](https://hub.steampipe.io/plugins/turbot/csv)** -- Documentation: [Table definitions & examples](https://hub.steampipe.io/plugins/turbot/csv/tables) +- **[Get started →](https://hub.steampipe.io/plugins/turbot/odbc)** +- Documentation: [Table definitions & examples](https://hub.steampipe.io/plugins/turbot/odbc/tables) - Community: [Slack Channel](https://steampipe.io/community/join) -- Get involved: [Issues](https://github.com/turbot/steampipe-plugin-csv/issues) +- Get involved: [Issues](https://github.com/turbot/steampipe-plugin-odbc/issues) ## Quick start Install the plugin with [Steampipe](https://steampipe.io): ```shell -steampipe plugin install csv +steampipe plugin install odbc ``` -Configure your [config file](https://hub.steampipe.io/plugins/turbot/csv#configuration) to include directories with CSV files. If no directory is specified, the current working directory will be used. +[Configure](https://hub.steampipe.io/plugins/turbot/odbc#configuration) the data source names that you'll query. Run steampipe: @@ -25,16 +25,19 @@ Run steampipe: steampipe query ``` -Run a query for the `my_users.csv` file: +Count names: ```sql -select - first_name, - last_name -from - my_users; +select count(*) from postgresql_names; ``` +Find a name by number: + +```sql +select name from sqlite_names where number = 1; +``` + + ## Developing Prerequisites: @@ -45,8 +48,8 @@ Prerequisites: Clone: ```sh -git clone https://github.com/turbot/steampipe-plugin-csv.git -cd steampipe-plugin-csv +git clone https://github.com/turbot/steampipe-plugin-odbc.git +cd steampipe-plugin-odbc ``` Build, which automatically installs the new version to your `~/.steampipe/plugins` directory: @@ -59,14 +62,14 @@ Configure the plugin: ``` cp config/* ~/.steampipe/config -vi ~/.steampipe/config/csv.spc +vi ~/.steampipe/config/odbc.spc ``` Try it! ``` steampipe query -> .inspect csv +> .inspect odbc ``` Further reading: @@ -76,9 +79,9 @@ Further reading: ## Contributing -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-csv/blob/main/LICENSE). +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-odbc/blob/main/LICENSE). `help wanted` issues: - [Steampipe](https://github.com/turbot/steampipe/labels/help%20wanted) -- [CSV Plugin](https://github.com/turbot/steampipe-plugin-csv/labels/help%20wanted) +- [ODBC Plugin](https://github.com/turbot/steampipe-plugin-odbc/labels/help%20wanted)