kv_delete_with_options()

#include <kvstore.h>

kv_error_tkv_delete_with_options(kv_store_t *store,
                       const kv_key_t *key,
                       const kv_version_t *if_version,
                       kv_value_t **previous_value,kv_return_value_version_enum return_info,
                       kv_durability_t durability,
                       kv_timeout_t timeout_ms) 

キーに関連付けられたkey/valueペアを削除します。

このメソッドを使用してkey/valueペアを削除しても、その子または子孫のkey/valueペアは自動的には削除されません。子または子孫を削除するには、かわりにkv_multi_delete()を使用します。

このメソッドを呼び出すと、結果は次のようになります。

• KVペアが削除され、削除されたレコード数が返されます。この関数の場合、成功した場合の戻り値は常に0または1になります。

• KVペアの正常な削除は保証されていません。成功しなかったことを示すkv_error_tエラーが返されます。つまり、負の整数が返されます。

パラメータ

• store

  storeパラメータは、削除操作を実行するストアへのハンドルです。

• key

  keyパラメータは、削除するkey/valueペアを調べるために使用されるキーです。

• if_version

  if_versionパラメータは、レコードを削除する前にそのレコードが一致している必要があるバージョンを示します。バージョンは、kv_get_version()関数を使用して取得されます。

• previous_value

  previous_valueパラメータは、この関数が削除したKey/Valueペアの値部分のコピー先であるメモリーを参照します。

• return_info

  return_infoパラメータは、この操作によってkv_execute() 結果リストに返される必要がある情報を指定します。このパラメータによって受け入れられるオプションの詳細は、kv_return_value_version_enumを参照してください。

• durability

  durabilityパラメータは、この削除操作で使用する永続性保証を提供します。永続性保証は、kv_create_durability()を使用して作成します。

• timeout_ms

  timeout_msパラメータは、操作を処理するための時間間隔の上限を指定します。指定された限度を超えないよう最善が尽くされます。ゼロの場合は、デフォルトの要求タイムアウトが使用されます。デフォルトの要求タイムアウトは、kv_config_set_timeouts()を使用して設定されます。

関連項目

• データ操作および関連関数