package summa.proto

uint64 created_at = 1
Timestamp when index has been created
repeated string unique_fields = 2
Unique fields of the index. Summa maintains unique constraint on them and uses for deduplicating data
repeated string multi_fields = 4
Multi fields is ones that may have multiple values and processed as lists. All other fields will be forcefully converted to singular value
optional string description = 6
Text index description
ConflictStrategy conflict_strategy = 8
repeated MappedField mapped_fields = 9
optional string auto_id_field = 10

Description containing `Index` metadata fields

Used in: AttachIndexResponse, CopyIndexResponse, CreateIndexResponse, GetIndexResponse

string index_name = 1
repeated string index_aliases = 2
All index aliases
optional IndexEngineConfig index_engine = 3
uint64 num_docs = 4
The number of committed documents
Compression compression = 5
Used compression for `store`
optional IndexAttributes index_attributes = 6
All custom index attributes

Indexing operations that contains document serialized in JSON format

Used in: IndexOperation

bytes document = 1

Description of the `IndexEngine` responsible for managing files in the persistent storage

Used in: IndexDescription

oneof config
- FileEngineConfig file = 1
- MemoryEngineConfig memory = 2
- RemoteEngineConfig remote = 3
optional MergePolicy merge_policy = 10
Merge policy
optional QueryParserConfig query_parser_config = 11

Message that should be put in Kafka for ingesting by Summa consumers

oneof operation
- IndexDocumentOperation index_document = 2

