MutationType
public enum MutationType : UInt32
A set of operations that can be performed atomically on a database.
-
Performs an addition of little-endian integers. If the existing value in the database is not present or shorter than
param
, it is first extended to the length ofparam
with zero bytes. Ifparam
is shorter than the existing value in the database, the existing value is truncated to match the length ofparam
. The integers to be added must be stored in a little-endian representation. They can be signed in two’s complement representation or unsigned. You can add to an integer at a known offset in the value by prepending the appropriate number of zero bytes toparam
and padding with zero bytes to match the length of the value. However, this offset technique requires that you know the addition will not cause the integer field within the value to overflow.Declaration
Swift
case add = 2
-
Undocumented
Declaration
Swift
public static let and: MutationType?
-
Performs a bitwise
and
operation. If the existing value in the database is not present, thenparam
is stored in the database. If the existing value in the database is shorter thanparam
, it is first extended to the length ofparam
with zero bytes. Ifparam
is shorter than the existing value in the database, the existing value is truncated to match the length ofparam
.Declaration
Swift
case bitAnd = 6
-
Undocumented
Declaration
Swift
public static let or: MutationType?
-
Performs a bitwise
or
operation. If the existing value in the database is not present or shorter thanparam
, it is first extended to the length ofparam
with zero bytes. Ifparam
is shorter than the existing value in the database, the existing value is truncated to match the length ofparam
.Declaration
Swift
case bitOr = 7
-
Undocumented
Declaration
Swift
public static let xor: MutationType?
-
Performs a bitwise
xor
operation. If the existing value in the database is not present or shorter thanparam
, it is first extended to the length ofparam
with zero bytes. Ifparam
is shorter than the existing value in the database, the existing value is truncated to match the length ofparam
.Declaration
Swift
case bitXor = 8
-
Appends
param
to the end of the existing value already in the database at the given key (or creates the key and sets the value toparam
if the key is empty). This will only append the value if the final concatenated value size is less than or equal to the maximum value size (i.e., if it fits). WARNING: No error is surfaced back to the user if the final value is too large because the mutation will not be applied until after the transaction has been committed. Therefore, it is only safe to use this mutation type if one can guarantee that one will keep the total value size under the maximum size.Declaration
Swift
case appendIfFits = 9
-
Performs a little-endian comparison of byte strings. If the existing value in the database is not present or shorter than
param
, it is first extended to the length ofparam
with zero bytes. Ifparam
is shorter than the existing value in the database, the existing value is truncated to match the length ofparam
. The larger of the two values is then stored in the database.Declaration
Swift
case max = 12
-
Performs a little-endian comparison of byte strings. If the existing value in the database is not present, then
param
is stored in the database. If the existing value in the database is shorter thanparam
, it is first extended to the length ofparam
with zero bytes. Ifparam
is shorter than the existing value in the database, the existing value is truncated to match the length ofparam
. The smaller of the two values is then stored in the database.Declaration
Swift
case min = 13
-
Transforms
key
using a versionstamp for the transaction. Sets the transformed key in the database toparam
. The key is transformed by removing the final four bytes from the key and reading those as a little-Endian 32-bit integer to get a positionpos
. The 10 bytes of the key frompos
topos + 10
are replaced with the versionstamp of the transaction used. The first byte of the key is position 0. A versionstamp is a 10 byte, unique, monotonically (but not sequentially) increasing value for each committed transaction. The first 8 bytes are the committed version of the database (serialized in big-Endian order). The last 2 bytes are monotonic in the serialization order for transactions. WARNING: At this time, versionstamps are compatible with the Tuple layer only in the Java and Python bindings. Also, note that prior to API version 520, the offset was computed from only the final two bytes rather than the final four bytes.Declaration
Swift
case setVersionstampedKey = 14
-
Transforms
param
using a versionstamp for the transaction. Sets thekey
given to the transformedparam
. The parameter is transformed by removing the final four bytes fromparam
and reading those as a little-Endian 32-bit integer to get a positionpos
. The 10 bytes of the parameter frompos
topos + 10
are replaced with the versionstamp of the transaction used. The first byte of the parameter is position 0. A versionstamp is a 10 byte, unique, monotonically (but not sequentially) increasing value for each committed transaction. The first 8 bytes are the committed version of the database (serialized in big-Endian order). The last 2 bytes are monotonic in the serialization order for transactions. WARNING: At this time, versionstamps are compatible with the Tuple layer only in the Java and Python bindings. Also, note that prior to API version 520, the versionstamp was always placed at the beginning of the parameter rather than computing an offset.Declaration
Swift
case setVersionstampedValue = 15
-
Performs lexicographic comparison of byte strings. If the existing value in the database is not present, then
param
is stored. Otherwise the smaller of the two values is then stored in the database.Declaration
Swift
case byteMin = 16
-
Performs lexicographic comparison of byte strings. If the existing value in the database is not present, then
param
is stored. Otherwise the larger of the two values is then stored in the database.Declaration
Swift
case byteMax = 17