# Steampipe

> sidebar_label: Coding Standards

## Pages

- [Coding Standards](develop-coding-standards.md): Code should be formatted with gofmt...
- [Developers](develop-overview.md): Steampipe uses a Postgres Foreign Data Wrapper to present data from external systems and services as database tables....
- [Plugin Release Checklist](develop-plugin-release-checklist.md): As of June 2025, we've absorbed 149+ plugins into the Hub. If you want to contribute one -- and we hope you do! -- he...
- [Table & Column Standards](develop-standards.md): - Use snake_case for all table and column names.
- [Table Documentation Standards](develop-table-docs-standards.md): Creating table documentation is an important part of developing tables, as each
- [Using AI for Plugin Development](develop-using-ai-for-plugin-development.md): Creating new tables for Steampipe plugins with AI tools and IDEs works remarkably well. At Turbot, we develop plugin ...
- [Writing Example Queries](develop-writing-example-queries.md): To help you get started on creating useful example queries, we've compiled a
- [Writing Plugins](develop-writing-plugins.md): The Steampipe Plug...
- [Writing Your First Table](develop-writing-your-first-table.md): The <a href="
- [Dynamic Tables](develop-writing-plugins-dynamic-tables.md): In the plugin definition, if`SchemaMode`is set to`dynamic`, every time
- [Hydrate Functions](develop-writing-plugins-hydrate-functions.md): A hydrate function connects to an external system or service and gathers data to fill a database table.
- [Implementing Tables](develop-writing-plugins-implementing-tables.md): By convention, each table should be implemented in a separate file named`table_{table name}.go`. Each table will ha...
- [Writing Plugins](develop-writing-plugins-overview.md): The Steampipe Plug...
- [SQL Operators as API Filters](develop-writing-plugins-sql-to-api-call.md): When you write SQL that resolves to API calls, you want a SQL operator like`>`to influence an API call in the expec...
- [The Basics](develop-writing-plugins-the-basics.md): The`main`function in then`main.go`is the entry point for your plugin. This function must call`plugin.Serve`fro...
- [Transform Functions](develop-writing-plugins-transform-functions.md): Transform functions are used to extract and/or reformat data returned by a hydrate function into the desired type/for...
- [Distributions](distributions-overview.md): Steampipe provides zero-ETL tools for fetching data directly from APIs and services. Steampipe is offered in several...
- [FAQ](faq-overview.md): | Topic |
- [Best Practices with AWS Organizations](guides-aws-orgs.md): There are some considerations when querying hundreds of accounts across all the regions. Steampipe has to have both a...
- [Users Guide to Steampipe Caching](guides-caching.md): Caching is an essential part of the Steampipe experience and is enabled by default. While caching is important in any...
- [Using Key Column Qualifiers](guides-key-columns.md): Like any relational database table, a Steampipe table is composed of one or more columns, each with a name and data t...
- [Users Guide to Concurrency & Rate Limiting](guides-limiter.md): Steampipe is designed to be fast. It provides parallel execution at multiple layers:
- [Guides](guides-overview.md): Guides provide expanded explanations for common cases.
- [Using search_path to target connections and aggregators](guides-search-path.md): You are probably here for one of the following reasons:
- [Using Steampipe in AWS Cloud Shell](integrations-aws-cloudshell.md): [AWS CloudShell](https://aws.amazon.com/cloudshell/) is a free service that spins up a terminal right in your AWS acc...
- [Using Steampipe in Azure Cloud Shell](integrations-azure-cloudshell.md): [Azure Cloud Shell](https://shell.azure.com/) is a browser-based shell preloaded with tools to create and manage your...
- [Using Steampipe in CircleCI](integrations-circleci.md): CircleCI provides a [hosted environment](https://circleci.com/) in which you can build, test, and deploy software. It...
- [Using Steampipe in AWS Cloud9](integrations-cloud9.md): [AWS Cloud9](https://aws.amazon.com/cloud9/) is a cloud-based IDE integrated with a code editor, debugger, and termin...
- [Using Steampipe in Google Cloud Shell](integrations-gcp-cloudshell.md): Google Cloud Shell is a web-based environment preloaded with tools for managing Google Cloud.
- [Authenticate to AWS with OIDC](integrations-github-actions-aws-oidc.md): If you run Steampipe in a [GitHub Action](https://steampipe.io/docs/integrations/github_actions/installing_steampipe)...
- [Installing Steampipe in GitHub Actions](integrations-github-actions-installing-steampipe.md): GitHub provides a [hosted environment](https://docs.github.com/en/actions/) in which you can build, test, and deploy ...
- [GitHub Actions](integrations-github-actions-overview.md): Steampipe brings powerful capabilities to your GitHub Actions pipelines.
- [Using Steampipe in a GitLab CI/CD Pipeline](integrations-gitlab-ci-cd.md): GitLab provides a [hosted environment](https://docs.gitlab.com/ee/ci/) in which you can build, test, and deploy softw...
- [Using Steampipe in Gitpod](integrations-gitpod.md): [Gitpod](https://www.gitpod.io/) is an open source platform provisioning ready-to-code developer environments that in...
- [Using Steampipe in Jenkins](integrations-jenkins.md): Jenkins provides a [hosted environment](https://www.jenkins.io/) in which you can build, test, and deploy software. T...
- [Integrations](integrations-overview.md): Steampipe is easy to install and run on your laptop or server, but is also simple to setup and run it from a variety ...
- [Learn Steampipe](learn.md): Steampipe provides zero-ETL tools for fetching data directly from APIs and services. Steampipe is offered in several...
- [Managing Connections](managing-connections.md): A Steampipe **connection** represents a set of tables for a single data source. Each connection is represented as a ...
- [Run Steampipe](managing-overview.md): Steampipe is simple to install and manage and does not require any special expertise to get started. You will need t...
- [Managing Plugins](managing-plugins.md): Steampipe provides an integrated, standardized SQL interface for querying various services, but it relies on **plugin...
- [Service Mode](managing-service.md): By default, when you run`steampipe query`, Steampipe will start the database if it is not already running. In this ...
- [Managing Workspaces](managing-workspaces.md): A Steampipe`workspace`is a "profile" that allows you to define a unified environment
- [Flowpipe](pipes-ecosystem-flowpipe.md): [Flowpipe](https://flowpipe.io/) is an automation and workflow engine designed for DevOps tasks. It allows you to def...
- [Pipes Ecosystem](pipes-ecosystem-overview.md): Steampipe is a part of a larger ecosystem of products that provide a flexible platform on which to build rich intelli...
- [Turbot Pipes](pipes-ecosystem-pipes.md): **[Turbot Pipes](/docs/steampipe-cloud)** is the only intelligence, automation & security platform built specifically...
- [Powerpipe](pipes-ecosystem-powerpipe.md): [Powerpipe](https://powerpipe.io/) is an open-source platform designed for building and visualizing cloud infrastruct...
- [Batch Queries](query-batch-query.md): Steampipe queries can provide valuable insight into your cloud configuration, and the interactive client is a powerfu...
- [AI Tools (MCP)](query-mcp.md): The [Steampipe MCP server](https://github.com/turbot/steampipe-mcp) (Model Control Protocol) transforms how you inter...
- [Query Steampipe](query-overview.md): Steampipe is built on [PostgreSQL](https://www.postgresql.org/), and you can use [standard SQL syntax](https://www..o...
- [Interactive Queries](query-query-shell.md): Steampipe provides an interactive query shell that provides features like auto-complete, syntax highlighting, and com...
- [Snapshots](query-snapshots.md): Steampipe allows you to take **snapshots**. A snapshot is a saved view of your query results that you can view as a ...
- [It's Just Postgres!](query-third-party.md): Because Steampipe is built on Postgres, you can export your data, connect to the Steampipe database with 3rd party to...
- [steampipe completion](reference-cli-completion.md): Generate the autocompletion script for`steampipe`for supported shells. This helps you configure your terminal’s she...
- [steampipe help](reference-cli-help.md): Display help and usage information for any command in the application.
- [steampipe login](reference-cli-login.md): Log in to [Turbot Pipes](https://turbot.com/pipes/docs).
- [Steampipe CLI](reference-cli-overview.md): | Command | Description
- [steampipe plugin](reference-cli-plugin.md): Steampipe plugin management.
- [steampipe query](reference-cli-query.md): Execute SQL queries interactively, or by a query argument.
- [steampipe service](reference-cli-service.md): Steampipe service management.
- [connection](reference-config-files-connection.md): The`connection`block defines a Steampipe [plugin connection](/docs/managing/plugins#installing-plugins) or [aggrega...
- [options](reference-config-files-options.md): Configuration options are defined using HCL`options`blocks in one or more Steampipe config files. Steampipe will l...
- [Configuration Files](reference-config-files-overview.md): Configuration file resource are defined using HCL in one or more Steampipe config files. Steampipe will load ALL con...
- [plugin](reference-config-files-plugin.md): The`plugin`block enables you to set plugin-level options like soft memory limits and rate limiters. You can then as...
- [workspace](reference-config-files-workspace.md): A Steampipe`workspace`is a "profile" that allows you to define a unified environment
- [.autocomplete](reference-dot-commands-autocomplete.md): Turn autocomplete on or off in the interactive query shell.
- [.cache](reference-dot-commands-cache.md): Enable, disable or clear the query cache for this session.
- [.cache_ttl](reference-dot-commands-cache-ttl.md): Set the query cache TTL (time-to-live) for this session.
- [.clear](reference-dot-commands-clear.md): Clear the console screen.
- [.connections](reference-dot-commands-connections.md): List the active connections (schemas).
- [.exit](reference-dot-commands-exit.md): Exit the steampipe interactive query session.
- [.header](reference-dot-commands-header.md): Turn column headers on or off.
- [.help](reference-dot-commands-help.md): Show help for Steampipe.
- [.inspect](reference-dot-commands-inspect.md): Inspect the available connections, tables, and columns.
- [.multi](reference-dot-commands-multi.md): Enable or disable multi-line mode.
- [.output](reference-dot-commands-output.md): Change the output mode. By default, the output format is`table`which provides a tabular, human-readable view. You ...
- [Meta-Commands](reference-dot-commands-overview.md): | Command | Description
- [.quit](reference-dot-commands-quit.md): Exit the steampipe interactive query session.
- [.search_path](reference-dot-commands-search-path.md): Display the current [search path](/docs/managing/connections#setting-the-search-path), or set the search path by pass...
- [.search_path_prefix](reference-dot-commands-search-path-prefix.md): Set a prefix to the current [search path](/docs/managing/connections#setting-the-search-path) by passing in a comma-s...
- [.separator](reference-dot-commands-separator.md): Set the separator string when the output mode is csv (the default is`,`).
- [.tables](reference-dot-commands-tables.md): List the available tables.
- [.timing](reference-dot-commands-timing.md): Enable or disable query execution timing:
- [Environment Variables](reference-env-vars-overview.md): Steampipe supports environment variables to allow you to change its default behavior. These are optional settings - ...
- [PIPES_HOST](reference-env-vars-pipes-host.md): Sets the Turbot Pipes host used when connecting to Turbot Pipes workspaces. The default is`pipes.turbot.com`-- you...
- [PIPES_TOKEN](reference-env-vars-pipes-token.md): Sets the [Turbot Pipes authentication token](https://turbot.com/pipes/docs/profile#tokens). This is used when connect...
- [STEAMPIPE_CACHE](reference-env-vars-steampipe-cache.md): Enable or disable automatic caching of results. This can significantly improve performance of some queries, at the e...
- [STEAMPIPE_CACHE_MAX_SIZE_MB](reference-env-vars-steampipe-cache-max-size-mb.md): ***`STEAMPIPE_CACHE_MAX_SIZE_MB`is deprecated and will be removed in a future version of Steampipe. Use`STEAMPIPE_P...
- [STEAMPIPE_CACHE_MAX_TTL](reference-env-vars-steampipe-cache-max-ttl.md): The maximum amount of time to cache query results, in seconds. The default is`300`(5 minutes).
- [STEAMPIPE_CACHE_TTL](reference-env-vars-steampipe-cache-ttl.md): The amount of time to cache query results for this client, in seconds. The default is`300`(5 minutes).
- [STEAMPIPE_DATABASE_PASSWORD](reference-env-vars-steampipe-database-password.md): Sets the Steampipe database password for this session. By default, steampipe creates a random, unique password for t...
- [STEAMPIPE_DATABASE_SSL_PASSWORD](reference-env-vars-steampipe-database-ssl-password.md): Sets the`server.key`passphrase. By default, Steampipe generates a certificate without a passphrase; you only need ...
- [STEAMPIPE_DATABASE_START_TIMEOUT](reference-env-vars-steampipe-database-start-timeout.md): The maximum time (in seconds) to wait for the Postgres process to start accepting queries after it has been started. ...
- [STEAMPIPE_DIAGNOSTIC_LEVEL](reference-env-vars-steampipe-diagnostic-level.md): Sets the diagnostic level. Supported levels are`ALL`,`NONE`. By default, the diagnostic level is`NONE`.
- [STEAMPIPE_INSTALL_DIR](reference-env-vars-steampipe-install-dir.md): Sets the directory for the Steampipe installation, in which the Steampipe database, plugins, and supporting files can...
- [STEAMPIPE_LOG_LEVEL](reference-env-vars-steampipe-log.md): Sets the output logging level. Standard log levels are supported (`TRACE`,`DEBUG`,`INFO`,`WARN`,`ERROR`). By def...
- [STEAMPIPE_MEMORY_MAX_MB](reference-env-vars-steampipe-memory-max-mb.md): Set a soft memory limit for the`steampipe`process. Steampipe sets`GOMEMLIMIT`for the`steampipe`process to the ...
- [STEAMPIPE_OTEL_INSECURE](reference-env-vars-steampipe-otel-insecure.md): Set the`STEAMPIPE_OTEL_INSECURE`to bypass the default secure connection requirements when connecting to an OpenTele...
- [STEAMPIPE_OTEL_LEVEL](reference-env-vars-steampipe-otel-level.md): Specify which [OpenTelemetry](https://opentelemetry.io/) data to send via OTLP. Accepted values are:
- [STEAMPIPE_PLUGIN_MEMORY_MAX_MB](reference-env-vars-steampipe-plugin-memory-max-mb.md): Set a default memory soft limit for each plugin process. Steampipe sets`GOMEMLIMIT`for each plugin process to the...
- [STEAMPIPE_QUERY_TIMEOUT](reference-env-vars-steampipe-query-timeout.md): The amount of time to wait for a query to complete before timing out, in seconds.
- [STEAMPIPE_SNAPSHOT_LOCATION](reference-env-vars-steampipe-snapshot-location.md): Sets the location to write [snapshots](/docs/query/snapshots) - either a local file path or a [Turbot Pipes workspace...
- [STEAMPIPE_TELEMETRY](reference-env-vars-steampipe-telemetry.md): By default, Steampipe collects usage information to help assess features, usage patterns, and bugs. This information...
- [STEAMPIPE_UPDATE_CHECK](reference-env-vars-steampipe-update-check.md): Enable or disable automatic update checking. Update checking is enabled by default. Set to`false`to disable updat...
- [STEAMPIPE_WORKSPACE](reference-env-vars-steampipe-workspace.md): Sets the Steampipe [workspace](/docs/reference/config-files/workspace).
- [STEAMPIPE_WORKSPACE_DATABASE](reference-env-vars-steampipe-workspace-database.md): Sets the database that Steampipe will connect to. By default, Steampipe will use the locally installed database (`loc...
- [Steampipe Reference](reference-overview.md): When all else fails, read the manual...
- [Querying IP Addresses](sql-querying-ips.md): One of the primary uses of Steampipe is for auditing cloud and network infrastructure. As such, many columns store I...
- [Querying JSON](sql-querying-json.md): Steampipe plugins call API functions, and quite often these functions return structured object data, most commonly in...
- [It's Just SQL!](sql-steampipe-sql.md): Steampipe leverages PostgreSQL Foreign Data Wrappers to provide a SQL interface to external services and systems. St...
- [Tips and Tricks](sql-tips.md): This is a common recommendation for any SQL database, but it is especially important for Steampipe, as it can avoid m...
- [Install](steampipe-export-install.md): Each Steampipe plugin is distributed as a distinct Steampipe Export CLI. They are available for download in the **Re...
- [Steampipe Export CLIs](steampipe-export-overview.md): Steampipe Export CLIs provide a flexible mechanism for exporting information from cloud services and APIs. Each expo...
- [Run](steampipe-export-run.md): Each Steampipe Export CLI is distributed as a separate binary, but the command line options are the same:
- [Configure](steampipe-postgres-configure.md): To use the Steampipe Postgres FDW, you first have to create the foreign server and import the foreign schema.
- [Install](steampipe-postgres-install.md): Each Steampipe plugin is distributed as a distinct Steampipe Postgres FDW. They are available for download in the **...
- [Steampipe Postgres FDWs](steampipe-postgres-overview.md): Steampipe Postgres FDWs are native Postgres Foreign Data Wrappers that translate APIs to foreign tables. Unlike Stea...
- [Query](steampipe-postgres-query.md): Your Steampipe Postgres FDW adds foreign tables to your Postgres installation. Typically, these tables are prefixed ...
- [Configure](steampipe-sqlite-configure.md): [!IMPORTANT]
- [Install](steampipe-sqlite-install.md): Each Steampipe plugin is distributed as a distinct Steampipe SQLite Extension. They are available for download in th...
- [Steampipe SQLite Extensions](steampipe-sqlite-overview.md): Steampipe SQLite extensions provide a zero-ETL, SQLite-native query experience. The Steampipe SQLite extensions crea...
- [Query](steampipe-sqlite-query.md): Your Steampipe extension adds virtual tables to your SQLite installation. Typically, these tables are prefixed with ...