package Fdb

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc FDBCLI (FDBCLIRequest, stream FDBCLIResponse)

  fdb.proto:83

  message FDBCLIRequest

  fdb.proto:631

  FDBCLIRequest defines the fdbcli command(s) to run. This will replicate fdbcli --exec "command(s)" (where N commands are separated by ;) NEXT: 20

  • optional google.protobuf.StringValue config = 1

    NOTE: Doesn't include status-from-json as that just prints a status from a given json file which would require uploading and seems unneeded today. Maps to -C|--cluster-file

  • optional google.protobuf.BoolValue log = 2

    Maps to –-log (if set implies --log-dir which is handled automatically)

  • optional google.protobuf.StringValue trace_format = 3

    Maps to –-trace-format

  • optional google.protobuf.StringValue tls_certificate_file = 4

    Maps to –-tls_certificate_file

  • optional google.protobuf.StringValue tls_ca_file = 5

    Maps to –-tls_ca_file

  • optional google.protobuf.StringValue tls_key_file = 6

    Maps to –-tls_key_file

  • optional google.protobuf.StringValue tls_password = 7

    Maps to –-tls_password

  • optional google.protobuf.StringValue tls_verify_peers = 8

    Maps to –-tls_verify_peers

  • optional google.protobuf.BoolValue debug_tls = 9

    Maps to –-debug-tls

  • optional google.protobuf.BoolValue version = 10

    Maps to -v|--version

  • optional google.protobuf.StringValue log_group = 14

    Maps to --log-group

  • optional google.protobuf.BoolValue no_status = 15

    Maps to --no-status

  • optional google.protobuf.StringValue memory = 16

    Maps to --memory

  • optional google.protobuf.BoolValue build_flags = 17

    Maps to --build-flags

  • optional google.protobuf.Int32Value timeout = 18

    Maps to --timeout

  • optional google.protobuf.StringValue knobs = 21

    Maps to --knob_<knob_name>=<knob_value> Provide a comma-separated list in the form "<knob_name1>=<knob_value1>,<knob_name2>=<knob_value2>, ..."

  • repeated FDBCLICommand commands = 19

  message FDBCLIResponse

  fdb.proto:685

  • oneof response

    • FDBCLIResponseOutput output = 1

    • Log log = 2

      Log will steam back any logfiles generated sequentially. When filename changes a new log has begun and the previous completed.

The fdb configuration service definition.

• rpc Read (ReadRequest, FdbConfResponse)

  fdb.proto:30

  Read a configuration value from a section in FDB config file.

  message ReadRequest

  fdb.proto:43

  • optional Location location = 1

  message FdbConfResponse

  fdb.proto:52

  • string value = 1

• rpc Write (WriteRequest, google.protobuf.Empty)

  fdb.proto:32

  Write updates a configuration value in a section of FDB config file.

  message WriteRequest

  fdb.proto:45

  • optional Location location = 1

  • string value = 2

• rpc Delete (DeleteRequest, google.protobuf.Empty)

  fdb.proto:34

  Delete a section value based on a key

  message DeleteRequest

  fdb.proto:50

  • optional Location location = 1

• rpc FDBMoveDataCopy (FDBMoveDataCopyRequest, FDBMoveDataCopyResponse)

  fdb.proto:55

  message FDBMoveDataCopyRequest

  fdb.proto:59

  • string cluster_file = 1

  • string tenant_group = 2

  • string source_cluster = 3

  • string destination_cluster = 4

  • int64 num_procs = 5

  message FDBMoveDataCopyResponse

  fdb.proto:67

  • int64 id = 1

  • bool existing = 2

• rpc FDBMoveDataWait (FDBMoveDataWaitRequest, stream FDBMoveDataWaitResponse)

  fdb.proto:56

  message FDBMoveDataWaitRequest

  fdb.proto:72

  • int64 id = 1

  message FDBMoveDataWaitResponse

  fdb.proto:76

  • bytes stdout = 1

  • bytes stderr = 2

  • int32 retCode = 3

• rpc FDBServer (FDBServerRequest, FDBServerResponse)

  fdb.proto:695

  message FDBServerRequest

  fdb.proto:698

  • repeated FDBServerCommand commands = 1

  message FDBServerResponse

  fdb.proto:716

  • bytes stdout = 1

  • bytes stderr = 2

  • int32 retCode = 3

