CHANGELOG.md

v5.11.0 [tbd]

What's new?

• Add support for pushing down sort order. (#596)

v5.10.1 [2024-05-09]

Bug fixes

• Ensure QueryData passed to ConnectionKeyColumns value callback is populated with ConnectionManager. (#797)

v5.10.0 [2024-04-10]

What's new?

• Add support for connection key columns. (#768)
• Add sp_ctx and sp_connection_name columns to all tables. (#769)

v5.9.0 [2024-02-26]

What's new?

• Remove support for Memoized functions to be directly assigned as column hydrate functions. Instead require a wrapper hydrate function. (#738)

Bug fixes

• If cache is disabled for the server, but enabled for the client, the query execution code tries to stream to the cache even though there is not active set operation. (#740)

v5.8.0 [2023-12-11]

What's new?

• Encapsulate plugin server so it is possible to use it in-process as well as via GRPC. (#719)
• Add steampipe field to _ctx column, containing sdk version. (#712)

Bug fixes

• Remove plugin has no connections error when deleting and then re-adding a connection. (#725)
• Fix potential divide by zero bug when setting cache size

v5.7.0 [2023-11-28]

What's new?

• Update proto.ColumnDefinition to include column default and hydrate function name. (#711)
• Show connection name along with error message. (#684)
• Dynamically allocate a TCP port when STEAMPIPE_PPROF environment variable is set.

Bug fixes

• Fix issue where NullIfEmptySliceValue panics when input is not a slice. (#707)

v5.6.3 [2023-11-06]

Bug fixes

• Fix expired credentials sometimes being left in connection cache - update connection cache to use a backing store per connection, rather than a shared backing store. (#699)

v5.6.2 [2023-10-03]

Bug fixes

• The initialise function is now being called for implicit hydrate configs (i.e. hydrate functions without explicit config), thereby preventing nil pointer reference errors when the hydrate function returns an error. (#683)

v5.6.1 [2023-09-29]

What's new?

• SetConnectionCacheOptions, a new GRPC endpoint to clear connection cache. (#678)

v5.6.0 [2023-09-27]

What's new?

• Define rate and concurrency limits for plugin execution. (#623)
• Diagnostics property added to _ctx column, containing information on hydrate calls and rate limiting (enabled by setting env var STEAMPIPE_DIAGNOSTIC_LEVEL=all)
• Support for JSONB operators in List hydrate functions. (#594).
• Type property added to ConnectionConfig protobuf definition and use to determine if a connection is an aggregator. (#590)
• When plugin startup fails, write specially formatted string to stdout so plugin manager can parse the output and display a useful message. (#619)
• Support for multi-line log entries. (#612)
• Added Equals function for QualValue. (#646)

Bug fixes

• Fix cache deadlock caused when the same table is scanned multiple times, and Postgres does not iterate the first scan. Update the query cache to make all scans a subscriber of the cache request, and decouple the reading ands writing of cached data . (#586)

v5.5.2 [2023-09-29]

What's new?

• Improve logging for connection config updates and connection cache clearing (#677)

v5.5.1 [2023-07-26]

What's new?

• Upgrade opentelemetry SDK to v1.16.0. (#570)

v5.5.0 [2023-06-16]

What's new?

• Update cache pending item implementation. (#564,#566)
  • Cache requests subscribe to pending items and stream them as the data is received rather than waiting for the item to complete.
  • When making cache request, update request to include ALL columns which will be returned, not just columns requested. This will allow pending item code to match in cases where a different column in the same hydrate function is requested.

Bug fixes

• Optimise GetSourceFiles to avoid recursing into child folders when not necessary (update go-kit version). (#557)
• Fix hang in hydrate retry code - fix invalid default retryInterval in getBackoff. (#558)
• Update GetSourceFiles to use go-getter GetAny method for https URLs. (#560)
• Do not print call stacks in logs. (#553)

v5.4.1 [2023-05-05]

Bug fixes

• Avoid loading schema repeatedly when initializing plugin with multiple connections. (#547)

v5.4.0 [2023-04-27]

What's new?

• Add SetCacheOptions to allow control of cache at server level. (#546)

v5.3.0 [2023-03-16]

What's new?

• Add env var support for limiting the folders from which source files are retrieved. (#540)
• Add go-getter support to TableMapFunc - add GetSourceFiles method to ConnectionMapData. (#542)

v5.2.0 [2023-03-02]

What's new?

• Add support for update of dynamic plugin schema based on file watching events. (#457)
• Update SetAllConnectionConfigs to return map of failed connections. (#458)
• Add support/handling for aggregator connections using dynamic plugins. (#453)
• Add new Hydrate function wrapper Memoize to replace WithCache. (#499)
• Replace Mutexes with RWMutexes and update locking to use RLock where possible. (#498)
• If an empty Matrix is returned from MatrixItemFunc, fetch function should not be called.(#496)
• Remove need for connection config schema - support hcl tags on connection config struct. (#482)
• Add support for including child struct properties in connection config. (#168)
• Instead of renaming _ctx column to dedupe it, implement a set of reserved columns which may not be used. (#536)
• Add support for like, not like, ilike and not ilike operators in List hydrate functions. (#592)

Bug fixes

• Fix query cache pending item mechanism. (#511,#512,#517)
• Fix dynamic plugins exhibiting very high CPU usage due to message stream function. (#537)

BREAKING CHANGE

• Fix typo in TableMapData - rename ConectionCache to ConnectionCache. (#535)

v5.1.2 [2023-01-24]

Bug fixes

• Fix cache timeout when doing select * - when adding all columns to the cache request, include the _ctx column. (#490)

v5.1.1 [2023-01-24]

Bug fixes

• When caching query results, cache all columns, not just those that were requested. (#487)

v5.1.0 [2023-01-11]

What's new?

• Add DiagsToWarnings function. (#474)
• Add NullIfEmptySlice transform. (#476)

v5.0.2 [2023-01-04]

Bug fixes

• When adding the ctx column to table schema, if that column already exists, keep prepending '' (e.g. __ctx) until a unique name is found. (#466)
• Fix validation for dynamic plugins. This fixes optional key columns which were sometimes not working for dynamic plugins as the key column operators were not being defaulted. (#469)

v5.0.1 [2022-11-30]

Bug fixes

• Fix hydrate function caching using WithCache for aggregator connections. (#460)

v5.0.0 [2022-11-16]

What's new?

• Add QueryData.GetSourceFiles which fetches files using go-getter. (#434)
• Add support for watching files specified by connection config properties with the tag watch. (#451)
• Update comments to improve GoDoc documentation and remove unnecessary exports. (#432)
• Update signature of TableMapFunc to accept TableMapData, which included ConnectionCache. (#436)
• Add support to customize the RetryHydrate function. (#349)
• Remove explicit setting of rlimit, now that Go 1.19 does it automatically. (#444)
• Fix query cache TTL maxing out at 5 mins - set hard limit to 24 hours. (#446)

Bug fixes

• Fix nil pointer reference error when qual value is nil. (#442)

Breaking changes

• The signature or TableMapFunc has changed to func(ctx context.Context, d *TableMapData) (map[string]*Table, error) where TableMapData is:

type TableMapData struct {
	Connection     *Connection
	ConectionCache *connection.ConnectionCache
}

• QueryData.QueryStatus.RowsRemaining has been moved to QueryData.RowsRemaining. (QueryData.QueryStatus is no longer exported)
• QueryData.KeyColumnQuals has been renamed to EqualsQuals
• QueryData.KeyColumnQualsString has been renamed to EqualsQualString
• ConcurrencyManager and HydrateCall and no longer exported

v4.1.11 [2023-01-24]

Bug fixes

• Fix cache timeout when doing select * - when adding all columns to the cache request, include the _ctx column. (#490)

v4.1.10 [2023-01-24]

Bug fixes

• When caching query results, cache all columns, not just those that were requested. (#487)

v4.1.9 [2022-11-30]

Bug fixes

• Fix hydrate function caching using WithCache for aggregator connections. (#460)

v4.1.8 [2022-09-08]

Bug fixes

• Remove explicit setting of the open-files limit, which was using a default which was too small. Instead, make use of the fact that Go 1.19 now sets the soft file limit to the hard limit automatically. (#444)

v4.1.7 [2022-11-08]

Bug fixes

• Move IsCancelled back to plugin package.

v4.1.6 [2022-09-02]

Bug fixes

• Fix issue where multi-region queries with a region where-clause do not have the region in the cache key, causing incorrect cache hits. (#402)

v4.1.5 [2022-08-31]

Bug fixes

• Fix ConnectionCache.SetWithTTL. (#399)
• When connection config changes, store updated connection config before calling ConnectionConfigChangedFunc. (#401)

v4.1.4 [2022-08-26]

Remove warning logs

v4.1.3 [2022-08-26]

Bug fixes

• Fix timeout waiting for pending cached item - if pending item has error, all queries waiting for that pending item now return error rather than rerunning the query. (#396)

v4.1.2 [2022-08-25]

Bug fixes

• Fix queries sometimes hanging when multiple scans are accessing the cache. (#391)

v4.1.1 [2022-08-24]

Bug fixes

• Fix concurrent map access crash for Plugin.connectionCacheMap. (#389)

v4.1.0 [2022-08-24]

What's new?

• Add Plugin propertyConnectionConfigChangedFunc. This is a callback function invoked when the connection config changes. The default implementation clears the connection cache and query cache for the changed connection. (#387)

v4.0.2 [2022-08-22]

Bug fixes

• Fix Get calls stalling due to an attempt to write to an unbuffered channel. (#382)

v4.0.1 [2022-08-11]

Bug fixes

• Fix UpdateConnectionConfigs not setting the connection config. (#375)
• Fix query results with zero rows not being cached, leading to timeouts and failure to load pending cache results. (#372)
• Fix duplicate results returned from cache. (#371)
• Remove max concurrent row semaphore. Max concurrent row limiting is disabled by default, and under certain circumstances has been seen to cause a NRE. Removed for now until more detailed benchmarking can be done to justify re-adding. (#369)
• Fix parent-child listing, which was broken in v4.0.x (#378)

v4.0.0 [2022-08-04]

What's new?

• A single plugin instance now supports multiple connections, as opposed to an instance being created per connection. (#365)
• Memory usage has been substantially reduced, particularly when streaming high row counts. (#366)
• Allow control of maximum cache memory usage. (#302)
• QueryData functions StreamListItem and StreamLeafListItem are now variadic, and accept multiple items to passed in a single call, simplifying the streaming of a page of data. (#341)

Breaking changes

• Go version updated to 1.19
• Plugin property TableMapFunc has changed signature. This is the function which is called for plugins with dynamic schema to return their table schema. Note that the parameter connection has been added. This may be used in place of the removed Plugin.Connection property.

The new signature is:

func(ctx context.Context, connection *Connection) (map[string]*Table, error)

• Plugin properties Connection, and Schema have been removed, and new property ConnectionMap added.
  This is a map of ConnectionData objects, keyed by connection. This is needed as each plugin instance may support multiple connections. ConnectionData looks as follows

type ConnectionData struct {
	// TableMap is a map of all the tables in the plugin, keyed by the table name
	TableMap map[string]*Table
	// connection this plugin is instantiated for
	Connection *Connection
	// schema - this may be connection specific for dynamic schemas
	Schema map[string]*proto.TableSchema
}

• ConnectionManager has been renamed to ConnectionCache. As the plugin can support multiple connections, each connection has its own ConnectionCache, which is a wrapper round an single underlying connection data cache.

NOTE: the property QueryData.ConnectionManager has been retained for comptibility reasons - this will be deprecated in a future version

v3.3.2 [2022-07-11]

What's new?

• Add MaxConcurrency to GetConfig - for use when using the Get hydrate as a column hydrate function. (#353)
• Validate table Name property matches key in plugin's TableMap. (#355)

v3.3.1 [2022-6-30]

Bug fixes

• Deprecated ShouldIgnoreError property is not being respected if defined in plugin.DefaultGetConfig. (#347)
• If cached item has limit, quals must match exactly to be considered a cache hit. (#345)

v3.3.0 [2022-06-22]

What's new?

• Add support for Open Telemetry. (#337)
• Return query metadata with the scan result, such as the number of hydrate functions called and the cache status. (#338)

Bug fixes

• Incomplete results should not be added to cache if the context is cancelled. (#339)
• Avoid deadlock after panic during newQueryData. (#332)

v3.2.0 [2022-05-20]

What's new?

• Deprecate ShouldIgnoreError and ShouldRetryError.

  Add instead ShouldRetryErrorFunc and a new IgnoreConfig containing ShouldIgnoreErrorFunc.

  These functions receive as args the context, QueryData and HydrateData to allow access to connection config and other context data. (#261)

Bug fixes

• Fix potential transform function casting errors caused by empty hydrate items. If no hydrate data is available, do not call transform functions. (#325)
• Fix the sdk not respecting the DefaultGetConfig when resolving the ShouldIgnoreError function. (#319)

v3.1.0 [2022-03-30]

What's new?

• Add CacheMatch property to KeyColumn, to support key columns which require exact matching to be considered a cache hit. (#298)
• Add table and plugin level defaults for ShouldIgnoreError and RetryConfig. (#257)

v3.0.1 [2022-03-10]

Bug fixes

• Fix issue when executing list calls with 'in' clauses, key column values passed in Quals map are incorrect. (#294)

v3.0.0 [2022-03-09]

What's new?

• Add support for ltree column type. (#248)
• Add support for inet column type. (#248)

v2.2.0 [2022-03-30]

What's new?

• Add CacheMatch property to KeyColumn, to support key columns which require exact matching to be considered a cache hit. (#298)
• Add table and plugin level defaults for ShouldIgnoreError and RetryConfig. (#257)

v2.1.1 [2022-03-10]

Bug fixes

• Fix issue when executing list calls with 'in' clauses, key column values passed in Quals map are incorrect. (#294)

v2.1.0 [2022-03-04]

What's new?

• Add support for is null and is not null quals. (#286)

Bug fixes

• Fix list call not respecting in qual if list config has multiple key columns. (#275)

v2.0.3 [2022-02-14]

What's new?

• Update all references to use github.com/turbot/steampipe-plugin-sdk/v2. (#272)

v2.0.2 [2022-02-14]

What's new?

• Update package name to github.com/turbot/steampipe-plugin-sdk/v2. (#272)

v2.0.1 [2022-02-10]

Bug fixes

• Fix requires hydrate data from xxxx but none is available error - avoid mutating Column objects, which may be shared between tables. (#259)

v2.0.0 [2022-02-04]

Changed behaviour

• A _ctx column is now added to all tables. This is a JSON field which specified the Steampipe connection name. (#246)

Bug fixes

• Fix a query cache bug which under very specific circumstances would lead to an incomplete data set being returned. (#254)

v1.8.3 [2021-12-23]

What's new?

• Updated missing required quals error to include table name. (#166)
• Move setting R Limit to OS specific code to allow compilation on Windows systems.
• Update makefile and GRPCServer to support protoc-gen-go-grpc 1.1.0_2.

Bug fixes

• Fix 'in' clause not being correctly evaluated when more than one key column qual is specified. (#239)
• Fix invalid memory address error when joining on a column with null value. (#233)
• Avoid adding duplicate quals to KeyColumnQualMap. Was causing invalid key column errors. (#236)

v1.8.2 [2021-11-22]

What's new?

• Query cache TTL defaults to 5 minutes and is increased to match the TTL of incoming queries. (#226)
• Set cache cost of items based on number of rows and columns inserted. (#227)
• Add logging for query cache usage. (#229)

v1.8.1 [2021-11-22]

What's new?

• Query result caching now determines whether a cache request is a subset of an existing cached item, taking the quals into account. (#224)

Bug fixes

• Fix timeout waiting for pending cache transfer to complete. (#218)
• Support cancellation while waiting for pending cache transfer. (#219)

v1.8.0 [2021-11-10]

What's new?

• Add support for query result caching with stampede prevention, and concurrent query execution. (#211)

v1.7.3 [2021-11-08]

Bug fixes

• FromField transform should return nil property value if property is nil, rather than nil interface value. (#212)

v1.7.2 [2021-11-03]

Bug fixes

• Fix KeyColumn Require and Operators properties not being set to default if a TableMapFunc is used. (#206)
• Remove unnecessary TableMapFunc validation from plugin - this breaks dynamic plugins when plugin manager is used. (#204)

v1.7.1 [2021-11-01]

Bug fixes

• FromValue transform should fall back to next property path if a property value is nil. (#197)
• Avoid nil data being passed to hydrate calls if plugin calls StreamListItem with a nil item. (#198)

v1.7.0 [2021-10-18]

What's new?

• Add dynamic schema support - add SchemaMode property to Plugin. If this is set to dynamic, Steampipe will check for plugin schema changes on startup. (#195)

v1.6.2 [2021-10-08]

Bug fixes

• Fix in clause not working when the table has any_of key columns. (#189)
• Fix transform functions being called with null data when the Get call returns a null item but no error. (#186)

v1.6.1 [2021-09-21]

Bug fixes

• Pass context to table creation callback TableMapFunc. (#183)

v1.6.0 [2021-09-21]

What's new?

• Add QueryStatus.RowsRemaining function which performs context cancellation and limit checking to determine how much more data the plugin should provide. (#177)
  • This function is used internally by StreamListItem to avoid calling hydrate functions once sufficient data has been returned.
  • It may also be called directly by the plugin to avoid retrieving unneeded data from the external API
• Enable plugin table creation to use the connection config. New plugin property has been added: TableMapFunc. This can be set to a table creation function which, when invoked, has access to the parsed connection config. (#180)

v1.5.1 [2021-09-13]

Bug fixes

• Fix get call returning nothing if there is an in clause for the key column, and matrix parameters are used. (#170)

v1.5.0 [2021-08-06]

What's new?

• Add cache functions SetWithTTL and Delete. (#163)

Bug fixes

• When listing missing quals, only report required quals. (#159)

v1.4.1 [2021-07-20]

Bug fixes

• Extraneous log output removed

v1.4.0 [2021-07-20]

What's new?

• Return all columns provided by hydrate functions, not just requested columns. (#156)

Bug fixes

• Fix matrix parameters not being added to the KeyColumns map passed to hydrate functions. (#151)

v1.3.1 [2021-07-15]

Bug fixes

• Fix crash caused by thread sync issue with multi-region union queries. (#149)
• When checking if StreamListItem is called from a non-list function, do not through errors for anonymous functions. (#147)

v1.3.0 [2021-07-09]

What's new?

• When defining key columns it is now possible to specify supported operators for each column (defaulting to '='). (#121)
• Add support for optional key columns. (#112)
• Cancellation of GRPC stream is now reflected in the context passed to plugin operations, so plugins can easily handle cancellation by checking the context. (#17)
• Add IsCancelled() function to simplify plugins checking for a cancelled context. (#143)
• Add WithCache() function - if this is chained after a hydrate function definition, it enables plugin cache optimisation to avoid concurrent hydrate functions with same parameters. (#116)

Breaking changes

• The property QueryData.QueryContext.Quals has been renamed to QueryContext.UnsafeQuals. This property contains all quals, not just key columns. These quals should not be used for filtering data as this may break the FDW row data caching, which is keyed based on key column quals. Instead, use the new property QueryData.Qualswhich contains only key column quals. (#119)
• Plugins built with v1.3 of the sdk will only be loaded by Steampipe v0.6.2 onwards.

v0.2.10 [2021-06-09]

What's new?

• Provide SDK transform to get a qual value. (#77)
• Change plugin license to Apache 2.0 (#488)

Bug fixes

• Fix Cache being recreated for every query. (#106)
• Improve error messages when hydrate function fails and when StreamListItem is called from anywhere other than a list function. (#70)
• Fix key column setting of AnyColumn only populating the first key column in the KeyColumnQuals map. (#101)
• Fix EnsureStringArray transform not working for input type *string. closes #92 (#100)
• Fix Steampipe hanging after hydrate error. (#103)
• Fix list call failing with error "get call requires an '=' qual". (#103)

v0.2.9 [2021-05-13]

What's new?

• Export GetQualValue function (#98)

v0.2.8 [2021-05-06]

What's new?

• Added support for retryable errors and ignorable errors inside getConfig and hydrateConfig. (#15)
• Update FromField transform to accept multiple arguments, which are tried in order. (#55)
• Add ProtocolVersion property to the plugin GetSchema response. (#94)

v0.2.7 [2021-03-31]

Bug fixes

• Multiregion queries should take region quals into account for 'get' calls. (#78)

v0.2.6 [2021-03-18]

re-tagged after pushing missing commit

v0.2.5 [2021-03-18]

What's new?

• Improve the hcl diagnostic to error message conversion to improve parse failure messages. (#72)

v0.2.4 [2021-03-16]

What's new?

• Include key column information in GetSchema response to support dynamic path key generation. (#57)
• Make get calls with 'in' clauses asynchronous. (#30)
• Remove need to call StreamLeafListItem for parent-child list calls. The child list function can now just cal StreamListItem. (#64)
• For parent-child list calls, store the parent list call results in RowData ParentItem property so they can be accessed by hydrate functions. (#65)

Bug fixes

• Queries with 'in' clause now work for list calls with required key columns. (#61)
• For Get or List calls with required key columns and 'in' clauses, incorrect quals are passed to hydrate calls. (#69)

v0.2.3 [2021-03-02]

Bug fixes

• Fix failure of Get calls which use ItemFromKey to provide a hydrate item. (#53)

v0.2.2 [2021-02-24]

What's new?

• Set the ulimit for plugin processes, respecting env var STEAMPIPE_ULIMIT. (#43)
• When displaying hcl errors, show the context if available. (#48)
• Only show concurrency summary if there is any summary data to show. (#47)

Bug fixes

• Fix error message not displaying when a query does not provide required get or listquals. (#42)

v0.2.1 [2021-02-18]

Bug fixes

• Remove "rc" from version number in the release branch. (#38)

v0.2.0 [2021-02-17]

What's new?

• Add support for multi-region querying. (#20)
• Add support for connection config. (#21)
• Add mechanism to limit max hydrate function concurrency. (#12)
• Update environment variables to use STEAMPIPE prefix. (#32)
• Provide dependency mechanism to allow Steampipe to know if a plugin uses a newer sdk version. (#25)

v0.1.1 [2021-02-11]

What's new?

• Add transforms StringArrayToMap and EnsureStringArray. (#3)

Bug fixes

• Fix ToLower and ToUpper transforms not working when input value is a with string pointers. (#13)
• Fix failure to report errors returned from Get function. (#23)