Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/flowpipe-hcl/mod.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ mod "deactivate_expired_aws_iam_access_keys" {
|-|-|-|-
| `categories` | List(String) | Optional | A list of labels, used to categorize mods (such as on the Flowpipe Hub).
| `color` | String | Optional | A hexadecimal RGB value to use as the color scheme for the mod on hub.flowpipe.io.
| `database` | String | Optional | The database to use as the default for [query steps](/docs/flowpipe-hcl/step/query) and [query triggers](/docs/flowpipe-hcl/trigger/query). The `database` may be a connection reference (`connection.steampipe.default`), a connection string (`postgres://steampipe@127.0.0.1:9193/steampipe`), or a Pipes workspace (`acme/anvils`). If not set, the default is the local Steampipe database instance.
| `database` | String | Optional | The database to use as the default for [query steps](/docs/flowpipe-hcl/step/query) and [query triggers](/docs/flowpipe-hcl/trigger/query). The `database` may be a connection reference (`connection.steampipe.default`), a connection string (`postgres://steampipe@localhost:9193/steampipe`), or a Pipes workspace (`acme/anvils`). If not set, the default is the local Steampipe database instance.
| `description` | String | Optional | A string containing a short description.
| `documentation` | String (Markdown)| Optional | A markdown string containing a long form description, used as documentation for the mod on hub.flowpipe.io.
| `icon` | String | Optional | The URL of an icon to use for the mod on hub.flowpipe.io.
Expand Down
2 changes: 1 addition & 1 deletion docs/flowpipe-hcl/step/query.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ pipeline "enabled_regions" {
| -----------| ------ | --------- | ----------------------------------------------------
| `sql` | String | Required | A SQL query string.
| `args` | List | Optional | A list of arguments to pass to the query.
| `database` | String | Optional | The database to query. This may be a connection reference (`connection.steampipe.default`), a connection string (`postgres://steampipe@127.0.0.1:9193/steampipe`), or a Pipes workspace (`acme/anvils`). If not set, the default set in the [mod `database`](/docs/flowpipe-hcl/mod) will be used.
| `database` | String | Optional | The database to query. This may be a connection reference (`connection.steampipe.default`), a connection string (`postgres://steampipe@localhost:9193/steampipe`), or a Pipes workspace (`acme/anvils`). If not set, the default set in the [mod `database`](/docs/flowpipe-hcl/mod) will be used.

This step also supports the [common step arguments](/docs/flowpipe-hcl/step#common-step-arguments) and [attributes](/docs/flowpipe-hcl/step#common-step-attributes-read-only).

Expand Down
2 changes: 1 addition & 1 deletion docs/flowpipe-hcl/trigger/query.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ On subsequent query trigger runs:
|---------------|---------|-----------|-----------------
| `sql` | String | Required | A SQL query string.
| `description` | String | Optional | A description of the trigger.
| `database` | String | Optional | The database to query. This may be a connection reference (`connection.steampipe.default`), a connection string (`postgres://steampipe@127.0.0.1:9193/steampipe`), or a Pipes workspace (`acme/anvils`). If not set, the default set in the [mod `database`](/docs/flowpipe-hcl/mod) will be used.
| `database` | String | Optional | The database to query. This may be a connection reference (`connection.steampipe.default`), a connection string (`postgres://steampipe@localhost:9193/steampipe`), or a Pipes workspace (`acme/anvils`). If not set, the default set in the [mod `database`](/docs/flowpipe-hcl/mod) will be used.
| `enabled` | Boolean | Optional | Enable or disable the trigger. A disabled trigger will not fire, but it will retain its history and configuration. Default is `true`.
| `param` | Block | Optional | A [param](#parameters) block that defines the parameters that can be passed into the trigger.
| `primary_key` | String | Optional | Primary key to use for update vs insert detection. If no primary key is defined, a hash of the row will be used as the key.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/config-files/connection/steampipe.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ connection "steampipe" "steampipe_connection" {
| Name | Type | Required?| Description
|---------------------|---------|----------|-------------------
| `db` | String | Optional | Database name. Defaults to `steampipe`.
| `host` | String | Optional | Database hostname. Defaults to `127.0.0.1`.
| `host` | String | Optional | Database hostname. Defaults to `localhost`.
| `password` | String | Optional | Database password.
| `port` | Number | Optional | Database port. Defaults to `9193`.
| `search_path` | String | Optional | Database search path.
Expand Down