Skip to content

Latest commit

 

History

History
122 lines (82 loc) · 3.27 KB

index.md

File metadata and controls

122 lines (82 loc) · 3.27 KB
Raw
title layout
delete
ja

{% comment %} ############################################## THIS FILE IS AUTOMATICALLY GENERATED FROM "_po/ja/reference/1.0.7/commands/delete/index.po" DO NOT EDIT THIS FILE MANUALLY! ############################################## {% endcomment %}

  • TOC {:toc}

概要 {#abstract}

The delete command removes records in a table.

This is compatible to the delete command of the Groonga.

APIの形式 {#api-types}

HTTP {#api-types-http}

リクエスト先 : (ドキュメントルート)/d/delete

リクエストメソッド : GET

リクエストのURLパラメータ : パラメータの一覧で定義されている物を指定します。

リクエストのbody : なし。

レスポンスのbody : レスポンスメッセージ。

REST {#api-types-rest}

対応していません。

Fluentd {#api-types-fluentd}

形式 : Request-Response型。コマンドに対しては必ず対応するレスポンスが返されます。

リクエストの type : delete

リクエストの body : パラメータのハッシュ。

レスポンスの type : delete.result

パラメータの構文 {#syntax}

{
  "table" : "<Name of the table>",
  "key"   : "<Key of the record>"
}

または

{
  "table" : "<Name of the table>",
  "id"    : "<ID of the record>"
}

または

{
  "table"  : "<Name of the table>",
  "filter" : "<Complex search conditions>"
}

パラメータの詳細 {#parameters}

All parameters except table are optional. However, you must specify one of key, id, or filter to specify the record (records) to be removed.

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

レスポンス {#response}

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

[
  [
    <Groonga's status code>,
    <Start time>,
    <Elapsed time>
  ],
  <Records are successfully removed or not>
]

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

レスポンスの body の詳細：

ステータスコード : コマンドが正常に受け付けられたかどうかを示す整数値です。以下のいずれかの値をとります。

  • 0 (Droonga::GroongaHandler::Status::SUCCESS) : 正常に処理された。.
  • -22 (Droonga::GroongaHandler::Status::INVALID_ARGUMENT) : 引数が不正である。

開始時刻 : 処理を開始した時刻を示す数値（UNIX秒）。

処理に要した時間 : 処理を開始してから完了までの間にかかった時間を示す数値。

Records are successfully removed or not : A boolean value meaning specified records were successfully removed or not. Possible values are:

  • true：Records were successfully removed.
  • false：Records were not removed.