Used in: FDBCLICommand

• int64 version = 1

Used in: FDBCLICommand

(message has no fields)

Used in: FDBCLICommand

• oneof request

  • FDBCLIBlobrangeStart start = 1

  • FDBCLIBlobrangeStop stop = 2

Used in: FDBCLIBlobrange

• string begin_key = 1

• string end_key = 2

Used in: FDBCLIBlobrange

• string begin_key = 1

• string end_key = 2

Used in: FDBCLICommand

• oneof request

  • FDBCLICacheRangeSet set = 1

  • FDBCLICacheRangeClear clear = 2

Used in: FDBCLICacheRange

• string begin_key = 1

• string end_key = 2

Used in: FDBCLICacheRange

• string begin_key = 1

• string end_key = 2

Used in: FDBCLICommand

• oneof request

  • FDBCLIChangefeedList list = 1

  • FDBCLIChangefeedRegister register = 2

  • FDBCLIChangefeedStop stop = 3

  • FDBCLIChangefeedDestroy destroy = 4

  • FDBCLIChangefeedStream stream = 5

  • FDBCLIChangefeedStreamPop pop = 6

Used in: FDBCLIChangefeed

• string range_id = 1

Used in: FDBCLIChangefeed

(message has no fields)

Used in: FDBCLIChangefeed

• string range_id = 1

• string begin = 2

• string end = 3

Used in: FDBCLIChangefeed

• string range_id = 1

Used in: FDBCLIChangefeed

• string range_id = 1

• oneof type

  Either begin only is set or begin+end. Can't just set end.

  • FDBCLIChangefeedStreamNoVersion no_version = 2

  • FDBCLIChangefeedStreamStartVersion start_version = 3

  • FDBCLIChangefeedStreamStartEndVersion start_end_version = 4

Used in: FDBCLIChangefeedStream

(message has no fields)

Used in: FDBCLIChangefeed

• string range_id = 1

• int64 version = 2

Used in: FDBCLIChangefeedStream

• int64 start_version = 1

• int64 end_version = 2

Used in: FDBCLIChangefeedStream

• int64 start_version = 1

Used in: FDBCLICommand

• string key = 1

Used in: FDBCLICommand

• string begin_key = 1

• string end_key = 2

FDBCLICommand defines all of the fdbcli commands supported. Certain items are excluded that don't make sense in a non-interactive session such as reset or rollback. This message is broken out separately for ease of use since it has gotten so large. NEXT: 50

Used in: FDBCLIRequest

• oneof command

  • FDBCLIAdvanceversion advanceversion = 1

    Does not include begin, commit, exit, help, reset, or rollback.

  • FDBCLIBegin begin = 47

  • FDBCLIBlobrange blobrange = 41

  • FDBCLICacheRange cache_range = 46

  • FDBCLIChangefeed changefeed = 40

  • FDBCLIClear clear = 2

  • FDBCLIClearrange clearrange = 3

  • FDBCLICommit commit = 48

  • FDBCLIConfigure configure = 4

  • FDBCLIConsistencycheck consistencycheck = 5

  • FDBCLICoordinators coordinators = 6

  • FDBCLICreatetenant createtenant = 29

  • FDBCLIDatadistribution datadistribution = 45

  • FDBCLIDefaulttenant defaulttenant = 30

  • FDBCLIDeletetenant deletetenant = 31

  • FDBCLIExclude exclude = 7

  • FDBCLIExpensiveDataCheck expensive_data_check = 44

  • FDBCLIFileconfigure fileconfigure = 8

  • FDBCLIForceRecoveryWithDataLoss force_recovery_with_data_loss = 9

  • FDBCLIGet get = 10

  • FDBCLIGetrange getrange = 11

  • FDBCLIGetrangekeys getrangekeys = 12

  • FDBCLIGettenant gettenant = 33

  • FDBCLIGetversion getversion = 13

  • FDBCLIHelp help = 32

  • FDBCLIInclude include = 14

  • FDBCLIKill kill = 15

  • FDBCLIListtenants listtenants = 36

  • FDBCLILock lock = 16

  • FDBCLIMaintenance maintenance = 17

  • FDBCLIOption option = 18

  • FDBCLIProfile profile = 19

  • FDBCLISet set = 20

  • FDBCLISetclass setclass = 21

  • FDBCLISnapshot snapshot = 39

  • FDBCLISleep sleep = 22

  • FDBCLIStatus status = 23

  • FDBCLISuspend suspend = 43

  • FDBCLITenantEmergencyMove tenant_emergency_move = 49

  • FDBCLIThrottle throttle = 24

  • FDBCLITriggerddteaminfolog triggerddteaminfolog = 25

  • FDBCLITssq tssq = 35

  • FDBCLIUnlock unlock = 26

  • FDBCLIUsetenant usetenant = 34

  • FDBCLIWritemode writemode = 27

  • FDBCLIVersionepoch versionepoch = 42

  • FDBCLIWaitconnected waitconnected = 37

  • FDBCLIWaitopen waitopen = 38

  • FDBCLIUnknownAction unknown = 28

    This one isn't used but defined so tests can trigger the unknown type check.

