voldemort-admin.proto

// Please use protoc version 2.3.0 to recompile:
//   https://code.google.com/p/protobuf/downloads/detail?name=protobuf-2.3.0.tar.gz&can=2&q=
// Use commmand like the below to recompile:
// $ protoc -I=src/proto --java_out=src/java src/proto/voldemort-admin.proto

package voldemort;

option java_package = "voldemort.client.protocol.pb";
option java_outer_classname = "VAdminProto";
option optimize_for = SPEED;

import "voldemort-client.proto";

message GetMetadataRequest {
  required bytes key = 1;
}

message GetMetadataResponse {
  optional Versioned version = 1;
  optional Error error = 2;
}

message UpdateMetadataRequest {
  required bytes key = 1;
  required Versioned versioned = 2;
}

message UpdateStoreDefinitions {
  required bytes key = 1;
  required Versioned versioned = 2;
}

message UpdateMetadataPairRequest {
  required bytes cluster_key = 1;
  required Versioned cluster_value = 2;
  required bytes stores_key = 3;
  required Versioned stores_value = 4;
}

message UpdateMetadataPairResponse {
  optional Error error = 1;
}

message UpdateMetadataResponse {
  optional Error error = 1;
}

message FileEntry {
  required string file_name = 1;
  required int64 file_size_bytes = 2;
}

message PartitionEntry {
  required bytes key = 1;
  required Versioned versioned = 2;
}

message UpdatePartitionEntriesRequest {
  required string store = 1;
  required PartitionEntry partition_entry = 2;
  optional VoldemortFilter filter = 3;
  optional bool overwriteIfLatestTs = 4;
}

message UpdatePartitionEntriesResponse {
  optional Error error = 1;
}

message VoldemortFilter {
  required string name = 1;
  required bytes data = 2;
}

message UpdateSlopEntriesRequest {
  required string store = 1;
  required bytes key = 2; 
  required VectorClock version = 3;
  required RequestType request_type = 4;
  optional bytes value = 5;
  optional bytes transform = 6;
}

message UpdateSlopEntriesResponse {
  optional Error error = 1;
}
message FetchPartitionFilesRequest {
   required string store_name = 1;
   repeated int32 partition_ids = 2;
}

message FetchPartitionEntriesRequest {
  repeated int32 partition_ids = 1;
  required string store = 2;
  optional VoldemortFilter filter = 3;
  optional bool fetch_values = 4;
  optional int64 OBSOLETE__DO_NOT_USE__skip_records = 5;
  optional string initial_cluster = 6;
  optional bool fetch_orphaned = 7;
  optional int64 records_per_partition = 8;
}

message FetchPartitionEntriesResponse {
  optional PartitionEntry partition_entry = 1;
  optional bytes key = 2;
  optional Error error = 3;
}

message DeletePartitionEntriesRequest {
  required string store = 1;
  repeated int32 partition_ids = 2;
  optional VoldemortFilter filter = 3; 
  optional string initial_cluster = 4;
}

message DeletePartitionEntriesResponse {
  optional int64 count = 1;
  optional Error error = 2;
}

message InitiateFetchAndUpdateRequest {
  required int32 node_id = 1;
  required string store = 2;
  optional VoldemortFilter filter = 3;
  repeated int32 partition_ids = 4;
  optional string initial_cluster = 5;
  optional bool OBSOLETE__DO_NOT_USE__optimize = 6;
}

message AsyncOperationStatusRequest {
  required int32 request_id = 1;
}

message AsyncOperationStatusResponse {
  optional int32 request_id = 1;
  optional string description = 2;
  optional string status = 3;
  optional bool complete = 4;
  optional Error error = 5;
}

message AsyncOperationStopRequest {
  required int32 request_id = 1;
}

message AsyncOperationStopResponse {
  optional Error error = 1;
}

message AsyncOperationListRequest {
  required bool show_complete = 2;
}

message AsyncOperationListResponse {
  repeated int32 request_ids = 1;
  optional Error error = 2;
}

message ListScheduledJobsRequest {
}

message ListScheduledJobsResponse {
  repeated string job_ids = 1;
  optional Error error = 2;
}

