Classes
class	CreateTableRequest

class	CreateTableResponse

class	DeleteRequest

class	DeleteResponse

class	DeleteTableRequest

class	DeleteTableResponse

class	FindByIdRequest

class	FindByIdResponse

class	FindRequest

class	FindResponse
	Results of Find() RPCs are streamed to the clients, with each FindResponse containing one OJAI document. If the `include_query_plan` in FindRequest was set to true, the first FindResponse will contain the query plan instead of OJAI Document More...

class	InsertOrReplaceRequest

class	InsertOrReplaceResponse

class	MapRDbServer
	=============================================// RPC calls exported from the service // =============================================// More...

class	MaprdbServerReflection
	Holder for reflection information generated from maprdb-server.proto More...

class	PingRequest

class	PingResponse

class	RpcError
	Protobuf message that encapsulates RPC operation error, if any. Each RPC response should include RpcError message, with `NO_ERROR` indicating success More...

class	TableExistsRequest

class	TableExistsResponse

class	UpdateRequest

class	UpdateResponse

Enumerations
enum	ErrorCode { ErrorCode.NoError = 0, ErrorCode.TableNotFound = 2, ErrorCode.IoError = 5, ErrorCode.OutOfMemory = 12, ErrorCode.AccessDenied = 13, ErrorCode.TableAlreadyExists = 17, ErrorCode.InvalidArgument = 22, ErrorCode.UnsupportedOperation = 38, ErrorCode.UnknownError = 256, ErrorCode.UnknownPayloadEncoding = 260, ErrorCode.ClusterNotFound = 270, ErrorCode.PathNotFound = 271, ErrorCode.DocumentAlreadyExists = 280, ErrorCode.DocumentNotFound = 281, ErrorCode.EncodingError = 290, ErrorCode.DecodingError = 291, ErrorCode.IllegalMutation = 292 }
	RPC response error codes. POSIX error codes are used where appropriate. More...

enum	PayloadEncoding { PayloadEncoding.UnknownEncoding = 0, PayloadEncoding.JsonEncoding = 1 }
	ENUM indicating the encoding scheme of the OJAI objects in RPC request/response. Currently only JSON encoding is supported. More...

enum	InsertMode { InsertMode.UnknownMode = 0, InsertMode.InsertOrReplace = 1, InsertMode.Insert = 2, InsertMode.Replace = 3 }

enum	FindResponseType { FindResponseType.UnknownType = 0, FindResponseType.ResultDocument = 1, FindResponseType.QueryPlan = 2 }

Enumeration Type Documentation

◆ ErrorCode

strong

Extended error codes, those that can not be mapped to a POSIX error code, begins at 256.

Enumerator
NoError	No error, operation completed successfully.
TableNotFound	Specified table does not exist
IoError	An I/O error occurred on the server(s)
OutOfMemory	The operation resulted in server(s) running out of memory
AccessDenied	User does not have sufficient permission to execute the operation.
TableAlreadyExists	The specified table already exists.
InvalidArgument	One or more request parameter was invalid. This error code should be used whenever a request parameter was unrecognized or outside a valid domain. For example, an unrecognized enum value was supplied for InsertMode.
UnsupportedOperation	Requested operation is not supported by this server. This error code should be used if a known, valid operation is not supported by the current service.
UnknownError	Catch-all for all undefined errors on server.
UnknownPayloadEncoding	Extended error codes. TODO: renumber the error codes before release </summary>
ClusterNotFound	specified cluster does not exist
PathNotFound	parent path of the specified table does not exist
DocumentAlreadyExists	a document with the specified _id already exist in the store
DocumentNotFound	a document with the specified _id wasn't found in the store
EncodingError	an error occurred while encoding an OJAI object
DecodingError	the supplied OJAI object could not be decoded
IllegalMutation	A mutation operation could not be applied

strong

Enumerator
UnknownType	Invalid, unknown type
ResultDocument	Indicates that the current response contains a QueryResult Document
QueryPlan	Indicates that the current response contains a Query plan

strong

Enumerator
UnknownMode	Invalid, unknown mode
InsertOrReplace	Insert this document WHETHER OR NOT a document with the same _id exist in the store
Insert	Insert this document ONLY IF another document with the same _id DOES NOT exist in the store
Replace	Insert this document ONLY IF a document with the same _id EXISTS in the store

strong

ENUM indicating the encoding scheme of the OJAI objects in RPC request/response. Currently only JSON encoding is supported.

Enumerator
UnknownEncoding	Invalid, unknown encoding
JsonEncoding	Payload is encoded as JSON string