Documentation
¶
Index ¶
- Constants
- Variables
- func NewFactory(b bus.Bus) controller.Factory
- type Config
- func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage
- func (m *Config) CloneVT() *Config
- func (this *Config) EqualMessageVT(thatMsg any) bool
- func (this *Config) EqualVT(that *Config) bool
- func (c *Config) EqualsConfig(other config.Config) bool
- func (c *Config) GetConfigID() string
- func (x *Config) MarshalJSON() ([]byte, error)
- func (x *Config) MarshalProtoJSON(s *json.MarshalState)
- func (x *Config) MarshalProtoText() string
- func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Config) MarshalToVT(dAtA []byte) (int, error)
- func (m *Config) MarshalVT() (dAtA []byte, err error)
- func (*Config) ProtoMessage()
- func (x *Config) Reset()
- func (m *Config) SizeVT() (n int)
- func (x *Config) String() string
- func (x *Config) UnmarshalJSON(b []byte) error
- func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)
- func (m *Config) UnmarshalVT(dAtA []byte) error
- func (c *Config) Validate() error
- type Controller
- type SQLHandler
- func (h *SQLHandler) ApplyWorldObjectOp(ctx context.Context, req *s4wave_worldop_registry.ApplyWorldObjectOpRequest) (*s4wave_worldop_registry.ApplyWorldObjectOpResponse, error)
- func (h *SQLHandler) ApplyWorldOp(ctx context.Context, req *s4wave_worldop_registry.ApplyWorldOpRequest) (*s4wave_worldop_registry.ApplyWorldOpResponse, error)
- func (h *SQLHandler) InvokeObjectType(ctx context.Context, req *s4wave_objecttype_registry.InvokeObjectTypeRequest) (*s4wave_objecttype_registry.InvokeObjectTypeResponse, error)
- func (h *SQLHandler) SeedQuickstart(ctx context.Context, req *s4wave_quickstart_registry.SeedQuickstartRequest) (*s4wave_quickstart_registry.SeedQuickstartResponse, error)
- func (h *SQLHandler) ValidateOp(ctx context.Context, req *s4wave_worldop_registry.ValidateOpRequest) (*s4wave_worldop_registry.ValidateOpResponse, error)
Constants ¶
const ConfigID = ControllerID
ConfigID is the config identifier.
const ControllerID = "plugin/sql"
ControllerID is the controller identifier.
const PluginID = "spacewave-sql"
PluginID is the manifest id for the SQL plugin.
const SQLQuickstartID = "sql"
SQLQuickstartID is the app-visible SQL quickstart id.
Variables ¶
var Version = controller.MustParseVersion("0.0.1")
Version is the component version.
Functions ¶
func NewFactory ¶
func NewFactory(b bus.Bus) controller.Factory
NewFactory constructs the component factory.
Types ¶
type Config ¶
type Config struct {
// contains filtered or unexported fields
}
Config carries the SQL plugin controller configuration.
func (*Config) CloneMessageVT ¶
func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage
func (*Config) EqualMessageVT ¶
func (*Config) EqualsConfig ¶
EqualsConfig checks if the config is equal to another.
func (*Config) GetConfigID ¶
GetConfigID returns the unique string for this configuration type.
func (*Config) MarshalJSON ¶
MarshalJSON marshals the Config to JSON.
func (*Config) MarshalProtoJSON ¶
func (x *Config) MarshalProtoJSON(s *json.MarshalState)
MarshalProtoJSON marshals the Config message to JSON.
func (*Config) MarshalProtoText ¶
func (*Config) MarshalToSizedBufferVT ¶
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) UnmarshalJSON ¶
UnmarshalJSON unmarshals the Config from JSON.
func (*Config) UnmarshalProtoJSON ¶
func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)
UnmarshalProtoJSON unmarshals the Config message from JSON.
func (*Config) UnmarshalVT ¶
type Controller ¶
type Controller struct {
*bus.BusController[*Config]
// contains filtered or unexported fields
}
Controller registers SQL domain handlers and serves them as a plugin resource.
func (*Controller) Execute ¶
func (c *Controller) Execute(ctx context.Context) error
Execute registers SQL ObjectTypes, WorldOps, viewers, and Quickstart metadata.
func (*Controller) HandleDirective ¶
func (c *Controller) HandleDirective(ctx context.Context, di directive.Instance) ([]directive.Resolver, error)
HandleDirective asks if the handler can resolve the directive.
type SQLHandler ¶
type SQLHandler struct {
// contains filtered or unexported fields
}
SQLHandler serves SQL plugin ObjectType, WorldOp, and Quickstart RPCs.
func (*SQLHandler) ApplyWorldObjectOp ¶
func (h *SQLHandler) ApplyWorldObjectOp( ctx context.Context, req *s4wave_worldop_registry.ApplyWorldObjectOpRequest, ) (*s4wave_worldop_registry.ApplyWorldObjectOpResponse, error)
ApplyWorldObjectOp applies a SQL operation through the attached ObjectState.
func (*SQLHandler) ApplyWorldOp ¶
func (h *SQLHandler) ApplyWorldOp( ctx context.Context, req *s4wave_worldop_registry.ApplyWorldOpRequest, ) (*s4wave_worldop_registry.ApplyWorldOpResponse, error)
ApplyWorldOp applies a SQL world operation through the attached WorldState.
func (*SQLHandler) InvokeObjectType ¶
func (h *SQLHandler) InvokeObjectType( ctx context.Context, req *s4wave_objecttype_registry.InvokeObjectTypeRequest, ) (*s4wave_objecttype_registry.InvokeObjectTypeResponse, error)
InvokeObjectType opens a SQL ObjectType resource through the attached Engine.
func (*SQLHandler) SeedQuickstart ¶
func (h *SQLHandler) SeedQuickstart( ctx context.Context, req *s4wave_quickstart_registry.SeedQuickstartRequest, ) (*s4wave_quickstart_registry.SeedQuickstartResponse, error)
SeedQuickstart seeds the SQL quickstart in the attached Space world.
func (*SQLHandler) ValidateOp ¶
func (h *SQLHandler) ValidateOp( ctx context.Context, req *s4wave_worldop_registry.ValidateOpRequest, ) (*s4wave_worldop_registry.ValidateOpResponse, error)
ValidateOp validates a SQL operation payload.
Source Files