s4wave_sql_workbench

package
v0.54.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 9, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source
const SRPCSqlWorkbenchResourceServiceServiceID = "s4wave.sql.workbench.SqlWorkbenchResourceService"
View Source
const SqlWorkbenchBlockTypeID = "github.com/s4wave/spacewave/sdk/sql/workbench.Workbench"

SqlWorkbenchBlockTypeID is the block type id for SQL workbench roots.

View Source
const SqlWorkbenchTypeID = "sql/workbench"

SqlWorkbenchTypeID is the world ObjectType id for SQL workbenches.

Variables

View Source
var (
	WorkbenchTabKind_name = map[int32]string{
		0: "WORKBENCH_TAB_KIND_UNSPECIFIED",
		1: "WORKBENCH_TAB_KIND_QUERY",
		2: "WORKBENCH_TAB_KIND_QUERY_RESULT",
	}
	WorkbenchTabKind_value = map[string]int32{
		"WORKBENCH_TAB_KIND_UNSPECIFIED":  0,
		"WORKBENCH_TAB_KIND_QUERY":        1,
		"WORKBENCH_TAB_KIND_QUERY_RESULT": 2,
	}
)

Enum value maps for WorkbenchTabKind.

View Source
var SqlWorkbenchBlockType = blocktype.NewBlockType(
	SqlWorkbenchBlockTypeID,
	func() *Workbench { return &Workbench{} },
)

SqlWorkbenchBlockType constructs SQL workbench root blocks for typed cursor writes.

Functions

func NewSRPCSqlWorkbenchResourceServiceHandler

func NewSRPCSqlWorkbenchResourceServiceHandler(impl SRPCSqlWorkbenchResourceServiceServer, serviceID string) srpc.Handler

NewSRPCSqlWorkbenchResourceServiceHandler constructs a new RPC handler. serviceID: if empty, uses default: s4wave.sql.workbench.SqlWorkbenchResourceService

func NewWorkbenchBlock

func NewWorkbenchBlock() block.Block

NewWorkbenchBlock constructs a SQL workbench block.

func SRPCRegisterSqlWorkbenchResourceService

func SRPCRegisterSqlWorkbenchResourceService(mux srpc.Mux, impl SRPCSqlWorkbenchResourceServiceServer) error

SRPCRegisterSqlWorkbenchResourceService registers the implementation with the mux. Uses the default serviceID: s4wave.sql.workbench.SqlWorkbenchResourceService

func SyncWorkbenchGraphQuads

func SyncWorkbenchGraphQuads(ctx context.Context, ws world.WorldState, objectKey string) error

SyncWorkbenchGraphQuads replaces the workbench's SQL graph links.

func WriteWorkbenchRootRef

func WriteWorkbenchRootRef(ctx context.Context, ws world.WorldState, workbench *Workbench) (*bucket.ObjectRef, error)

WriteWorkbenchRootRef writes a SQL workbench root block and returns its ref.

Types

type AddPinRequest

type AddPinRequest struct {

	// QueryObjectKey is the sql/query object to pin.
	QueryObjectKey string `protobuf:"bytes,1,opt,name=query_object_key,json=queryObjectKey,proto3" json:"queryObjectKey,omitempty"`
	// contains filtered or unexported fields
}

AddPinRequest pins a sql/query object.

func (*AddPinRequest) CloneMessageVT

func (m *AddPinRequest) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*AddPinRequest) CloneVT

func (m *AddPinRequest) CloneVT() *AddPinRequest

func (*AddPinRequest) EqualMessageVT

func (this *AddPinRequest) EqualMessageVT(thatMsg any) bool

func (*AddPinRequest) EqualVT

func (this *AddPinRequest) EqualVT(that *AddPinRequest) bool

func (*AddPinRequest) GetQueryObjectKey

func (x *AddPinRequest) GetQueryObjectKey() string

func (*AddPinRequest) MarshalJSON

func (x *AddPinRequest) MarshalJSON() ([]byte, error)

MarshalJSON marshals the AddPinRequest to JSON.

func (*AddPinRequest) MarshalProtoJSON

func (x *AddPinRequest) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the AddPinRequest message to JSON.

func (*AddPinRequest) MarshalProtoText

func (x *AddPinRequest) MarshalProtoText() string

func (*AddPinRequest) MarshalToSizedBufferVT

func (m *AddPinRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*AddPinRequest) MarshalToVT

func (m *AddPinRequest) MarshalToVT(dAtA []byte) (int, error)

func (*AddPinRequest) MarshalVT

func (m *AddPinRequest) MarshalVT() (dAtA []byte, err error)

func (*AddPinRequest) ProtoMessage

func (*AddPinRequest) ProtoMessage()

func (*AddPinRequest) Reset

func (x *AddPinRequest) Reset()

func (*AddPinRequest) SizeVT

func (m *AddPinRequest) SizeVT() (n int)

