Connections

Before you can use Steampipe, you need to add one or more connections and add its schema to the database.

In Steampipe, a connection represents a set of tables for a single data source. In order to query data, you'll need at least one connection, as the other schema types depend on connections to provide credentials and other configuration information. Connections may defined at the workspace level, or they may be created and shared by a tenant or organization and then attached to workspaces.

Adding a Connection Schema

You may create a connection at the tenant, organization, or workspace level, but you can only add the schema to Steampipe at the workspace level.

To add a schema for an existing connection, navigate to your workspace and then to the Connections tab. Find the schema that you wish to add and click Add to Schema.

To add schemas for all connections in a folder, navigate to your workspace and then to the Connections tab. Find the folder whose schemas you wish to add and click Add to Schema.

You can also create new connections for your workspace from the Connections tab. When creating a new connection, you can choose to Add to Steampipe schema automatically during creation to create the connection and add the schema in a single step.

Removing a Connection Schema

To remove a schema, navigate to your workspace and then to the Connections tab. Find the schema or folder that you wish to remove and click Remove from Schema. Note that if a connection schema was added indirectly by adding the parent folder, you cannot remove the connection schema individually; you must remove the folder.