package ikvschemas

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc healthCheck (google.protobuf.Empty, HealthCheckResponse)

  services.proto:32

  message HealthCheckResponse

  services.proto:43

  • int32 code = 1

    health status <-> code value mapping is defined in AWS ALB health check settings.

• rpc helloWorld (HelloWorldRequest, HelloWorldResponse)

  services.proto:13

  message HelloWorldRequest

  services.proto:35

  • string echo = 1

  message HelloWorldResponse

  services.proto:39

  • string echo = 1

• rpc upsertFieldValues (UpsertFieldValuesRequest, Status)

  services.proto:16

  Write methods

  message UpsertFieldValuesRequest

  services.proto:50

  • optional UserStoreContextInitializer userStoreContextInitializer = 1

  • optional google.protobuf.Timestamp timestamp = 2

  • optional IKVDocumentOnWire document = 3

• rpc batchUpsertFieldValues (BatchUpsertFieldValuesRequest, Status)

  services.proto:17

  message BatchUpsertFieldValuesRequest

  services.proto:56

  • optional UserStoreContextInitializer userStoreContextInitializer = 1

  • optional google.protobuf.Timestamp timestamp = 2

  • repeated IKVDocumentOnWire documents = 3

• rpc deleteFieldValues (DeleteFieldValueRequest, Status)

  services.proto:19

  message DeleteFieldValueRequest

  services.proto:63

  Delete fields from a document.

  • optional UserStoreContextInitializer userStoreContextInitializer = 1

  • optional google.protobuf.Timestamp timestamp = 2

  • optional IKVDocumentOnWire documentId = 3

  • repeated string fieldNames = 4

• rpc batchDeleteFieldValues (BatchDeleteFieldValuesRequest, Status)

  services.proto:20

  message BatchDeleteFieldValuesRequest

  services.proto:71

  Delete fields from a batch of documents.

  • optional UserStoreContextInitializer userStoreContextInitializer = 1

  • optional google.protobuf.Timestamp timestamp = 2

  • repeated IKVDocumentOnWire documentIds = 3

  • repeated string fieldNames = 4

• rpc deleteDocument (DeleteDocumentRequest, Status)

  services.proto:22

  message DeleteDocumentRequest

  services.proto:79

  Delete a document.

  • optional UserStoreContextInitializer userStoreContextInitializer = 1

  • optional google.protobuf.Timestamp timestamp = 2

  • optional IKVDocumentOnWire documentId = 3

• rpc batchDeleteDocuments (BatchDeleteDocumentsRequest, Status)

  services.proto:23

  message BatchDeleteDocumentsRequest

  services.proto:86

  Delete a batch of documents.

  • optional UserStoreContextInitializer userStoreContextInitializer = 1

  • optional google.protobuf.Timestamp timestamp = 2

  • repeated IKVDocumentOnWire documentIds = 3

• rpc dropFields (DropFieldsRequest, Status)

  services.proto:25

  message DropFieldsRequest

  services.proto:93

  Drop (delete) field(s) from all documents or all documents.

  • optional UserStoreContextInitializer userStoreContextInitializer = 1

  • optional google.protobuf.Timestamp timestamp = 2

  • repeated string field_names = 3

    Attempts to delete primary-key will be ignored. No-op if the fields don't exist.

  • repeated string field_name_prefixes = 4

  • bool drop_all = 5

    drop all data

• rpc getUserStoreConfig (GetUserStoreConfigRequest, GetUserStoreConfigResponse)

  services.proto:28

  Gateway-specified configuration

  message GetUserStoreConfigRequest

  services.proto:119

  • optional UserStoreContextInitializer userStoreContextInitializer = 1

  message GetUserStoreConfigResponse

  services.proto:123

  • optional IKVStoreConfig globalConfig = 1

Used in: UserStoreContextInitializer

• string accountId = 1

• string accountPasskey = 2

/ Index level headers and metadata.

• uint64 base_index_epoch_millis = 1

  / Epoch (~ build time) of the current base index.

• uint64 mmap_write_offset = 1

  defaults to 0

Used in: OffsetTableEntry

• bytes primary_key = 1

Used in: OffsetTableEntry

• bytes primary_key = 1

• repeated uint32 field_ids = 2

Delete specified document.

