psdbconnectv1alpha1connect

Documentation

Index

• Constants
• func NewConnectHandler(svc ConnectHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type ConnectClient
  • func NewConnectClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) ConnectClient
• type ConnectHandler
• type UnimplementedConnectHandler
  • func (UnimplementedConnectHandler) Sync(context.Context, *connect.Request[v1alpha1.SyncRequest], ...) error

Constants

const (
	// ConnectName is the fully-qualified name of the Connect service.
	ConnectName = "psdbconnect.v1alpha1.Connect"
)

const (
	// ConnectSyncProcedure is the fully-qualified name of the Connect's Sync RPC.
	ConnectSyncProcedure = "/psdbconnect.v1alpha1.Connect/Sync"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

Functions

func NewConnectHandler

func NewConnectHandler(svc ConnectHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewConnectHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type ConnectClient

type ConnectClient interface {
	// Sync will continuously stream data from a PlanetScale database given a table, keyspace and shard.
	// Sync also allows you to incrementally sync data from a table given a TableCursor that is returned as part of the SyncResponse.
	// If the last known position is empty, Sync will download all the rows for a given table in a shard
	// and then wait to stream any changes to the table (inserts/updates/deletes)
	// If the last known position is not empty, Sync will pickup where the last Sync session left off and stream
	// any changes to the table since the last Sync session.
	Sync(context.Context, *connect.Request[v1alpha1.SyncRequest]) (*connect.ServerStreamForClient[v1alpha1.SyncResponse], error)
}

ConnectClient is a client for the psdbconnect.v1alpha1.Connect service.

func NewConnectClient

func NewConnectClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) ConnectClient

NewConnectClient constructs a client for the psdbconnect.v1alpha1.Connect service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type ConnectHandler

type ConnectHandler interface {
	// Sync will continuously stream data from a PlanetScale database given a table, keyspace and shard.
	// Sync also allows you to incrementally sync data from a table given a TableCursor that is returned as part of the SyncResponse.
	// If the last known position is empty, Sync will download all the rows for a given table in a shard
	// and then wait to stream any changes to the table (inserts/updates/deletes)
	// If the last known position is not empty, Sync will pickup where the last Sync session left off and stream
	// any changes to the table since the last Sync session.
	Sync(context.Context, *connect.Request[v1alpha1.SyncRequest], *connect.ServerStream[v1alpha1.SyncResponse]) error
}

ConnectHandler is an implementation of the psdbconnect.v1alpha1.Connect service.

type UnimplementedConnectHandler

type UnimplementedConnectHandler struct{}

UnimplementedConnectHandler returns CodeUnimplemented from all methods.

func (UnimplementedConnectHandler) Sync

func (UnimplementedConnectHandler) Sync(context.Context, *connect.Request[v1alpha1.SyncRequest], *connect.ServerStream[v1alpha1.SyncResponse]) error