column_rename

概要

The column_rename command renames an existing column in a table.

This is compatible to the column_rename command of the Groonga.

APIの形式

HTTP

リクエスト先
(ドキュメントルート)/d/column_rename
リクエストメソッド
GET
リクエストのURLパラメータ
パラメータの一覧で定義されている物を指定します。
リクエストのbody
なし。
レスポンスのbody
レスポンスメッセージ。

REST

対応していません。

Fluentd

形式
Request-Response型。コマンドに対しては必ず対応するレスポンスが返されます。
リクエストの type
column_rename
リクエストの body
パラメータのハッシュ。
レスポンスの type
column_rename.result

パラメータの構文

{
  "table"    : "<Name of the table>",
  "name"     : "<Current name of the column>",
  "new_name" : "<New name of the column>"
}

パラメータの詳細

All parameters are required.

They are compatible to the parameters of the column_rename command of the Groonga. See the linked document for more details.

レスポンス

このコマンドは、レスポンスの body としてコマンドの実行結果に関する情報を格納した配列を返却します。

[
  [
    <Groonga's status code>,
    <Start time>,
    <Elapsed time>
  ],
  <Column is successfully renamed or not>
]

このコマンドはレスポンスの statusCode として常に 200 を返します。これは、Groonga互換コマンドのエラー情報はGroongaのそれと同じ形で処理される必要があるためです。

レスポンスの body の詳細：

ステータスコード
コマンドが正常に受け付けられたかどうかを示す整数値です。以下のいずれかの値をとります。
  • 0 (Droonga::GroongaHandler::Status::SUCCESS) : 正常に処理された。.
  • -22 (Droonga::GroongaHandler::Status::INVALID_ARGUMENT) : 引数が不正である。
開始時刻
処理を開始した時刻を示す数値（UNIX秒）。
処理に要した時間
処理を開始してから完了までの間にかかった時間を示す数値。
Column is successfully renamed or not
A boolean value meaning the column was successfully renamed or not. Possible values are:
  • true：The column was successfully renamed.
  • false：The column was not renamed.