grpc

Documentation

Index

• Constants
• func BuildCallId() string
• func GetQualValue(v *proto.QualValue) interface{}
• func HandleGrpcError(err error, connection, call string) error
• func IsGRPCConnectivityError(err error) bool
• func QualEquals(left *proto.Qual, right *proto.Qual) bool
• func QualMapToString(qualMap map[string]*proto.Quals) interface{}
• func QualToString(q *proto.Qual) string
• type ExecuteFunc
• type GetSchemaFunc
• type PluginClient
  • func NewPluginClient(reattach *plugin.ReattachConfig, pluginName string) (*PluginClient, error)
  • func (c *PluginClient) Execute(req *proto.ExecuteRequest) (str proto.WrapperPlugin_ExecuteClient, ctx context.Context, ...)
  • func (c *PluginClient) Exited() bool
  • func (c *PluginClient) GetSchema() (*proto.Schema, error)
  • func (c *PluginClient) GetSupportedOperations() (*proto.GetSupportedOperationsResponse, error)
  • func (c *PluginClient) SetConnectionConfig(req *proto.SetConnectionConfigRequest) error
• type PluginSchema
• type PluginServer
  • func NewPluginServer(pluginName string, setConnectionConfigFunc SetConnectionConfigFunc, ...) *PluginServer
  • func (s PluginServer) Execute(req *proto.ExecuteRequest, stream proto.WrapperPlugin_ExecuteServer) (err error)
  • func (s PluginServer) GetSchema(_ *proto.GetSchemaRequest) (res *proto.GetSchemaResponse, err error)
  • func (s PluginServer) GetSupportedOperations(*proto.GetSupportedOperationsRequest) (*proto.GetSupportedOperationsResponse, error)
  • func (s PluginServer) Serve()
  • func (s PluginServer) SetConnectionConfig(req *proto.SetConnectionConfigRequest) (res *proto.SetConnectionConfigResponse, err error)
• type SetConnectionConfigFunc

Constants

const (
	IPv4 = "IPv4"
	IPv6 = "IPv6"
)

Functions

func BuildCallId

func BuildCallId() string

BuildCallId generates a unique id based on the current time this can be passed into plugin calls to assist with tracking parallel calls

func GetQualValue

func GetQualValue(v *proto.QualValue) interface{}

func HandleGrpcError

func HandleGrpcError(err error, connection, call string) error

func IsGRPCConnectivityError

func IsGRPCConnectivityError(err error) bool

func QualEquals

func QualEquals(left *proto.Qual, right *proto.Qual) bool

func QualMapToString

func QualMapToString(qualMap map[string]*proto.Quals) interface{}

func QualToString

func QualToString(q *proto.Qual) string

Types

type ExecuteFunc

type ExecuteFunc func(req *proto.ExecuteRequest, stream proto.WrapperPlugin_ExecuteServer) error

type GetSchemaFunc

type GetSchemaFunc func() (*PluginSchema, error)

type PluginClient

type PluginClient struct {
	Name string
	Stub pluginshared.WrapperPluginClient
	Pid  int
	// contains filtered or unexported fields
}

PluginClient is the client object used by clients of the plugin

func NewPluginClient

func NewPluginClient(reattach *plugin.ReattachConfig, pluginName string) (*PluginClient, error)

func (*PluginClient) Execute

func (c *PluginClient) Execute(req *proto.ExecuteRequest) (str proto.WrapperPlugin_ExecuteClient, ctx context.Context, cancel context.CancelFunc, err error)

func (*PluginClient) Exited

func (c *PluginClient) Exited() bool

Exited returned whether the underlying client has exited, i.e. th eplugin has terminated

func (*PluginClient) GetSchema

func (c *PluginClient) GetSchema() (*proto.Schema, error)

func (*PluginClient) GetSupportedOperations

func (c *PluginClient) GetSupportedOperations() (*proto.GetSupportedOperationsResponse, error)

func (*PluginClient) SetConnectionConfig

func (c *PluginClient) SetConnectionConfig(req *proto.SetConnectionConfigRequest) error

type PluginSchema

type PluginSchema struct {
	Schema map[string]*proto.TableSchema
	Mode   string
}

type PluginServer

type PluginServer struct {
	proto.UnimplementedWrapperPluginServer
	// contains filtered or unexported fields
}

PluginServer is the server for a single plugin

func NewPluginServer

func NewPluginServer(pluginName string, setConnectionConfigFunc SetConnectionConfigFunc, getSchemaFunc GetSchemaFunc, executeFunc ExecuteFunc) *PluginServer

func (PluginServer) Execute

func (s PluginServer) Execute(req *proto.ExecuteRequest, stream proto.WrapperPlugin_ExecuteServer) (err error)

func (PluginServer) GetSchema

func (s PluginServer) GetSchema(_ *proto.GetSchemaRequest) (res *proto.GetSchemaResponse, err error)

func (PluginServer) GetSupportedOperations

func (s PluginServer) GetSupportedOperations(*proto.GetSupportedOperationsRequest) (*proto.GetSupportedOperationsResponse, error)

func (PluginServer) Serve

func (s PluginServer) Serve()

func (PluginServer) SetConnectionConfig

func (s PluginServer) SetConnectionConfig(req *proto.SetConnectionConfigRequest) (res *proto.SetConnectionConfigResponse, err error)

type SetConnectionConfigFunc

type SetConnectionConfigFunc func(string, string) error