Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/turbot/steampipe-postgres-fdw
The Steampipe foreign data wrapper (FDW) is a zero-ETL product that provides Postgres foreign tables which translate queries into API calls to cloud services and APIs. It's bundled with Steampipe and also available as a set of standalone extensions for use in your own Postgres database.
https://github.com/turbot/steampipe-postgres-fdw
aws azure data devsecops gcp golang hacktoberfest kubernetes postgres postgresql postgresql-fdw security sql steampipe steampipe-engine
Last synced: about 2 months ago
JSON representation
The Steampipe foreign data wrapper (FDW) is a zero-ETL product that provides Postgres foreign tables which translate queries into API calls to cloud services and APIs. It's bundled with Steampipe and also available as a set of standalone extensions for use in your own Postgres database.
- Host: GitHub
- URL: https://github.com/turbot/steampipe-postgres-fdw
- Owner: turbot
- License: apache-2.0
- Created: 2021-01-19T15:58:12.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T13:04:07.000Z (5 months ago)
- Last Synced: 2024-04-14T22:52:09.819Z (5 months ago)
- Topics: aws, azure, data, devsecops, gcp, golang, hacktoberfest, kubernetes, postgres, postgresql, postgresql-fdw, security, sql, steampipe, steampipe-engine
- Language: Go
- Homepage: https://steampipe.io/
- Size: 8.67 MB
- Stars: 61
- Watchers: 10
- Forks: 10
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - turbot/steampipe-postgres-fdw - Postgres FDW for Steampipe (hacktoberfest)
README
# Steampipe Postgres FDW
## Overview
The Steampipe Postgres Foreign Data Wrapper (FDW) is a Postgres extension that translates APIs to foreign tables. It does not directly interface with external systems, but instead relies on plugins to implement API- or provider-specific code that returns data in a standard format via gRPC. See the [Writing Plugins](https://steampipe.io/docs/develop/writing-plugins) guide to get started writing Steampipe plugins.
The FDW is part of the [Steampipe project](https://github.com/turbot/steampipe). Bundled with the Steampipe CLI, it works with one or more of the [plugins](https://hub.steampipe.io/plugins) you install in Steampipe. You can also [install](https://steampipe.io/docs/steampipe_postgres/install) one or more plugin-specific extensions in your own instance of Postgres.
## Getting Started
To use the FDW with Steampipe, [download Steampipe](https://steampipe.io/downloads) and use it to install one or more plugins.
You can also use a standalone installer that enables you to choose a plugin and download the FDW for that plugin.
**[Installation guide →](https://steampipe.io/docs/steampipe_sqlite/install)**
## Developing
### Building the FDW for Steampipe
Make sure that you have the following installed in your system:
1. `Postgresql v14`
1. `go`
1. `gcc` for Linux
> For instructions on how to install PostgreSQL, please visit: https://www.postgresql.org/download/
>
> For instruction on how to install `golang`, please visit: https://go.dev/dl/
Steps:
1. Clone this repository onto your system
1. Change to the cloned directory
1. Run the following commands:
```
$ make
```
This will compile the FDW (`steampipe_postgres_fdw.so`) along with the `control` and `sql` file in the `build-$PLATFORM` directory. This will install the compiled FDW into the default Steampipe installation directory (`~/.steampipe`) - if it exists.
### Building the FDW as a standalone extension
To build the FDW for one particular plugin, and run it as a standalone extension in any PostgreSQL database without relying on Steampipe:
Make sure that you have the following installed in your system:
1. `Postgresql v14`
1. `go`
1. `gcc` for Linux
Steps:
1. Clone this repository onto your system
1. Change to the cloned directory
1. Run the following commands:
```
$ make standalone plugin=""
```
Replace plugin alias with the alias or short name of your plugin.
This command will compile the FDW specifically for the chosen plugin, and the resulting binary, control file, and SQL files will be generated.
#### Example
Suppose you want to build the FDW for a plugin with an alias `aws` from a GitHub repository located at https://github.com/turbot/steampipe-plugin-aws. You would run the following command:
```
$ make standalone plugin="aws"
```
## Open Source & Contributing
This repository is published under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license. 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 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).