func (*AddPinRequest) String

func (x *AddPinRequest) String() string

func (*AddPinRequest) UnmarshalJSON

func (x *AddPinRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the AddPinRequest from JSON.

func (*AddPinRequest) UnmarshalProtoJSON

func (x *AddPinRequest) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the AddPinRequest message from JSON.

func (*AddPinRequest) UnmarshalVT

func (m *AddPinRequest) UnmarshalVT(dAtA []byte) error

type AddPinResponse

type AddPinResponse struct {
	// contains filtered or unexported fields
}

AddPinResponse is returned after adding a pin.

func (*AddPinResponse) CloneMessageVT

func (m *AddPinResponse) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*AddPinResponse) CloneVT

func (m *AddPinResponse) CloneVT() *AddPinResponse

func (*AddPinResponse) EqualMessageVT

func (this *AddPinResponse) EqualMessageVT(thatMsg any) bool

func (*AddPinResponse) EqualVT

func (this *AddPinResponse) EqualVT(that *AddPinResponse) bool

func (*AddPinResponse) MarshalJSON

func (x *AddPinResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals the AddPinResponse to JSON.

func (*AddPinResponse) MarshalProtoJSON

func (x *AddPinResponse) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the AddPinResponse message to JSON.

func (*AddPinResponse) MarshalProtoText

func (x *AddPinResponse) MarshalProtoText() string

func (*AddPinResponse) MarshalToSizedBufferVT

func (m *AddPinResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*AddPinResponse) MarshalToVT

func (m *AddPinResponse) MarshalToVT(dAtA []byte) (int, error)

func (*AddPinResponse) MarshalVT

func (m *AddPinResponse) MarshalVT() (dAtA []byte, err error)

func (*AddPinResponse) ProtoMessage

func (*AddPinResponse) ProtoMessage()

func (*AddPinResponse) Reset

func (x *AddPinResponse) Reset()

func (*AddPinResponse) SizeVT

func (m *AddPinResponse) SizeVT() (n int)

func (*AddPinResponse) String

func (x *AddPinResponse) String() string

func (*AddPinResponse) UnmarshalJSON

func (x *AddPinResponse) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the AddPinResponse from JSON.

func (*AddPinResponse) UnmarshalProtoJSON

func (x *AddPinResponse) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the AddPinResponse message from JSON.

func (*AddPinResponse) UnmarshalVT

func (m *AddPinResponse) UnmarshalVT(dAtA []byte) error

type GetWorkbenchRequest

type GetWorkbenchRequest struct {
	// contains filtered or unexported fields
}

GetWorkbenchRequest is a request for workbench state.

func (*GetWorkbenchRequest) CloneMessageVT

func (*GetWorkbenchRequest) CloneVT

func (*GetWorkbenchRequest) EqualMessageVT

func (this *GetWorkbenchRequest) EqualMessageVT(thatMsg any) bool

func (*GetWorkbenchRequest) EqualVT

func (this *GetWorkbenchRequest) EqualVT(that *GetWorkbenchRequest) bool

func (*GetWorkbenchRequest) MarshalJSON

func (x *GetWorkbenchRequest) MarshalJSON() ([]byte, error)

MarshalJSON marshals the GetWorkbenchRequest to JSON.

func (*GetWorkbenchRequest) MarshalProtoJSON

func (x *GetWorkbenchRequest) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the GetWorkbenchRequest message to JSON.

func (*GetWorkbenchRequest) MarshalProtoText

func (x *GetWorkbenchRequest) MarshalProtoText() string

func (*GetWorkbenchRequest) MarshalToSizedBufferVT

func (m *GetWorkbenchRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*GetWorkbenchRequest) MarshalToVT

func (m *GetWorkbenchRequest) MarshalToVT(dAtA []byte) (int, error)

func (*GetWorkbenchRequest) MarshalVT

func (m *GetWorkbenchRequest) MarshalVT() (dAtA []byte, err error)

func (*GetWorkbenchRequest) ProtoMessage

func (*GetWorkbenchRequest) ProtoMessage()

func (*GetWorkbenchRequest) Reset

func (x *GetWorkbenchRequest) Reset()

func (*GetWorkbenchRequest) SizeVT

func (m *GetWorkbenchRequest) SizeVT() (n int)

func (*GetWorkbenchRequest) String

func (x *GetWorkbenchRequest) String() string

func (*GetWorkbenchRequest) UnmarshalJSON

func (x *GetWorkbenchRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the GetWorkbenchRequest from JSON.

func (*GetWorkbenchRequest) UnmarshalProtoJSON

func (x *GetWorkbenchRequest) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the GetWorkbenchRequest message from JSON.

func (*GetWorkbenchRequest) UnmarshalVT

func (m *GetWorkbenchRequest) UnmarshalVT(dAtA []byte) error

type GetWorkbenchResponse

type GetWorkbenchResponse struct {

	// Workbench is the persisted workbench block.
	Workbench *Workbench `protobuf:"bytes,1,opt,name=workbench,proto3" json:"workbench,omitempty"`
	// contains filtered or unexported fields
}

GetWorkbenchResponse contains workbench state.

func (*GetWorkbenchResponse) CloneMessageVT

func (*GetWorkbenchResponse) CloneVT

func (*GetWorkbenchResponse) EqualMessageVT

func (this *GetWorkbenchResponse) EqualMessageVT(thatMsg any) bool

func (*GetWorkbenchResponse) EqualVT

func (this *GetWorkbenchResponse) EqualVT(that *GetWorkbenchResponse) bool

func (*GetWorkbenchResponse) GetWorkbench

func (x *GetWorkbenchResponse) GetWorkbench() *Workbench

func (*GetWorkbenchResponse) MarshalJSON

func (x *GetWorkbenchResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals the GetWorkbenchResponse to JSON.

func (*GetWorkbenchResponse) MarshalProtoJSON

func (x *GetWorkbenchResponse) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the GetWorkbenchResponse message to JSON.

func (*GetWorkbenchResponse) MarshalProtoText

func (x *GetWorkbenchResponse) MarshalProtoText() string

func (*GetWorkbenchResponse) MarshalToSizedBufferVT

func (m *GetWorkbenchResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*GetWorkbenchResponse) MarshalToVT

func (m *GetWorkbenchResponse) MarshalToVT(dAtA []byte) (int, error)

func (*GetWorkbenchResponse) MarshalVT

func (m *GetWorkbenchResponse) MarshalVT() (dAtA []byte, err error)

func (*GetWorkbenchResponse) ProtoMessage

func (*GetWorkbenchResponse) ProtoMessage()

func (*GetWorkbenchResponse) Reset

func (x *GetWorkbenchResponse) Reset()

func (*GetWorkbenchResponse) SizeVT

func (m *GetWorkbenchResponse) SizeVT() (n int)

func (*GetWorkbenchResponse) String

func (x *GetWorkbenchResponse) String() string

func (*GetWorkbenchResponse) UnmarshalJSON

func (x *GetWorkbenchResponse) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the GetWorkbenchResponse from JSON.

func (*GetWorkbenchResponse) UnmarshalProtoJSON

func (x *GetWorkbenchResponse) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the GetWorkbenchResponse message from JSON.

func (*GetWorkbenchResponse) UnmarshalVT

func (m *GetWorkbenchResponse) UnmarshalVT(dAtA []byte) error

type RemovePinRequest

type RemovePinRequest struct {

	// QueryObjectKey is the sql/query object to unpin.
	QueryObjectKey string `protobuf:"bytes,1,opt,name=query_object_key,json=queryObjectKey,proto3" json:"queryObjectKey,omitempty"`
	// contains filtered or unexported fields
}

RemovePinRequest removes a pinned sql/query object.

func (*RemovePinRequest) CloneMessageVT

func (m *RemovePinRequest) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*RemovePinRequest) CloneVT

func (m *RemovePinRequest) CloneVT() *RemovePinRequest

func (*RemovePinRequest) EqualMessageVT

func (this *RemovePinRequest) EqualMessageVT(thatMsg any) bool

func (*RemovePinRequest) EqualVT

func (this *RemovePinRequest) EqualVT(that *RemovePinRequest) bool

func (*RemovePinRequest) GetQueryObjectKey

func (x *RemovePinRequest) GetQueryObjectKey() string

func (*RemovePinRequest) MarshalJSON

func (x *RemovePinRequest) MarshalJSON() ([]byte, error)

MarshalJSON marshals the RemovePinRequest to JSON.

func (*RemovePinRequest) MarshalProtoJSON

func (x *RemovePinRequest) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the RemovePinRequest message to JSON.

func (*RemovePinRequest) MarshalProtoText

func (x *RemovePinRequest) MarshalProtoText() string

func (*RemovePinRequest) MarshalToSizedBufferVT

func (m *RemovePinRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*RemovePinRequest) MarshalToVT

func (m *RemovePinRequest) MarshalToVT(dAtA []byte) (int, error)

func (*RemovePinRequest) MarshalVT

func (m *RemovePinRequest) MarshalVT() (dAtA []byte, err error)

func (*RemovePinRequest) ProtoMessage

func (*RemovePinRequest) ProtoMessage()

func (*RemovePinRequest) Reset

func (x *RemovePinRequest) Reset()

func (*RemovePinRequest) SizeVT

func (m *RemovePinRequest) SizeVT() (n int)

func (*RemovePinRequest) String

func (x *RemovePinRequest) String() string

func (*RemovePinRequest) UnmarshalJSON

func (x *RemovePinRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the RemovePinRequest from JSON.

func (*RemovePinRequest) UnmarshalProtoJSON

func (x *RemovePinRequest) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the RemovePinRequest message from JSON.

func (*RemovePinRequest) UnmarshalVT

func (m *RemovePinRequest) UnmarshalVT(dAtA []byte) error

type RemovePinResponse

type RemovePinResponse struct {
	// contains filtered or unexported fields
}

RemovePinResponse is returned after removing a pin.

func (*RemovePinResponse) CloneMessageVT

func (m *RemovePinResponse) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*RemovePinResponse) CloneVT

func (m *RemovePinResponse) CloneVT() *RemovePinResponse

func (*RemovePinResponse) EqualMessageVT

func (this *RemovePinResponse) EqualMessageVT(thatMsg any) bool

func (*RemovePinResponse) EqualVT

func (this *RemovePinResponse) EqualVT(that *RemovePinResponse) bool

func (*RemovePinResponse) MarshalJSON

func (x *RemovePinResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals the RemovePinResponse to JSON.

func (*RemovePinResponse) MarshalProtoJSON

func (x *RemovePinResponse) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the RemovePinResponse message to JSON.

func (*RemovePinResponse) MarshalProtoText

func (x *RemovePinResponse) MarshalProtoText() string

func (*RemovePinResponse) MarshalToSizedBufferVT

func (m *RemovePinResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*RemovePinResponse) MarshalToVT

func (m *RemovePinResponse) MarshalToVT(dAtA []byte) (int, error)

func (*RemovePinResponse) MarshalVT

func (m *RemovePinResponse) MarshalVT() (dAtA []byte, err error)

func (*RemovePinResponse) ProtoMessage

func (*RemovePinResponse) ProtoMessage()

func (*RemovePinResponse) Reset

func (x *RemovePinResponse) Reset()

func (*RemovePinResponse) SizeVT

func (m *RemovePinResponse) SizeVT() (n int)

func (*RemovePinResponse) String

func (x *RemovePinResponse) String() string

func (*RemovePinResponse) UnmarshalJSON

func (x *RemovePinResponse) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the RemovePinResponse from JSON.

func (*RemovePinResponse) UnmarshalProtoJSON

func (x *RemovePinResponse) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the RemovePinResponse message from JSON.

func (*RemovePinResponse) UnmarshalVT

func (m *RemovePinResponse) UnmarshalVT(dAtA []byte) error

type SRPCSqlWorkbenchResourceServiceClient

type SRPCSqlWorkbenchResourceServiceClient interface {
	// SRPCClient returns the underlying SRPC client.
	SRPCClient() srpc.Client

	// GetWorkbench returns the persisted workbench state.
	GetWorkbench(ctx context.Context, in *GetWorkbenchRequest) (*GetWorkbenchResponse, error)
	// AddPin pins a sql/query object.
	AddPin(ctx context.Context, in *AddPinRequest) (*AddPinResponse, error)
	// RemovePin removes a pinned sql/query object.
	RemovePin(ctx context.Context, in *RemovePinRequest) (*RemovePinResponse, error)
	// SetLayout replaces the open tabs and layout preferences.
	SetLayout(ctx context.Context, in *SetLayoutRequest) (*SetLayoutResponse, error)
}

func NewSRPCSqlWorkbenchResourceServiceClient

func NewSRPCSqlWorkbenchResourceServiceClient(cc srpc.Client) SRPCSqlWorkbenchResourceServiceClient

func NewSRPCSqlWorkbenchResourceServiceClientWithServiceID

func NewSRPCSqlWorkbenchResourceServiceClientWithServiceID(cc srpc.Client, serviceID string) SRPCSqlWorkbenchResourceServiceClient

type SRPCSqlWorkbenchResourceServiceHandler

type SRPCSqlWorkbenchResourceServiceHandler struct {
	// contains filtered or unexported fields
}

func (SRPCSqlWorkbenchResourceServiceHandler) GetMethodIDs

func (*SRPCSqlWorkbenchResourceServiceHandler) GetServiceID

func (*SRPCSqlWorkbenchResourceServiceHandler) InvokeMethod

func (d *SRPCSqlWorkbenchResourceServiceHandler) InvokeMethod(
	serviceID, methodID string,
	strm srpc.Stream,
) (bool, error)

func (SRPCSqlWorkbenchResourceServiceHandler) InvokeMethod_AddPin

func (SRPCSqlWorkbenchResourceServiceHandler) InvokeMethod_GetWorkbench

func (SRPCSqlWorkbenchResourceServiceHandler) InvokeMethod_RemovePin

func (SRPCSqlWorkbenchResourceServiceHandler) InvokeMethod_SetLayout

type SRPCSqlWorkbenchResourceServiceServer

type SRPCSqlWorkbenchResourceServiceServer interface {
	// GetWorkbench returns the persisted workbench state.
	GetWorkbench(context.Context, *GetWorkbenchRequest) (*GetWorkbenchResponse, error)
	// AddPin pins a sql/query object.
	AddPin(context.Context, *AddPinRequest) (*AddPinResponse, error)
	// RemovePin removes a pinned sql/query object.
	RemovePin(context.Context, *RemovePinRequest) (*RemovePinResponse, error)
	// SetLayout replaces the open tabs and layout preferences.
	SetLayout(context.Context, *SetLayoutRequest) (*SetLayoutResponse, error)
}

type SRPCSqlWorkbenchResourceService_AddPinStream

type SRPCSqlWorkbenchResourceService_AddPinStream interface {
	srpc.Stream
}

type SRPCSqlWorkbenchResourceService_GetWorkbenchStream

type SRPCSqlWorkbenchResourceService_GetWorkbenchStream interface {
	srpc.Stream
}

type SRPCSqlWorkbenchResourceService_RemovePinStream

type SRPCSqlWorkbenchResourceService_RemovePinStream interface {
	srpc.Stream
}

type SRPCSqlWorkbenchResourceService_SetLayoutStream

type SRPCSqlWorkbenchResourceService_SetLayoutStream interface {
	srpc.Stream
}

type SetLayoutRequest

type SetLayoutRequest struct {

	// OpenTabs are persisted query/result tabs in display order.
	OpenTabs []*WorkbenchTab `protobuf:"bytes,1,rep,name=open_tabs,json=openTabs,proto3" json:"openTabs,omitempty"`
	// Layout stores user preferences for the workbench frame.
	Layout *WorkbenchLayout `protobuf:"bytes,2,opt,name=layout,proto3" json:"layout,omitempty"`
	// contains filtered or unexported fields
}

SetLayoutRequest replaces the open tabs and layout preferences.

func (*SetLayoutRequest) CloneMessageVT

func (m *SetLayoutRequest) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*SetLayoutRequest) CloneVT

func (m *SetLayoutRequest) CloneVT() *SetLayoutRequest

func (*SetLayoutRequest) EqualMessageVT

func (this *SetLayoutRequest) EqualMessageVT(thatMsg any) bool

func (*SetLayoutRequest) EqualVT

func (this *SetLayoutRequest) EqualVT(that *SetLayoutRequest) bool

func (*SetLayoutRequest) GetLayout

func (x *SetLayoutRequest) GetLayout() *WorkbenchLayout

func (*SetLayoutRequest) GetOpenTabs

func (x *SetLayoutRequest) GetOpenTabs() []*WorkbenchTab

func (*SetLayoutRequest) MarshalJSON

func (x *SetLayoutRequest) MarshalJSON() ([]byte, error)

MarshalJSON marshals the SetLayoutRequest to JSON.

func (*SetLayoutRequest) MarshalProtoJSON

func (x *SetLayoutRequest) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the SetLayoutRequest message to JSON.

func (*SetLayoutRequest) MarshalProtoText

func (x *SetLayoutRequest) MarshalProtoText() string

func (*SetLayoutRequest) MarshalToSizedBufferVT

func (m *SetLayoutRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*SetLayoutRequest) MarshalToVT

func (m *SetLayoutRequest) MarshalToVT(dAtA []byte) (int, error)

func (*SetLayoutRequest) MarshalVT

func (m *SetLayoutRequest) MarshalVT() (dAtA []byte, err error)

func (*SetLayoutRequest) ProtoMessage

func (*SetLayoutRequest) ProtoMessage()

func (*SetLayoutRequest) Reset

func (x *SetLayoutRequest) Reset()

func (*SetLayoutRequest) SizeVT

func (m *SetLayoutRequest) SizeVT() (n int)

func (*SetLayoutRequest) String

func (x *SetLayoutRequest) String() string

func (*SetLayoutRequest) UnmarshalJSON

func (x *SetLayoutRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the SetLayoutRequest from JSON.

func (*SetLayoutRequest) UnmarshalProtoJSON

func (x *SetLayoutRequest) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the SetLayoutRequest message from JSON.

func (*SetLayoutRequest) UnmarshalVT

func (m *SetLayoutRequest) UnmarshalVT(dAtA []byte) error

type SetLayoutResponse

type SetLayoutResponse struct {
	// contains filtered or unexported fields
}

SetLayoutResponse is returned after updating layout state.

func (*SetLayoutResponse) CloneMessageVT

func (m *SetLayoutResponse) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*SetLayoutResponse) CloneVT

func (m *SetLayoutResponse) CloneVT() *SetLayoutResponse

func (*SetLayoutResponse) EqualMessageVT

func (this *SetLayoutResponse) EqualMessageVT(thatMsg any) bool

func (*SetLayoutResponse) EqualVT

func (this *SetLayoutResponse) EqualVT(that *SetLayoutResponse) bool

func (*SetLayoutResponse) MarshalJSON

func (x *SetLayoutResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals the SetLayoutResponse to JSON.

func (*SetLayoutResponse) MarshalProtoJSON

func (x *SetLayoutResponse) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the SetLayoutResponse message to JSON.

func (*SetLayoutResponse) MarshalProtoText

func (x *SetLayoutResponse) MarshalProtoText() string

func (*SetLayoutResponse) MarshalToSizedBufferVT

func (m *SetLayoutResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*SetLayoutResponse) MarshalToVT

func (m *SetLayoutResponse) MarshalToVT(dAtA []byte) (int, error)

func (*SetLayoutResponse) MarshalVT

func (m *SetLayoutResponse) MarshalVT() (dAtA []byte, err error)

func (*SetLayoutResponse) ProtoMessage

func (*SetLayoutResponse) ProtoMessage()

func (*SetLayoutResponse) Reset

func (x *SetLayoutResponse) Reset()

func (*SetLayoutResponse) SizeVT

func (m *SetLayoutResponse) SizeVT() (n int)

func (*SetLayoutResponse) String

func (x *SetLayoutResponse) String() string

func (*SetLayoutResponse) UnmarshalJSON

func (x *SetLayoutResponse) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the SetLayoutResponse from JSON.

func (*SetLayoutResponse) UnmarshalProtoJSON

func (x *SetLayoutResponse) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the SetLayoutResponse message from JSON.

func (*SetLayoutResponse) UnmarshalVT

func (m *SetLayoutResponse) UnmarshalVT(dAtA []byte) error

type Workbench

type Workbench struct {

	// TargetDbObjectKey is the sql/db object this workbench explores.
	TargetDbObjectKey string `protobuf:"bytes,1,opt,name=target_db_object_key,json=targetDbObjectKey,proto3" json:"targetDbObjectKey,omitempty"`
	// PinnedQueryObjectKeys are sql/query objects pinned in the workbench.
	PinnedQueryObjectKeys []string `protobuf:"bytes,2,rep,name=pinned_query_object_keys,json=pinnedQueryObjectKeys,proto3" json:"pinnedQueryObjectKeys,omitempty"`
	// OpenTabs are persisted query/result tabs in display order.
	OpenTabs []*WorkbenchTab `protobuf:"bytes,3,rep,name=open_tabs,json=openTabs,proto3" json:"openTabs,omitempty"`
	// Layout stores user preferences for the workbench frame.
	Layout *WorkbenchLayout `protobuf:"bytes,4,opt,name=layout,proto3" json:"layout,omitempty"`
	// DisplayName is an optional user-facing label.
	DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"displayName,omitempty"`
	// Description is optional user-facing metadata.
	Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Workbench is a persistent SQL exploration workspace.

func ReadWorkbenchObjectRoot

func ReadWorkbenchObjectRoot(ctx context.Context, obj world.ObjectState) (*Workbench, error)

ReadWorkbenchObjectRoot reads a SQL workbench root from an object state.

func ReadWorkbenchRoot

func ReadWorkbenchRoot(ctx context.Context, ws world.WorldState, objectKey string) (*Workbench, error)

ReadWorkbenchRoot reads a SQL workbench object's root.

func (*Workbench) CloneMessageVT

func (m *Workbench) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Workbench) CloneVT

func (m *Workbench) CloneVT() *Workbench

func (*Workbench) EqualMessageVT

func (this *Workbench) EqualMessageVT(thatMsg any) bool

func (*Workbench) EqualVT

func (this *Workbench) EqualVT(that *Workbench) bool

func (*Workbench) GetDescription

func (x *Workbench) GetDescription() string

func (*Workbench) GetDisplayName

func (x *Workbench) GetDisplayName() string

func (*Workbench) GetLayout

func (x *Workbench) GetLayout() *WorkbenchLayout

func (*Workbench) GetOpenTabs

func (x *Workbench) GetOpenTabs() []*WorkbenchTab

func (*Workbench) GetPinnedQueryObjectKeys

func (x *Workbench) GetPinnedQueryObjectKeys() []string

func (*Workbench) GetTargetDbObjectKey

func (x *Workbench) GetTargetDbObjectKey() string

func (*Workbench) MarshalBlock

func (w *Workbench) MarshalBlock() ([]byte, error)

MarshalBlock marshals the SQL workbench root.

func (*Workbench) MarshalJSON

func (x *Workbench) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Workbench to JSON.

func (*Workbench) MarshalProtoJSON

func (x *Workbench) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the Workbench message to JSON.

func (*Workbench) MarshalProtoText

func (x *Workbench) MarshalProtoText() string

func (*Workbench) MarshalToSizedBufferVT

func (m *Workbench) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Workbench) MarshalToVT

func (m *Workbench) MarshalToVT(dAtA []byte) (int, error)

func (*Workbench) MarshalVT

func (m *Workbench) MarshalVT() (dAtA []byte, err error)

func (*Workbench) ProtoMessage

func (*Workbench) ProtoMessage()

func (*Workbench) Reset

func (x *Workbench) Reset()

func (*Workbench) SizeVT

func (m *Workbench) SizeVT() (n int)

func (*Workbench) String

func (x *Workbench) String() string

func (*Workbench) UnmarshalBlock

func (w *Workbench) UnmarshalBlock(data []byte) error

UnmarshalBlock unmarshals the SQL workbench root.

func (*Workbench) UnmarshalJSON

func (x *Workbench) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Workbench from JSON.

func (*Workbench) UnmarshalProtoJSON

func (x *Workbench) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the Workbench message from JSON.

func (*Workbench) UnmarshalVT

func (m *Workbench) UnmarshalVT(dAtA []byte) error

func (*Workbench) Validate

func (w *Workbench) Validate() error

Validate performs cursory checks on the SQL workbench root.

type WorkbenchLayout

type WorkbenchLayout struct {

	// Mode names the viewer layout mode.
	Mode string `protobuf:"bytes,1,opt,name=mode,proto3" json:"mode,omitempty"`
	// SidebarWidth stores the preferred database tree width in pixels.
	SidebarWidth uint32 `protobuf:"varint,2,opt,name=sidebar_width,json=sidebarWidth,proto3" json:"sidebarWidth,omitempty"`
	// ResultPanelHeight stores the preferred result panel height in pixels.
	ResultPanelHeight uint32 `protobuf:"varint,3,opt,name=result_panel_height,json=resultPanelHeight,proto3" json:"resultPanelHeight,omitempty"`
	// ActiveTabId stores the selected tab.
	ActiveTabId string `protobuf:"bytes,4,opt,name=active_tab_id,json=activeTabId,proto3" json:"activeTabId,omitempty"`
	// contains filtered or unexported fields
}

WorkbenchLayout stores layout preferences for the workbench viewer.

func (*WorkbenchLayout) CloneMessageVT

func (m *WorkbenchLayout) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*WorkbenchLayout) CloneVT

func (m *WorkbenchLayout) CloneVT() *WorkbenchLayout

func (*WorkbenchLayout) EqualMessageVT

func (this *WorkbenchLayout) EqualMessageVT(thatMsg any) bool

func (*WorkbenchLayout) EqualVT

func (this *WorkbenchLayout) EqualVT(that *WorkbenchLayout) bool

func (*WorkbenchLayout) GetActiveTabId

func (x *WorkbenchLayout) GetActiveTabId() string

func (*WorkbenchLayout) GetMode

func (x *WorkbenchLayout) GetMode() string

func (*WorkbenchLayout) GetResultPanelHeight

func (x *WorkbenchLayout) GetResultPanelHeight() uint32

func (*WorkbenchLayout) GetSidebarWidth

func (x *WorkbenchLayout) GetSidebarWidth() uint32

func (*WorkbenchLayout) MarshalJSON

func (x *WorkbenchLayout) MarshalJSON() ([]byte, error)

MarshalJSON marshals the WorkbenchLayout to JSON.

func (*WorkbenchLayout) MarshalProtoJSON

func (x *WorkbenchLayout) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the WorkbenchLayout message to JSON.

func (*WorkbenchLayout) MarshalProtoText

func (x *WorkbenchLayout) MarshalProtoText() string

func (*WorkbenchLayout) MarshalToSizedBufferVT

func (m *WorkbenchLayout) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*WorkbenchLayout) MarshalToVT

func (m *WorkbenchLayout) MarshalToVT(dAtA []byte) (int, error)

func (*WorkbenchLayout) MarshalVT

func (m *WorkbenchLayout) MarshalVT() (dAtA []byte, err error)

func (*WorkbenchLayout) ProtoMessage

func (*WorkbenchLayout) ProtoMessage()

func (*WorkbenchLayout) Reset

func (x *WorkbenchLayout) Reset()

func (*WorkbenchLayout) SizeVT

func (m *WorkbenchLayout) SizeVT() (n int)

func (*WorkbenchLayout) String

func (x *WorkbenchLayout) String() string

func (*WorkbenchLayout) UnmarshalJSON

func (x *WorkbenchLayout) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the WorkbenchLayout from JSON.

func (*WorkbenchLayout) UnmarshalProtoJSON

func (x *WorkbenchLayout) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the WorkbenchLayout message from JSON.

func (*WorkbenchLayout) UnmarshalVT

func (m *WorkbenchLayout) UnmarshalVT(dAtA []byte) error

type WorkbenchTab

type WorkbenchTab struct {

	// TabId is the stable tab identifier in the workbench layout.
	TabId string `protobuf:"bytes,1,opt,name=tab_id,json=tabId,proto3" json:"tabId,omitempty"`
	// ObjectKey is the sql/query or sql/query-result object shown by the tab.
	ObjectKey string `protobuf:"bytes,2,opt,name=object_key,json=objectKey,proto3" json:"objectKey,omitempty"`
	// Kind identifies the object type expected for ObjectKey.
	Kind WorkbenchTabKind `protobuf:"varint,3,opt,name=kind,proto3" json:"kind,omitempty"`
	// Title is an optional tab label.
	Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`
	// Pinned keeps the tab open across layout changes.
	Pinned bool `protobuf:"varint,5,opt,name=pinned,proto3" json:"pinned,omitempty"`
	// contains filtered or unexported fields
}

WorkbenchTab describes one persisted workbench tab.

func (*WorkbenchTab) CloneMessageVT

func (m *WorkbenchTab) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*WorkbenchTab) CloneVT

func (m *WorkbenchTab) CloneVT() *WorkbenchTab

func (*WorkbenchTab) EqualMessageVT

func (this *WorkbenchTab) EqualMessageVT(thatMsg any) bool

func (*WorkbenchTab) EqualVT

func (this *WorkbenchTab) EqualVT(that *WorkbenchTab) bool

func (*WorkbenchTab) GetKind

func (x *WorkbenchTab) GetKind() WorkbenchTabKind

func (*WorkbenchTab) GetObjectKey

func (x *WorkbenchTab) GetObjectKey() string

func (*WorkbenchTab) GetPinned

func (x *WorkbenchTab) GetPinned() bool

func (*WorkbenchTab) GetTabId

func (x *WorkbenchTab) GetTabId() string

func (*WorkbenchTab) GetTitle

func (x *WorkbenchTab) GetTitle() string

func (*WorkbenchTab) MarshalJSON

func (x *WorkbenchTab) MarshalJSON() ([]byte, error)

MarshalJSON marshals the WorkbenchTab to JSON.

func (*WorkbenchTab) MarshalProtoJSON

func (x *WorkbenchTab) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the WorkbenchTab message to JSON.

func (*WorkbenchTab) MarshalProtoText

func (x *WorkbenchTab) MarshalProtoText() string

func (*WorkbenchTab) MarshalToSizedBufferVT

func (m *WorkbenchTab) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*WorkbenchTab) MarshalToVT

func (m *WorkbenchTab) MarshalToVT(dAtA []byte) (int, error)

func (*WorkbenchTab) MarshalVT

func (m *WorkbenchTab) MarshalVT() (dAtA []byte, err error)

func (*WorkbenchTab) ProtoMessage

func (*WorkbenchTab) ProtoMessage()

func (*WorkbenchTab) Reset

func (x *WorkbenchTab) Reset()

func (*WorkbenchTab) SizeVT

func (m *WorkbenchTab) SizeVT() (n int)

func (*WorkbenchTab) String

func (x *WorkbenchTab) String() string

func (*WorkbenchTab) UnmarshalJSON

func (x *WorkbenchTab) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the WorkbenchTab from JSON.

func (*WorkbenchTab) UnmarshalProtoJSON

func (x *WorkbenchTab) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the WorkbenchTab message from JSON.

func (*WorkbenchTab) UnmarshalVT

func (m *WorkbenchTab) UnmarshalVT(dAtA []byte) error

type WorkbenchTabKind

type WorkbenchTabKind int32

WorkbenchTabKind identifies the kind of object opened in a workbench tab.

const (
	WorkbenchTabKind_WORKBENCH_TAB_KIND_UNSPECIFIED  WorkbenchTabKind = 0
	WorkbenchTabKind_WORKBENCH_TAB_KIND_QUERY        WorkbenchTabKind = 1
	WorkbenchTabKind_WORKBENCH_TAB_KIND_QUERY_RESULT WorkbenchTabKind = 2
)

func (WorkbenchTabKind) Enum

func (WorkbenchTabKind) MarshalJSON

func (x WorkbenchTabKind) MarshalJSON() ([]byte, error)

MarshalJSON marshals the WorkbenchTabKind to JSON.

func (WorkbenchTabKind) MarshalProtoJSON

func (x WorkbenchTabKind) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the WorkbenchTabKind to JSON.

func (WorkbenchTabKind) MarshalProtoText

func (x WorkbenchTabKind) MarshalProtoText() string

func (WorkbenchTabKind) MarshalText

func (x WorkbenchTabKind) MarshalText() ([]byte, error)

MarshalText marshals the WorkbenchTabKind to text.

func (WorkbenchTabKind) String

func (x WorkbenchTabKind) String() string

func (*WorkbenchTabKind) UnmarshalJSON

func (x *WorkbenchTabKind) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the WorkbenchTabKind from JSON.

func (*WorkbenchTabKind) UnmarshalProtoJSON

func (x *WorkbenchTabKind) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the WorkbenchTabKind from JSON.

func (*WorkbenchTabKind) UnmarshalText

func (x *WorkbenchTabKind) UnmarshalText(b []byte) error

UnmarshalText unmarshals the WorkbenchTabKind from text.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL