Skip to main content

Module document

Module document 

Source

Structs§

ContestedDocumentsTemporarilyNotAllowedError
No longer produced: Platform refused contested document creates before epoch 4 until that gate was removed. The error stays so BasicError keeps its variant order and clients still decode code 10418 from nodes that predate the removal.
DataContractNotPresentError
DocumentCreationNotAllowedError
DocumentFieldMaxSizeExceededError
DocumentPropertyConstraintViolatedError
A created or replaced document breaks a rule of its document type’s propertyConstraints: the rule does not hold, or evaluating it overflowed, divided by zero, raised to a negative power or read a value that is not an integer.
DocumentPropertyMaxBytesExceededError
A document supplied a string longer in UTF-8 bytes than the maxBytes its type declares on the property (or on the items of a typed array of strings). maxLength counts characters, which can be up to four bytes each; maxBytes bounds the stored size.
DocumentPropertyNotDistinctError
A distinctFrom identifier property of the written document equals the value it must differ from: the document’s $ownerId, or the named property of the same document.
DocumentPropertyNotGeneratedError
A generatedFrom property of the written document is not what its function generates from its parameters: its value differs, or it is present while a parameter is absent (or absent while every parameter is present, which the platform only sees when a document skipped the generation it runs on arrival).
DocumentReferencePreimageInvalidError
A document being created cannot assemble the preimage of a refersTo key it reveals, the findBy function ("<referenced property>": { "function": "sys.hash.sha256d", "params": [...] }): a value a param reads is absent or of a kind a param cannot take, or a variable-length value holds the one-byte separator that follows it, so the preimage would not split back into its params one way.
DocumentTransitionsAreAbsentError
DuplicateDocumentTransitionsWithIdsError
DuplicateDocumentTransitionsWithIndicesError
InconsistentCompoundIndexDataError
InvalidDocumentTransitionActionError
InvalidDocumentTransitionIdError
InvalidDocumentTypeError
InvalidEncryptedPropertyShapeError
A document supplied a value for a property its type declares encryptedFor whose length is not one the declared scheme produces: at least the IV plus one block, and a multiple of the block length. The shape is all consensus can check about a ciphertext.
MaxDocumentsTransitionsExceededError
MissingDataContractIdBasicError
MissingDocumentTransitionActionError
MissingDocumentTransitionTypeError
MissingDocumentTypeError
MissingPositionsInDocumentTypePropertiesError
NonceOutOfBoundsError

Enums§

PropertyConstraintViolation
Why a document breaks a rule of its type’s propertyConstraints.