steampipe plugin install pipes

Table: pipes_workspace - Query Pipes Workspaces using SQL

Workspaces provide a bounded context for managing, operating, and securing Steampipe resources. A workspace comprises a single Steampipe database instance as well as a directory of mod resources such as queries, benchmarks, and controls. Workspaces allow you to separate your Steampipe instances for security, operational, or organizational purposes.

Table Usage Guide

The pipes_workspace table provides insights into workspaces within Pipes. As a data engineer, explore workspace-specific details through this table, including creation time, last update time, and associated user information. Utilize it to uncover information about workspaces, such as their current status, the user who last updated them, and the time of the last update.

Examples

Basic info

Explore which workspaces are active and who is managing them. This is useful for auditing purposes and ensuring proper workspace allocation.

select
id,
state,
handle,
identity_handle
from
pipes_workspace;
select
id,
state,
handle,
identity_handle
from
pipes_workspace;

List user workspaces

Explore which workspaces are specifically associated with user identities. This can help in managing user-specific resources and understanding user activities within these workspaces.

select
id,
state,
handle,
identity_handle
from
pipes_workspace
where
identity_type = 'user';
select
id,
state,
handle,
identity_handle
from
pipes_workspace
where
identity_type = 'user';

List organization workspaces

Explore which workspaces are linked to your organization. This query is useful in understanding the overall structure and dependencies within your organization.

select
id,
state,
handle,
identity_handle
from
pipes_workspace
where
identity_type = 'org';
select
id,
state,
handle,
identity_handle
from
pipes_workspace
where
identity_type = 'org';

List workspaces which are not running

Assess the elements within your system to pinpoint specific workspaces that are not currently active. This can help in managing resources and ensuring efficient workspace utilization.

select
id,
state,
handle,
identity_handle
from
pipes_workspace
where
state <> 'running';
select
id,
state,
handle,
identity_handle
from
pipes_workspace
where
state <> 'running';

Schema for pipes_workspace

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form.
api_versiontextThe API version for the workspace.
cli_versiontextThe CLI version for the workspace.
created_attimestamp with time zoneThe time when the workspace was created.
created_byjsonbInformation about the user who created the workspace.
created_by_idtextThe unique identifier of the user who created the workspace.
database_nametextThe database name for the workspace.
handletext=The handle name for the workspace.
hivetextThe database hive for this workspace.
hosttextThe host for this workspace.
idtextThe unique identifier for the workspace.
identity_handletext=The handle name for an identity where the workspace has been created.
identity_idtext=The unique identifier for an identity where the workspace has been created.
identity_typetextThe type of identity, which can be 'user' or 'org'.
sp_connection_nametext=, !=, ~~, ~~*, !~~, !~~*Steampipe connection name.
sp_ctxjsonbSteampipe context in JSON form.
statetextThe current workspace state.
updated_attimestamp with time zoneThe time when the workspace was last updated.
updated_byjsonbInformation about the user who last updated the workspace.
updated_by_idtextThe unique identifier of the user who last updated the workspace.
user_idtext=, !=, ~~, ~~*, !~~, !~~*The unique identifier for the user.
version_idbigintThe current version ID of the workspace record.

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_workspace