Module org.yamcs.api

Package org.yamcs.protobuf

Class RocksDbApiClient

java.lang.Object

org.yamcs.protobuf.AbstractRocksDbApi<Void>

org.yamcs.protobuf.RocksDbApiClient

All Implemented Interfaces:

Api<Void>

@Generated(value="org.yamcs.maven.ServiceGenerator",
           date="2026-08-05T11:34:19.226349540Z")
public class RocksDbApiClient
extends AbstractRocksDbApi<Void>

Constructor Summary

Constructors

Constructor	Description
RocksDbApiClient(MethodHandler handler)

Method Summary

Modifier and Type	Method	Description
final void	backupDatabase(Void ctx, BackupDatabaseRequest request, Observer<com.google.protobuf.Empty> observer)	Backup database
final void	compactDatabase(Void ctx, CompactDatabaseRequest request, Observer<com.google.protobuf.Empty> observer)	Compact database
final void	describeDatabase(Void ctx, DescribeDatabaseRequest request, Observer<HttpBody> observer)	Get a text-dump describing a database This operation can be used to debug the inner workings of RocksDB database.
final void	describeRocksDb(Void ctx, com.google.protobuf.Empty request, Observer<HttpBody> observer)	Get a text-dump with general RocksDB info
final void	listDatabases(Void ctx, com.google.protobuf.Empty request, Observer<ListRocksDbDatabasesResponse> observer)	List databases
final void	listTablespaces(Void ctx, com.google.protobuf.Empty request, Observer<ListRocksDbTablespacesResponse> observer)	List tablespaces

Methods inherited from class org.yamcs.protobuf.AbstractRocksDbApi

callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RocksDbApiClient

public RocksDbApiClient(MethodHandler handler)

Method Details

listTablespaces

public final void listTablespaces(Void ctx,
 com.google.protobuf.Empty request,
 Observer<ListRocksDbTablespacesResponse> observer)

  List tablespaces
 

Specified by:

listTablespaces in class AbstractRocksDbApi<Void>

backupDatabase

public final void backupDatabase(Void ctx,
 BackupDatabaseRequest request,
 Observer<com.google.protobuf.Empty> observer)

  Backup database
 

Specified by:

backupDatabase in class AbstractRocksDbApi<Void>

listDatabases

public final void listDatabases(Void ctx,
 com.google.protobuf.Empty request,
 Observer<ListRocksDbDatabasesResponse> observer)

  List databases
 

Specified by:

listDatabases in class AbstractRocksDbApi<Void>

compactDatabase

public final void compactDatabase(Void ctx,
 CompactDatabaseRequest request,
 Observer<com.google.protobuf.Empty> observer)

  Compact database
 

Specified by:

compactDatabase in class AbstractRocksDbApi<Void>

describeRocksDb

public final void describeRocksDb(Void ctx,
 com.google.protobuf.Empty request,
 Observer<HttpBody> observer)

  Get a text-dump with general RocksDB info
 

Specified by:

describeRocksDb in class AbstractRocksDbApi<Void>

describeDatabase

public final void describeDatabase(Void ctx,
 DescribeDatabaseRequest request,
 Observer<HttpBody> observer)

  Get a text-dump describing a database
 
  This operation can be used to debug the inner workings of RocksDB database.
  For example the property `rocksdb.estimate-table-readers-mem` provides an
  estimation of how much memory is used by the index and filter cache of
  RocksDB (note that the memory used by RocksDB is outside the java heap space).
 
  See: <https://github.com/facebook/rocksdb/blob/master/include/rocksdb/db.h>
 
  The response contains a dump of various rocksdb properties for each column
  family. The single value properties are presented in a "name: value" list.
  The multiline properties are preceded by a line including the property name
  between dashes.
 

Specified by:

describeDatabase in class AbstractRocksDbApi<Void>