7.3.17. config_delete — Groonga v16.0.4ドキュメント

本文へスキップ
`Ctrl`+`K`

# 7.3.17. `config_delete`

## 7.3.17.1. 概要

Added in version 5.1.2.

`config_delete` コマンドは指定した設定項目を削除します。

## 7.3.17.2. 構文

このコマンドの引数は1つで必須です:

    config_delete key

## 7.3.17.3. 使い方

以下は `alias.column` 設定項目を削除する例です。

実行例:

    config_set alias.column Aliases.real_name
    # [[0,1337566253.89858,0.000355720520019531],true]
    config_get alias.column
    # [[0,1337566253.89858,0.000355720520019531],"Aliases.real_name"]
    config_delete alias.column
    # [[0,1337566253.89858,0.000355720520019531],true]
    config_get alias.column
    # [[0,1337566253.89858,0.000355720520019531],""]

以下は存在しない設定項目を削除する例です。

実行例:

    config_delete nonexistent
    # [
    #   [
    #     -22,
    #     1337566253.89858,
    #     0.000355720520019531,
    #     "[config][delete] failed to delete: <nonexistent>",
    #     [
    #       [
    #         "grn_config_delete",
    #         "lib/config.c",
    #         2929
    #       ]
    #     ]
    #   ],
    #   false
    # ]

`config_delete` は存在しない設定項目を削除しようとするとエラーを返します。

## 7.3.17.4. 引数

このセクションではすべての引数について説明します。

### 7.3.17.4.1. 必須引数

必須の引数は1つです。

#### 7.3.17.4.1.1. `key`

対象設定項目のキーを指定します。

最大キーサイズは4KiBです。

キーには空文字列を使うことはできません。

### 7.3.17.4.2. 省略可能引数

省略可能な引数はありません。

## 7.3.17.5. 戻り値

`config_delete` コマンドは設定項目の削除に成功したかどうかを返します。:

    [HEADER, SUCCEEDED_OR_NOT]

### 7.3.17.5.1. `HEADER`

`HEADER` については 出力形式 を参照してください。

### 7.3.17.5.2. `SUCCEEDED_OR_NOT`

コマンドの実行が成功するとtrueを返します。失敗するとエラーとしてfalseを返します。

## 7.3.17.6. 参考

> - 設定

> - config_get

> - config_set