message GetScheduledJobStatusRequest {
  required string job_id = 1;
}

message GetScheduledJobStatusResponse {
  required bool enabled = 1;
  optional Error error = 2;
}

message StopScheduledJobRequest {
  required string job_id = 1;
}

message StopScheduledJobResponse {
  optional Error error = 1;
}

message EnableScheduledJobRequest {
  required string job_id = 1;
}

message EnableScheduledJobResponse {
  optional Error error = 1;
}

message PartitionTuple {
  required int32 replica_type = 1;
  repeated int32 partitions = 2;
}

message PerStorePartitionTuple {
  required string store_name = 1;
  repeated PartitionTuple replica_to_partition = 2;
}

message RebalancePartitionInfoMap {
  required int32 stealer_id = 1;
  required int32 donor_id = 2;
  optional int32 OBSOLETE__DO_NOT_USE__attempt = 3;
  repeated PerStorePartitionTuple replica_to_add_partition = 4;
  repeated PerStorePartitionTuple replica_to_delete_partition = 5;
  required string initial_cluster = 6;
}

message StoreToPartitionsIds {
  required string store_name = 1;
  repeated int32 partition_ids = 2;
}

message RebalanceTaskInfoMap {
  required int32 stealer_id = 1;
  required int32 donor_id = 2;
  repeated StoreToPartitionsIds per_store_partition_ids = 3;
  required string initial_cluster = 4;
}

message InitiateRebalanceNodeRequest {
  required RebalanceTaskInfoMap rebalance_task_info = 1;
}

message InitiateRebalanceNodeOnDonorRequest {
  repeated RebalancePartitionInfoMap rebalance_partition_info = 1;
}

message TruncateEntriesRequest {
  required string store = 1;
}

message TruncateEntriesResponse {
  optional Error error = 1;
}

message AddStoreRequest {
  required string storeDefinition = 1;
}

message AddStoreResponse {
  optional Error error = 1;
}

message DeleteStoreRequest {
  required string storeName = 1;
}

message DeleteStoreResponse {
  optional Error error = 1;
}

message FetchStoreRequest {
  required string store_name = 1;
  required string store_dir = 2;
  optional int64 push_version = 3; 
}

message SwapStoreRequest {
  required string store_name = 1;
  required string store_dir = 2;
}

message SwapStoreResponse {
  optional Error error = 1; 
  optional string previous_store_dir = 2;
}

message RollbackStoreRequest {
  required string store_name = 1;
  required int64 push_version = 2; 
}

message RollbackStoreResponse {
  optional Error error = 1;
}

message RepairJobRequest {
  optional string store_name = 1;
}

message RepairJobResponse {
  optional Error error = 1;
}

message PruneJobRequest {
  optional string store_name = 1;
}

message PruneJobResponse {
  optional Error error = 1;
}

message SlopPurgeJobRequest {
  repeated int32 filter_node_ids = 1;
  optional int32 filter_zone_id = 2;
  repeated string filter_store_names = 3;
}

message SlopPurgeJobResponse {
  optional Error error = 1;
}


message ROStoreVersionDirMap {
 required string store_name = 1;
 required string store_dir = 2;
}

message GetROMaxVersionDirRequest {
  repeated string store_name = 1;
}

message GetROMaxVersionDirResponse {
  repeated ROStoreVersionDirMap ro_store_versions = 1;
  optional Error error = 2;
}
 
message GetROCurrentVersionDirRequest {
  repeated string store_name = 1;
}

message GetROCurrentVersionDirResponse {
  repeated ROStoreVersionDirMap ro_store_versions = 1;
  optional Error error = 2;
}

message GetROStorageFormatRequest {
  repeated string store_name = 1;
}

message GetROStorageFormatResponse {
  repeated ROStoreVersionDirMap ro_store_versions = 1;
  optional Error error = 2;
}

message GetROStorageFileListRequest {
  required string store_name = 1;
}

message GetROStorageFileListResponse {
  repeated string file_name = 1;
  optional Error error = 2;
  repeated int32 data_file_size=3;
  repeated int32 index_file_size=4;
}

