mirror of
https://github.com/turbot/steampipe.git
synced 2026-03-23 04:00:11 -04:00
4fa11a424e
* Add function to clear connection cache. * Update FDW to v1.9.0 - Add ability to clear connection cache by inserting into settings table. * Update plugin sdk to v5.6.1 * fix listen unit tests
99 lines
5.3 KiB
Markdown
99 lines
5.3 KiB
Markdown
# Search Path
|
|
|
|
## Configuring the search path
|
|
|
|
## Server search path
|
|
Server side search path (the 'steampipe' user search path) is determined according to following precedence:
|
|
1) `server_search_path` and `server_search_path_prefix` config options (set in the database global option,)
|
|
2) the compiled default (public, then alphabetical by connection name)
|
|
|
|
It is set as follows:
|
|
- When service is started the user search path is cleared (to avoid a race condition if the config has changed, and a query is executed before the user searhc path is update)
|
|
- Post-service-start, RefreshConnections is called asyncronously.
|
|
- RefreshConnections sets the required user search path, (determined using the precedence above.)
|
|
- It then adds new schemas in the order of the search path
|
|
|
|
## Client search path
|
|
Client side search path (the session search path) is determined according to following precedence:
|
|
1) The session setting, as set by the most recent `.search_path` and/or `.search_path_prefix` meta-command (for interactive session).
|
|
2) The `--search-path` or `--search-path-prefix` command line arguments.
|
|
3) The `search_path` or `search_path_prefix` set in the workspace, in the workspace.spc file.
|
|
4) The compiled default (public, then alphabetical by connection name)
|
|
|
|
|
|
When a DB session is created, if viper has a setting for either `search_path` ot `search_path_prefix`, the session search path is set (determined using the precedence above.)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Finally, call `LoadSchemaNames` which updates the client `foreignSchemas` property with a list of foreign schema
|
|
|
|
### RefreshConnectionAndSearchPaths implementation
|
|
`LocalDbClient.RefreshConnectionAndSearchPaths` simplified, does this:
|
|
```
|
|
refreshConnections()
|
|
setUserSearchPath()
|
|
SetSessionSearchPath()
|
|
```
|
|
#### setUserSearchPath
|
|
This function sets the search path for all steampipe users of the db service.
|
|
We do this so that the search path is set even when connecting to the DB from a non Steampipe client.
|
|
(When using Steampipe to connect to the DB, it is the Session search path which is respected.)
|
|
|
|
It does this by finding all users assigned to the role `steampipe_users` and setting their search path.
|
|
|
|
To determine the search path to set, it checks whether the `search-path` config is set.
|
|
- If set, it uses the configured value (with "internal" at the end)
|
|
- If not, it calls `getDefaultSearchPath` which builds a search path from the connection schemas, bookended with `public` and `internal`.
|
|
|
|
|
|
#### SetRequiredSessionSearchPath
|
|
This function populates the `requiredSessionSearchPath` property on the client.
|
|
This will be used during session initialisation to actually set the search path
|
|
|
|
In order to construct the required search path, `ContructSearchPath` is called
|
|
|
|
#### ContructSearchPath
|
|
- If a custom search path has been provided, prefix this with the search path prefix (if any) and suffix with `internal`
|
|
- Otherwise use the default search path, prefixed with the search path prefix (if any)
|
|
|
|
If either a `search-path` or `search-path-prefix` is set in config, this sets the search path
|
|
(otherwise fall back to the user search path set in setUserSearchPath`)
|
|
|
|
|
|
## Responding to runtime search path changes
|
|
The search path setting in the `database` or `terminal` options may be changed while the steampipe service is running.
|
|
|
|
The result currently depends on what is running.
|
|
|
|
### Steampipe DB service
|
|
If the steampipe DB service is running and search path options are changed in the `database` or `terminal` options,
|
|
the updated search path will be reflected in any _new_ Steampipe interactive sessions.
|
|
(New sessions using other DB clients will reflect changes in the `database config only)
|
|
|
|
### Interactive session
|
|
If an interactive session (or third paty client session) is running, changes to the search path options _will not_ be
|
|
reflected in the current session.
|
|
|
|
### Dasboard Service
|
|
If the dashboard service is running, changes to the search path options _will not_ be
|
|
reflected until the dashboard service is restarted
|
|
|
|
### Implementation of runtime search path updates
|
|
At initialisation time, the connection config options are parsed and these are used to determine
|
|
the DbClient `requiredSessionSearchPath`.
|
|
|
|
Whenever a steampipe service is running (either db service or dashboard service), a plugin manager process runs.
|
|
This is a GRPC service which has connections to the plugins, and the FDW.
|
|
It is started by the steampipe service startup code.
|
|
|
|
In the plugin manager process, a connection config file-watcher runs. If the connection config or options have changed,
|
|
`RefreshConnectionsAndSearchPaths` is called. As discussed above this has the affect of:
|
|
- setting the user search path on the DB (this search path will be used for any subsequent connections from external clients)
|
|
- setting the `requiredSessionSearchPath` on the (local) DbClient. HOWEVER - this just sets the required search path on the DbClient in the plugin manager process, NOT any DbClient used by Steampipe Query or Dashboard processes.
|
|
|
|
####Dashboard service search path implementation
|
|
When the dashboard server is started, it creates a DbClient, whose `requiredSessionSearchPath` is populated _at init time_, based on the current options amnd config values.
|
|
If the options are changed while the service is running, the `requiredSessionSearchPath` for the Dashboard server DbClient _is not updated_ |