Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
judell committed Dec 21, 2023
1 parent 86ca37e commit de16714
Showing 1 changed file with 23 additions and 20 deletions.
43 changes: 23 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,43 @@
![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:

```shell
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:
Expand All @@ -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:
Expand All @@ -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:
Expand All @@ -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)

0 comments on commit de16714

Please sign in to comment.