pkg/api/protomodel/docs.md
<a name="top"></a>
<a name="authorization.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="immudb.model.CloseSessionRequest"></a>
<a name="immudb.model.CloseSessionResponse"></a>
<a name="immudb.model.KeepAliveRequest"></a>
<a name="immudb.model.KeepAliveResponse"></a>
<a name="immudb.model.OpenSessionRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| username | string | ||
| password | string | ||
| database | string |
<a name="immudb.model.OpenSessionResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| sessionID | string | ||
| serverUUID | string | ||
| expirationTimestamp | int32 | ||
| inactivityTimestamp | int32 |
<a name="immudb.model.AuthorizationService"></a>
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| OpenSession | OpenSessionRequest | OpenSessionResponse | |
| KeepAlive | KeepAliveRequest | KeepAliveResponse | |
| CloseSession | CloseSessionRequest | CloseSessionResponse |
<a name="documents.proto"></a>
<p align="right"><a href="#top">Top</a></p><a name="immudb.model.AddFieldRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| collectionName | string | ||
| field | Field |
<a name="immudb.model.AddFieldResponse"></a>
<a name="immudb.model.AuditDocumentRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| collectionName | string | ||
| documentId | string | ||
| desc | bool | ||
| page | uint32 | ||
| pageSize | uint32 | ||
| omitPayload | bool |
<a name="immudb.model.AuditDocumentResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| revisions | DocumentAtRevision | repeated |
<a name="immudb.model.Collection"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| documentIdFieldName | string | ||
| fields | Field | repeated | |
| indexes | Index | repeated |
<a name="immudb.model.CountDocumentsRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| query | Query |
<a name="immudb.model.CountDocumentsResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| count | int64 |
<a name="immudb.model.CreateCollectionRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| documentIdFieldName | string | ||
| fields | Field | repeated | |
| indexes | Index | repeated |
<a name="immudb.model.CreateCollectionResponse"></a>
<a name="immudb.model.CreateIndexRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| collectionName | string | ||
| fields | string | repeated | |
| isUnique | bool |
<a name="immudb.model.CreateIndexResponse"></a>
<a name="immudb.model.DeleteCollectionRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| name | string |
<a name="immudb.model.DeleteCollectionResponse"></a>
<a name="immudb.model.DeleteDocumentsRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| query | Query |
<a name="immudb.model.DeleteDocumentsResponse"></a>
<a name="immudb.model.DeleteIndexRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| collectionName | string | ||
| fields | string | repeated |
<a name="immudb.model.DeleteIndexResponse"></a>
<a name="immudb.model.DocumentAtRevision"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| transactionId | uint64 | ||
| documentId | string | ||
| revision | uint64 | ||
| metadata | DocumentMetadata | ||
| document | google.protobuf.Struct | ||
| username | string | ||
| ts | int64 |
<a name="immudb.model.DocumentMetadata"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| deleted | bool |
<a name="immudb.model.Field"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| type | FieldType |
<a name="immudb.model.FieldComparison"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| field | string | ||
| operator | ComparisonOperator | ||
| value | google.protobuf.Value |
<a name="immudb.model.GetCollectionRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| name | string |
<a name="immudb.model.GetCollectionResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| collection | Collection |
<a name="immudb.model.GetCollectionsRequest"></a>
<a name="immudb.model.GetCollectionsResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| collections | Collection | repeated |
<a name="immudb.model.Index"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| fields | string | repeated | |
| isUnique | bool |
<a name="immudb.model.InsertDocumentsRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| collectionName | string | ||
| documents | google.protobuf.Struct | repeated |
<a name="immudb.model.InsertDocumentsResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| transactionId | uint64 | ||
| documentIds | string | repeated |
<a name="immudb.model.OrderByClause"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| field | string | ||
| desc | bool |
<a name="immudb.model.ProofDocumentRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| collectionName | string | ||
| documentId | string | ||
| transactionId | uint64 | ||
| proofSinceTransactionId | uint64 |
<a name="immudb.model.ProofDocumentResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| database | string | ||
| collectionId | uint32 | ||
| documentIdFieldName | string | ||
| encodedDocument | bytes | ||
| verifiableTx | immudb.schema.VerifiableTxV2 |
<a name="immudb.model.Query"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| collectionName | string | ||
| expressions | QueryExpression | repeated | |
| orderBy | OrderByClause | repeated | |
| limit | uint32 |
<a name="immudb.model.QueryExpression"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| fieldComparisons | FieldComparison | repeated |
<a name="immudb.model.RemoveFieldRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| collectionName | string | ||
| fieldName | string |
<a name="immudb.model.RemoveFieldResponse"></a>
<a name="immudb.model.ReplaceDocumentsRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| query | Query | ||
| document | google.protobuf.Struct |
<a name="immudb.model.ReplaceDocumentsResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| revisions | DocumentAtRevision | repeated |
<a name="immudb.model.SearchDocumentsRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| searchId | string | ||
| query | Query | ||
| page | uint32 | ||
| pageSize | uint32 | ||
| keepOpen | bool |
<a name="immudb.model.SearchDocumentsResponse"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| searchId | string | ||
| revisions | DocumentAtRevision | repeated |
<a name="immudb.model.UpdateCollectionRequest"></a>
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| documentIdFieldName | string |
<a name="immudb.model.UpdateCollectionResponse"></a>
<a name="immudb.model.ComparisonOperator"></a>
| Name | Number | Description |
|---|---|---|
| EQ | 0 | |
| NE | 1 | |
| LT | 2 | |
| LE | 3 | |
| GT | 4 | |
| GE | 5 | |
| LIKE | 6 | |
| NOT_LIKE | 7 |
<a name="immudb.model.FieldType"></a>
| Name | Number | Description |
|---|---|---|
| STRING | 0 | |
| BOOLEAN | 1 | |
| INTEGER | 2 | |
| DOUBLE | 3 | |
| UUID | 4 |
<a name="immudb.model.DocumentService"></a>
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| CreateCollection | CreateCollectionRequest | CreateCollectionResponse | |
| GetCollections | GetCollectionsRequest | GetCollectionsResponse | |
| GetCollection | GetCollectionRequest | GetCollectionResponse | |
| UpdateCollection | UpdateCollectionRequest | UpdateCollectionResponse | |
| DeleteCollection | DeleteCollectionRequest | DeleteCollectionResponse | |
| AddField | AddFieldRequest | AddFieldResponse | |
| RemoveField | RemoveFieldRequest | RemoveFieldResponse | |
| CreateIndex | CreateIndexRequest | CreateIndexResponse | |
| DeleteIndex | DeleteIndexRequest | DeleteIndexResponse | |
| InsertDocuments | InsertDocumentsRequest | InsertDocumentsResponse | |
| ReplaceDocuments | ReplaceDocumentsRequest | ReplaceDocumentsResponse | |
| DeleteDocuments | DeleteDocumentsRequest | DeleteDocumentsResponse | |
| SearchDocuments | SearchDocumentsRequest | SearchDocumentsResponse | |
| CountDocuments | CountDocumentsRequest | CountDocumentsResponse | |
| AuditDocument | AuditDocumentRequest | AuditDocumentResponse | |
| ProofDocument | ProofDocumentRequest | ProofDocumentResponse |
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
|---|---|---|---|---|---|---|---|---|
| <a name="double" /> double | double | double | float | float64 | double | float | Float | |
| <a name="float" /> float | float | float | float | float32 | float | float | Float | |
| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| <a name="bool" /> bool | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | |
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |