redcloud

type AdminServiceClient interface {
	// Create a new table with the specified metadata.
	CreateTable(ctx context.Context, in *TableMetadata, opts ...grpc.CallOption) (*Empty, error)
	// Update an existing table with the specified metadata.
	UpdateTable(ctx context.Context, in *TableMetadata, opts ...grpc.CallOption) (*Empty, error)
	//
	// Delete a table; since this will unregister it from all data nodes,
	// this may take some time.
	DeleteTable(ctx context.Context, in *TableName, opts ...grpc.CallOption) (*Empty, error)
}

type AdminServiceServer interface {
	// Create a new table with the specified metadata.
	CreateTable(context.Context, *TableMetadata) (*Empty, error)
	// Update an existing table with the specified metadata.
	UpdateTable(context.Context, *TableMetadata) (*Empty, error)
	//
	// Delete a table; since this will unregister it from all data nodes,
	// this may take some time.
	DeleteTable(context.Context, *TableName) (*Empty, error)
}

type Column struct {
	//
	// Type of the data contained in the column. In journals and minor sstables,
	// this might be set to TOMBSTONE to represent that data in the column has
	// been deleted.
	Type Column_ColumnContentType `protobuf:"varint,1,opt,name=type,enum=redcloud.Column_ColumnContentType" json:"type,omitempty"`
	//
	// timestamp describes the exact point in time, encoded as milliseconds,
	// when the datum has been written. This will be used both for expiry (see
	// ttl) and to determine the most current datum in the column.
	//
	// Nonetheless, this field is filled in by the client because red-cloud
	// can't claim to know where the data came from.
	Timestamp int64 `protobuf:"varint,2,opt,name=timestamp" json:"timestamp,omitempty"`
	//
	// ttl describes the number of milliseconds this datum will be considered
	// valid. A compaction running after timestamp+ttl will discard this datum.
	// A ttl of 0 describes permanent data which will never expire.
	Ttl int64 `protobuf:"varint,3,opt,name=ttl" json:"ttl,omitempty"`
	// content contains the data actually written to the column.
	Content []byte `protobuf:"bytes,4,opt,name=content,proto3" json:"content,omitempty"`
}

