table info

Displays information about a HPE Ezmeral Data Fabric Database 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:

NOTE
The mapr user is not treated as a superuser. HPE Ezmeral Data Fabric Database 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>
NOTE
The mapr user is not treated as a superuser. HPE Ezmeral Data Fabric Database 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.

  • For a path on the local cluster, start the path at the volume mount point. For example, for a table named test under volume1 which has a mount point at /volume1, specify the following path: /volume1/test
  • For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named customer under volume1 in the sanfrancisco cluster, specify the following path:/mapr/sanfrancisco/volume1/customer
index The name of the index for which to display information.

Example

Lists the information for a table named mytable in the JSON format, as described in Common Options:

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

Output Fields

maprcli table info -path /mapr/my.cluster.com/volume1/mytable -json

{
        "timestamp":1540362830403,
        "timeofday":"2018-10-23 11:33:50.403 GMT-0700 PM",
        "status":"OK",
        "total":1,
        "data":[
                {
                        "path":"/mapr/my.cluster.com/volume1/mytable",
                        "numregions":1,
                        "totallogicalsize":0,
                        "totalphysicalsize":0,
                        "totalcopypendingsize":0,
                        "totalrows":0,
                        "totalnumberofspills":0,
                        "totalnumberofsegments":0,
                        "autosplit":true,
                        "bulkload":false,
                        "wireencryptionfrompolicies":false,
                        "tabletype":"json",
                        "securitypolicy":"[Credit_Card_Data,Confidential]",
                        "regionsizemb":4096,
                        "audit":false,
                        "metricsinterval":10,
                        "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",
                        "defaultcompressionperm":"u:root",
                        "defaultmemoryperm":"u:root",
                        "defaultreadperm":"u:root",
                        "defaulttraverseperm":"u:root",
                        "defaultwriteperm":"u:root",
                        "defaultunmaskedreadperm": "u:mapr",
                        "uuid":"8fea24dc-6e56-6d56-6336-0e0408e15e00"
                }
        ]
}

Output Field

Description

path

The path to the HPE Ezmeral Data Fabric Database table

  • For a path on the local cluster, start the path at the volume mount point. For example, for a table named test under a volume with a mount point at /volume1, specify the following path: /volume1/test
  • For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named customer under volume1 in the sanfrancisco cluster, specify the following path:/mapr/sanfrancisco/volume1/customer
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. Values may not match the actual number of rows. This variance occurs because the counter, for performance reasons, is not updated on each row. Note that internal data management events trigger (in bulk) counter updates.
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 regionsizemb parameter.

The default value is true. If value is set to false, you can manually split tables into regions by using the table region split command.
bulkload

A Boolean value that specifies whether to allow a full bulk load of the table. The default is false. For more information, see Loading Data into Binary Tables and Loading Documents into JSON Tables.
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 HPE Ezmeral Data Fabric Database tries to split the table as the table grows. The default is 4096 MB. This value is ignored if autosplit is set to false.

If autosplit is set to true, HPE Ezmeral Data Fabric Database splits a region when the size of the region exceeds 150% of the average value. For example, if the average value is 4096 MB, HPE Ezmeral Data Fabric Database splits a region that is larger than 6144 MB.

Although splits are automatic, merges are not. For example, if the value of regionsizemb is changed from 8 GB to 4 GB, all regions that are eligible are split automatically, if autosplit is set to true. However, if the value of regionsizemb is changed from 2 GB to 4 GB, regions smaller than 4 GB are not automatically merged.

NOTE
When a table has less than 4 regions, HPE Ezmeral Data Fabric Database 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:

  • Run the table region split and table region merge commands to split the table into regions or to merge regions of the table together.
  • Change the value of regionsizemb.

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 u:<username of the table creator>. This value of the parameter memoryperm in the table cf create and table cf edit commands overrides this value.
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.
defaultunmaskedreadperm The defaultunmaskedreadperm permission on table creation is set to the table creator. This setting takes effect for all new column families (and therefore also all columns/fields within all column families) unless otherwise overridden by the maprcli table cf or the maprcli table cf colperm command. This permission allows the user to read the data unmasked. Users without this permission have the masked data returned.
securitypolicy The security policy or policies tagged to the table. If the parameter is not specified during table creation, the default value is uninitialized ("[-]"), and there is no security policy for the table.
uuid The table UUID.
wireencryptionfrompolicies The system automatically sets this field to true if at least one security policy has wire-level encryption enabled, false otherwise.