Used in: IKVDataEvent

• optional IKVDocumentOnWire documentId = 1

Delete specified fields for specified document.

Used in: IKVDataEvent

• optional IKVDocumentOnWire documentId = 1

• repeated string fieldsToDelete = 2

Drop (delete) field(s) from all documents. No-op if the fields don't exist. Attempts to delete primary-key will be ignored.

Used in: IKVDataEvent

• repeated string field_names = 1

  field name list (exact match required)

• repeated string field_name_prefixes = 2

  field name prefix list (exact match required)

• bool drop_all = 3

  CAUTION! drops all except primary-key Only checked if field_names and field_name_prefixes are empty set to false when not populated by proto3

Used in: IKVDataEvent

• optional google.protobuf.Timestamp sourceTimestamp = 1

TODO: inspect TO BE DEPRECATED

• string name = 1

  the case-sensitive field name

• int32 id = 2

  unique field-id. `name` and `id` have 1:1 mappings.

• FieldType fieldType = 3

Used in: FieldSchema, FieldValue

• UNKNOWN = 0

  usually signifies writer/producer is ahead w.r.t the symbol list

• INT32 = 1

• INT64 = 2

• FLOAT32 = 3

• FLOAT64 = 4

• STRING = 5

• BYTES = 6

• BOOLEAN = 7

Used in: IKVDocumentOnWire

• FieldType fieldType = 1

• bytes value = 2

• optional EventHeader eventHeader = 1

• oneof event

  event data (upsert, delete, etc...)

  • UpsertDocumentFieldsEvent upsertDocumentFieldsEvent = 2

  • DeleteDocumentFieldsEvent deleteDocumentFieldsEvent = 3

  • DeleteDocumentEvent deleteDocumentEvent = 4

  • DropFieldEvent dropFieldEvent = 5

Used in: BatchDeleteDocumentsRequest, BatchDeleteFieldValuesRequest, BatchUpsertFieldValuesRequest, DeleteDocumentEvent, DeleteDocumentFieldsEvent, DeleteDocumentRequest, DeleteFieldValueRequest, UpsertDocumentFieldsEvent, UpsertFieldValuesRequest

• map<string, FieldValue> document = 1

  field_name vs field_value

Used in: GetUserStoreConfigResponse

• map<string, string> stringConfigs = 1

  Map key uniquely defines a config key Config keys are unique across all typed maps

• map<string, int64> intConfigs = 2

• map<string, float> floatConfigs = 3

• map<string, bytes> bytesConfigs = 4

• map<string, bool> booleanConfigs = 5

• repeated KafkaOffsetStoreEntry entries = 1

Used in: KafkaOffsetStore

• string topic = 1

• int32 partition = 2

• int64 offset = 3

Single entry in offset table on-disk stream.

• oneof operation

  • UpdateDocFields updateDocFields = 1

  • DeleteDocFields deleteDocFields = 2

  • DeleteDoc deleteDoc = 3

• string primary_key_field_name = 1

• map<string, uint32> field_ids = 2

• uint64 field_id_counter = 3

  Used to assign field-ids to new fields. Primary-key always gets id=0. Current value denotes an available id, i.e. [0, current-1] are already taken.

Used as response type in: InlineKVWriteService.batchDeleteDocuments, InlineKVWriteService.batchDeleteFieldValues, InlineKVWriteService.batchUpsertFieldValues, InlineKVWriteService.deleteDocument, InlineKVWriteService.deleteFieldValues, InlineKVWriteService.dropFields, InlineKVWriteService.upsertFieldValues

(message has no fields)

Used in: OffsetTableEntry

• bytes primary_key = 1

• repeated uint32 field_ids = 2

• repeated uint64 offsets = 3

Upsert fields for specified document.

Used in: IKVDataEvent

• optional IKVDocumentOnWire document = 1

Used to construct UserStoreContext - used for schema/configuration/etc.

Used in: BatchDeleteDocumentsRequest, BatchDeleteFieldValuesRequest, BatchUpsertFieldValuesRequest, DeleteDocumentRequest, DeleteFieldValueRequest, DropFieldsRequest, GetUserStoreConfigRequest, UpsertFieldValuesRequest

• optional AccountCredentials credentials = 1

• string storeName = 2