7.3.17. config_get — Groonga v14.0.6ドキュメント

Skip to main content
`Ctrl`+`K`

# 7.3.17. `config_get`

## 7.3.17.1. 概要

Added in version 5.1.2.

`config_get` コマンドは指定した設定項目の値を返します。

## 7.3.17.2. 構文

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

    config_get 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_get nonexistent
    # [[0,1337566253.89858,0.000355720520019531],""]

`config_get` は存在しない設定項目の場合は空文字列を返します。

## 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_get` コマンドは指定した設定項目の値を返します。:

    [HEADER, VALUE]

### 7.3.17.5.1. `HEADER`

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

### 7.3.17.5.2. `VALUE`

`VALUE` は `key` で指定した設定項目の値です。文字列です。

## 7.3.17.6. 参考

> - 設定

> - config_set

> - config_delete