wal

package
v0.0.0-...-aa2f566 Latest Latest
Warning

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

 Go to latest Published: Apr 10, 2024 License: Apache-2.0 Imports: 8 Imported by: 2

Documentation

Index

Constants

View Source 
const (
	WAL_GetCapabilities_FullMethodName  = "/cnpgi.wal.v1.WAL/GetCapabilities"
	WAL_Archive_FullMethodName          = "/cnpgi.wal.v1.WAL/Archive"
	WAL_Restore_FullMethodName          = "/cnpgi.wal.v1.WAL/Restore"
	WAL_Status_FullMethodName           = "/cnpgi.wal.v1.WAL/Status"
	WAL_SetFirstRequired_FullMethodName = "/cnpgi.wal.v1.WAL/SetFirstRequired"
)

Variables

View Source 
var (
	WALCapability_RPC_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "TYPE_ARCHIVE_WAL",
		2: "TYPE_RESTORE_WAL",
		3: "TYPE_STATUS",
		4: "TYPE_SET_FIRST_REQUIRED",
	}
	WALCapability_RPC_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED":        0,
		"TYPE_ARCHIVE_WAL":        1,
		"TYPE_RESTORE_WAL":        2,
		"TYPE_STATUS":             3,
		"TYPE_SET_FIRST_REQUIRED": 4,
	}
)

Enum value maps for WALCapability_RPC_Type.

View Source 
var File_proto_wal_proto protoreflect.FileDescriptor
View Source 
var WAL_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cnpgi.wal.v1.WAL",
	HandlerType: (*WALServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetCapabilities",
			Handler:    _WAL_GetCapabilities_Handler,
		},
		{
			MethodName: "Archive",
			Handler:    _WAL_Archive_Handler,
		},
		{
			MethodName: "Restore",
			Handler:    _WAL_Restore_Handler,
		},
		{
			MethodName: "Status",
			Handler:    _WAL_Status_Handler,
		},
		{
			MethodName: "SetFirstRequired",
			Handler:    _WAL_SetFirstRequired_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/wal.proto",
}

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

Functions

func RegisterWALServer 

func RegisterWALServer(s grpc.ServiceRegistrar, srv WALServer)

Types

type SetFirstRequiredRequest 

type SetFirstRequiredRequest struct {

	// This field is REQUIRED. Value of this field is the JSON
	// serialization of the Cluster corresponding to the Pod being applied
	ClusterDefinition []byte `protobuf:"bytes,1,opt,name=cluster_definition,json=clusterDefinition,proto3" json:"cluster_definition,omitempty"`
	// This field is REQUIRED. Value of this field is the name of the first
	// required WAL in the WAL archive for this cluster (normally based on the
	// begin WAL of the first available base backup for the cluster)
	FirstRequiredWal string `protobuf:"bytes,2,opt,name=first_required_wal,json=firstRequiredWal,proto3" json:"first_required_wal,omitempty"`
	// contains filtered or unexported fields
}

func (*SetFirstRequiredRequest) Descriptor deprecated 

func (*SetFirstRequiredRequest) Descriptor() ([]byte, []int)

Deprecated: Use SetFirstRequiredRequest.ProtoReflect.Descriptor instead.

func (*SetFirstRequiredRequest) GetClusterDefinition 

func (x *SetFirstRequiredRequest) GetClusterDefinition() []byte

func (*SetFirstRequiredRequest) GetFirstRequiredWal 

func (x *SetFirstRequiredRequest) GetFirstRequiredWal() string

func (*SetFirstRequiredRequest) ProtoMessage 

func (*SetFirstRequiredRequest) ProtoMessage()

func (*SetFirstRequiredRequest) ProtoReflect 

func (x *SetFirstRequiredRequest) ProtoReflect() protoreflect.Message

func (*SetFirstRequiredRequest) Reset 

func (x *SetFirstRequiredRequest) Reset()

func (*SetFirstRequiredRequest) String 

func (x *SetFirstRequiredRequest) String() string

type SetFirstRequiredResult 

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

func (*SetFirstRequiredResult) Descriptor deprecated 

func (*SetFirstRequiredResult) Descriptor() ([]byte, []int)

Deprecated: Use SetFirstRequiredResult.ProtoReflect.Descriptor instead.

func (*SetFirstRequiredResult) ProtoMessage 

