MapR 5.1 is at End of Life (EOL) and no longer supported. Please see the latest documentation. This documentation is not being updated.

Home
5.1 Reference
This section provides information about development content including MapR-FS and MapReduce development topics and reference content.
Reference Guide
maprcli and REST API Syntax
table
Performs functions related to MapR-DB tables.
table cf
Manages column families for MapR-DB tables.
table cf list
Lists a MapR table's column families.

MapR 5.1 Documentation

5.1 Reference
This section provides information about development content including MapR-FS and MapReduce development topics and reference content.
- Development Guide
- Reference Guide
  - MapR Control System
  - Hadoop Commands
  - HBase Shell for MapR-DB
    You can manage MapR-DB tables using HBase shell commands and additional HBase shell commands included in the MapR distribution of Hadoop.
  - YARN commands
  - maprcli and REST API Syntax
    - Overview
      Each command reference page includes the command syntax, a table that describes the parameters, and examples of command usage.
    - acl
      Describes the acl commands used to access control lists (ACLs).
    - alarm
      Describes the alarm commands that perform functions related to system alarms.
    - audit
      Describes commands used to audit operations related to cluster management and data access.
    - blacklist
      Describes commands used to blacklist and to list blacklisted users.
    - cluster
      Manages cluster features, gateways, and cluster-wide settings.
    - config
      Manages configuration values for the MapR cluster.
    - dashboard info
      Displays a summary of information about the cluster.
    - dialhome
    - disk
      Describes command for working with disks.
    - dump
      Returns key information about volumes, containers, storage pools, and MapR cluster services for debugging and troubleshooting.
    - entity
      Manages entities (users and groups).
    - fid
      Displays information about MapR-DB or file-system components that are identified by a FID.
    - job
      Manages Hadoop jobs running on the cluster.
    - license
      Manages MapR licenses.
    - nagios generate
      Generates a Nagios Object Definition file that describes the cluster nodes and the services running on each.
    - nfsmgmt
      Refreshes NFS exports and server cache.
    - node
      Manages nodes in the cluster
    - rlimit
      Manages resource usage limits for the cluster.
    - schedule
      Manages schedules.
    - service list
      Lists all services on the specified node, the memory allocated for each service, the state of each service, and log path for each service.
    - setloglevel
      Sets log level on individual services.
    - stream
      Manages stream functionality.
    - table
      Performs functions related to MapR-DB tables.
      - table create
        Creates a new MapR-DB binary or JSON table.
      - table cf
        Manages column families for MapR-DB tables.
        table cf colperm get
        Lists the Access Control Expressions (ACEs) for a specified column.
        table cf colperm set
        Sets Access Control Expressions (ACEs) for a specified column.
        table cf colperm delete
        Deletes the Access Control Expressions (ACEs) for a specified column. Deletion cannot be undone.
        table cf create
        Creates a column family for a MapR binary or JSON table.
        table cf delete
        Deletes a column family from a MapR-DB binary table or JSON table. Deletion cannot be undone.
        table cf edit
        Edits a column family in a binary table or JSON table.
        table cf list
        Lists a MapR table's column families.
      - table delete
        Deletes a MapR-DB binary or JSON table.
      - table edit
        Edits the attributes of a MapR-DB binary or JSON table.
      - table info
        Displays information about a MapR-DB binary or JSON table.
      - table region
        Manages table regions for MapR-DB binary and JSON tables.
      - table replica
        Performs functions related to binary-table replication.
      - table replica elasticsearch
        Sets up and manages the indexing of MapR-DB binary tables in Elasticsearch.
      - table upstream
        Performs functions related to upstream sources for table replication.
    - task
      Manipulates information about the Hadoop jobs that are running on your cluster.
    - trace
      Lets you view and modify the trace buffer, and the trace levels for the system modules.
    - urls
      Displays the status page URL for the specified service.
    - virtualip
      Manages virtual IP addresses for NFS nodes.
    - volume
      Manages volumes, snapshots and mirrors.
  - Alarms Reference
  - Utilities
  - Default MapR Configurations
  - Configuration Files
  - MapR Environment
  - MapR Parameters
  - Best Practices
  - Language Support for MapR-DB Tables
  - Glossary
    This section contains defintions for commonly used terms in MapR Converged Data Platform environments.
  - Source Code for MapR Software
- Glossary
  This section contains defintions for commonly used terms in MapR Converged Data Platform environments.

table cf list

Lists a MapR table's column families.

Syntax

CLI

maprcli table cf list
    -path <path>
    [ -cfname <name> ]

REST

http[s]://<host>:<port>/rest/table/cf/list?path=<path>&<parameters

NOTE: The 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.

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 test under volume1 in the sanfrancisco cluster, specify the following path:/mapr/sanfrancisco/volume1/customer

cfname

The name of the column family to edit.

Output fields

Verbose Field Name	Terse Field Name	Field Value
inmemory	inmem	Whether or not this column value resides in memory
cfname	n	The column family name
maxversions	vmax	Maximum number of versions for this column family
minversions	vmin	Minimum number of versions for this column family
compression	comp	Compression scheme used for this column family
ttl	ttl	Time to live for this column family

Examples

Tersely listing the column families for a table

This example lists all column families for the table newtable.

CLI

maprcli table cf list -path /my.cluster.com/volume1/newtable

REST

https://r1n1.sj.us:8443/rest/table/cf/list?path=%2Fmy.cluster.com%2Fvolume1%2Fnewtable

Example Output

[user@node]# maprcli table cf list -path /mapr/default/user/user/newtable 
comp  inmem  vmax  n           ttl         vmin
lz4   false  3     dine        2147483647  0
lz4   false  3     nahashchid  2147483647  0
lz4   false  3     wollachee   2147483647  0