package reindexer.grpc

string nsName = 1
namespace name
string key = 2
metadata key
string value = 3
metadata, for Get and Delete operations this field is supposed to be empty

Modify mode

Used in: AddTxItemRequest, ModifyItemRequest

UPSERT = 0
INSERT = 1
UPDATE = 2
DELETE = 3

Namespaces definition.

Used in: AddNamespaceRequest, EnumNamespacesResponse

string dbName = 1
string name = 2
optional StorageOptions storageOptions = 3
repeated Index indexesDefinitions = 4
bool isTemporary = 5

Options for QueryResults output stream

Used in: DeleteRequest, SelectRequest, SelectSqlRequest, UpdateRequest

EncodingType encodingType = 1
Results encoding can be one of the following: 1.JSON 2.CJSON 3.MSGPACK 4.PROTOBUF Note that protobuf doesn't support joined items yet
bool withItemID = 2
include rowId to item's cjson
bool withNsID = 3
include namespace Id to cson
bool withRank = 4
include full-text search rank() value to cjson
bool withJoinedItems = 5
include all the joined documents to cjson

Query definition. Represents query as a binary serialized buffer.

Used in: DeleteRequest, SelectRequest, UpdateRequest

EncodingType encodingType = 1
Query can be encoded as following: 1. JSON # Using DSL-query format, described here: https://github.com/Restream/reindexer/blob/v3.23.0/cpp_src/server/contrib/server.yml#L2420 2. MSGPACK # Not supported yet
bytes data = 2

Query execution results set

Used as response type in: Reindexer.Delete, Reindexer.Select, Reindexer.SelectSql, Reindexer.Update

bytes data = 1
Bytes stream.
optional QueryResultsResponse.QueryResultsOptions options = 2
contains options only for the first item in a stream
optional ErrorResponse errorResponse = 3
status

Options for returned buffer.

Used in: QueryResultsResponse

int64 totalItems = 1
int64 queryTotalItems = 2
bool cacheEnabled = 3
string explain = 4

JSON Schema definition.

Used in: SetSchemaRequest

string nsName = 1
string jsonData = 2

Storage options for a namespace.

Used in: Namespace, OpenNamespaceRequest

string nsName = 1
Ns name.
bool enabled = 2
To work with physical storage or not.
bool dropOnFileFormatError = 3
In case of problems with storage it fails, otherwise the error will be skipped and Reindexer won't work with it.
bool createIfMissing = 4
Creates database if it doesn't exist yet.
bool verifyChecksums = 5
If true, all data read from storage will be verified against corresponding checksums.
bool fillCache = 6
Should the data read for this iteration be cached in memory? Callers may wish to set this field to false for bulk scans.
bool sync = 7
If true, the write will be flushed from the operating system buffer cache before the write is considered complete. If this flag is true, writes will be slower. If false and the machine crashes, some recent writes may be lost. Note that if it is just the process that crashes (i.e., the machine does not reboot), no writes will be lost even if sync==false.

Storage type

Used in: ConnectOptions

StorageTypeLevelDB = 0
StorageTypeRocksDB = 1

package reindexer.grpc

service Reindexer

rpc Connect (ConnectRequest, ErrorResponse)

message ConnectRequest

string url = 1

string dbName = 2

string login = 3

string password = 4

optional ConnectOptions connectOpts = 5

rpc CreateDatabase (CreateDatabaseRequest, ErrorResponse)

message CreateDatabaseRequest

string dbName = 1

rpc OpenNamespace (OpenNamespaceRequest, ErrorResponse)

message OpenNamespaceRequest

string dbName = 1

optional StorageOptions storageOptions = 2

rpc AddNamespace (AddNamespaceRequest, ErrorResponse)

message AddNamespaceRequest

string dbName = 1

optional Namespace namespace = 2

rpc CloseNamespace (CloseNamespaceRequest, ErrorResponse)

message CloseNamespaceRequest

string dbName = 1

string nsName = 2

rpc DropNamespace (DropNamespaceRequest, ErrorResponse)

message DropNamespaceRequest

string dbName = 1

string nsName = 2

rpc TruncateNamespace (TruncateNamespaceRequest, ErrorResponse)

message TruncateNamespaceRequest

string dbName = 1

string nsName = 2

rpc AddIndex (AddIndexRequest, ErrorResponse)

message AddIndexRequest

string dbName = 1

string nsName = 2

optional Index definition = 3

rpc UpdateIndex (UpdateIndexRequest, ErrorResponse)

message UpdateIndexRequest

string dbName = 1

string nsName = 2

optional Index definition = 3

rpc DropIndex (DropIndexRequest, ErrorResponse)

message DropIndexRequest

string dbName = 1

string nsName = 2

optional Index definition = 3

rpc SetSchema (SetSchemaRequest, ErrorResponse)

message SetSchemaRequest

string dbName = 1

optional SchemaDefinition schemaDefinitionRequest = 2

rpc EnumNamespaces (EnumNamespacesRequest, EnumNamespacesResponse)

message EnumNamespacesRequest

string dbName = 1

optional EnumNamespacesOptions options = 2

message EnumNamespacesResponse

repeated Namespace namespacesDefinitions = 1

optional ErrorResponse errorResponse = 2

rpc EnumDatabases (EnumDatabasesRequest, EnumDatabasesResponse)

message EnumDatabasesRequest

message EnumDatabasesResponse

repeated string names = 1

optional ErrorResponse errorResponse = 2

rpc ModifyItem (stream ModifyItemRequest, stream ErrorResponse)

message ModifyItemRequest

string dbName = 1

string nsName = 2

ModifyMode mode = 3

EncodingType encodingType = 4

bytes data = 5

rpc SelectSql (SelectSqlRequest, stream QueryResultsResponse)

message SelectSqlRequest

string dbName = 1

string sql = 2

optional OutputFlags flags = 3

rpc Select (SelectRequest, stream QueryResultsResponse)

message SelectRequest

string dbName = 1

optional Query query = 2

optional OutputFlags flags = 3