Google Bigtable v2 API - Class Mutations (3.14.0)

public static class Mutations

Reference documentation and code samples for the Google Bigtable v2 API class Mutations.

Static class with convenience methods for creating various kinds of Mutation instances.

Inheritance

object > Mutations

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Methods

CreateEntry(BigtableByteString, params Mutation[])

public static MutateRowsRequest.Types.Entry CreateEntry(BigtableByteString rowKey, params Mutation[] mutations)

Creates a MutateRowsRequest.Types.Entry to use with MutateRows requests. Each Entry is an atomic, ordered set of mutations for a particular row.

Parameters
Name	Description
`rowKey`	`BigtableByteString` The key of the row to which the `mutations` should be applied. Must not be empty.
`mutations`	`Mutation` Changes to be atomically applied to the specified row. Mutations are applied in order, meaning that earlier mutations can be masked by later ones. You must specify at least one mutation. Must not be null, or contain null elements.

Returns
Type	Description
`MutateRowsRequestTypesEntry`	The MutateRows entry describing mutations for a single row.

Remarks

Note that string is implicitly convertible to BigtableByteString, so rowKey can be specified using a string as well and its UTF-8 representations will be used.

See Also

DeleteFromColumn(string, BigtableByteString, BigtableVersionRange)

public static Mutation DeleteFromColumn(string familyName, BigtableByteString columnQualifier, BigtableVersionRange versionRange = null)

Creates a Mutation which deletes cells from the specified column, optionally restricting the deletions to a given version range.

Parameters
Name	Description
`familyName`	`string` The name of the family from which cells should be deleted. Must match `[-_.a-zA-Z0-9]+`
`columnQualifier`	`BigtableByteString` The qualifier of the column from which cells should be deleted. Can be any byte string, including the empty string.
`versionRange`	`BigtableVersionRange` [Optional] The range of versions within which cells should be deleted. If unspecified, all versions will be deleted.

Returns
Type	Description
`Mutation`	The created Mutation instance.

Remarks

Note that string is implicitly convertible to BigtableByteString, so columnQualifier can be specified using a string as well and its UTF-8 representations will be used.

DeleteFromFamily(string)

public static Mutation DeleteFromFamily(string familyName)

Creates a Mutation which deletes all cells from the specified column family.

Parameter
Name	Description
`familyName`	`string` The name of the family from which cells should be deleted. Must match `[-_.a-zA-Z0-9]+`

Returns
Type	Description
`Mutation`	The created Mutation instance.

DeleteFromRow()

public static Mutation DeleteFromRow()

Creates a Mutation which deletes all cells from the containing row.

Returns
Type	Description
`Mutation`	The created Mutation instance.

SetCell(string, BigtableByteString, BigtableByteString, BigtableVersion?)

public static Mutation SetCell(string familyName, BigtableByteString columnQualifier, BigtableByteString value, BigtableVersion? version = null)

Creates a Mutation which sets the value of the specified cell.

Parameters
Name	Description
`familyName`	`string` The name of the family into which new data should be written. Must match `[-_.a-zA-Z0-9]+`
`columnQualifier`	`BigtableByteString` The qualifier of the column into which new data should be written. Can be any byte string, including the empty string.
`value`	`BigtableByteString` The value to be written into the specified cell.
`version`	`BigtableVersion` [Optional] The version of the cell into which new data should be written. If unspecified, the version will be initialized from the current UTC time.

Returns
Type	Description
`Mutation`	The created Mutation instance.

Remarks

Note that string is implicitly convertible to BigtableByteString, so columnQualifier or value can be specified using a string as well and its UTF-8 representations will be used.