func (*SetFirstRequiredResult) ProtoMessage()

func (*SetFirstRequiredResult) ProtoReflect 

func (x *SetFirstRequiredResult) ProtoReflect() protoreflect.Message

func (*SetFirstRequiredResult) Reset 

func (x *SetFirstRequiredResult) Reset()

func (*SetFirstRequiredResult) String 

func (x *SetFirstRequiredResult) String() string

type UnimplementedWALServer 

type UnimplementedWALServer struct {
}

UnimplementedWALServer must be embedded to have forward compatible implementations.

func (UnimplementedWALServer) Archive 

func (UnimplementedWALServer) Archive(context.Context, *WALArchiveRequest) (*WALArchiveResult, error)

func (UnimplementedWALServer) GetCapabilities 

func (UnimplementedWALServer) GetCapabilities(context.Context, *WALCapabilitiesRequest) (*WALCapabilitiesResult, error)

func (UnimplementedWALServer) Restore 

func (UnimplementedWALServer) Restore(context.Context, *WALRestoreRequest) (*WALRestoreResult, error)

func (UnimplementedWALServer) SetFirstRequired 

func (UnimplementedWALServer) SetFirstRequired(context.Context, *SetFirstRequiredRequest) (*SetFirstRequiredResult, error)

func (UnimplementedWALServer) Status 

func (UnimplementedWALServer) Status(context.Context, *WALStatusRequest) (*WALStatusResult, error)

type UnsafeWALServer 

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

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

type WALArchiveRequest 