Merge policy for implementing [LogMergePolicy](https://docs.rs/tantivy/latest/tantivy/merge_policy/struct.LogMergePolicy.html)

Used in: MergePolicy

bool is_frozen = 1
Set if once merged segment should be left intact

Used in: IndexAttributes

string source_field = 1
string target_field = 2

Used in: Query

string value = 1
optional QueryParserConfig query_parser_config = 2

Used in: QueryParserConfig

(message has no fields)

Used in: QueryParserConfig

float tie_breaker = 1

Used in: IndexEngineConfig

string schema = 1
Schema of the index for memory engine

Merge policy that describes how to merge committed segments

Used in: AttachIndexRequest, CopyIndexRequest, CreateIndexRequest, IndexEngineConfig

oneof merge_policy
- LogMergePolicy log = 11
- TemporalMergePolicy temporal = 12

Used in: Query

string document = 1
optional uint64 min_doc_frequency = 2
optional uint64 max_doc_frequency = 3
optional uint64 min_term_frequency = 4
optional uint64 max_query_terms = 5
optional uint64 min_word_length = 6
optional uint64 max_word_length = 7
optional string boost = 8
repeated string stop_words = 9

Used in: QueryParserConfig

optional float derive_tenses_coefficient = 1

optional float boost = 1
repeated string fields = 2

Used in: BooleanSubquery

should = 0
must = 1
must_not = 2

Used in: SortByField

Asc = 0
Desc = 1

Used in: Query

string field = 1
string value = 2
uint32 slop = 3

Recursive query DSL

Used in: BooleanSubquery, BoostQuery, DeleteDocumentsRequest, DisjunctionMaxQuery, DocumentsRequest, SearchRequest

oneof query
- BooleanQuery boolean = 1
- MatchQuery match = 2
- RegexQuery regex = 3
- TermQuery term = 4
- PhraseQuery phrase = 5
- RangeQuery range = 6
- AllQuery all = 7
- MoreLikeThisQuery more_like_this = 8
- BoostQuery boost = 9
- DisjunctionMaxQuery disjunction_max = 10
- EmptyQuery empty = 11
- ExistsQuery exists = 12

Used in: AttachIndexRequest, CreateIndexRequest, IndexEngineConfig, MatchQuery

map<string, string> field_aliases = 1
map<string, float> field_boosts = 2
map<string, TermFieldMapperConfig> term_field_mapper_configs = 3
uint32 term_limit = 4
repeated string default_fields = 5
oneof default_mode
- MatchQueryBooleanShouldMode boolean_should_mode = 6
- MatchQueryDisjuctionMaxMode disjuction_max_mode = 7
optional ExactMatchesPromoter exact_matches_promoter = 8
repeated string excluded_fields = 9
map<string, MorphologyConfig> morphology_configs = 10
optional string query_language = 11

Used in: ReservoirSamplingCollectorOutput

string document = 1
optional Score score = 2
string index_alias = 3

Used in: RangeQuery

string left = 1
string right = 2
bool including_left = 3
bool including_right = 4

Used in: Query

string field = 1
optional Range value = 2

Used in: Query

string field = 1
string value = 2

Used in: AttachRemoteEngineRequest, IndexEngineConfig

string method = 1
Which method should be used to request remote endpoint
string url_template = 2
URL template which will be used to generate real URL by variables substitution
map<string, string> headers_template = 3
Headers template which will be used to generate real URL by variables substitution
optional CacheConfig cache_config = 4
Description of the cache for the engine
optional uint32 timeout_ms = 5
Timeout for the request

Used in: Collector

uint32 limit = 1
repeated string fields = 2
repeated string excluded_fields = 3

repeated RandomDocument documents = 1

Used in: RandomDocument, ScoredDocument

oneof score
- double f64_score = 1
- uint64 u64_score = 2

Used in: DocumentsCollectorOutput

string document = 1
optional Score score = 2
uint32 position = 3
map<string, Snippet> snippets = 4
string index_alias = 5

Used in: TopDocsCollector

oneof scorer
- string eval_expr = 1
- string order_by = 2

Used as request type in: PublicApi.search, SearchApi.search

string index_alias = 1
The index name or alias
optional Query query = 2
Query DSL. Use `MatchQuery` to pass a free-form query
repeated Collector collectors = 3
Every collector is responsible of processing and storing documents and/or their derivatives (like counters) to return them to the caller
optional bool is_fieldnorms_scoring_enabled = 4
Is requiring fieldnorms needed for the query?
optional bool load_cache = 5
optional bool store_cache = 6

Used as response type in: PublicApi.search, SearchApi.search

double elapsed_secs = 1
Time spent inside of `search` handler
repeated CollectorOutput collector_outputs = 2
An array of collector outputs

Used in: GetTopTermsResponse

repeated TermInfo term_infos = 1

Used in: ScoredDocument

bytes fragment = 1
repeated Highlight highlights = 2
string html = 3

string field = 1
Order order = 2

Merge policy for compressing old segments

Used in: MergePolicy

uint64 merge_older_then_secs = 1

Used in: QueryParserConfig

repeated string fields = 1

Used in: SegmentTerms

bytes key = 1
uint32 doc_freq = 2

Used in: Query

string field = 1
string value = 2

Used in: Collector

uint32 limit = 1
uint32 offset = 2
optional Scorer scorer = 3
map<string, uint32> snippet_configs = 4
bool explain = 5
repeated string fields = 6
repeated string excluded_fields = 7

package summa.proto

service ConsumerApi

rpc create_consumer (CreateConsumerRequest, CreateConsumerResponse)

message CreateConsumerRequest

repeated string bootstrap_servers = 1

string group_id = 2

string index_name = 3

string consumer_name = 4

repeated string topics = 5

message CreateConsumerResponse

optional Consumer consumer = 1

rpc get_consumer (GetConsumerRequest, GetConsumerResponse)

message GetConsumerRequest

string index_name = 1

string consumer_name = 2

message GetConsumerResponse

optional Consumer consumer = 1

rpc get_consumers (GetConsumersRequest, GetConsumersResponse)

message GetConsumersRequest

message GetConsumersResponse

repeated Consumer consumers = 1

rpc delete_consumer (DeleteConsumerRequest, DeleteConsumerResponse)

message DeleteConsumerRequest

string consumer_name = 1

message DeleteConsumerResponse

string consumer_name = 2

service IndexApi

rpc attach_index (AttachIndexRequest, AttachIndexResponse)

message AttachIndexRequest

string index_name = 1

oneof index_engine

AttachFileEngineRequest file = 2

AttachRemoteEngineRequest remote = 3

optional MergePolicy merge_policy = 10

optional QueryParserConfig query_parser_config = 11

message AttachIndexResponse

optional IndexDescription index = 1

rpc commit_index (CommitIndexRequest, CommitIndexResponse)

message CommitIndexRequest

string index_name = 1

bool with_hotcache = 2

message CommitIndexResponse

double elapsed_secs = 1

rpc copy_documents (CopyDocumentsRequest, CopyDocumentsResponse)

message CopyDocumentsRequest

string source_index_name = 1

string target_index_name = 2

optional ConflictStrategy conflict_strategy = 3

message CopyDocumentsResponse

double elapsed_secs = 1

uint32 copied_documents = 2

rpc create_index (CreateIndexRequest, CreateIndexResponse)

message CreateIndexRequest

string index_name = 1

oneof index_engine

CreateFileEngineRequest file = 7

CreateMemoryEngineRequest memory = 8

string schema = 2

Compression compression = 3

optional uint32 blocksize = 4

optional IndexAttributes index_attributes = 6

optional MergePolicy merge_policy = 20

optional QueryParserConfig query_parser_config = 21

message CreateIndexResponse

optional IndexDescription index = 1

rpc copy_index (CopyIndexRequest, CopyIndexResponse)

message CopyIndexRequest

string source_index_name = 1

string target_index_name = 2

oneof target_index_engine

CreateFileEngineRequest file = 3

CreateMemoryEngineRequest memory = 4

optional MergePolicy merge_policy = 6

message CopyIndexResponse

optional IndexDescription index = 1

rpc delete_documents (DeleteDocumentsRequest, DeleteDocumentsResponse)

message DeleteDocumentsRequest

string index_name = 1

optional Query query = 2

message DeleteDocumentsResponse