sqldatagrpc

package
v1.22.0 Latest Latest
Warning

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

Go to latest
Published: Jun 11, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source
const (
	SqlDataService_StreamSqlData_FullMethodName = "/google.cloud.sql.v1beta4.SqlDataService/StreamSqlData"
)

Variables

View Source
var SqlDataService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.sql.v1beta4.SqlDataService",
	HandlerType: (*SqlDataServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamSqlData",
			Handler:       _SqlDataService_StreamSqlData_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "internal/sqldata/sql_data_service.proto",
}

SqlDataService_ServiceDesc is the grpc.ServiceDesc for SqlDataService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterSqlDataServiceServer

func RegisterSqlDataServiceServer(s grpc.ServiceRegistrar, srv SqlDataServiceServer)

Types

type SqlDataServiceClient

type SqlDataServiceClient interface {
	// `StreamSqlData` establishes a bidirectional stream to a Cloud SQL instance,
	// and then streams data to and from the instance.
	//
	// The first message from the client MUST be a `sqldatapb.StreamSqlDataRequest` request
	// with configuration settings, including required values for the
	// `connection_settings` field. Subsequent messages from the client may
	// contain the `payload` field.
	//
	// Messages from the server may contain the `payload` field.
	//
	// The `payload` fields of the request and response streams contain the raw
	// data of the database's native wire protocol (e.g., PostgreSQL wire
	// protocol). The database client is responsible for generating and parsing
	// this data.
	//
	// Any errors on initial connection (e.g., connection failure, authorization
	// issues, network problems) will result in the stream being terminated with
	// an appropriate RPC status exception.
	//
	// After a successful connection is made, if an error occurs, then the server
	// terminates connection and returns the appropriate RPC status exception.
	StreamSqlData(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[sqldatapb.StreamSqlDataRequest, sqldatapb.StreamSqlDataResponse], error)
}

SqlDataServiceClient is the client API for SqlDataService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

Service for streaming data to and from Cloud SQL instances.

type SqlDataServiceServer

type SqlDataServiceServer interface {
	// `StreamSqlData` establishes a bidirectional stream to a Cloud SQL instance,
	// and then streams data to and from the instance.
	//
	// The first message from the client MUST be a `sqldatapb.StreamSqlDataRequest` request
	// with configuration settings, including required values for the
	// `connection_settings` field. Subsequent messages from the client may
	// contain the `payload` field.
	//
	// Messages from the server may contain the `payload` field.
	//
	// The `payload` fields of the request and response streams contain the raw
	// data of the database's native wire protocol (e.g., PostgreSQL wire
	// protocol). The database client is responsible for generating and parsing
	// this data.
	//
	// Any errors on initial connection (e.g., connection failure, authorization
	// issues, network problems) will result in the stream being terminated with
	// an appropriate RPC status exception.
	//
	// After a successful connection is made, if an error occurs, then the server
	// terminates connection and returns the appropriate RPC status exception.
	StreamSqlData(grpc.BidiStreamingServer[sqldatapb.StreamSqlDataRequest, sqldatapb.StreamSqlDataResponse]) error
	// contains filtered or unexported methods
}

SqlDataServiceServer is the server API for SqlDataService service. All implementations must embed UnimplementedSqlDataServiceServer for forward compatibility.

Service for streaming data to and from Cloud SQL instances.

type SqlDataService_StreamSqlDataClient

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type SqlDataService_StreamSqlDataServer

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type UnimplementedSqlDataServiceServer

type UnimplementedSqlDataServiceServer struct{}

UnimplementedSqlDataServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

type UnsafeSqlDataServiceServer

type UnsafeSqlDataServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeSqlDataServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SqlDataServiceServer will result in compilation errors.

Jump to

Keyboard shortcuts

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