Skip to content

Commit

Permalink
proofread fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsmyth committed May 18, 2023
1 parent 3ba80fe commit 078acd5
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/reference/config-files/workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Any unset arguments will assume the default values.
|---------------------|-----------------------------------------------|-----------------------------------------
| `base` | | A reference to a named workspace resource that this workspace should source its definition from. Any argument can be overridden after sourcing via base.
| `cache` | `true` | Enable/disable caching. Note that is a **client** setting - if the database (`options "database"`) has the cache disabled, then the cache is disabled regardless of the workspace setting. <br /> <br /> Env: [STEAMPIPE_CACHE](/docs/reference/env-vars/steampipe_cache)
| `cache_ttl` | `300` | Set the client query cache expiration (TTL) in seconds. Note that is a **client** setting - if the database (`options "database"`) `cache_max_ttl` is lower than the cache_ttl in the workspace, then the effective ttl for this workspace is the cache_max_ttl. <br /> <br /> Env: [STEAMPIPE_CACHE_TTL](/docs/reference/env-vars/steampipe_cache_ttl)
| `cache_ttl` | `300` | Set the client query cache expiration (TTL) in seconds. Note that is a **client** setting - if the database `cache_max_ttl` is lower than the `cache_ttl` in the workspace, then the effective ttl for this workspace is the `cache_max_ttl`. <br /> <br /> Env: [STEAMPIPE_CACHE_TTL](/docs/reference/env-vars/steampipe_cache_ttl)
| `cloud_host` | `cloud.steampipe.io` | Set the Steampipe Cloud host for connecting to Steampipe Cloud workspace. <br /> <br /> Env: [STEAMPIPE_CLOUD_HOST](/docs/reference/env-vars/steampipe_cloud_host) <br /> CLI: `--cloud-host`
| `cloud_token` | The token obtained by `steampipe login` | Set the Steampipe Cloud authentication token for connecting to a Steampipe Cloud workspace. This may be a token obtained by `steampipe login` or a user-generated [token](/docs/cloud/profile#tokens). <br /> <br /> Env: [STEAMPIPE_CLOUD_TOKEN](/docs/reference/env-vars/steampipe_cloud_token) <br /> CLI: `--cloud-token`
| `input` | `true` | Enable/Disable interactive prompts for missing variables. To disable prompts and fail on missing variables, set to `false`. This is useful when running from scripts. <br /> <br /> CLI: `--input`
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/dot-commands/cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: .cache


# .cache
Enable, disable or clear the query cache.
Enable, disable or clear the query cache for this session.

## Usage
```
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/env-vars/steampipe_cache_max_ttl.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ sidebar_label: STEAMPIPE_CACHE_MAX_TTL

# STEAMPIPE_CACHE_MAX_TTL

The maximum amount of time to cache results, in seconds. The default is `300` (5 minutes).
The maximum amount of time to cache query results, in seconds. The default is `300` (5 minutes).

Caching must be enabled for this setting to take effect.

This is a server setting, not a client setting -- when connecting to a Steampipe database, you are subject to the `STEAMPIPE_CACHE_MAX_TTL` set on the server. You can set the [STEAMPIPE_CACHE_TTL](reference/env-vars/steampipe_cache_ttl) (or `cache_ttl` in a [workspace](/docs/reference/config-files/workspace) from your client to *reduce* the TTL for your session but not to expand it -- The net effect for your session will be the lower of the two values.
This is a server setting, not a client setting -- when connecting to a Steampipe database, you are subject to the `STEAMPIPE_CACHE_MAX_TTL` set on the server. You can set the [STEAMPIPE_CACHE_TTL](reference/env-vars/steampipe_cache_ttl) (or `cache_ttl` in a [workspace](/docs/reference/config-files/workspace)) from your client to *reduce* the TTL for your session but not to expand it -- The net effect for your session will be the lower of the two values.


## Usage
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/env-vars/steampipe_cache_ttl.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ sidebar_label: STEAMPIPE_CACHE_TTL

# STEAMPIPE_CACHE_TTL

The amount of time to cache results, in seconds. The default is `300` (5 minutes).
The amount of time to cache query results for this client, in seconds. The default is `300` (5 minutes).

Caching must be enabled for this setting to take effect.

This is a client setting -- when connecting to a Steampipe database, you are also subject to the [STEAMPIPE_CACHE_MAX_TTL](reference/env-vars/steampipe_cache_max_ttl) set on the server. You can set the `STEAMPIPE_CACHE_TTL` (or `cache_ttl` in a [workspace](/docs/reference/config-files/workspace) from your client to *reduce* the TTL for your session but not to expand it -- The net effect for your session will be the lower of the two values.
This is a client setting -- when connecting to a Steampipe database, you are also subject to the [STEAMPIPE_CACHE_MAX_TTL](reference/env-vars/steampipe_cache_max_ttl) set on the server. You can set the `STEAMPIPE_CACHE_TTL` (or `cache_ttl` in a [workspace](/docs/reference/config-files/workspace)) from your client to *reduce* the TTL for your session but not to expand it -- The net effect for your session will be the lower of the two values.


## Usage
Expand Down

0 comments on commit 078acd5

Please sign in to comment.