type ColumnFamily struct {
	// Row key to identify the row this ColumnFamily pertains to.
	Key []byte `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Many ColumnSets make a ColumnFamily.
	ColumnSet []*ColumnSet `protobuf:"bytes,2,rep,name=column_set,json=columnSet" json:"column_set,omitempty"`
}

type ColumnFamilyMetadata struct {
	// Name of the column family registered.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

type ColumnRange struct {
	// Name of the first column to be returned.
	StartColumn string `protobuf:"bytes,1,opt,name=start_column,json=startColumn" json:"start_column,omitempty"`
	//
	// Name of the first column that should not be returned anymore, or an empty
	// string to operate on all columns following StartColumn.
	EndColumn string `protobuf:"bytes,2,opt,name=end_column,json=endColumn" json:"end_column,omitempty"`
}

type ColumnSet struct {
	// name contains the name of the column being represented.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	//
	// A ColumnSet consists of a number of Columns. They represent different
	// versions of the data contained in the column.
	Column []*Column `protobuf:"bytes,2,rep,name=column" json:"column,omitempty"`
}

type Column_ColumnContentType int32

type DataNodeMetadataServiceClient interface {
	//
	// ServeRange requests to start serving a specific range of the table. May
	// fail, but otherwise it is assumed that the table/range will be served
	// from this node in the future.
	ServeRange(ctx context.Context, in *RangeServingRequest, opts ...grpc.CallOption) (*Empty, error)
	//
	// ReleaseRange requests to stop serving a specific range of a table and to
	// return pointers to all files associated with the range at the time
	// serving has stopped.
	ReleaseRange(ctx context.Context, in *RangeReleaseRequest, opts ...grpc.CallOption) (*RangeReleaseResponse, error)
	//
	// GetServerStatus determines and returns some information about the status
	// of the server.
	GetServerStatus(ctx context.Context, in *Empty, opts ...grpc.CallOption) (*ServerStatus, error)
	//
	// Ping provides simple ping functionality to check node availability.
	Ping(ctx context.Context, in *Empty, opts ...grpc.CallOption) (*Empty, error)
}

type DataNodeMetadataServiceServer interface {
	//
	// ServeRange requests to start serving a specific range of the table. May
	// fail, but otherwise it is assumed that the table/range will be served
	// from this node in the future.
	ServeRange(context.Context, *RangeServingRequest) (*Empty, error)
	//
	// ReleaseRange requests to stop serving a specific range of a table and to
	// return pointers to all files associated with the range at the time
	// serving has stopped.
	ReleaseRange(context.Context, *RangeReleaseRequest) (*RangeReleaseResponse, error)
	//
	// GetServerStatus determines and returns some information about the status
	// of the server.
	GetServerStatus(context.Context, *Empty) (*ServerStatus, error)
	//
	// Ping provides simple ping functionality to check node availability.
	Ping(context.Context, *Empty) (*Empty, error)
}

type DataNodeServiceClient interface {
	//
	// Request an individual data cell from the database. If multiple versions of
	// the cell exist, only the latest version will be returned.
	Get(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*Column, error)
	//
	// Request a range of data from the database. This will return all matching
	// versions of all matching data on the database.
	GetRange(ctx context.Context, in *GetRangeRequest, opts ...grpc.CallOption) (DataNodeService_GetRangeClient, error)
	// Set a very specific data cell to the specified value.
	Insert(ctx context.Context, in *InsertRequest, opts ...grpc.CallOption) (*Empty, error)
}

type DataNodeServiceServer interface {
	//
	// Request an individual data cell from the database. If multiple versions of
	// the cell exist, only the latest version will be returned.
	Get(context.Context, *GetRequest) (*Column, error)
	//
	// Request a range of data from the database. This will return all matching
	// versions of all matching data on the database.
	GetRange(*GetRangeRequest, DataNodeService_GetRangeServer) error
	// Set a very specific data cell to the specified value.
	Insert(context.Context, *InsertRequest) (*Empty, error)
}

type DataNodeService_GetRangeClient interface {
	Recv() (*ColumnSet, error)
	grpc.ClientStream
}

type DataNodeService_GetRangeServer interface {
	Send(*ColumnSet) error
	grpc.ServerStream
}

type DataUsage int32

type Empty struct {
}

type GetRangeRequest struct {
	// Key of the first record to be returned.
	StartKey []byte `protobuf:"bytes,1,opt,name=start_key,json=startKey,proto3" json:"start_key,omitempty"`
	//
	// Key of the first record that shall no longer be returned; if empty, all
	// keys after the start key will be returned.
	EndKey []byte `protobuf:"bytes,2,opt,name=end_key,json=endKey,proto3" json:"end_key,omitempty"`
	// Name of the table which the data is being extracted from.
	Table string `protobuf:"bytes,3,opt,name=table" json:"table,omitempty"`
	//
	// Name of the column family the data is stored at. Data can only be
	// requested from a single column family at a time.
	ColumnFamily string `protobuf:"bytes,4,opt,name=column_family,json=columnFamily" json:"column_family,omitempty"`
	// List of the names of all columns affected.
	Column []string `protobuf:"bytes,5,rep,name=column" json:"column,omitempty"`
	//
	// Minimum timestamp to be taken into account for returning, or 0.
	// Please note that no number of affected timestamps filtering can be done
	// on the data node.
	MinTimestamp int64 `protobuf:"varint,6,opt,name=min_timestamp,json=minTimestamp" json:"min_timestamp,omitempty"`
	// Maximum timestamp to be taken into account, or 0.
	MaxTimestamp int64 `protobuf:"varint,7,opt,name=max_timestamp,json=maxTimestamp" json:"max_timestamp,omitempty"`
	//
	// Maximum number of results which will be returned from each data node.
	// There will be no ordering of results, probably, so this is mostly a
	// sanity check mechanism to prevent excessive load. Setting this to 0
	// will disable any limits.
	MaxResults int64 `protobuf:"varint,8,opt,name=max_results,json=maxResults" json:"max_results,omitempty"`
}

type GetRequest struct {
	// Key of the row to be fetched from the database.
	Key []byte `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Name of the table which data is being extracted from.
	Table string `protobuf:"bytes,2,opt,name=table" json:"table,omitempty"`
	// Name of the column family the data is stored at.
	ColumnFamily string `protobuf:"bytes,3,opt,name=column_family,json=columnFamily" json:"column_family,omitempty"`
	// Name of the specific column being referred to.
	Column string `protobuf:"bytes,4,opt,name=column" json:"column,omitempty"`
}

type InsertRequest struct {
	// Key of the row which shall be updated.
	Key []byte `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Name of the table to mutate.
	Table string `protobuf:"bytes,2,opt,name=table" json:"table,omitempty"`
	// Name of the column family to mutate.
	ColumnFamily string `protobuf:"bytes,3,opt,name=column_family,json=columnFamily" json:"column_family,omitempty"`
	// Name of the column to insert.
	ColumnName string `protobuf:"bytes,4,opt,name=column_name,json=columnName" json:"column_name,omitempty"`
	// Column value to insert into the data stream.
	Column *Column `protobuf:"bytes,5,opt,name=column" json:"column,omitempty"`
}

type RangeReleaseRequest struct {
	// table is the name of the table whose data is supposed to be unloaded.
	Table string `protobuf:"bytes,1,opt,name=table" json:"table,omitempty"`
	//
	// start_key is the first valid key which is covered by the range which is
	// being loaded.
	StartKey []byte `protobuf:"bytes,2,opt,name=start_key,json=startKey,proto3" json:"start_key,omitempty"`
	//
	// end_key is the first key which is no longer covered by the range which is
	// being loaded. If this is empty, it represents the end of the table.
	EndKey []byte `protobuf:"bytes,3,opt,name=end_key,json=endKey,proto3" json:"end_key,omitempty"`
}

type RangeReleaseResponse struct {
	// Relevant paths for all sstables which have been unloaded.
	Paths []*SSTablePathDescription `protobuf:"bytes,1,rep,name=paths" json:"paths,omitempty"`
}

type RangeServingRequest struct {
	// table is the name of the table which is supposed to be loaded.
	Table string `protobuf:"bytes,1,opt,name=table" json:"table,omitempty"`
	//
	// start_key is the first valid key which is covered by the range which is
	// being loaded.
	StartKey []byte `protobuf:"bytes,2,opt,name=start_key,json=startKey,proto3" json:"start_key,omitempty"`
	//
	// end_key is the first key which is no longer covered by the range which is
	// being loaded. If this is empty, it represents the end of the table.
	EndKey []byte `protobuf:"bytes,3,opt,name=end_key,json=endKey,proto3" json:"end_key,omitempty"`
	// Relevant paths for all sstables which should be loaded.
	Paths []*SSTablePathDescription `protobuf:"bytes,4,rep,name=paths" json:"paths,omitempty"`
}

type SSTablePathDescription struct {
	// Name of the column family which is covered.
	ColumnFamily string `protobuf:"bytes,1,opt,name=column_family,json=columnFamily" json:"column_family,omitempty"`
	//
	// Path to the major sstable holding the current compacted version of the
	// column family in the specified table.
	MajorSstablePath string `protobuf:"bytes,2,opt,name=major_sstable_path,json=majorSstablePath" json:"major_sstable_path,omitempty"`
	//
	// Path to the minor sstable holding the current amended data of the column
	// family in the specified table.
	MinorSstablePath string `protobuf:"bytes,3,opt,name=minor_sstable_path,json=minorSstablePath" json:"minor_sstable_path,omitempty"`
	//
	// Path to all journal files containing further amendments of the minor
	// sstable which have not been (fully) compacted yet.
	RelevantJournalPaths []string `protobuf:"bytes,4,rep,name=relevant_journal_paths,json=relevantJournalPaths" json:"relevant_journal_paths,omitempty"`
	// Size of the major sstable on the most recent compaction.
	MajorSstableSize int64 `protobuf:"varint,5,opt,name=major_sstable_size,json=majorSstableSize" json:"major_sstable_size,omitempty"`
	// Size of the minor sstable on the most recent compaction.
	MinorSstableSize int64 `protobuf:"varint,6,opt,name=minor_sstable_size,json=minorSstableSize" json:"minor_sstable_size,omitempty"`
}

type ServerStatus struct {
	// Number of currently allocated bytes of heap memory.
	HeapSize uint64 `protobuf:"varint,1,opt,name=heap_size,json=heapSize" json:"heap_size,omitempty"`
	// Status port for looking at the web interface.
	StatusPort uint32 `protobuf:"varint,2,opt,name=status_port,json=statusPort" json:"status_port,omitempty"`
}

type ServerTableMetadata struct {
	// The name of the table, for identifying it.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// Table metadata associated with the table.
	TableMd *TableMetadata `protobuf:"bytes,2,opt,name=table_md,json=tableMd" json:"table_md,omitempty"`
	//
	// List of all tablets associated with this table and the servers they
	// are loaded on.
	Tablet []*ServerTabletMetadata `protobuf:"bytes,3,rep,name=tablet" json:"tablet,omitempty"`
}

type ServerTabletMetadata struct {
	// The first key of the tablet.
	StartKey []byte `protobuf:"bytes,1,opt,name=start_key,json=startKey,proto3" json:"start_key,omitempty"`
	//
	// The first key after the end of the tablet, or an empty byte string
	// if this is the last tablet of the table.
	EndKey []byte `protobuf:"bytes,2,opt,name=end_key,json=endKey,proto3" json:"end_key,omitempty"`
	//
	// host currently holding the tablet. Please note that this may change
	// at any time.
	Host string `protobuf:"bytes,3,opt,name=host" json:"host,omitempty"`
	//
	// Port the host currently holding the tablet is exporting the database
	// service on.
	Port int32 `protobuf:"varint,4,opt,name=port" json:"port,omitempty"`
	//
	// Optional path to the sstable file holding the table data, so future
	// data nodes can pick it up.
	SstablePath []*SSTablePathDescription `protobuf:"bytes,5,rep,name=sstable_path,json=sstablePath" json:"sstable_path,omitempty"`
}

type TableMetadata struct {
	// The name of the table.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	//
	// Desired size after which tablets should be split.
	// If unspecified, defaults to 128 MB.
	SplitSize int64 `protobuf:"varint,2,opt,name=split_size,json=splitSize" json:"split_size,omitempty"`
	//
	// Maximum number of versions to keep of each cell. If 0, cells will never
	// be expired automatically based on the number of them.
	MaxVersions int64 `protobuf:"varint,3,opt,name=max_versions,json=maxVersions" json:"max_versions,omitempty"`
	//
	// Maximum age, in milliseconds, of older versions of cells, i.e. the ones
	// which do not have the highest insertion time stamp. If 0, old versions
	// are not expired based on age.
	MaxVersionAge int64 `protobuf:"varint,4,opt,name=max_version_age,json=maxVersionAge" json:"max_version_age,omitempty"`
	//
	// Path the files will be stored under. Changes to this value will only take
	// effect gradually when tablets are reloaded.
	PathPrefix string `protobuf:"bytes,5,opt,name=path_prefix,json=pathPrefix" json:"path_prefix,omitempty"`
	//
	// List of all column families configured for the table.
	ColumnFamily []*ColumnFamilyMetadata `protobuf:"bytes,6,rep,name=column_family,json=columnFamily" json:"column_family,omitempty"`
	//
	// Declaration of the type of data contained in the table.
	DataUsage DataUsage `protobuf:"varint,7,opt,name=data_usage,json=dataUsage,enum=redcloud.DataUsage" json:"data_usage,omitempty"`
}

type TableName struct {
	// Name of the table the operation is performed on.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}