connection
The connection block defines a Steampipe plugin connection or aggregator.
Most connection arguments are plugin-specific, and they are used to specify credentials, accounts, and other options. The Steampipe Hub provides detailed information about the arguments for each plugin.
Supported options
| Argument | Default | Values | Description |
|---|---|---|---|
| import_schema | enabled | enabled, disabled | Enable or disable the creation of a Postgres schema for this connection. When import_schema is disabled, Steampipe will not create a schema for the connection (and will delete it if it exists), but the connection will still be queryable from any aggregator that includes it. For installations with a large number of connections, setting import_schema to disabled can decrease startup time and increase performance. |
| plugin | none | plugin version string or plugin reference | The plugin version / instance that this connection uses. This must refer to an installed plugin version. |
| type | plugin | plugin, aggregator | The type of connection - plugin connection or aggregator. |
| {plugin argument} | varies | varies | Additional options are defined in each plugin - refer to the documentation for your plugin on the Steampipe Hub. |
Plugin Version Strings
Steampipe plugin versions are in the format:
The {organization} is optional, and if it is not specified, it is assumed to be turbot. The {release stream} is also optional, and defaults to @latest. As a result, plugin version are usually simple plugin names:
You may specify a specific version:
Or a release stream:
For third-party plugins, the {organization} must be specified:
You can even use a local path while developing plugins:
Examples
Connections using plugin version strings:
Connections using plugin reference: