partitionedtable

package
v0.15.0 Latest Latest
Warning

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

 Go to latest Published: Jul 29, 2022 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_deephaven_proto_partitionedtable_proto protoreflect.FileDescriptor
View Source 
var PartitionedTableService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "io.deephaven.proto.backplane.grpc.PartitionedTableService",
	HandlerType: (*PartitionedTableServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "PartitionBy",
			Handler:    _PartitionedTableService_PartitionBy_Handler,
		},
		{
			MethodName: "Merge",
			Handler:    _PartitionedTableService_Merge_Handler,
		},
		{
			MethodName: "GetTable",
			Handler:    _PartitionedTableService_GetTable_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "deephaven/proto/partitionedtable.proto",
}

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

Functions

func RegisterPartitionedTableServiceServer 

func RegisterPartitionedTableServiceServer(s grpc.ServiceRegistrar, srv PartitionedTableServiceServer)

Types

type GetTableRequest 

type GetTableRequest struct {

	// The ticket for the PartitionedTable object to query.
	PartitionedTable *ticket.Ticket `protobuf:"bytes,1,opt,name=partitioned_table,json=partitionedTable,proto3" json:"partitioned_table,omitempty"`
	// The ticket for the table containing the key to fetch from the partitioned table.
	KeyTableTicket *ticket.Ticket `protobuf:"bytes,2,opt,name=key_table_ticket,json=keyTableTicket,proto3" json:"key_table_ticket,omitempty"`
	// The ticket to use to hold the newly returned table.
	ResultId *ticket.Ticket `protobuf:"bytes,4,opt,name=result_id,json=resultId,proto3" json:"result_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetTableRequest) Descriptor deprecated 

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

Deprecated: Use GetTableRequest.ProtoReflect.Descriptor instead.

func (*GetTableRequest) GetKeyTableTicket 

func (x *GetTableRequest) GetKeyTableTicket() *ticket.Ticket

func (*GetTableRequest) GetPartitionedTable 

func (x *GetTableRequest) GetPartitionedTable() *ticket.Ticket

func (*GetTableRequest) GetResultId 

func (x *GetTableRequest) GetResultId() *ticket.Ticket

func (*GetTableRequest) ProtoMessage 

func (*GetTableRequest) ProtoMessage()

func (*GetTableRequest) ProtoReflect 

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

func (*GetTableRequest) Reset 

func (x *GetTableRequest) Reset()

func (*GetTableRequest) String 

func (x *GetTableRequest) String() string

type MergeRequest 

type MergeRequest struct {

	// The ticket for the PartitionedTable object to merge.
	PartitionedTable *ticket.Ticket `protobuf:"bytes,1,opt,name=partitioned_table,json=partitionedTable,proto3" json:"partitioned_table,omitempty"`
	// The ticket to use to hold the results of the merge operation.
	ResultId *ticket.Ticket `protobuf:"bytes,2,opt,name=result_id,json=resultId,proto3" json:"result_id,omitempty"`
	// contains filtered or unexported fields
}

func (*MergeRequest) Descriptor deprecated 

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

Deprecated: Use MergeRequest.ProtoReflect.Descriptor instead.

func (*MergeRequest) GetPartitionedTable 

func (x *MergeRequest) GetPartitionedTable() *ticket.Ticket

func (*MergeRequest) GetResultId 

func (x *MergeRequest) GetResultId() *ticket.Ticket

func (*MergeRequest) ProtoMessage 

func (*MergeRequest) ProtoMessage()

func (*MergeRequest) ProtoReflect 

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

func (*MergeRequest) Reset 

func (x *MergeRequest) Reset()

func (*MergeRequest) String 

func (x *MergeRequest) String() string

type PartitionByRequest 

type PartitionByRequest struct {
	TableId        *ticket.Ticket `protobuf:"bytes,1,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
	ResultId       *ticket.Ticket `protobuf:"bytes,2,opt,name=result_id,json=resultId,proto3" json:"result_id,omitempty"`
	KeyColumnNames []string       `protobuf:"bytes,3,rep,name=key_column_names,json=keyColumnNames,proto3" json:"key_column_names,omitempty"`
	DropKeys       bool           `protobuf:"varint,4,opt,name=drop_keys,json=dropKeys,proto3" json:"drop_keys,omitempty"`
	// contains filtered or unexported fields
}

func (*PartitionByRequest) Descriptor deprecated 

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

Deprecated: Use PartitionByRequest.ProtoReflect.Descriptor instead.

func (*PartitionByRequest) GetDropKeys 

func (x *PartitionByRequest) GetDropKeys() bool

func (*PartitionByRequest) GetKeyColumnNames 

func (x *PartitionByRequest) GetKeyColumnNames() []string

func (*PartitionByRequest) GetResultId 

func (x *PartitionByRequest) GetResultId() *ticket.Ticket

func (*PartitionByRequest) GetTableId 

func (x *PartitionByRequest) GetTableId() *ticket.Ticket

func (*PartitionByRequest) ProtoMessage 

func (*PartitionByRequest) ProtoMessage()

func (*PartitionByRequest) ProtoReflect 

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

func (*PartitionByRequest) Reset 

func (x *PartitionByRequest) Reset()

func (*PartitionByRequest) String 

func (x *PartitionByRequest) String() string

type PartitionByResponse 

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

func (*PartitionByResponse) Descriptor deprecated 

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

Deprecated: Use PartitionByResponse.ProtoReflect.Descriptor instead.

func (*PartitionByResponse) ProtoMessage 

func (*PartitionByResponse) ProtoMessage()

func (*PartitionByResponse) ProtoReflect 

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

func (*PartitionByResponse) Reset 

func (x *PartitionByResponse) Reset()

func (*PartitionByResponse) String 

func (x *PartitionByResponse) String() string

type PartitionedTableDescriptor 

type PartitionedTableDescriptor struct {

	// The names of the key columns. The underlying table will contain these columns - a client can
	// subscribe to these columns to see what keys are present.
	KeyColumnNames []string `protobuf:"bytes,1,rep,name=key_column_names,json=keyColumnNames,proto3" json:"key_column_names,omitempty"`
	// The name of the column in the underlying table that contains the table represented by that row.
	ConstituentColumnName string `` /* 126-byte string literal not displayed */
	// True if the keys will be unique, so any set of known keys can be queried using GetTable.
	UniqueKeys bool `protobuf:"varint,2,opt,name=unique_keys,json=uniqueKeys,proto3" json:"unique_keys,omitempty"`
	// Returns a flight Messsage wrapping a Schema that will describe every table contained in this
	// PartitionedTable.
	ConstituentDefinitionSchema []byte `` /* 144-byte string literal not displayed */
	// True if the underlying table may tick with updates. See PartitionedTable.constituentChangesPermitted()
	// for more details.
	ConstituentChangesPermitted bool `` /* 145-byte string literal not displayed */
	// contains filtered or unexported fields
}

A message that describes a partitioned table, able to be sent as a plugin object to a client. This object will also come with a ticket to the underlying table that can be used to get the constituent tables by key.

func (*PartitionedTableDescriptor) Descriptor deprecated 

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

Deprecated: Use PartitionedTableDescriptor.ProtoReflect.Descriptor instead.

func (*PartitionedTableDescriptor) GetConstituentChangesPermitted 

func (x *PartitionedTableDescriptor) GetConstituentChangesPermitted() bool

func (*PartitionedTableDescriptor) GetConstituentColumnName 

func (x *PartitionedTableDescriptor) GetConstituentColumnName() string

func (*PartitionedTableDescriptor) GetConstituentDefinitionSchema 

func (x *PartitionedTableDescriptor) GetConstituentDefinitionSchema() []byte

func (*PartitionedTableDescriptor) GetKeyColumnNames 

func (x *PartitionedTableDescriptor) GetKeyColumnNames() []string

func (*PartitionedTableDescriptor) GetUniqueKeys 

func (x *PartitionedTableDescriptor) GetUniqueKeys() bool

func (*PartitionedTableDescriptor) ProtoMessage 

func (*PartitionedTableDescriptor) ProtoMessage()

func (*PartitionedTableDescriptor) ProtoReflect 

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

func (*PartitionedTableDescriptor) Reset 

