Table: pipes_workspace_mod - Query Pipes Workspace Modules using SQL

Pipes Workspace Modules are components of the Pipes service that allow users to manage and configure their data pipelines. Each module in a workspace contains specific configurations, versions, and dependencies, which are crucial for the proper functioning and management of data pipelines.

A Steampipe mod is a portable, versioned collection of related Steampipe resources such as dashboards, benchmarks, queries, and controls. Steampipe mods and mod resources are defined in HCL, and distributed as simple text files. Modules can be found on the Steampipe Hub, and may be shared with others from any public git repository.

Table Usage Guide

The pipes_workspace_mod table provides insights into the Workspace Modules within Pipes. As a Data Engineer, explore module-specific details through this table, including configurations, versions, and dependencies. Utilize it to uncover information about each module, such as its configuration details, the version it is running, and the dependencies it has on other modules.

Examples

Basic information about mods across all workspaces

Explore the status and details of modifications across all workspaces. This allows for efficient management and oversight of workspace modifications, including their current versions and state.

select
  id,
  path,
  alias,
  constraint,
  installed_version,
  state
from
  pipes_workspace_mod;

select
  id,
  path,
  alias,
  constraint,
  installed_version,
  state
from
  pipes_workspace_mod;

List mods for all workspaces of the user

Explore which modifications have been made across all of a user's workspaces. This can help in understanding the state of each workspace, including any constraints or version changes that have been applied.

select
  id,
  path,
  alias,
  constraint,
  installed_version,
  state
from
  pipes_workspace_mod
where
  identity_type = 'user';

select
  id,
  path,
  alias,
  constraint,
  installed_version,
  state
from
  pipes_workspace_mod
where
  identity_type = 'user';

List mods for all workspaces belonging to all organizations that the user is a member of

Explore which modifications are installed in all workspaces across organizations you're a member of. This can help assess the elements within each workspace and ensure they are up to date and functioning as expected.

select
  id,
  path,
  alias,
  constraint,
  installed_version,
  state
from
  pipes_workspace_mod
where
  identity_type = 'org';

select
  id,
  path,
  alias,
  constraint,
  installed_version,
  state
from
  pipes_workspace_mod
where
  identity_type = 'org';

List mods for a particular workspace belonging to an organization

Analyze the modifications made to a specific workspace within an organization to understand the current state, version, and constraints of those modifications. This is useful for managing and understanding the workspace's configuration and its impact on the organization's operations.

select
  swm.id,
  swm.path,
  swm.alias,
  swm.constraint,
  swm.installed_version,
  swm.state
from
  pipes_workspace_mod as swm
  inner join pipes_organization as so on so.id = swm.identity_id
  inner join pipes_workspace as sw on sw.id = swm.workspace_id
where
  so.handle = 'testorg'
  and sw.handle = 'dev';

select
  swm.id,
  swm.path,
  swm.alias,
  swm.constraint,
  swm.installed_version,
  swm.state
from
  pipes_workspace_mod as swm
  join pipes_organization as so on so.id = swm.identity_id
  join pipes_workspace as sw on sw.id = swm.workspace_id
where
  so.handle = 'testorg'
  and sw.handle = 'dev';

Schema for pipes_workspace_mod

Name	Type	Operators	Description
_ctx	jsonb		Steampipe context in JSON form, e.g. connection_name.
alias	text	=	Short name used to identify the mod.
constraint	text		Version constraint for the mod.
created_at	timestamp with time zone		The time when the mod was installed.
created_by	jsonb		Information about the user who installed the mod.
created_by_id	text		The unique identifier of the user who installed the mod.
details	text		Extra stored details about the mod.
id	text		The unique identifier for the workspace mod.
identity_handle	text		The handle of the identity which contains the workspace.
identity_id	text	=	The unique identifier for the identity which contains the workspace.
identity_type	text		The type of identity, which can be 'user' or 'org'.
installed_version	text		Version of the mod installed.
path	text		Full path name for the mod.
state	text		State of the mod. Can be one of 'installing', 'installed' or 'error'.
updated_at	timestamp with time zone		The time when the mod was last updated.
updated_by	jsonb		Information about the user who last updated the mod.
updated_by_id	text		The unique identifier of the user who last updated the mod.
version_id	bigint		The current version ID of the mod record.
workspace_handle	text		The handle for the workspace.
workspace_id	text	=	The unique identifier for the workspace.

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_mod