Documentation
¶
Index ¶
- Constants
- Variables
- func AreSameHeight(h1, h2 *TxRef) bool
- func BlockNumFromSnapshotAbortKey(key []byte) (uint64, error)
- func IsSnapshotAbortKey(key []byte) bool
- func IsSystemNamespace(nsID string) bool
- func RegisterQueryServiceServer(s grpc.ServiceRegistrar, srv QueryServiceServer)
- func RegisterSidecarServiceServer(s grpc.ServiceRegistrar, srv SidecarServiceServer)
- func SnapshotAbortKey(blockNum uint64) []byte
- func SystemNamespaces() []string
- type BlockEvent
- func (*BlockEvent) Descriptor() ([]byte, []int)deprecated
- func (x *BlockEvent) GetEvents() []*TxEvent
- func (x *BlockEvent) GetHeader() *common.BlockHeader
- func (*BlockEvent) ProtoMessage()
- func (x *BlockEvent) ProtoReflect() protoreflect.Message
- func (x *BlockEvent) Reset()
- func (x *BlockEvent) String() string
- type BlockNumber
- type DeleteDBCloneForSnapshotRequest
- func (*DeleteDBCloneForSnapshotRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteDBCloneForSnapshotRequest) GetTxId() string
- func (*DeleteDBCloneForSnapshotRequest) ProtoMessage()
- func (x *DeleteDBCloneForSnapshotRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteDBCloneForSnapshotRequest) Reset()
- func (x *DeleteDBCloneForSnapshotRequest) String() string
- type IsoLevel
- type NotificationRequest
- func (*NotificationRequest) Descriptor() ([]byte, []int)deprecated
- func (x *NotificationRequest) GetTimeout() *durationpb.Duration
- func (x *NotificationRequest) GetTxStatusRequest() *TxIDsBatch
- func (*NotificationRequest) ProtoMessage()
- func (x *NotificationRequest) ProtoReflect() protoreflect.Message
- func (x *NotificationRequest) Reset()
- func (x *NotificationRequest) String() string
- type NotificationResponse
- func (*NotificationResponse) Descriptor() ([]byte, []int)deprecated
- func (x *NotificationResponse) GetRejectedTxIds() *RejectedTxIds
- func (x *NotificationResponse) GetTimeoutTxIds() []string
- func (x *NotificationResponse) GetTxStatusEvents() []*TxStatus
- func (*NotificationResponse) ProtoMessage()
- func (x *NotificationResponse) ProtoReflect() protoreflect.Message
- func (x *NotificationResponse) Reset()
- func (x *NotificationResponse) String() string
- type Query
- type QueryNamespace
- func (*QueryNamespace) Descriptor() ([]byte, []int)deprecated
- func (x *QueryNamespace) GetKeys() [][]byte
- func (x *QueryNamespace) GetNsId() string
- func (*QueryNamespace) ProtoMessage()
- func (x *QueryNamespace) ProtoReflect() protoreflect.Message
- func (x *QueryNamespace) Reset()
- func (x *QueryNamespace) String() string
- type QueryServiceClient
- type QueryServiceServer
- type RejectedTxIds
- func (*RejectedTxIds) Descriptor() ([]byte, []int)deprecated
- func (x *RejectedTxIds) GetReason() string
- func (x *RejectedTxIds) GetTxIds() []string
- func (*RejectedTxIds) ProtoMessage()
- func (x *RejectedTxIds) ProtoReflect() protoreflect.Message
- func (x *RejectedTxIds) Reset()
- func (x *RejectedTxIds) String() string
- type Row
- type Rows
- type RowsNamespace
- func (*RowsNamespace) Descriptor() ([]byte, []int)deprecated
- func (x *RowsNamespace) GetNsId() string
- func (x *RowsNamespace) GetRows() []*Row
- func (*RowsNamespace) ProtoMessage()
- func (x *RowsNamespace) ProtoReflect() protoreflect.Message
- func (x *RowsNamespace) Reset()
- func (x *RowsNamespace) String() string
- type SidecarServiceClient
- type SidecarServiceServer
- type SidecarService_OpenNotificationStreamClient
- type SidecarService_OpenNotificationStreamServer
- type SidecarService_StreamBlocksClient
- type SidecarService_StreamBlocksServer
- type SnapshotState
- func (*SnapshotState) Descriptor() ([]byte, []int)deprecated
- func (x *SnapshotState) GetCheckpointHash() []byte
- func (x *SnapshotState) GetCloneDatabase() string
- func (x *SnapshotState) GetError() string
- func (x *SnapshotState) GetHash() []byte
- func (x *SnapshotState) GetStatus() SnapshotState_Status
- func (x *SnapshotState) GetTxRef() *TxRef
- func (*SnapshotState) ProtoMessage()
- func (x *SnapshotState) ProtoReflect() protoreflect.Message
- func (x *SnapshotState) Reset()
- func (x *SnapshotState) String() string
- type SnapshotState_Status
- func (SnapshotState_Status) Descriptor() protoreflect.EnumDescriptor
- func (x SnapshotState_Status) Enum() *SnapshotState_Status
- func (SnapshotState_Status) EnumDescriptor() ([]byte, []int)deprecated
- func (x SnapshotState_Status) Number() protoreflect.EnumNumber
- func (x SnapshotState_Status) String() string
- func (SnapshotState_Status) Type() protoreflect.EnumType
- type Status
- type StreamBlocksRequest
- func (*StreamBlocksRequest) Descriptor() ([]byte, []int)deprecated
- func (x *StreamBlocksRequest) GetFilterNamespaces() []string
- func (x *StreamBlocksRequest) GetFilterStatus() []Status
- func (x *StreamBlocksRequest) GetIncludeEndorsements() bool
- func (x *StreamBlocksRequest) GetIncludeMetadata() bool
- func (x *StreamBlocksRequest) GetIncludeReadWriteSets() bool
- func (*StreamBlocksRequest) ProtoMessage()
- func (x *StreamBlocksRequest) ProtoReflect() protoreflect.Message
- func (x *StreamBlocksRequest) Reset()
- func (x *StreamBlocksRequest) String() string
- type TxEvent
- func (*TxEvent) Descriptor() ([]byte, []int)deprecated
- func (x *TxEvent) GetEndorsements() []*applicationpb.Endorsements
- func (x *TxEvent) GetMetadata() [][]byte
- func (x *TxEvent) GetNamespaces() []*applicationpb.TxNamespace
- func (x *TxEvent) GetRef() *TxRef
- func (x *TxEvent) GetStatus() Status
- func (*TxEvent) ProtoMessage()
- func (x *TxEvent) ProtoReflect() protoreflect.Message
- func (x *TxEvent) Reset()
- func (x *TxEvent) String() string
- type TxID
- type TxIDsBatch
- type TxRef
- func (*TxRef) Descriptor() ([]byte, []int)deprecated
- func (x *TxRef) GetBlockNum() uint64
- func (x *TxRef) GetTxId() string
- func (x *TxRef) GetTxNum() uint32
- func (x *TxRef) IsHeight(blockNum uint64, txNum uint32) bool
- func (*TxRef) ProtoMessage()
- func (x *TxRef) ProtoReflect() protoreflect.Message
- func (x *TxRef) Reset()
- func (x *TxRef) String() string
- type TxStatus
- type TxStatusQuery
- func (*TxStatusQuery) Descriptor() ([]byte, []int)deprecated
- func (x *TxStatusQuery) GetTxIds() []string
- func (x *TxStatusQuery) GetView() *View
- func (*TxStatusQuery) ProtoMessage()
- func (x *TxStatusQuery) ProtoReflect() protoreflect.Message
- func (x *TxStatusQuery) Reset()
- func (x *TxStatusQuery) String() string
- type TxStatusResponse
- type UnimplementedQueryServiceServer
- func (UnimplementedQueryServiceServer) BeginView(context.Context, *ViewParameters) (*View, error)
- func (UnimplementedQueryServiceServer) EndView(context.Context, *View) (*emptypb.Empty, error)
- func (UnimplementedQueryServiceServer) GetConfigTransaction(context.Context, *emptypb.Empty) (*applicationpb.ConfigTransaction, error)
- func (UnimplementedQueryServiceServer) GetNamespacePolicies(context.Context, *emptypb.Empty) (*applicationpb.NamespacePolicies, error)
- func (UnimplementedQueryServiceServer) GetRows(context.Context, *Query) (*Rows, error)
- func (UnimplementedQueryServiceServer) GetTransactionStatus(context.Context, *TxStatusQuery) (*TxStatusResponse, error)
- type UnimplementedSidecarServiceServer
- func (UnimplementedSidecarServiceServer) DeleteDBCloneForSnapshot(context.Context, *DeleteDBCloneForSnapshotRequest) (*emptypb.Empty, error)
- func (UnimplementedSidecarServiceServer) GetBlockByNumber(context.Context, *BlockNumber) (*common.Block, error)
- func (UnimplementedSidecarServiceServer) GetBlockByTxID(context.Context, *TxID) (*common.Block, error)
- func (UnimplementedSidecarServiceServer) GetBlockchainInfo(context.Context, *emptypb.Empty) (*common.BlockchainInfo, error)
- func (UnimplementedSidecarServiceServer) GetTxByID(context.Context, *TxID) (*common.Envelope, error)
- func (UnimplementedSidecarServiceServer) OpenNotificationStream(grpc.BidiStreamingServer[NotificationRequest, NotificationResponse]) error
- func (UnimplementedSidecarServiceServer) StreamBlocks(*StreamBlocksRequest, grpc.ServerStreamingServer[BlockEvent]) error
- type UnsafeQueryServiceServer
- type UnsafeSidecarServiceServer
- type View
- type ViewParameters
- func (*ViewParameters) Descriptor() ([]byte, []int)deprecated
- func (x *ViewParameters) GetIsoLevel() IsoLevel
- func (x *ViewParameters) GetNonDeferrable() bool
- func (x *ViewParameters) GetTimeoutMilliseconds() uint64
- func (*ViewParameters) ProtoMessage()
- func (x *ViewParameters) ProtoReflect() protoreflect.Message
- func (x *ViewParameters) Reset()
- func (x *ViewParameters) String() string
Constants ¶
const ( QueryService_GetRows_FullMethodName = "/committerpb.QueryService/GetRows" QueryService_BeginView_FullMethodName = "/committerpb.QueryService/BeginView" QueryService_EndView_FullMethodName = "/committerpb.QueryService/EndView" QueryService_GetNamespacePolicies_FullMethodName = "/committerpb.QueryService/GetNamespacePolicies" QueryService_GetConfigTransaction_FullMethodName = "/committerpb.QueryService/GetConfigTransaction" QueryService_GetTransactionStatus_FullMethodName = "/committerpb.QueryService/GetTransactionStatus" )
const ( SidecarService_GetBlockchainInfo_FullMethodName = "/committerpb.SidecarService/GetBlockchainInfo" SidecarService_GetBlockByNumber_FullMethodName = "/committerpb.SidecarService/GetBlockByNumber" SidecarService_GetBlockByTxID_FullMethodName = "/committerpb.SidecarService/GetBlockByTxID" SidecarService_GetTxByID_FullMethodName = "/committerpb.SidecarService/GetTxByID" SidecarService_OpenNotificationStream_FullMethodName = "/committerpb.SidecarService/OpenNotificationStream" SidecarService_StreamBlocks_FullMethodName = "/committerpb.SidecarService/StreamBlocks" SidecarService_DeleteDBCloneForSnapshot_FullMethodName = "/committerpb.SidecarService/DeleteDBCloneForSnapshot" )
const ( // MetaNamespaceID is the system's namespace ID that holds information about application's namespaces. MetaNamespaceID = "_meta" // ConfigNamespaceID is the system's namespace ID that holds the config transaction. ConfigNamespaceID = "_config" // SnapshotNamespaceID is the system's namespace ID that holds snapshot data. SnapshotNamespaceID = "_snapshot" // CheckpointNamespaceID is the system's namespace ID that holds checkpoint data. CheckpointNamespaceID = "_checkpoint" // ConfigKey is the key of the config transaction. ConfigKey = "_config" )
Variables ¶
var ( IsoLevel_name = map[int32]string{ 0: "ISO_LEVEL_UNSPECIFIED", 1: "SERIALIZABLE", 2: "REPEATABLE_READ", 3: "READ_COMMITTED", 4: "READ_UNCOMMITTED", } IsoLevel_value = map[string]int32{ "ISO_LEVEL_UNSPECIFIED": 0, "SERIALIZABLE": 1, "REPEATABLE_READ": 2, "READ_COMMITTED": 3, "READ_UNCOMMITTED": 4, } )
Enum value maps for IsoLevel.
var ( SnapshotState_Status_name = map[int32]string{ 0: "STATUS_UNSPECIFIED", 1: "PENDING", 2: "IN_PROGRESS", 3: "COMPLETED", 4: "FAILED", 5: "CHECKPOINTED", 6: "ABORTED", } SnapshotState_Status_value = map[string]int32{ "STATUS_UNSPECIFIED": 0, "PENDING": 1, "IN_PROGRESS": 2, "COMPLETED": 3, "FAILED": 4, "CHECKPOINTED": 5, "ABORTED": 6, } )
Enum value maps for SnapshotState_Status.
var ( Status_name = map[int32]string{ 0: "STATUS_UNSPECIFIED", 1: "COMMITTED", 2: "ABORTED_SIGNATURE_INVALID", 3: "ABORTED_MVCC_CONFLICT", 100: "REJECTED_DUPLICATE_TX_ID", 101: "MALFORMED_BAD_ENVELOPE", 102: "MALFORMED_MISSING_TX_ID", 103: "MALFORMED_UNSUPPORTED_ENVELOPE_PAYLOAD", 104: "MALFORMED_BAD_ENVELOPE_PAYLOAD", 105: "MALFORMED_TX_ID_CONFLICT", 106: "MALFORMED_EMPTY_NAMESPACES", 107: "MALFORMED_DUPLICATE_NAMESPACE", 108: "MALFORMED_NAMESPACE_ID_INVALID", 109: "MALFORMED_BLIND_WRITES_NOT_ALLOWED", 110: "MALFORMED_NO_WRITES", 111: "MALFORMED_EMPTY_KEY", 112: "MALFORMED_DUPLICATE_KEY_IN_READ_WRITE_SET", 113: "MALFORMED_MISSING_SIGNATURE", 114: "MALFORMED_NAMESPACE_POLICY_INVALID", 115: "MALFORMED_CONFIG_TX_INVALID", 116: "MALFORMED_SNAPSHOT_NOT_MARKER_ONLY", 117: "MALFORMED_CHECKPOINT_INVALID_KEY", 118: "MALFORMED_SYSTEM_TX_NOT_STANDALONE", 119: "REJECTED_SNAPSHOT_IN_PROGRESS", 120: "REJECTED_SNAPSHOT_NO_CHECKPOINT", 121: "REJECTED_DUPLICATE_SNAPSHOT_IN_BLOCK", 122: "MALFORMED_SNAPSHOT_INVALID_ABORT_KEY", 123: "REJECTED_SNAPSHOT_ABORT_NO_SUCH_SNAPSHOT", } Status_value = map[string]int32{ "STATUS_UNSPECIFIED": 0, "COMMITTED": 1, "ABORTED_SIGNATURE_INVALID": 2, "ABORTED_MVCC_CONFLICT": 3, "REJECTED_DUPLICATE_TX_ID": 100, "MALFORMED_BAD_ENVELOPE": 101, "MALFORMED_MISSING_TX_ID": 102, "MALFORMED_UNSUPPORTED_ENVELOPE_PAYLOAD": 103, "MALFORMED_BAD_ENVELOPE_PAYLOAD": 104, "MALFORMED_TX_ID_CONFLICT": 105, "MALFORMED_EMPTY_NAMESPACES": 106, "MALFORMED_DUPLICATE_NAMESPACE": 107, "MALFORMED_NAMESPACE_ID_INVALID": 108, "MALFORMED_BLIND_WRITES_NOT_ALLOWED": 109, "MALFORMED_NO_WRITES": 110, "MALFORMED_EMPTY_KEY": 111, "MALFORMED_DUPLICATE_KEY_IN_READ_WRITE_SET": 112, "MALFORMED_MISSING_SIGNATURE": 113, "MALFORMED_NAMESPACE_POLICY_INVALID": 114, "MALFORMED_CONFIG_TX_INVALID": 115, "MALFORMED_SNAPSHOT_NOT_MARKER_ONLY": 116, "MALFORMED_CHECKPOINT_INVALID_KEY": 117, "MALFORMED_SYSTEM_TX_NOT_STANDALONE": 118, "REJECTED_SNAPSHOT_IN_PROGRESS": 119, "REJECTED_SNAPSHOT_NO_CHECKPOINT": 120, "REJECTED_DUPLICATE_SNAPSHOT_IN_BLOCK": 121, "MALFORMED_SNAPSHOT_INVALID_ABORT_KEY": 122, "REJECTED_SNAPSHOT_ABORT_NO_SUCH_SNAPSHOT": 123, } )
Enum value maps for Status.
var File_api_committerpb_block_query_proto protoreflect.FileDescriptor
var File_api_committerpb_notify_proto protoreflect.FileDescriptor
var File_api_committerpb_query_proto protoreflect.FileDescriptor
var File_api_committerpb_ref_proto protoreflect.FileDescriptor
var File_api_committerpb_sidecar_proto protoreflect.FileDescriptor
var File_api_committerpb_snapshot_proto protoreflect.FileDescriptor
var File_api_committerpb_status_proto protoreflect.FileDescriptor
var QueryService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "committerpb.QueryService", HandlerType: (*QueryServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetRows", Handler: _QueryService_GetRows_Handler, }, { MethodName: "BeginView", Handler: _QueryService_BeginView_Handler, }, { MethodName: "EndView", Handler: _QueryService_EndView_Handler, }, { MethodName: "GetNamespacePolicies", Handler: _QueryService_GetNamespacePolicies_Handler, }, { MethodName: "GetConfigTransaction", Handler: _QueryService_GetConfigTransaction_Handler, }, { MethodName: "GetTransactionStatus", Handler: _QueryService_GetTransactionStatus_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "api/committerpb/query.proto", }
QueryService_ServiceDesc is the grpc.ServiceDesc for QueryService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var SidecarService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "committerpb.SidecarService", HandlerType: (*SidecarServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetBlockchainInfo", Handler: _SidecarService_GetBlockchainInfo_Handler, }, { MethodName: "GetBlockByNumber", Handler: _SidecarService_GetBlockByNumber_Handler, }, { MethodName: "GetBlockByTxID", Handler: _SidecarService_GetBlockByTxID_Handler, }, { MethodName: "GetTxByID", Handler: _SidecarService_GetTxByID_Handler, }, { MethodName: "DeleteDBCloneForSnapshot", Handler: _SidecarService_DeleteDBCloneForSnapshot_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "OpenNotificationStream", Handler: _SidecarService_OpenNotificationStream_Handler, ServerStreams: true, ClientStreams: true, }, { StreamName: "StreamBlocks", Handler: _SidecarService_StreamBlocks_Handler, ServerStreams: true, }, }, Metadata: "api/committerpb/sidecar.proto", }
SidecarService_ServiceDesc is the grpc.ServiceDesc for SidecarService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func AreSameHeight ¶
AreSameHeight returns true if both references' heights are either nil or equal.
func BlockNumFromSnapshotAbortKey ¶ added in v0.2.9
BlockNumFromSnapshotAbortKey decodes an abort key into the block number of the snapshot it abandons.
Trailing bytes are rejected rather than ignored, as for a checkpoint key: accepting a prefix would attribute the abort to the wrong snapshot.
func IsSnapshotAbortKey ¶ added in v0.2.9
IsSnapshotAbortKey reports whether key is an abort key rather than a snapshot record's key.
Only the prefix is inspected: a prefixed key whose block number does not decode is an abort transaction with a bad key, which must be rejected as one rather than mistaken for a snapshot request.
func IsSystemNamespace ¶ added in v0.2.9
IsSystemNamespace returns true if nsID is a reserved system namespace ID.
func RegisterQueryServiceServer ¶
func RegisterQueryServiceServer(s grpc.ServiceRegistrar, srv QueryServiceServer)
func RegisterSidecarServiceServer ¶ added in v0.2.9
func RegisterSidecarServiceServer(s grpc.ServiceRegistrar, srv SidecarServiceServer)
func SnapshotAbortKey ¶ added in v0.2.9
SnapshotAbortKey returns the `_snapshot` namespace key an abort snapshot transaction writes to abandon the snapshot taken at blockNum.
The snapshot is named by block number alone -- a snapshot is a cut of committed state and a block holds at most one `_snapshot` transaction, so the transaction number adds no distinguishing power -- and the number is encoded order-preserving so aborts can be compared and range-scanned directly on the stored key.
func SystemNamespaces ¶ added in v0.2.9
func SystemNamespaces() []string
SystemNamespaces returns all reserved system namespace IDs.
Types ¶
type BlockEvent ¶ added in v0.2.9
type BlockEvent struct {
// The header of the block from which these transactions originated.
// It carries the block number, the previous block hash and the data hash.
// The block hash can be computed from it with protoutil.BlockHeaderHash.
Header *common.BlockHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
// List of transaction events (may be filtered based on request).
Events []*TxEvent `protobuf:"bytes,2,rep,name=events,proto3" json:"events,omitempty"`
// contains filtered or unexported fields
}
BlockEvent contains a batch of transaction events from a single block.
func (*BlockEvent) Descriptor
deprecated
added in
v0.2.9
func (*BlockEvent) Descriptor() ([]byte, []int)
Deprecated: Use BlockEvent.ProtoReflect.Descriptor instead.
func (*BlockEvent) GetEvents ¶ added in v0.2.9
func (x *BlockEvent) GetEvents() []*TxEvent
func (*BlockEvent) GetHeader ¶ added in v0.2.9
func (x *BlockEvent) GetHeader() *common.BlockHeader
func (*BlockEvent) ProtoMessage ¶ added in v0.2.9
func (*BlockEvent) ProtoMessage()
func (*BlockEvent) ProtoReflect ¶ added in v0.2.9
func (x *BlockEvent) ProtoReflect() protoreflect.Message
func (*BlockEvent) Reset ¶ added in v0.2.9
func (x *BlockEvent) Reset()
func (*BlockEvent) String ¶ added in v0.2.9
func (x *BlockEvent) String() string
type BlockNumber ¶ added in v0.2.0
type BlockNumber struct {
Number uint64 `protobuf:"varint,1,opt,name=number,proto3" json:"number,omitempty"`
// contains filtered or unexported fields
}
func (*BlockNumber) Descriptor
deprecated
added in
v0.2.0
func (*BlockNumber) Descriptor() ([]byte, []int)
Deprecated: Use BlockNumber.ProtoReflect.Descriptor instead.
func (*BlockNumber) GetNumber ¶ added in v0.2.0
func (x *BlockNumber) GetNumber() uint64
func (*BlockNumber) ProtoMessage ¶ added in v0.2.0
func (*BlockNumber) ProtoMessage()
func (*BlockNumber) ProtoReflect ¶ added in v0.2.0
func (x *BlockNumber) ProtoReflect() protoreflect.Message
func (*BlockNumber) Reset ¶ added in v0.2.0
func (x *BlockNumber) Reset()
func (*BlockNumber) String ¶ added in v0.2.0
func (x *BlockNumber) String() string
type DeleteDBCloneForSnapshotRequest ¶ added in v0.2.9
type DeleteDBCloneForSnapshotRequest struct {
// Transaction ID of the snapshot transaction, the _snapshot namespace row key.
TxId string `protobuf:"bytes,1,opt,name=tx_id,json=txId,proto3" json:"tx_id,omitempty"`
// contains filtered or unexported fields
}
DeleteDBCloneForSnapshotRequest identifies the snapshot whose database clone is dropped.
func (*DeleteDBCloneForSnapshotRequest) Descriptor
deprecated
added in
v0.2.9
func (*DeleteDBCloneForSnapshotRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteDBCloneForSnapshotRequest.ProtoReflect.Descriptor instead.
func (*DeleteDBCloneForSnapshotRequest) GetTxId ¶ added in v0.2.9
func (x *DeleteDBCloneForSnapshotRequest) GetTxId() string
func (*DeleteDBCloneForSnapshotRequest) ProtoMessage ¶ added in v0.2.9
func (*DeleteDBCloneForSnapshotRequest) ProtoMessage()
func (*DeleteDBCloneForSnapshotRequest) ProtoReflect ¶ added in v0.2.9
func (x *DeleteDBCloneForSnapshotRequest) ProtoReflect() protoreflect.Message
func (*DeleteDBCloneForSnapshotRequest) Reset ¶ added in v0.2.9
func (x *DeleteDBCloneForSnapshotRequest) Reset()
func (*DeleteDBCloneForSnapshotRequest) String ¶ added in v0.2.9
func (x *DeleteDBCloneForSnapshotRequest) String() string
type IsoLevel ¶
type IsoLevel int32
func (IsoLevel) Descriptor ¶
func (IsoLevel) Descriptor() protoreflect.EnumDescriptor
func (IsoLevel) EnumDescriptor
deprecated
func (IsoLevel) Number ¶
func (x IsoLevel) Number() protoreflect.EnumNumber
func (IsoLevel) Type ¶
func (IsoLevel) Type() protoreflect.EnumType
type NotificationRequest ¶
type NotificationRequest struct {
TxStatusRequest *TxIDsBatch `protobuf:"bytes,1,opt,name=tx_status_request,json=txStatusRequest,proto3,oneof" json:"tx_status_request,omitempty"`
// The timeout duration that applies to ALL the subscriptions in this request.
// It is non-strict, i.e., it is possible to receive notifications for this request
// after the timeout has passed.
// If this field is not set or has a default value (zero), the default would be applied as
// per the committer's configuration.
Timeout *durationpb.Duration `protobuf:"bytes,2,opt,name=timeout,proto3" json:"timeout,omitempty"`
// contains filtered or unexported fields
}
NotificationRequest is sent by the clients to subscribe to events.
func (*NotificationRequest) Descriptor
deprecated
func (*NotificationRequest) Descriptor() ([]byte, []int)
Deprecated: Use NotificationRequest.ProtoReflect.Descriptor instead.
func (*NotificationRequest) GetTimeout ¶
func (x *NotificationRequest) GetTimeout() *durationpb.Duration
func (*NotificationRequest) GetTxStatusRequest ¶
func (x *NotificationRequest) GetTxStatusRequest() *TxIDsBatch
func (*NotificationRequest) ProtoMessage ¶
func (*NotificationRequest) ProtoMessage()
func (*NotificationRequest) ProtoReflect ¶
func (x *NotificationRequest) ProtoReflect() protoreflect.Message
func (*NotificationRequest) Reset ¶
func (x *NotificationRequest) Reset()
func (*NotificationRequest) String ¶
func (x *NotificationRequest) String() string
type NotificationResponse ¶
type NotificationResponse struct {
TxStatusEvents []*TxStatus `protobuf:"bytes,1,rep,name=tx_status_events,json=txStatusEvents,proto3" json:"tx_status_events,omitempty"` // List of transaction status events.
TimeoutTxIds []string `protobuf:"bytes,2,rep,name=timeout_tx_ids,json=timeoutTxIds,proto3" json:"timeout_tx_ids,omitempty"` // List of timeout events.
RejectedTxIds *RejectedTxIds `protobuf:"bytes,3,opt,name=rejected_tx_ids,json=rejectedTxIds,proto3" json:"rejected_tx_ids,omitempty"` // List of rejected transaction IDs with a reason.
// contains filtered or unexported fields
}
NotificationResponse contains a batch of event details. It is pushed to the client via the stream.
func (*NotificationResponse) Descriptor
deprecated
func (*NotificationResponse) Descriptor() ([]byte, []int)
Deprecated: Use NotificationResponse.ProtoReflect.Descriptor instead.
func (*NotificationResponse) GetRejectedTxIds ¶ added in v0.2.0
func (x *NotificationResponse) GetRejectedTxIds() *RejectedTxIds
func (*NotificationResponse) GetTimeoutTxIds ¶
func (x *NotificationResponse) GetTimeoutTxIds() []string
func (*NotificationResponse) GetTxStatusEvents ¶
func (x *NotificationResponse) GetTxStatusEvents() []*TxStatus
func (*NotificationResponse) ProtoMessage ¶
func (*NotificationResponse) ProtoMessage()
func (*NotificationResponse) ProtoReflect ¶
func (x *NotificationResponse) ProtoReflect() protoreflect.Message
func (*NotificationResponse) Reset ¶
func (x *NotificationResponse) Reset()
func (*NotificationResponse) String ¶
func (x *NotificationResponse) String() string
type Query ¶
type Query struct {
View *View `protobuf:"bytes,1,opt,name=view,proto3,oneof" json:"view,omitempty"`
Namespaces []*QueryNamespace `protobuf:"bytes,2,rep,name=namespaces,proto3" json:"namespaces,omitempty"`
// contains filtered or unexported fields
}
func (*Query) Descriptor
deprecated
func (*Query) GetNamespaces ¶
func (x *Query) GetNamespaces() []*QueryNamespace
func (*Query) ProtoMessage ¶
func (*Query) ProtoMessage()
func (*Query) ProtoReflect ¶
func (x *Query) ProtoReflect() protoreflect.Message
type QueryNamespace ¶
type QueryNamespace struct {
NsId string `protobuf:"bytes,1,opt,name=ns_id,json=nsId,proto3" json:"ns_id,omitempty"`
Keys [][]byte `protobuf:"bytes,2,rep,name=keys,proto3" json:"keys,omitempty"`
// contains filtered or unexported fields
}
func (*QueryNamespace) Descriptor
deprecated
func (*QueryNamespace) Descriptor() ([]byte, []int)
Deprecated: Use QueryNamespace.ProtoReflect.Descriptor instead.
func (*QueryNamespace) GetKeys ¶
func (x *QueryNamespace) GetKeys() [][]byte
func (*QueryNamespace) GetNsId ¶
func (x *QueryNamespace) GetNsId() string
func (*QueryNamespace) ProtoMessage ¶
func (*QueryNamespace) ProtoMessage()
func (*QueryNamespace) ProtoReflect ¶
func (x *QueryNamespace) ProtoReflect() protoreflect.Message
func (*QueryNamespace) Reset ¶
func (x *QueryNamespace) Reset()
func (*QueryNamespace) String ¶
func (x *QueryNamespace) String() string
type QueryServiceClient ¶
type QueryServiceClient interface {
GetRows(ctx context.Context, in *Query, opts ...grpc.CallOption) (*Rows, error)
BeginView(ctx context.Context, in *ViewParameters, opts ...grpc.CallOption) (*View, error)
EndView(ctx context.Context, in *View, opts ...grpc.CallOption) (*emptypb.Empty, error)
GetNamespacePolicies(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*applicationpb.NamespacePolicies, error)
GetConfigTransaction(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*applicationpb.ConfigTransaction, error)
GetTransactionStatus(ctx context.Context, in *TxStatusQuery, opts ...grpc.CallOption) (*TxStatusResponse, error)
}
QueryServiceClient is the client API for QueryService 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 NewQueryServiceClient ¶
func NewQueryServiceClient(cc grpc.ClientConnInterface) QueryServiceClient
type QueryServiceServer ¶
type QueryServiceServer interface {
GetRows(context.Context, *Query) (*Rows, error)
BeginView(context.Context, *ViewParameters) (*View, error)
EndView(context.Context, *View) (*emptypb.Empty, error)
GetNamespacePolicies(context.Context, *emptypb.Empty) (*applicationpb.NamespacePolicies, error)
GetConfigTransaction(context.Context, *emptypb.Empty) (*applicationpb.ConfigTransaction, error)
GetTransactionStatus(context.Context, *TxStatusQuery) (*TxStatusResponse, error)
// contains filtered or unexported methods
}
QueryServiceServer is the server API for QueryService service. All implementations must embed UnimplementedQueryServiceServer for forward compatibility.
type RejectedTxIds ¶ added in v0.2.0
type RejectedTxIds struct {
TxIds []string `protobuf:"bytes,1,rep,name=tx_ids,json=txIds,proto3" json:"tx_ids,omitempty"` // List of rejected transaction IDs.
Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"` // The reason for rejection.
// contains filtered or unexported fields
}
RejectedTxIds contains a list of transaction IDs that were rejected along with the reason.
func (*RejectedTxIds) Descriptor
deprecated
added in
v0.2.0
func (*RejectedTxIds) Descriptor() ([]byte, []int)
Deprecated: Use RejectedTxIds.ProtoReflect.Descriptor instead.
func (*RejectedTxIds) GetReason ¶ added in v0.2.0
func (x *RejectedTxIds) GetReason() string
func (*RejectedTxIds) GetTxIds ¶ added in v0.2.0
func (x *RejectedTxIds) GetTxIds() []string
func (*RejectedTxIds) ProtoMessage ¶ added in v0.2.0
func (*RejectedTxIds) ProtoMessage()
func (*RejectedTxIds) ProtoReflect ¶ added in v0.2.0
func (x *RejectedTxIds) ProtoReflect() protoreflect.Message
func (*RejectedTxIds) Reset ¶ added in v0.2.0
func (x *RejectedTxIds) Reset()
func (*RejectedTxIds) String ¶ added in v0.2.0
func (x *RejectedTxIds) String() string
type Row ¶
type Row struct {
Key []byte `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
Version uint64 `protobuf:"varint,3,opt,name=version,proto3" json:"version,omitempty"`
// contains filtered or unexported fields
}
func (*Row) Descriptor
deprecated
func (*Row) GetVersion ¶
func (*Row) ProtoMessage ¶
func (*Row) ProtoMessage()
func (*Row) ProtoReflect ¶
func (x *Row) ProtoReflect() protoreflect.Message
type Rows ¶
type Rows struct {
Namespaces []*RowsNamespace `protobuf:"bytes,1,rep,name=namespaces,proto3" json:"namespaces,omitempty"`
// contains filtered or unexported fields
}
func (*Rows) Descriptor
deprecated
func (*Rows) GetNamespaces ¶
func (x *Rows) GetNamespaces() []*RowsNamespace
func (*Rows) ProtoMessage ¶
func (*Rows) ProtoMessage()
func (*Rows) ProtoReflect ¶
func (x *Rows) ProtoReflect() protoreflect.Message
type RowsNamespace ¶
type RowsNamespace struct {
NsId string `protobuf:"bytes,1,opt,name=ns_id,json=nsId,proto3" json:"ns_id,omitempty"`
Rows []*Row `protobuf:"bytes,2,rep,name=rows,proto3" json:"rows,omitempty"`
// contains filtered or unexported fields
}
func (*RowsNamespace) Descriptor
deprecated
func (*RowsNamespace) Descriptor() ([]byte, []int)
Deprecated: Use RowsNamespace.ProtoReflect.Descriptor instead.
func (*RowsNamespace) GetNsId ¶
func (x *RowsNamespace) GetNsId() string
func (*RowsNamespace) GetRows ¶
func (x *RowsNamespace) GetRows() []*Row
func (*RowsNamespace) ProtoMessage ¶
func (*RowsNamespace) ProtoMessage()
func (*RowsNamespace) ProtoReflect ¶
func (x *RowsNamespace) ProtoReflect() protoreflect.Message
func (*RowsNamespace) Reset ¶
func (x *RowsNamespace) Reset()
func (*RowsNamespace) String ¶
func (x *RowsNamespace) String() string
type SidecarServiceClient ¶ added in v0.2.9
type SidecarServiceClient interface {
// Block store reads. Previously BlockQueryService.
GetBlockchainInfo(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*common.BlockchainInfo, error)
GetBlockByNumber(ctx context.Context, in *BlockNumber, opts ...grpc.CallOption) (*common.Block, error)
GetBlockByTxID(ctx context.Context, in *TxID, opts ...grpc.CallOption) (*common.Block, error)
GetTxByID(ctx context.Context, in *TxID, opts ...grpc.CallOption) (*common.Envelope, error)
// Event subscriptions. Previously Notifier.
OpenNotificationStream(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[NotificationRequest, NotificationResponse], error)
StreamBlocks(ctx context.Context, in *StreamBlocksRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[BlockEvent], error)
// Snapshot-clone administration. The committer answers UNIMPLEMENTED until
// the clone-deletion pipeline lands.
DeleteDBCloneForSnapshot(ctx context.Context, in *DeleteDBCloneForSnapshotRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}
SidecarServiceClient is the client API for SidecarService 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.
SidecarService is the single service backing sidecar client traffic: block queries, event notifications, and snapshot-clone administration. New sidecar RPCs belong here rather than in a new service.
Fabric block delivery is deliberately not part of this service. It stays on the Fabric `protos.Deliver` service so Fabric clients can dial the sidecar unchanged; one sidecar object backs both services.
func NewSidecarServiceClient ¶ added in v0.2.9
func NewSidecarServiceClient(cc grpc.ClientConnInterface) SidecarServiceClient
type SidecarServiceServer ¶ added in v0.2.9
type SidecarServiceServer interface {
// Block store reads. Previously BlockQueryService.
GetBlockchainInfo(context.Context, *emptypb.Empty) (*common.BlockchainInfo, error)
GetBlockByNumber(context.Context, *BlockNumber) (*common.Block, error)
GetBlockByTxID(context.Context, *TxID) (*common.Block, error)
GetTxByID(context.Context, *TxID) (*common.Envelope, error)
// Event subscriptions. Previously Notifier.
OpenNotificationStream(grpc.BidiStreamingServer[NotificationRequest, NotificationResponse]) error
StreamBlocks(*StreamBlocksRequest, grpc.ServerStreamingServer[BlockEvent]) error
// Snapshot-clone administration. The committer answers UNIMPLEMENTED until
// the clone-deletion pipeline lands.
DeleteDBCloneForSnapshot(context.Context, *DeleteDBCloneForSnapshotRequest) (*emptypb.Empty, error)
// contains filtered or unexported methods
}
SidecarServiceServer is the server API for SidecarService service. All implementations must embed UnimplementedSidecarServiceServer for forward compatibility.
SidecarService is the single service backing sidecar client traffic: block queries, event notifications, and snapshot-clone administration. New sidecar RPCs belong here rather than in a new service.
Fabric block delivery is deliberately not part of this service. It stays on the Fabric `protos.Deliver` service so Fabric clients can dial the sidecar unchanged; one sidecar object backs both services.
type SidecarService_OpenNotificationStreamClient ¶ added in v0.2.9
type SidecarService_OpenNotificationStreamClient = grpc.BidiStreamingClient[NotificationRequest, NotificationResponse]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type SidecarService_OpenNotificationStreamServer ¶ added in v0.2.9
type SidecarService_OpenNotificationStreamServer = grpc.BidiStreamingServer[NotificationRequest, NotificationResponse]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type SidecarService_StreamBlocksClient ¶ added in v0.2.9
type SidecarService_StreamBlocksClient = grpc.ServerStreamingClient[BlockEvent]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type SidecarService_StreamBlocksServer ¶ added in v0.2.9
type SidecarService_StreamBlocksServer = grpc.ServerStreamingServer[BlockEvent]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type SnapshotState ¶ added in v0.2.9
type SnapshotState struct {
// Reference identifying snapshot transaction and its position in the block.
TxRef *TxRef `protobuf:"bytes,1,opt,name=tx_ref,json=txRef,proto3" json:"tx_ref,omitempty"`
// Current snapshot lifecycle status.
Status SnapshotState_Status `protobuf:"varint,2,opt,name=status,proto3,enum=committerpb.SnapshotState_Status" json:"status,omitempty"`
// Deterministic hash computed from snapshot database contents.
Hash []byte `protobuf:"bytes,3,opt,name=hash,proto3" json:"hash,omitempty"`
// Diagnostic context for a recoverable snapshot failure.
Error string `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`
// Name of the database clone used to compute the snapshot hash.
CloneDatabase string `protobuf:"bytes,5,opt,name=clone_database,json=cloneDatabase,proto3" json:"clone_database,omitempty"`
// Checkpoint hash that differed from the local snapshot hash.
// Empty when no checkpoint mismatch has been recorded.
CheckpointHash []byte `protobuf:"bytes,6,opt,name=checkpoint_hash,json=checkpointHash,proto3" json:"checkpoint_hash,omitempty"`
// contains filtered or unexported fields
}
SnapshotState describes state for a snapshot transaction.
Snapshot state is stored in the _snapshot system namespace. The snapshot transaction ID is the row key, encoded as UTF-8 transaction ID bytes, and the row value is the serialized SnapshotState protobuf message.
func (*SnapshotState) Descriptor
deprecated
added in
v0.2.9
func (*SnapshotState) Descriptor() ([]byte, []int)
Deprecated: Use SnapshotState.ProtoReflect.Descriptor instead.
func (*SnapshotState) GetCheckpointHash ¶ added in v0.2.9
func (x *SnapshotState) GetCheckpointHash() []byte
func (*SnapshotState) GetCloneDatabase ¶ added in v0.2.9
func (x *SnapshotState) GetCloneDatabase() string
func (*SnapshotState) GetError ¶ added in v0.2.9
func (x *SnapshotState) GetError() string
func (*SnapshotState) GetHash ¶ added in v0.2.9
func (x *SnapshotState) GetHash() []byte
func (*SnapshotState) GetStatus ¶ added in v0.2.9
func (x *SnapshotState) GetStatus() SnapshotState_Status
func (*SnapshotState) GetTxRef ¶ added in v0.2.9
func (x *SnapshotState) GetTxRef() *TxRef
func (*SnapshotState) ProtoMessage ¶ added in v0.2.9
func (*SnapshotState) ProtoMessage()
func (*SnapshotState) ProtoReflect ¶ added in v0.2.9
func (x *SnapshotState) ProtoReflect() protoreflect.Message
func (*SnapshotState) Reset ¶ added in v0.2.9
func (x *SnapshotState) Reset()
func (*SnapshotState) String ¶ added in v0.2.9
func (x *SnapshotState) String() string
type SnapshotState_Status ¶ added in v0.2.9
type SnapshotState_Status int32
const ( SnapshotState_STATUS_UNSPECIFIED SnapshotState_Status = 0 SnapshotState_PENDING SnapshotState_Status = 1 SnapshotState_IN_PROGRESS SnapshotState_Status = 2 SnapshotState_COMPLETED SnapshotState_Status = 3 SnapshotState_FAILED SnapshotState_Status = 4 SnapshotState_CHECKPOINTED SnapshotState_Status = 5 SnapshotState_ABORTED SnapshotState_Status = 6 )
func (SnapshotState_Status) Descriptor ¶ added in v0.2.9
func (SnapshotState_Status) Descriptor() protoreflect.EnumDescriptor
func (SnapshotState_Status) Enum ¶ added in v0.2.9
func (x SnapshotState_Status) Enum() *SnapshotState_Status
func (SnapshotState_Status) EnumDescriptor
deprecated
added in
v0.2.9
func (SnapshotState_Status) EnumDescriptor() ([]byte, []int)
Deprecated: Use SnapshotState_Status.Descriptor instead.
func (SnapshotState_Status) Number ¶ added in v0.2.9
func (x SnapshotState_Status) Number() protoreflect.EnumNumber
func (SnapshotState_Status) String ¶ added in v0.2.9
func (x SnapshotState_Status) String() string
func (SnapshotState_Status) Type ¶ added in v0.2.9
func (SnapshotState_Status) Type() protoreflect.EnumType
type Status ¶
type Status int32
Status represents the result of transaction validation. Except for STATUS_UNSPECIFIED, all statuses are recorded in the ledger. Some statuses are also stored in the state database which prevent resubmission of the same transaction ID.
const ( // Should never be persisted or reported. Status_STATUS_UNSPECIFIED Status = 0 // Default. The transaction has not been validated yet. // Stored in the state database. Prevents submitting a transaction with the same ID. Status_COMMITTED Status = 1 // Successfully committed and state updated. Status_ABORTED_SIGNATURE_INVALID Status = 2 // Signature is invalid according to the namespace policy. Status_ABORTED_MVCC_CONFLICT Status = 3 // Read-write set conflict. // Cannot be stored in the state database because the TX ID cannot be extracted, // or the TX ID entry is already occupied. Status_REJECTED_DUPLICATE_TX_ID Status = 100 // Transaction with the same ID has already been processed. Status_MALFORMED_BAD_ENVELOPE Status = 101 // Cannot unmarshal envelope. Status_MALFORMED_MISSING_TX_ID Status = 102 // Envelope is missing transaction ID. // Stored in the state database. Prevents submitting a transaction with the same ID. Status_MALFORMED_UNSUPPORTED_ENVELOPE_PAYLOAD Status = 103 // Unsupported envelope payload type. Status_MALFORMED_BAD_ENVELOPE_PAYLOAD Status = 104 // Cannot unmarshal envelope's payload. Status_MALFORMED_TX_ID_CONFLICT Status = 105 // Envelope's TX ID does not match the payload's TX ID. Status_MALFORMED_EMPTY_NAMESPACES Status = 106 // No namespaces provided. Status_MALFORMED_DUPLICATE_NAMESPACE Status = 107 // Duplicate namespace detected. Status_MALFORMED_NAMESPACE_ID_INVALID Status = 108 // Invalid namespace identifier. Status_MALFORMED_BLIND_WRITES_NOT_ALLOWED Status = 109 // Blind writes are not allowed in a namespace transaction. Status_MALFORMED_NO_WRITES Status = 110 // No write operations in the transaction. Status_MALFORMED_EMPTY_KEY Status = 111 // Unset key detected. Status_MALFORMED_DUPLICATE_KEY_IN_READ_WRITE_SET Status = 112 // Duplicate key in the read-write set. Status_MALFORMED_MISSING_SIGNATURE Status = 113 // Number of signatures does not match the number of namespaces. Status_MALFORMED_NAMESPACE_POLICY_INVALID Status = 114 // Invalid namespace policy. Status_MALFORMED_CONFIG_TX_INVALID Status = 115 // Invalid configuration transaction. Status_MALFORMED_SNAPSHOT_NOT_MARKER_ONLY Status = 116 // _snapshot TX is neither a marker-only snapshot request (entirely empty read-write set) nor an abort snapshot TX (exactly one read-write, no reads, no blind writes). Status_MALFORMED_CHECKPOINT_INVALID_KEY Status = 117 // _checkpoint TX read-write key does not decode as a valid TxHeight. Status_MALFORMED_SYSTEM_TX_NOT_STANDALONE Status = 118 // System TX must be standalone and cannot be mixed with other namespaces. Status_REJECTED_SNAPSHOT_IN_PROGRESS Status = 119 // Another snapshot is still being hashed / awaiting its checkpoint (a prior _snapshot row is not yet CHECKPOINTED). Status_REJECTED_SNAPSHOT_NO_CHECKPOINT Status = 120 // A prior snapshot exists that was never checkpointed, so a new snapshot cannot be accepted. Status_REJECTED_DUPLICATE_SNAPSHOT_IN_BLOCK Status = 121 // More than one snapshot TX appeared in the same block; only the first is processed and the rest are rejected regardless of the first's outcome. Status_MALFORMED_SNAPSHOT_INVALID_ABORT_KEY Status = 122 // An abort snapshot TX's read-write key does not decode as an abort key naming a snapshot's block number. Status_REJECTED_SNAPSHOT_ABORT_NO_SUCH_SNAPSHOT Status = 123 // An abort snapshot TX names a block that is not the snapshot awaiting its checkpoint, or that snapshot's lifecycle is already closed (CHECKPOINTED/ABORTED). )
func (Status) Descriptor ¶
func (Status) Descriptor() protoreflect.EnumDescriptor
func (Status) EnumDescriptor
deprecated
func (Status) Number ¶
func (x Status) Number() protoreflect.EnumNumber
func (Status) Type ¶
func (Status) Type() protoreflect.EnumType
type StreamBlocksRequest ¶ added in v0.2.9
type StreamBlocksRequest struct {
// Filter by namespace IDs (OR logic: transaction touches ANY of these namespaces).
// Empty list means no namespace filtering (all namespaces included).
FilterNamespaces []string `protobuf:"bytes,1,rep,name=filter_namespaces,json=filterNamespaces,proto3" json:"filter_namespaces,omitempty"`
// Filter by transaction status (multiple statuses can be specified).
// Empty list means no status filtering (all statuses included).
FilterStatus []Status `` /* 129-byte string literal not displayed */
// Include transaction content (read/write sets) in the response.
// Default: false (only transaction reference and status).
IncludeReadWriteSets bool `` /* 126-byte string literal not displayed */
// Include endorsements in the response.
// Default: false (only transaction reference and status).
IncludeEndorsements bool `protobuf:"varint,4,opt,name=include_endorsements,json=includeEndorsements,proto3" json:"include_endorsements,omitempty"`
// Include metadata in the response.
// Default: false (only transaction reference and status).
IncludeMetadata bool `protobuf:"varint,5,opt,name=include_metadata,json=includeMetadata,proto3" json:"include_metadata,omitempty"`
// contains filtered or unexported fields
}
StreamBlocksRequest is sent by clients to subscribe to all committed transactions.
func (*StreamBlocksRequest) Descriptor
deprecated
added in
v0.2.9
func (*StreamBlocksRequest) Descriptor() ([]byte, []int)
Deprecated: Use StreamBlocksRequest.ProtoReflect.Descriptor instead.
func (*StreamBlocksRequest) GetFilterNamespaces ¶ added in v0.2.9
func (x *StreamBlocksRequest) GetFilterNamespaces() []string
func (*StreamBlocksRequest) GetFilterStatus ¶ added in v0.2.9
func (x *StreamBlocksRequest) GetFilterStatus() []Status
func (*StreamBlocksRequest) GetIncludeEndorsements ¶ added in v0.2.9
func (x *StreamBlocksRequest) GetIncludeEndorsements() bool
func (*StreamBlocksRequest) GetIncludeMetadata ¶ added in v0.2.9
func (x *StreamBlocksRequest) GetIncludeMetadata() bool
func (*StreamBlocksRequest) GetIncludeReadWriteSets ¶ added in v0.2.9
func (x *StreamBlocksRequest) GetIncludeReadWriteSets() bool
func (*StreamBlocksRequest) ProtoMessage ¶ added in v0.2.9
func (*StreamBlocksRequest) ProtoMessage()
func (*StreamBlocksRequest) ProtoReflect ¶ added in v0.2.9
func (x *StreamBlocksRequest) ProtoReflect() protoreflect.Message
func (*StreamBlocksRequest) Reset ¶ added in v0.2.9
func (x *StreamBlocksRequest) Reset()
func (*StreamBlocksRequest) String ¶ added in v0.2.9
func (x *StreamBlocksRequest) String() string
type TxEvent ¶ added in v0.2.5
type TxEvent struct {
// Transaction reference (ID, block number, transaction index).
Ref *TxRef `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
// Transaction commit status.
Status Status `protobuf:"varint,2,opt,name=status,proto3,enum=committerpb.Status" json:"status,omitempty"`
// Transaction namespaces (included only if include_read_write_sets is true).
// If namespace filtering is active, only matching namespaces are included.
// Empty if not requested or if transaction has no namespaces.
Namespaces []*applicationpb.TxNamespace `protobuf:"bytes,3,rep,name=namespaces,proto3" json:"namespaces,omitempty"`
// Transaction endorsements (included only if include_endorsements is true).
// Empty if not requested or if transaction has no endorsements.
Endorsements []*applicationpb.Endorsements `protobuf:"bytes,4,rep,name=endorsements,proto3" json:"endorsements,omitempty"`
// Transaction metadata (included only if include_metadata is true).
// Empty if not requested or if transaction has no metadata.
Metadata [][]byte `protobuf:"bytes,5,rep,name=metadata,proto3" json:"metadata,omitempty"`
// contains filtered or unexported fields
}
TxEvent represents a single transaction event.
func (*TxEvent) Descriptor
deprecated
added in
v0.2.5
func (*TxEvent) GetEndorsements ¶ added in v0.2.5
func (x *TxEvent) GetEndorsements() []*applicationpb.Endorsements
func (*TxEvent) GetMetadata ¶ added in v0.2.6
func (*TxEvent) GetNamespaces ¶ added in v0.2.5
func (x *TxEvent) GetNamespaces() []*applicationpb.TxNamespace
func (*TxEvent) ProtoMessage ¶ added in v0.2.5
func (*TxEvent) ProtoMessage()
func (*TxEvent) ProtoReflect ¶ added in v0.2.5
func (x *TxEvent) ProtoReflect() protoreflect.Message
type TxID ¶ added in v0.2.0
type TxID struct {
TxId string `protobuf:"bytes,1,opt,name=tx_id,json=txId,proto3" json:"tx_id,omitempty"`
// contains filtered or unexported fields
}
func (*TxID) Descriptor
deprecated
added in
v0.2.0
func (*TxID) ProtoMessage ¶ added in v0.2.0
func (*TxID) ProtoMessage()
func (*TxID) ProtoReflect ¶ added in v0.2.0
func (x *TxID) ProtoReflect() protoreflect.Message
type TxIDsBatch ¶
type TxIDsBatch struct {
TxIds []string `protobuf:"bytes,1,rep,name=tx_ids,json=txIds,proto3" json:"tx_ids,omitempty"` // List of transaction IDs.
// contains filtered or unexported fields
}
A batch of TX IDs.
func (*TxIDsBatch) Descriptor
deprecated
func (*TxIDsBatch) Descriptor() ([]byte, []int)
Deprecated: Use TxIDsBatch.ProtoReflect.Descriptor instead.
func (*TxIDsBatch) GetTxIds ¶
func (x *TxIDsBatch) GetTxIds() []string
func (*TxIDsBatch) ProtoMessage ¶
func (*TxIDsBatch) ProtoMessage()
func (*TxIDsBatch) ProtoReflect ¶
func (x *TxIDsBatch) ProtoReflect() protoreflect.Message
func (*TxIDsBatch) Reset ¶
func (x *TxIDsBatch) Reset()
func (*TxIDsBatch) String ¶
func (x *TxIDsBatch) String() string
type TxRef ¶
type TxRef struct {
BlockNum uint64 `protobuf:"varint,1,opt,name=block_num,json=blockNum,proto3" json:"block_num,omitempty"` // The block number.
TxNum uint32 `protobuf:"varint,2,opt,name=tx_num,json=txNum,proto3" json:"tx_num,omitempty"` // Transaction number within the block
TxId string `protobuf:"bytes,3,opt,name=tx_id,json=txId,proto3" json:"tx_id,omitempty"` // Transaction ID within the block.
// contains filtered or unexported fields
}
The TX reference with respect to the block generated by the orderer.
func (*TxRef) Descriptor
deprecated
func (*TxRef) GetBlockNum ¶
func (*TxRef) ProtoMessage ¶
func (*TxRef) ProtoMessage()
func (*TxRef) ProtoReflect ¶
func (x *TxRef) ProtoReflect() protoreflect.Message
type TxStatus ¶
type TxStatus struct {
Ref *TxRef `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
Status Status `protobuf:"varint,2,opt,name=status,proto3,enum=committerpb.Status" json:"status,omitempty"`
// contains filtered or unexported fields
}
The status of a TX.
func NewTxStatus ¶
NewTxStatus is a convenient method to create a TxStatus in a single line.
func NewTxStatusFromRef ¶
NewTxStatusFromRef is a convenient method to create a TxStatus from a TxRef in a single line.
func (*TxStatus) Descriptor
deprecated
func (*TxStatus) ProtoMessage ¶
func (*TxStatus) ProtoMessage()
func (*TxStatus) ProtoReflect ¶
func (x *TxStatus) ProtoReflect() protoreflect.Message
type TxStatusQuery ¶
type TxStatusQuery struct {
View *View `protobuf:"bytes,1,opt,name=view,proto3,oneof" json:"view,omitempty"`
TxIds []string `protobuf:"bytes,2,rep,name=tx_ids,json=txIds,proto3" json:"tx_ids,omitempty"` // List of transaction IDs.
// contains filtered or unexported fields
}
func (*TxStatusQuery) Descriptor
deprecated
func (*TxStatusQuery) Descriptor() ([]byte, []int)
Deprecated: Use TxStatusQuery.ProtoReflect.Descriptor instead.
func (*TxStatusQuery) GetTxIds ¶
func (x *TxStatusQuery) GetTxIds() []string
func (*TxStatusQuery) GetView ¶
func (x *TxStatusQuery) GetView() *View
func (*TxStatusQuery) ProtoMessage ¶
func (*TxStatusQuery) ProtoMessage()
func (*TxStatusQuery) ProtoReflect ¶
func (x *TxStatusQuery) ProtoReflect() protoreflect.Message
func (*TxStatusQuery) Reset ¶
func (x *TxStatusQuery) Reset()
func (*TxStatusQuery) String ¶
func (x *TxStatusQuery) String() string
type TxStatusResponse ¶
type TxStatusResponse struct {
Statuses []*TxStatus `protobuf:"bytes,1,rep,name=statuses,proto3" json:"statuses,omitempty"`
// contains filtered or unexported fields
}
func (*TxStatusResponse) Descriptor
deprecated
func (*TxStatusResponse) Descriptor() ([]byte, []int)
Deprecated: Use TxStatusResponse.ProtoReflect.Descriptor instead.
func (*TxStatusResponse) GetStatuses ¶
func (x *TxStatusResponse) GetStatuses() []*TxStatus
func (*TxStatusResponse) ProtoMessage ¶
func (*TxStatusResponse) ProtoMessage()
func (*TxStatusResponse) ProtoReflect ¶
func (x *TxStatusResponse) ProtoReflect() protoreflect.Message
func (*TxStatusResponse) Reset ¶
func (x *TxStatusResponse) Reset()
func (*TxStatusResponse) String ¶
func (x *TxStatusResponse) String() string
type UnimplementedQueryServiceServer ¶
type UnimplementedQueryServiceServer struct{}
UnimplementedQueryServiceServer 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.
func (UnimplementedQueryServiceServer) BeginView ¶
func (UnimplementedQueryServiceServer) BeginView(context.Context, *ViewParameters) (*View, error)
func (UnimplementedQueryServiceServer) GetConfigTransaction ¶
func (UnimplementedQueryServiceServer) GetConfigTransaction(context.Context, *emptypb.Empty) (*applicationpb.ConfigTransaction, error)
func (UnimplementedQueryServiceServer) GetNamespacePolicies ¶
func (UnimplementedQueryServiceServer) GetNamespacePolicies(context.Context, *emptypb.Empty) (*applicationpb.NamespacePolicies, error)
func (UnimplementedQueryServiceServer) GetTransactionStatus ¶
func (UnimplementedQueryServiceServer) GetTransactionStatus(context.Context, *TxStatusQuery) (*TxStatusResponse, error)
type UnimplementedSidecarServiceServer ¶ added in v0.2.9
type UnimplementedSidecarServiceServer struct{}
UnimplementedSidecarServiceServer 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.
func (UnimplementedSidecarServiceServer) DeleteDBCloneForSnapshot ¶ added in v0.2.9
func (UnimplementedSidecarServiceServer) DeleteDBCloneForSnapshot(context.Context, *DeleteDBCloneForSnapshotRequest) (*emptypb.Empty, error)
func (UnimplementedSidecarServiceServer) GetBlockByNumber ¶ added in v0.2.9
func (UnimplementedSidecarServiceServer) GetBlockByNumber(context.Context, *BlockNumber) (*common.Block, error)
func (UnimplementedSidecarServiceServer) GetBlockByTxID ¶ added in v0.2.9
func (UnimplementedSidecarServiceServer) GetBlockchainInfo ¶ added in v0.2.9
func (UnimplementedSidecarServiceServer) GetBlockchainInfo(context.Context, *emptypb.Empty) (*common.BlockchainInfo, error)
func (UnimplementedSidecarServiceServer) OpenNotificationStream ¶ added in v0.2.9
func (UnimplementedSidecarServiceServer) OpenNotificationStream(grpc.BidiStreamingServer[NotificationRequest, NotificationResponse]) error
func (UnimplementedSidecarServiceServer) StreamBlocks ¶ added in v0.2.9
func (UnimplementedSidecarServiceServer) StreamBlocks(*StreamBlocksRequest, grpc.ServerStreamingServer[BlockEvent]) error
type UnsafeQueryServiceServer ¶
type UnsafeQueryServiceServer interface {
// contains filtered or unexported methods
}
UnsafeQueryServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to QueryServiceServer will result in compilation errors.
type UnsafeSidecarServiceServer ¶ added in v0.2.9
type UnsafeSidecarServiceServer interface {
// contains filtered or unexported methods
}
UnsafeSidecarServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SidecarServiceServer will result in compilation errors.
type View ¶
type View struct {
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// contains filtered or unexported fields
}
func (*View) Descriptor
deprecated
func (*View) ProtoMessage ¶
func (*View) ProtoMessage()
func (*View) ProtoReflect ¶
func (x *View) ProtoReflect() protoreflect.Message
type ViewParameters ¶
type ViewParameters struct {
IsoLevel IsoLevel `protobuf:"varint,1,opt,name=iso_level,json=isoLevel,proto3,enum=committerpb.IsoLevel" json:"iso_level,omitempty"` // View's isolation level. Defaults to serializable.
NonDeferrable bool `protobuf:"varint,2,opt,name=non_deferrable,json=nonDeferrable,proto3" json:"non_deferrable,omitempty"` // Do not defer errors. Defaults deferrable.
TimeoutMilliseconds uint64 `protobuf:"varint,3,opt,name=timeout_milliseconds,json=timeoutMilliseconds,proto3" json:"timeout_milliseconds,omitempty"` // View's timeout. Zero => maximal value
// contains filtered or unexported fields
}
func (*ViewParameters) Descriptor
deprecated
func (*ViewParameters) Descriptor() ([]byte, []int)
Deprecated: Use ViewParameters.ProtoReflect.Descriptor instead.
func (*ViewParameters) GetIsoLevel ¶
func (x *ViewParameters) GetIsoLevel() IsoLevel
func (*ViewParameters) GetNonDeferrable ¶
func (x *ViewParameters) GetNonDeferrable() bool
func (*ViewParameters) GetTimeoutMilliseconds ¶
func (x *ViewParameters) GetTimeoutMilliseconds() uint64
func (*ViewParameters) ProtoMessage ¶
func (*ViewParameters) ProtoMessage()
func (*ViewParameters) ProtoReflect ¶
func (x *ViewParameters) ProtoReflect() protoreflect.Message
func (*ViewParameters) Reset ¶
func (x *ViewParameters) Reset()
func (*ViewParameters) String ¶
func (x *ViewParameters) String() string