func (x *PartitionedTableDescriptor) Reset()

func (*PartitionedTableDescriptor) String 

func (x *PartitionedTableDescriptor) String() string

type PartitionedTableServiceClient 

type PartitionedTableServiceClient interface {
	//
	// Transforms a table into a partitioned table, consisting of many separate table, each individually
	// addressable. The result will be a FetchObjectResponse populated with a PartitionedTable.
	PartitionBy(ctx context.Context, in *PartitionByRequest, opts ...grpc.CallOption) (*PartitionByResponse, error)
	//
	// Given a partitioned table, returns a table with the contents of all of the constituent tables.
	Merge(ctx context.Context, in *MergeRequest, opts ...grpc.CallOption) (*table.ExportedTableCreationResponse, error)
	//
	// Given a partitioned table and a row described by another table's contents, returns a table
	// that matched that row, if any. If none is present, NOT_FOUND will be sent in response. If
	// more than one is present, FAILED_PRECONDITION will be sent in response.
	//
	// If the provided key table has any number of rows other than one, INVALID_ARGUMENT will be
	// sent in response.
	//
	// The simplest way to generally use this is to subscribe to the key columns of the underlying
	// table of a given PartitionedTable, then use /FlightService/DoPut to create a table with the
	// desired keys, and pass that ticket to this service. After that request is sent (note that it
	// is not required to wait for it to complete), that new table ticket can be used to make this
	// GetTable request.
	GetTable(ctx context.Context, in *GetTableRequest, opts ...grpc.CallOption) (*table.ExportedTableCreationResponse, error)
}

PartitionedTableServiceClient is the client API for PartitionedTableService 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 NewPartitionedTableServiceClient 

func NewPartitionedTableServiceClient(cc grpc.ClientConnInterface) PartitionedTableServiceClient

type PartitionedTableServiceServer 

type PartitionedTableServiceServer interface {
	//
	// Transforms a table into a partitioned table, consisting of many separate table, each individually
	// addressable. The result will be a FetchObjectResponse populated with a PartitionedTable.
	PartitionBy(context.Context, *PartitionByRequest) (*PartitionByResponse, error)
	//
	// Given a partitioned table, returns a table with the contents of all of the constituent tables.
	Merge(context.Context, *MergeRequest) (*table.ExportedTableCreationResponse, error)
	//
	// Given a partitioned table and a row described by another table's contents, returns a table
	// that matched that row, if any. If none is present, NOT_FOUND will be sent in response. If
	// more than one is present, FAILED_PRECONDITION will be sent in response.
	//
	// If the provided key table has any number of rows other than one, INVALID_ARGUMENT will be
	// sent in response.
	//
	// The simplest way to generally use this is to subscribe to the key columns of the underlying
	// table of a given PartitionedTable, then use /FlightService/DoPut to create a table with the
	// desired keys, and pass that ticket to this service. After that request is sent (note that it
	// is not required to wait for it to complete), that new table ticket can be used to make this
	// GetTable request.
	GetTable(context.Context, *GetTableRequest) (*table.ExportedTableCreationResponse, error)
	// contains filtered or unexported methods
}

PartitionedTableServiceServer is the server API for PartitionedTableService service. All implementations must embed UnimplementedPartitionedTableServiceServer for forward compatibility

type UnimplementedPartitionedTableServiceServer 

type UnimplementedPartitionedTableServiceServer struct {
}

UnimplementedPartitionedTableServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedPartitionedTableServiceServer) GetTable 

func (UnimplementedPartitionedTableServiceServer) GetTable(context.Context, *GetTableRequest) (*table.ExportedTableCreationResponse, error)

func (UnimplementedPartitionedTableServiceServer) Merge 

func (UnimplementedPartitionedTableServiceServer) Merge(context.Context, *MergeRequest) (*table.ExportedTableCreationResponse, error)

func (UnimplementedPartitionedTableServiceServer) PartitionBy 

func (UnimplementedPartitionedTableServiceServer) PartitionBy(context.Context, *PartitionByRequest) (*PartitionByResponse, error)

type UnsafePartitionedTableServiceServer 

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

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

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.