tibasFieldDef_SetEncrypted()

Specifies whether the data in a specified tuple field is to be encrypted.

Declaration

tibas_status tibasFieldDef_SetEncrypted(
    tibasFieldDef fieldDef,
    tibas_boolean secured)

Parameters

Parameter Description
fieldDef Specify the fieldDef object for the field that you want to set as encrypted.
secured A tibas_boolean value that specifies whether the field data will be encrypted.

To encrypt the field data, specify TIBAS_TRUE. If the data should be unencrypted, specify TIBAS_FALSE.

Remarks

Use the tibasFieldDef_SetEncrypted() function to specify that the data for a specified field definition is encrypted.

When data is put into a field that is defined to be encrypted, the data is encrypted while it resides in memory in the data grid and when it is persisted with shared-nothing persistence.

Certain types of fields in a space should not be encrypted. Do not encrypt fields that are used:

  • As keys or indexes
  • In filters for searching through the data in a space

See Also

tibasFieldDef_IsEncrypted(),