type WALArchiveRequest struct {

	// This field is REQUIRED. Value of this field is the JSON
	// serialization of the Cluster corresponding to the Pod being applied
	ClusterDefinition []byte `protobuf:"bytes,1,opt,name=cluster_definition,json=clusterDefinition,proto3" json:"cluster_definition,omitempty"`
	// This field is REQUIRED. Value of this field is the full path
	// of the WAL file that should be archived
	SourceFileName string `protobuf:"bytes,2,opt,name=source_file_name,json=sourceFileName,proto3" json:"source_file_name,omitempty"`
	// This field is OPTIONAL. Values are opaque.
	Parameters map[string]string `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*WALArchiveRequest) Descriptor deprecated 

func (*WALArchiveRequest) Descriptor() ([]byte, []int)

Deprecated: Use WALArchiveRequest.ProtoReflect.Descriptor instead.

func (*WALArchiveRequest) GetClusterDefinition 

func (x *WALArchiveRequest) GetClusterDefinition() []byte

func (*WALArchiveRequest) GetParameters 

func (x *WALArchiveRequest) GetParameters() map[string]string

func (*WALArchiveRequest) GetSourceFileName 

func (x *WALArchiveRequest) GetSourceFileName() string

func (*WALArchiveRequest) ProtoMessage 

func (*WALArchiveRequest) ProtoMessage()

func (*WALArchiveRequest) ProtoReflect 

func (x *WALArchiveRequest) ProtoReflect() protoreflect.Message

func (*WALArchiveRequest) Reset 

func (x *WALArchiveRequest) Reset()

func (*WALArchiveRequest) String 

func (x *WALArchiveRequest) String() string

type WALArchiveResult 

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

func (*WALArchiveResult) Descriptor deprecated 

func (*WALArchiveResult) Descriptor() ([]byte, []int)

Deprecated: Use WALArchiveResult.ProtoReflect.Descriptor instead.

func (*WALArchiveResult) ProtoMessage 

func (*WALArchiveResult) ProtoMessage()

func (*WALArchiveResult) ProtoReflect 

func (x *WALArchiveResult) ProtoReflect() protoreflect.Message

func (*WALArchiveResult) Reset 

func (x *WALArchiveResult) Reset()

func (*WALArchiveResult) String 

func (x *WALArchiveResult) String() string

type WALCapabilitiesRequest 

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

func (*WALCapabilitiesRequest) Descriptor deprecated 

func (*WALCapabilitiesRequest) Descriptor() ([]byte, []int)

Deprecated: Use WALCapabilitiesRequest.ProtoReflect.Descriptor instead.

func (*WALCapabilitiesRequest) ProtoMessage 

func (*WALCapabilitiesRequest) ProtoMessage()

func (*WALCapabilitiesRequest) ProtoReflect 

func (x *WALCapabilitiesRequest) ProtoReflect() protoreflect.Message

func (*WALCapabilitiesRequest) Reset 

func (x *WALCapabilitiesRequest) Reset()

func (*WALCapabilitiesRequest) String 

func (x *WALCapabilitiesRequest) String() string

type WALCapabilitiesResult 

type WALCapabilitiesResult struct {

	// All the capabilities that the controller service supports. This
	// field is OPTIONAL.
	Capabilities []*WALCapability `protobuf:"bytes,1,rep,name=capabilities,proto3" json:"capabilities,omitempty"`
	// contains filtered or unexported fields
}

func (*WALCapabilitiesResult) Descriptor deprecated 

func (*WALCapabilitiesResult) Descriptor() ([]byte, []int)

Deprecated: Use WALCapabilitiesResult.ProtoReflect.Descriptor instead.

func (*WALCapabilitiesResult) GetCapabilities 

func (x *WALCapabilitiesResult) GetCapabilities() []*WALCapability

func (*WALCapabilitiesResult) ProtoMessage 

func (*WALCapabilitiesResult) ProtoMessage()

func (*WALCapabilitiesResult) ProtoReflect 

func (x *WALCapabilitiesResult) ProtoReflect() protoreflect.Message

func (*WALCapabilitiesResult) Reset 

func (x *WALCapabilitiesResult) Reset()

func (*WALCapabilitiesResult) String 

func (x *WALCapabilitiesResult) String() string

type WALCapability 

type WALCapability struct {

	// Types that are assignable to Type:
	//
	//	*WALCapability_Rpc
	Type isWALCapability_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

func (*WALCapability) Descriptor deprecated 

func (*WALCapability) Descriptor() ([]byte, []int)

Deprecated: Use WALCapability.ProtoReflect.Descriptor instead.

func (*WALCapability) GetRpc 

func (x *WALCapability) GetRpc() *WALCapability_RPC

func (*WALCapability) GetType 

func (m *WALCapability) GetType() isWALCapability_Type

func (*WALCapability) ProtoMessage 

func (*WALCapability) ProtoMessage()

func (*WALCapability) ProtoReflect 

func (x *WALCapability) ProtoReflect() protoreflect.Message

func (*WALCapability) Reset 

func (x *WALCapability) Reset()

func (*WALCapability) String 

func (x *WALCapability) String() string

type WALCapability_RPC 

type WALCapability_RPC struct {
	Type WALCapability_RPC_Type `protobuf:"varint,1,opt,name=type,proto3,enum=cnpgi.wal.v1.WALCapability_RPC_Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*WALCapability_RPC) Descriptor deprecated 

func (*WALCapability_RPC) Descriptor() ([]byte, []int)

Deprecated: Use WALCapability_RPC.ProtoReflect.Descriptor instead.

func (*WALCapability_RPC) GetType 

func (x *WALCapability_RPC) GetType() WALCapability_RPC_Type

func (*WALCapability_RPC) ProtoMessage 

func (*WALCapability_RPC) ProtoMessage()

func (*WALCapability_RPC) ProtoReflect 

func (x *WALCapability_RPC) ProtoReflect() protoreflect.Message

func (*WALCapability_RPC) Reset 

func (x *WALCapability_RPC) Reset()

func (*WALCapability_RPC) String 

func (x *WALCapability_RPC) String() string

type WALCapability_RPC_Type 

type WALCapability_RPC_Type int32
const (
	WALCapability_RPC_TYPE_UNSPECIFIED WALCapability_RPC_Type = 0
	// TYPE_ARCHIVE_WAL indicates that the Plugin is able to
	// reply to the Archive RPC request
	WALCapability_RPC_TYPE_ARCHIVE_WAL WALCapability_RPC_Type = 1
	// TYPE_RESTORE_WAL indicates that the Plugin is able to
	// reply to the Restore RPC request
	WALCapability_RPC_TYPE_RESTORE_WAL WALCapability_RPC_Type = 2
	// TYPE_STATUS indicates that the Plugin is able to
	// reply to the Status RPC request
	WALCapability_RPC_TYPE_STATUS WALCapability_RPC_Type = 3
	// TYPE_SET_FIRST_REQUIRED indicates that the Plugin is able to
	// reply to the SetFirstRequired RPC request
	WALCapability_RPC_TYPE_SET_FIRST_REQUIRED WALCapability_RPC_Type = 4
)

func (WALCapability_RPC_Type) Descriptor 

func (WALCapability_RPC_Type) Descriptor() protoreflect.EnumDescriptor

func (WALCapability_RPC_Type) Enum 

func (x WALCapability_RPC_Type) Enum() *WALCapability_RPC_Type

func (WALCapability_RPC_Type) EnumDescriptor deprecated 

func (WALCapability_RPC_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use WALCapability_RPC_Type.Descriptor instead.

func (WALCapability_RPC_Type) Number 

func (x WALCapability_RPC_Type) Number() protoreflect.EnumNumber

func (WALCapability_RPC_Type) String 

func (x WALCapability_RPC_Type) String() string

func (WALCapability_RPC_Type) Type 

func (WALCapability_RPC_Type) Type() protoreflect.EnumType

type WALCapability_Rpc 

type WALCapability_Rpc struct {
	Rpc *WALCapability_RPC `protobuf:"bytes,1,opt,name=rpc,proto3,oneof"`
}

type WALClient 

type WALClient interface {
	// GetCapabilities gets the capabilities of the WAL service
	GetCapabilities(ctx context.Context, in *WALCapabilitiesRequest, opts ...grpc.CallOption) (*WALCapabilitiesResult, error)
	// Archive copies one WAL file into the archive
	Archive(ctx context.Context, in *WALArchiveRequest, opts ...grpc.CallOption) (*WALArchiveResult, error)
	// Restores copies WAL file from the archive to the data directory
	Restore(ctx context.Context, in *WALRestoreRequest, opts ...grpc.CallOption) (*WALRestoreResult, error)
	// Status gets the statistics of the WAL file archive
	Status(ctx context.Context, in *WALStatusRequest, opts ...grpc.CallOption) (*WALStatusResult, error)
	// SetFirstRequired sets the first required WAL for the cluster
	SetFirstRequired(ctx context.Context, in *SetFirstRequiredRequest, opts ...grpc.CallOption) (*SetFirstRequiredResult, error)
}

WALClient is the client API for WAL 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.

func NewWALClient 

func NewWALClient(cc grpc.ClientConnInterface) WALClient

type WALRestoreRequest 

type WALRestoreRequest struct {

	// This field is REQUIRED. Value of this field is the JSON
	// serialization of the Cluster corresponding to the Pod being applied
	ClusterDefinition []byte `protobuf:"bytes,1,opt,name=cluster_definition,json=clusterDefinition,proto3" json:"cluster_definition,omitempty"`
	// This field is REQUIRED. Value of this field is the name of
	// the WAL to be retrieved from the archive, such as:
	// 000000010000000100000012
	SourceWalName string `protobuf:"bytes,2,opt,name=source_wal_name,json=sourceWalName,proto3" json:"source_wal_name,omitempty"`
	// This field is REQUIRED. Value of this field is the full path
	// where the WAL file should be stored
	DestinationFileName string `protobuf:"bytes,3,opt,name=destination_file_name,json=destinationFileName,proto3" json:"destination_file_name,omitempty"`
	// This field is OPTIONAL. Values are opaque.
	Parameters map[string]string `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*WALRestoreRequest) Descriptor deprecated 

func (*WALRestoreRequest) Descriptor() ([]byte, []int)

Deprecated: Use WALRestoreRequest.ProtoReflect.Descriptor instead.

func (*WALRestoreRequest) GetClusterDefinition 

func (x *WALRestoreRequest) GetClusterDefinition() []byte

func (*WALRestoreRequest) GetDestinationFileName 

func (x *WALRestoreRequest) GetDestinationFileName() string

func (*WALRestoreRequest) GetParameters 

func (x *WALRestoreRequest) GetParameters() map[string]string

func (*WALRestoreRequest) GetSourceWalName 

func (x *WALRestoreRequest) GetSourceWalName() string

func (*WALRestoreRequest) ProtoMessage 

func (*WALRestoreRequest) ProtoMessage()

func (*WALRestoreRequest) ProtoReflect 

func (x *WALRestoreRequest) ProtoReflect() protoreflect.Message

func (*WALRestoreRequest) Reset 

func (x *WALRestoreRequest) Reset()

func (*WALRestoreRequest) String 

func (x *WALRestoreRequest) String() string

type WALRestoreResult 

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

func (*WALRestoreResult) Descriptor deprecated 

func (*WALRestoreResult) Descriptor() ([]byte, []int)

Deprecated: Use WALRestoreResult.ProtoReflect.Descriptor instead.

func (*WALRestoreResult) ProtoMessage 

func (*WALRestoreResult) ProtoMessage()

func (*WALRestoreResult) ProtoReflect 

func (x *WALRestoreResult) ProtoReflect() protoreflect.Message

func (*WALRestoreResult) Reset 

func (x *WALRestoreResult) Reset()

func (*WALRestoreResult) String 

func (x *WALRestoreResult) String() string

type WALServer 

type WALServer interface {
	// GetCapabilities gets the capabilities of the WAL service
	GetCapabilities(context.Context, *WALCapabilitiesRequest) (*WALCapabilitiesResult, error)
	// Archive copies one WAL file into the archive
	Archive(context.Context, *WALArchiveRequest) (*WALArchiveResult, error)
	// Restores copies WAL file from the archive to the data directory
	Restore(context.Context, *WALRestoreRequest) (*WALRestoreResult, error)
	// Status gets the statistics of the WAL file archive
	Status(context.Context, *WALStatusRequest) (*WALStatusResult, error)
	// SetFirstRequired sets the first required WAL for the cluster
	SetFirstRequired(context.Context, *SetFirstRequiredRequest) (*SetFirstRequiredResult, error)
	// contains filtered or unexported methods
}

WALServer is the server API for WAL service. All implementations must embed UnimplementedWALServer for forward compatibility

type WALStatusRequest 

type WALStatusRequest struct {

	// This field is REQUIRED. Value of this field is the JSON
	// serialization of the Cluster corresponding to the Pod being applied
	ClusterDefinition []byte `protobuf:"bytes,1,opt,name=cluster_definition,json=clusterDefinition,proto3" json:"cluster_definition,omitempty"`
	// contains filtered or unexported fields
}

func (*WALStatusRequest) Descriptor deprecated 

func (*WALStatusRequest) Descriptor() ([]byte, []int)

Deprecated: Use WALStatusRequest.ProtoReflect.Descriptor instead.

func (*WALStatusRequest) GetClusterDefinition 

func (x *WALStatusRequest) GetClusterDefinition() []byte

func (*WALStatusRequest) ProtoMessage 

func (*WALStatusRequest) ProtoMessage()

func (*WALStatusRequest) ProtoReflect 

func (x *WALStatusRequest) ProtoReflect() protoreflect.Message

func (*WALStatusRequest) Reset 

func (x *WALStatusRequest) Reset()

func (*WALStatusRequest) String 

func (x *WALStatusRequest) String() string

type WALStatusResult 

type WALStatusResult struct {

	// This field is REQUIRED. Value of this field is the base name of
	// the oldest archived WAL, such as:
	// 000000010000000100000012
	FirstWal string `protobuf:"bytes,1,opt,name=first_wal,json=firstWal,proto3" json:"first_wal,omitempty"`
	// This field is REQUIRED. Value of this field is the base name of
	// the newest archived WAL, such as:
	// 000000010000000100000014
	LastWal string `protobuf:"bytes,2,opt,name=last_wal,json=lastWal,proto3" json:"last_wal,omitempty"`
	// This field is OPTIONAL. Value is opaque.
	AdditionalInformation map[string]string `` /* 212-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*WALStatusResult) Descriptor deprecated 

func (*WALStatusResult) Descriptor() ([]byte, []int)

Deprecated: Use WALStatusResult.ProtoReflect.Descriptor instead.

func (*WALStatusResult) GetAdditionalInformation 

func (x *WALStatusResult) GetAdditionalInformation() map[string]string

func (*WALStatusResult) GetFirstWal 

func (x *WALStatusResult) GetFirstWal() string

func (*WALStatusResult) GetLastWal 

func (x *WALStatusResult) GetLastWal() string

func (*WALStatusResult) ProtoMessage 

func (*WALStatusResult) ProtoMessage()

func (*WALStatusResult) ProtoReflect 

func (x *WALStatusResult) ProtoReflect() protoreflect.Message

func (*WALStatusResult) Reset 

func (x *WALStatusResult) Reset()

func (*WALStatusResult) String 

func (x *WALStatusResult) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.