package io.evitadb.externalApi.grpc.generated
Get desktop application:
View/edit binary Protocol Buffers messages
This service contains RPCs that could be called by gRPC clients on evitaDB. Main purpose of this service is to provide a way to create sessions and catalogs, and to update the catalog.
Procedure used to cancel queued or running task.
message
GrpcEvitaManagementAPI.proto:268Request to cancel a task by id
optional taskId = 1
Identification of the task
message
GrpcEvitaManagementAPI.proto:274Response to a cancel task request.
bool success = 1
True if a task with the given id existed and was successfully canceled; false if no such task exists, or the task could no longer be canceled (e.g. it had already finished).
Procedure used to delete file contents
message
GrpcEvitaManagementAPI.proto:338Request to delete a file available for fetching, by its id.
optional fileId = 1
Identification of the file
message
GrpcEvitaManagementAPI.proto:344Response to a file deletion request.
bool success = 1
True if the file existed and was deleted; false if no file exists for the given id. Any other failure during deletion is reported as a gRPC error rather than `false`.
rpc FetchFile (, stream )
GrpcEvitaManagementAPI.proto:406Procedure used to get file contents, streamed back to the client in chunks.
message
GrpcEvitaManagementAPI.proto:321Request to stream the contents of a single file available for fetching, by its id.
optional fileId = 1
Identification of the file
message
GrpcEvitaManagementAPI.proto:329One chunk of a file's contents, streamed back to the client. The server sends a sequence of these messages; concatenate `fileContents` from all of them, in arrival order, to reconstruct the full file.
bytes fileContents = 1
One chunk of the file's binary contents.
int64 totalSizeInBytes = 2
Total size of the complete file (bytes); the same value is repeated on every chunk in the stream, not just the size of this chunk.
Procedure used to obtain catalog statistics.
message
GrpcEvitaManagementAPI.proto:121Response to a server catalog statistics request.
repeated catalogStatistics = 1
Per-catalog statistics for every catalog known to the server, including corrupted ones (see `GrpcCatalogStatistics.unusable`, where most other fields fall back to a placeholder value).
Procedure used to obtain server configuration.
message
GrpcEvitaManagementAPI.proto:85Response to an evitaDB configuration request. This RPC (and therefore this response) is unavailable while the engine runs in read-only mode - see GrpcEvitaEngineSettingsResponse for the smaller, always-available subset of configuration.
string configuration = 1
Current configuration of the server in YAML format with evaluated values.
Procedure used to obtain the curated subset of the engine configuration that is safe to expose to any client. Unlike GetConfiguration this procedure is available also when the engine runs in read-only mode.
message
GrpcEvitaManagementAPI.proto:105Response to an evitaDB engine settings request. Carries the curated subset of the engine configuration that clients need in order to reason about the behaviour of the server they talk to. Unlike GrpcEvitaConfigurationResponse - which renders the entire configuration file including paths and credentials, and is refused while the engine runs in read-only mode - the values collected here carry nothing sensitive and remain readable in read-only mode. The message is intentionally flat rather than mirroring the sectioning of the configuration file: only a small fraction of the configuration is client-actionable, and which section a value happens to live in is an accident of the server's own configuration history that the caller should not have to know. All values originate from the configuration file and are therefore constant for the entire lifetime of the server process - a client may safely cache the response until it reconnects. Live state that changes while the server runs (readiness, health problems, catalog counts) and the enabled external APIs with their URLs are deliberately absent - they belong to GrpcEvitaServerStatusResponse, which must not be cached.
optional conflictResolution = 1
The engine-wide default conflict resolution applied to a transaction commit when neither the catalog schema nor the entity schema declares its own - the base of the conflict resolution precedence walk.
bool timeTravelEnabled = 2
True when the engine retains historical data, so queries and restores targeting a past point in time are available at all.
bool changeDataCaptureEnabled = 3
True when clients may subscribe to change data capture streams.
bool trafficRecordingEnabled = 4
True when the server records client traffic, so recordings can be started, inspected and exported.
bool queryCacheEnabled = 5
True when the engine caches computed query results; affects latency characteristics only, never query results.
Procedure used to get single file by its id available for fetching.
message
GrpcEvitaManagementAPI.proto:308Request to get a single file available for fetching, by its id.
optional fileId = 1
Identification of the file
message
GrpcEvitaManagementAPI.proto:315Response to a request for a single file available for fetching. If no file exists for the given id, the call fails with an error instead of returning this message.
optional fileToFetch = 1
Descriptor of the requested file.
Procedure used to get detail of particular task status.
message
GrpcEvitaManagementAPI.proto:251Request to get single task status by id
optional taskId = 1
Identification of the task
message
GrpcEvitaManagementAPI.proto:257Response to a task status request.
optional taskStatus = 1
Status of the requested task. If no task exists for the given id, the server currently does not send this response message at all, rather than sending it with this field unset - for this unary call, that means the call does not complete normally rather than yielding an empty result (the bundled Java driver, for one, surfaces this as a `StatusRuntimeException` with status `INTERNAL`). Prefer `GetTaskStatuses` (plural) if an unknown id must not surface as an error, since it returns a normal (possibly empty) response instead.
Procedure used to get multiple details of particular task statuses.
message
GrpcEvitaManagementAPI.proto:236Request to get multiple task statuses.
repeated taskIds = 1
Identifications of the tasks whose statuses should be returned. Ids that don't match any known task are silently omitted from the response - see `GrpcSpecifiedTaskStatusesResponse.taskStatus`.
message
GrpcEvitaManagementAPI.proto:244Response to a multiple task statuses request.
repeated taskStatus = 1
Statuses of the requested tasks that were found, in no particular order; ids from the request that don't match any known task are simply absent here, no error is raised for them.
Procedure used to get listing of files available for fetching.
message
GrpcEvitaManagementAPI.proto:281Request to list files available for fetching, in paginated form.
int32 pageNumber = 1
Page number of the files to be listed. Page-based paging: 1-indexed, page 1 is the first page (see `io.evitadb.dataType.PaginatedList#getPageNumber`).
int32 pageSize = 2
Number of files per page. No server-side maximum is enforced.
repeated origin = 3
File origins to filter by (see `GrpcFile.origin` - usually the `taskType` of the task that produced the file, e.g. `BackupTask`); a file matches if its origin is any of the listed values. Empty (the default) means no filtering - files of all origins are returned.
message
GrpcEvitaManagementAPI.proto:294Response to a request to list files available for fetching.
int32 pageSize = 1
The page size that was actually applied (echoes the request's `pageSize`).
int32 pageNumber = 2
The page number that was actually applied (echoes the request's `pageNumber`); 1-indexed, see `GrpcFilesToFetchRequest.pageNumber` for the paging model.
repeated filesToFetch = 3
Files on this page, matching the origin filter from the request.
int32 totalNumberOfRecords = 4
Total number of files matching the request's origin filter across all pages, not just this one.
List reserved keywords
message
GrpcEvitaManagementAPI.proto:366Response that returns information about reserved keywords.
repeated keywords = 1
All reserved keywords, across all classifier types.
Procedure used to get listing of task statuses.
message
GrpcEvitaManagementAPI.proto:206Request to list task statuses in paginated form.
int32 pageNumber = 1
Page number of the task statuses to be listed. Page-based paging: 1-indexed, page 1 is the first page (see `io.evitadb.dataType.PaginatedList#getPageNumber`).
int32 pageSize = 2
Number of task statuses per page. No server-side maximum is enforced.
repeated taskType = 3
Task type names to filter by (matched against `GrpcTaskStatus.taskType`); a task matches if its type is any of the listed values. Empty (the default) means no filtering by type.
repeated GrpcTaskSimplifiedState simplifiedState = 4
Simplified task states to filter by; a task matches if its state is any of the listed values. Empty (the default) means no filtering by state. When both `taskType` and `simplifiedState` are non-empty, a task must satisfy both filters.
message
GrpcEvitaManagementAPI.proto:222Response to a task statuses request.
int32 pageSize = 1
The page size that was actually applied (echoes the request's `pageSize`).
int32 pageNumber = 2
The page number that was actually applied (echoes the request's `pageNumber`); 1-indexed, see `GrpcTaskStatusesRequest.pageNumber` for the paging model.
repeated taskStatus = 3
Task statuses on this page, matching the filters from the request.
int32 totalNumberOfRecords = 4
Total number of task statuses matching the request's filters across all pages, not just this one.
rpc RestoreCatalog (stream , )
GrpcEvitaManagementAPI.proto:386Procedure used to restore a catalog from a client-uploaded backup via true gRPC client streaming; see `RestoreCatalogUnary` for the chunked-unary alternative.
message
GrpcEvitaManagementAPI.proto:132One chunk of a streamed catalog restore. The client sends a sequence of these messages over the same gRPC client stream, each carrying one slice of the backup archive; the server concatenates `backupFile` across all messages, in arrival order, into a single ZIP file. `catalogName` is expected to be identical on every chunk - only the value from the last message in the stream is actually used to name the restored catalog.
string catalogName = 1
Name of the target catalog into which the backup will be restored. Must not clash with the name of any existing catalog.
bytes backupFile = 2
One chunk of the binary backup ZIP archive; concatenate `backupFile` from all messages in the stream, in order, to reconstruct the full archive.
Procedure used to restore a catalog from a backup file already stored on the server, without re-uploading it.
message
GrpcEvitaManagementAPI.proto:170Request to restore a catalog from a backup file that already exists on the server (e.g. produced by a prior backup task, or a previous restore upload) - in contrast to `GrpcRestoreCatalogRequest` and `GrpcRestoreCatalogUnaryRequest`, which upload a new backup file as part of the call.
string catalogName = 1
Name of the target catalog into which the backup will be restored. Must not clash with the name of any existing catalog.
optional fileId = 2
Identification of the backup file already stored on the server that should be restored.
Procedure used to restore a catalog from a client-uploaded backup, one chunk per call (unary version for gRPC/web, where true client streaming as in `RestoreCatalog` is unavailable).
message
GrpcEvitaManagementAPI.proto:145One chunk of a catalog restore uploaded via repeated unary calls, used where true client-side streaming (as in `GrpcRestoreCatalogRequest`) is unavailable, e.g. gRPC-Web. The client calls `RestoreCatalogUnary` once per chunk, feeding back the `fileId` it received in the previous response so the server appends to the same upload; see `GrpcRestoreCatalogUnaryResponse`.
string catalogName = 1
Name of the target catalog into which the backup will be restored. Must not clash with the name of any existing catalog.
bytes backupFile = 2
One chunk of the binary backup ZIP archive; the server appends it to the chunks already received for this upload (identified by `fileId`).
optional fileId = 3
Identifies the upload this chunk continues. If unset, this is the first chunk of a new upload: the server allocates a new upload id and returns it as `fileId` in the response. If set, it must be a `fileId` previously returned for this same upload, and this chunk is appended to it.
int64 totalSizeInBytes = 4
Total size of the complete backup file (bytes), as expected once all chunks have been received; sent with every chunk. Once the bytes received so far reach exactly this size, the restore starts automatically. If more bytes are received than this, the server still returns a normal response for that (final) chunk and only afterwards discards the partial upload - an overshoot is not guaranteed to surface to the client as an error, so do not exceed it.
message
GrpcEvitaManagementAPI.proto:192Response to a catalog restore request (unary variant). This is used for gRPC/web. We need to explicitly handle the fileId, because it gets repeatedly updated (appended) from the client.
int64 read = 1
Cumulative number of bytes received for this upload so far, across this and all preceding chunks (bytes).
optional fileId = 2
Identifies this upload. Echo this value back as `fileId` in the next `GrpcRestoreCatalogUnaryRequest` chunk so the server appends to the same upload; on the first chunk of an upload the server allocates this id and returns it here for the first time.
optional task = 3
The task tracking the restore operation; poll its status (`GetTaskStatus`) to observe restore progress.
Procedure used to obtain server status.
message
GrpcEvitaManagementAPI.proto:13Response to a server status request.
string version = 1
Version of evitaDB server taken from the MANIFEST.MF file
optional startedAt = 2
Date and time when the server was started
int64 uptime = 3
Duration of time since the server was started (seconds)
string instanceId = 4
Unique identifier of the server instance
int32 catalogsCorrupted = 5
Number of corrupted catalogs
int32 catalogsOk = 6
Deprecated since 2025.7 - number of catalogs that are active and has been successfully loaded, renamed to `catalogsActive`
repeated GrpcHealthProblem healthProblems = 7
Health problems currently detected by any of the server's health probes, deduplicated. Empty means no problems were detected.
GrpcReadiness readiness = 8
Overall readiness of the evitaDB server
map<string, > api = 9
Status keyed by API code, for every external API registered on the classpath - including ones that are disabled (`GrpcApiStatus.enabled == false`) or have no registered provider (in which case `baseUrl` and `endpoints` are empty). Presence in this map does not imply the API is enabled or reachable; check `GrpcApiStatus.enabled`/`ready`.
bool readOnly = 10
Flag indicating that the server is in read-only mode
int32 catalogsActive = 11
Number of catalogs that are active and has been successfully loaded
int32 catalogsInactive = 12
Number of inactive catalogs
int64 engineVersion = 13
Monotonically increasing version number of the engine's own state, distinct from any single catalog's version - incremented once for each committed engine-level change (e.g. a catalog being created, removed, renamed, or having its format upgraded or read-only mode toggled). Ordinary data mutations within a catalog do not advance it.
optional introducedAt = 14
The date and time when the current engine version was introduced (last engine level change occurred).
This service contains RPCs that could be called by gRPC clients on evitaDB. Main purpose of this service is to provide a way to create sessions and catalogs, and to update the catalog.
Procedure used to activate a catalog.
message
GrpcEvitaAPI.proto:192Response to an activate catalog request.
bool success = 1
Indicator whether the catalog was activated successfully.
rpc ActivateCatalogWithProgress (, stream )
GrpcEvitaAPI.proto:356Procedure used to activate a catalog with progress tracking.
rpc ApplyMutation (, )
GrpcEvitaAPI.proto:326Procedure used to update the catalog with a set of mutations.
message
GrpcEvitaAPI.proto:216Response to apply mutation on engine level.
(message has no fields)
rpc ApplyMutationWithProgress (, stream )
GrpcEvitaAPI.proto:328Procedure used to update the catalog with a set of mutations which tracks the progress of the operation.
Procedure used to create read-only session which will return data in binary format. Part of the Private API.
Procedure used to create read-write session which will return data in binary format. Part of the Private API.
Procedure used to create read only sessions.
Procedure used to create read write sessions.
Procedure used to deactivate a catalog.
message
GrpcEvitaAPI.proto:204Response to a deactivate catalog request.
bool success = 1
Indicator whether the catalog was deactivated successfully.
rpc DeactivateCatalogWithProgress (, stream )
GrpcEvitaAPI.proto:360Procedure used to deactivate a catalog with progress tracking.
rpc DefineCatalog (, )
GrpcEvitaAPI.proto:322Procedure used to define a new catalog.
message
GrpcEvitaAPI.proto:80Request to define a new catalog.
string catalogName = 1
Name of the catalog to be defined.
message
GrpcEvitaAPI.proto:86Response to a catalog definition request.
bool success = 1
Indicator whether the catalog was defined successfully.
Procedure used to delete an existing catalog.
message
GrpcEvitaAPI.proto:124Request to delete a catalog.
string catalogName = 1
Name of the catalog to be deleted.
message
GrpcEvitaAPI.proto:130Response to a catalog deletion request.
bool success = 1
Indicator whether the catalog was deleted successfully.
Procedure used to duplicate a catalog.
message
GrpcEvitaAPI.proto:180Response to a duplicate catalog request.
bool success = 1
Indicator whether the catalog was duplicated successfully.
rpc DuplicateCatalogWithProgress (, stream )
GrpcEvitaAPI.proto:352Procedure used to duplicate a catalog with progress tracking.
Procedure used to get names of all existing catalogs.
message
GrpcEvitaAPI.proto:62Response to a catalog names request.
repeated string catalogNames = 1
Names of all existing catalogs.
Procedure used to get state of the catalog by its name.
message
GrpcEvitaAPI.proto:68Request to a get catalog state request.
string catalogName = 1
Name of the catalog to be checked for state.
message
GrpcEvitaAPI.proto:74Response to a get catalog state request.
optional GrpcCatalogState catalogState = 1
State of the catalog. Unset if no catalog with the requested name exists.
rpc GetProgress (, stream )
GrpcEvitaAPI.proto:364Procedure used to initiate progress consumption for top-level engine mutations.
message
GrpcEvitaAPI.proto:274Request to get progress of the top-level engine mutations.
string catalogName = 1
The name of the catalog for which the progress is requested. Might be empty if the progress is not related to any catalog and is related to the whole evitaDB instance.
message
GrpcEvitaAPI.proto:281Response to GrpcGetProgressRequest.
bool found = 1
True when a mutation progress was being tracked for `catalogName` at the moment this call was received. If `false`, none of the fields below carry information - either no mutation is currently in flight for this catalog, or a previously tracked one already finished (and its progress entry was cleared) before this call arrived; the call must be made while the operation is still running in order to observe it.
optional progressInPercent = 2
Current progress of the tracked mutation (percent, 0-100). Unset iff `found` is `false`. The final streamed message carries 100; intermediate updates are throttled (only sent on an increase, at most once per second).
string catalogName = 3
Catalog name copied from the request. Empty when `found` is `false`.
optional catalogVersion = 4
Catalog version reached by the operation. Set only on the final streamed message (`progressInPercent` = 100), and only if the operation produced a catalog version (i.e. relates to a catalog rather than being purely engine-level); unset on every intermediate update.
optional catalogSchemaVersion = 5
Catalog schema version reached by the operation. Set only on the final streamed message (`progressInPercent` = 100), and only if the operation produced a catalog schema version (i.e. relates to a catalog rather than being purely engine-level); unset on every intermediate update.
rpc IsReady (, )
GrpcEvitaAPI.proto:306Procedure used to check readiness of the API
message
GrpcEvitaAPI.proto:15Response to a server status request.
bool ready = 1
Always true when returned
Procedure used to make a catalog alive.
message
GrpcEvitaAPI.proto:166Response to a make catalog alive request.
bool success = 1
Indicator whether the catalog was made alive successfully.
rpc MakeCatalogAliveWithProgress (, stream )
GrpcEvitaAPI.proto:348Procedure used to make a catalog alive with progress tracking.
Procedure used to make a catalog immutable.
message
GrpcEvitaAPI.proto:154Response to a make catalog immutable request.
bool success = 1
Indicator whether the catalog was made immutable successfully.
rpc MakeCatalogImmutableWithProgress (, stream )
GrpcEvitaAPI.proto:344Procedure used to make a catalog immutable with progress tracking.
Procedure used to make a catalog mutable.
message
GrpcEvitaAPI.proto:142Response to a make catalog mutable request.
bool success = 1
Indicator whether the catalog was made mutable successfully.
rpc MakeCatalogMutableWithProgress (, stream )
GrpcEvitaAPI.proto:340Procedure used to make a catalog mutable with progress tracking.
rpc RegisterSystemChangeCapture (, stream )
GrpcEvitaAPI.proto:362Procedure used to register a system change capture.
message
GrpcEvitaAPI.proto:239Request to register a system change capture.
optional sinceVersion = 1
Starting point for the search (engine version). If `null`, the capture starts live-tailing from the most recent / greatest available engine version rather than replaying history from the beginning.
optional sinceIndex = 2
Continuation point within `sinceVersion` (index of the mutation within the engine version - currently each engine level transaction contains only one mutation). If `null`, the capture starts at the beginning of `sinceVersion` rather than resuming mid-transaction.
GrpcChangeCaptureContent content = 3
Requested content of the capture - i.e. whether client wants to receive only the simple notification about the change or whether he wants to receive the full content of the change
repeated criteria = 4
OR-ed criteria for the capture. When empty, defaults to ENGINE only on the system stream (NOTE: this differs from the catalog stream, which defaults to all areas including INFRASTRUCTURE). HOST on the system stream requires explicit opt-in.
message
GrpcEvitaAPI.proto:257Response to GrpcRegisterSystemChangeCapture request.
optional uuid = 1
Identification of the registered subscription. Set on `ACKNOWLEDGEMENT` and `HEARTBEAT` responses (when a subscription id is available), unset on `CHANGE` responses.
optional capture = 2
A single captured CDC event that matched the subscription's criteria - each stream message carries at most one event, not a batch. Set only when `responseType` is `CHANGE`; unset on `ACKNOWLEDGEMENT` and `HEARTBEAT` responses.
GrpcCaptureResponseType responseType = 3
The kind of this response: `ACKNOWLEDGEMENT` is sent exactly once, when the subscription is set up; `CHANGE` is sent for each matching capture event; `HEARTBEAT` is sent periodically as a keep-alive while no matching event has occurred.
optional heartBeat = 4
Heartbeat information. Set only on `ACKNOWLEDGEMENT` and `HEARTBEAT` responses, unset on `CHANGE` responses.
rpc RenameCatalog (, )
GrpcEvitaAPI.proto:330Procedure used to rename an existing catalog.
message
GrpcEvitaAPI.proto:100Response to a catalog rename request.
bool success = 1
Indicator whether the catalog was renamed successfully.
rpc RenameCatalogWithProgress (, stream )
GrpcEvitaAPI.proto:332Procedure used to rename an existing catalog with progress tracking.
rpc ReplaceCatalog (, )
GrpcEvitaAPI.proto:334Procedure used to replace an existing catalog.
message
GrpcEvitaAPI.proto:118Response to a catalog replace request.
bool success = 1
Indicator whether the catalog was replaced successfully.
rpc ReplaceCatalogWithProgress (, stream )
GrpcEvitaAPI.proto:336Procedure used to replace an existing catalog with progress tracking.
Procedure used to terminate existing session.
message
GrpcEvitaAPI.proto:50Request to terminate a session.
string sessionId = 2
UUID of the session to be terminated.
message
GrpcEvitaAPI.proto:56Response to a session termination request.
bool terminated = 1
Indicator whether the session was terminated successfully.
This service contains RPCs that could be called by gRPC clients on evitaDB's catalog by usage of a before created session. By specifying its UUID and the name of a catalog to which it corresponds to it's possible to execute methods that in evitaDB's implementation a called on an instance of EvitaSessionContract. Main purpose of this service is to provide a way to manipulate with stored entity collections and their schemas. That includes their creating, updating and deleting. Same operations could be done with entities, which in addition could be fetched by specifying a complex queries.
Applies single mutation to the entity.
Procedure that archives an entity and returns it with required richness.
message
GrpcEvitaSessionAPI.proto:757Request for archiving a single entity by primary key and returning it fetched in the richness described by `require`.
string entityType = 1
Entity type (collection name) the entity to archive belongs to.
optional primaryKey = 2
Primary key of the entity to archive. Effectively mandatory despite the wrapper type: the server reads its value directly without checking presence, so an unset value is treated identically to an explicit `0` rather than as "no primary key" - always set this field explicitly.
string require = 3
The string part of a parametrised `require` query fragment describing how richly to fetch the entity back after it is archived. `?`/`@name` placeholders are bound the same way as `positionalQueryParams`/`namedQueryParams` on `GrpcEntityRequest` - see there for the full binding contract.
repeated positionalQueryParams = 4
Values for the `?` positional placeholders in `require`, bound in encounter order (FIFO) - see `GrpcEntityRequest.positionalQueryParams` for the full binding contract.
map<string, > namedQueryParams = 5
Values for the `@name` named placeholders in `require`, keyed by name (without the `@` prefix) - see `GrpcEntityRequest.namedQueryParams` for the full binding contract.
message
GrpcEvitaSessionAPI.proto:848Response to ArchiveEntity request.
oneof response
At most one of these is set. If an entity with the requested primary key existed and was archived, which field is chosen by whether `GrpcArchiveEntityRequest.require` has an `entityFetch` requirement: `entity` (fully fetched) if it does, `entityReference` otherwise. Neither is set if no entity with the requested primary key existed to archive.
entityReference = 1
The archived entity as a reference (type + primary key only).
entity = 2
The archived entity, fully fetched per `GrpcArchiveEntityRequest.require`.
Procedure used to backup an existing catalog.
rpc BackupCatalogWithProgress (, stream )
GrpcEvitaSessionAPI.proto:942Procedure used to backup an existing catalog, streaming progress updates.
rpc Close (, )
GrpcEvitaSessionAPI.proto:948Procedure that closes the session.
message
GrpcEvitaSessionAPI.proto:531Request for Close, which commits or rollbacks the changes in the session and terminates it.
GrpcCommitBehavior commitBehaviour = 1
Contains the requested commit behaviour
string catalogName = 2
Name of the catalog to which the session relates.
bool rollback = 3
When true, the session's transaction is discarded (rolled back) instead of committed. The client sets this when an exception escaped the transaction block uncaught, so the server rolls back exactly as an embedded session would. When false (the default) the surviving changes are committed.
message
GrpcEvitaSessionAPI.proto:543Response for Close request that commits or rollbacks the changes in the session.
int64 catalogVersion = 1
Contains next catalog version
int32 catalogSchemaVersion = 2
Contains the version of the catalog schema that will be valid at the moment of closing the session. If session relates to a writable transaction, this schema version becomes valid at the moment the next catalog version (i.e. the one that is returned in the response) becomes visible.
rpc CloseWithProgress (, stream )
GrpcEvitaSessionAPI.proto:950Procedure that closes the session opening a stream that listens to transaction processing phases.
message
GrpcEvitaSessionAPI.proto:553Request for CloseGrpcCloseWithProgress procedure that commits or rollbacks the changes in the session.
string catalogName = 1
Name of the catalog to which the session relates.
bool rollback = 2
When true, the session's transaction is discarded (rolled back) instead of committed. The client sets this when an exception escaped the transaction block uncaught, so the server rolls back exactly as an embedded session would. When false (the default) the surviving changes are committed.
message
GrpcEvitaSessionAPI.proto:563Response for CloseGrpcCloseWithProgress request that commits or rollbacks the changes in the session.
int64 catalogVersion = 1
Contains next catalog version
int32 catalogSchemaVersion = 2
Contains the version of the catalog schema that will be valid at the moment of closing the session. If session relates to a writable transaction, this schema version becomes valid at the moment the next catalog version (i.e. the one that is returned in the response) becomes visible.
GrpcTransactionPhase finishedPhase = 3
The successfully finished phase of the transaction.
Procedure that defines the schema of a new entity type and return it.
message
GrpcEvitaSessionAPI.proto:342Request for defining the schema of a new entity type.
string entityType = 1
The schema of the new entity type.
message
GrpcEvitaSessionAPI.proto:348Response to DefineEntitySchema request.
optional entitySchema = 1
Newly created entity schema.
Procedure that deletes an entity collection.
message
GrpcEvitaSessionAPI.proto:474Request for deleting an entity collection.
string entityType = 1
The entity type of the collection to be deleted.
message
GrpcEvitaSessionAPI.proto:480Response to DeleteCollection request.
bool deleted = 1
True, if the collection was deleted.
Procedure that deletes all entities that match the sent query and returns their bodies.
message
GrpcEvitaSessionAPI.proto:802Request for deleting all entities matched by a query. Beware: without a `page()`/`strip()` requirement in the query's `require` block to bound the result, at most 20 entities are deleted (the engine's default page size) - add an explicit `page()`/`strip()` requirement to remove more.
string query = 1
The string part of the parametrised query. `?`/`@name` placeholders are bound the same way as `positionalQueryParams`/`namedQueryParams` on `GrpcEntityRequest` - see there for the full binding contract.
repeated positionalQueryParams = 2
Values for the `?` positional placeholders in `query`, bound in encounter order (FIFO) - see `GrpcEntityRequest.positionalQueryParams` for the full binding contract.
map<string, > namedQueryParams = 3
Values for the `@name` named placeholders in `query`, keyed by name (without the `@` prefix) - see `GrpcEntityRequest.namedQueryParams` for the full binding contract.
message
GrpcEvitaSessionAPI.proto:900Response to DeleteEntities request that deletes all entities matched by the sent query.
int32 deletedEntities = 1
Total number of entities deleted.
repeated deletedEntityBodies = 2
The deleted entities' bodies, fully fetched (as they were immediately before deletion) per the `require` block of the query in `GrpcDeleteEntitiesRequest`. Empty if that `require` block had no `entityFetch` requirement.
Procedure that deletes an entity and returns it with required richness.
message
GrpcEvitaSessionAPI.proto:833Response to DeleteEntity request.
oneof response
At most one of these is set. If an entity with the requested primary key existed and was deleted, which field is chosen by whether `GrpcDeleteEntityRequest.require` has an `entityFetch` requirement: `entity` (fully fetched, as it was immediately before deletion) if it does, `entityReference` otherwise. Neither is set if no entity with the requested primary key existed to delete.
entityReference = 1
The deleted entity as a reference (type + primary key only).
entity = 2
The deleted entity, fully fetched (as it was immediately before deletion) per `GrpcDeleteEntityRequest.require`.
Procedure that deletes an entity and its hierarchy and returns the root entity with required richness.
message
GrpcEvitaSessionAPI.proto:877Response to DeleteEntityAndItsHierarchy, which removes a hierarchical root entity together with every entity of the same type that transitively references it as a parent.
int32 deletedEntities = 1
Total number of entities deleted (the root plus its whole nested hierarchy).
oneof response
At most one of these is set. Unlike the equivalent oneof on `GrpcDeleteEntityResponse`, this RPC always fetches the root entity's body - even when `GrpcDeleteEntityRequest.require` is empty - so in practice `deletedRootEntity` is the field that gets populated; `deletedRootEntityReference` is currently unreachable in the server implementation. Neither is set if no entity with the requested primary key existed to delete. Covers only the root entity - the rest of the deleted hierarchy is available solely as primary keys via `deletedEntityPrimaryKeys` below.
deletedRootEntityReference = 2
The deleted root entity as a reference (type + primary key only). Currently never populated by the server - see the message-level comment above.
deletedRootEntity = 3
The deleted root entity, fully fetched (as it was immediately before deletion) per `GrpcDeleteEntityRequest.require`.
repeated int32 deletedEntityPrimaryKeys = 4
Primary keys of every entity deleted as part of the hierarchy removal, including the root entity's own primary key.
Procedure used to backup an existing catalog.
rpc FullBackupCatalogWithProgress (, stream )
GrpcEvitaSessionAPI.proto:946Procedure used to fully backup an existing catalog, streaming progress updates.
Procedure that returns the list of all entity types.
message
GrpcEvitaSessionAPI.proto:635Response to GetAllEntityTypes request.
repeated string entityTypes = 1
Names of all entity collections (entity types) defined in the catalog.
Procedure that returns the current (the one on which the used session operates) catalog schema.
message
GrpcEvitaSessionAPI.proto:290Request to GetCatalogSchema request.
bool nameVariants = 1
True, if the schema should include name variants for it and all sub-schemas. This could considerably increase the size of the response.
message
GrpcEvitaSessionAPI.proto:297Response to GetCatalogSchema request.
optional catalogSchema = 1
The current catalog schema.
int64 catalogVersion = 2
The current catalog version (data version, incremented with each transaction commit). Zero for catalogs that are in the warming-up state.
int32 catalogSchemaVersion = 3
The current catalog schema version.
Procedure that returns the current state of the catalog.
message
GrpcEvitaSessionAPI.proto:23Response to GetCatalogState request.
GrpcCatalogState state = 1
The current state of the catalog.
Procedure that returns the version of the catalog at a specific moment in time.
message
GrpcEvitaSessionAPI.proto:29Request to GrpcCatalogVersionAt request.
optional theMoment = 1
Chosen moment in time for which the version of the catalog should be returned.
GrpcTimeFlow timeFlow = 2
Signalizes whether the returned version should be the closest one before the specified moment or the closest one after the specified moment
message
GrpcEvitaSessionAPI.proto:38Response to GrpcCatalogVersionAt request.
int64 startVersion = 1
The first version of the materialized version block visible in the specified time
int64 endVersion = 2
The last version of the materialized version block visible in the specified time
optional introducedAt = 3
Exact moment when this materialized version block was introduced to the catalog snapshot
Procedure that find entity by passed entity type and primary key and return it by specified richness by passed parametrised require query part.
message
GrpcEvitaSessionAPI.proto:373Request for acquiring a single entity by primary key, in the richness described by `require`.
int32 primaryKey = 1
The primary key of the entity to fetch.
string entityType = 2
The entity type (collection name) the primary key belongs to.
string require = 3
The string part of a parametrised `require` query fragment (e.g. `entityFetch(attributeContentAll())`), parsed on the server. Parameter values are not embedded in this string but supplied separately via `positionalQueryParams`/`namedQueryParams` below. A `?` placeholder in this string is a positional parameter, an `@name` placeholder is a named parameter - see `positionalQueryParams`/`namedQueryParams` below for the full binding contract, which applies identically here.
repeated positionalQueryParams = 4
Values for the `?` positional placeholders in `require`, bound in encounter order: the first `?` in the parsed string binds to `positionalQueryParams[0]`, the second to `positionalQueryParams[1]`, and so on (FIFO). Supplying fewer values than there are `?` placeholders fails the request with "Missing argument of index N."; extra values are ignored.
map<string, > namedQueryParams = 5
Values for the `@name` named placeholders in `require`, keyed by the name used after `@` in the string (without the `@` prefix). An `@name` placeholder with no matching map entry fails the request with "Missing argument of name `name`."; extra map entries are ignored.
repeated GrpcEntityScope scopes = 6
Scopes to search for the entity in. An empty list defaults to searching only the `LIVE` scope - `ARCHIVED` entities are not matched unless `ARCHIVED_ENTITY` is explicitly included here.
message
GrpcEvitaSessionAPI.proto:399Response to GetEntity request.
optional entity = 1
The found entity. Unset (not an error) if no entity with the requested primary key exists in `entityType` within the requested `scopes`.
Procedure that returns the size of an entity collection.
message
GrpcEvitaSessionAPI.proto:519Request for acquiring the size of an entity collection.
string entityType = 1
The entity type (collection name) whose size (count of entities stored) should be returned.
message
GrpcEvitaSessionAPI.proto:525Response to GetEntityCollectionSize request.
int32 size = 1
The size of the collection.
Procedure that returns the schema of a specific entity type.
message
GrpcEvitaSessionAPI.proto:308Request for acquiring the schema of a specific entity type.
string entityType = 1
The entity type for which the schema is requested.
bool nameVariants = 2
True, if the schema should include name variants for it and all sub-schemas. This could considerably increase the size of the response.
message
GrpcEvitaSessionAPI.proto:317Response to GetEntitySchema request.
optional entitySchema = 1
The schema of the requested entity type.
rpc GetMutationsHistory (, stream )
GrpcEvitaSessionAPI.proto:1018Procedure that returns stream of all past mutations in reversed (newest-first) order that match the request criteria.
rpc GetMutationsHistoryForward (, stream )
GrpcEvitaSessionAPI.proto:1021Procedure that returns stream of all past mutations in chronological (oldest-first) order that match the request criteria - the forward counterpart of GetMutationsHistory.
Procedure that returns requested page of past mutations in reversed (newest-first) order that match the request criteria.
Procedure that returns requested page of past mutations in chronological (oldest-first) order that match the request criteria - the forward counterpart of GetMutationsHistoryPage.
Procedure that opens a transaction.
message
GrpcEvitaSessionAPI.proto:910Response to GetTransactionId request, returned after a new transaction is opened.
int64 catalogVersion = 1
The current version of the catalog the transaction is bound to.
optional transactionId = 2
The id of the opened transaction.
Procedure that returns details of a specific transactions that move catalog to specified versions.
message
GrpcEvitaSessionAPI.proto:210Request to GetTransactionOverview request.
repeated int64 catalogVersion = 1
The catalog versions to return the transaction overview for. See `GetTransactionOverviewResponse` for the ordering and completeness contract of the response.
message
GrpcEvitaSessionAPI.proto:220Response to GetTransactionOverview request. Entries preserve the relative order of the requested `catalogVersion` list, but a version unknown to history - purged, or never committed - is omitted rather than padded with an empty entry. The response can therefore be shorter than the request, and can be empty; it is not an error to ask for a version history no longer holds.
repeated transactionOverviews = 1
The transaction overviews for those requested catalog versions that are still known to history, in request order. Because unknown versions are omitted rather than padded, positions do not line up with the request - correlate each entry by its own `catalogVersion` field, never by index.
Procedure that changes the state of the catalog to ALIVE and closes the session.
message
GrpcEvitaSessionAPI.proto:575Response for GoLiveAndClose request that switches the catalog to ALIVE state and closes the session.
bool success = 1
True, if the catalog was switched to ALIVE state.
int64 catalogVersion = 2
Contains next catalog version
int32 catalogSchemaVersion = 3
Contains the version of the catalog schema that will be valid at the moment of closing the session. If session relates to a writable transaction, this schema version becomes valid at the moment the next catalog version (i.e. the one that is returned in the response) becomes visible.
rpc GoLiveAndCloseWithProgress (, stream )
GrpcEvitaSessionAPI.proto:938Procedure that changes the state of the catalog to ALIVE and closes the session opening a stream that listens to updates of go live procedure.
message
GrpcEvitaSessionAPI.proto:591One message of the GoLiveAndCloseWithProgress stream. Intermediate messages report only `progressInPercent` (throttled to at most once per second, and only when the percentage has increased); `catalogVersion`/`catalogSchemaVersion` are left at their zero default on those messages since they are not yet meaningful. The final message always carries `progressInPercent == 100` together with a populated `catalogVersion`/`catalogSchemaVersion`, and ends the stream.
int64 catalogVersion = 1
Contains next catalog version. Only populated on the final message (`progressInPercent == 100`); left at its default (`0`) on intermediate progress-only messages.
int32 catalogSchemaVersion = 2
Contains the version of the catalog schema that will be valid at the moment of closing the session. If session relates to a writable transaction, this schema version becomes valid at the moment the next catalog version (i.e. the one that is returned in the response) becomes visible. Only populated on the final message (`progressInPercent == 100`); left at its default (`0`) on intermediate progress-only messages.
int32 progressInPercent = 3
Progress of the go-live operation, 0-100. Monotonically increasing across messages; the final message in the stream always carries 100.
rpc Query (, )
GrpcEvitaSessionAPI.proto:957Procedure that executes passed parametrised query and returns a data chunk with computed extra results.
Procedure that executes passed parametrised query and returns a list of entities.
Procedure that executes passed query with embedded variables and returns a list of entities. Do not use in your applications! This method is unsafe and should be used only for internal purposes.
Procedure that executes passed parametrised query and returns zero or one entity.
Procedure that executes passed query with embedded variables and returns zero or one entity. Do not use in your applications! This method is unsafe and should be used only for internal purposes.
Procedure that executes passed query with embedded variables and returns a data chunk with computed extra results. Do not use in your applications! This method is unsafe and should be used only for internal purposes.
rpc RegisterChangeCatalogCapture (, stream )
GrpcEvitaSessionAPI.proto:1025Procedure that registers a change capture.
message
GrpcEvitaSessionAPI.proto:192Request to open a live subscription (RegisterChangeCatalogCapture) that streams mutations as they commit, optionally preceded by a historical replay starting at `sinceVersion`/`sinceIndex`.
optional sinceVersion = 1
Catalog version from which to start the historical replay portion of the subscription (inclusive). If unset, defaults to the current catalog version plus one, i.e. only mutations committed after the subscription is registered are delivered, with no historical replay.
optional sinceIndex = 2
Index of the mutation within `sinceVersion` from which to start the historical replay (inclusive). A version's mutations are numbered from 1 upward; the transaction header itself occupies index 0. If unset, defaults to 0, i.e. starting from that version's transaction header.
repeated criteria = 3
Criteria mutations must match to be included (entity type, mutation kind, area, etc.). An empty list applies no criteria-based filtering.
GrpcChangeCaptureContent content = 4
Whether delivered captures carry only mutation headers (`CHANGE_HEADER`, the default - proto3 zero value - when this field is left unset) or full mutation bodies (`CHANGE_BODY`).
message
GrpcEvitaSessionAPI.proto:274One message of the RegisterChangeCatalogCapture stream. `responseType` selects which payload is meaningful: `ACKNOWLEDGEMENT` (subscription set up; `heartBeat` populated, `capture` is not), `CHANGE` (`capture` populated, `heartBeat` is not), or `HEARTBEAT` (`heartBeat` populated, `capture` is not) - the periodic keep-alive sent while no matching mutation has occurred.
optional uuid = 1
Identification of the registered subscription. Present on every message, not just the initial acknowledgement.
optional capture = 2
The single mutation (CDC event) delivered by this message. Populated only when `responseType` is `CHANGE`; unset otherwise.
GrpcCaptureResponseType responseType = 3
Which payload field (`capture` or `heartBeat`) is populated on this message - see the message-level comment above.
optional heartBeat = 4
Heartbeat information. Populated when `responseType` is `ACKNOWLEDGEMENT` or `HEARTBEAT`; unset when `responseType` is `CHANGE`.
Procedure that renames an entity collection.
message
GrpcEvitaSessionAPI.proto:486Request for renaming an entity collection.
string entityType = 1
The entity type of the collection to be renamed.
string newName = 2
The new name of the collection.
message
GrpcEvitaSessionAPI.proto:494Response to RenameCollection request.
bool renamed = 1
True, if the collection was renamed.
Procedure that replaces an entity collection.
message
GrpcEvitaSessionAPI.proto:503Request for replacing an entity collection's contents with those of another collection. On success, `entityTypeToBeReplaced` is purged and its name is taken over by the (dropped) `entityTypeToBeReplacedWith` collection. If an error occurs mid-operation, both collections are guaranteed to be left untouched under their original names.
string entityTypeToBeReplaced = 1
Name of the collection that will be replaced: its current contents are dropped, and it will end up holding the contents of `entityTypeToBeReplacedWith` under this same name.
string entityTypeToBeReplacedWith = 2
Name of the collection whose contents become the new contents of `entityTypeToBeReplaced`. This collection itself no longer exists under its own name once the replacement completes.
message
GrpcEvitaSessionAPI.proto:513Response to ReplaceCollection request.
bool replaced = 1
True, if the collection was replaced.
Procedure that restores an entity and returns it with required richness.
message
GrpcEvitaSessionAPI.proto:779Request for restoring a single previously archived entity by primary key and returning it fetched in the richness described by `require`.
string entityType = 1
Entity type (collection name) the entity to restore belongs to.
optional primaryKey = 2
Primary key of the entity to restore. Effectively mandatory despite the wrapper type: the server reads its value directly without checking presence, so an unset value is treated identically to an explicit `0` rather than as "no primary key" - always set this field explicitly.
string require = 3
The string part of a parametrised `require` query fragment describing how richly to fetch the entity back after it is restored. `?`/`@name` placeholders are bound the same way as `positionalQueryParams`/`namedQueryParams` on `GrpcEntityRequest` - see there for the full binding contract.
repeated positionalQueryParams = 4
Values for the `?` positional placeholders in `require`, bound in encounter order (FIFO) - see `GrpcEntityRequest.positionalQueryParams` for the full binding contract.
map<string, > namedQueryParams = 5
Values for the `@name` named placeholders in `require`, keyed by name (without the `@` prefix) - see `GrpcEntityRequest.namedQueryParams` for the full binding contract.
message
GrpcEvitaSessionAPI.proto:862Response to RestoreEntity request.
oneof response
At most one of these is set. If an entity with the requested primary key existed and was restored, which field is chosen by whether `GrpcRestoreEntityRequest.require` has an `entityFetch` requirement: `entity` (fully fetched) if it does, `entityReference` otherwise. Neither is set if no archived entity with the requested primary key existed to restore.
entityReference = 1
The restored entity as a reference (type + primary key only).
entity = 2
The restored entity, fully fetched per `GrpcRestoreEntityRequest.require`.
Procedure that updates the catalog schema and returns it.
message
GrpcEvitaSessionAPI.proto:336Response to UpdateAndFetchCatalogSchema request, which updates the catalog schema and returns the resulting schema in one round trip.
optional catalogSchema = 1
The catalog schema after the requested mutations were applied.
Procedure that updates the schema of an existing entity type and returns it.
message
GrpcEvitaSessionAPI.proto:367Response to UpdateAndFetchEntitySchema request, which updates an entity type's schema and returns the resulting schema in one round trip.
optional entitySchema = 1
The entity schema after the requested mutations were applied.
Procedure that updates the catalog schema and return its updated version.
message
GrpcEvitaSessionAPI.proto:329Response to UpdateCatalogSchema request.
int32 version = 1
The new version of the catalog schema.
Procedure that updates the schema of an existing entity type and return its updated version.
message
GrpcEvitaSessionAPI.proto:360Response to UpdateEntitySchema request.
int32 version = 1
The new version of the entity schema.
Procedure that upserts (inserts/updates) an entity and returns it with required richness.
message
GrpcEvitaSessionAPI.proto:717Request for upserting (inserting/updating) an entity and returning it fetched in the richness described by `require`.
optional entityMutation = 1
The mutation to apply - either an upsert (insert/update) or a delete mutation for the entity.
string require = 2
The string part of a parametrised `require` query fragment (e.g. `entityFetch(attributeContentAll())`) describing how richly to fetch the entity back after the mutation is applied. `?`/`@name` placeholders are bound the same way as `positionalQueryParams`/`namedQueryParams` on `GrpcEntityRequest` - see there for the full binding contract.
repeated positionalQueryParams = 3
Values for the `?` positional placeholders in `require`, bound in encounter order (FIFO) - see `GrpcEntityRequest.positionalQueryParams` for the full binding contract.
map<string, > namedQueryParams = 4
Values for the `@name` named placeholders in `require`, keyed by name (without the `@` prefix) - see `GrpcEntityRequest.namedQueryParams` for the full binding contract.
message
GrpcEvitaSessionAPI.proto:816Response to UpsertEntity request.
oneof response
Exactly one of these is set. `entity` is set when `GrpcUpsertEntityRequest.require` has an `entityFetch` requirement. Otherwise a reference is returned: `entityReferenceWithAssignedPrimaryKeys` when the upsert caused reference primary keys to be reassigned (e.g. due to reflected reference schemas), or plain `entityReference` otherwise.
entityReference = 1
The upserted entity as a reference (type + primary key only).
entity = 2
The upserted entity, fully fetched per `GrpcUpsertEntityRequest.require`.
entityReferenceWithAssignedPrimaryKeys = 3
The upserted entity reference together with any reference primary keys that were reassigned as a side effect of the upsert.
This service contains RPCs that could be called by gRPC clients on evitaDB's catalog by usage of a before created session. Main purpose of this service is to provide a way to query and manage recorded traffic (queries, mutations, session lifecycle events) captured for diagnostics.
Procedure that exports a consistent, on-demand snapshot of the currently buffered traffic recording window to a downloadable zip archive - not gated by any running recording task.
Request to ExportTrafficRecording request.
optional chunkFileSizeInBytes = 1
The target size of each individual chunk file within the export (bytes); exported files are split into chunks of approximately this size. If unset, or set to zero, the server-configured default chunk size is used.
rpc GetTrafficRecordingHistory (, stream )
GrpcEvitaTrafficRecordingAPI.proto:132Procedure that returns stream of all past traffic records that match the request criteria. Order of the returned records is from the newest sessions to the oldest, traffic records within the session are ordered from the newest to the oldest.
Request for the streaming variant of the traffic history query; unlike GetTrafficHistoryListRequest, all matching records are streamed back without a result cap.
optional criteria = 1
The criteria of the traffic recording, allowing constraints on the returned records. If unset, no filters are applied and all recorded traffic is streamed back.
A single streamed response frame carrying traffic records.
repeated trafficRecord = 1
The traffic records carried by this streamed frame (the current server implementation emits exactly one record per frame).
Procedure that returns requested list of past traffic records with limited size that match the request criteria. Order of the returned records is from the oldest sessions to the newest, traffic records within the session are ordered from the oldest to the newest.
Procedure that returns requested list of past traffic records with limited size that match the request criteria. Order of the returned records is from the newest sessions to the oldest, traffic records within the session are ordered from the newest to the oldest.
Procedure returns a list of top unique label values ordered by cardinality of their values present in the traffic recording.
Request to GetTrafficRecordingLabelsValuesOrderedByCardinality request.
int32 limit = 1
Maximum number of label values to return, ordered by descending cardinality (most frequently used values first). This is a plain result cap, not page-based or offset-based pagination; repeated calls do not support continuation.
string labelName = 2
The name of the label to get the values for
optional valueStartsWith = 3
Only label values starting with this prefix are returned. If unset, no prefix filter is applied.
Response to GetTrafficRecordingLabelsValuesOrderedByCardinality request.
repeated string labelValue = 1
The label values that match the criteria, ordered by descending cardinality (most frequently used values first).
Procedure returns a list of top unique labels names ordered by cardinality of their values present in the traffic recording.
Request to GetTrafficRecordingLabelsNamesOrderedByCardinality request.
int32 limit = 1
Maximum number of label names to return, ordered by descending cardinality (most frequently used labels first). This is a plain result cap, not page-based or offset-based pagination; repeated calls do not support continuation.
optional nameStartsWith = 2
Only label names starting with this prefix are returned. If unset, no prefix filter is applied.
Response to GetTrafficRecordingLabelsNamesOrderedByCardinality request.
repeated string labelName = 1
The label names that match the criteria, ordered by descending cardinality (most frequently used labels first).
Procedure that starts the traffic recording for the given criteria and settings. Fails if a recording is already in progress - only one recording may run at a time.
Request to start a new traffic recording session. Only one recording may be in progress at a time; starting a new one while another is still running fails.
int32 samplingRate = 1
The sampling rate of the traffic recording (100 means all records will be recorded, 1 means 1% of records will be recorded)
bool exportFile = 2
If true the recording will be exported to a file, otherwise only internal ring buffer will be made available for the time the traffic recording is running.
optional maxDurationInMilliseconds = 3
The maximum duration of the recording (milliseconds); the recording stops automatically once this much time has elapsed. If unset, the recording keeps running until explicitly stopped via StopTrafficRecording.
optional maxFileSizeInBytes = 4
The maximum size of the recorded traffic data (bytes); the recording stops automatically once this much data has been captured. If unset, no size-based automatic stop is applied.
optional chunkFileSizeInBytes = 5
The target size of each individual chunk file within the export (bytes); exported files are split into chunks of approximately this size. If unset, or set to zero, the server-configured default chunk size is used.
Procedure that stops the traffic recording
Request to StopTrafficRecording request.
optional taskStatusId = 1
The ID of the task that started the recording
message
GrpcEvitaDataTypes.proto:409Structure that holds a map-typed node of a complex associated data value's tree.
Used in:
map<string, > data = 1
The child nodes of this map node, keyed by property name.
message
GrpcEvitaSessionAPI.proto:62Request for GetMutationsHistoryPage / GetMutationsHistoryPageForward, a paged read of past mutations (catalog schema changes and entity mutations) that match the given criteria. GetMutationsHistoryPage delivers pages reverse-chronologically (newest first); GetMutationsHistoryPageForward delivers them chronologically (oldest first). The two RPCs share this same request/response message pair; fields whose meaning depends on direction say so explicitly below. A page never splits a single entity/schema mutation from the local-mutation captures it produced. The CDC model has exactly three levels - there is no separate "record" level: the transaction level (`version` alone), the entity/schema-mutation level (`index` within a `version`; index 0 is reserved for the transaction's own lead event), and the local-mutation level (the individual field-level changes an entity mutation fans out into, which share their parent's `(version, index)` instead of getting an index of their own). In this RPC's paging terms, a "record" is simply one `(version, index)` group: either the lone transaction-lead capture by itself, or one entity/schema-mutation capture plus every local-mutation capture it produced. See `GetMutationsHistoryPageResponse` for what that implies for `pageSize` and for completeness checking across page boundaries.
Used as request type in: EvitaSessionService.GetMutationsHistoryPage, EvitaSessionService.GetMutationsHistoryPageForward
optional page = 1
The requested page number (1-indexed: page 1 is the first page in whichever direction the RPC traverses - newest-first for GetMutationsHistoryPage, oldest-first for GetMutationsHistoryPageForward). If unset, defaults to 1. Not rejected when it lands past the last available page - the response is simply empty; see `GetMutationsHistoryPageResponse.hasNext` for how to detect the last page.
optional pageSize = 2
The number of records to return per page (see the message-level comment for what a record is - this is page-based paging over records, not over individual captures). If unset, defaults to 20. Not rejected or capped when it exceeds the number of available records; the last page is simply shorter. Because pages are record-aligned, the number of `GrpcChangeCatalogCapture` entries actually returned can exceed `pageSize` whenever the last included record fans out into several local-mutation captures - `pageSize` bounds records, not entries.
optional sinceVersion = 3
Catalog version to anchor the search at (inclusive). Meaning depends on which RPC this request is sent to: - GetMutationsHistoryPage (reverse): an upper bound - the anchor to start from and go backward. If unset, defaults to the upper bound implied by the request - the version resolved from `timeFrame`'s upper bound when `timeFrame` is set, otherwise the session's current catalog version. A value above that bound is silently clamped down to it rather than rejected. - GetMutationsHistoryPageForward (forward): a lower bound - the anchor to start from and go forward. If unset, defaults to the lower bound implied by the request - the version resolved from `timeFrame`'s lower bound when set, otherwise the oldest version known to the catalog's mutation history. A value below that bound is silently clamped up to it. A value above the newest available version is not an error - it simply yields an empty result, since "past the newest" is a legitimate (if unusual) floor. Leave this unset only for the very first page of a traversal; from the second page on, pass back `GetMutationsHistoryPageResponse.sinceVersion` from the previous page's response verbatim, to keep the whole traversal anchored to one consistent version - see that field for details.
optional sinceIndex = 4
Index of the mutation within `sinceVersion` to anchor the search at (inclusive). A version's mutations are numbered from 1 upward; the transaction header itself occupies index 0. If unset, defaults to 0 for GetMutationsHistoryPageForward ("start from that version's transaction header") or `Integer.MAX_VALUE` for GetMutationsHistoryPage ("start from the newest mutation of that version"). This default applies independently of whether `sinceVersion` is set - but not independently of whether the resolved `sinceVersion` ends up clamped (up to the forward floor, or down to the reverse ceiling - see `sinceVersion` above): an explicitly set `sinceIndex` is discarded and the direction default used instead whenever that clamp happens, since the client computed it against the original, un-clamped version, and it no longer identifies a valid position in the version actually resolved to.
optional timeFrame = 5
Restricts the search to mutations committed within this time range. For GetMutationsHistoryPage (reverse), the lower bound (`from`) is exclusive - the version resolved from it is excluded from the result, even though the underlying version-resolution lookup it uses is itself inclusive of that moment. For GetMutationsHistoryPageForward (forward), the upper bound (`to`) is inclusive instead: the last version committed at or before `to` is the traversal's far, stopping edge, and is itself included in the result - not symmetric to `from` on the reverse RPC. A forward `from` moment in the future is not an error either - like an explicit `sinceVersion` past the newest available version (see above), it simply yields an empty result rather than falling back to the newest mutations. Time-to-version resolution for both `from` and `to` is checkpoint-granular, not exact to the mutation's own commit moment - a `from`/`to` that lands inside the current checkpoint interval may include or exclude mutations committed within that same interval on either side of the requested boundary.
repeated criteria = 6
Criteria mutations must match to be included (entity type, mutation kind, area, etc.). An empty list applies no criteria-based filtering.
GrpcChangeCaptureContent content = 7
Whether the response carries only mutation headers (`CHANGE_HEADER`, the default - proto3 zero value - when this field is left unset) or full mutation bodies (`CHANGE_BODY`). Only `CHANGE_BODY` carries enough information (e.g. `mutationCount` on the transaction header) to verify a transaction was received in full.
message
GrpcEvitaSessionAPI.proto:135Response to GetMutationsHistoryPage request. Unlike `GrpcPaginatedList`/`GrpcDataChunk` elsewhere in this API, there is no `totalRecordCount` here - a WAL scan cannot produce one cheaply - so `hasNext` is computed by the server peeking one record past the requested page rather than from a precomputed count, and there is no `isLast`/`hasPrevious` counterpart either. See `sinceVersion` below for the anchor-echo mechanism that keeps a multi-page traversal consistent across concurrent commits. Pages never split a `(version, index)` group (see `GetMutationsHistoryPageRequest` for what that means - there is no separate "record level", just the transaction/entity-schema-mutation/local-mutation levels the CDC model actually has). That guarantee holds at the entity/schema-mutation level only, not at the transaction level: a page's first group can be a transaction's non-header entity/schema mutation without that transaction's lead event appearing anywhere in the same page. So the `mutationCount`-based completeness check available on the unpaged `GetMutationsHistory`/`GetMutationsHistoryForward` RPCs is not usable across page boundaries here.
Used as response type in: EvitaSessionService.GetMutationsHistoryPage, EvitaSessionService.GetMutationsHistoryPageForward
repeated changeCapture = 1
The mutations on this page - newest first for GetMutationsHistoryPage, oldest first for GetMutationsHistoryPageForward. Can be shorter than the requested page size - including empty - and, since a page never splits a `(version, index)` group, can also carry more entries than `pageSize` when the last included group fans out into several local-mutation captures; see the message-level comment.
bool hasNext = 2
Whether a further page exists beyond this one - see the message-level comment for how this is derived.
int64 sinceVersion = 3
The catalog version this page's traversal is anchored to. If the request left `sinceVersion` unset, this reports what the implied bound resolved to: "now" (the newest available version) for GetMutationsHistoryPage, or the oldest known version for GetMutationsHistoryPageForward - no other RPC reports either directly (`GetCatalogVersionAt` with no moment set reports the *oldest* known version only, regardless of direction). Pass this value back as `GetMutationsHistoryPageRequest.sinceVersion` on every subsequent page of the same traversal to keep it anchored to that one version throughout. If `sinceVersion` is instead left unset on every call, each page resolves the bound independently, so a commit landing between page fetches moves it and mutations can be skipped or duplicated across pages.
message
GrpcEvitaSessionAPI.proto:159Request for GetMutationsHistory / GetMutationsHistoryForward, a streamed read of past mutations that match the given criteria - the unpaged sibling of GetMutationsHistoryPage / GetMutationsHistoryPageForward. GetMutationsHistory delivers them reverse-chronologically (newest first); GetMutationsHistoryForward delivers them chronologically (oldest first). The two RPCs share this same request message; `sinceVersion` switches meaning by direction.
Used as request type in: EvitaSessionService.GetMutationsHistory, EvitaSessionService.GetMutationsHistoryForward
optional sinceVersion = 1
Catalog version to anchor the search at (inclusive). For GetMutationsHistory (reverse), an upper bound - the anchor to start from and go backward; if unset, defaults to the engine's last applied catalog version (this default differs from the paged RPC's, which anchors on the session's current catalog version instead - the two can diverge under concurrent writes). For GetMutationsHistoryForward (forward), a lower bound - the anchor to start from and go forward; if unset, defaults to the oldest version known to the catalog's mutation history. A forward `sinceVersion` past the newest available version is not rejected - it simply yields an empty stream.
optional sinceIndex = 2
Index of the mutation within `sinceVersion` to anchor the search at (inclusive). A version's mutations are numbered from 1 upward; the transaction header itself occupies index 0. If unset, no index-based filtering is applied within `sinceVersion` - all of that version's mutations are included.
repeated criteria = 3
Criteria mutations must match to be included (entity type, mutation kind, area, etc.). An empty list applies no criteria-based filtering.
GrpcChangeCaptureContent content = 4
Whether the response carries only mutation headers (`CHANGE_HEADER`, the default - proto3 zero value - when this field is left unset) or full mutation bodies (`CHANGE_BODY`). Only `CHANGE_BODY` carries enough information (e.g. `mutationCount` on the transaction header) to verify a transaction was received in full.
message
GrpcEvitaSessionAPI.proto:185Response to GetMutationsHistory / GetMutationsHistoryForward request. The server sends one such message per mutation - each carries exactly one `changeCapture` entry, not a batch (see the RPC's streaming semantics).
Used as response type in: EvitaSessionService.GetMutationsHistory, EvitaSessionService.GetMutationsHistoryForward
repeated changeCapture = 1
The single mutation delivered by this stream message.
Request for a single bounded batch of past traffic records matching the given criteria.
Used as request type in: GrpcEvitaTrafficRecordingService.GetTrafficRecordingHistoryList, GrpcEvitaTrafficRecordingService.GetTrafficRecordingHistoryListReversed
int32 limit = 1
Maximum number of matching traffic records to return in this response. This is a plain result cap - not page-based or offset-based pagination - and the server enforces no upper bound of its own beyond it. To continue fetching beyond this limit, issue a new request with `criteria.sinceSessionSequenceId` and `criteria.sinceRecordSessionOffset` set to the position right after the last record already received.
optional criteria = 2
The criteria of the traffic recording, allowing constraints on the returned records. If unset, no filters are applied and all recorded traffic (up to `limit`) is eligible.
Response to GetTrafficHistoryList request.
Used as response type in: GrpcEvitaTrafficRecordingService.GetTrafficRecordingHistoryList, GrpcEvitaTrafficRecordingService.GetTrafficRecordingHistoryListReversed
repeated trafficRecord = 1
The matching traffic records, up to the requested `limit`.
Response to StartTrafficRecording, StopTrafficRecording, and ExportTrafficRecording requests.
Used as response type in: GrpcEvitaTrafficRecordingService.ExportTrafficRecording, GrpcEvitaTrafficRecordingService.StartTrafficRecording, GrpcEvitaTrafficRecordingService.StopTrafficRecording
optional taskStatus = 1
The status of the recording task
message
GrpcEvitaAPI.proto:186Request to activate a catalog.
Used as request type in: EvitaService.ActivateCatalog, EvitaService.ActivateCatalogWithProgress
string catalogName = 1
Name of the catalog to activate.
Mutation is responsible for adding one or more currencies to a `EntitySchema.currencies` in `EntitySchema`.
Used in:
repeated currencies = 1
Set of all currencies that could be used for prices in entities of this type.
Mutation is responsible for adding one or more modes to a `CatalogSchema.catalogEvolutionMode` in `CatalogSchema`.
Used in:
repeated GrpcCatalogEvolutionMode evolutionModes = 1
Set of allowed catalog evolution modes. These allow to specify how strict is evitaDB when unknown information is presented to her for the first time. When no evolution mode is set, each violation of the `CatalogSchema` is reported by an error. This behaviour can be changed by this evolution mode, however.
Mutation is responsible for adding one or more modes to a `EntitySchema.evolutionMode` in `EntitySchema`.
Used in:
repeated GrpcEvolutionMode evolutionModes = 1
Set of allowed evolution modes. These allow to specify how strict is evitaDB when unknown information is presented to her for the first time. When no evolution mode is set, each violation of the `EntitySchema` is reported by an error. This behaviour can be changed by this evolution mode, however.
Mutation is responsible for adding one or more locales to a `EntitySchema.locales` in `EntitySchema`.
Used in:
repeated locales = 1
Set of all locales that could be used for localized `AttributeSchema` or `AssociatedDataSchema`.
message
GrpcEvitaManagementAPI.proto:53Status of the external API
Used in:
bool enabled = 1
True when this API is turned on in the server configuration. An enabled API can still be briefly not ready while the server is starting up - see `ready`.
bool ready = 2
True when the API has finished initialization and is actually able to serve requests. Always false when `enabled` is false.
repeated string baseUrl = 3
Base URLs the API is reachable on - one per configured host binding (`host`, plus the `exposeOn` override if set), so this commonly holds more than one URL even though the field name is singular.
repeated endpoints = 4
Notable endpoints exposed by this API in addition to its base URLs, each entry naming the endpoint and giving its URL(s). Currently only the system API populates this list; every other API reports it empty.
message
GrpcAttributeMutations.proto:14Increments or decrements existing numeric value by specified delta (negative number produces decremental of existing number, positive one incrementation). Allows to specify the number range that is tolerated for the value after delta application has been finished to verify for example that number of items on stock doesn't go below zero.
Used in: ,
string attributeName = 1
Unique name of the attribute. Case-sensitive. Distinguishes one associated data item from another within single entity instance.
optional attributeLocale = 2
Contains locale in case the attribute is locale specific.
oneof delta
Delta to change existing value by of this attribute (negative number produces decremental of existing number, positive one incrementation).
int32 integerDelta = 3
Integer delta to apply to existing value of this attribute.
int64 longDelta = 4
Long delta to apply to existing value of this attribute.
bigDecimalDelta = 5
BigDecimal delta to apply to existing value of this attribute.
oneof requiredRangeAfterApplication
Number range that is tolerated for the value after delta application has been finished to verify for example that number of items on stock doesn't go below zero.
integerRequiredRangeAfterApplication = 6
Integer number range within which the value after delta application has to be.
longRequiredRangeAfterApplication = 7
Long number range within which the value after delta application has to be.
bigDecimalRequiredRangeAfterApplication = 8
BigDecimal number range within which the value after delta application has to be.
message
GrpcEvitaAPI.proto:210Request to apply mutation on engine level.
Used as request type in: EvitaService.ApplyMutation, EvitaService.ApplyMutationWithProgress
optional mutation = 1
Single engine level mutation to be applied.
message
GrpcEvitaAPI.proto:224Streamed progress report for any of evitaDB's long-running catalog-lifecycle operations that support progress tracking (apply mutation, rename, replace, make mutable/immutable/alive, duplicate, activate, deactivate - see the `*WithProgress` RPCs on `EvitaService`). One or more intermediate messages are streamed as the operation advances, followed by exactly one final message with `progressInPercent` set to 100.
Used as response type in: EvitaService.ActivateCatalogWithProgress, EvitaService.ApplyMutationWithProgress, EvitaService.DeactivateCatalogWithProgress, EvitaService.DuplicateCatalogWithProgress, EvitaService.MakeCatalogAliveWithProgress, EvitaService.MakeCatalogImmutableWithProgress, EvitaService.MakeCatalogMutableWithProgress, EvitaService.RenameCatalogWithProgress, EvitaService.ReplaceCatalogWithProgress
int32 progressInPercent = 1
Progress of the tracked operation (percent, 0-100). Intermediate updates are throttled (only sent on an increase, at most once per second); the final message of the stream always carries 100.
optional catalogVersion = 2
Catalog version reached by the operation. Set only on the final message (`progressInPercent` = 100), and only if the operation produced a catalog version (i.e. relates to a catalog rather than being purely engine-level); unset on every intermediate update.
optional catalogSchemaVersion = 3
Catalog schema version reached by the operation. Set only on the final message (`progressInPercent` = 100), and only if the operation produced a catalog schema version (i.e. relates to a catalog rather than being purely engine-level); unset on every intermediate update.
message
GrpcEntitySchema.proto:270This is the definition object for associated data that is stored along with entity. Definition objects allow to describe the structure of the entity type so that in any time everyone can consult complete structure of the entity type. Associated data carry additional data entries that are never used for filtering / sorting but may be needed to be fetched along with entity in order to present data to the target consumer (i.e. user / API / bot). Associated data may be stored in slower storage and may contain wide range of data types - from small ones (i.e. numbers, strings, dates) up to large binary arrays representing entire files (i.e. pictures, documents).
Used in:
string name = 1
Contains unique name of the model. Case-sensitive. Distinguishes one model item from another within single entity instance.
optional description = 2
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
optional deprecationNotice = 3
Deprecation notice contains information about planned removal of this entity from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes. If notice is `null`, this schema is considered not deprecated.
GrpcEvitaAssociatedDataDataType.GrpcEvitaDataType type = 4
Data type of the associated data. Must be one of Evita-supported values. Internally the type is converted into Java-corresponding data type. The type may be scalar type or may represent complex object type (JSON).
bool localized = 5
Localized associated data has to be ALWAYS used in connection with specific `Locale`. In other words - it cannot be stored unless associated locale is also provided.
bool nullable = 6
When associated data is nullable, its values may be missing in the entities. Otherwise, the system will enforce non-null checks upon upserting of the entity.
repeated nameVariant = 7
Contains associated data name converted to different naming conventions.
GrpcConflictResolutionOverride conflictResolutionOverride = 8
Contains the per-associated-data override of the conflict resolution granularity. Defaults to inherited (follow the resolved conflict resolution).
message
GrpcEntitySchema.proto:478Attribute element is a part of the sortable compound. It defines the attribute name, the direction of the sorting and the behaviour of the null values. The attribute name refers to the existing attribute defined in the schema.
Used in: ,
string attributeName = 1
Name of the existing attribute in the same schema.
GrpcOrderDirection direction = 2
Direction of the sorting.
GrpcOrderBehaviour behaviour = 3
Behaviour of the null values.
Enum specifies different modes for reference attributes inheritance in reflected schema.
Used in: , ,
INHERIT_ALL_EXCEPT = 0
* Inherit all attributes by default except those listed in the attribute inheritance filter array.
INHERIT_ONLY_SPECIFIED = 1
* Do not inherit any attributes by default except those listed in the attribute inheritance filter array.
message
GrpcAttributeMutations.proto:65Mutation of a single attribute.
Used in:
oneof mutation
The mutation to apply.
applyDeltaAttributeMutation = 1
Increments or decrements existing numeric value by specified delta (negative number produces decremental of existing number, positive one incrementation).
upsertAttributeMutation = 2
Upsert attribute mutation will either update existing attribute or create new one.
removeAttributeMutation = 3
Remove attribute mutation will drop existing attribute - ie.generates new version of the attribute with tombstone on it.
message
GrpcEntitySchema.proto:162This is the definition object for attributes that are stored along with entity. Definition objects allow to describe the structure of the entity type so that in any time everyone can consult complete structure of the entity type. Definition object is similar to Java reflection process where you can also at any moment see which fields and methods are available for the class. Entity attributes allows defining set of data that are fetched in bulk along with the entity body. Attributes may be indexed for fast filtering (`AttributeSchema.filterable`) or can be used to sort along (`AttributeSchema.sortable`). Attributes are not automatically indexed in order not to waste precious memory space for data that will never be used in search queries. Filtering in attributes is executed by using constraints like `and`, `not`, `attributeEquals`, `attributeContains` and many others. Sorting can be achieved with `attributeNatural` or others. Attributes are not recommended for bigger data as they are all loaded at once requested. Large data that are occasionally used store in `associatedData`.
Used in: ,
string name = 1
Contains unique name of the model. Case-sensitive. Distinguishes one model item from another within single entity instance.
GrpcAttributeSchemaType schemaType = 2
When this attribute schema belongs to a catalog - it is global and can have globally unique attributes enforced across whole catalog.
optional description = 3
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
optional deprecationNotice = 4
Deprecation notice contains information about planned removal of this entity from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes. If notice is `null`, this schema is considered not deprecated.
GrpcAttributeUniquenessType unique = 5
When attribute is unique it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute among other entities in the same collection. As an example of unique attribute can be EAN - there is no sense in having two entities with same EAN, and it's better to have this ensured by the database engine. Deprecated since 2024.12 - deprecated in favor of `uniqueInScopes`
GrpcGlobalAttributeUniquenessType uniqueGlobally = 6
When attribute is unique globally it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute in the entire catalog. The type of the unique attribute must implement the `Comparable` interface. As an example of unique attribute can be URL - there is no sense in having two entities with same URL, and it's better to have this ensured by the database engine. Deprecated since 2024.12 - deprecated in favor of `uniqueGloballyInScopes`
bool filterable = 7
When attribute is filterable, it is possible to filter entities by this attribute. Do not mark attribute as filterable unless you know that you'll search entities by this attribute. Each filterable attribute occupies (memory/disk) space in the form of index. When attribute is filterable, extra result `attributeHistogram` can be requested for this attribute. Deprecated since 2024.12 - deprecated in favor of `filterableInScopes`
bool sortable = 8
When attribute is sortable, it is possible to sort entities by this attribute. Do not mark attribute as sortable unless you know that you'll sort entities along this attribute. Each sortable attribute occupies (memory/disk) space in the form of index. Deprecated since 2024.12 - deprecated in favor of `sortableInScopes`
bool localized = 9
When attribute is localized, it has to be ALWAYS used in connection with specific `Locale`.
bool nullable = 10
When attribute is nullable, its values may be missing in the entities. Otherwise, the system will enforce non-null checks upon upserting of the entity.
bool representative = 11
Representative flag marks the attribute as one of the most important attributes in the entity, or when used on a reference-level attribute schema, it marks attributes distinguishing duplicated references to the same entity and is a key attribute for creating distinct indexes for such references. In overall, representative attributes should be used in developer tools along with the entity's primary key to describe the entity or reference to that entity. If the flag is used correctly, it can be very helpful to developers in quickly finding their way around the data. There should be very few representative attributes in the entity / reference type, and the ones with uniqueness significance are usually the best to choose.
GrpcEvitaDataType type = 12
Data type of the attribute. Must be one of Evita-supported values. Internally the scalar is converted into Java-corresponding data type.
optional defaultValue = 13
Default value is used when the entity is created without this attribute specified. Default values allow to pass non-null checks even if no attributes of such name are specified.
int32 indexedDecimalPlaces = 14
Determines how many fractional places are important when entities are compared during filtering or sorting. It is significant to know that all values of this attribute will be converted to `Int`, so the attribute number must not ever exceed maximum limits of `Int` type when scaling the number by the power of ten using `indexedDecimalPlaces` as exponent.
repeated nameVariant = 15
Contains attribute name converted to different naming conventions.
bool inherited = 16
Contains true if the attribute was inherited from the original object via reflected reference relation
repeated uniqueInScopes = 17
When attribute is unique it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute among other entities in the same collection. As an example of unique attribute can be EAN - there is no sense in having two entities with same EAN, and it's better to have this ensured by the database engine.
repeated uniqueGloballyInScopes = 18
When attribute is unique globally it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute in the entire catalog. The type of the unique attribute must implement the `Comparable` interface. As an example of unique attribute can be URL - there is no sense in having two entities with same URL, and it's better to have this ensured by the database engine.
repeated GrpcEntityScope filterableInScopes = 19
When attribute is filterable, it is possible to filter entities by this attribute. Do not mark attribute as filterable unless you know that you'll search entities by this attribute. Each filterable attribute occupies (memory/disk) space in the form of index. When attribute is filterable, extra result `attributeHistogram` can be requested for this attribute.
repeated GrpcEntityScope sortableInScopes = 20
When attribute is sortable, it is possible to sort entities by this attribute. Do not mark attribute as sortable unless you know that you'll sort entities along this attribute. Each sortable attribute occupies (memory/disk) space in the form of index.
GrpcConflictResolutionOverride conflictResolutionOverride = 21
Contains the per-attribute override of the conflict resolution granularity. Defaults to inherited (follow the resolved conflict resolution).
Mutation of an attribute schema.
Used in:
oneof mutation
Type of the mutation.
createAttributeSchemaMutation = 3
Mutation is responsible for setting up a new `AttributeSchema` in the `EntitySchema`.
modifyAttributeSchemaDefaultValueMutation = 4
Mutation is responsible for modifying a default value of an existing `AttributeSchema` in the `EntitySchema`.
modifyAttributeSchemaDeprecationNoticeMutation = 5
Mutation is responsible for modifying a deprecation notice of an existing `AttributeSchema` in the `EntitySchema`.
modifyAttributeSchemaDescriptionMutation = 6
Mutation is responsible for modifying a description of an existing `AttributeSchema` in the `EntitySchema`.
modifyAttributeSchemaNameMutation = 7
Mutation is responsible for renaming an existing `AttributeSchema` in `EntitySchema` or `GlobalAttributeSchema` in `CatalogSchema`.
modifyAttributeSchemaTypeMutation = 8
Mutation is responsible for modifying a type of an existing `AttributeSchema` in the `EntitySchema`.
removeAttributeSchemaMutation = 9
Mutation is responsible for removing an existing `AttributeSchema` in the `EntitySchema` or `GlobalAttributeSchema`
setAttributeSchemaFilterableMutation = 10
Mutation is responsible for setting value `AttributeSchema.filterable` in `EntitySchema`.
setAttributeSchemaLocalizedMutation = 11
Mutation is responsible for setting value `AttributeSchema.localized` in `EntitySchema`.
setAttributeSchemaNullableMutation = 12
Mutation is responsible for setting value `AttributeSchema.nullable` in `EntitySchema`.
setAttributeSchemaRepresentativeMutation = 13
Mutation is responsible for setting value `AttributeSchema.representative` in `EntitySchema`.
setAttributeSchemaSortableMutation = 14
Mutation is responsible for setting value `AttributeSchema.sortable` in `EntitySchema`.
setAttributeSchemaUniqueMutation = 15
Mutation is responsible for setting value `AttributeSchema.unique` in `EntitySchema`.
useGlobalAttributeSchemaMutation = 16
Mutation is responsible for introducing a `GlobalAttributeSchema` into an `EvitaSession`.
setAttributeSchemaConflictResolutionOverrideMutation = 17
Mutation is responsible for setting value `AttributeSchema.conflictResolutionOverride` in `EntitySchema`.
Defines the type of the attribute schema
Used in:
GLOBAL_SCHEMA = 0
attribute schema is GlobalAttributeSchemaContract
ENTITY_SCHEMA = 1
attribute schema is EntityAttributeSchemaContract
REFERENCE_SCHEMA = 2
attribute schema is AttributeSchemaContract
Represents constant or "special" value attribute can have (or has it implicitly, e.g. missing value is represented `null` that is not directly comparable).
Used in: ,
NULL = 0
Represents missing value.
NOT_NULL = 1
Represents existing (not-null) value.
message
GrpcEvitaDataTypes.proto:234Wrapper for representing an array of AttributeSpecialValue enums.
Used in:
repeated GrpcAttributeSpecialValue value = 1
The individual AttributeSpecialValue values, in their original order.
This enum represents the uniqueness type of an `AttributeSchema`. It is used to determine whether the attribute value must be unique among all the entity attributes of this type or whether it must be unique only among attributes of the same locale.
Used in: , , , , ,
NOT_UNIQUE = 0
The attribute is not unique (default).
UNIQUE_WITHIN_COLLECTION = 1
The attribute value must be unique among all the entities of the same collection.
UNIQUE_WITHIN_COLLECTION_LOCALE = 2
The localized attribute value must be unique among all values of the same `Locale` among all the entities using of the same collection.
message
GrpcEvitaSessionAPI.proto:606Request to back up a catalog and stream the backup file to the client.
Used as request type in: EvitaSessionService.BackupCatalog, EvitaSessionService.BackupCatalogWithProgress
optional pastMoment = 1
The moment in time to back up the catalog's state to. If unset, defaults to the current moment (subject to being overridden by `catalogVersion`, see below).
bool includingWAL = 2
True, if the WAL should be included in the backup. Use false if you want to restore catalog in exact state as it was at the pastMoment.
optional catalogVersion = 3
Precise catalog version to create the backup for. If unset, defaults to the latest version - or, when `pastMoment` is set, the version resolved from `pastMoment`. When this field is set, `pastMoment` is ignored regardless of whether it is also set.
message
GrpcEvitaSessionAPI.proto:620Response to a catalog backup request.
Used as response type in: EvitaSessionService.BackupCatalog, EvitaSessionService.BackupCatalogWithProgress
optional taskStatus = 1
Handle to the asynchronous backup task; use it to poll or stream the task's progress and, once finished, retrieve the resulting backup file.
message
GrpcEvitaDataTypes.proto:64Representation of Java's BigDecimal class with arbitrary precision.
Used in: , , , , , , , ,
string valueString = 1
The decimal value serialized as a string in the canonical form produced by `BigDecimal#toString()`, with the exponent marker lower-cased and its `+` sign stripped (e.g. `2.5e8` rather than `2.5E+8`). Preserves the original scale so the value round-trips exactly.
message
GrpcEvitaDataTypes.proto:156Wrapper for representing an array of BigDecimals.
Used in: ,
repeated value = 1
The individual BigDecimal elements, in their original order.
message
GrpcEvitaDataTypes.proto:38Representation of BigDecimalNumberRange structures. At least one of `from`/`to` should be set; if both are absent, the range decodes to the degenerate range `[0,0]` rather than being unbounded in both directions.
Used in: , , ,
optional from = 1
The inclusive lower bound of the range. If unset (while `to` is set), the range is unbounded below.
optional to = 2
The inclusive upper bound of the range. If unset (while `from` is set), the range is unbounded above.
int32 decimalPlacesToCompare = 3
The number of fractional digits retained (rounded half-up) when comparing values against this range: both bounds and the compared value are scaled to this precision first, so digits beyond it are ignored for range-membership comparisons.
message
GrpcEvitaDataTypes.proto:183Wrapper for representing an array of BigDecimalNumberRanges.
Used in: ,
repeated value = 1
The individual BigDecimalNumberRange elements, in their original order.
message
GrpcEntity.proto:167Response carries entities in a binary format and is part of the PRIVATE API that is used by Java driver. The client that receives the binary data must know how to deserialize them using Kryo deserializers which are internal to the evitaDB (and even if they had been public they could not have been used because Kryo is not ported to other platforms than Java). The response is triggered by BinaryForm query requirement.
Used in: , ,
string entityType = 1
Type of entity. Entity type is main sharding key - all data of entities with same type are stored in separated collections. Within the entity type entity is uniquely represented by primary key.
int32 primaryKey = 2
Unique Integer positive number representing the entity. Can be used for fast lookup for entity (entities). Primary key must be unique within the same entity type.
int32 schemaVersion = 3
Contains version of this entity schema and gets increased with any entity type update. Allows to execute optimistic locking i.e. avoiding parallel modifications.
bytes entityStoragePart = 4
Serialized representation of the entity body.
repeated bytes attributeStorageParts = 5
Serialized representation of entity attributes.
repeated bytes associatedDataStorageParts = 6
Serialized representation of entity associated data.
bytes priceStoragePart = 7
Serialized representation of entity prices.
bytes referenceStoragePart = 8
Serialized representation of entity references.
message
GrpcEvitaDataTypes.proto:150Wrapper for representing an array of booleans.
Used in: ,
repeated bool value = 1
The individual boolean elements, in their original order.
Enum specifying the type of response that is sent to the subscriber.
Used in: ,
ACKNOWLEDGEMENT = 0
The response contains only the acknowledgement of the subscription.
CHANGE = 1
The response contains the change event that was captured.
HEARTBEAT = 2
The response contains the heartbeat event.
In EvitaDB we define only one-way relationship from the perspective of the entity. We stick to the ERD modelling <a href="https://www.gleek.io/blog/crows-foot-notation.html">standards</a> here.
Used in: , , , , ,
NOT_SPECIFIED = 0
No cardinality specified.
ZERO_OR_ONE = 1
Relation may be missing completely, but if it exists - there is never more than single relation of this type.
EXACTLY_ONE = 2
There is always single relation of this type.
ZERO_OR_MORE = 3
Relation may be missing completely, but there may be also one or more relations of this type.
ONE_OR_MORE = 4
There is always at least one relation of this type, but there may be also more than one.
ZERO_OR_MORE_WITH_DUPLICATES = 5
There is always at least one relation of this type, but there may be also more than one. When there is more than one, they may refer the same target entity (and are distinguished by reference attributes)
ONE_OR_MORE_WITH_DUPLICATES = 6
There is always at least one relation of this type, but there may be also more than one. When there is more than one, they may refer the same target entity (and are distinguished by reference attributes)
Evolution mode allows to specify how strict is evitaDB when unknown information is presented to her for the first time. When no evolution mode is set, each violation of the EntitySchema is reported by an exception. However, this behaviour can be changed by this evolution mode.
Used in: , ,
ADDING_ENTITY_TYPES = 0
When new entity is inserted and no collection of its entity type exists, it is silently created with empty schema and with all Evolution modes allowed.
message
GrpcChangeCapture.proto:155Fires when a catalog's local reference settles into a non-transient state on this host.
Used in:
string catalogName = 1
the name of the catalog whose reference settled
GrpcCatalogState observedState = 2
the non-transient state the catalog settled into
int64 currentEngineVersion = 3
snapshot of the engine version at emit time (correlation only - does not advance)
message
GrpcChangeCapture.proto:165Fires when a catalog is fully removed from the live view on this host.
Used in:
string catalogName = 1
the name of the catalog that was removed
int64 currentEngineVersion = 2
snapshot of the engine version at emit time (correlation only - does not advance)
message
GrpcCatalogSchema.proto:15Represents the schema of a single catalog - the top-level container that groups related entity collections together (analogous to a database / schema in a relational system). Holds the catalog name, its schema version, optional description, evolution mode settings, catalog-wide (global) attributes shared across entity types, name variants and the conflict resolution policy inherited by entity schemas that don't override it.
Used in: ,
string name = 1
Contains unique name of the catalog. Case-sensitive. Distinguishes one catalog item from another within single entity instance.
int32 version = 2
Contains version of this catalog schema and gets increased with any entity type update. Allows to execute optimistic locking i.e. avoiding parallel modifications.
optional description = 3
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
repeated GrpcCatalogEvolutionMode catalogEvolutionMode = 4
set of evolution modes that allow to specify how strict is evitaDB when unknown information is presented to her for the first time. When no evolution mode is set, each violation of the catalog schema is reported by an exception. This behaviour can be changed by this evolution mode, however.
map<string, > attributes = 5
Contains index of generally (catalog-wide) shared `AttributeSchema` that could be used as attributes of any entity type that refers them. These attributes cannot be changed from within the entity schema. Entity schemas will not be able to define their own attribute of same name that would clash with the global one (they may only reference the attributes with the same name from the catalog schema). There may be entities that won't take advantage of certain global attributes (i.e. it's not guaranteed that all entity types in catalog have all global attributes). The "catalog-wide" unique attributes allows Evita to fetch entity of any (and up-front unknown) entity type by some unique attribute value - usually URL.
repeated nameVariant = 6
Contains catalog name converted to different naming conventions.
optional conflictResolution = 7
Contains the catalog-level conflict resolution setting. When not set (absent), the catalog schema inherits the resolved conflict resolution from the transaction options.
message
GrpcChangeCapture.proto:174Fires when a catalog's schema version increases on this host (coalesced once per session/transaction). See HostSystemEvent.CatalogSchemaUpdated.
Used in:
string catalogName = 1
the name of the catalog whose schema version increased
int32 newSchemaVersion = 2
the new (current) catalog schema version on this host
int64 currentEngineVersion = 3
snapshot of the engine version at emit time (correlation only - does not advance)
Indicates actual state in which Evita operates. See detailed information for each state.
Used in: , , , ,
WARMING_UP = 0
Initial state of the Evita catalog. This state has several limitations but also advantages. This state requires single threaded access - this means only single thread can read/write data to the catalog in this state. No transactions are allowed in this state and there are no guarantees on consistency of the catalog if any of the WRITE operations fails. If any error is encountered while writing to the catalog in this state it is strongly recommended discarding entire catalog contents and starts filling it from the scratch. Writing to the catalog in this phase is much faster than with transactional access. Operations are executed in bulk, transactional logic is disabled and doesn't slow down the writing process. This phase is meant to quickly fill initial state of the catalog from the external primary data store. This state is also planned to be used when new replica is created and needs to quickly catch up with the master.
ALIVE = 1
Standard "serving" state of the Evita catalog. All operations are executed transactionally and leave the date in consistent state even if any error occurs. Multiple readers and writers can work with the catalog simultaneously.
CORRUPTED = 3
State signalizing that evitaDB engine was not able to consistently open and load this catalog from the file system.
INACTIVE = 4
State signalizing that evitaDB engine didn't load this catalog from the file system, but is present in the persistence storage. Catalog might be loaded into memory later on demand and start to process requests.
GOING_ALIVE = 5
State signalizing that evitaDB engine is transitioning catalog from `WARMING_UP` to `ALIVE` state. Until the transition is fully completed, the catalog is not able to serve any requests.
BEING_ACTIVATED = 6
State signalizing that evitaDB engine is loading catalog from the file system to the memory and performing initialization of the catalog. The catalog is not able to serve any requests until the initialization is fully completed.
BEING_DEACTIVATED = 7
State signalizing that evitaDB engine is deactivating the catalog. When the operation is completed, the catalog is moved to `INACTIVE` state.
BEING_CREATED = 8
State signalizing that evitaDB engine is creating a new catalog. The catalog is not able to serve any requests until the creation is fully completed.
BEING_DELETED = 9
State signalizing that evitaDB engine is deleting the catalog. When the operation is completed, the catalog is removed from the file system and is no longer available.
MISSING = 10
State signalizing that a catalog previously registered with the engine no longer has an on-disk folder. The engine records this divergence via `MarkCatalogMissingMutation` so it can be diagnosed and later recovered via auto-discovery or operator action.
OUT_OF_DATE = 11
State signalizing that the catalog's on-disk storage protocol is older than the engine supports. Reads and writes are refused until the catalog has been upgraded via `UpgradeCatalogFormatMutation`.
BEING_UPGRADED = 12
State signalizing that the catalog is currently being upgraded from an older storage protocol to the one the engine supports. Transient state entered while an `UpgradeCatalogFormatMutation` is running; the completion phase returns the catalog to its prior operational state.
UNKNOWN_CATALOG_STATE = 2
Unknown state of the catalog. Used when catalog is corrupted.
message
GrpcEvitaDataTypes.proto:488Aggregates basic data about the catalog and entity types stored in it.
Used in:
optional catalogId = 1
unique identifier of the catalog
string catalogName = 2
The catalog's unique name, used to address it via the API.
bool corrupted = 3
true if the catalog is corrupted (other data will be not available) Deprecated since 2025.7 - deprecated in favor of `catalogState` (compare against `CORRUPTED`)
GrpcCatalogState catalogState = 4
Current lifecycle state of the catalog. Reflects `CORRUPTED` when the catalog failed to load consistently, or `UNKNOWN_CATALOG_STATE` if the state could not be determined.
int64 catalogVersion = 5
version of the catalog, -1 for corrupted catalog
int64 totalRecords = 6
total number of records in the catalog, -1 for corrupted catalog
int64 indexCount = 7
total number of indexes in the catalog, -1 for corrupted catalog
int64 sizeOnDiskInBytes = 8
total size of the catalog on disk in bytes
repeated entityCollectionStatistics = 9
statistics for each entity collection in the catalog, empty array for corrupted catalog
bool readOnly = 10
true if the catalog is read-only, false otherwise
bool unusable = 11
true if the catalog is unusable, false otherwise
The enum defines what catalog area is covered by the capture.
Used in: ,
SCHEMA = 0
Changes in the schema are captured.
DATA = 1
Changes in the data are captured.
INFRASTRUCTURE = 2
Infrastructural mutations that are neither schema nor data.
The container type describes internal evitaDB data structures.
Used in: ,
CONTAINER_CATALOG = 0
Catalog - similar to relational database schema.
CONTAINER_ENTITY = 1
Entity - similar to relational database table (or better - set of inter-related tables).
CONTAINER_ATTRIBUTE = 2
Attribute - similar to relational database column.
CONTAINER_ASSOCIATED_DATA = 3
Reference - similar to an unstructured JSON document in relational database column.
CONTAINER_PRICE = 4
Price - fixed structure data type, could be represented as row in a specialized table in relational database.
CONTAINER_REFERENCE = 5
Reference - similar to a foreign key in relational database or a binding table in many-to-many relationship.
Enum to specify the depth of details sent in the CDC event.
Used in: , , ,
CHANGE_HEADER = 0
Only the header of the event is sent.
CHANGE_BODY = 1
Entire mutation triggering the event is sent. In case of mutations with the large content (associated data update), the size of the event can be significant. Consider whether you need the entire mutation or just the header.
message
GrpcChangeCapture.proto:18Record for the criteria of the capture request allowing to limit mutations to specific area of interest and its properties.
Used in: , ,
GrpcChangeCaptureArea area = 1
The area of capture - SCHEMA, DATA or INFRASTRUCTURE. If `schemaSite`/`dataSite` below is set, it determines the effective area and this field is ignored; this field is only consulted when neither site is set, which is also the only way to select INFRASTRUCTURE (it has no site message of its own).
oneof site
At most one of `schemaSite`/`dataSite` may be set. If neither is set, every mutation matching `area` passes without further site-level filtering; each set field on the chosen site message narrows the match further (see that message's field comments for what an unset field means).
schemaSite = 2
Criteria for schema capture
dataSite = 3
Criteria for data capture
message
GrpcChangeCapture.proto:54Record describing the location and form of the CDC data event in the evitaDB that should be captured. Every field below is an independent, optional filter (logically ANDed together when several are set); an unset/empty field imposes no restriction on that dimension.
Used in:
optional entityType = 1
Restricts capture to mutations of the named entity type. If `null`, matches data mutations for any entity type.
optional entityPrimaryKey = 2
Restricts capture to mutations of the entity with this primary key. If `null`, matches any primary key within the entity type filter above.
repeated GrpcChangeCaptureOperation operation = 3
Restricts capture to the listed operation types. If empty, matches any operation.
repeated GrpcChangeCaptureContainerType containerType = 4
Restricts capture to the listed container types (e.g. attribute, associated data, reference). If empty, matches any container type.
repeated string containerName = 5
Restricts capture to containers with one of the listed names (e.g. attribute name, associated data name, reference name). If empty, matches containers of any name.
Enumeration of possible mutation types handled by evitaDB.
Used in: , , ,
UPSERT = 0
Create or update operation - i.e. there was data with such identity before, and it was updated.
REMOVE = 1
Remove operation - i.e. there was data with such identity before, and it was removed.
TRANSACTION = 2
Delimiting operation signaling the beginning of a transaction.
message
GrpcChangeCapture.proto:37Record describing the location and form of the CDC schema event in the evitaDB that should be captured. Every field below is an independent, optional filter (logically ANDed together when several are set); an unset/empty field imposes no restriction on that dimension.
Used in:
optional entityType = 1
Restricts capture to schema mutations of the named entity type. If `null`, matches schema mutations for any entity type, including catalog-level schema changes (which carry no entity type of their own).
repeated GrpcChangeCaptureOperation operation = 2
Restricts capture to the listed operation types. If empty, matches any operation.
repeated GrpcChangeCaptureContainerType containerType = 3
Restricts capture to the listed container types (e.g. attribute, associated data, reference). If empty, matches any container type.
repeated string containerName = 4
Restricts capture to containers with one of the listed names (e.g. attribute name, associated data name, reference name). If empty, matches containers of any name.
message
GrpcChangeCapture.proto:72Record represents a catalog CDC event that is sent to the subscriber if it matches to the request he made.
Used in: , ,
optional version = 1
The catalog version the operation was committed in. Strictly monotonic across the stream: ascending in a forward stream, descending in a reverse stream.
optional index = 2
A direction-stable physical position of the underlying WAL record within its transaction, not a delivery counter: a forward stream assigns `1..mutationCount` ascending, a reverse stream assigns `mutationCount..1` descending, so the same physical record gets the same index regardless of direction - but indices are therefore NOT monotonic within a transaction when read in reverse (the transaction header is emitted at index `0`, then indices count down from `mutationCount`). Nested local mutations do not get their own index: they inherit the `(version, index)` pair of the entity mutation record they belong to, so `(version, index)` identifies a WAL record, not an individual emitted capture - an entity upsert with 5 local mutations produces 6 captures that all share the same pair. The index is advanced before criteria filtering is applied, so it stays stable and comparable across requests using different filters.
GrpcChangeCaptureArea area = 3
the area of the operation
optional entityType = 4
the name of the entity type or its schema that was affected by the operation (if the operation is executed on catalog schema this field is null)
optional entityPrimaryKey = 5
the primary key of the entity that was affected by the operation (null for schema operations)
GrpcChangeCaptureOperation operation = 6
The kind of change that produced this capture. Together with `area`, it determines which arm of `body` (if present) carries the payload - see the `body` oneof comment for the mapping.
oneof body
Payload of the operation. Present only when the request's content mode is `CHANGE_BODY` (see `GrpcChangeCaptureContent`); a `CHANGE_HEADER` request - the proto3 default when `content` is left unset - always leaves every arm of this oneof unset. When present, exactly one arm is set, chosen by `area`/`operation`: `schemaMutation` for a SCHEMA area mutation, `entityMutation` for the top-level DATA area entity mutation, `localMutation` for a DATA area field-level mutation nested inside an entity upsert (it shares the parent entity mutation's `(version, index)` - see the `index` field comment above), `infrastructureMutation` for the INFRASTRUCTURE area transaction header.
schemaMutation = 7
Set for a SCHEMA area mutation. See the `body` comment above for the full arm-selection mapping.
entityMutation = 8
Set for the top-level DATA area entity mutation. See the `body` comment above.
localMutation = 9
Set for a DATA area field-level mutation nested inside an entity upsert. See the `body` comment above and the `index` field comment for how it shares its parent's `(version, index)`.
infrastructureMutation = 10
Set for the INFRASTRUCTURE area transaction header. See the `body` comment above.
optional timestamp = 99
Represents the timestamp of the commit.
message
GrpcChangeCapture.proto:120Record represents a system CDC event that is sent to the subscriber if it matches to the request he made.
Used in:
int64 version = 1
the version of the engine where the operation was performed
int32 index = 2
the index of the event within the enclosed transaction, index 0 is the transaction lead event
GrpcChangeCaptureOperation operation = 3
the operation that was performed
oneof body
Body of the capture - exactly one of the two branches when present. Old clients that do not opt in to HOST never receive `hostEvent`; clients that decode an unknown oneof tag drop the body silently, which is acceptable.
systemMutation = 4
Engine mutation body - durable, WAL-replicated event (ENGINE area).
hostEvent = 6
Host event body (HOST area, opt-in only).
optional timestamp = 5
Represents the timestamp of the commit.
message
GrpcChangeCapture.proto:272Criteria for filtering system CDC captures. OR-ed when multiple are provided. Default-shape divergence vs catalog stream: when criteria is empty, only ENGINE events are delivered - HOST requires explicit opt-in.
Used in:
GrpcSystemCaptureArea area = 1
The area of capture (system stream supports only ENGINE and HOST).
Enum describes possible classifier types used in reserved keywords listing
Used in:
CLASSIFIER_TYPE_SERVER_NAME = 0
* Identification of the server instance.
CLASSIFIER_TYPE_CATALOG = 1
* Identification of the catalog.
CLASSIFIER_TYPE_ENTITY = 2
* Identification of the entity type.
CLASSIFIER_TYPE_ATTRIBUTE = 3
* Identification of the attribute.
CLASSIFIER_TYPE_ASSOCIATED_DATA = 4
* Identification of the associated data (rich content).
CLASSIFIER_TYPE_REFERENCE = 5
* Identification of the reference.
CLASSIFIER_TYPE_REFERENCE_ATTRIBUTE = 6
* Identification of the reference attribute.
Contains set of all possible close method behavior types when the session is committed/closed
Used in: , ,
WAIT_FOR_CONFLICT_RESOLUTION = 0
Changes performed in the transaction are passed to evitaDB server, checked for conflicts and if no conflict is found the transaction is marked as completed and commit is finished. This behaviour is fastest, but does not guarantee that the changes are persisted on disk and durable. If the server crashes before the changes are written to disk, the changes are lost.
WAIT_FOR_LOG_PERSISTENCE = 1
Changes performed in the transaction are passed to evitaDB server, checked for conflicts and if no conflict is found, they are written to Write Ahead Log (WAL) and transaction waits until the WAL is persisted on disk (fsynced). After that the transaction is marked as completed and commit is finished. This behaviour is slower than `WAIT_FOR_CONFLICT_RESOLUTION` but guarantees that the changes are persisted on disk and durable. The server may decide to fsync changes from multiple transactions at once, so the transaction may wait longer than necessary. This behaviour still does not guarantee that the changes will be visible immediately after the commit - because they still need to be propagated to indexes in order new data can be found by queries. This behaviour is default.
WAIT_FOR_CHANGES_VISIBLE = 2
Changes performed in the transaction are passed to evitaDB server, checked for conflicts and if no conflict is found, they are written to Write Ahead Log (WAL). Then the WAL is processed and all changes are propagated to indexes. After that the transaction is marked as completed and commit is finished. This behaviour is slowest but guarantees that the changes are persisted on disk and durable and that they are visible immediately after the commit is marked as completed.
Enum represents the coarse, mutually exclusive scope at which transaction conflicts are detected.
Used in:
CONFLICT_POLICY_NONE = 0
No conflict detection is performed.
CONFLICT_POLICY_CATALOG = 1
Conflicts are detected at the catalog level.
CONFLICT_POLICY_COLLECTION = 2
Conflicts are detected at the entity collection level.
CONFLICT_POLICY_ENTITY = 3
Conflicts are detected at the entity level.
message
GrpcEnums.proto:898Represents the conflict resolution setting combining the coarse conflict policy scope with an optional set of sub-entity granular refinements. Used as an optional (nullable) field on catalog and entity schemas — an absent message means the schema inherits the resolved conflict resolution.
Used in: , , , , ,
GrpcConflictPolicy policy = 1
The coarse, mutually exclusive scope at which conflicts are detected.
repeated GrpcGranularConflictPolicy granularity = 2
The set of sub-entity refinements; non-empty only when policy is set to entity level.
Enum represents the per-item override of the conflict resolution granularity applied to a schema element (attribute, associated data or reference).
Used in: , , , , , , , , , ,
CONFLICT_RESOLUTION_OVERRIDE_INHERITED = 0
The schema element follows the resolved conflict resolution (no explicit override).
CONFLICT_RESOLUTION_OVERRIDE_GRANULAR = 1
Conflicts on this schema element are detected at granular (sub-entity) level.
CONFLICT_RESOLUTION_OVERRIDE_ENTITY = 2
Conflicts on this schema element are detected at whole-entity level.
Mutation is responsible for setting up a new `AssociatedDataSchema` in the `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
Used in:
string name = 1
Contains unique name of the model. Case-sensitive. Distinguishes one model item from another within single entity instance.
optional description = 2
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
optional deprecationNotice = 3
Deprecation notice contains information about planned removal of this associated data from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes.
GrpcEvitaAssociatedDataDataType.GrpcEvitaDataType type = 4
Contains the data type of the entity. Must be one of supported types or may represent complex type - which is JSON object that can be automatically converted to the set of basic types.
bool localized = 5
Localized associated data has to be ALWAYS used in connection with specific `locale`. In other words - it cannot be stored unless associated locale is also provided.
bool nullable = 6
When associated data is nullable, its values may be missing in the entities. Otherwise, the system will enforce non-null checks upon upserting of the entity.
GrpcConflictResolutionOverride conflictResolutionOverride = 7
The per-associated-data override of the conflict resolution granularity.
Mutation is responsible for setting up a new `AttributeSchema` in the `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` alone.
Used in: ,
string name = 1
Name of the attribute the mutation is targeting.
optional description = 2
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
optional deprecationNotice = 3
Deprecation notice contains information about planned removal of this attribute from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes.
GrpcAttributeUniquenessType unique = 4
When attribute is unique it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute among other entities in the same collection. Deprecated since 2024.12 - deprecated in favor of `uniqueInScopes`
bool filterable = 5
When attribute is filterable, it is possible to filter entities by this attribute. Do not mark attribute as filterable unless you know that you'll search entities by this attribute. Each filterable attribute occupies (memory/disk) space in the form of index. Deprecated since 2024.12 - deprecated in favor of `filterableInScopes`
bool sortable = 6
When attribute is sortable, it is possible to sort entities by this attribute. Do not mark attribute as sortable unless you know that you'll sort entities along this attribute. Each sortable attribute occupies (memory/disk) space in the form of index. Deprecated since 2024.12 - deprecated in favor of `sortableInScopes`
bool localized = 7
Localized attribute has to be ALWAYS used in connection with specific `locale`. In other words - it cannot be stored unless associated locale is also provided.
bool nullable = 8
When attribute is nullable, its values may be missing in the entities. Otherwise, the system will enforce non-null checks upon upserting of the entity.
bool representative = 9
If an attribute is flagged as representative, it should be used in developer tools along with the entity's primary key to describe the entity or reference to that entity. The flag is completely optional and doesn't affect the core functionality of the database in any way. However, if it's used correctly, it can be very helpful to developers in quickly finding their way around the data. There should be very few representative attributes in the entity type, and the unique ones are usually the best to choose.
GrpcEvitaDataType type = 10
Type of the attribute. Must be one of supported data types or its array.
int32 indexedDecimalPlaces = 11
Determines how many fractional places are important when entities are compared during filtering or sorting. It is significant to know that all values of this attribute will be converted to `Integer`, so the attribute number must not ever exceed maximum limits of `Integer` type when scaling the number by the power of ten using `indexedDecimalPlaces` as exponent.
optional defaultValue = 12
Default value is used when the entity is created without this attribute specified. Default values allow to pass non-null checks even if no attributes of such name are specified.
repeated uniqueInScopes = 13
When attribute is unique it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute among other entities in the same collection.
repeated GrpcEntityScope filterableInScopes = 14
When attribute is filterable, it is possible to filter entities by this attribute. Do not mark attribute as filterable unless you know that you'll search entities by this attribute. Each filterable attribute occupies (memory/disk) space in the form of index.
repeated GrpcEntityScope sortableInScopes = 15
When attribute is sortable, it is possible to sort entities by this attribute. Do not mark attribute as sortable unless you know that you'll sort entities along this attribute. Each sortable attribute occupies (memory/disk) space in the form of index.
GrpcConflictResolutionOverride conflictResolutionOverride = 16
The per-attribute override of the conflict resolution granularity.
message
GrpcEngineMutation.proto:13Mutation is responsible for setting up a new CatalogSchema.
Used in:
string catalogName = 1
Name of newly created catalog schema.
optional conflictResolution = 2
Optional catalog-level transaction conflict resolution override applied to the new catalog. When not set, the catalog inherits the engine-level default.
Mutation is responsible for setting up a new `EntitySchema` - or more precisely the collection within catalog.
Used in: ,
string entityType = 1
Name of newly created entity schema.
Mutation is responsible for setting up a new `GlobalAttributeSchema` in the `CatalogSchema`. Mutation can be used for altering also the existing `GlobalAttributeSchema` alone.
Used in:
string name = 1
Name of the attribute the mutation is targeting.
optional description = 2
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
optional deprecationNotice = 3
Deprecation notice contains information about planned removal of this attribute from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes.
GrpcAttributeUniquenessType unique = 4
When attribute is unique it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute among other entities in the same collection. Deprecated since 2024.12 - deprecated in favor of `uniqueInScopes`
GrpcGlobalAttributeUniquenessType uniqueGlobally = 5
When attribute is unique globally it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute in entire catalog. Deprecated since 2024.12 - deprecated in favor of `uniqueGloballyInScopes`
bool filterable = 6
When attribute is filterable, it is possible to filter entities by this attribute. Do not mark attribute as filterable unless you know that you'll search entities by this attribute. Each filterable attribute occupies (memory/disk) space in the form of index. Deprecated since 2024.12 - deprecated in favor of `filterableInScopes`
bool sortable = 7
When attribute is sortable, it is possible to sort entities by this attribute. Do not mark attribute as sortable unless you know that you'll sort entities along this attribute. Each sortable attribute occupies (memory/disk) space in the form of index. Deprecated since 2024.12 - deprecated in favor of `sortableInScopes`
bool localized = 8
Localized attribute has to be ALWAYS used in connection with specific `locale`. In other words - it cannot be stored unless associated locale is also provided.
bool nullable = 9
When attribute is nullable, its values may be missing in the entities. Otherwise, the system will enforce non-null checks upon upserting of the entity.
bool representative = 10
If an attribute is flagged as representative, it should be used in developer tools along with the entity's primary key to describe the entity or reference to that entity. The flag is completely optional and doesn't affect the core functionality of the database in any way. However, if it's used correctly, it can be very helpful to developers in quickly finding their way around the data. There should be very few representative attributes in the entity type, and the unique ones are usually the best to choose.
GrpcEvitaDataType type = 11
Type of the attribute. Must be one of supported data types or its array.
int32 indexedDecimalPlaces = 12
Determines how many fractional places are important when entities are compared during filtering or sorting. It is significant to know that all values of this attribute will be converted to `Integer`, so the attribute number must not ever exceed maximum limits of `Integer` type when scaling the number by the power of ten using `indexedDecimalPlaces` as exponent.
optional defaultValue = 13
Default value is used when the entity is created without this attribute specified. Default values allow to pass non-null checks even if no attributes of such name are specified.
repeated uniqueInScopes = 14
When attribute is unique it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute among other entities in the same collection.
repeated uniqueGloballyInScopes = 15
When attribute is unique globally it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute in entire catalog.
repeated GrpcEntityScope filterableInScopes = 16
When attribute is filterable, it is possible to filter entities by this attribute. Do not mark attribute as filterable unless you know that you'll search entities by this attribute. Each filterable attribute occupies (memory/disk) space in the form of index.
repeated GrpcEntityScope sortableInScopes = 17
When attribute is sortable, it is possible to sort entities by this attribute. Do not mark attribute as sortable unless you know that you'll sort entities along this attribute. Each sortable attribute occupies (memory/disk) space in the form of index.
GrpcConflictResolutionOverride conflictResolutionOverride = 18
The per-attribute override of the conflict resolution granularity.
Mutation is responsible for setting up a new `ReferenceSchema` in the `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
Used in:
string name = 1
Name of the reference the mutation is targeting.
optional description = 2
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
optional deprecationNotice = 3
Deprecation notice contains information about planned removal of this schema from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes.
GrpcCardinality cardinality = 4
Cardinality describes the expected count of relations of this type. In evitaDB we define only one-way relationship from the perspective of the entity. We stick to the ERD modelling [standards](https://www.gleek.io/blog/crows-foot-notation.html) here. Cardinality affect the design of the client API (returning only single reference or collections) and also help us to protect the consistency of the data so that conforms to the creator mental model.
string referencedEntityType = 5
Reference to `EntitySchema.name` of the referenced entity. Might be also any `String` that identifies type some external resource not maintained by Evita.
bool referencedEntityTypeManaged = 6
Whether `referencedEntityType` refers to any existing `EntitySchema.name` that is maintained by Evita.
optional referencedGroupType = 7
Reference to `EntitySchema.name` of the referenced group entity. Might be also any `String` that identifies type some external resource not maintained by Evita.
bool referencedGroupTypeManaged = 8
Whether `referencedGroupType` refers to any existing `EntitySchema.name` that is maintained by Evita.
bool filterable = 9
Whether the index for this reference should be created and maintained allowing to filter by `referenceHaving` filtering constraints. Index is also required when reference is `faceted`. Do not mark reference as faceted unless you know that you'll need to filter/sort entities by this reference. Each indexed reference occupies (memory/disk) space in the form of index. When reference is not indexed, the entity cannot be looked up by reference attributes or relation existence itself, but the data is loaded alongside other references if requested. Deprecated since 2024.12 - deprecated in favor of `indexedInScopes`
bool faceted = 10
Whether the statistics data for this reference should be maintained and this allowing to get `referenceSummary` for this reference or use `facetInSet` filtering query. Do not mark reference as faceted unless you want it among `FacetStatistics`. Each faceted reference occupies (memory/disk) space in the form of index. Reference that was marked as faceted is called Facet. Deprecated since 2024.12 - deprecated in favor of `facetedInScopes`
repeated GrpcEntityScope indexedInScopes = 11
Whether the index for this reference should be created and maintained allowing to filter by `referenceHaving` filtering constraints. Index is also required when reference is `faceted`. Do not mark reference as faceted unless you know that you'll need to filter/sort entities by this reference. Each indexed reference occupies (memory/disk) space in the form of index. When reference is not indexed, the entity cannot be looked up by reference attributes or relation existence itself, but the data is loaded alongside other references if requested. Deprecated since 2025.6 - deprecated in favor of `scopedIndexTypes`
repeated GrpcEntityScope facetedInScopes = 12
Whether the statistics data for this reference should be maintained and this allowing to get `referenceSummary` for this reference or use `facetInSet` filtering query. Do not mark reference as faceted unless you want it among `FacetStatistics`. Each faceted reference occupies (memory/disk) space in the form of index. Reference that was marked as faceted is called Facet.
repeated scopedIndexTypes = 13
Scoped reference index types that define both the scope and the type of index for the reference. This replaces the deprecated `indexedInScopes` field with more granular control over indexing.
repeated scopedIndexedComponents = 14
Scoped reference indexed components that specify which parts of a reference relationship (referenced entity, referenced group entity) are indexed per scope. When not specified, the default indexed components are determined automatically.
repeated facetedPartially = 15
Per-scope expressions that narrow which entities participate in faceting.
repeated bucketedInScopes = 16
Per-scope bucketed histogram configurations defining index name and value expression.
repeated bucketedPartiallyInScopes = 17
Per-scope expressions that narrow which entities participate in bucketed histogram computation.
GrpcConflictResolutionOverride conflictResolutionOverride = 18
The per-reference override of the conflict resolution granularity.
Mutation is responsible for setting up a new `ReflectedReferenceSchema` in the `EntitySchema`. Mutation can be used for altering also the existing `ReflectedReferenceSchema` alone.
Used in:
string name = 1
Name of the reference the mutation is targeting.
optional description = 2
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
optional deprecationNotice = 3
Deprecation notice contains information about planned removal of this schema from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes.
GrpcCardinality cardinality = 4
Cardinality describes the expected count of relations of this type. In evitaDB we define only one-way relationship from the perspective of the entity. We stick to the ERD modelling [standards](https://www.gleek.io/blog/crows-foot-notation.html) here. Cardinality affect the design of the client API (returning only single reference or collections) and also help us to protect the consistency of the data so that conforms to the creator mental model.
string referencedEntityType = 5
Reference to `EntitySchema.name` of the referenced entity. Might be also any `String` that identifies type some external resource not maintained by Evita.
string reflectedReferenceName = 6
Name of the reflected reference of the target referencedEntityType(). The referenced entity must contain reference of such name and this reference must target the entity where the reflected reference is defined, and the target entity must be managed on both sides of the relation.
optional faceted = 7
Whether the statistics data for this reference should be maintained and this allowing to get `referenceSummary` for this reference or use `facetInSet` filtering query. Do not mark reference as faceted unless you want it among `FacetStatistics`. Each faceted reference occupies (memory/disk) space in the form of index. Reference that was marked as faceted is called Facet. Deprecated since 2024.12 - deprecated in favor of `facetedInScopes`
GrpcAttributeInheritanceBehavior attributeInheritanceBehavior = 8
Contains true if the attributes of the reflected reference are inherited from the target reference.
repeated string attributeInheritanceFilter = 9
The array of attribute names that are inherited / excluded from inheritance based on the value of attributeInheritanceBehavior property.
bool indexedInherited = 10
when set to true, the value of `indexedInScope` field is ignored and the settings are inherited from the original reference.
repeated GrpcEntityScope indexedInScopes = 11
Whether the index for this reference should be created and maintained allowing to filter by `referenceHaving` filtering constraints. Index is also required when reference is `faceted`. Do not mark reference as faceted unless you know that you'll need to filter/sort entities by this reference. Each indexed reference occupies (memory/disk) space in the form of index. When reference is not indexed, the entity cannot be looked up by reference attributes or relation existence itself, but the data is loaded alongside other references if requested. Deprecated since 2025.6 - deprecated in favor of `scopedIndexTypes`
bool facetedInherited = 12
when set to true, the value of `facetedInScope` field is ignored and the settings are inherited from the original reference.
repeated GrpcEntityScope facetedInScopes = 13
Whether the statistics data for this reference should be maintained and this allowing to get `referenceSummary` for this reference or use `facetInSet` filtering query. Do not mark reference as faceted unless you want it among `FacetStatistics`. Each faceted reference occupies (memory/disk) space in the form of index. Reference that was marked as faceted is called Facet.
repeated scopedIndexTypes = 14
Scoped reference index types that define both the scope and the type of index for the reference. This replaces the deprecated `indexedInScopes` field with more granular control over indexing. When `indexedInherited` is true, this field is ignored.
repeated scopedIndexedComponents = 15
Scoped reference indexed components that specify which parts of a reference relationship (referenced entity, referenced group entity) are indexed per scope. When `indexedInherited` is true, this field is ignored.
repeated facetedPartially = 16
Per-scope expressions that narrow which entities participate in faceting.
repeated bucketedInScopes = 17
Per-scope bucketed histogram configurations defining index name and value expression.
repeated bucketedPartiallyInScopes = 18
Per-scope expressions that narrow which entities participate in bucketed histogram computation.
Mutation is responsible for setting up a new `SortableAttributeCompoundSchema` in the `EntitySchema`. Mutation can be used for altering also the existing `SortableAttributeCompoundSchema` alone.
Used in: ,
string name = 1
Name of the sortable attribute compound the mutation is targeting.
optional description = 2
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
optional deprecationNotice = 3
Deprecation notice contains information about planned removal of this sortable attribute compound from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes.
repeated attributeElements = 4
Defines list of individual elements forming this compound.
repeated GrpcEntityScope indexedInScopes = 5
When attribute sortable compound is indexed, it is possible to sort entities by this calculated attribute compound. This property contains set of all scopes this attribute compound is indexed in.
message
GrpcEvitaDataTypes.proto:80Structure for representing Currency objects specified by currency code.
Used in: , , , , , , , ,
string code = 1
ISO 4217 three-letter currency code (e.g. `USD`, `EUR`), resolved via `Currency#getInstance(String)`.
message
GrpcEvitaDataTypes.proto:204Wrapper for representing an array of Currencies.
Used in: ,
repeated value = 1
The individual Currency elements, in their original order.
message
GrpcEvitaSessionAPI.proto:438A page or strip of entities, in one of three representations (references, full sealed entities, or binary entities) depending on what the query's `require` block asked for. Only one representation is populated per response and only one of the two pagination descriptors below is set, matching whichever paging requirement (`page()`/`strip()`) the query used.
Used in:
repeated entityReferences = 1
Entity references (type + primary key only, no content). Populated when the query's `require` block has no `entityFetch` requirement; `sealedEntities`/`binaryEntities` are then both empty.
repeated sealedEntities = 2
Fully fetched entities in structured (non-binary) form. Populated when `require` has an `entityFetch` requirement and the session is not using the binary storage format; `entityReferences`/`binaryEntities` are then both empty.
repeated binaryEntities = 3
Fully fetched entities in the server's binary storage format, for clients that decode entities themselves. Populated when `require` has an `entityFetch` requirement and the session uses the binary storage format; `entityReferences`/`sealedEntities` are then both empty.
oneof chunk
Exactly one of these is set, matching which paging requirement (`page()`/`strip()`) the query used.
paginatedList = 4
Set when the query used page-based paging (`page()`).
stripList = 5
Set when the query used strip/offset-based paging (`strip()`).
int32 totalRecordCount = 6
Total number of records matching the query across all pages/strips, not just this chunk's size.
bool isFirst = 7
True if this chunk is the first page/strip of the result set.
bool isLast = 8
True if this chunk is the last page/strip of the result set.
bool hasPrevious = 9
True if a preceding page/strip exists.
bool hasNext = 10
True if a following page/strip exists.
bool isSinglePage = 11
True if the entire result set fits within this single chunk.
bool isEmpty = 12
True if this chunk (and the entire result set) contains no records.
message
GrpcEvitaDataTypes.proto:390Structure that holds one node of a complex (structured) associated data value's recursive tree. A node is either a leaf primitive value, an array of child nodes, or a map of named child nodes.
Used in: , ,
oneof value
Exactly one of these is set, identifying which kind of node this is.
primitiveValue = 1
Leaf node: the primitive value at this position of the tree (evitaDB `DataItemValue`).
arrayValue = 4
Array node: the ordered child nodes at this position of the tree (evitaDB `DataItemArray`).
mapValue = 5
Map node: the named child nodes at this position of the tree (evitaDB `DataItemMap`).
message
GrpcEvitaDataTypes.proto:403Structure that holds an array-typed node of a complex associated data value's tree.
Used in:
repeated children = 1
The ordered child nodes of this array node, in their original order.
message
GrpcEvitaDataTypes.proto:54Representation of DateTimeRange structures. At least one of `from`/`to` should be set; if both are absent, the range decodes to a degenerate range anchored at the Unix epoch (1970-01-01T00:00:00Z) rather than being unbounded in both directions.
Used in: , , , , ,
optional from = 1
The inclusive lower bound (start) of the range. If unset (while `to` is set), the range is unbounded below (open start).
optional to = 2
The inclusive upper bound (end) of the range. If unset (while `from` is set), the range is unbounded above (open end).
message
GrpcEvitaDataTypes.proto:162Wrapper for representing an array of DateTimeRanges.
Used in: ,
repeated value = 1
The individual DateTimeRange elements, in their original order.
message
GrpcEvitaAPI.proto:198Request to deactivate a catalog.
Used as request type in: EvitaService.DeactivateCatalog, EvitaService.DeactivateCatalogWithProgress
string catalogName = 1
Name of the catalog to deactivate.
message
GrpcEvitaSessionAPI.proto:735Request for deleting a single entity by primary key and returning it fetched in the richness described by `require` before deletion.
Used as request type in: EvitaSessionService.DeleteEntity, EvitaSessionService.DeleteEntityAndItsHierarchy
string entityType = 1
Entity type (collection name) the entity to delete belongs to.
optional primaryKey = 2
Primary key of the entity to delete. Effectively mandatory despite the wrapper type: the server reads its value directly without checking presence, so an unset value is treated identically to an explicit `0` rather than as "no primary key" - always set this field explicitly.
string require = 3
The string part of a parametrised `require` query fragment describing how richly to fetch the entity back before it is deleted. `?`/`@name` placeholders are bound the same way as `positionalQueryParams`/`namedQueryParams` on `GrpcEntityRequest` - see there for the full binding contract.
repeated positionalQueryParams = 4
Values for the `?` positional placeholders in `require`, bound in encounter order (FIFO) - see `GrpcEntityRequest.positionalQueryParams` for the full binding contract.
map<string, > namedQueryParams = 5
Values for the `@name` named placeholders in `require`, keyed by name (without the `@` prefix) - see `GrpcEntityRequest.namedQueryParams` for the full binding contract.
Mutation is responsible for removing one or more currencies from a `EntitySchema.currencies` in `EntitySchema`.
Used in:
repeated currencies = 1
Set of all currencies that can't be used for prices in entities of this type.
Mutation is responsible for removing one or more modes from a `CatalogSchema.evolutionMode` in `CatalogSchema`.
Used in:
repeated GrpcCatalogEvolutionMode evolutionModes = 1
Set of forbidden evolution modes. These allow to specify how strict is evitaDB when unknown information is presented to her for the first time. When no evolution mode is set, each violation of the `CatalogSchema` is reported by an error. This behaviour can be changed by this evolution mode, however.
Mutation is responsible for removing one or more modes from a `EntitySchema.evolutionMode` in `EntitySchema`.
Used in:
repeated GrpcEvolutionMode evolutionModes = 1
Set of forbidden evolution modes. These allow to specify how strict is evitaDB when unknown information is presented to her for the first time. When no evolution mode is set, each violation of the `EntitySchema` is reported by an error. This behaviour can be changed by this evolution mode, however.
Mutation is responsible for removing one or more locales from a `EntitySchema.locales` in `EntitySchema`.
Used in:
repeated locales = 1
Set of all locales that can't be used for localized `AttributeSchema` or `AssociatedDataSchema`.
message
GrpcEngineMutation.proto:66Mutation that duplicates a catalog with a new name, copying all contents from the source catalog.
Used in:
string catalogName = 1
Name of the source catalog to duplicate.
string newCatalogName = 2
Name of the new catalog to create with duplicated contents.
message
GrpcEvitaAPI.proto:172Request to duplicate a catalog.
Used as request type in: EvitaService.DuplicateCatalog, EvitaService.DuplicateCatalogWithProgress
string catalogName = 1
Name of the source catalog to duplicate.
string newCatalogName = 2
Name of the new catalog to create with duplicated contents.
The enumeration controls HierarchyOfReference behaviour whether the hierarchical nodes that are not referred by any of the queried entities should be part of the result hierarchy statistics tree.
Used in: ,
LEAVE_EMPTY = 0
The hierarchy nodes that are not referred by any of the queried entities will be part of the result hierarchy
REMOVE_EMPTY = 1
The hierarchy nodes that are not referred by any of the queried entities will be removed from the result hierarchy
message
GrpcEvitaDataTypes.proto:246Wrapper for representing an array of EmptyHierarchicalEntityBehaviour enums.
Used in:
repeated GrpcEmptyHierarchicalEntityBehaviour value = 1
The individual EmptyHierarchicalEntityBehaviour values, in their original order.
message
GrpcEvitaManagementAPI.proto:72A named endpoint exposed by an external API, distinct from the API's own base URL(s) (see `GrpcApiStatus.endpoints`).
Used in:
string name = 1
Logical name identifying what the endpoint serves. For the system API - currently the only API that populates `GrpcApiStatus.endpoints` - this is one of `serverNameUrl`, `serverCertificateUrl`, `clientCertificateUrl`, `clientPrivateKeyUrl`.
repeated string url = 2
Absolute URL(s) the endpoint is reachable on - one per configured host binding, so this commonly holds more than one URL even though the field name is singular.
message
GrpcEngineMutation.proto:105This structure encapsulates all mutations that needs to be executed on entire evitaDB level and not locally to single catalog schema instance.
Used in: ,
oneof mutation
The top level catalog schema mutation to be executed.
createCatalogSchemaMutation = 1
Mutation is responsible for setting up a new CatalogSchema.
modifyCatalogSchemaNameMutation = 2
Mutation is responsible for renaming an existing CatalogSchema.
modifyCatalogSchemaMutation = 3
Mutation is responsible for renaming an existing CatalogSchema.
makeCatalogAliveMutation = 4
Mutation that transitions a catalog to the "live" state, making it transactional.
removeCatalogSchemaMutation = 5
Mutation is responsible for removing an existing CatalogSchema.
transactionMutation = 6
Mutation delimits one transaction from another.
setCatalogMutabilityMutation = 7
Mutation that sets the mutability state of a catalog.
duplicateCatalogMutation = 8
Mutation that duplicates a catalog with a new name, copying all contents from the source catalog.
setCatalogStateMutation = 9
Mutation that sets the active state of a catalog.
restoreCatalogSchemaMutation = 10
Mutation is responsible for restoring a CatalogSchema in INACTIVE state.
markCatalogMissingMutation = 11
Mutation that records the fact a catalog's on-disk folder is no longer present.
upgradeCatalogFormatMutation = 12
Mutation that upgrades a catalog's on-disk storage protocol to the engine's current version.
message
GrpcEvitaSessionAPI.proto:259Structure that holds changes in a specific entity collection within a transaction.
Used in:
string entityName = 1
The name (entity type) of the entity collection these counts apply to.
int32 schemaChanges = 2
The number of schema altering mutations.
int32 upserted = 3
The number of upsert entity mutations.
int32 removed = 4
The number of entity removal mutations.
message
GrpcEvitaDataTypes.proto:516Aggregates basic data about the entity collection.
Used in:
string entityType = 1
name of the entity collection
int32 totalRecords = 2
total number of records in the entity collection
int32 indexCount = 3
total number of indexes in the entity collection
int64 sizeOnDiskInBytes = 4
total size of the entity collection on disk in bytes
Contains set of all possible expected states for the entity.
Used in:
MAY_EXIST = 0
Entity may or may not exist.
MUST_NOT_EXIST = 1
Entity must not exist.
MUST_EXIST = 2
Entity must exist.
message
GrpcEntityMutation.proto:36Represents a mutation to be performed on the evitaDB that relates to an entity.
Used as request type in: EvitaSessionService.ApplyMutation
Used as field type in: , ,
oneof mutation
The mutation to be performed.
entityUpsertMutation = 1
Represents a terminal mutation that wraps a list of mutation that are to be performed on an entity.
entityRemoveMutation = 2
Represents a terminal mutation when existing entity is removed in the evitaDB. The entity with all its internal data are deleted.
message
GrpcEntity.proto:16This type represents a reference to any Evita entity and that is returned by default for all queries that don't require loading additional data.
Used in: , , , , , , , , , , , ,
string entityType = 1
Type of entity. Entity type is main sharding key - all data of entities with same type are stored in separated collections. Within the entity type entity is uniquely represented by primary key.
int32 primaryKey = 2
Unique Integer positive number representing the entity. Can be used for fast lookup for entity (entities). Primary key must be unique within the same entity type.
int32 version = 3
Deprecated since 2024.10 - value is deprecated, it was available only for entity references used in entity body, in other use-cases it was left as zero - which was a mistake in the design. in order to get the entity version you need to fetch the entity itself (with entity body).
optional referenceVersion = 4
Contains version of this reference and gets increased with any entity type update. Allows to execute optimistic locking i.e. avoiding parallel modifications.
message
GrpcEntity.proto:65Extended entity reference that maintains a mapping of reassigned primary keys for entity references. This type is used during entity mutations when references need to be tracked with their newly assigned internal primary keys after persistence. When references are first created, they are assigned temporary negative internal primary keys. Upon persistence to the database, these temporary keys are replaced with positive permanent internal primary keys assigned by the server. This message maintains the mapping between the original reference keys (with temporary internal PKs) and the reference keys with their newly assigned permanent internal PKs. This is particularly useful when: - Multiple references share the same business key but differ in properties - Client code needs to track which references were assigned which internal primary keys after persistence - References need to be looked up by their original temporary keys to find their permanent counterparts
Used in:
string entityType = 1
Type of entity. Entity type is main sharding key - all data of entities with same type are stored in separated collections. Within the entity type entity is uniquely represented by primary key.
int32 primaryKey = 2
Unique Integer positive number representing the entity. Can be used for fast lookup for entity (entities). Primary key must be unique within the same entity type.
repeated reassignedReferenceKeys = 3
Mapping from original reference keys (with temporary internal PK) to the new reference keys with permanent internal PK assigned by the server after persistence. The map key is the original reference key, and the value is the reassigned reference key.
message
GrpcEntity.proto:34Entity reference which contains information about parent entity.
Used in:
string entityType = 1
Type of entity. Entity type is main sharding key - all data of entities with same type are stored in separated collections. Within the entity type entity is uniquely represented by primary key.
int32 primaryKey = 2
Unique Integer positive number representing the entity. Can be used for fast lookup for entity (entities). Primary key must be unique within the same entity type.
int32 version = 3
Contains version of this entity and gets increased with any entity type update. Allows to execute optimistic locking i.e. avoiding parallel modifications. Deprecated since 2024.10 - value is deprecated, it was never available in the first place - it was a mistake in the design. in order to get the entity version you need to fetch the entity itself (with entity body).
optional parent = 4
Recursive pointer to parent entity.
message
GrpcEntityMutation.proto:28Represents a terminal mutation when existing entity is removed in the evitaDB. The entity is and all its internal data are deleted.
Used in:
string entityType = 1
The type of the entity to be removed.
int32 entityPrimaryKey = 2
The primary key of the entity to be removed.
message
GrpcEntitySchema.proto:23This is the definition object for entity. Definition objects allow to describe the structure of the entity type so that in any time everyone can consult complete structure of the entity type. Based on our experience we've designed following data model for handling entities in evitaDB. Model is rather complex but was designed to limit amount of data fetched from database and minimize an amount of data that are indexed and subject to search. Minimal entity definition consists of: - entity type and - primary key (even this is optional and may be autogenerated by the database). Other entity data is purely optional and may not be used at all.
Used in: , ,
string name = 1
Contains unique name of the model. Case-sensitive. Distinguishes one model item from another within single entity instance.
int32 version = 2
Contains version of this entity schema and gets increased with any entity type update. Allows to execute optimistic locking i.e. avoiding parallel modifications.
optional description = 3
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
optional deprecationNotice = 4
Deprecation notice contains information about planned removal of this entity from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes. If notice is `null`, this schema is considered not deprecated.
bool withGeneratedPrimaryKey = 5
Contains `true` when primary keys of entities of this type will not be provided by the external systems and Evita is responsible for generating unique primary keys for the entity on insertion. Generated key is guaranteed to be unique, but may not represent continuous ascending series. Generated key will be always greater than zero.
bool withHierarchy = 6
Contains `true` when entities of this type are organized in a tree like structure (hierarchy) where certain entities are subordinate of other entities. Entities may be organized in hierarchical fashion. That means that entity may refer to single parent entity and may be referred by multiple child entities. Hierarchy is always composed of entities of same type. Each entity must be part of at most single hierarchy (tree). Hierarchy can limit returned entities by using filtering constraints. It's also used for computation of extra data - such as the `parents` requirement. It can also invert type of returned entities in case extra result `hierarchyOfSelf` is requested.
bool withPrice = 7
Contains `true` when entities of this type holds price information. Prices are specific to a very few entities, but because correct price computation is very complex in e-commerce systems and highly affects performance of the entities filtering and sorting, they deserve first class support in entity model. It is pretty common in B2B systems single product has assigned dozens of prices for the different customers. Specifying prices on entity allows usage of `priceValidIn`, `priceInCurrency` `priceBetween`, and `priceInPriceLists` filtering constraints and also `priceNatural`, ordering of the entities. Additional extra result `priceHistogram` and requirement `priceType` can be used in query as well.
int32 indexedPricePlaces = 8
Determines how many fractional places are important when entities are compared during filtering or sorting. It is important to know that all prices will be converted to `Int`, so any of the price values (either with or without tax) must not ever exceed maximum limits of `Int` type when scaling the number by the power of ten using `indexedPricePlaces` as exponent.
repeated locales = 9
Contains set of all `Locale` that could be used for localized `AttributeSchema` or `AssociatedDataSchema`. Enables using `entityLocaleEquals` filtering constraint in query.
repeated currencies = 10
Contains set of all `Currency` that could be used for `prices` in entities of this type.
map<string, > attributes = 11
Contains index of all `AttributeSchema` that could be used as attributes of entity of this type. Entity (global) attributes allows defining set of data that are fetched in bulk along with the entity body. Attributes may be indexed for fast filtering (`AttributeSchema.filterable`) or can be used to sort along (`AttributeSchema.sortable`). Attributes are not automatically indexed in order not to waste precious memory space for data that will never be used in search queries. Filtering in attributes is executed by using constraints like `and`, `not`, `attributeEquals`, `attributeContains` and many others. Sorting can be achieved with `attributeNatural` or others. Attributes are not recommended for bigger data as they are all loaded at once requested. Large data that are occasionally used store in `associatedData`.
map<string, > associatedData = 12
Contains index of all `AssociatedDataSchema` that could be used as associated data of entity of this type. Associated data carry additional data entries that are never used for filtering / sorting but may be needed to be fetched along with entity in order to present data to the target consumer (i.e. user / API / bot). Associated data may be stored in slower storage and may contain wide range of data types - from small ones (i.e. numbers, strings, dates) up to large binary arrays representing entire files (i.e. pictures, documents). The search query must contain specific associated data fields in order associated data are fetched along with the entity. Associated data are stored and fetched separately by their name.
map<string, > references = 13
Contains index of all `ReferenceSchema` that could be used as references of entity of this type. References refer to other entities (of same or different entity type). Allows entity filtering (but not sorting) of the entities by using `facetInSet` constraint and statistics computation when `facetStatistics` extra result is requested. Reference is uniquely represented by int positive number (max. (2^63)-1) and entity type and can be part of multiple reference groups, that are also represented by int and entity type. Reference id in one entity is unique and belongs to single reference group id. Among multiple entities reference may be part of different reference groups. Referenced entity type may represent type of another Evita entity or may refer to anything unknown to Evita that posses unique int key and is maintained by external systems (fe. tag assignment, group assignment, category assignment, stock assignment and so on). Not all these data needs to be present in Evita. References may carry additional key-value data linked to this entity relation (fe. item count present on certain stock). The search query must contain specific `referenceContent` requirement in order references are fetched along with the entity.
repeated GrpcEvolutionMode evolutionMode = 14
Evolution mode allows to specify how strict is evitaDB when unknown information is presented to her for the first time. When no evolution mode is set, each violation of the `EntitySchema` is reported by an exception. This behaviour can be changed by this evolution mode however.
map<string, > sortableAttributeCompounds = 15
Contains index of definitions of all sortable attribute compounds defined in this schema.
repeated nameVariant = 16
Contains entity type converted to different naming conventions.
repeated GrpcEntityScope hierarchyIndexedInScopes = 17
Contains set of all scopes the entity is indexed in and can be used for filtering entities and computation of extra data. If the hierarchy information is not indexed, it is still available on the entity itself (i.e. entity can define its parent entity), but it is not possible to work with the hierarchy information in any other way (calculating parent chain, children, siblings, etc.).
repeated GrpcEntityScope priceIndexedInScopes = 18
Contains set of all scopes the price information is indexed in and can be used for filtering entities and computation of extra data. If the price information is not indexed, it is still available on the entity itself (i.e. entity can define its price), but it is not possible to work with the price information in any other way (calculating price histogram, filtering, sorting by price, etc.). Prices can be also set as non-indexed individually via the individual price's own `indexed` flag.
int64 catalogSchemaVersion = 19
Contains current version of the catalog schema this entity schema belongs to.
optional conflictResolution = 20
Contains the entity-level conflict resolution setting. When not set (absent), the entity schema inherits the resolved conflict resolution from the catalog / transaction options.
Contains all possible entity schema mutations.
Used in: , ,
oneof mutation
The mutation to be executed.
createAssociatedDataSchemaMutation = 1
Mutation is responsible for setting up a new `AssociatedDataSchema` in the `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
modifyAssociatedDataSchemaDeprecationNoticeMutation = 2
Mutation is responsible for setting value to a `AssociatedDataSchemaContract.deprecationNotice` in `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
modifyAssociatedDataSchemaDescriptionMutation = 3
Mutation is responsible for setting value to a `AssociatedDataSchema.description` in `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
modifyAssociatedDataSchemaNameMutation = 4
Mutation is responsible for renaming an existing `AssociatedDataSchema` in `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
modifyAssociatedDataSchemaTypeMutation = 5
Mutation is responsible for setting value to a `AssociatedDataSchema.type` in `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
removeAssociatedDataSchemaMutation = 6
Mutation is responsible for removing an existing `AssociatedDataSchema` in the `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
setAssociatedDataSchemaLocalizedMutation = 7
Mutation is responsible for setting value to a `AssociatedDataSchema.localized` in `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
setAssociatedDataSchemaNullableMutation = 8
Mutation is responsible for setting value to a `AssociatedDataSchema.nullable` in `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
setAssociatedDataSchemaConflictResolutionOverrideMutation = 9
Mutation is responsible for setting value to a `AssociatedDataSchema.conflictResolutionOverride` in `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
createAttributeSchemaMutation = 20
Mutation is responsible for setting up a new `AttributeSchema` in the `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` alone.
modifyAttributeSchemaDefaultValueMutation = 21
Mutation is responsible for setting value to a `AttributeSchema.defaultValue` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
modifyAttributeSchemaDeprecationNoticeMutation = 22
Mutation is responsible for setting value to a `AttributeSchema.deprecationNotice` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
modifyAttributeSchemaDescriptionMutation = 23
Mutation is responsible for setting value to a `AttributeSchema.description` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
modifyAttributeSchemaNameMutation = 24
Mutation is responsible for renaming an existing `AttributeSchema` in `EntitySchema` or `GlobalAttributeSchema` in `CatalogSchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
modifyAttributeSchemaTypeMutation = 25
Mutation is responsible for setting value to a `AttributeSchema.type` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
removeAttributeSchemaMutation = 26
Mutation is responsible for removing an existing `AttributeSchema` in the `EntitySchema` or `GlobalAttributeSchema` in the `CatalogSchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
setAttributeSchemaFilterableMutation = 27
Mutation is responsible for setting value to a `AttributeSchema.filterable` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
setAttributeSchemaLocalizedMutation = 28
Mutation is responsible for setting value to a `AttributeSchema.localized` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
setAttributeSchemaNullableMutation = 29
Mutation is responsible for setting value to a `AttributeSchema.nullable` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
setAttributeSchemaRepresentativeMutation = 30
Mutation is responsible for setting value to a `AttributeSchema.representative` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
setAttributeSchemaSortableMutation = 31
Mutation is responsible for setting value to a `AttributeSchema.sortable` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
setAttributeSchemaUniqueMutation = 32
Mutation is responsible for setting value to a `AttributeSchema.unique` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
useGlobalAttributeSchemaMutation = 33
Mutation is responsible for introducing a `GlobalAttributeSchema` into an `EvitaSession`.
setAttributeSchemaConflictResolutionOverrideMutation = 34
Mutation is responsible for setting value `AttributeSchema.conflictResolutionOverride` in `EntitySchema`.
allowCurrencyInEntitySchemaMutation = 50
Mutation is responsible for adding one or more currencies to a `EntitySchema.currencies` in `EntitySchema`.
allowEvolutionModeInEntitySchemaMutation = 51
Mutation is responsible for adding one or more modes to a `EntitySchema.evolutionMode` in `EntitySchema`.
allowLocaleInEntitySchemaMutation = 52
Mutation is responsible for adding one or more locales to a `EntitySchema.locales` in `EntitySchema`.
disallowCurrencyInEntitySchemaMutation = 53
Mutation is responsible for removing one or more currencies from a `EntitySchema.currencies` in `EntitySchema`.
disallowEvolutionModeInEntitySchemaMutation = 54
Mutation is responsible for removing one or more modes from a `EntitySchema.evolutionMode` in `EntitySchema`.
disallowLocaleInEntitySchemaMutation = 55
Mutation is responsible for removing one or more locales to a `EntitySchema.locales` in `EntitySchema`.
modifyEntitySchemaDeprecationNoticeMutation = 56
Mutation is responsible for setting a `EntitySchema.deprecationNotice` in `EntitySchema`.
modifyEntitySchemaDescriptionMutation = 57
Mutation is responsible for setting a `EntitySchema.description` in `EntitySchema`.
setEntitySchemaWithGeneratedPrimaryKeyMutation = 58
Mutation is responsible for setting a `EntitySchema.withGeneratedPrimaryKey` in `EntitySchema`.
setEntitySchemaWithHierarchyMutation = 59
Mutation is responsible for setting a `EntitySchema.withHierarchy` in `EntitySchema`.
setEntitySchemaWithPriceMutation = 60
Mutation is responsible for setting a `EntitySchema.withPrice` in `EntitySchema`.
modifyEntitySchemaNameMutation = 61
Mutation is responsible for renaming or replacing a `EntitySchema`.
removeEntitySchemaMutation = 62
Mutation is responsible for removing a `EntitySchema` - i.e. entity collection.
createEntitySchemaMutation = 63
Mutation is responsible for setting up a new `EntitySchema` in the `CatalogSchema`.
modifyEntitySchemaMutation = 64
Mutation is responsible for modifying existing `EntitySchema` in the `CatalogSchema`.
modifyEntitySchemaConflictResolutionMutation = 65
Mutation is responsible for setting value to a `EntitySchema.conflictResolution` in `EntitySchema`.
createReferenceSchemaMutation = 80
Mutation is responsible for setting up a new `ReferenceSchema` in the `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
modifyReferenceAttributeSchemaMutation = 81
Mutation is a holder for a single `AttributeSchema` that affect any of `ReferenceSchema.attributes` in the `EntitySchema`.
modifyReferenceSchemaCardinalityMutation = 82
Mutation is responsible for setting value to a `ReferenceSchema.cardinality` in `EntitySchema`.
modifyReferenceSchemaDeprecationNoticeMutation = 83
Mutation is responsible for setting value to a `ReferenceSchema.deprecationNotice` in `EntitySchema`.
modifyReferenceSchemaDescriptionMutation = 84
Mutation is responsible for setting value to a `ReferenceSchema.description` in `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
modifyReferenceSchemaNameMutation = 85
Mutation is responsible for renaming an existing `ReferenceSchema` in `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
modifyReferenceSchemaRelatedEntityGroupMutation = 86
Mutation is responsible for setting value to a `ReferenceSchema.referencedGroupType` in `EntitySchema`.
modifyReferenceSchemaRelatedEntityMutation = 87
Mutation is responsible for setting value to a `ReferenceSchema.referencedEntityType` in `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
removeReferenceSchemaMutation = 88
Mutation is responsible for removing an existing `ReferenceSchema` in the `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
setReferenceSchemaFacetedMutation = 89
Mutation is responsible for setting value to a `ReferenceSchema.faceted` in `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
setReferenceSchemaIndexedMutation = 90
Mutation is responsible for setting value to a `ReferenceSchema.indexed` in `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
createReflectedReferenceSchemaMutation = 91
Mutation is responsible for setting up a new `ReflectedReferenceSchema` in the `EntitySchema`. Mutation can be used for altering also the existing `ReflectedReferenceSchema` alone.
modifyReflectedReferenceAttributeInheritanceSchemaMutation = 92
Mutation is responsible for setting value to a `ReflectedReferenceSchema.attributesInherited` and `ReflectedReferenceSchema.attributesExcludedFromInheritance` in `ReferenceSchema`. Mutation can be used for altering also the existing `ReferenceSchemaContract` alone.
ModifyReferenceSortableAttributeCompoundSchemaMutation = 93
Mutation is a holder for a single `SortableAttributeCompoundSchema` that affect any of `ReferenceSchema.sortableAttributeCompound` in the `EntitySchema`.
setReferenceSchemaBucketedMutation = 94
Mutation is responsible for setting bucketed histogram configuration on a `ReferenceSchema` in `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
setReferenceSchemaConflictResolutionOverrideMutation = 95
Mutation is responsible for setting value to a `ReferenceSchema.conflictResolutionOverride` in `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
createSortableAttributeCompoundSchemaMutation = 120
Mutation is responsible for setting up a new `SortableAttributeCompoundSchema` in the `EntitySchema`. Mutation can be used for altering also the existing `SortableAttributeCompoundSchema` alone.
modifySortableAttributeCompoundSchemaDeprecationNoticeMutation = 121
Mutation is responsible for setting value to a `SortableAttributeCompoundSchema.deprecationNotice` in `EntitySchema` or `ReferenceSchema`.
modifySortableAttributeCompoundSchemaDescriptionMutation = 122
Mutation is responsible for setting value to a `SortableAttributeCompoundSchema.description` in `EntitySchema` or `ReferenceSchema`.
modifySortableAttributeCompoundSchemaNameMutation = 123
Mutation is responsible for renaming an existing `SortableAttributeCompoundSchema` in `EntitySchema` or `ReferenceSchema`.
removeSortableAttributeCompoundSchemaMutation = 124
Mutation is responsible for removing an existing `SortableAttributeCompound` in the `EntitySchema` or `ReferenceSchema`.
setSortableAttributeCompoundIndexedMutation = 125
Mutation is responsible for setting set of scopes for indexing value in a `SortableAttributeCompoundSchema` in `EntitySchema`.
Enum defines the possible scopes where the entities can reside.
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
SCOPE_LIVE = 0
Entities that are currently active and reside in the live data set block.
SCOPE_ARCHIVED = 1
Entities that are no longer active and reside in the archive block.
message
GrpcEvitaDataTypes.proto:270Wrapper for representing an array of Scope enums.
Used in:
repeated GrpcEntityScope value = 1
The individual Scope values, in their original order.
message
GrpcEntityMutation.proto:12Represents a terminal mutation that wraps a list of mutation that are to be performed on an entity.
Used in:
string entityType = 1
The type of the entity to be mutated.
optional entityPrimaryKey = 2
The primary key of the entity to be mutated.
GrpcEntityExistence entityExistence = 3
Controls behaviour of the upsert operation. - MUST_NOT_EXIST: use when you know you'll be inserting a new value - MUST_EXIST: use when you know you'll be updating an existing value - MAY_EXIST: use when you're not sure
repeated mutations = 4
List of all local mutations that modify internal data of the entity.
message
GrpcEnums.proto:410This enum contains all supported data types of AssociatedData.
(message has no fields)
Enumerates the value types evitaDB supports for associated data (both scalar and array variants) - a subset of the general query data types plus `ComplexDataObject` for arbitrary nested structures.
Used in: , , ,
STRING = 0
Represents string data type.
BYTE = 1
Represents byte data type.
SHORT = 2
Represents short data type.
INTEGER = 3
Represents integer data type.
LONG = 4
Represents long data type.
BOOLEAN = 5
Represents boolean data type.
CHARACTER = 6
Represents character data type.
BIG_DECIMAL = 7
Represents BigDecimal data type.
OFFSET_DATE_TIME = 8
Represents OffsetDateTime data type.
LOCAL_DATE_TIME = 9
Represents LocalDateTime data type.
LOCAL_DATE = 10
Represents LocalDate data type.
LOCAL_TIME = 11
Represents LocalTime data type.
DATE_TIME_RANGE = 12
Represents DateTimeRange data type.
BIG_DECIMAL_RANGE = 13
Represents BigDecimalNumberRange data type.
LONG_RANGE = 14
Represents LongNumberRange data type.
INTEGER_RANGE = 15
Represents IntegerNumberRange data type.
SHORT_RANGE = 16
Represents ShortNumberRange data type.
BYTE_RANGE = 17
Represents ByteNumberRange data type.
LOCALE = 18
Represents Locale data type.
CURRENCY = 19
Represents Currency data type.
UUID = 20
Represents UUID data type.
COMPLEX_DATA_OBJECT = 21
Represents ComplexDataObject data type.
STRING_ARRAY = 50
Represents string array data type.
BYTE_ARRAY = 51
Represents byte array data type.
SHORT_ARRAY = 52
Represents short array data type.
INTEGER_ARRAY = 53
Represents integer array data type.
LONG_ARRAY = 54
Represents long array data type.
BOOLEAN_ARRAY = 55
Represents boolean array data type.
CHARACTER_ARRAY = 56
Represents character array data type.
BIG_DECIMAL_ARRAY = 57
Represents BigDecimal array data type.
OFFSET_DATE_TIME_ARRAY = 58
Represents OffsetDateTime array data type.
LOCAL_DATE_TIME_ARRAY = 59
Represents LocalDateTime array data type.
LOCAL_DATE_ARRAY = 60
Represents LocalDate array data type.
LOCAL_TIME_ARRAY = 61
Represents LocalTime array data type.
DATE_TIME_RANGE_ARRAY = 62
Represents DateTimeRange array data type.
BIG_DECIMAL_RANGE_ARRAY = 63
Represents BigDecimalNumberRange array data type.
LONG_RANGE_ARRAY = 64
Represents LongNumberRange array data type.
INTEGER_RANGE_ARRAY = 65
Represents IntegerNumberRange array data type.
SHORT_RANGE_ARRAY = 66
Represents ShortNumberRange array data type.
BYTE_RANGE_ARRAY = 67
Represents ByteNumberRange array data type.
LOCALE_ARRAY = 68
Represents Locale array data type.
CURRENCY_ARRAY = 69
Represents Currency array data type.
UUID_ARRAY = 70
Represents UUID array data type.
message
GrpcEvitaDataTypes.proto:363Structure that holds a single associated-data value, which is either one of the primitive/array Evita data types (wrapped by `GrpcEvitaValue`) or a complex (structured) object.
Used in: , ,
oneof value
Exactly one of these fields is set, identifying how the associated data value is encoded.
primitiveValue = 1
A primitive or array Evita value (see `GrpcEvitaValue`), used whenever the associated data is not a complex/structured object.
string jsonValue = 2
JSON-encoded `ComplexDataObject` value. Deprecated since 2025.4 - deprecated in favor of `root`: this legacy JSON encoding loses precise data type information. TOBEDONE #538: remove once no client older than 2025.4 remains in use (https://github.com/FgForrest/evitaDB/issues/538)
root = 4
The root node of a complex (structured) object's tree, recursively described by `GrpcDataItem`. Used as the modern replacement for the deprecated `jsonValue` encoding.
GrpcEvitaAssociatedDataDataType.GrpcEvitaDataType type = 100
The concrete Evita data type of the stored value, including `COMPLEX_DATA_OBJECT` when the value is a structured object described via `root` (or the deprecated `jsonValue`).
optional version = 3
Version of this associated data value; increases on every update to enable optimistic locking (concurrent-modification detection). May be null if this value is nested within a larger complex object.
This enum contains all supported types in evitaDB query context.
Used in: , , , , ,
STRING = 0
Represents string data type.
BYTE = 1
Represents byte data type.
SHORT = 2
Represents short data type.
INTEGER = 3
Represents integer data type.
LONG = 4
Represents long data type.
BOOLEAN = 5
Represents boolean data type.
CHARACTER = 6
Represents character data type.
BIG_DECIMAL = 7
Represents BigDecimal data type.
OFFSET_DATE_TIME = 8
Represents OffsetDateTime data type.
LOCAL_DATE_TIME = 9
Represents LocalDateTime data type.
LOCAL_DATE = 10
Represents LocalDate data type.
LOCAL_TIME = 11
Represents LocalTime data type.
DATE_TIME_RANGE = 12
Represents DateTimeRange data type.
BIG_DECIMAL_NUMBER_RANGE = 13
Represents BigDecimalNumberRange data type.
LONG_NUMBER_RANGE = 14
Represents LongNumberRange data type.
INTEGER_NUMBER_RANGE = 15
Represents IntegerNumberRange data type.
SHORT_NUMBER_RANGE = 16
Represents ShortNumberRange data type.
BYTE_NUMBER_RANGE = 17
Represents ByteNumberRange data type.
LOCALE = 18
Represents Locale data type.
CURRENCY = 19
Represents Currency data type.
UUID = 20
Represents UUID data type.
PREDECESSOR = 21
Represents Predecessor data type.
REFERENCED_ENTITY_PREDECESSOR = 22
Represents ReferencedEntityPredecessor data type.
STRING_ARRAY = 50
Represents string array data type.
BYTE_ARRAY = 51
Represents byte array data type.
SHORT_ARRAY = 52
Represents short array data type.
INTEGER_ARRAY = 53
Represents integer array data type.
LONG_ARRAY = 54
Represents long array data type.
BOOLEAN_ARRAY = 55
Represents boolean array data type.
CHARACTER_ARRAY = 56
Represents character array data type.
BIG_DECIMAL_ARRAY = 57
Represents BigDecimal array data type.
OFFSET_DATE_TIME_ARRAY = 58
Represents OffsetDateTime array data type.
LOCAL_DATE_TIME_ARRAY = 59
Represents LocalDateTime array data type.
LOCAL_DATE_ARRAY = 60
Represents LocalDate array data type.
LOCAL_TIME_ARRAY = 61
Represents LocalTime array data type.
DATE_TIME_RANGE_ARRAY = 62
Represents DateTimeRange array data type.
BIG_DECIMAL_NUMBER_RANGE_ARRAY = 63
Represents BigDecimalNumberRange array data type.
LONG_NUMBER_RANGE_ARRAY = 64
Represents LongNumberRange array data type.
INTEGER_NUMBER_RANGE_ARRAY = 65
Represents IntegerNumberRange array data type.
SHORT_NUMBER_RANGE_ARRAY = 66
Represents ShortNumberRange array data type.
BYTE_NUMBER_RANGE_ARRAY = 67
Represents ByteNumberRange array data type.
LOCALE_ARRAY = 68
Represents Locale array data type.
CURRENCY_ARRAY = 69
Represents Currency array data type.
UUID_ARRAY = 70
Represents UUID array data type.
message
GrpcEvitaAPI.proto:21Request to create a session inside of a catalog.
Used as request type in: EvitaService.CreateBinaryReadOnlySession, EvitaService.CreateBinaryReadWriteSession, EvitaService.CreateReadOnlySession, EvitaService.CreateReadWriteSession
string catalogName = 1
The name of the catalog for which the session is to be created.
GrpcCommitBehavior commitBehavior = 2
Default commit behaviour applied when the session is closed implicitly via `close()` - determines how far a transaction must be durably persisted before the close is considered complete. Can be overridden per call by closing the session explicitly with a specific behaviour instead. See `GrpcCommitBehavior` for the available durability/performance trade-offs.
bool dryRun = 3
For testing purposes. Flag indicating that all changes by the session should be rollbacked after the session is closed.
message
GrpcEvitaAPI.proto:34Response to a session creation request.
Used as response type in: EvitaService.CreateBinaryReadOnlySession, EvitaService.CreateBinaryReadWriteSession, EvitaService.CreateReadOnlySession, EvitaService.CreateReadWriteSession
string sessionId = 1
UUID of the created session.
GrpcSessionType sessionType = 2
Type of the created session - read-only vs. read-write, and whether fetched entities are returned in binary form for the Java driver (`BINARY_*` variants). See `GrpcSessionType`.
GrpcCommitBehavior commitBehaviour = 3
Effective commit behaviour of the created session, applied when the session is closed implicitly via `close()`. See `GrpcCommitBehavior` for the available durability/performance trade-offs.
GrpcCatalogState catalogState = 4
State of the catalog after the session was created.
string catalogId = 5
UUID of the catalog the session is bound to.
message
GrpcEvitaDataTypes.proto:277Structure that holds a single attribute/default-value value together with its declared Evita data type and optimistic-locking version.
Used in: , , , , , , , , , , ,
oneof value
The stored value in its wire representation; which Evita/Java type it actually represents is given by `type` below — several narrower Evita types share the same wire arm (see individual field comments). Exactly one of these fields is set when the value is non-null. When this `GrpcEvitaValue` represents an absent/null value (e.g. no default value defined for an attribute schema), none of these fields are set and `type` is left at its enum default (`STRING`), which callers must not interpret as an actual empty string value.
string stringValue = 1
String value (Java `String`). Also carries a `Character` value, as a single-character string, when `type` is `CHARACTER`.
int32 integerValue = 2
Integer value (Java `int`). Also carries `Byte` and `Short` values, widened to int32, when `type` is `BYTE` or `SHORT`.
int64 longValue = 3
Long value (Java `long`).
bool booleanValue = 4
Boolean value (Java `boolean`).
bigDecimalValue = 5
BigDecimal value (Java `BigDecimal`).
dateTimeRangeValue = 6
DateTimeRange value (evitaDB `DateTimeRange`).
integerNumberRangeValue = 7
IntegerNumberRange value (evitaDB `IntegerNumberRange`). Also carries `ByteNumberRange` and `ShortNumberRange` values when `type` is `BYTE_NUMBER_RANGE` or `SHORT_NUMBER_RANGE`.
longNumberRangeValue = 8
LongNumberRange value (evitaDB `LongNumberRange`).
bigDecimalNumberRangeValue = 9
BigDecimalNumberRange value (evitaDB `BigDecimalNumberRange`).
offsetDateTimeValue = 10
Date/time value (Java `OffsetDateTime`). Also carries `LocalDateTime`, `LocalDate` and `LocalTime` values when `type` is `LOCAL_DATE_TIME`, `LOCAL_DATE` or `LOCAL_TIME` respectively.
localeValue = 11
Locale value (Java `Locale`).
currencyValue = 12
Currency value (Java `Currency`).
uuidValue = 13
UUID value (Java `UUID`).
predecessorValue = 14
Predecessor value (evitaDB `Predecessor`). Also carries a `ReferencedEntityPredecessor` value when `type` is `REFERENCED_ENTITY_PREDECESSOR`.
stringArrayValue = 50
String array value (Java `String[]`). Also carries a `Character[]` value, each element a single-character string, when `type` is `CHARACTER_ARRAY`.
integerArrayValue = 51
Integer array value (Java `Integer[]`). Also carries `Byte[]` and `Short[]` values when `type` is `BYTE_ARRAY` or `SHORT_ARRAY`.
longArrayValue = 52
Long array value (Java `Long[]`).
booleanArrayValue = 53
Boolean array value (Java `Boolean[]`).
bigDecimalArrayValue = 54
BigDecimal array value (Java `BigDecimal[]`).
dateTimeRangeArrayValue = 55
DateTimeRange array value (evitaDB `DateTimeRange[]`).
integerNumberRangeArrayValue = 56
IntegerNumberRange array value (evitaDB `IntegerNumberRange[]`). Also carries `ByteNumberRange[]` and `ShortNumberRange[]` values when `type` is `BYTE_NUMBER_RANGE_ARRAY` or `SHORT_NUMBER_RANGE_ARRAY`.
longNumberRangeArrayValue = 57
LongNumberRange array value (evitaDB `LongNumberRange[]`).
bigDecimalNumberRangeArrayValue = 58
BigDecimalNumberRange array value (evitaDB `BigDecimalNumberRange[]`).
offsetDateTimeArrayValue = 59
Date/time array value (Java `OffsetDateTime[]`). Also carries `LocalDateTime[]`, `LocalDate[]` and `LocalTime[]` values when `type` is `LOCAL_DATE_TIME_ARRAY`, `LOCAL_DATE_ARRAY` or `LOCAL_TIME_ARRAY` respectively.
localeArrayValue = 60
Locale array value (Java `Locale[]`).
currencyArrayValue = 61
Currency array value (Java `Currency[]`).
uuidArrayValue = 62
UUID array value (Java `UUID[]`).
GrpcEvitaDataType type = 100
The concrete Evita/Java data type represented by the `value` oneof above (see each arm's comment for which narrower types it also stands in for).
optional version = 101
Contains version of this value and gets increased with any entity type update. Allows to execute optimistic locking i.e. avoiding parallel modifications. May be null if value is used within larger complex object.
Evolution mode allows to specify how strict is evitaDB when unknown information is presented to her for the first time. When no evolution mode is set, each violation of the EntitySchema is reported by an exception. However, this behaviour can be changed by this evolution mode.
Used in: , ,
ADAPT_PRIMARY_KEY_GENERATION = 0
When first entity is inserted in the collection - primary key generation will automatically adapt whether this first entity has the primary key already present or not. If it is present all other entities are expected to have also primary key provided from external systems, if not primary keys will be always automatically generated by Evita and may never be provided from outside.
ADDING_ATTRIBUTES = 1
When new attribute is encountered, it is silently added to a collection schema as non-filterable, non-sortable, non-unique attribute of the type that was used for the first value. Localizability of the attribute is determined by the fact whether the first value encountered was associated with any localization.
ADDING_ASSOCIATED_DATA = 2
When new associated data is encountered, it is silently added to a collection schema. Localizability of the associated data is determined by the fact whether the first value encountered was associated with any localization.
ADDING_REFERENCES = 3
When new reference type is encountered, it is silently added. It's linked to other evitaDB entity when the entity type of a reference or its group respectively matches by a type of a different entity reference any existing entity collection. Reference is not indexed, nor hierarchy indexed by default and this must be changed by updating the schema.
ADDING_PRICES = 4
When entity has no prices and new price is encountered, it is silently added. That means that entity type starts supporting prices when first price has been added.
ADDING_LOCALES = 5
When new localization is encountered, it is silently added.
ADDING_CURRENCIES = 6
When new currency is encountered in prices, it is silently added.
ADDING_HIERARCHY = 7
When hierarchy placement for the entity is encountered, it is silently added.
UPDATING_REFERENCE_CARDINALITY = 8
When a new duplicate reference is added to the entity, evitaDB automatically updates the schema to allow such duplicities. By default, references are set up with cardinality ZERO_OR_MORE
message
GrpcExtraResults.proto:256This DTO contains extra results that are computed based on the query results.
Used in:
map<string, > attributeHistogram = 1
Returns computed histograms for specific attributes based on filter constraints. A histogram is an approximate representation of the distribution of numerical data. For detailed description please see [WikiPedia](https://en.wikipedia.org/wiki/Histogram). Histogram can be computed only for numeric based properties. It visualises which property values are more common in the returned data set and which are rare. Bucket count will never exceed requested bucket count specified in `requestedCount` but there may be less of them if there is no enough data for computation. Bucket thresholds are specified heuristically so that there are as few "empty buckets" as possible. - buckets are defined by their lower bounds (inclusive) - the upper bound is the lower bound of the next bucket
optional priceHistogram = 2
Returns computed histogram for prices satisfactory to filter constraints. A histogram is an approximate representation of the distribution of numerical data. For detailed description please see [WikiPedia](https://en.wikipedia.org/wiki/Histogram). Histogram can be computed only for numeric based properties. It visualises which property values are more common in the returned data set and which are rare. Bucket count will never exceed requested bucket count specified in `requestedCount` but there may be less of them if there is no enough data for computation. Bucket thresholds are specified heuristically so that there are as few "empty buckets" as possible. - buckets are defined by their lower bounds (inclusive) - the upper bound is the lower bound of the next bucket
repeated facetGroupStatistics = 3
Contains a collection of FacetGroupStatistics DTOs where each of them contains information about single facet group (if they belong in one) and statistics of the facets that relates to it. Deprecated since 2026.2 - renamed to `referenceGroupStatistics`
optional selfHierarchy = 4
Contains list of statistics for the single level (probably root or whatever is filtered by the query) of the queried hierarchy entity.
map<string, > hierarchy = 5
Index holds the statistics for particular references that target hierarchy entity types. Key is the identification of the reference name, value contains list of statistics for the single level (probably root or whatever is filtered by the query) of the hierarchy entity.
optional queryTelemetry = 6
This DTO contains detailed information about query processing time and its decomposition to single operations.
repeated referenceGroupStatistics = 7
Contains a collection of ReferenceGroupStatistics DTOs where each of them contains information about single reference group (if they belong in one) and statistics of the references that relates to it.
Enum defines various level of relationship for which the facet summary calculation rules are defined.
Used in:
WITH_DIFFERENT_FACETS_IN_GROUP = 0
Defines relation type between two facets in the same group and reference.
WITH_DIFFERENT_GROUPS = 1
Defines relation type between two facets in the different groups or references.
message
GrpcExtraResults.proto:81This DTO contains information about single facet group and statistics of the facets that relates to it. Deprecated since 2026.2 - deprecated in favor of `GrpcReferenceGroupStatistics`, produced by the `referenceSummary` requirement TOBEDONE: remove when FacetSummary constraint is removed (https://github.com/FgForrest/evitaDB/issues/538)
Used in:
string referenceName = 1
Contains name of the facet group.
optional groupEntityReference = 2
Contains referenced entity reference representing this group.
optional groupEntity = 3
Contains referenced entity representing this group.
int32 count = 4
Contains number of distinct entities in the response that possess any reference in this group.
repeated facetStatistics = 5
Contains statistics of individual facets.
Enum defines all supported relation type that can be used in the facet summary impact calculation.
Used in:
DISJUNCTION = 0
Logical OR relation.
CONJUNCTION = 1
Logical AND relation.
NEGATION = 2
Logical AND NOT relation.
EXCLUSIVITY = 3
Exclusive relations to other facets on the same level, when selected no other facet on that level can be selected.
message
GrpcExtraResults.proto:97This DTO contains information about single facet statistics of the entities that are present in the response.
Used in: ,
optional facetEntityReference = 1
Contains referenced entity reference representing.
optional facetEntity = 2
Contains referenced entity representing.
bool requested = 3
Contains TRUE if the facet was part of the query filtering constraints.
int32 count = 4
Contains number of distinct entities in the response that possess of this reference.
optional impact = 5
This field is not null only when this facet is not requested. Contains projected impact on the current response if this facet is also requested in filtering constraints.
optional matchCount = 6
Projected number of filtered entities if the query is altered by adding this facet to filtering constraint.
bool hasSense = 7
Selection has sense - TRUE if there is at least one entity still present in the result if the query is altered by adding this facet to filtering query. In case of OR relation between facets it's also true only if there is at least one entity present in the result when all other facets in the same group are removed and only this facet is requested.
This enum controls whether ReferenceSummary should contain only basic statistics about facets - e.g. count only, or whether the selection impact should be computed as well. Backward compatibility: `COUNTS` is kept at tag 0 (the proto3 default) and `IMPACT` at tag 1 so existing clients continue to deserialize unchanged. The newer `NONE` option is assigned a fresh tag; older clients that never request it are unaffected, and since this enum is used only as a request parameter (never as a server-emitted response), servers never push `NONE` to an unaware client.
Used in: ,
COUNTS = 0
Only counts of facets will be computed.
IMPACT = 1
Counts and selection impact for non-selected facets will be computed.
STATISTICS_NONE = 2
No per-facet statistics are computed. The engine returns facet options without counts or impact — the cheapest option, appropriate when the UI only needs to enumerate available facets without any numeric indicator. Proto3 enum values share a file-level namespace, so this value is prefixed (plain `NONE` is used by `GrpcPriceInnerRecordHandling` elsewhere in this file).
message
GrpcEvitaDataTypes.proto:216Wrapper for representing an array of FacetStatisticsDepth enums.
Used in:
repeated GrpcFacetStatisticsDepth value = 1
The individual FacetStatisticsDepth values, in their original order.
message
GrpcEvitaDataTypes.proto:416Identification of a file available for fetching from the server (e.g. a backup archive or an export produced by an asynchronous task).
Used in: , ,
optional fileId = 1
Unique identifier of the file, used to reference it in fetch/download requests.
string name = 2
File name, including extension.
optional description = 3
Human-readable description of the file's purpose or contents. Unset when no description was provided.
string contentType = 4
MIME content type of the file (e.g. `application/zip`).
int64 totalSizeInBytes = 5
Size of the file on disk (bytes).
optional created = 6
Date and time when the file was created.
optional origin = 7
Comma-separated identifiers of what produced the file — usually the `taskType` (see `GrpcTaskStatus.taskType`) of the task that created it. Unset when the origin wasn't recorded.
message
GrpcExtraResults.proto:197One node of the formula plan a query phase was carried out with - the structural counterpart of the timings. The plan is a DAG rather than a tree: a formula's result is memoized per instance, so a subtree reachable by two paths is computed once and every later occurrence of it is free. `refTo` is what keeps a reader from counting such a subtree twice - the first occurrence is described in full, and every later one is a bare node pointing back at it by id, with no children of its own. actualCost and resultCount are absent whenever the formula was not computed, which is the normal state for a rejected plan alternative and for a short-circuited branch of the winning one. They are absent rather than 0 because the plan is rendered without ever computing anything: filling them in would make asking for the plan change what the query does.
Used in:
int32 id = 1
Identity of the formula instance this node stands for, unique within the plan and stable across its occurrences - it is what makes "computed once, reused twice" visible.
optional int32 refTo = 2
Absent on the occurrence that describes the instance; equal to `id` on every later occurrence, which carries no detail and no children and means "see the node with this id".
int64 hash = 3
Structural hash of the formula, i.e. what the cache keys on. Two nodes with the same hash are interchangeable computations, whereas two nodes with the same id are the same object - the two answer different questions.
optional string description = 4
Human readable description of the formula. Absent on a back-reference node.
int64 estimatedCost = 5
Cost the planner estimated for this formula before running anything.
optional int64 actualCost = 6
Cost the formula really incurred. Absent when it was never computed.
optional int32 resultCount = 7
Number of records the formula produced. Absent when it was never computed.
repeated children = 8
Inner formulas. Always empty on a back-reference node.
message
GrpcEvitaSessionAPI.proto:628Response to a catalog full backup request (a backup that includes the entire catalog history, not just the current state).
Used as response type in: EvitaSessionService.FullBackupCatalog, EvitaSessionService.FullBackupCatalogWithProgress
optional taskStatus = 1
Handle to the asynchronous backup task; use it to poll or stream the task's progress and, once finished, retrieve the resulting backup file.
message
GrpcCatalogSchema.proto:60This is the definition object for attributes that are stored along with catalog. Definition objects allow to describe the structure of the catalog so that in any time everyone can consult complete structure of the catalog. Definition object is similar to Java reflection process where you can also at any moment see which fields and methods are available for the class. Catalog attributes allows defining set of data that are fetched in bulk along with the catalog body. Attributes may be indexed for fast filtering or can be used to sort along. Attributes are not automatically indexed in order not to waste precious memory space for data that will never be used in search queries. Filtering in attributes is executed by using constraints like `and`, `or`, `not`. Sorting can be achieved with `attributeNatural` or others. Attributes are not recommended for bigger data as they are all loaded at once when requested.
Used in:
string name = 1
Contains unique name of the attribute. Case-sensitive. Distinguishes one attribute from another within a single entity type or, for global attributes, within the entire catalog.
optional description = 2
optional description of the attribute
optional deprecationNotice = 3
optional deprecation notice
GrpcAttributeUniquenessType unique = 4
When attribute is unique it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute among other entities in the same collection. As an example of unique attribute can be EAN - there is no sense in having two entities with same EAN, and it's better to have this ensured by the database engine. Deprecated since 2024.12 - deprecated in favor of `uniqueInScopes`
bool filterable = 5
When attribute is filterable, it is possible to filter entities by this attribute. Do not mark attribute as filterable unless you know that you'll search entities by this attribute. Each filterable attribute occupies (memory/disk) space in the form of index. When attribute is filterable, extra result `attributeHistogram` can be requested for this attribute. Deprecated since 2024.12 - deprecated in favor of `filterableInScopes`
bool sortable = 6
When attribute is sortable, it is possible to sort entities by this attribute. Do not mark attribute as sortable unless you know that you'll sort entities along this attribute. Each sortable attribute occupies (memory/disk) space in the form of index.. Deprecated since 2024.12 - deprecated in favor of `sortableInScopes`
bool localized = 7
When attribute is localized, it has to be ALWAYS used in connection with specific `Locale`.
bool nullable = 8
When attribute is nullable, its values may be missing in the entities. Otherwise, the system will enforce non-null checks upon upserting of the entity.
bool representative = 9
If an attribute is flagged as representative, it should be used in developer tools along with the entity's primary key to describe the entity or reference to that entity. The flag is completely optional and doesn't affect the core functionality of the database in any way. However, if it's used correctly, it can be very helpful to developers in quickly finding their way around the data. There should be very few representative attributes in the entity type, and the unique ones are usually the best to choose.
GrpcEvitaDataType type = 10
Data type of the attribute. Must be one of Evita-supported values. Internally the scalar is converted into Java-corresponding data type.
optional defaultValue = 11
Default value is used when the entity is created without this attribute specified. Default values allow to pass non-null checks even if no attributes of such name are specified.
int32 indexedDecimalPlaces = 12
Determines how many fractional places are important when entities are compared during filtering or sorting. It is significant to know that all values of this attribute will be converted to `Integer`, so the attribute number must not ever exceed maximum limits of `Integer` type when scaling the number by the power of ten using `indexedDecimalPlaces` as exponent.
GrpcGlobalAttributeUniquenessType uniqueGlobally = 13
When attribute is unique globally it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute in entire catalog. As an example of unique attribute can be URL - there is no sense in having two entities with same URL, and it's better to have this ensured by the database engine. Deprecated since 2024.12 - deprecated in favor of `uniqueGloballyInScopes`
repeated nameVariant = 14
Contains attribute name converted to different naming conventions.
repeated uniqueInScopes = 15
When attribute is unique it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute among other entities in the same collection. As an example of unique attribute can be EAN - there is no sense in having two entities with same EAN, and it's better to have this ensured by the database engine.
repeated GrpcEntityScope filterableInScopes = 16
When attribute is filterable, it is possible to filter entities by this attribute. Do not mark attribute as filterable unless you know that you'll search entities by this attribute. Each filterable attribute occupies (memory/disk) space in the form of index. When attribute is filterable, extra result `attributeHistogram` can be requested for this attribute.
repeated GrpcEntityScope sortableInScopes = 17
When attribute is sortable, it is possible to sort entities by this attribute. Do not mark attribute as sortable unless you know that you'll sort entities along this attribute. Each sortable attribute occupies (memory/disk) space in the form of index..
repeated uniqueGloballyInScopes = 18
When attribute is unique globally it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute in entire catalog. As an example of unique attribute can be URL - there is no sense in having two entities with same URL, and it's better to have this ensured by the database engine.
GrpcConflictResolutionOverride conflictResolutionOverride = 19
Contains the per-attribute override of the conflict resolution granularity. Defaults to inherited (follow the resolved conflict resolution).
This enum represents the uniqueness type of a `GlobalAttributeSchema`. It is used to determine whether the attribute value must be unique among all the entities using this `GlobalAttributeSchema` or whether it must be unique only among entities of the same locale.
Used in: , , , ,
NOT_GLOBALLY_UNIQUE = 0
The attribute is not unique (default).
UNIQUE_WITHIN_CATALOG = 1
The attribute value (either localized or non-localized) must be unique among all values among all the entities using this `GlobalAttributeSchema` in the entire catalog.
UNIQUE_WITHIN_CATALOG_LOCALE = 2
The localized attribute value must be unique among all values of the same `Locale` among all the entities using this `GlobalAttributeSchema` in the entire catalog.
Enum represents a sub-entity refinement of entity-level conflict detection. Granularity is legal only when the coarse conflict policy is set to entity level.
Used in:
GRANULAR_CONFLICT_POLICY_ENTITY_ATTRIBUTE = 0
Conflicts are detected on entity attributes.
GRANULAR_CONFLICT_POLICY_REFERENCE = 1
Conflicts are detected on references.
GRANULAR_CONFLICT_POLICY_REFERENCE_ATTRIBUTE = 2
Conflicts are detected on reference attributes.
GRANULAR_CONFLICT_POLICY_ASSOCIATED_DATA = 3
Conflicts are detected on associated data.
GRANULAR_CONFLICT_POLICY_PRICE = 4
Conflicts are detected on prices.
GRANULAR_CONFLICT_POLICY_HIERARCHY = 5
Conflicts are detected on hierarchy placement.
This enum represents the possible health problems that can be signaled by the server.
Used in:
MEMORY_SHORTAGE = 0
* Signalized when the consumed memory never goes below 85% of the maximum heap size and the GC tries to free old generation at least once (this situation usually leads to repeated attempts of expensive old generation GC and pressure on system CPUs).
EXTERNAL_API_UNAVAILABLE = 1
* Signalized when the readiness probe signals that at least one external API, that is configured to be enabled doesn't respond to internal HTTP check call.
INPUT_QUEUES_OVERLOADED = 2
* Signalized when the input queues are full and the server is not able to process incoming requests. The problem is reported when there is ration of rejected tasks to accepted tasks >= 2. This flag is cleared when the rejection ratio decreases below the specified threshold, which signalizes that server is able to process incoming requests again.
JAVA_INTERNAL_ERRORS = 3
* Signaled when there are occurrences of Java internal errors. These errors are usually caused by the server itself and are not related to the client's requests. Java errors signal fatal problems inside the JVM.
message
GrpcChangeCapture.proto:184Heartbeat message sent to the subscriber to keep the connection alive.
Used in: ,
int64 index = 1
the index of the heartbeat event
optional timestamp = 2
the timestamp of the heartbeat event on the server
int64 lastObservedVersion = 3
the last observed version by the subscriber in case of system subscription it is engine version in case of catalog subscription it is catalog version
int64 millisToNextHeartbeat = 4
milliseconds to the next heartbeat (derived from the server configuration)
message
GrpcExtraResults.proto:120Contains list of statistics for the single level (probably root or whatever is filtered by the query) of the queried hierarchy entity.
Used in:
map<string, > hierarchy = 1
Map holds the statistics represented by user-specified output name of requested hierarchy.
message
GrpcExtraResults.proto:22Histogram can be computed only for numeric based properties. It visualises which property values are more common in the returned data set and which are rare. Bucket count will never exceed requested bucket count but there may be less of them if there is no enough data for computation. Bucket thresholds are specified heuristically so tha there are as few "empty buckets" as possible. - buckets are defined by their lower bounds (inclusive) - the upper bound is the lower bound of the next bucket
Used in: ,
optional min = 1
Returns left bound of the first bucket. It represents the smallest value encountered in the returned set.
optional max = 2
Returns right bound of the last bucket of the histogram. Each bucket contains only left bound threshold, so this value is necessary so that first histogram buckets makes any sense. This value is exceptional in the sense that it represents the biggest value encountered in the returned set and represents inclusive right bound for the last bucket.
int32 overallCount = 3
Returns count of all entities that are covered by this histogram. It's plain sum of occurrences of all buckets in the histogram.
repeated buckets = 4
Returns histogram buckets that represents a tuple of occurrence count and the minimal threshold of the bucket values.
optional minReferencedEntity = 5
Referenced entity whose value anchors the minimum bucket of the histogram. Populated only for reference-scope histograms when an entity fetch is requested for the associated reference.
optional maxReferencedEntity = 6
Referenced entity whose value anchors the maximum bucket of the histogram. Populated only for reference-scope histograms when an entity fetch is requested for the associated reference.
message
GrpcExtraResults.proto:34Data object that carries out threshold in histogram (or bucket if you will) along with number of occurrences in it.
Used in:
optional threshold = 2
Contains threshold (left bound - inclusive) of the bucket.
int32 occurrences = 3
Contains number of entity occurrences in this bucket - e.g. number of entities that has monitored property value between previous bucket threshold (exclusive) and this bucket threshold (inclusive)
bool requested = 4
Contains true if the `bucket` is overlapping the attribute between filtering constraint
optional relativeFrequency = 5
Relative frequency value used for visualization purposes. For standard histograms: percentage of total occurrences (0-100). For equalized histograms: normalized value density (0-100) accounting for both occurrences and bucket width, scaled so all buckets sum to 100. Higher values indicate denser data concentration in this bucket.
The enum specifies whether the HistogramBehavior should produce histogram with exactly requested bucket counts or optimized one, which may have less buckets than requested, but is more compact
Used in: ,
STANDARD = 0
Histogram always contains the number of buckets you asked for. This is the default behaviour. Bucket boundaries are positioned at equal intervals across the value range.
OPTIMIZED = 1
Histogram will never contain more buckets than you asked for, but may contain less when the data is scarce and there would be big gaps (empty buckets) between buckets. This leads to more compact histograms, which provide better user experience. Bucket boundaries are positioned at equal intervals across the value range.
EQUALIZED = 2
Histogram always contains the number of buckets you asked for. Bucket boundaries are positioned based on cumulative frequency distribution, so each bucket covers approximately equal portion of total records.
EQUALIZED_OPTIMIZED = 3
Histogram will never contain more buckets than you asked for, but may contain less when the data is scarce. Bucket boundaries are positioned based on cumulative frequency distribution, so each bucket covers approximately equal portion of total records.
message
GrpcEvitaDataTypes.proto:264Wrapper for representing an array of HistogramBehavior enums.
Used in:
repeated GrpcHistogramBehavior value = 1
The individual HistogramBehavior values, in their original order.
message
GrpcChangeCapture.proto:142Host CDC event. Carried as the body of GrpcChangeSystemCapture when the subscriber explicitly opted in to HOST.
Used in:
oneof event
Exactly one of the following event kinds is set.
catalogInstalled = 1
Fires when a catalog's local reference settles into a non-transient state on this host.
catalogRemoved = 2
Fires when a catalog is fully removed from the live view on this host.
catalogSchemaUpdated = 3
Fires when a catalog's schema version increases on this host (coalesced).
Contains all possible infrastructure mutations in catalog.
Used in:
oneof mutation
The mutation to be performed.
transactionMutation = 1
This transaction mutation delimits mutations of one transaction from another. It contains data that allow to recognize the scope of the transaction and verify its integrity.
message
GrpcReferenceMutations.proto:13This mutation allows to create a reference in the entity.
Used in:
string referenceName = 1
Unique identifier of the reference.
int32 referencePrimaryKey = 2
Primary key of the referenced entity. Might be also any integer that uniquely identifies some external resource not maintained by Evita.
GrpcCardinality referenceCardinality = 3
Contains information about reference cardinality. This value is usually NULL except the case when the reference is created for the first time and `EvolutionMode.ADDING_REFERENCES` is allowed.
optional referencedEntityType = 4
Contains information about target entity type. This value is usually NULL except the case when the reference is created for the first time and `EvolutionMode.ADDING_REFERENCES` is allowed.
int32 internalPrimaryKey = 5
internal PK is assigned by evitaDB engine and is used to uniquely identify the reference among other references. It is used when multiple references share same business key - entityType and primaryKey - but differ by other properties (fe. reference group or attributes). When a reference is created for the first time, internal id is set to a unique negative number that is not used by the server side, which assigns positive unique numbers to the references on first reference persistence. This allows distinguishing references that are not yet persisted from those that are already persistent. When standalone key is used: - negative number: means that the reference is new and hasn't been yet persisted - zero: means we don't know the internal PK - positive number: means that the reference is persistent and has been already stored in the database
message
GrpcEvitaDataTypes.proto:138Wrapper for representing an array of integers. Also used to carry Byte and Short arrays, narrowed/widened to int32 on the wire; which Java array type applies is determined by the accompanying GrpcEvitaDataType (BYTE_ARRAY, SHORT_ARRAY or INTEGER_ARRAY).
Used in: ,
repeated int32 value = 1
The individual integer elements, in their original order.
message
GrpcEvitaDataTypes.proto:14Representation of IntegerNumberRange structures. At least one of `from`/`to` should be set; if both are absent, the range decodes to the degenerate range `[0,0]` rather than being unbounded in both directions.
Used in: , , ,
optional from = 1
The inclusive lower bound of the range. If unset (while `to` is set), the range is unbounded below.
optional to = 2
The inclusive upper bound of the range. If unset (while `from` is set), the range is unbounded above.
message
GrpcEvitaDataTypes.proto:171Wrapper for representing an array of IntegerNumberRanges. Also used to carry ByteNumberRange and ShortNumberRange arrays; which Java array type applies is determined by the accompanying GrpcEvitaDataType (BYTE_NUMBER_RANGE_ARRAY, SHORT_NUMBER_RANGE_ARRAY or INTEGER_NUMBER_RANGE_ARRAY).
Used in: ,
repeated value = 1
The individual IntegerNumberRange elements, in their original order.
message
GrpcExtraResults.proto:133This DTO represents single hierarchical entity in the statistics tree. It contains identification of the entity, the cardinality of queried entities that refer to it and information about children level.
Used in:
optional entityReference = 1
Hierarchical entity reference at position in tree represented by this object.
optional entity = 2
Hierarchical entity at position in tree represented by this object.
optional queriedEntityCount = 3
Contains the number of queried entities that refer directly to this `entity` or to any of its children entities.
optional childrenCount = 4
Contains number of hierarchical entities that are referring to this `entity` as its parent. The count will respect behaviour settings and will not count empty children in case `REMOVE_EMPTY` is used for computation.
repeated items = 5
Contains hierarchy info of the entities that are subordinate (children) of this `entity`.
bool requested = 6
Contains true if the `entity` was filtered by hierarchy within constraint
message
GrpcExtraResults.proto:126This DTO represents a wrapper for array of statistics for the single hierarchy level of inner entities.
Used in:
repeated levelInfos = 1
Array of statistics for the single hierarchy level of inner entities.
Contains all possible catalog schema mutations.
Used in: ,
oneof mutation
The used local catalog mutation.
modifyCatalogSchemaDescriptionMutation = 1
Mutation is responsible for setting value to a `CatalogSchema.description` in `CatalogSchema`.
allowEvolutionModeInCatalogSchemaMutation = 2
Mutation is responsible for adding one or more modes to a `CatalogSchema.catalogEvolutionMode` in `CatalogSchema`.
disallowEvolutionModeInCatalogSchemaMutation = 3
Mutation is responsible for removing one or more modes from a `CatalogSchema.evolutionMode` in `CatalogSchema`.
createGlobalAttributeSchemaMutation = 4
Mutation is responsible for setting up a new `GlobalAttributeSchema` in the `CatalogSchema`. Mutation can be used for altering also the existing `GlobalAttributeSchema` alone.
modifyAttributeSchemaDefaultValueMutation = 5
Mutation is responsible for setting value to a `AttributeSchema.defaultValue` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
modifyAttributeSchemaDeprecationNoticeMutation = 6
Mutation is responsible for setting value to a `AttributeSchema.defaultValue` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
modifyAttributeSchemaDescriptionMutation = 7
Mutation is responsible for setting value to a `AttributeSchema.description` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
modifyAttributeSchemaNameMutation = 8
Mutation is responsible for renaming an existing `AttributeSchema` in `EntitySchema` or `GlobalAttributeSchema` in `CatalogSchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
modifyAttributeSchemaTypeMutation = 9
Mutation is responsible for setting value to a `AttributeSchema.type` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
removeAttributeSchemaMutation = 10
Mutation is responsible for removing an existing `AttributeSchema` in the `EntitySchema` or `GlobalAttributeSchema` in the `CatalogSchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
setAttributeSchemaFilterableMutation = 11
Mutation is responsible for setting value to a `AttributeSchema.filterable` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
setAttributeSchemaLocalizedMutation = 12
Mutation is responsible for setting value to a `AttributeSchema.localized`in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or`GlobalAttributeSchema` alone.
setAttributeSchemaNullableMutation = 13
Mutation is responsible for setting value to a `AttributeSchema.nullable` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
setAttributeSchemaRepresentativeMutation = 14
Mutation is responsible for setting value to a `AttributeSchema.representative` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
setAttributeSchemaSortableMutation = 15
Mutation is responsible for setting value to a `AttributeSchema.sortable` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
setAttributeSchemaUniqueMutation = 16
Mutation is responsible for setting value to a `AttributeSchema.unique` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
setAttributeSchemaGloballyUniqueMutation = 17
Mutation is responsible for setting value to a `GlobalAttributeSchema.uniqueGlobally` in `EntitySchema`. Mutation can be used for altering also the existing `GlobalAttributeSchema` alone.
createEntitySchemaMutation = 30
Mutation is responsible for setting up a new `EntitySchema` - or more precisely the collection within catalog.
modifyEntitySchemaMutation = 31
Mutation is a holder for a set of `EntitySchemaMutation` that affect a single entity schema within the `CatalogSchema`.
modifyEntitySchemaNameMutation = 32
Mutation is responsible for renaming an existing `EntitySchema`.
removeEntitySchemaMutation = 33
Mutation is responsible for removing an existing `EntitySchema` - or more precisely the entity collection instance itself.
setAttributeSchemaConflictResolutionOverrideMutation = 34
Mutation is responsible for setting value `AttributeSchema.conflictResolutionOverride` in `CatalogSchema`.
modifyCatalogSchemaConflictResolutionMutation = 35
Mutation is responsible for setting value to a `CatalogSchema.conflictResolution` in `CatalogSchema`.
message
GrpcLocalMutation.proto:14Contains all possible local mutations to perform on entity.
Used in: ,
oneof mutation
The mutation to be performed.
applyDeltaAttributeMutation = 1
Increments or decrements existing numeric value by specified delta (negative number produces decremental of existing number, positive one incrementation). Allows to specify the number range that is tolerated for the value after delta application has been finished to verify for example that number of items on stock doesn't go below zero.
upsertAttributeMutation = 2
Upsert attribute mutation will either update existing attribute or create new one.
removeAttributeMutation = 3
Remove attribute mutation will drop existing attribute - ie.generates new version of the attribute with tombstone on it.
upsertAssociatedDataMutation = 4
Upsert associatedData mutation will either update existing associatedData or create new one.
removeAssociatedDataMutation = 5
Remove associated data mutation will drop existing associatedData - ie.generates new version of the associated data with tombstone on it.
upsertPriceMutation = 6
This mutation allows to create / update `price` of the entity.
removePriceMutation = 7
This mutation allows to remove existing `price` of the entity.
setPriceInnerRecordHandlingMutation = 8
This mutation allows to set / remove `priceInnerRecordHandling` behaviour of the entity.
setParentMutation = 9
This mutation allows to set `parent` in the `entity`.
removeParentMutation = 10
This mutation allows to remove `parent` from the `entity`.
insertReferenceMutation = 11
This mutation allows to create a reference in the entity.
removeReferenceMutation = 12
This mutation allows to remove a reference from the entity.
setReferenceGroupMutation = 13
This mutation allows to create / update group of the reference.
removeReferenceGroupMutation = 14
This mutation allows to remove group in the reference.
referenceAttributeMutation = 15
This mutation allows to create / update / remove attribute of the reference.
setEntityScopeMutation = 16
This mutation allows to set scope of the entity to ARCHIVED or LIVE state.
message
GrpcEvitaDataTypes.proto:73Structure for representing Locale objects specified by language tag.
Used in: , , , , , , , , , , ,
string languageTag = 1
IETF BCP 47 language tag (e.g. `en-US`, `cs-CZ`), resolved server-side via `Locale#forLanguageTag(String)`.
message
GrpcEvitaDataTypes.proto:198Wrapper for representing an array of Locales.
Used in: ,
repeated value = 1
The individual Locale elements, in their original order.
message
GrpcAssociatedData.proto:10This structure is used as a wrapper around the associated data map for the purpose of separation the global associated data from the localized.
Used in:
map<string, > associatedData = 1
The map, where the key is the name of the associated data and the value is the associated data value. The localization is held on the entity level - specific language tag is used as a key of the outer map on the SealedEntity level.
message
GrpcAttribute.proto:10This structure is used as a wrapper around the attribute map for the purpose of separation the global attributes from the localized ones.
Used in: ,
map<string, > attributes = 1
The map, where the key is the name of the attribute and the value is its value. The localization is held on the entity or the reference level respectively - specific language tag is used as a key of the outer map on the SealedEntity level.
message
GrpcReferenceMutations.proto:152This structure is used as a wrapper around the attribute map for the purpose of separation the global attributes from the localized ones.
map<string, > attributes = 1
The map, where the key is the name of the attribute and the value is the its value.
message
GrpcEvitaDataTypes.proto:144Wrapper for representing an array of longs.
Used in: ,
repeated int64 value = 1
The individual long elements, in their original order.
message
GrpcEvitaDataTypes.proto:26Representation of LongNumberRange structures. At least one of `from`/`to` should be set; if both are absent, the range decodes to the degenerate range `[0,0]` rather than being unbounded in both directions.
Used in: , , ,
optional from = 1
The inclusive lower bound of the range. If unset (while `to` is set), the range is unbounded below.
optional to = 2
The inclusive upper bound of the range. If unset (while `from` is set), the range is unbounded above.
message
GrpcEvitaDataTypes.proto:177Wrapper for representing an array of LongNumberRanges.
Used in: ,
repeated value = 1
The individual LongNumberRange elements, in their original order.
message
GrpcEngineMutation.proto:46Mutation that transitions a catalog to the "live" state, making it transactional.
Used in:
string catalogName = 1
Name of the catalog schema the mutation is targeting (will rename).
message
GrpcEvitaAPI.proto:160Request to make a catalog alive.
Used as request type in: EvitaService.MakeCatalogAlive, EvitaService.MakeCatalogAliveWithProgress
string catalogName = 1
Name of the catalog to make alive.
message
GrpcEvitaAPI.proto:148Request to make a catalog immutable.
Used as request type in: EvitaService.MakeCatalogImmutable, EvitaService.MakeCatalogImmutableWithProgress
string catalogName = 1
Name of the catalog to make immutable.
message
GrpcEvitaAPI.proto:136Request to make a catalog mutable.
Used as request type in: EvitaService.MakeCatalogMutable, EvitaService.MakeCatalogMutableWithProgress
string catalogName = 1
Name of the catalog to make mutable.
This enumeration controls behavior of the `ReferenceContent` related to managed entities. If the target entity is not (yet) present in the database and `EXISTING` is set, the reference will not be returned as if it does not exist. If `ANY` is set (default behavior), the reference will be returned if defined regardless of its target entity existence.
Used in:
ANY = 0
The reference to managed entity will always be returned regardless of the target entity existence.
EXISTING = 1
The reference to managed entity will be returned only if the target entity exists in the database.
message
GrpcEngineMutation.proto:84Mutation that records the fact a catalog's on-disk folder is no longer present, so the engine can move it to `MISSING` state in lock-step with the WAL rather than silently rewriting the bootstrap file on startup reconciliation.
Used in:
string catalogName = 1
Name of the catalog whose on-disk folder is no longer present.
Mutation is responsible for setting value to a `AssociatedDataSchemaContract.deprecationNotice` in `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
Used in:
string name = 1
Contains unique name of the model. Case-sensitive. Distinguishes one model item from another within single entity instance.
optional deprecationNotice = 2
Deprecation notice contains information about planned removal of this associated data from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes.
Mutation is responsible for setting value to a `AssociatedDataSchema.description` in `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
Used in:
string name = 1
Contains unique name of the model. Case-sensitive. Distinguishes one model item from another within single entity instance.
optional description = 2
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
Mutation is responsible for renaming an existing `AssociatedDataSchema` in `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
Used in:
string name = 1
Contains unique name of the model. Case-sensitive. Distinguishes one model item from another within single entity instance.
string newName = 2
Contains unique name of the model. Case-sensitive. Distinguishes one model item from another within single entity instance.
Mutation is responsible for setting value to a `AssociatedDataSchema.type` in `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
Used in:
string name = 1
Contains unique name of the model. Case-sensitive. Distinguishes one model item from another within single entity instance.
GrpcEvitaAssociatedDataDataType.GrpcEvitaDataType type = 2
Contains the data type of the entity. Must be one of supported types or may represent complex type - which is JSON object that can be automatically converted to the set of basic types.
Mutation is responsible for setting value to a `AttributeSchema.defaultValue` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or GlobalAttributeSchema` alone.
Used in: , ,
string name = 1
Name of the attribute the mutation is targeting.
optional defaultValue = 2
Default value is used when the entity is created without this attribute specified. Default values allow to pass non-null checks even if no attributes of such name are specified.
Mutation is responsible for setting value to a `AttributeSchema.deprecationNotice` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
Used in: , ,
string name = 1
Name of the attribute the mutation is targeting.
optional deprecationNotice = 2
Deprecation notice contains information about planned removal of this attribute from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes.
Mutation is responsible for setting value to a `AttributeSchema.description` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
Used in: , ,
string name = 1
Name of the attribute the mutation is targeting.
optional description = 2
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
Mutation is responsible for renaming an existing `AttributeSchema` in `EntitySchema` or `GlobalAttributeSchema` in `CatalogSchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
Used in: , ,
string name = 1
Name of the attribute the mutation is targeting.
string newName = 2
New name of the attribute the mutation is targeting.
Mutation is responsible for setting value to a `AttributeSchema.type` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
Used in: , ,
string name = 1
Name of the attribute the mutation is targeting.
GrpcEvitaDataType type = 2
Type of the attribute. Must be one of supported data types or its array.
int32 indexedDecimalPlaces = 3
Determines how many fractional places are important when entities are compared during filtering or sorting.
Mutation is responsible for setting value to a `CatalogSchema.conflictResolution` in `CatalogSchema`.
Used in:
optional conflictResolution = 1
The catalog-level conflict resolution setting. When not set (absent), the catalog schema conflict resolution is cleared (inherits the resolved conflict resolution).
Mutation is responsible for setting value to a `CatalogSchema.description` in `CatalogSchema`.
Used in:
optional description = 1
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
message
GrpcEngineMutation.proto:38Mutation is responsible for altering an existing CatalogSchema.
Used in:
string catalogName = 1
Name of the catalog schema the mutation is targeting (will rename).
repeated schemaMutations = 2
Collection of schema mutations that should be applied on current version of the catalog schema.
message
GrpcEngineMutation.proto:28Mutation is responsible for renaming an existing CatalogSchema.
Used in:
string catalogName = 1
Name of the catalog schema the mutation is targeting (will rename).
string newCatalogName = 2
The new name of the catalog schema.
bool overwriteTarget = 3
Flag indicating whether to replace the existing catalog or just to rename it.
Mutation is responsible for setting value to a `EntitySchema.conflictResolution` in `EntitySchema`.
Used in:
optional conflictResolution = 1
The entity-level conflict resolution setting. When not set (absent), the entity schema conflict resolution is cleared (inherits the resolved conflict resolution).
Mutation is responsible for setting a `EntitySchema.deprecationNotice` in `EntitySchema`.
Used in:
optional deprecationNotice = 1
Deprecation notice contains information about planned removal of this entity schema from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes.
Mutation is responsible for setting a `EntitySchema.description` in `EntitySchema`.
Used in:
optional description = 1
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
Mutation is a holder for a set of `EntitySchemaMutation` that affect a single entity schema within the `CatalogSchema`.
Used in: , ,
string entityType = 1
Entity type of entity schema that will be affected by passed mutations.
repeated entitySchemaMutations = 2
Collection of mutations that should be applied on current version of the schema.
Mutation is responsible for renaming an existing `EntitySchema`.
Used in: ,
string name = 1
Name of the entity schema the mutation is targeting.
string newName = 2
New name of the entity schema the mutation is targeting.
bool overwriteTarget = 3
Whether to overwrite entity collection with same name as the `newName` if found.
Mutation is a holder for a single `AttributeSchema` that affect any of `ReferenceSchema.attributes` in the `EntitySchema`.
Used in:
string name = 1
Name of the reference the mutation is targeting.
optional attributeSchemaMutation = 2
Nested attribute schema mutation that mutates reference attributes of targeted reference.
Mutation is responsible for setting value to a `ReferenceSchema.cardinality` in `EntitySchema`.
Used in:
string name = 1
Name of the reference the mutation is targeting.
GrpcCardinality cardinality = 2
Cardinality describes the expected count of relations of this type. In evitaDB we define only one-way relationship from the perspective of the entity. We stick to the ERD modelling [standards](https://www.gleek.io/blog/crows-foot-notation.html) here. Cardinality affect the design of the client API (returning only single reference or collections) and also help us to protect the consistency of the data so that conforms to the creator mental model.
Mutation is responsible for setting value to a `ReferenceSchema.deprecationNotice` in `EntitySchema`.
Used in:
string name = 1
Name of the reference the mutation is targeting.
optional deprecationNotice = 2
Deprecation notice contains information about planned removal of this schema from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes.
Mutation is responsible for setting value to a `ReferenceSchema.description` in `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
Used in:
string name = 1
Name of the reference the mutation is targeting.
optional description = 2
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
Mutation is responsible for renaming an existing `ReferenceSchema` in `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
Used in:
string name = 1
Name of the reference the mutation is targeting.
string newName = 2
New name of the reference the mutation is targeting.
Mutation is responsible for setting value to a `ReferenceSchema.referencedGroupType`in `EntitySchema`.
Used in:
string name = 1
Name of the reference the mutation is targeting.
optional referencedGroupType = 2
Reference to `EntitySchema.name` of the referenced group entity. Might be also any `String` that identifies type some external resource not maintained by Evita.
bool referencedGroupTypeManaged = 3
Whether `referencedGroupType` refers to any existing `EntitySchema.name` that is maintained by Evita.
Mutation is responsible for setting value to a `ReferenceSchema.referencedEntityType` in `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
Used in:
string name = 1
Name of the reference the mutation is targeting.
string referencedEntityType = 2
Reference to `EntitySchema.name` of the referenced entity. Might be also any `String` that identifies type some external resource not maintained by Evita.
bool referencedEntityTypeManaged = 3
Whether `referencedEntityType` refers to any existing `EntitySchema.name` that is maintained by Evita.
Mutation is a holder for a single `SortableAttributeCompoundSchema` that affect any of `ReferenceSchema.sortableAttributeCompound` in the `EntitySchema`.
Used in:
string name = 1
Name of the reference the mutation is targeting.
optional sortableAttributeCompoundSchemaMutation = 2
Nested sortable attribute compound schema mutation that mutates reference sortable attribute compounds of targeted reference.
Mutation is responsible for setting value to a `ReflectedReferenceSchema.attributesInherited` and `ReflectedReferenceSchema.attributesExcludedFromInheritance` in `ReferenceSchema`. Mutation can be used for altering also the existing `ReferenceSchemaContract` alone.
Used in:
string name = 1
Name of the reference the mutation is targeting.
GrpcAttributeInheritanceBehavior attributeInheritanceBehavior = 2
Contains true if the attributes of the reflected reference are inherited from the target reference.
repeated string attributeInheritanceFilter = 3
The array of attribute names that are inherited / excluded from inheritance based on the value of attributeInheritanceBehavior property.
Mutation is responsible for setting value to a `SortableAttributeCompoundSchema.deprecationNotice` in `EntitySchema` or `ReferenceSchema`.
Used in: ,
string name = 1
Name of the sortable attribute compound the mutation is targeting.
optional deprecationNotice = 2
Deprecation notice contains information about planned removal of this sortable attribute compound from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes.
Mutation is responsible for setting value to a `SortableAttributeCompoundSchema.description` in `EntitySchema` or `ReferenceSchema`.
Used in: ,
string name = 1
Name of the sortable attribute compound the mutation is targeting.
optional description = 2
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
Mutation is responsible for renaming an existing `SortableAttributeCompoundSchema` in `EntitySchema` or `ReferenceSchema`.
Used in: ,
string name = 1
Name of the sortable attribute compound the mutation is targeting.
string newName = 2
New name of the sortable attribute compound the mutation is targeting.
message
GrpcEvitaDataTypes.proto:528Structure for representing a name in a particular naming convention.
Used in: , , , , , , ,
GrpcNamingConvention namingConvention = 1
The naming convention this variant is rendered in (e.g. camelCase, kebab-case, PascalCase).
string name = 2
The entity/attribute/reference name transformed into the given naming convention.
Contains set of all supported/used naming conventions in evitaDB APIs.
Used in:
CAMEL_CASE = 0
Camel case: https://en.wikipedia.org/wiki/Camel_case
PASCAL_CASE = 1
Pascal case: https://www.theserverside.com/definition/Pascal-case
SNAKE_CASE = 2
Snake case: https://en.wikipedia.org/wiki/Snake_case
UPPER_SNAKE_CASE = 3
Capitalized snake case: https://en.wikipedia.org/wiki/Snake_case
KEBAB_CASE = 4
Kebab case: https://en.wikipedia.org/wiki/Letter_case#Kebab_case
message
GrpcEntity.proto:245The OffsetAndLimit record represents pagination parameters including offset, limit, and the last page number.
Used in:
int32 offset = 1
The starting point for fetching records.
int32 limit = 2
The number of records to fetch from the starting point.
int32 pageNumber = 3
The current page number based on the current pagination settings.
int32 lastPageNumber = 4
The last page number based on the current pagination settings.
int32 totalRecordCount = 5
The total number of records available.
message
GrpcEvitaDataTypes.proto:107Structure for universal representation of DateTime objects with an offset.
Used in: , , , , , , , , , , , , , , , , ,
optional timestamp = 1
The date and time of the object internally represented by unix timestamp.
string offset = 2
The offset of the object in seconds. Templates for offset: Z - for UTC +h +hh +hh:mm -hh:mm +hhmm -hhmm +hh:mm:ss -hh:mm:ss +hhmmss -hhmms
message
GrpcEvitaDataTypes.proto:192Wrapper for representing an array of OffsetDateTimes. Also used to carry LocalDateTime, LocalDate and LocalTime arrays; which Java array type applies is determined by the accompanying GrpcEvitaDataType (OFFSET_DATE_TIME_ARRAY, LOCAL_DATE_TIME_ARRAY, LOCAL_DATE_ARRAY or LOCAL_TIME_ARRAY).
Used in: ,
repeated value = 1
The individual date/time elements, in their original order.
Defines the behaviour of null values in an attribute element of the sortable attribute compound.
Used in:
NULLS_FIRST = 0
Null values are sorted before non-null values.
NULLS_LAST = 1
Null values are sorted after non-null values.
Used in order constraints to specify ordering direction.
Used in: , ,
ASC = 0
Ascending order.
DESC = 1
Descending order.
message
GrpcEvitaDataTypes.proto:240Wrapper for representing an array of OrderDirection enums.
Used in:
repeated GrpcOrderDirection value = 1
The individual OrderDirection values, in their original order.
message
GrpcEvitaSessionAPI.proto:412Page-based pagination descriptor for a `GrpcDataChunk`, reporting the page actually returned. The desired page is requested via the query's `page()` require constraint, not a field on this response structure - see `io.evitadb.api.query.require.Page` for the full contract. `pageNumber` is 1-indexed (page 1 is the first page) - see `io.evitadb.dataType.PaginatedList#getPageNumber`. A requested page number of 0 or less is rejected by the server; a requested page number beyond `lastPageNumber` is not rejected - the engine returns the first page instead, so `pageNumber` here can differ from what was requested.
Used in:
int32 pageSize = 1
Number of records requested per page, echoed back from the query's `page()` require constraint. Zero is valid and yields an empty page while `totalRecordCount`/`lastPageNumber` are still reported.
int32 pageNumber = 2
The page actually returned (1-indexed) - see the message-level comment for how this can differ from the requested page number.
int32 lastPageNumber = 3
The number of the last available page, given `pageSize` and the total record count.
message
GrpcEvitaDataTypes.proto:97Structure for representing Predecessor objects, used to express a manually maintained ordering of sibling entities/references by pointing each one at the primary key of the item that precedes it.
Used in:
bool head = 1
If `true`, this is the first item in the ordering (no predecessor) and `predecessorId` is not set. If `false`, this item has a predecessor and `predecessorId` must be set.
optional predecessorId = 2
The primary key of the entity/reference that precedes this one in the ordering. Unset when `head` is `true`; must be set when `head` is `false`.
message
GrpcPrice.proto:13Prices are specific to a very few entities, but because correct price computation is very complex in e-commerce systems and highly affects performance of the entities filtering and sorting, they deserve first class support in entity model. It is pretty common in B2B systems single product has assigned dozens of prices for the different customers.
Used in:
int32 priceId = 1
Contains identification of the price in the external systems. This id is expected to be used for the synchronization of the price in relation with the primary source of the prices. This id is used to uniquely find a price within same price list and currency and is mandatory.
string priceList = 2
Contains identification of the price list in the external system. Each price must reference a price list. Price list identification may refer to another Evita entity or may contain any external price list identification (for example id or unique name of the price list in the external system). Single entity is expected to have single price for the price list unless there is validity specified. In other words there is no sense to have multiple concurrently valid prices for the same entity that have roots in the same price list.
optional currency = 3
Identification of the currency.
optional innerRecordId = 4
Some special products (such as master products, or product sets) may contain prices of all "subordinate" products so that the aggregating product can represent them in certain views on the product. In that case there is need to distinguish the projected prices of the subordinate product in the one that represents them. Inner record id must contain positive value.
optional priceWithoutTax = 5
Price without tax.
optional taxRate = 6
Tax rate percentage (i.e. for 19% it'll be 19.00)
optional priceWithTax = 7
Price with tax.
optional validity = 8
Date and time interval for which the price is valid (inclusive).
bool sellable = 9
Controls whether price is subject to filtering / sorting logic, non-sellable prices will be fetched along with entity but won't be considered when evaluating search. These prices may be used for "informational" prices such as reference price (the crossed out price often found on e-commerce sites as "usual price") but are not considered as the "selling" price. Deprecated since 2024.10 - RENAMED TO "indexed"
int32 version = 10
Contains version of this price and gets increased with any entity type update. Allows to execute optimistic locking i.e. avoiding parallel modifications.
bool indexed = 11
Controls whether price is subject to filtering / sorting logic, non-sellable prices will be fetched along with entity but won't be considered when evaluating search. These prices may be used for "informational" prices such as reference price (the crossed out price often found on e-commerce sites as "usual price") but are not considered as the "selling" price.
Determines which prices will be fetched along with entity.
Used in: ,
FETCH_NONE = 0
No prices will be fetched.
RESPECTING_FILTER = 1
Only prices respecting filter constraints in query will be fetched.
ALL = 2
All prices will be fetched.
message
GrpcEvitaDataTypes.proto:228Wrapper for representing an array of PriceContentMode enums.
Used in:
repeated GrpcPriceContentMode value = 1
The individual PriceContentMode values, in their original order.
This enum controls how prices that share same `inner entity id` will behave during filtering and sorting.
Used in: ,
NONE = 0
No special strategy set. Inner record id is not taken into account at all.
LOWEST_PRICE = 1
Prices with same inner entity id will be sorted descending by priority value and first one (i.e. the one with the biggest priority) will be used (others won't be considered at all)
SUM = 2
Prices with same inner entity id will be added up to a new computed aggregated price, prices must share same tax rate percentage, currency and price list id in order to be added up
UNKNOWN = 3
Price handling mode that is used in cases when the information has not been fetched along with entity, and is therefore unknown (even if some strategy is associated with the entity in reality).
message
GrpcTrafficRecording.proto:178Client label attached to the query
Used in: , ,
string name = 1
The label name
string value = 2
The label value
message
GrpcEvitaSessionAPI.proto:703Response for a query executed via QueryList, i.e. expecting a flat list of matching entities (no paging metadata - use plain `Query` via `GrpcQueryResponse` if paging is needed). Exactly one of `entityReferences`/`sealedEntities`/`binaryEntities` is the active field, chosen the same way as in `GrpcDataChunk`: no `entityFetch` requirement in the query's `require` block selects `entityReferences`; an `entityFetch` requirement selects `sealedEntities` (structured form) or `binaryEntities` (binary storage form), depending on whether the session uses the binary storage format. The other two fields are always left empty; note the active field is itself also empty when zero entities matched.
Used as response type in: EvitaSessionService.QueryList, EvitaSessionService.QueryListUnsafe
repeated entityReferences = 1
Matched entities as references (type + primary key only). See the message-level comment for when this field (vs. the other two) is the active one.
repeated sealedEntities = 2
Matched entities, fully fetched in structured (non-binary) form. See the message-level comment for when this field (vs. the other two) is the active one.
repeated binaryEntities = 3
Matched entities, fully fetched in the server's binary storage format. See the message-level comment for when this field (vs. the other two) is the active one.
message
GrpcEvitaSessionAPI.proto:684Response for a query executed via QueryOne, i.e. expecting zero or one matching entity. At most one of `entityReference`/`sealedEntity`/`binaryEntity` is populated. If an entity matched, which one is chosen the same way as in `GrpcDataChunk`: no `entityFetch` requirement in the query's `require` block yields `entityReference`; an `entityFetch` requirement yields `sealedEntity` (structured form) or `binaryEntity` (binary storage form), depending on whether the session uses the binary storage format. If no entity matched the query, all three fields are left unset - this is not an error.
Used as response type in: EvitaSessionService.QueryOne, EvitaSessionService.QueryOneUnsafe
optional entityReference = 1
The matched entity as a reference (type + primary key only). See the message-level comment for when this field (vs. the other two) is populated.
optional sealedEntity = 2
The matched entity, fully fetched in structured (non-binary) form. See the message-level comment for when this field (vs. the other two) is populated.
optional binaryEntity = 3
The matched entity, fully fetched in the server's binary storage format. See the message-level comment for when this field (vs. the other two) is populated.
message
GrpcQueryParam.proto:11Structure that supports storing all possible parameters that could be used within query.
Used in: , , , , , ,
oneof queryParam
Exactly one of the following arms must be set. An unset `queryParam` is a client error: `QueryConverter.convertQueryParam` dispatches on the set arm and throws `EvitaInvalidUsageException` if none matches. Positional parameters (query strings using `?` placeholders) bind to entries of the enclosing message's `positionalQueryParams` list in the order the `?` placeholders are encountered in the query text — the first `?` binds to index 0, and so on. A query with more `?` placeholders than available entries fails with `EvitaInvalidUsageException("Missing argument of index N.")`. Named parameters (query strings using `@name` placeholders) bind to entries of the enclosing message's `namedQueryParams` map by the name embedded in the query text. A placeholder with no matching key fails with `EvitaInvalidUsageException("Missing argument of name `name`.")`.
string stringValue = 1
Binds a string parameter into the query, e.g. a string literal compared by `attributeEquals`, `attributeContains` or similar constraints, or a classifier name (entity type, attribute name).
int32 integerValue = 2
Binds an `int32` parameter into the query, typically used for primary keys or numeric literals.
int64 longValue = 3
Binds a `long` parameter into the query, typically used for primary keys or numeric literals that exceed the `int32` range.
bool booleanValue = 4
Binds a boolean parameter into the query.
bigDecimalValue = 5
Binds an arbitrary-precision decimal parameter into the query, typically used for price or other monetary/decimal literals.
dateTimeRangeValue = 6
Binds a date-time range parameter into the query, e.g. used with `entityValidIn`/`priceValidIn` style constraints that test whether a given instant falls within a validity range.
integerNumberRangeValue = 7
Binds an `int32` range parameter into the query, e.g. used with `between`-style range constraints.
longNumberRangeValue = 8
Binds a `long` range parameter into the query, e.g. used with `between`-style range constraints.
bigDecimalNumberRangeValue = 9
Binds an arbitrary-precision decimal range parameter into the query, e.g. used with `between`- style range constraints over prices or other decimal values.
offsetDateTimeValue = 10
Binds a single point-in-time parameter (date, time and offset) into the query, e.g. used with `priceValidIn` to test price validity at a specific instant.
localeValue = 11
Binds a `Locale` parameter into the query, e.g. used with `entityLocaleEquals`.
currencyValue = 12
Binds a `Currency` parameter into the query, e.g. used with `priceInCurrency`.
GrpcFacetStatisticsDepth facetStatisticsDepthValue = 13
Binds a `GrpcFacetStatisticsDepth` enum parameter into the query, e.g. used with the `facetSummary` requirement to select whether only counts or also selection impact is computed.
GrpcQueryPriceMode queryPriceModelValue = 14
Binds a `GrpcQueryPriceMode` enum parameter into the query, used by price-related filtering constraints to select whether tax-inclusive or tax-exclusive prices are considered. Field name is a legacy typo ("Model" instead of "Mode"); kept as-is because renaming would break generated accessors and JSON field mapping for existing clients.
GrpcPriceContentMode priceContentModeValue = 15
Binds a `GrpcPriceContentMode` enum parameter into the query, e.g. used with the `priceContent` requirement to select which prices are fetched along with the entity.
GrpcAttributeSpecialValue attributeSpecialValue = 16
Binds a `GrpcAttributeSpecialValue` enum parameter into the query, e.g. used with `attributeIs` to test whether an attribute value is `NULL` or `NOT_NULL`.
GrpcOrderDirection orderDirectionValue = 17
Binds a `GrpcOrderDirection` enum parameter into the query, e.g. used with `attributeNatural` and other ordering constraints to select ascending or descending order.
GrpcEmptyHierarchicalEntityBehaviour emptyHierarchicalEntityBehaviour = 18
Binds a `GrpcEmptyHierarchicalEntityBehaviour` enum parameter into the query, used by hierarchy statistics requirements to select whether hierarchy nodes with no referring entities are kept in or removed from the result tree.
GrpcStatisticsBase statisticsBase = 19
Binds a `GrpcStatisticsBase` enum parameter into the query, used by hierarchy statistics requirements to select which part of the `filterBy` constraint is considered when computing cardinalities.
GrpcStatisticsType statisticsType = 20
Binds a `GrpcStatisticsType` enum parameter into the query, used by hierarchy statistics requirements to select whether children counts or queried-entity counts are produced.
GrpcHistogramBehavior histogramBehavior = 21
Binds a `GrpcHistogramBehavior` enum parameter into the query, used by histogram requirements to select whether the histogram always has exactly the requested bucket count or an optimized, more compact bucket layout.
GrpcManagedReferencesBehaviour managedReferencesBehaviour = 22
Binds a `GrpcManagedReferencesBehaviour` enum parameter into the query, used by the `referenceContent` requirement to select whether references to a managed entity that no longer exists are still returned.
string expressionValue = 23
Binds a raw EvitaQL expression string into the query, evaluated via `ExpressionFactory` — e.g. used as the size argument of the `gap` requirement to compute spacing between paginated results.
GrpcEntityScope scope = 24
Binds a `GrpcEntityScope` enum parameter into the query, used by scope-aware constraints to select whether live or archived entities are considered.
GrpcFacetRelationType facetRelationType = 25
Binds a `GrpcFacetRelationType` enum parameter into the query, used by facet summary impact calculation to select the logical relation (disjunction, conjunction, negation, exclusivity) applied between facets.
GrpcFacetGroupRelationLevel facetGroupRelationLevel = 26
Binds a `GrpcFacetGroupRelationLevel` enum parameter into the query, used by facet summary impact calculation to select whether the relation applies between facets in the same group or across different groups/references.
GrpcTraversalMode traversalMode = 27
Binds a `GrpcTraversalMode` enum parameter into the query, used by the `traverseByEntityProperty` ordering constraint to select depth-first or breadth-first traversal.
stringArrayValue = 101
Binds a list of string parameters into the query, e.g. used with `inSet`-style constraints such as `attributeInSet` over string-typed attributes.
integerArrayValue = 102
Binds a list of `int32` parameters into the query, e.g. used with `entityPrimaryKeyInSet` or `attributeInSet` over integer-typed attributes.
longArrayValue = 103
Binds a list of `long` parameters into the query, e.g. used with `inSet`-style constraints over long-typed values that exceed the `int32` range.
booleanArrayValue = 104
Binds a list of boolean parameters into the query, e.g. used with `inSet`-style constraints over boolean-typed attributes.
bigDecimalArrayValue = 105
Binds a list of arbitrary-precision decimal parameters into the query, e.g. used with `inSet`-style constraints over decimal-typed attributes.
dateTimeRangeArrayValue = 106
Binds a list of date-time range parameters into the query, e.g. used with `inSet`-style constraints over range-typed attributes.
integerNumberRangeArrayValue = 107
Binds a list of `int32` range parameters into the query, e.g. used with `inSet`-style constraints over integer-range-typed attributes.
longNumberRangeArrayValue = 108
Binds a list of `long` range parameters into the query, e.g. used with `inSet`-style constraints over long-range-typed attributes.
bigDecimalNumberRangeArrayValue = 109
Binds a list of arbitrary-precision decimal range parameters into the query, e.g. used with `inSet`-style constraints over decimal-range-typed attributes.
offsetDateTimeArrayValue = 110
Binds a list of point-in-time parameters into the query, e.g. used with `inSet`-style constraints over date-time-typed attributes.
localeArrayValue = 111
Binds a list of `Locale` parameters into the query, e.g. used to enumerate multiple locales in a single constraint or requirement.
currencyArrayValue = 112
Binds a list of `Currency` parameters into the query, e.g. used to enumerate multiple currencies in a single constraint or requirement.
facetStatisticsDepthArrayValue = 113
Binds a list of `GrpcFacetStatisticsDepth` enum parameters into the query, used where the placeholder resolves to a list rather than a single value.
queryPriceModelArrayValue = 114
Binds a list of `GrpcQueryPriceMode` enum parameters into the query, used where the placeholder resolves to a list rather than a single value.
priceContentModeArrayValue = 115
Binds a list of `GrpcPriceContentMode` enum parameters into the query, used where the placeholder resolves to a list rather than a single value.
attributeSpecialArrayValue = 116
Binds a list of `GrpcAttributeSpecialValue` enum parameters into the query, used where the placeholder resolves to a list rather than a single value.
orderDirectionArrayValue = 117
Binds a list of `GrpcOrderDirection` enum parameters into the query, used where the placeholder resolves to a list rather than a single value.
emptyHierarchicalEntityBehaviourArrayValue = 118
Binds a list of `GrpcEmptyHierarchicalEntityBehaviour` enum parameters into the query, used where the placeholder resolves to a list rather than a single value.
statisticsBaseArrayValue = 119
Binds a list of `GrpcStatisticsBase` enum parameters into the query, used where the placeholder resolves to a list rather than a single value.
statisticsTypeArrayValue = 120
Binds a list of `GrpcStatisticsType` enum parameters into the query, used where the placeholder resolves to a list rather than a single value.
histogramBehaviorTypeArrayValue = 121
Binds a list of `GrpcHistogramBehavior` enum parameters into the query, used where the placeholder resolves to a list rather than a single value.
scopeArrayValue = 122
Binds a list of `GrpcEntityScope` enum parameters into the query, e.g. used with constraints that accept multiple scopes (live, archived) at once.
Enum contains all query execution phases, that leads from request to response.
Used in:
OVERALL = 0
Entire query execution time.
PLANNING = 1
Entire planning phase of the query execution.
PLANNING_NESTED_QUERY = 2
Planning phase of the inner query execution.
PLANNING_INDEX_USAGE = 3
Determining which indexes should be used.
PLANNING_FILTER = 4
Creating formula for filtering entities.
PLANNING_FILTER_NESTED_QUERY = 5
Creating formula for nested query.
PLANNING_FILTER_ALTERNATIVE = 6
Creating alternative formula for filtering entities.
PLANNING_SORT = 7
Creating formula for sorting result entities.
PLANNING_SORT_ALTERNATIVE = 8
Creating alternative formula for sorting result entities.
PLANNING_EXTRA_RESULT_FABRICATION = 9
Creating factories for requested extra results.
PLANNING_EXTRA_RESULT_FABRICATION_ALTERNATIVE = 10
Creating factories for requested extra results based on alternative indexes.
EXECUTION = 11
Entire query execution phase.
EXECUTION_PREFETCH = 12
Prefetching entities that should be examined instead of consulting indexes.
EXECUTION_FILTER = 13
Computing entities that should be returned in output (filtering).
EXECUTION_FILTER_NESTED_QUERY = 14
Computing entities within nested query that should be returned in output (filtering).
EXECUTION_SORT_AND_SLICE = 15
Sorting output entities and slicing requested page.
EXTRA_RESULTS_FABRICATION = 16
Fabricating requested extra results.
EXTRA_RESULT_ITEM_FABRICATION = 17
Fabricating requested single extra result.
FETCHING = 18
Fetching rich data from the storage based on computed entity primary keys.
FETCHING_REFERENCES = 19
Fetching referenced entities and entity groups from the storage based on referenced primary keys information.
FETCHING_PARENTS = 20
Fetching parent entities from the storage based on parent primary keys information.
FETCHING_REFERENCE_BODIES = 21
Aggregate phase covering orchestration of all referenced entity loads (predicate setup, ID collection, dedup, recursive dispatch).
Determines which price will be used for filtering.
Used in: ,
WITH_TAX = 0
Price computation operations will use actual price with tax added for filtering.
WITHOUT_TAX = 1
Price computation operations will use actual price without tax added for filtering.
message
GrpcEvitaDataTypes.proto:222Wrapper for representing an array of QueryPriceModeArray enums.
Used in:
repeated GrpcQueryPriceMode value = 1
The individual QueryPriceMode values, in their original order.
message
GrpcEvitaSessionAPI.proto:641Request for specifying a full EvitaQL query (filter, order and require blocks) to be executed.
Used as request type in: EvitaSessionService.Query, EvitaSessionService.QueryList, EvitaSessionService.QueryOne
string query = 1
The string part of the parametrised query, e.g. `query(collection('Product'), filterBy(entityPrimaryKeyInSet(?)))`. Parameter values are not embedded in this string but supplied separately via `positionalQueryParams`/ `namedQueryParams` below. A `?` placeholder is a positional parameter, an `@name` placeholder is a named parameter - see `positionalQueryParams` for the full binding contract, which applies identically here.
repeated positionalQueryParams = 2
Values for the `?` positional placeholders in `query`, bound in encounter order: the first `?` in the parsed string binds to `positionalQueryParams[0]`, the second to `positionalQueryParams[1]`, and so on (FIFO). Supplying fewer values than there are `?` placeholders fails the request with "Missing argument of index N."; extra values are ignored.
map<string, > namedQueryParams = 3
Values for the `@name` named placeholders in `query`, keyed by the name used after `@` in the string (without the `@` prefix). An `@name` placeholder with no matching map entry fails the request with "Missing argument of name `name`."; extra map entries are ignored.
message
GrpcEvitaSessionAPI.proto:668Response to Query request.
Used as response type in: EvitaSessionService.Query, EvitaSessionService.QueryUnsafe
optional recordPage = 1
The fetched page or strip of entities (in whichever of the three representations the query's `require` block asked for - see `GrpcDataChunk`).
optional extraResults = 2
Extra results computed by `require` constraints beyond the entity page itself (facet summary, hierarchy statistics, price histograms, etc.). Unset (default) if the query's `require` block requested none of these.
message
GrpcExtraResults.proto:152This DTO contains detailed information about query processing time and its decomposition to single operations.
Used in:
GrpcQueryPhase operation = 1
Phase of the query processing.
int64 start = 2
Number of nanoseconds elapsed since the root step of this telemetry tree began - the root step itself therefore always reports 0. This is not a wall-clock timestamp and must not be rendered as a date.
repeated steps = 3
Internal steps of this telemetry step (operation decomposition).
repeated string arguments = 4
Arguments of the processing phase.
int64 spentTime = 5
Duration in nanoseconds, covering this step and everything nested below it.
optional startedAt = 6
Wall-clock instant at which the query began. Set only on the root step - it anchors the whole tree in time, so the wall-clock position of any other node is startedAt plus that node's start offset.
int64 selfTime = 7
Duration in nanoseconds this step spent on its own work - its spentTime less the time accounted for by its direct children. A parent's spentTime is not the sum of its children's, so this is the number that says how much of a phase is the phase itself rather than the phases inside it. This is a server-derived convenience, not part of the telemetry object's identity: the engine does not track it, and the Java driver does not reconstruct it when it rebuilds the tree from this message. It is emitted so that clients which consume the wire format directly do not each have to sum the children themselves.
optional metrics = 8
Typed numeric measurements recorded for this step - cardinalities, costs and I/O counters the engine computed while answering the query. Unlike `arguments`, which is prose, these are values a client can compare and chart without parsing English. Absent when nothing was measured for this step, which is the case for every step but the root.
optional plan = 9
Structure of the formula this phase built or ran. Present only when the query asked for it with queryTelemetry(PLAN), and then only on the phases that own a formula: each PLANNING_FILTER_ALTERNATIVE step carries the candidate it costed - including the ones that lost - and the root carries the plan that ran.
message
GrpcExtraResults.proto:225Typed numeric measurements recorded for a single query telemetry step. Every field is optional and absence is meaningful: a metric is recorded where the engine happens to compute the number, so a missing one means "not measured for this phase". That is deliberately distinct from a measured 0, which recordsReturned, ioFetchCount, ioFetchedSizeBytes and prefetched can all legitimately be - which is also why these are `optional` rather than plain scalars, since proto3 implicit presence cannot tell the two apart.
Used in:
optional int64 estimatedCardinality = 1
How many records the planner expected the filtering formula to match. Compare against actualCardinality - an estimate that is orders of magnitude off is why the engine chose the index it chose, and it is the usual explanation for a plan that looks wrong.
optional int64 actualCardinality = 2
How many records the filtering formula really matched, before the requested page was cut out of them. This counts what the filter found, not what was returned - recordsReturned is the latter.
optional int64 estimatedCost = 3
Cost the planner estimated for the filtering formula it chose. This is the unitless scale candidate indexes are ranked on - comparable between plans of the same query, meaningless in absolute terms. Absent when the estimate overflowed.
optional int64 actualCost = 4
Cost the filtering formula really incurred, computed from the real cardinalities once it ran. Compare against estimatedCost on the same scale. Absent when the formula was never computed.
optional int64 recordsReturned = 5
How many records were actually handed back, i.e. the size of the page cut out of actualCardinality. Legitimately 0 for a query whose requested page lies past the end of the result.
optional int64 ioFetchCount = 6
How many times the storage was read while assembling the response. Legitimately 0 - a query answered entirely from indexes, or one returning bare primary keys, never touches storage.
optional int64 ioFetchedSizeBytes = 7
How many bytes were read from the storage while assembling the response. Reported alongside ioFetchCount because many small reads and one large read cost very differently.
optional bool prefetched = 8
Whether the planner prefetched entity bodies and filtered over them instead of consulting indexes. It explains the shape of the rest of the profile rather than measuring anything: a prefetched query spends its time in EXECUTION_PREFETCH and barely touches the index phases.
message
GrpcEvitaSessionAPI.proto:661Request for specifying a full EvitaQL query with parameter values embedded directly in the string (no separate positional/named parameter binding). Internal/unsafe use only - see the `QueryUnsafe` RPC comment: applications should use `GrpcQueryRequest` instead.
Used as request type in: EvitaSessionService.QueryListUnsafe, EvitaSessionService.QueryOneUnsafe, EvitaSessionService.QueryUnsafe
string query = 1
The complete query string, with any parameter values already embedded (no `?`/`@name` placeholders to resolve).
Enum representing overall readiness state of the server API.
Used in:
API_STARTING = 0
* At least one API is not ready.
API_READY = 1
* All APIs are ready.
API_STALLING = 2
* At least one API that was ready is not ready anymore.
API_SHUTDOWN = 3
* Server is shutting down. None of the APIs are ready.
API_UNKNOWN = 4
* Unknown state - cannot determine the state of the APIs (should not happen).
message
GrpcEntity.proto:203References may carry additional key-value data linked to this entity relation (fe. item count present on certain stock).
Used in:
string referenceName = 1
Name of the reference
int32 version = 2
Contains version of this reference and gets increased with any entity type update. Allows to execute optimistic locking i.e. avoiding parallel modifications.
optional referencedEntityReference = 3
Returns entity reference of the referenced entity in case its fetching was requested via entityFetch constraint.
optional referencedEntity = 4
Returns body of the referenced entity in case its fetching was requested via entityFetch constraint.
oneof groupReferenceType
Returns the referenced entity in case its fetching was requested via entityGroupFetch constraint.
groupReferencedEntityReference = 5
Returns entity reference of the referenced entity in case its fetching was requested via entityGroupFetch constraint.
groupReferencedEntity = 6
Returns body of the referenced entity in case its fetching was requested via entityGroupFetch constraint.
map<string, > globalAttributes = 7
Contains global attributes.
map<string, > localizedAttributes = 8
Contains localized attributes.
GrpcCardinality referenceCardinality = 9
Contains reference cardinality.
int32 internalPrimaryKey = 10
internal PK is assigned by evitaDB engine and is used to uniquely identify the reference among other references. It is used when multiple references share same business key - entityType and primaryKey - but differ by other properties (fe. reference group or attributes). When a reference is created for the first time, internal id is set to a unique negative number that is not used by the server side, which assigns positive unique numbers to the references on first reference persistence. This allows distinguishing references that are not yet persisted from those that are already persistent. When standalone key is used: - negative number: means that the reference is new and hasn't been yet persisted - zero: means we don't know the internal PK - positive number: means that the reference is persistent and has been already stored in the database
message
GrpcReferenceMutations.proto:125This mutation allows to create / update / remove attribute of the reference.
Used in:
string referenceName = 1
Unique identifier of the reference.
int32 referencePrimaryKey = 2
Primary key of the referenced entity. Might be also any integer that uniquely identifies some external resource not maintained by Evita.
optional attributeMutation = 3
One attribute mutation to update / insert / delete single attribute of the reference.
int32 internalPrimaryKey = 4
internal PK is assigned by evitaDB engine and is used to uniquely identify the reference among other references. It is used when multiple references share same business key - entityType and primaryKey - but differ by other properties (fe. reference group or attributes). When a reference is created for the first time, internal id is set to a unique negative number that is not used by the server side, which assigns positive unique numbers to the references on first reference persistence. This allows distinguishing references that are not yet persisted from those that are already persistent. When standalone key is used: - negative number: means that the reference is new and hasn't been yet persisted - zero: means we don't know the internal PK - positive number: means that the reference is persistent and has been already stored in the database
message
GrpcExtraResults.proto:61This DTO contains information about single reference group and statistics of the references that relates to it.
Used in:
string referenceName = 1
Contains name of the facet group.
optional groupEntityReference = 2
Contains referenced entity reference representing this group.
optional groupEntity = 3
Contains referenced entity representing this group.
int32 count = 4
Contains number of distinct entities in the response that possess any reference in this group.
repeated facetStatistics = 5
Contains statistics of individual facets.
map<string, > histogramStatistics = 6
Contains named histogram statistics for this reference group. Each histogram index defined on the reference schema produces a separate histogram entry keyed by the histogram index name.
Enum represents the type of index that should be created and maintained for a reference.
Used in:
REFERENCE_INDEX_TYPE_NONE = 0
Reference has no index available.
REFERENCE_INDEX_TYPE_FOR_FILTERING = 1
Reference has only basic index available that is necessary for ReferenceHaving constraint interpretation.
REFERENCE_INDEX_TYPE_FOR_FILTERING_AND_PARTITIONING = 2
Reference has basic index available and also partitioning indexes for the main entity type.
Enum represents the reference components that should be indexed for a reference.
Used in:
REFERENCE_INDEXED_COMPONENTS_REFERENCED_ENTITY = 0
The referenced entity itself is indexed.
REFERENCE_INDEXED_COMPONENTS_REFERENCED_GROUP_ENTITY = 1
The referenced group entity is indexed.
message
GrpcEntity.proto:82Represents a pair of reference keys used for tracking reassigned internal primary keys. The 'original' key contains the temporary internal PK, while the 'reassigned' key contains the permanent internal PK assigned after persistence.
Used in:
string referenceName = 1
Name of the reference (e.g., "category", "brand"). References the reference schema name that defines the type of relationship.
int32 primaryKey = 2
Primary key of the referenced entity. May be either an evitaDB entity primary key or an external resource identifier.
int32 originalInternalPrimaryKey = 3
Original reference key with temporary internal primary key (negative number).
int32 reassignedInternalPrimaryKey = 4
Reassigned reference key with permanent internal primary key (positive number) assigned by the server.
message
GrpcEntitySchema.proto:316This is the definition object for reference that is stored along with entity. Definition objects allow to describe the structure of the entity type so that in any time everyone can consult complete structure of the entity type. The references refer to other entities (of same or different entity type). Allows entity filtering (but not sorting) of the entities by using `facet_{name}_inSet` query and statistics computation if when requested. Reference is uniquely represented by int positive number (max. (2^63)-1) and entity type and can be part of multiple reference groups, that are also represented by int and entity type. Reference id in one entity is unique and belongs to single reference group id. Among multiple entities reference may be part of different reference groups. Referenced entity type may represent type of another Evita entity or may refer to anything unknown to Evita that posses unique int key and is maintained by external systems (fe. tag assignment, group assignment, category assignment, stock assignment and so on). Not all these data needs to be present in Evita. References may carry additional key-value data linked to this entity relation (fe. item count present on certain stock).
Used in:
string name = 1
Contains unique name of the model. Case-sensitive. Distinguishes one model item from another within single entity instance.
optional description = 2
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
optional deprecationNotice = 3
Deprecation notice contains information about planned removal of this entity from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes. If notice is `null`, this schema is considered not deprecated.
GrpcCardinality cardinality = 4
Cardinality describes the expected count of relations of this type. In evitaDB we define only one-way relationship from the perspective of the entity. We stick to the ERD modelling [standards](https://www.gleek.io/blog/crows-foot-notation.html) here. Cardinality affect the design of the client API (returning only single reference or collections) and also help us to protect the consistency of the data so that conforms to the creator mental model.
string entityType = 5
Reference to `Entity.type` of the referenced entity. Might be also any `String` that identifies type some external resource not maintained by Evita.
bool entityTypeRelatesToEntity = 6
Contains `true` if `entityType` refers to any existing entity that is maintained by Evita. Deprecated since 2024.10 - use referencedEntityTypeManaged instead
optional groupType = 7
Reference to `Entity.type` of the referenced entity. Might be also `String` that identifies type some external resource not maintained by Evita.
bool groupTypeRelatesToEntity = 8
Contains `true` if `groupType` refers to any existing entity that is maintained by Evita. Deprecated since 2024.10 - use referencedGroupTypeManaged instead
bool indexed = 9
Contains `true` if the index for this reference should be created and maintained allowing to filter by `reference_{reference name}_having` filtering constraints. Index is also required when reference is `faceted`. Do not mark reference as faceted unless you know that you'll need to filter/sort entities by this reference. Each indexed reference occupies (memory/disk) space in the form of index. When reference is not indexed, the entity cannot be looked up by reference attributes or relation existence itself, but the data can be fetched. Deprecated since 2024.12 - deprecated in favor of `indexedInScopes`
bool faceted = 10
Contains `true` if the statistics data for this reference should be maintained and this allowing to get `facetStatistics` for this reference or use `facet_{reference name}_inSet` filtering constraint. Do not mark reference as faceted unless you want it among `facetStatistics`. Each faceted reference occupies (memory/disk) space in the form of index. Reference that was marked as faceted is called Facet. Deprecated since 2024.12 - deprecated in favor of `facetedInScopes`
map<string, > attributes = 11
Attributes related to reference allows defining set of data that are fetched in bulk along with the entity body. Attributes may be indexed for fast filtering (`AttributeSchema.filterable`) or can be used to sort along (`AttributeSchema.filterable`). Attributes are not automatically indexed in order not to waste precious memory space for data that will never be used in search queries. Filtering in attributes is executed by using constraints like `and`, `not`, `attributeEquals`, `attributeContains` and many others. Sorting can be achieved with `attributeNatural` or others. Attributes are not recommended for bigger data as they are all loaded at once.
map<string, > sortableAttributeCompounds = 12
Contains index of definitions of all sortable attribute compounds defined in this schema.
repeated nameVariant = 13
Contains reference name converted to different naming conventions.
repeated entityTypeNameVariant = 14
Contains referenced entity name converted to different naming conventions (only for non-managed entities).
repeated groupTypeNameVariant = 15
Contains referenced group name converted to different naming conventions (only for non-managed entities).
bool referencedEntityTypeManaged = 16
Contains `true` if `entityType` refers to any existing entity that is maintained by Evita.
bool referencedGroupTypeManaged = 17
Contains `true` if `groupType` refers to any existing entity that is maintained by Evita.
optional reflectedReferenceName = 18
Name of the reflected reference of the target referencedEntityType(). The referenced entity must contain reference of such name and this reference must target the entity where the reflected reference is defined, and the target entity must be managed on both sides of the relation.
bool descriptionInherited = 19
Contains true if the description of the reflected reference is inherited from the target reference.
bool deprecationNoticeInherited = 20
Contains true if the deprecated flag of the reflected reference is inherited from the target reference.
bool cardinalityInherited = 21
Contains true if the cardinality of the reflected reference is inherited from the target reference.
bool facetedInherited = 22
Contains true if the faceted property settings of the reflected reference is inherited from the target reference.
GrpcAttributeInheritanceBehavior attributeInheritanceBehavior = 23
Contains true if the attributes of the reflected reference are inherited from the target reference.
repeated string attributeInheritanceFilter = 24
The array of attribute names that are inherited / excluded from inheritance based on the value of attributeInheritanceBehavior property.
bool indexedInherited = 25
Contains true if the indexed property settings of the reflected reference is inherited from the target reference.
repeated GrpcEntityScope indexedInScopes = 26
Contains `true` if the index for this reference should be created and maintained allowing to filter by `reference_{reference name}_having` filtering constraints. Index is also required when reference is `faceted`. Do not mark reference as faceted unless you know that you'll need to filter/sort entities by this reference. Each indexed reference occupies (memory/disk) space in the form of index. When reference is not indexed, the entity cannot be looked up by reference attributes or relation existence itself, but the data can be fetched. Deprecated since 2025.6 - deprecated in favor of `scopedIndexTypes`
repeated GrpcEntityScope facetedInScopes = 27
Contains `true` if the statistics data for this reference should be maintained and this allowing to get `facetStatistics` for this reference or use `facet_{reference name}_inSet` filtering constraint. Do not mark reference as faceted unless you want it among `facetStatistics`. Each faceted reference occupies (memory/disk) space in the form of index. Reference that was marked as faceted is called Facet.
repeated scopedIndexTypes = 28
Scoped reference index types that define both the scope and the type of index for the reference. This replaces the deprecated `indexedInScopes` field with more granular control over indexing.
repeated scopedIndexedComponents = 29
Scoped reference indexed components that specify which parts of a reference relationship (referenced entity, referenced group entity) are indexed per scope.
bool indexedComponentsInherited = 30
Contains true if the indexed components property settings of the reflected reference is inherited from the target reference.
repeated facetedPartially = 31
Per-scope expressions that narrow which entities participate in faceting.
repeated bucketed = 32
Per-scope bucketed histogram configurations defining index name and value expression.
repeated bucketedPartially = 33
Per-scope expressions that narrow which entities participate in bucketed histogram computation.
GrpcConflictResolutionOverride conflictResolutionOverride = 34
Contains the per-reference override of the conflict resolution granularity. Defaults to inherited (follow the resolved conflict resolution). On reflected references this is always inherited.
Remove associated data mutation will drop existing associatedData - ie.generates new version of the associated data with tombstone on it.
Used in:
string associatedDataName = 1
Unique name of the associatedData. Case-sensitive. Distinguishes one associated data item from another within single entity instance.
optional associatedDataLocale = 2
Contains locale in case the associatedData is locale specific.
Mutation is responsible for removing an existing `AssociatedDataSchema` in the `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
Used in:
string name = 1
Contains unique name of the model. Case-sensitive. Distinguishes one model item from another within single entity instance.
message
GrpcAttributeMutations.proto:56Remove attribute mutation will drop existing attribute - ie.generates new version of the attribute with tombstone on it.
Used in: ,
string attributeName = 1
Unique name of the attribute. Case-sensitive. Distinguishes one associated data item from another within single entity instance.
optional attributeLocale = 2
Contains locale in case the attribute is locale specific.
Mutation is responsible for removing an existing `AttributeSchema` in the `EntitySchema` or `GlobalAttributeSchema` in the `CatalogSchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
Used in: , ,
string name = 1
Name of the attribute the mutation is targeting.
message
GrpcEngineMutation.proto:52Mutation is responsible for removing an existing CatalogSchema.
Used in:
string catalogName = 1
Name of catalog schema to remove.
Mutation is responsible for removing an existing `EntitySchema`.
Used in: ,
string name = 1
Name of entity schema to remove.
message
GrpcEntityMutations.proto:16This mutation allows to remove `parent` from the `entity`.
Used in:
(message has no fields)
message
GrpcPriceMutations.proto:62This mutation allows to remove an existing `price` of the entity, identified by price ID, price list and currency.
Used in:
int32 priceId = 1
Contains identification of the price in the external systems. This id is expected to be used for the synchronization of the price in relation with the primary source of the prices. This id is used to uniquely find a price within same price list and currency and is mandatory.
string priceList = 2
Contains identification of the price list in the external system. Each price must reference a price list. Price list identification may refer to another Evita entity or may contain any external price list identification (for example id or unique name of the price list in the external system). Single entity is expected to have single price for the price list unless there is `validity` specified. In other words there is no sense to have multiple concurrently valid prices for the same entity that have roots in the same price list.
optional currency = 3
Identification of the currency. Three-letter form according to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
message
GrpcReferenceMutations.proto:100This mutation allows to remove group in the reference.
Used in:
string referenceName = 1
Unique identifier of the reference.
int32 referencePrimaryKey = 2
Primary key of the referenced entity. Might be also any integer that uniquely identifies some external resource not maintained by Evita.
int32 internalPrimaryKey = 3
internal PK is assigned by evitaDB engine and is used to uniquely identify the reference among other references. It is used when multiple references share same business key - entityType and primaryKey - but differ by other properties (fe. reference group or attributes). When a reference is created for the first time, internal id is set to a unique negative number that is not used by the server side, which assigns positive unique numbers to the references on first reference persistence. This allows distinguishing references that are not yet persisted from those that are already persistent. When standalone key is used: - negative number: means that the reference is new and hasn't been yet persisted - zero: means we don't know the internal PK - positive number: means that the reference is persistent and has been already stored in the database
message
GrpcReferenceMutations.proto:44This mutation allows to remove a reference from the entity.
Used in:
string referenceName = 1
Unique identifier of the reference.
int32 referencePrimaryKey = 2
Primary key of the referenced entity. Might be also any integer that uniquely identifies some external resource not maintained by Evita.
int32 internalPrimaryKey = 3
internal PK is assigned by evitaDB engine and is used to uniquely identify the reference among other references. It is used when multiple references share same business key - entityType and primaryKey - but differ by other properties (fe. reference group or attributes). When a reference is created for the first time, internal id is set to a unique negative number that is not used by the server side, which assigns positive unique numbers to the references on first reference persistence. This allows distinguishing references that are not yet persisted from those that are already persistent. When standalone key is used: - negative number: means that the reference is new and hasn't been yet persisted - zero: means we don't know the internal PK - positive number: means that the reference is persistent and has been already stored in the database
Mutation is responsible for removing an existing `ReferenceSchema` in the `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
Used in:
string name = 1
Name of the reference the mutation is targeting.
Mutation is responsible for removing an existing `SortableAttributeCompound` in the `EntitySchema` or `ReferenceSchema`.
Used in: ,
string name = 1
Name of the sortable attribute compound the mutation is targeting.
message
GrpcEvitaAPI.proto:92Request to rename a catalog.
Used as request type in: EvitaService.RenameCatalog, EvitaService.RenameCatalogWithProgress
string catalogName = 1
Name of the catalog to be renamed.
string newCatalogName = 2
New name of the catalog.
message
GrpcEvitaAPI.proto:106Request to replace a catalog.
Used as request type in: EvitaService.ReplaceCatalog, EvitaService.ReplaceCatalogWithProgress
string catalogNameToBeReplacedWith = 1
Name of the source catalog whose content takes over. After a successful replace, this name no longer exists - the catalog is consumed and its content is now served under `catalogNameToBeReplaced`. If the operation fails, the state of this catalog is unknown and must be treated as damaged.
string catalogNameToBeReplaced = 2
Name of the target catalog to replace. Its existing content is dropped and replaced by the content of `catalogNameToBeReplacedWith`, while the name itself is preserved and keeps serving requests under it. If the operation fails, this catalog is guaranteed to remain untouched.
message
GrpcEvitaManagementAPI.proto:353A single reserved keyword that cannot be used as a classifier of the given type (e.g. as an entity type, attribute name, or reference name) - client-side validation of user-supplied classifiers can use this list to reject collisions early, before the server does.
Used in:
GrpcClassifierType classifierType = 1
The kind of classifier this keyword is reserved against (e.g. entity type, attribute name).
string classifier = 2
The reserved keyword in its normalized (camelCase) form. A candidate classifier is considered colliding if it matches this value in any of evitaDB's supported naming conventions (camelCase, PascalCase, snake_case, UPPER_SNAKE_CASE, kebab-case), not just this exact form.
repeated string words = 3
The individual words `classifier` is composed of, used to detect a collision across the supported naming conventions regardless of separator or case.
message
GrpcEvitaManagementAPI.proto:180Response to a catalog restore request. Returned by both `RestoreCatalog` and `RestoreCatalogFromServerFile`.
Used as response type in: EvitaManagementService.RestoreCatalog, EvitaManagementService.RestoreCatalogFromServerFile
int64 read = 1
Total number of bytes read from the backup file (bytes). Only meaningful for `RestoreCatalog`, where it reports the cumulative size of the uploaded stream; always 0 for `RestoreCatalogFromServerFile`, which does not populate this field.
optional task = 3
The task tracking the restore operation; poll its status (`GetTaskStatus`) to observe restore progress.
message
GrpcEngineMutation.proto:22Mutation is responsible for restoring a CatalogSchema in INACTIVE state.
Used in:
string catalogName = 1
Name of catalog schema to restore.
message
GrpcEvitaDataTypes.proto:536uniqueness type associated with particular scope
Used in: , , , ,
GrpcEntityScope scope = 1
scope of entities where uniqueness is enforced
GrpcAttributeUniquenessType uniquenessType = 2
type of uniqueness
message
GrpcEvitaDataTypes.proto:602Message representing a per-scope expression that narrows which entities participate in bucketed histogram computation.
Used in: , , ,
GrpcEntityScope scope = 1
The scope in which the bucketed partially expression applies.
optional expression = 2
The expression that narrows which entities participate in bucketed histogram for this scope. When absent (not set), no partial bucketing filter is applied for this scope.
message
GrpcEvitaDataTypes.proto:569Message representing a per-scope expression that narrows which entities participate in faceting.
Used in: , , ,
GrpcEntityScope scope = 1
The scope in which the faceted partially expression applies.
optional expression = 2
The expression that narrows which entities participate in faceting for this scope. When absent (not set), no partial faceting filter is applied for this scope.
message
GrpcEvitaDataTypes.proto:544uniqueness type associated with particular scope
Used in: , , ,
GrpcEntityScope scope = 1
scope of entities where uniqueness is enforced
GrpcGlobalAttributeUniquenessType uniquenessType = 2
type of uniqueness
message
GrpcEvitaDataTypes.proto:579Message representing a per-scope bucketed histogram configuration that defines the index name and optional value expression computing the bucket value for each referenced entity.
Used in: , , ,
GrpcEntityScope scope = 1
The scope in which the bucketed histogram configuration applies.
string nameOfTheIndex = 2
The name identifying the histogram index.
repeated nameVariants = 3
Server-generated variants of nameOfTheIndex in different naming conventions. Populated only on schema output; ignored when present on mutation input.
optional valueExpression = 4
The expression computing the histogram bucket value for each referenced entity. When absent (not set), no value expression is defined for this scope.
optional assignedWhen = 5
Partition selector. Among references already eligible per the reference- or scope-level bucketedPartially gate, this expression decides whether the referenced entity is assigned to this specific histogram. Multiple histograms on the same reference may declare overlapping or disjoint predicates; overlap is allowed but means a record participates in every histogram whose predicate evaluates to true. When absent (not set), no per-histogram restriction applies and the histogram contains every referenced entity already eligible per the gate.
message
GrpcEvitaDataTypes.proto:552Message representing a scoped reference index type that combines scope and index type.
Used in: , , ,
GrpcEntityScope scope = 1
The scope in which the reference index type is applied.
GrpcReferenceIndexType indexType = 2
The type of index that should be created and maintained for the reference.
message
GrpcEvitaDataTypes.proto:561Message representing scoped reference indexed components that specify which parts of a reference relationship are indexed per scope.
Used in: , , ,
GrpcEntityScope scope = 1
The scope in which the indexed components configuration applies.
repeated GrpcReferenceIndexedComponents indexedComponents = 2
The reference components that should be indexed in the given scope.
message
GrpcEntity.proto:98Based on our experience we've designed following data model for handling entities in evitaDB. Model is rather complex but was designed to limit amount of data fetched from database and minimize an amount of data that are indexed and subject to search.
Used in: , , , , , , , , , , , , , , ,
string entityType = 1
Type of entity. Entity type is main sharding key - all data of entities with same type are stored in separated collections. Within the entity type entity is uniquely represented by primary key.
int32 primaryKey = 2
Unique Integer positive number representing the entity. Can be used for fast lookup for entity (entities). Primary key must be unique within the same entity type.
int32 version = 3
Contains version of this entity and gets increased with any entity type update. Allows to execute optimistic locking i.e. avoiding parallel modifications.
int32 schemaVersion = 4
Contains version of this entity schema and gets increased with any entity type update. Allows to execute optimistic locking i.e. avoiding parallel modifications.
optional parent = 5
Primary key of parent entity.
optional parentReference = 6
A parent entity reference with its parent hierarchy chain.
optional parentEntity = 7
A parent entity with its parent hierarchy chain.
map<string, > globalAttributes = 8
Contains global attributes.
map<string, > localizedAttributes = 9
Contains localized attributes.
repeated prices = 10
Prices allows defining set of prices of entity for complex filtering and ordering.
optional priceForSale = 11
Price for which the entity should be sold. This method can be used only when appropriate price related constraints are present so that `currency` and `priceList` priority can be extracted from the query. The moment is either extracted from the query as well (if present) or current date and time is used.
GrpcPriceInnerRecordHandling priceInnerRecordHandling = 12
Price inner record handling controls how prices that share same `inner entity id` will behave during filtering and sorting.
repeated references = 13
Returns a collection of References of this entity. The references represent relations to other evitaDB entities or external entities in different systems.
map<string, > globalAssociatedData = 14
Contains global associated data.
map<string, > localizedAssociatedData = 15
Contains localized associated data.
repeated locales = 16
Contains set of all locales that were used for localized attributes or associated data of this particular entity.
GrpcEntityScope scope = 17
Identifies scope where the entity resides (either live or archived scope).
map<string, > referenceOffsetAndLimits = 18
Contains total count of references per reference name. This may differ from count of provided references if pagination or strip was used in the input query.
map<string, > accompanyingPrices = 19
Contains prices that has been requested to be calculated beside the main price for sale.
optional priceForSaleMin = 20
Lowest selling price (or component price for `SUM` strategy) computed with the same currency / valid-in / price-list filters as `priceForSale`. Populated when the price-range-for-sale is available on the entity. The exact semantics depend on the price inner record handling strategy: - `NONE`: equal to `priceForSale`. - `LOWEST_PRICE`: equal to `priceForSale` (the cheapest per-inner-record selling price). - `SUM`: cheapest per-inner-record component price (`priceForSale` is the cumulated sum).
optional priceForSaleMax = 21
Highest selling price (or component price for `SUM` strategy) computed with the same currency / valid-in / price-list filters as `priceForSale`. Populated when the price-range-for-sale is available on the entity. The exact semantics depend on the price inner record handling strategy: - `NONE`: equal to `priceForSale`. - `LOWEST_PRICE`: most expensive per-inner-record selling price. - `SUM`: most expensive per-inner-record component price (`priceForSale` is the cumulated sum).
This enum is used to identify session type of the created session by gRPC server.
Used in:
READ_ONLY = 0
Classic read-only session.
READ_WRITE = 1
Classic read-write session.
BINARY_READ_ONLY = 2
Read only session that returns all fetched entities in a form of a `BinaryEntity`, which has all of its data represented in a binary form. Should be used only in combination with evitaDB's Java driver.
BINARY_READ_WRITE = 3
Read write session that returns all fetched entities in a form of a `BinaryEntity`, which has all of its data represented in a binary form. Should be used only in combination with evitaDB's Java driver.
Mutation is responsible for setting value to a `AssociatedDataSchema.conflictResolutionOverride` in `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
Used in:
string name = 1
Contains unique name of the model. Case-sensitive. Distinguishes one model item from another within single entity instance.
GrpcConflictResolutionOverride conflictResolutionOverride = 2
The per-associated-data override of the conflict resolution granularity.
Mutation is responsible for setting value to a `AssociatedDataSchema.localized` in `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
Used in:
string name = 1
Contains unique name of the model. Case-sensitive. Distinguishes one model item from another within single entity instance.
bool localized = 2
Localized associated data has to be ALWAYS used in connection with specific `locale`. In other words - it cannot be stored unless associated locale is also provided.
Mutation is responsible for setting value to a `AssociatedDataSchema.nullable` in `EntitySchema`. Mutation can be used for altering also the existing `AssociatedDataSchema` alone.
Used in:
string name = 1
Contains unique name of the model. Case-sensitive. Distinguishes one model item from another within single entity instance.
bool nullable = 2
When associated data is nullable, its values may be missing in the entities. Otherwise, the system will enforce non-null checks upon upserting of the entity.
Mutation is responsible for setting value to a `AttributeSchema.conflictResolutionOverride` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
Used in: , ,
string name = 1
Name of the attribute the mutation is targeting.
GrpcConflictResolutionOverride conflictResolutionOverride = 2
The per-attribute override of the conflict resolution granularity.
Mutation is responsible for setting value to a `AttributeSchema.filterable` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
Used in: , ,
string name = 1
Name of the attribute the mutation is targeting.
bool filterable = 2
When attribute is filterable, it is possible to filter entities by this attribute. Do not mark attribute as filterable unless you know that you'll search entities by this attribute. Each filterable attribute occupies (memory/disk) space in the form of index. Deprecated since 2024.12 - deprecated in favor of `filterableInScopes`
repeated GrpcEntityScope filterableInScopes = 3
When attribute is filterable, it is possible to filter entities by this attribute. Do not mark attribute as filterable unless you know that you'll search entities by this attribute. Each filterable attribute occupies (memory/disk) space in the form of index.
Mutation is responsible for setting value to a `GlobalAttributeSchema.uniqueGlobally` in `EntitySchema`. Mutation can be used for altering also the existing `GlobalAttributeSchema` alone.
Used in:
string name = 1
Name of the attribute the mutation is targeting.
GrpcGlobalAttributeUniquenessType uniqueGlobally = 2
When attribute is unique globally it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute in entire catalog. Deprecated since 2024.12 - deprecated in favor of `uniqueGloballyInScopes`
repeated uniqueGloballyInScopes = 15
When attribute is unique globally it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute in entire catalog.
Mutation is responsible for setting value to a `AttributeSchema.localized` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
Used in: , ,
string name = 1
Name of the attribute the mutation is targeting.
bool localized = 2
Localized attribute has to be ALWAYS used in connection with specific `locale`. In other words - it cannot be stored unless associated locale is also provided.
Mutation is responsible for setting value to a `AttributeSchema.nullable` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
Used in: , ,
string name = 1
Name of the attribute the mutation is targeting.
bool nullable = 2
When attribute is nullable, its values may be missing in the entities. Otherwise, the system will enforce non-null checks upon upserting of the entity.
Mutation is responsible for setting value to a `AttributeSchema.representative` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
Used in: , ,
string name = 1
Name of the attribute the mutation is targeting.
bool representative = 2
When attribute is representative, its values may be missing in the entities. Otherwise, the system will enforce non-null checks upon upserting of the entity.
Mutation is responsible for setting value to a `AttributeSchema.sortable` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
Used in: , ,
string name = 1
Name of the attribute the mutation is targeting.
bool sortable = 2
When attribute is sortable, it is possible to sort entities by this attribute. Do not mark attribute as sortable unless you know that you'll sort entities along this attribute. Each sortable attribute occupies (memory/disk) space in the form of index. Deprecated since 2024.12 - deprecated in favor of `sortableInScopes`
repeated GrpcEntityScope sortableInScopes = 3
When attribute is sortable, it is possible to sort entities by this attribute. Do not mark attribute as sortable unless you know that you'll sort entities along this attribute. Each sortable attribute occupies (memory/disk) space in the form of index.
Mutation is responsible for setting value to a `AttributeSchema.unique` in `EntitySchema`. Mutation can be used for altering also the existing `AttributeSchema` or `GlobalAttributeSchema` alone.
Used in: , ,
string name = 1
Name of the attribute the mutation is targeting.
GrpcAttributeUniquenessType unique = 2
When attribute is unique it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute among other entities in the same collection. Deprecated since 2024.12 - deprecated in favor of `uniqueInScopes`
repeated uniqueInScopes = 13
When attribute is unique it is automatically filterable, and it is ensured there is exactly one single entity having certain value of this attribute among other entities in the same collection.
message
GrpcEngineMutation.proto:58Mutation that sets the mutability state of a catalog.
Used in:
string catalogName = 1
Name of the catalog to modify.
bool mutable = 2
Whether the catalog should be mutable (read-write) or immutable (read-only).
message
GrpcEngineMutation.proto:74Mutation that sets the active state of a catalog.
Used in:
string catalogName = 1
Name of the catalog to modify.
bool active = 2
Whether the catalog should be active or inactive.
Mutation is responsible for setting a `EntitySchema.withGeneratedPrimaryKey` in `EntitySchema`.
Used in:
bool withGeneratedPrimaryKey = 1
Whether primary keys of entities of this type will not be provided by the external systems and Evita is responsible for generating unique primary keys for the entity on insertion. Generated key is guaranteed to be unique, but may not represent continuous ascending series. Generated key will be always greater than zero.
Mutation is responsible for setting a `EntitySchema.withHierarchy` in `EntitySchema`.
Used in:
bool withHierarchy = 1
Whether entities of this type are organized in a tree like structure (hierarchy) where certain entities are subordinate of other entities. Entities may be organized in hierarchical fashion. That means that entity may refer to single parent entity and may be referred by multiple child entities. Hierarchy is always composed of entities of same type. Each entity must be part of at most single hierarchy (tree). Hierarchy can limit returned entities by using filtering constraints `hierarchy_{reference name}_within`. It's also used for computation of extra data - such as `hierarchyParents`.
repeated GrpcEntityScope indexedInScopes = 2
Contains set of all scopes the entity is indexed in and can be used for filtering entities and computation of extra data. If the hierarchy information is not indexed, it is still available on the entity itself (i.e. entity can define its parent entity), but it is not possible to work with the hierarchy information in any other way (calculating parent chain, children, siblings, etc.).
Mutation is responsible for setting a `EntitySchema.withPrice` in `EntitySchema`.
Used in:
bool withPrice = 1
Whether entities of this type holds price information. Prices are specific to a very few entities, but because correct price computation is very complex in e-commerce systems and highly affects performance of the entities filtering and sorting, they deserve first class support in entity model. It is pretty common in B2B systems single product has assigned dozens of prices for the different customers. Specifying prices on entity allows usage of `priceValidIn`, `priceInCurrency` `priceBetween`, and `priceInPriceLists` filtering constraints and also price ordering of the entities. Additional requirements `priceHistogram` and `priceType` can be used in query as well.
int32 indexedPricePlaces = 2
Determines how many fractional places are important when entities are compared during filtering or sorting. It is important to know that all prices will be converted to `Integer`, so any of the price values (either with or without tax) must not ever exceed maximum limits of `Integer` type when scaling the number by the power of ten using `indexedPricePlaces` as exponent.
repeated GrpcEntityScope indexedInScopes = 3
Contains set of all scopes the price information is indexed in and can be used for filtering entities and computation of extra data. If the price information is not indexed, it is still available on the entity itself (i.e. entity can define its price), but it is not possible to work with the price information in any other way (calculating price histogram, filtering, sorting by price, etc.). Prices can be also set as non-indexed individually via the individual price's own `indexed` flag.
message
GrpcEntityMutations.proto:21This mutation allows to set scope of the entity to ARCHIVED or LIVE state.
Used in:
GrpcEntityScope scope = 1
The new scope of the entity.
message
GrpcEntityMutations.proto:10This mutation allows to set `parent` in the `entity`.
Used in:
int32 primaryKey = 1
Optional new primary key of parent entity. If null, this entity is at the root of hierarchy.
message
GrpcPriceMutations.proto:12This mutation allows to set / remove `priceInnerRecordHandling` behaviour of the entity.
Used in:
GrpcPriceInnerRecordHandling priceInnerRecordHandling = 1
Price inner record handling controls how prices that share same `inner entity id` will behave during filtering and sorting.
message
GrpcReferenceMutations.proto:69This mutation allows to create / update group of the reference.
Used in:
string referenceName = 1
Unique identifier of the reference.
int32 referencePrimaryKey = 2
Primary key of the referenced entity. Might be also any integer that uniquely identifies some external resource not maintained by Evita.
optional groupType = 3
Type of the referenced entity representing group. Might be also any `String` that identifies type in some external resource not maintained by Evita.
int32 groupPrimaryKey = 4
Primary key of the referenced entity representing group. Might be also any integer that uniquely identifies some external resource not maintained by Evita.
int32 internalPrimaryKey = 5
internal PK is assigned by evitaDB engine and is used to uniquely identify the reference among other references. It is used when multiple references share same business key - entityType and primaryKey - but differ by other properties (fe. reference group or attributes). When a reference is created for the first time, internal id is set to a unique negative number that is not used by the server side, which assigns positive unique numbers to the references on first reference persistence. This allows distinguishing references that are not yet persisted from those that are already persistent. When standalone key is used: - negative number: means that the reference is new and hasn't been yet persisted - zero: means we don't know the internal PK - positive number: means that the reference is persistent and has been already stored in the database
Mutation is responsible for setting bucketed histogram configuration on a `ReferenceSchema` in `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
Used in:
string name = 1
Name of the reference the mutation is targeting.
repeated bucketedInScopes = 2
Per-scope bucketed histogram configurations defining index name and value expression.
repeated bucketedPartially = 3
Per-scope expressions that narrow which entities participate in bucketed histogram computation.
Mutation is responsible for setting value to a `ReferenceSchema.conflictResolutionOverride` in `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
Used in:
string name = 1
Name of the reference the mutation is targeting.
GrpcConflictResolutionOverride conflictResolutionOverride = 2
The per-reference override of the conflict resolution granularity.
Mutation is responsible for setting value to a `ReferenceSchema.faceted in `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
Used in:
string name = 1
Name of the reference the mutation is targeting.
bool faceted = 2
Whether the statistics data for this reference should be maintained and this allowing to get `referenceSummary` for this reference or use `facet_{reference name}_inSet` filtering query. Do not mark reference as faceted unless you want it among `FacetStatistics`. Each faceted reference occupies (memory/disk) space in the form of index. Reference that was marked as faceted is called Facet. Deprecated since 2024.12 - deprecated in favor of `facetedInScopes`
bool inherited = 3
Set to true when the faceted property should be inherited from the original. This property makes sense only for inherited reference attributes on reflected reference. For all other cases it must be left as false. When set to TRUE the value of `faceted` field is ignored.
repeated GrpcEntityScope facetedInScopes = 4
Whether the statistics data for this reference should be maintained and this allowing to get `referenceSummary` for this reference or use `facet_{reference name}_inSet` filtering query. Do not mark reference as faceted unless you want it among `FacetStatistics`. Each faceted reference occupies (memory/disk) space in the form of index. Reference that was marked as faceted is called Facet.
repeated facetedPartially = 5
Per-scope expressions that narrow which entities participate in faceting. When absent (not set), expressions are inherited for reflected references.
Mutation is responsible for setting value to a `ReferenceSchema.indexed` in `EntitySchema`. Mutation can be used for altering also the existing `ReferenceSchema` alone.
Used in:
string name = 1
Name of the reference the mutation is targeting.
bool inherited = 2
Set to true when the filterable property should be inherited from the original. This property makes sense only for inherited reference attributes on reflected reference. For all other cases it must be left as false. When set to TRUE the value of `filterable` field is ignored.
repeated GrpcEntityScope indexedInScopes = 3
Whether the index for this reference should be created and maintained allowing to filter by `referenceHaving` filtering constraints. Index is also required when reference is `faceted`. Do not mark reference as faceted unless you know that you'll need to filter / sort entities by this reference. Each indexed reference occupies (memory/disk) space in the form of index. When reference is not indexed, the entity cannot be looked up by reference attributes or relation existence itself, but the data is loaded alongside other references if requested. Deprecated since 2025.6 - deprecated in favor of `scopedIndexTypes`
repeated scopedIndexTypes = 4
Scoped reference index types that define both the scope and the type of index for the reference. This replaces the deprecated `indexedInScopes` field with more granular control over indexing. When `inherited` is true, this field is ignored.
repeated scopedIndexedComponents = 5
Scoped reference indexed components that specify which parts of a reference relationship (referenced entity, referenced group entity) are indexed per scope. When `inherited` is true, this field is ignored.
Mutation is responsible for setting set of scopes for indexing value in a `SortableAttributeCompoundSchema` in `EntitySchema`.
Used in: ,
string name = 1
Name of the sortable attribute compound the mutation is targeting.
repeated GrpcEntityScope indexedInScopes = 2
When attribute sortable compound is indexed, it is possible to sort entities by this calculated attribute compound. This property contains set of all scopes this attribute compound is indexed in.
message
GrpcEntitySchema.proto:451Sortable attribute compounds are used to sort entities or references by multiple attributes at once. evitaDB requires a pre-sorted index in order to be able to sort entities or references by particular attribute or combination of attributes, so it can deliver the results as fast as possible. Sortable attribute compounds are filtered the same way as attributes - using natural ordering constraint.
Used in: ,
string name = 1
Contains unique name of the model. Case-sensitive. Distinguishes one model item from another within single entity instance.
optional description = 2
Contains description of the model is optional but helps authors of the schema / client API to better explain the original purpose of the model to the consumers.
optional deprecationNotice = 3
Deprecation notice contains information about planned removal of this entity from the model / client API. This allows to plan and evolve the schema allowing clients to adapt early to planned breaking changes. If notice is `null`, this schema is considered not deprecated.
repeated attributeElements = 4
Collection of attribute elements that define the sortable compound. The order of the elements is important, as it defines the order of the sorting.
repeated nameVariant = 5
Contains attribute compound name converted to different naming conventions.
bool inherited = 6
Contains true if the attribute was inherited from the original object via reflected reference relation
repeated GrpcEntityScope indexedInScopes = 7
When attribute sortable compound is indexed, it is possible to sort entities by this calculated attribute compound. This property contains set of all scopes this attribute compound is indexed in.
Mutation of a sortable attribute compound schema.
Used in:
oneof mutation
Type of the mutation. Exactly one of the following must be set.
createSortableAttributeCompoundSchemaMutation = 1
Mutation is responsible for setting up a new `SortableAttributeCompoundSchema` in the `EntitySchema`.
modifySortableAttributeCompoundSchemaDeprecationNoticeMutation = 2
Mutation is responsible for modifying a deprecation notice of an existing `SortableAttributeCompoundSchema` in the `EntitySchema`.
modifySortableAttributeCompoundSchemaDescriptionMutation = 3
Mutation is responsible for modifying a description of an existing `SortableAttributeCompoundSchema` in the `EntitySchema`.
modifySortableAttributeCompoundSchemaNameMutation = 4
Mutation is responsible for renaming an existing `SortableAttributeCompoundSchema` in the `EntitySchema`.
removeSortableAttributeCompoundSchemaMutation = 5
Mutation is responsible for removing an existing `SortableAttributeCompoundSchema` in the `EntitySchema`.
setSortableAttributeCompoundIndexedMutation = 6
Mutation is responsible for setting value `SortableAttributeCompoundSchema.indexedInScopes` in the `EntitySchema`.
The enum specifies whether the hierarchy statistics cardinality will be based on a complete query filter by constraint or only the part without user defined filter.
Used in: ,
COMPLETE_FILTER = 0
Complete `filterBy` constraint output will be considered when calculating statistics of the queried entities.
WITHOUT_USER_FILTER = 1
Contents of the `filterBy` excluding `userFilter` and its children will be considered when calculating statistics of the queried entities.
COMPLETE_FILTER_EXCLUDING_SELF_IN_USER_FILTER = 2
Complete `filterBy` constraint output excluding constraints within `userFilter` limiting references of the same hierarchical entity type this constraint is applied to will be considered when calculating statistics of the queried entities.
message
GrpcEvitaDataTypes.proto:252Wrapper for representing an array of StatisticsBase enums.
Used in:
repeated GrpcStatisticsBase value = 1
The individual StatisticsBase values, in their original order.
The enum specifies whether the HierarchyStatistics should produce the hierarchy children count or referenced entity count.
Used in: ,
CHILDREN_COUNT = 0
The statistics will be produce a hierarchy children count.
QUERIED_ENTITY_COUNT = 1
The statistics will be produce a reference entity count.
message
GrpcEvitaDataTypes.proto:258Wrapper for representing an array of StatisticsType enums.
Used in:
repeated GrpcStatisticsType value = 1
The individual StatisticsType values, in their original order.
message
GrpcEvitaDataTypes.proto:129Wrapper for representing an array of strings. Also used to carry a Character array — each element is then a single-character string; which Java array type applies is determined by the accompanying GrpcEvitaDataType (STRING_ARRAY vs CHARACTER_ARRAY).
Used in: ,
repeated string value = 1
The individual string (or, for a character array, single-character) elements, in their original order.
message
GrpcEvitaSessionAPI.proto:425Strip/offset-based pagination descriptor for a `GrpcDataChunk` - the alternative to `GrpcPaginatedList` used when the query's `require` block specifies a `strip()` requirement instead of `page()`.
Used in:
int32 limit = 1
Maximum number of records returned in this strip.
int32 offset = 2
Number of records skipped from the beginning of the result set before this strip starts. 0-indexed: an offset of 0 starts at the very first record - unlike `GrpcPaginatedList.pageNumber`, this is not a page number.
Area covered by the system CDC capture. Deliberately separate from GrpcChangeCaptureArea because the system stream has no SCHEMA/DATA semantics. The zero value SYSTEM_AREA_UNSPECIFIED encodes "no area set" / null on the domain side so proto3's default-value semantics do not collapse a null criterion into ENGINE. See issue #1151 for the rationale.
Used in:
SYSTEM_AREA_UNSPECIFIED = 0
Sentinel for an absent area — domain `null` round-trips through this value rather than collapsing into ENGINE because of proto3 default-value semantics.
SYSTEM_AREA_ENGINE = 1
Engine mutations (durable, WAL-replicated).
SYSTEM_AREA_HOST = 2
Host events (HostSystemEvent - non-replicable, live-tail-only).
State aggregates the possible states of a task into a simple enumeration.
Used in: ,
TASK_QUEUED = 0
* Task is waiting in the queue to be executed.
TASK_RUNNING = 1
* Task is currently running.
TASK_FINISHED = 2
* Task has finished successfully.
TASK_FAILED = 3
* Task has failed.
TASK_WAITING_FOR_PRECONDITION = 4
* Task is waiting for precondition to be satisfied.
message
GrpcEvitaDataTypes.proto:436Record representing status of particular asynchronous task
Used in: , , , , , , ,
string taskType = 1
Type of the task (shortName of the task) Available tasks: - "BackupTask": Task responsible for backing up the catalog data and WAL files into a ZIP file. - "RestoreTask": This task is used to restore a catalog from a ZIP file. - "JfrRecorderTask": Task is responsible for recording selected JFR events into an exportable file. - "MetricTask": Task that listens for JFR events and transforms them into Prometheus metrics.
string taskName = 2
Longer, human-readable name of the task
optional taskId = 3
Unique identifier of this task instance; use it to reference this task in status lookups or cancellation requests.
optional catalogName = 4
Name of the catalog this task operates on. Unset for tasks that are not scoped to a single catalog (e.g. server-wide/system tasks).
optional issued = 5
Date and time when the task was issued for execution (queued to run). Unset while the task is still pending and has not yet been issued.
optional started = 6
Date and time when the task started executing. Unset before execution begins.
optional finished = 7
Date and time when the task finished executing, successfully or with an error. Unset while the task is still running.
GrpcTaskSimplifiedState simplifiedState = 8
Coarse-grained lifecycle state of the task (queued, running, finished or failed), derived from the task's more detailed internal state.
int32 progress = 9
Progress of the task (0-100)
optional settings = 10
String representation (`toString()`) of the task's configuration settings. Read back as an empty string if unset.
oneof result
The task's result, once it has produced one. At most one of these is set; neither is set while the task has not finished or produced no result.
text = 11
String representation (`toString()`) of the task's result object, used for any result other than a fetchable file.
file = 12
The file produced by the task (e.g. a backup archive), available for fetching by `fileId`.
optional exception = 13
Public-safe error message if the task failed. Unset while the task is running or if it completed without error.
repeated GrpcTaskTrait trait = 14
Capabilities available for this task instance (e.g. whether it can be manually started, cancelled, or must be explicitly stopped).
optional created = 15
Date and time when this task status record was created; always set, and precedes `issued`.
Enum describes traits of a GrpcTask task.
Used in:
TASK_CAN_BE_STARTED = 0
* Task can be manually started by the user.
TASK_CAN_BE_CANCELLED = 1
* Task can be manually cancelled by the user.
TASK_NEEDS_TO_BE_STOPPED = 2
* Task needs to be manually stopped by the user (otherwise it will run indefinitely).
Enum represents time flow direction for time-based filtering.
Used in:
AFTER = 0
Time flows forward - from past to future.
BEFORE = 1
Time flows backward - from future to past.
message
GrpcTrafficRecording.proto:120This container holds information about single entity enrichment.
Used in:
string query = 1
The query operation associated with enrichment.
int32 primaryKey = 2
The primary key of the enriched record
message
GrpcTrafficRecording.proto:128This container holds information about single entity fetch.
Used in:
string query = 1
The query operation associated with entity fetch.
int32 primaryKey = 2
The primary key of the fetched record
message
GrpcTrafficRecording.proto:94This container holds a mutation and its metadata.
Used in:
oneof mutation
The mutation operation; exactly one of the following is set.
entityMutation = 1
The entity mutation operation.
schemaMutation = 2
The schema mutation operation.
message
GrpcTrafficRecording.proto:105Container for a query and its metadata.
Used in:
string queryDescription = 1
The shortened description of the query and its purpose
string query = 2
The query operation.
int32 totalRecordCount = 3
The total number of records calculated by the query.
repeated int32 primaryKeys = 4
The primary keys of the records returned by the query (in returned data chunk). I.e. number of records actually returned by the pagination requirement of the query.
repeated labels = 5
The client labels associated with the query.
message
GrpcTrafficRecording.proto:44Record represents a CDC event that is sent to the subscriber if it matches to the request he made.
Used in: ,
int64 sessionSequenceOrder = 1
The sequence order of the session (analogous to sessionId, but monotonic sequence based on location in the log).
optional sessionId = 2
The session id which the recording belongs to.
int32 recordSessionOffset = 3
The order (sequence) of the traffic recording in the session. First record in the session has sequence ID 0 and represents the session start, additional records are numbered sequentially.
int32 sessionRecordsCount = 4
Total count of the records in the session. This number allows clients to determine whether the recordSessionOffset is the last record in the session (i.e. when recordSessionOffset = recordsInSession - 1, then it is the last record).
GrpcTrafficRecordingType type = 5
The type of the recording.
optional created = 6
The time when the recording was created.
int32 durationInMilliseconds = 7
The duration of the operation in milliseconds.
int32 ioFetchedSizeBytes = 8
The size of the data fetched from the permanent storage in bytes.
int32 ioFetchCount = 9
The number of objects fetched from the permanent storage.
optional finishedWithError = 10
The error message the operation this record represents finished with. If unset, the operation completed without error.
oneof body
The body of the traffic recording, present only when body content was requested via the capture criteria's `content` field (`TRAFFIC_RECORDING_BODY`); entirely absent when only headers were requested (`TRAFFIC_RECORDING_HEADER`). When present, exactly one of the following members is set, matching this record's `type`.
mutation = 101
Present when `type` is `TRAFFIC_RECORDING_MUTATION` - the entity or schema mutation that was executed.
query = 102
Present when `type` is `TRAFFIC_RECORDING_QUERY` - the internal evitaDB query (evitaQL) that was executed.
enrichment = 103
Present when `type` is `TRAFFIC_RECORDING_ENRICHMENT` - the entity enrichment call that was executed.
fetch = 104
Present when `type` is `TRAFFIC_RECORDING_FETCH` - the single entity fetch call that was executed.
sessionClose = 105
Present when `type` is `TRAFFIC_RECORDING_SESSION_FINISH` - statistics collected over the closed session.
sessionStart = 106
Present when `type` is `TRAFFIC_RECORDING_SESSION_START` - metadata about the newly opened session.
sourceQuery = 107
Present when `type` is `TRAFFIC_RECORDING_SOURCE_QUERY` - the raw, unparsed query as received from the client.
sourceQueryStatistics = 108
Present when `type` is `TRAFFIC_RECORDING_SOURCE_QUERY_STATISTICS` - statistics aggregated over all operations related to a single source query.
message
GrpcTrafficRecording.proto:14Record for the criteria of the capture request allowing to limit mutations to specific area of interest and its properties.
Used in: ,
GrpcTrafficRecordingContent content = 1
Determines whether only basic information about the traffic recording is returned, or the actual event content as well (see the `body` oneof on `GrpcTrafficRecord`).
optional since = 2
The lower time bound (inclusive) for returned traffic records. If unset, no time-based lower bound is applied.
optional sinceSessionSequenceId = 3
The session sequence ID (see `GrpcTrafficRecord#sessionSequenceOrder`) from which the traffic recording should be returned (inclusive). If unset, no session-sequence lower bound is applied.
optional sinceRecordSessionOffset = 4
The record offset within the session identified by `sinceSessionSequenceId` from which the traffic recording should be returned (the offset is relative to the session sequence ID and starts from 0); allows continuing to fetch a session's traffic recording from the last fetched record when the session was not fully fetched in a previous call. If unset, records are returned from the start of the session.
repeated GrpcTrafficRecordingType type = 5
The types of traffic recording to be returned. If empty, records of all types are returned.
repeated sessionId = 6
The session IDs to limit the returned traffic recording to. If empty, records from all sessions are considered.
optional longerThanMilliseconds = 7
The minimum duration (milliseconds) the traffic recording operation must have taken to be returned. If unset, no minimum-duration filter is applied.
optional fetchingMoreBytesThan = 8
The minimum number of bytes the record must have fetched from the permanent storage to be returned. If unset, no minimum-size filter is applied.
repeated labels = 9
The client labels the traffic recording must have (both name and value must match). If empty, no label filter is applied.
Enum to specify the depth of details sent in the traffic recording event.
Used in:
TRAFFIC_RECORDING_HEADER = 0
Only the header of the event is sent.
TRAFFIC_RECORDING_BODY = 1
Entire traffic recording content is sent.
List of all possible traffic recording types.
Used in: ,
TRAFFIC_RECORDING_SESSION_START = 0
evitaDB session opened.
TRAFFIC_RECORDING_SESSION_FINISH = 1
evitaDB session closed.
TRAFFIC_RECORDING_SOURCE_QUERY = 2
Query received via. API from the client - container contains original string of the client query. API might call multiple queries related to the same source query.
TRAFFIC_RECORDING_SOURCE_QUERY_STATISTICS = 3
Query received via. API from the client is finalized and sent to the client. Container contains the final statistics aggregated over all operations related to the source query.
TRAFFIC_RECORDING_QUERY = 4
Internal evitaDB query (evitaQL) was executed.
TRAFFIC_RECORDING_FETCH = 5
Internal call to retrieve single evitaDB entity. Record is not created for entities fetched as a part of a query.
TRAFFIC_RECORDING_ENRICHMENT = 6
Internal call to enrich contents of the evitaDB entity.
TRAFFIC_RECORDING_MUTATION = 7
Internal call to mutate the evitaDB entity or catalog schema.
message
GrpcTrafficRecording.proto:142This container holds information about the session close.
Used in:
int64 catalogVersion = 1
The version of the catalog
int32 trafficRecordCount = 2
The overall number of traffic records recorded for this session.
int32 queryCount = 3
The overall number of queries executed in this session.
int32 entityFetchCount = 4
The overall number of entities fetched in this session (excluding the entities fetched by queries).
int32 mutationCount = 5
The overall number of mutations executed in this session.
int32 trafficRecordsMissedOut = 6
The number of traffic records that were missed due to buffer overflow.
message
GrpcTrafficRecording.proto:136This container holds information about the session start.
Used in:
int64 catalogVersion = 1
The version of the catalog that will be used for the entire session.
message
GrpcTrafficRecording.proto:158This container holds information about the source query.
Used in:
optional sourceQueryId = 1
The unique identifier of the source query
string sourceQuery = 2
unparsed, raw source query in particular format
repeated labels = 3
The automatic labels associated with the query.
message
GrpcTrafficRecording.proto:168This container holds information about the source query statistics.
Used in:
optional sourceQueryId = 1
The source query id
int32 returnedRecordCount = 2
The number of records actually returned by the query, i.e. the size of the fetched data chunk after pagination.
int32 totalRecordCount = 3
The total number of records matching the query, before pagination is applied.
message
GrpcEvitaSessionAPI.proto:247Structure that holds changes within a transaction.
Used in:
int32 catalogSchemaChangeCount = 3
The number of catalog schema changes within the transaction.
int32 mutationCount = 4
The number of mutations within the transaction.
int64 walSizeInBytes = 5
The size of the write-ahead log (WAL) in bytes for the transaction.
repeated entityCollectionChanges = 6
The collection of entity collection changes within the transaction.
This transaction mutation delimits mutations of one transaction from another. It contains data that allow to recognize the scope of the transaction and verify its integrity.
Used in: ,
optional transactionId = 1
Represents the unique identifier of a transaction.
int64 version = 2
Represents the next version the transaction transitions the state to.
int32 mutationCount = 3
Represents the number of mutations in this particular transaction.
int64 walSizeInBytes = 4
Represents the size of the serialized transaction mutations that follow this mutation in bytes.
optional commitTimestamp = 5
Represents the timestamp of the commit.
message
GrpcEvitaSessionAPI.proto:228Structure that holds overview of a specific transaction.
Used in:
int64 catalogVersion = 1
The version of the catalog that the transaction moved to.
optional transactionId = 2
The id of the transaction.
optional commitTimestamp = 3
The commit timestamp of the transaction.
optional processedTimestamp = 4
The timestamp when the transaction was processed.
int64 processingLagInMillis = 5
The processing lag of the transaction in milliseconds (i.e. duration between commit timestamp and the real shared view incorporation).
bool reversible = 6
The flag indicates whether point-in-time recovery to this version is possible.
repeated transactionChanges = 7
The collection of changes within the transaction.
Contains set of all possible transaction phases each transaction goes through.
Used in:
CONFLICTS_RESOLVED = 0
All changes passed conflict resolution steps and are not in conflict with other transactions.
WAL_PERSISTED = 1
Changes are written to Write Ahead Log (WAL) and are safely persisted on disk. Client might rely on the fact that the changes will eventually be visible in the database.
CHANGES_VISIBLE = 2
Changes are visible in shared state of the database and are available to all newly created sessions.
Enum defines the two modes of traversing a hierarchy when using the `traverseByEntityProperty` ordering constraint.
Used in:
DEPTH_FIRST = 0
The depth-first traversal mode traverses the hierarchy in a depth-first manner, meaning it will explore as far as possible along each branch before backtracking.
BREADTH_FIRST = 1
The breadth-first traversal mode traverses the hierarchy in a breadth-first manner, meaning it will explore all the nodes at the present depth level before moving on to the nodes at the next depth level.
message
GrpcEvitaSessionAPI.proto:323Request for updating the catalog schema.
Used as request type in: EvitaSessionService.UpdateAndFetchCatalogSchema, EvitaSessionService.UpdateCatalogSchema
repeated schemaMutations = 1
Collection of local catalog schema mutations to be applied.
message
GrpcEvitaSessionAPI.proto:354Request for updating the schema of an existing entity type.
Used as request type in: EvitaSessionService.UpdateAndFetchEntitySchema, EvitaSessionService.UpdateEntitySchema
optional schemaMutation = 1
Wrapper that holds the entity type and the collection of EntitySchemaMutations to be applied.
message
GrpcEngineMutation.proto:93Mutation that upgrades a catalog's on-disk storage protocol from `fromProtocolVersion` to `toProtocolVersion`. Drives the state transitions `OUT_OF_DATE` → `BEING_UPGRADED` → prior operational state and serves as the WAL-backed record of the per-catalog lazy format upgrade.
Used in:
string catalogName = 1
Name of the catalog whose storage protocol is being upgraded.
int32 fromProtocolVersion = 2
Storage protocol version currently present on disk (captured for observability).
int32 toProtocolVersion = 3
Storage protocol version to upgrade to, typically the engine's current `STORAGE_PROTOCOL_VERSION` (captured for observability).
Upsert associatedData mutation will either update existing associatedData or create new one.
Used in:
string associatedDataName = 1
Unique name of the associatedData. Case-sensitive. Distinguishes one associated data item from another within single entity instance.
optional associatedDataLocale = 2
Contains locale in case the associatedData is locale specific.
optional associatedDataValue = 3
New value of this associated data. Data type is expected to be the same as in schema or must be explicitly set via `valueType`.
message
GrpcAttributeMutations.proto:43Upsert attribute mutation will either update existing attribute or create new one.
Used in: ,
string attributeName = 1
Unique name of the attribute. Case-sensitive. Distinguishes one associated data item from another within single entity instance.
optional attributeLocale = 2
Contains locale in case the attribute is locale specific.
optional attributeValue = 3
New value of this attribute. Data type is expected to be the same as in schema or must be explicitly set via `valueType`.
message
GrpcPriceMutations.proto:18This mutation allows to create / update `price` of the entity.
Used in:
int32 priceId = 1
Contains identification of the price in the external systems. This id is expected to be used for the synchronization of the price in relation with the primary source of the prices. This id is used to uniquely find a price within same price list and currency and is mandatory.
string priceList = 2
Contains identification of the price list in the external system. Each price must reference a price list. Price list identification may refer to another Evita entity or may contain any external price list identification (for example id or unique name of the price list in the external system). Single entity is expected to have single price for the price list unless there is `validity` specified. In other words there is no sense to have multiple concurrently valid prices for the same entity that have roots in the same price list.
optional currency = 3
Identification of the currency. Three-letter form according to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
optional innerRecordId = 4
Some special products (such as master products, or product sets) may contain prices of all "subordinate" products so that the aggregating product can represent them in certain views on the product. In that case there is need to distinguish the projected prices of the subordinate product in the one that represents them. Inner record id must contain positive value.
optional priceWithoutTax = 5
Price without tax.
optional taxRate = 6
Tax rate percentage (i.e. for 19% it'll be 19.00)
optional priceWithTax = 7
Price with tax.
optional validity = 8
Date and time interval for which the price is valid (inclusive).
bool sellable = 9
Controls whether price is subject to filtering / sorting logic, non-sellable prices will be fetched along with entity but won't be considered when evaluating search query. These prices may be used for "informational" prices such as reference price (the crossed out price often found on e-commerce sites as "usual price") but are not considered as the "selling" price. Deprecated since 2024.10 - RENAMED TO "indexed"
bool indexed = 10
Controls whether price is subject to filtering / sorting logic, non-indexed prices will be fetched along with entity but won't be considered when evaluating search query. These prices may be used for "informational" prices such as reference price (the crossed out price often found on e-commerce sites as "usual price") but are not considered as the "selling" price.
Mutation is responsible for introducing a `GlobalAttributeSchema` into an `EvitaSession`.
Used in: ,
string name = 1
Name of the attribute the mutation is targeting.
message
GrpcEvitaDataTypes.proto:87Structure for representing UUID objects.
Used in: , , , , , , , , , , , , , , , , , , , , , , ,
int64 mostSignificantBits = 1
The most significant 64 bits of the UUID, as returned by `UUID#getMostSignificantBits()`.
int64 leastSignificantBits = 2
The least significant 64 bits of the UUID, as returned by `UUID#getLeastSignificantBits()`.
message
GrpcEvitaDataTypes.proto:210Wrapper for representing an array of UUIDs.
Used in:
repeated value = 1
The individual UUID elements, in their original order.