document.proto

path sdk/document.proto

package m10.sdk

---

Messages

CollectionMetadata

Metadata for a document collection.

Name	Type	Description
name	string	Name of the collection.
descriptor_name	string	Name of the protobuf message descriptor for documents in this collection.
file_descriptor_set	google.protobuf.FileDescriptorSet	File descriptor set containing the message descriptor.
index_metadata	repeated IndexMetadata	Metadata for indexes on this collection.
primary_key_path	string	Path to the field that serves as the collection's primary key.

DocumentOperations

Operations to be performed on a document.

Name	Type	Description
operations	repeated Operation	List of operations.

Exp

An expression that can be evaluated.

Name	Type	Description
exp	string	The expression string.
vars	repeated Exp.VarsEntry	Variables used in the expression.

Exp.VarsEntry

Name	Type	Description
key	string
value	Value

IndexMetadata

Metadata for an index.

Name	Type	Description
path	repeated string	Paths of the indexed fields. Compound indexes are represented using a repeated path.

Operation

A single operation on a document database.

Name	Type	Description
insert_document	Operation.InsertDocument	Inserts a new document into a collection.
update_document	Operation.UpdateDocument	Updates an existing document in a collection.
delete_document	Operation.DeleteDocument	Deletes a document from a collection.
insert_collection	CollectionMetadata	Inserts metadata for a collection.
insert_index	Operation.InsertIndex	Inserts an index for a collection.

Operation.DeleteDocument

Operation to delete a document.

Name	Type	Description
collection	string	The collection containing the document to delete.
primary_key	Value	The primary key of the document to delete.

Operation.InsertDocument

Operation to insert a new document.

Name	Type	Description
collection	string	The collection to insert the document into.
document	bytes	The document to be inserted, serialized as bytes.

Operation.InsertIndex

Operation to insert an index for a collection.

Name	Type	Description
collection	string	The collection to create the index on.
path	string	Path of the field being indexed

Operation.UpdateDocument

Operation to update an existing document.

Name	Type	Description
collection	string	The collection containing the document to update.
primary_key	Value	The primary key of the document to update.
document	bytes	The updated document, serialized as bytes.
field_mask	google.protobuf.FieldMask	A field mask specifying which fields to update.
merge_repeated	bool	Whether to merge repeated fields instead of replacing them entirely.

QueryRequest

A query request against a collection.

Name	Type	Description
collection	string	The collection to query.
expression	Exp	The query expression.
public_key	optional bytes	An optional public key, for use in encrypted queries

Value

A value that can be stored in a document.

Name	Type	Description
string_value	string
int8_value	int32
int16_value	int32
int32_value	int32
int64_value	int64
uint8_value	uint32
uint16_value	uint32
uint32_value	uint32
uint64_value	uint64
double_value	double
float_value	float
bool_value	bool
bytes_value	bytes

---