show tables
post
/V0/nosql/admin/tables
Display the table information. By default, the names of all top-tables and their child tables are listed. Top-level tables are those without parents. The level of child tables can be limited by specifying the
level
flag. If a specific table is named, its detailed metadata is displayed. The table name is an optionally namespace qualified dot-separated name with the format [ns:]tableName[.childTableName]*.
Flag parent
is used to show all child tables for the given parent table.Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Admin CLI Command:
show tables [-name] [-parent ] [-level ]
show tables [-name
Root Schema : schema
Type:
Show Source
object
-
arguments(required): array
arguments
-
command(required): string
Allowed Values:
[ "show" ]
Example:
{
"command":"show",
"arguments":[
{
"name":"Name of the specific table to show"
},
{
"parent":"Name of the parent table to show all child tables"
},
{
"level":"Specify the the level of the child tables to show"
}
]
}
Response
Supported Media Types
- application/json
200 Response
Operation ended successfully
Root Schema : commonResponse
Type:
Show Source
object
-
description(required): string
-
operation(required): string
-
returnCode(required): string
-
returnValue(required): object
returnValue
Example:
{
"operation":"operation executed",
"returnCode":"5000 when success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem at execution",
"description":"error description when returnCode != 5000",
"returnValue":"JSON object with the output returned by the command when returnCode: 5000(success). Otherwise, null"
}
Nested Schema : returnValue
Type:
object