7.3.17. config_set — Groonga v7.0.6ドキュメント

# groonga - オープンソースのカラムストア機能付き全文検索エンジン

- English

# 7.3.17. `config_set`

## 7.3.17.1. 概要

バージョン 5.1.2 で追加.

`config_set` コマンドは指定した設定項目に値を設定します。

## 7.3.17.2. 構文

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

    config_set key value

## 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"]

## 7.3.17.4. 引数

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

### 7.3.17.4.1. 必須引数

いくつか必須の引数があります。

#### 7.3.17.4.1.1. `key`

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

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

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

#### 7.3.17.4.1.2. `value`

`key` で指定した対象設定項目の値を指定します。

値の最大サイズは4091B（= 4KiB - 5B）です。

### 7.3.17.4.2. 省略可能引数

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

## 7.3.17.5. 戻り値

`config_set` コマンドは設定項目に値を設定できたかどうかを返します。:

    [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_delete