message GetROStorageCompressionCodecListRequest {
}

message GetROStorageCompressionCodecListResponse {
  repeated string compression_codecs = 1;
  optional Error error = 2;
}

message FailedFetchStoreRequest {
  required string store_name = 1;
  required string store_dir = 2;
}

message FailedFetchStoreResponse {
  optional Error error = 1;
}

message RebalanceStateChangeRequest {
  repeated RebalanceTaskInfoMap rebalance_task_list = 1;
  required string cluster_string = 2;
  required string stores_string = 3;
  required bool swap_ro = 4;
  required bool change_cluster_metadata = 5;
  required bool change_rebalance_state = 6;
  required bool rollback = 7;
}

message RebalanceStateChangeResponse {
  optional Error error = 1;
}

message DeleteStoreRebalanceStateRequest {
  required string store_name = 1;
  required int32 node_id = 2; 
}

message DeleteStoreRebalanceStateResponse {
  optional Error error = 1;
}

message SetOfflineStateRequest {
  required bool offline_mode = 1;
}

message SetOfflineStateResponse {
  optional Error error = 1;
}

message NativeBackupRequest {
  required string store_name = 1;
  required string backup_dir = 2;
  required bool   verify_files = 3;
  required bool   incremental = 4;
}

message ReserveMemoryRequest {
  required string store_name = 1;
  required int64  size_in_mb = 2;
}

message ReserveMemoryResponse {
  optional Error error = 1;
}

message GetHighAvailabilitySettingsRequest {
}

message GetHighAvailabilitySettingsResponse {
  required bool enabled = 1;
  optional string cluster_id = 2;
  optional int32 max_node_failure = 3;
  optional string lock_path = 4;
  optional string lock_implementation = 5;
}

message DisableStoreVersionRequest {
  required string store_name = 1;
  required int64 push_version = 2;
  optional string info = 3;
}

message DisableStoreVersionResponse {
  required bool disable_success = 1;
  optional bool disable_persistence_success = 2;
  optional string info = 3;
  optional int32 node_id = 4;
}

message HandleFetchFailureRequest {
  repeated int32 failed_nodes = 1;
  required string store_name = 2;
  required int64 push_version = 3;
  optional string info = 4;
}

message HandleFetchFailureResponse {
  required bool swap_is_possible = 1;
  optional string info = 2;
  repeated DisableStoreVersionResponse disable_store_responses = 3;
}

message GetConfigRequest {
  repeated string config_key = 1;
}

message GetConfigResponse {
  // Key/value pairs of each requested config key
  repeated MapFieldEntry config_map = 1;
  // Requested config keys which cannot be provided, along with the reason why in the value.
  repeated MapFieldEntry invalid_config_map = 2;
}

message MapFieldEntry {
  required string key = 1;
  required string value = 2;
}

enum AdminRequestType {
  GET_METADATA = 0;
  UPDATE_METADATA = 1;
  UPDATE_PARTITION_ENTRIES = 2;
  FETCH_PARTITION_ENTRIES = 3;
  DELETE_PARTITION_ENTRIES = 4;
  INITIATE_FETCH_AND_UPDATE = 5;
  ASYNC_OPERATION_STATUS = 6;
  INITIATE_REBALANCE_NODE = 7;
  ASYNC_OPERATION_STOP = 8;
  ASYNC_OPERATION_LIST = 9;
  TRUNCATE_ENTRIES = 10;
  ADD_STORE = 11;
  DELETE_STORE = 12;
  FETCH_STORE = 13;
  SWAP_STORE = 14;
  ROLLBACK_STORE = 15;
  GET_RO_MAX_VERSION_DIR = 16;
  GET_RO_CURRENT_VERSION_DIR = 17;
  FETCH_PARTITION_FILES = 18;
  UPDATE_SLOP_ENTRIES = 20;
  FAILED_FETCH_STORE = 22;
  GET_RO_STORAGE_FORMAT = 23;
  REBALANCE_STATE_CHANGE = 24;
  REPAIR_JOB = 25;
  // INITIATE_REBALANCE_NODE_ON_DONOR = 26;
  DELETE_STORE_REBALANCE_STATE = 27;
  NATIVE_BACKUP = 28;
  RESERVE_MEMORY = 29;
  PRUNE_JOB = 30;
  SLOP_PURGE_JOB = 31;
  UPDATE_METADATA_PAIR = 32;
  UPDATE_STORE_DEFINITIONS = 33;
  SET_OFFLINE_STATE = 34;
  GET_RO_STORAGE_FILE_LIST = 35;
  GET_RO_COMPRESSION_CODEC_LIST = 36;
  LIST_SCHEDULED_JOBS = 37;
  GET_SCHEDULED_JOB_STATUS = 38;
  STOP_SCHEDULED_JOB = 39;
  ENABLE_SCHEDULED_JOB = 40;
  GET_HA_SETTINGS = 41;
  DISABLE_STORE_VERSION = 42;
  HANDLE_FETCH_FAILURE = 43;
  GET_CONFIG = 44;
}

