Steampipe

The Steampipe plugin is used to query Steampipe components, such as the available plugins in the Steampipe hub.

Steampipe is an open-source zero-ETL engine to instantly query cloud APIs using SQL.

This plugin currently requires no authentication as it only queries public endpoints.

For example:

select
  name,
  update_time
from
  steampipe_registry_plugin

+--------------------+---------------------+
| name               | update_time         |
+--------------------+---------------------+
| turbot/alicloud    | 2021-09-13 16:18:49 |
| theapsgroup/gitlab | 2021-09-16 12:22:14 |
| turbot/aws         | 2021-10-12 12:45:35 |
| turbot/jira        | 2021-09-22 18:59:46 |
| turbot/steampipe   | 2021-07-22 20:36:14 |
+--------------------+---------------------+

Documentation

Table definitions & examples →

Get started

Install

Download and install the latest Steampipe plugin:

steampipe plugin install steampipe

Credentials

Item	Description
Credentials	No creds required
Permissions	n/a
Radius	Steampipe automatically connects to the Steampipe registry
Resolution	n/a

Configuration

No configuration is needed. Installing the latest steampipe plugin will create a config file (~/.steampipe/config/steampipe.spc) with a single connection named steampipe:

connection "steampipe" {
  plugin = "steampipe"
}

Get Involved

Open source: https://github.com/turbot/steampipe-plugin-steampipe
Community: Join #steampipe on Slack →

Postgres FDW

This plugin is available as a native Postgres FDW. Unlike Steampipe CLI, which ships with an embedded Postgres server instance, the Postgres FDW can be installed in any supported Postgres database version.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_postgres_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/postgres.sh)" -- steampipe

The installer will prompt you for the plugin name and version, download and install the appropriate files for your OS, system architecture, and Postgres version.

To configure the Postgres FDW, you will create an extension, foreign server, and schema and import the foreign schema.

CREATE EXTENSION IF NOT EXISTS steampipe_postgres_steampipe;
CREATE SERVER steampipe_steampipe FOREIGN DATA WRAPPER steampipe_postgres_steampipe OPTIONS (config '<your_config>');
CREATE SCHEMA steampipe;
IMPORT FOREIGN SCHEMA steampipe FROM SERVER steampipe_steampipe INTO steampipe;

SQLite Extension

This plugin is available as a SQLite Extension, making the tables available as SQLite virtual tables.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_sqlite_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/sqlite.sh)" -- steampipe

The installer will prompt you for the plugin name, version, and destination directory. It will then determine the OS and system architecture, and it will download and install the appropriate package.

To configure the SQLite extension, load the extension module and then run the steampipe_configure_steampipe function to configure it with plugin-specific options.

$ sqlite3
sqlite> .load ./steampipe_sqlite_extension_steampipe.so
sqlite> select steampipe_configure_steampipe('<your_config>');

Export

This plugin is available as a standalone Export CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- steampipe

You can pass the configuration to the command with the --config argument:

steampipe_export_steampipe --config '<your_config>' <table_name>