kv_delete()

#include <kvstore.h>

kv_error_t 
kv_delete(kv_store_t *store,
          const kv_key_t *key) 

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

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

この関数は、デフォルトの永続性とデフォルトの要求タイムアウトを使用します。デフォルトの永続性は、kv_config_set_durability()を使用して設定されます。デフォルトの要求タイムアウトは、kv_config_set_timeouts()を使用して設定されます。

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

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

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

パラメータ

• store

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

• key

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

関連項目

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