table info
Displays information about a MapR-DB binary or JSON table, or an index on a JSON table.
Permissions Required
To run this command, your user ID must have the following permissions:
mapr
user is not treated as a superuser.
MapR-DB does not allow the mapr
user to run this command unless that user
is given the relevant permission or permissions with access-control expressions.Syntax
- CLI
-
maprcli table info -path <path> [ -index <index name> ]
- REST
-
curl -k -X GET \ 'http[s]://<host>:<port>/rest/table/info?path=<path>&index=<index name>' -u <username>:<password>
mapr
user is not treated as a superuser.
MapR-DB does not allow the mapr
user to run this command unless that user
is given the relevant permission or permissions with access-control expressions.Parameters
Parameter | Description |
---|---|
path |
The path to the table.
|
index | The name of the index for which to display information. |
Example
Lists the information for a table named mytable
in the JSON format:
- CLI
-
maprcli table info -path /mapr/my.cluster.com/volume1/mytable -json
- REST
-
curl -k -X GET \ 'https://r1n1.sj.us:8443/rest/table/info?path=%2Fmapr%2Fmy.cluster.com%2Fvolume1%2Fmytable' \ -u mapr:mapr
Sample Output
# maprcli table info -path /mydirectory/mytable -json
{
"timestamp":1444671479053,
"timeofday":"2015-10-12 10:37:59.053 GMT-0700",
"status":"OK",
"total":1,
"data":[
{
"path":"/mydirectory/mytable",
"numregions":1,
"totallogicalsize":0,
"totalphysicalsize":0,
"totalcopypendingsize":0,
"totalrows":0,
"autosplit":true,
"bulkload":false,
"tabletype":"json",
"regionsizemb":4096,
"audit":false,
"maxvalueszinmemindex":100,
"adminaccessperm":"u:root",
"createrenamefamilyperm":"u:root",
"bulkloadperm":"u:root",
"indexperm":"u:root",
"packperm":"u:root",
"deletefamilyperm":"u:root",
"replperm":"u:root",
"splitmergeperm":"u:root",
"defaultappendperm":"u:root",
"defaultcompressionperm":"u:root",
"defaultmemoryperm":"u:root",
"defaultreadperm":"u:root",
"defaulttraverseperm":"u:root",
"defaultversionperm":"u:root",
"defaultwriteperm":"u:root",
"uuid":"3b4ef43c-83d4-06eb-99ba-08c8ef1b5600"
}
]
}
Output Fields
Output Field |
Description |
---|---|
path |
The path to the MapR-DB table
|
numregions | Number of regions in the table |
totallogicalsize | Estimated size (in bytes) of uncompressed data stored in table (excluding replication) |
totalphysicalsize |
Estimated size (in bytes) of actual data stored in table (excluding replication). Includes internal metadata and reflects compressed data size when compression is enabled. |
totalcopypendingsize | Total size (in bytes) of pending data for replication |
totalrows | Estimated number of rows in a table |
autosplit |
A Boolean value that specifies whether to split the table into regions
automatically as the table grows. The average size of each region is determined by
the The default value is |
bulkload |
A Boolean value that specifies whether to allow a full bulk
load of the table. The default is |
tabletype | Specifies whether the table will be a binary table or
a JSON table. The values are binary and json .
The default is binary . |
regionsizemb |
The average size of the regions into which MapR-DB tries to split the table as
the table grows. The default is 4096 MB. This value is ignored if
If Although splits are automatic, merges are not. For example, if the value of
NOTE: When a table has less than 4 regions, MapR-DB ignores the
regionsizemb parameter and splits regions at a lower threshold.
|
audit | Specifies whether to turn auditing on for the table. If auditing is also
enabled at the cluster level with the maprcli audit data command
and enabled for the current volume, setting this value to true causes auditing to
start for the table. |
metricsinterval | The table metrics collection interval, in seconds |
maxvalueszinmemindex | The maximum value size to save in an in-memory index |
adminaccessperm | The Access Control Expression that controls who can view and edit the permissions for this table. By default, permission is given to the user ID that is used to create the table. |
createrenamefamilyperm | The Access Control Expression that controls who can create column families for this table or rename existing column families. By default, permission is given to the user ID that is used to create the table. |
bulkloadperm | The Access Control Expression that controls who can load this table with bulk loads if the table was created with bulk load support. By default, permission is given to the user ID that is used to create the table. |
indexperm | The secondary index Admin permissions setting that controls who can create an index associated with this table. By default, permission is given to the user ID that is used to create the table. |
packperm | The Access Control Expression that controls who can pack table regions. By default, permission is given to the user ID that is used to create the table. |
deletefamilyperm | The Access Control Expression that defines access to delete column families for this table. Delimit the expression with single-quotation marks. By default, permission is given to the user ID that is used to create the table. |
replperm | The Access Control Expression that controls who can set up replication either to or from a table. By default, permission is given to the user ID that is used to create the table |
splitmergeperm |
The Access Control Expression that controls who can take the following actions:
By default, permission is given to the user ID that is used to create the table. |
defaultappendperm | Applies to binary tables only:
The default Access Control Expression for the append permission on new column
families that are created in this table. If no value is specified, the default is
u:<username of the table creator> . This value of the
parameter appendperm in the table cf create and
table cf edit commands overrides this value. |
defaultcompressionperm | Applies to binary tables only:
The default Access Control Expression for the compression permission on new column
families that are created in this table. If no value is specified, the default is
u:<username of the table creator> . This value of the
parameter compressionperm in the table cf create
and table cf edit commands overrides this value. |
defaultmemoryperm |
The default Access Control Expression for the memory permission on new column
families that are created in this table. If no value is specified, the default is
|
defaultreadperm | The default Access Control Expression for the read permission on new column
families that are created in this table. If no value is specified, the default is
u:<username of the table creator> . This value of the
parameter readperm in the table cf create and
table cf edit commands overrides this value.
See table cf create and table cf edit
|
defaulttraverseperm | Applies to JSON tables only: The default Access Control Expression for the traverse permission on new column families. For more information about this permission, see Permission Types for Fields and Column Families in JSON Tables. |
defaultwriteperm | The default Access Control Expression for the write permission on new
column families that are created in this table. If no value is specified,
the default is u:<username of the table creator> .
This value of the parameter writeperm in the table
cf create and table cf edit commands overrides
this value. See table cf create and table cf edit. |