Documentation
¶
Index ¶
- Constants
- func FindPluginFolder(remoteSchema string) (string, error)
- func GetPluginManager() (pluginshared.PluginManager, error)
- func GetPluginPath(plugin, pluginShortName string) (string, error)
- func PluginFQNToSchemaName(pluginFQN string) string
- func StartNewInstance(steampipeExecutablePath string) error
- func Stop() error
- type LegacyPluginManagerState
- type PluginManager
- type PluginManagerClient
- type PluginManagerState
Constants ¶
const PluginManagerStructVersion = 20220411
Variables ¶
This section is empty.
Functions ¶
func FindPluginFolder ¶ added in v0.11.1
FindPluginFolder searches for a folder which when hashed would match the schema
func GetPluginManager ¶ added in v0.11.1
func GetPluginManager() (pluginshared.PluginManager, error)
GetPluginManager connects to a running plugin manager
func GetPluginPath ¶ added in v0.11.1
func PluginFQNToSchemaName ¶ added in v0.11.1
PluginFQNToSchemaName convert a full plugin name to a schema name schemas in postgres are limited to 63 chars - the name may be longer than this, in which case trim the length and add a hash to the end to make unique
func StartNewInstance ¶ added in v0.11.1
StartNewInstance loads the plugin manager state, stops any previous instance and instantiates a new plugin manager
Types ¶
type LegacyPluginManagerState ¶
type LegacyPluginManagerState struct {
Protocol plugin.Protocol
ProtocolVersion int
Addr *pb.SimpleAddr
Pid int
// path to the steampipe executable
Executable string
// is the plugin manager running
Running bool `json:"-"`
}
LegacyPluginManagerState is a struct used to migrate the PluginManagerState to serialize with snake case property names(migrated in v0.14.0)
type PluginManager ¶ added in v0.11.1
type PluginManager struct {
pb.UnimplementedPluginManagerServer
Plugins map[string]*runningPlugin
// contains filtered or unexported fields
}
PluginManager is the real implementation of grpc.PluginManager
func NewPluginManager ¶ added in v0.11.1
func NewPluginManager(connectionConfig map[string]*pb.ConnectionConfig, logger hclog.Logger) *PluginManager
func (*PluginManager) Get ¶ added in v0.11.1
func (m *PluginManager) Get(req *pb.GetRequest) (*pb.GetResponse, error)
func (*PluginManager) Serve ¶ added in v0.11.1
func (m *PluginManager) Serve()
func (*PluginManager) SetConnectionConfigMap ¶ added in v0.11.1
func (m *PluginManager) SetConnectionConfigMap(configMap map[string]*pb.ConnectionConfig)
func (*PluginManager) Shutdown ¶ added in v0.11.1
func (m *PluginManager) Shutdown(req *pb.ShutdownRequest) (resp *pb.ShutdownResponse, err error)
type PluginManagerClient ¶ added in v0.11.1
type PluginManagerClient struct {
// contains filtered or unexported fields
}
PluginManagerClient is the client used by steampipe to access the plugin manager
func NewPluginManagerClient ¶ added in v0.11.1
func NewPluginManagerClient(pluginManagerState *PluginManagerState) (*PluginManagerClient, error)
func (*PluginManagerClient) Get ¶ added in v0.11.1
func (c *PluginManagerClient) Get(req *pb.GetRequest) (res *pb.GetResponse, err error)
func (*PluginManagerClient) Shutdown ¶ added in v0.11.1
func (c *PluginManagerClient) Shutdown(req *pb.ShutdownRequest) (res *pb.ShutdownResponse, err error)
type PluginManagerState ¶ added in v0.11.1
type PluginManagerState struct {
Protocol plugin.Protocol `json:"protocol"`
ProtocolVersion int `json:"protocol_version"`
Addr *pb.SimpleAddr `json:"addr"`
Pid int `json:"pid"`
// path to the steampipe executable
Executable string `json:"executable"`
// is the plugin manager running
Running bool `json:"-"`
StructVersion int64 `json:"struct_version"`
}
func LoadPluginManagerState ¶ added in v0.11.1
func LoadPluginManagerState() (*PluginManagerState, error)
func NewPluginManagerState ¶ added in v0.11.1
func NewPluginManagerState(executable string, reattach *plugin.ReattachConfig) *PluginManagerState
func (PluginManagerState) IsValid ¶
func (s PluginManagerState) IsValid() bool
IsValid checks whether the struct was correctly deserialized, by checking if the StructVersion is populated
func (*PluginManagerState) MigrateFrom ¶
func (s *PluginManagerState) MigrateFrom(prev interface{}) migrate.Migrateable
func (*PluginManagerState) Save ¶ added in v0.11.1
func (s *PluginManagerState) Save() error