Table: pipes_connection - Query Pipes Connections using SQL

Pipes is a service within Steampipe that allows you to create and manage connections between different plugins. It provides a unified interface to set up and manage connections for various plugins, including AWS, Azure, GCP, and more. Pipes help you stay informed about the health and status of your connections and take appropriate actions when predefined conditions are met.

Table Usage Guide

The pipes_connection table provides insights into the connections within Steampipe's Pipes service. As a DevOps engineer, explore connection-specific details through this table, including connection status, configuration, and associated metadata. Utilize it to uncover information about connections, such as those with specific configurations, the health status of connections, and the verification of connection configurations.

Examples

Basic info

Explore which plugins are connected to your system and identify any associated handles. This can help you manage your system's connections more effectively.

select
  id,
  plugin,
  handle,
  identity_handle
from
  pipes_connection;

select
  id,
  plugin,
  handle,
  identity_handle
from
  pipes_connection;

List connections using AWS plugin

Determine the areas in which AWS plugin is being used for connections. This is useful to understand and manage the distribution and usage of plugins across your connections.

select
  id,
  plugin,
  handle,
  jsonb_pretty(config) as config,
  identity_handle
from
  pipes_connection
where
  plugin = 'aws';

select
  id,
  plugin,
  handle,
  config,
  identity_handle
from
  pipes_connection
where
  plugin = 'aws';

List user connections

Explore which user connections are currently active. This is useful for understanding user engagement and tracking resource usage.

select
  id,
  plugin,
  handle,
  jsonb_pretty(config) as config,
  identity_handle
from
  pipes_connection
where
  identity_type = 'user';

select
  id,
  plugin,
  handle,
  config,
  identity_handle
from
  pipes_connection
where
  identity_type = 'user';

List organization workspaces

Review the configuration of your organization's workspaces to understand the plugins in use and their respective settings. This can help in assessing the elements within your organization's setup and identify areas for optimization or troubleshooting.

select
  id,
  plugin,
  handle,
  jsonb_pretty(config) as config,
  identity_handle
from
  pipes_connection
where
  identity_type = 'org';

select
  id,
  plugin,
  handle,
  config,
  identity_handle
from
  pipes_connection
where
  identity_type = 'org';

Schema for pipes_connection

Name	Type	Operators	Description
_ctx	jsonb		Steampipe context in JSON form.
config	jsonb		The connection config details.
created_at	timestamp with time zone		The connection created time.
created_by	jsonb		Information about the user who created the connection.
created_by_id	text		The unique identifier of the user who created the connection.
handle	text	=	The handle name for the connection.
id	text		The unique identifier for the connection.
identity_handle	text	=	The handle name for an identity where the connection has been created.
identity_id	text	=	The unique identifier for an identity where the connection has been created.
identity_type	text		The type of identity, which can be 'user' or 'org'.
plugin	text		The plugin name for the connection.
sp_connection_name	text	=, !=, ~~, ~~, !~~, !~~	Steampipe connection name.
sp_ctx	jsonb		Steampipe context in JSON form.
type	text		The connection type.
updated_at	timestamp with time zone		The connection's updated time.
updated_by	jsonb		Information about the user who last updated the connection.
updated_by_id	text		The unique identifier of the user who last updated the connection.
user_id	text	=, !=, ~~, ~~, !~~, !~~	The unique identifier for the user.
version_id	bigint		The version ID for the connection.

Export

This table is available as a standalone Exporter 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)" -- pipes

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

steampipe_export_pipes --config '<your_config>' pipes_connection