github.com/matrixorigin/matrixone@v0.7.0/proto/ctl.proto (about)

     1  /* 
     2   * Copyright 2022 Matrix Origin
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *      http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  syntax = "proto3";
    18  package ctl; 
    19  option go_package = "github.com/matrixorigin/matrixone/pkg/pb/ctl";
    20  
    21  import "github.com/gogo/protobuf/gogoproto/gogo.proto";
    22  
    23  option (gogoproto.goproto_enum_prefix_all) = true;
    24  
    25  
    26  // CmdMethod debug command method
    27  enum CmdMethod {
    28      // Ping ping the service.
    29      Ping        = 0;
    30      // Flush is to force flush the table data.
    31      // parameter should be "DbName.TableName"
    32      Flush       = 1;
    33      // Task disable or enable task framework
    34      Task        = 2;
    35      // Checkpoint is to force incremental checkpoint.
    36      Checkpoint  = 3;
    37      // UseSnapshot use a spec snapshot timestamp, and all txn will use this ts as snapshot timestamp
    38      UseSnapshot = 4;
    39      // GetSnapshot get current snapshot timestamp
    40      GetSnapshot = 5;
    41      // ForceGC forcing a GC to free memory
    42      ForceGC     = 6;
    43      // Inspect DN info
    44      Inspect   = 7;
    45  }
    46  
    47  // DNPingRequest ping request
    48  message DNPingRequest {
    49      string parameter = 1;
    50  }
    51  
    52  // DNPingResponse ping response
    53  message DNPingResponse {
    54      string storeID        = 1;
    55      string serviceAddress = 2;
    56      uint64 shardID        = 3;
    57      uint64 replicaID      = 4;
    58      uint64 logShardID     = 5;
    59  }
    60  
    61  // DNStringResponse string type response
    62  message DNStringResponse {
    63      string returnStr = 1;
    64  }