message VoldemortAdminRequest {
  required AdminRequestType type = 1;
  optional GetMetadataRequest get_metadata = 2;
  optional UpdateMetadataRequest update_metadata = 3;
  optional UpdatePartitionEntriesRequest update_partition_entries = 4;
  optional FetchPartitionEntriesRequest fetch_partition_entries = 5;
  optional DeletePartitionEntriesRequest delete_partition_entries = 6;
  optional InitiateFetchAndUpdateRequest initiate_fetch_and_update = 7;
  optional AsyncOperationStatusRequest async_operation_status = 8;
  optional InitiateRebalanceNodeRequest initiate_rebalance_node = 9;
  optional AsyncOperationStopRequest async_operation_stop = 10;
  optional AsyncOperationListRequest async_operation_list = 11;
  optional TruncateEntriesRequest truncate_entries = 12;
  optional AddStoreRequest add_store = 13;
  optional DeleteStoreRequest delete_store = 14;
  optional FetchStoreRequest fetch_store = 15;
  optional SwapStoreRequest swap_store = 16;
  optional RollbackStoreRequest rollback_store = 17;
  optional GetROMaxVersionDirRequest get_ro_max_version_dir = 18;
  optional GetROCurrentVersionDirRequest get_ro_current_version_dir = 19;
  optional FetchPartitionFilesRequest fetch_partition_files = 20;
  optional UpdateSlopEntriesRequest update_slop_entries = 22;
  optional FailedFetchStoreRequest failed_fetch_store = 24;
  optional GetROStorageFormatRequest get_ro_storage_format = 25;
  optional RebalanceStateChangeRequest rebalance_state_change = 26;
  optional RepairJobRequest repair_job = 27;  
  // optional InitiateRebalanceNodeOnDonorRequest initiate_rebalance_node_on_donor = 28;
  optional DeleteStoreRebalanceStateRequest delete_store_rebalance_state = 29;
  optional NativeBackupRequest native_backup = 30;
  optional ReserveMemoryRequest reserve_memory = 31;
  optional PruneJobRequest prune_job = 32;
  optional SlopPurgeJobRequest slop_purge_job = 33;
  optional UpdateMetadataPairRequest update_metadata_pair = 34;
  optional UpdateStoreDefinitions update_store_definitions = 35;
  optional SetOfflineStateRequest set_offline_state = 36;
  optional GetROStorageFileListRequest get_ro_storage_file_list = 37;
  optional GetROStorageCompressionCodecListRequest get_ro_compression_codec_list = 38;
  optional ListScheduledJobsRequest list_scheduled_jobs = 39;
  optional GetScheduledJobStatusRequest get_scheduled_job_status = 40;
  optional StopScheduledJobRequest stop_scheduled_job = 41;
  optional EnableScheduledJobRequest enable_scheduled_job = 42;
  optional GetHighAvailabilitySettingsRequest get_ha_settings = 43;
  optional DisableStoreVersionRequest disable_store_version = 44;
  optional HandleFetchFailureRequest handle_fetch_failure = 45;
  optional GetConfigRequest get_config = 46;
}