From 58bf0c97e1272f8729493641ec28e6755fc10b97 Mon Sep 17 00:00:00 2001 From: Graza Date: Tue, 11 Mar 2025 08:19:31 +0000 Subject: [PATCH] Corrected default address of Steampipe database --- docs/flowpipe-hcl/mod.md | 2 +- docs/flowpipe-hcl/step/query.md | 2 +- docs/flowpipe-hcl/trigger/query.md | 2 +- docs/reference/config-files/connection/steampipe.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/flowpipe-hcl/mod.md b/docs/flowpipe-hcl/mod.md index 09e2c95..2df261b 100644 --- a/docs/flowpipe-hcl/mod.md +++ b/docs/flowpipe-hcl/mod.md @@ -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. diff --git a/docs/flowpipe-hcl/step/query.md b/docs/flowpipe-hcl/step/query.md index b744bf2..a6244d9 100644 --- a/docs/flowpipe-hcl/step/query.md +++ b/docs/flowpipe-hcl/step/query.md @@ -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). diff --git a/docs/flowpipe-hcl/trigger/query.md b/docs/flowpipe-hcl/trigger/query.md index f96514b..ef12abd 100644 --- a/docs/flowpipe-hcl/trigger/query.md +++ b/docs/flowpipe-hcl/trigger/query.md @@ -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. diff --git a/docs/reference/config-files/connection/steampipe.md b/docs/reference/config-files/connection/steampipe.md index 960747e..584e3f4 100644 --- a/docs/reference/config-files/connection/steampipe.md +++ b/docs/reference/config-files/connection/steampipe.md @@ -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.