The highest tagged major version is
README
¶
Steampipe Plugin SDK
Write Plugins with the Steampipe Plugin SDK
The Steampipe Plugin SDK provides a simple abstraction layer to simplify writing Steampipe Plugins.
Get Started Writing Plugins
Writing Steampipe plugins is fast, easy, and fun with the Steampipe Plugin SDK! Most of the heavy lifting is taken care of for you - just define your tables and columns, wire up a few API calls, and you can start to query your service with standard SQL!
See the Writing Plugins guide to get started.
Get involved
Community
The Steampipe community can be found on GitHub Discussions, where you can ask questions, voice ideas, and share your projects.
Our Code of Conduct applies to all Steampipe community channels.
Contributing
Please see CONTRIBUTING.md.
Darwin
To compile the SDK repo, you must install protoc.
brew install protoc
brew install protoc-gen-go-grpc
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package connection is a cache which may be used by the plugin to store connection specific data, for example credentials and hydrate function results
|
Package connection is a cache which may be used by the plugin to store connection specific data, for example credentials and hydrate function results |
|
docs
|
|
|
dynamic_plugin
package dynamic_plugin
|
package dynamic_plugin |
|
Package error_helpers contains custom error types and error helper functions
|
Package error_helpers contains custom error types and error helper functions |
|
Package grpc contains the definition of the [PluginServer] which runs the GRPC plugin, and the [PluginClient], which provides a simple interface to access the plugin functions.
|
Package grpc contains the definition of the [PluginServer] which runs the GRPC plugin, and the [PluginClient], which provides a simple interface to access the plugin functions. |
|
proto
Package proto contains [protobuf] definitions and auto generated code for the plugin service interface.
|
Package proto contains [protobuf] definitions and auto generated code for the plugin service interface. |
|
shared
Package shared contains types which are shared between plugin implementation and plugin clients
|
Package shared contains types which are shared between plugin implementation and plugin clients |
|
Package logging contains functions to create the plugin [hclog.Logger]
|
Package logging contains functions to create the plugin [hclog.Logger] |
|
Plugin is the top-level package of the [Steampipe] plugin SDK.
|
Plugin is the top-level package of the [Steampipe] plugin SDK. |
|
context_key
Package context_key provides keys used to retrieve items from the context
|
Package context_key provides keys used to retrieve items from the context |
|
os_specific
Package os_specific provides OS specific functions to set the file limit
|
Package os_specific provides OS specific functions to set the file limit |
|
quals
Package quals is the SDK representation of a SQL query qualifier, i.e.
|
Package quals is the SDK representation of a SQL query qualifier, i.e. |
|
schema
Package schema provides types used to define the plugin.ConnectionConfigSchema
|
Package schema provides types used to define the plugin.ConnectionConfigSchema |
|
transform
Package transform defines functions that modify plugin.Column values.
|
Package transform defines functions that modify plugin.Column values. |
|
Package query_cache is a cache used to store query results.
|
Package query_cache is a cache used to store query results. |
|
Package telemetry provides Open Telemetry support.
|
Package telemetry provides Open Telemetry support. |
|
Package version defines the SDK version
|
Package version defines the SDK version |
Click to show internal directories.
Click to hide internal directories.