Skip to content

Commit

Permalink
add import_schema to connection reference docs (added in .20)
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsmyth committed May 16, 2023
1 parent d0ba0d2 commit cadae28
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions docs/reference/config-files/connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@ Most `connection` arguments are plugin-specific, and they are used to specify cr
## 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](#plugin-version-strings) | The plugin version that this connection uses. This must refer to an [installed plugin version](/docs/managing/plugins#installing-plugins).
| `type` | `plugin` | `plugin`, `aggregator` | The type of connection - [plugin connection](/docs/managing/plugins#installing-plugins) or [aggregator](/docs/managing/connections#using-aggregators).
| `{plugin argument}`| varies | varies| Additional options are defined in each plugin - refer to the documentation for your plugin on the [Steampipe Hub](https://hub.steampipe.io/plugins).


### Plugin Version Strings


Steampipe plugin versions are in the format:
```
[{organization}/]{plugin name}[@release stream]
Expand Down Expand Up @@ -66,24 +68,25 @@ connection "myplugin" {
```hcl
connection "aws_all" {
type = "aggregator"
plugin = "aws"
plugin = "aws"
connections = ["aws_*"]
}
connection "aws_01" {
plugin = "aws"
profile = "aws_01"
regions = ["*"]
plugin = "aws"
profile = "aws_01"
regions = ["*"]
}
connection "aws_02" {
plugin = "aws"
profile = "aws_02"
regions = ["us-*", "eu-*"]
plugin = "aws"
import_schema = "disabled"
profile = "aws_02"
regions = ["us-*", "eu-*"]
}
connection "aws_03" {
plugin = "aws"
plugin = "aws"
aws_access_key_id = AKIA4YFAKEKEYXTDS252
aws_secret_access_key = SH42YMW5p3EThisIsNotRealzTiEUwXN8BOIOF5J8m
regions = ["us-east-1", "us-west-2"]
Expand Down

0 comments on commit cadae28

Please sign in to comment.