Used in: FDBCLICommand

(message has no fields)

See https://apple.github.io/foundationdb/command-line-interface.html#configure for possible values for options.

Used in: FDBCLICommand

• optional google.protobuf.StringValue new_or_tss = 1

• optional google.protobuf.StringValue redundancy_mode = 2

• optional google.protobuf.StringValue storage_engine = 3

• optional google.protobuf.UInt32Value grv_proxies = 4

• optional google.protobuf.UInt32Value commit_proxies = 5

• optional google.protobuf.UInt32Value resolvers = 6

• optional google.protobuf.UInt32Value logs = 7

• optional google.protobuf.UInt32Value count = 8

• optional google.protobuf.UInt32Value perpetual_storage_wiggle = 9

• optional google.protobuf.StringValue perpetual_storage_wiggle_locality = 10

• optional google.protobuf.StringValue storage_migration_type = 11

• optional google.protobuf.StringValue tenant_mode = 12

• optional google.protobuf.UInt32Value blob_granules_enabled = 13

Used in: FDBCLICommand

• optional google.protobuf.BoolValue mode = 1

Used in: FDBCLICommand

• oneof request

  • FDBCLICoordinatorsAuto auto = 1

  • FDBCLICoordinatorsAddresses addresses = 2

• optional google.protobuf.StringValue description = 3

Used in: FDBCLICoordinators

• repeated string addresses = 1

Used in: FDBCLICoordinators

(message has no fields)

Used in: FDBCLICommand

• string name = 1

Used in: FDBCLICommand

• oneof request

  • FDBCLIDatadistributionOn on = 1

  • FDBCLIDatadistributionOff off = 2

  • FDBCLIDatadistributionEnable enable = 3

  • FDBCLIDatadistributionDisable disable = 4

Used in: FDBCLIDatadistribution

• string option = 1

Used in: FDBCLIDatadistribution

• string option = 1

Used in: FDBCLIDatadistribution

(message has no fields)

Used in: FDBCLIDatadistribution

(message has no fields)

Used in: FDBCLICommand

(message has no fields)

Used in: FDBCLICommand

• string name = 1

Used in: FDBCLICommand

• optional google.protobuf.BoolValue failed = 1

• repeated string addresses = 2

• optional google.protobuf.BoolValue no_wait = 3

Used in: FDBCLICommand

• oneof request

  • FDBCLIExpensiveDataCheckInit init = 1

  • FDBCLIExpensiveDataCheckList list = 2

  • FDBCLIExpensiveDataCheckAll all = 3

  • FDBCLIExpensiveDataCheckCheck check = 4

Used in: FDBCLIExpensiveDataCheck

(message has no fields)

Used in: FDBCLIExpensiveDataCheck

• repeated string addresses = 1

Used in: FDBCLIExpensiveDataCheck

(message has no fields)

Used in: FDBCLIExpensiveDataCheck

(message has no fields)

Used in: FDBCLICommand

• optional google.protobuf.BoolValue new = 1

• string file = 2

Used in: FDBCLICommand

• string dcid = 1

Used in: FDBCLICommand

• string key = 1

Used in: FDBCLICommand

• string begin_key = 1

• optional google.protobuf.StringValue end_key = 2

• optional google.protobuf.UInt32Value limit = 3

Used in: FDBCLICommand

• string begin_key = 1

• optional google.protobuf.StringValue end_key = 2

• optional google.protobuf.UInt32Value limit = 3

Used in: FDBCLICommand

• string name = 1

Used in: FDBCLICommand

(message has no fields)

Used in: FDBCLICommand

• repeated string options = 1

Used in: FDBCLICommand

• optional google.protobuf.BoolValue failed = 1

• oneof request

  • bool all = 2

  • FDBCLIIncludeAddresses addresses = 3

Used in: FDBCLIInclude

• repeated string addresses = 1

Used in: FDBCLICommand

• oneof request

  • FDBCLIKillInit init = 1

  • FDBCLIKillList list = 2

  • FDBCLIKillAll all = 3

  • FDBCLIKillTargets targets = 4

• optional google.protobuf.Duration sleep = 5

  Duration to sleep after sending the kill command. fdbcli may return before message is actually sent. See https://github.com/apple/foundationdb/pull/9526

Used in: FDBCLIKill

(message has no fields)

Used in: FDBCLIKill

(message has no fields)

Used in: FDBCLIKill

(message has no fields)

Used in: FDBCLIKill

• repeated string addresses = 1

Used in: FDBCLICommand

• optional google.protobuf.StringValue begin = 1

• optional google.protobuf.StringValue end = 2

• optional google.protobuf.UInt32Value limit = 3

Used in: FDBCLICommand

(message has no fields)

Used in: FDBCLICommand

• oneof request

  • FDBCLIMaintenanceStatus status = 1

  • FDBCLIMaintenanceOn on = 2

  • FDBCLIMaintenanceOff off = 3

Used in: FDBCLIMaintenance

(message has no fields)

Used in: FDBCLIMaintenance

• string zoneid = 1

• uint32 seconds = 2

Used in: FDBCLIMaintenance

(message has no fields)

Used in: FDBCLICommand

• oneof request

  • FDBCLIOptionBlank blank = 1

  • FDBCLIOptionArg arg = 2

Used in: FDBCLIOption

• string state = 1

• string option = 2

• optional google.protobuf.StringValue arg = 3

Used in: FDBCLIOption

(message has no fields)

Used in: FDBCLICommand

• oneof request

  • FDBCLIProfileActionClient client = 1

  • FDBCLIProfileActionList list = 2

  • FDBCLIProfileActionFlow flow = 3

  • FDBCLIProfileActionHeap heap = 4

Used in: FDBCLIProfile

• oneof request

  • FDBCLIProfileActionClientGet get = 1

  • FDBCLIProfileActionClientSet set = 2

Used in: FDBCLIProfileActionClientSet

(message has no fields)

Used in: FDBCLIProfileActionClient

(message has no fields)

Used in: FDBCLIProfileActionClient

• oneof rate

  • FDBCLIProfileActionClientDefault default_rate = 1

  • double value_rate = 2

• oneof size

  • FDBCLIProfileActionClientDefault default_size = 3

  • uint64 value_size = 4

Used in: FDBCLIProfile

• uint32 duration = 1

• repeated string processes = 2

  Client should simulate file. Internally handled and returned in a Log below.

Used in: FDBCLIProfile

• string process = 1

Used in: FDBCLIProfile

(message has no fields)

Used in: FDBCLIResponse

• bytes stdout = 1

• bytes stderr = 2

• int32 retCode = 3

Used in: FDBCLICommand

• string key = 1

• string value = 2

Used in: FDBCLICommand

• oneof request

  • FDBCLISetclassList list = 1

  • FDBCLISetclassArg arg = 2

Used in: FDBCLISetclass

• string address = 1

• string class = 2

Use this message to indicate no arguments to setclass

Used in: FDBCLISetclass

(message has no fields)

Used in: FDBCLICommand

• uint32 seconds = 1

Used in: FDBCLICommand

• string command = 1

• repeated string options = 2

Used in: FDBCLICommand

• optional google.protobuf.StringValue style = 1

Used in: FDBCLICommand

