table_list

• Abstract
• API types
  • HTTP
  • REST
  • Fluentd
• Responses

Abstract

The table_list command reports the list of all existing tables in the dataset.

This is compatible to the table_list command of the Groonga.

API types

HTTP

Request endpoint

(Document Root)/d/table_list

Request methd

GET

Request URL parameters

Nothing.

Request body

Nothing.

Response body

A response message.

REST

Not supported.

Fluentd

Style

Request-Response. One response message is always returned per one request.

type of the request

table_list

body of the request

null or a blank hash.

type of the response

table_list.result

Responses

This returns an array including list of tables as the response’s body.

[
  [
    <Groonga's status code>,
    <Start time>,
    <Elapsed time>
  ],
  <List of tables>
]

The structure of the returned array is compatible to the returned value of the Groonga’s table_list command. See the linked document for more details.

This command always returns a response with 200 as its statusCode, because this is a Groonga compatible command and errors of this command must be handled in the way same to Groonga’s one.

Response body’s details:

Status code

An integer which means the operation’s result. Possible values are:

• 0 (Droonga::GroongaHandler::Status::SUCCESS) : Successfully processed.
• -22 (Droonga::GroongaHandler::Status::INVALID_ARGUMENT) : There is any invalid argument.

Start time

An UNIX time which the operation was started on.

Elapsed time

A decimal of seconds meaning the elapsed time for the operation.