`Ctrl`+`K`

# 7.3.57. `shutdown`

## 7.3.57.1. 概要

`shutdown` はGroongaサーバープロセスを終了します。

`shutdown` はデフォルトではgraceful shutdownを使います。もし、実行中のコマンドがあるならそれらのコマンドが終了してからGroongaサーバープロセスを終了します。 `shutdown` コマンドを実行した後は新しいコマンドを実行されません。

バージョン 6.0.1 で追加: `shutdown` は `mode` パラメーターに `immediate` を指定するとimmediate shutdownを使います。たとえ実行中のコマンドがあってもGroongaサーバープロセスをすぐに終了します。

注釈

immediate shutdownを使うにはすべてのリクエストに リクエストID を設定する必要があります。

バージョン 9.1.2 で追加: Groonga HTTPサーバーは全てのスレッドが使用中であってもimmediate shutdownを受け付けます。

注釈

この機能はGroonga HTTPサーバでのみ使えます。

## 7.3.57.2. 構文

このコマンドの引数は1つで省略できます:

    shutdown [mode=graceful]

## 7.3.57.3. 使い方

`shutdown` はデフォルトではgraceful shutdownを使います。

実行例:

    shutdown
    # [[0, 1337566253.89858, 0.000355720520019531], true]

明示的に `mode` パラメーターに `graceful` を指定することもできます。

実行例:

    shutdown --mode graceful
    # [[0, 1337566253.89858, 0.000355720520019531], true]

`mode` パラメーターに `immediate` を指定することでimmediate shutdownを使うことができます。

実行例:

    shutdown --mode immediate
    # [[0, 1337566253.89858, 0.000355720520019531], true]

immediate shutdownはgraceful shutdownする時間がないときに便利です。たとえば、WindowsはWindowsをシャットダウンするときに時間内に終了しないサービスを強制終了します。

## 7.3.57.4. 引数

このセクションではこのコマンドのパラメーターを説明します。

### 7.3.57.4.1. 必須引数

必須の引数はありません。

### 7.3.57.4.2. 省略可能引数

いくつか省略可能な引数があります。

#### 7.3.57.4.2.1. `mode`

シャットダウンのモードを指定します。利用可能なモードは次の通りです。

値 | 説明
--- | ---
`graceful` | 実行中のコマンドが終了してから終了します。 これがデフォルトです。
`immediate` | バージョン 6.0.1 で追加: 実行中のコマンドがあってもすぐに終了します。

## 7.3.57.5. 戻り値

`shutdown` はシャットダウンを受け付けたときは以下のようにボディが `true` になります。:

    [HEADER, true]

`shutdown` がシャットダウンを受け付けなかったら `HEADER` にエラーの詳細が含まれます。

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