• oneof request

  • FDBCLISuspendInit init = 1

  • FDBCLISuspendSuspend suspend = 2

Used in: FDBCLISuspend

(message has no fields)

Used in: FDBCLISuspend

• double seconds = 1

• repeated string addresses = 2

Used in: FDBCLICommand

• oneof request

  • FDBCLITenantEmergencyMoveStart start = 1

  • FDBCLITenantEmergencyMoveSwitch switch = 2

  • FDBCLITenantEmergencyMoveFinish finish = 3

  • FDBCLITenantEmergencyMoveAbort abort = 4

  • FDBCLITenantEmergencyMoveStatus status = 5

Used in: FDBCLITenantEmergencyMove

• string tenant_group = 1

• string source_cluster = 2

• string destination_cluster = 3

Used in: FDBCLITenantEmergencyMove

• string tenant_group = 1

• string source_cluster = 2

• string destination_cluster = 3

Used in: FDBCLITenantEmergencyMove

• string tenant_group = 1

• string source_cluster = 2

• string destination_cluster = 3

Used in: FDBCLITenantEmergencyMove

• string tenant_group = 1

Used in: FDBCLITenantEmergencyMove

• string tenant_group = 1

• string source_cluster = 2

• string destination_cluster = 3

Used in: FDBCLICommand

• oneof request

  • FDBCLIThrottleActionOn on = 1

  • FDBCLIThrottleActionOff off = 2

  • FDBCLIThrottleActionEnable enable = 3

  • FDBCLIThrottleActionDisable disable = 4

  • FDBCLIThrottleActionList list = 5

Used in: FDBCLIThrottle

(message has no fields)

Used in: FDBCLIThrottle

(message has no fields)

Used in: FDBCLIThrottle

• optional google.protobuf.StringValue type = 1

• optional google.protobuf.UInt32Value limit = 2

Used in: FDBCLIThrottle

• optional google.protobuf.StringValue type = 1

• optional google.protobuf.StringValue tag = 2

• optional google.protobuf.StringValue priority = 3

Used in: FDBCLIThrottle

• string tag = 1

• optional google.protobuf.UInt32Value rate = 2

• optional google.protobuf.StringValue duration = 3

• optional google.protobuf.StringValue priority = 4

Used in: FDBCLICommand

(message has no fields)

Used in: FDBCLICommand

• oneof request

  • FDBCLITssqStart start = 1

  • FDBCLITssqStop stop = 2

  • FDBCLITssqList list = 3

Used in: FDBCLITssq

(message has no fields)

Used in: FDBCLITssq

• string storage_uid = 1

Used in: FDBCLITssq

• string storage_uid = 1

Used in: FDBCLICommand

(message has no fields)

Used in: FDBCLICommand

• string uid = 1

Used in: FDBCLICommand

• string name = 1

Used in: FDBCLICommand

• oneof request

  • FDBCLIVersionepochInfo info = 1

  • FDBCLIVersionepochGet get = 2

  • FDBCLIVersionepochDisable disable = 3

  • FDBCLIVersionepochEnable enable = 4

  • FDBCLIVersionepochCommit commit = 5

  • FDBCLIVersionepochSet set = 6

Used in: FDBCLIVersionepoch

(message has no fields)

Used in: FDBCLIVersionepoch

(message has no fields)

Used in: FDBCLIVersionepoch

(message has no fields)

Used in: FDBCLIVersionepoch

(message has no fields)

Used in: FDBCLIVersionepoch

(message has no fields)

Used in: FDBCLIVersionepoch

• int64 epoch = 1

Used in: FDBCLICommand

(message has no fields)

Used in: FDBCLICommand

(message has no fields)

Used in: FDBCLICommand

• string mode = 1

FDBServerCommand defines all of the fdbserver commands supported.

Used in: FDBServerRequest

• oneof command

  • FDBServerVersion version = 1

  • FDBServerUnknownAction unknown = 2

    just for test purpose

Used in: FDBServerCommand

(message has no fields)

Used in: FDBServerCommand

(message has no fields)

Used in: DeleteRequest, ReadRequest, WriteRequest

• string file = 1

• string section = 2

• string key = 3

Used in: FDBCLIResponse

• string filename = 1

• bytes contents = 2