HPE Ezmeral Data Fabric 6.1.x is In Maintenance and transitions to "End of Maintenance" in June 2024. Please see the latest documentation.

About MapR 6.1
This site contains the main documentation for Version 6.1 of the MapR Converged Data Platform, including installation, configuration, administration, and reference information.
6.1 Installation
This section contains information about installing and upgrading MapR software. It also contains information about how to migrate data and applications from an Apache Hadoop cluster to a MapR cluster.
6.1 MapR Data Platform
MapR Data Platform is the industry-leading data platform for AI and analytics that solves enterprise business needs.
6.1 Administration
This section describes how to manage the nodes and services that make up a cluster.
- Administering Users and Clusters
  Lists topics that help manage a MapR cluster.
- Administering Nodes
  Provides a synopsis of managing nodes in a cluster.
- Administering Volumes
  This section provide information about how to organize and manage data using volumes, a unique feature of MapR clusters.
- Administering Files and Directories
- Administering Tables
  Administration of the MapR Database is done primarily via the command line (maprcli) or with the Managed Control System (MCS). Regardless of whether the MapR Database table is used for binary files or JSON documents, the same types of commands are used with slightly different parameter options. MapR Database administration is associated with tables, columns and column families, and table regions.
- Administering Streams
- Administering MapR Gateways
  A MapR gateway mediates one-way communication between a source MapR cluster and a destination cluster. You can replicate MapR Database tables (binary and JSON) and MapR Event Store For Apache Kafka streams. MapR gateways also apply updates from JSON tables to their secondary indexes and propagate Change Data Capture (CDC) logs.
- Administering Services
- Monitoring the Cluster
  This section describes how to monitor the health and performance of a MapR cluster.
- Configuring Security
  Describes how to configure security and manage secure clusters.
- Managing Secure Clusters
  Provides procedures that will enable you to use MapR clusters securely.
- Administering the MapR Data Access Gateway
  The MapR Data Access Gateway is a service that acts as a proxy and gateway for translating requests between lightweight client applications and the MapR cluster. This section describes considerations when upgrading the service, how to modify configuration settings, and how to administer and manage the service.
- Planning for High Availability
- Administrator's Reference
  This section contains in-depth reference information for the administrator.
  - maprcli and REST API Syntax
    This section provides information about the MapR command API. Most commands can be run on the command-line interface (CLI), or by making REST requests programmatically or in a browser.
    - Overview
      Each command reference page includes the command syntax, a table that describes the parameters, and examples of command usage.
    - acerole validate
      Verifies given user roles for ACEs exists in the /opt/mapr/conf/m7_permissions_roles_refimpl.conf file.
    - 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
      Lists configuration values for the MapR cluster.
    - dashboard info
      Displays a summary of information about the cluster.
    - dialhome
    - disk
      Lists disk parameters.
    - 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 Database or file-system components that are identified by a FID.
    - file
      Lets you perform tiering operations at the file level.
    - job
      Manages Hadoop jobs running on the cluster.
    - license
      Manages MapR licenses.
    - nfsmgmt
      Refreshes NFS exports and server cache.
    - nfs4mgmt
      Manages NFSv4 server.
    - node
      Manages nodes in the cluster
    - rlimit
      Manages resource usage limits for the cluster.
    - schedule
      Manages schedules.
    - security
    - 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.
      - stream assign list
        For the given stream, lists consumers and the topics and partitions that the consumers are reading messages from.
      - stream create
        Creates a new stream.
      - stream cursor delete
        Deletes committed cursors that are in the partitions in a stream.
      - stream cursor list
        Lists the cursors for the consumers of a stream.
      - stream delete
        Deletes the specified stream. Deleted streams cannot be recovered unless they were previously replicated.
      - stream edit
        Edits the values of parameters for the specified stream.
      - stream info
        Displays the values of the parameters of the specified stream.
      - stream purge
        Runs the purge process, removing messages that are marked for deletion and reclaiming disk space.
      - stream replica add
        Registers an existing stream as a replica of the specified stream.
      - stream replica autosetup
        Sets up and starts replication between a source stream and replica stream.
      - stream replica edit
        Modifies the way in which messages are replicated from one stream to another.
      - stream replica list
        Lists the replicas of a given stream.
      - stream replica pause
        Pauses replication from a source stream to a replica stream during autosetup and replication phases.
      - stream replica remove
        Unregisters a stream as the replica of another stream.
      - stream replica resume
        Resumes replication from one stream to another stream Replication can be paused during autosetup and replication phases. When replication resumes, it continues from where it left off.
      - stream upstream add
        Registers a stream as an upstream source for a given stream. For example, if you wanted to replicate messages from Stream_A to Stream_B, Stream_A would be the upstream source for Stream_B.
      - stream upstream list
        Lists all of the streams that are replicating to a given stream.
      - stream upstream remove
        Unregisters a stream as an upstream source for a given stream.
      - stream topic create
        Creates a topic in the specified stream.
      - stream topic delete
        Deletes the specified topic from the specified stream.
      - stream topic edit
        Allows you to increase the number of partitions that are in the specified topic.
      - stream topic info
        Lists information about a stream's topic, grouped by partition ID.
      - stream topic list
        Lists the topics that are in a stream, as well as the number of partitions in each topic.
    - table
      Performs functions related to MapR Database tables.
    - tier
      Lets you create, modify, remove, and retrieve list of tiers and tiering rules.
    - 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.
  - Utilities
    Contains information about various scripts and utilities, that help setup, maintain, and monitor clusters.
  - Configuration Files
    This section contains reference information about various configuration files.
  - Alarms Reference
    The pages in this section provide details about all of the types of alarms.
  - MapR Data Platform Environment
    This section provides information associated with the MapR Data Platform environment.
  - Sample JSON File for Metering
    A sample metering JSON file for an 8-node cluster with no workloads enabled.
  - Metering Data Descriptions
    This table lists the metrics collected by the metering feature.
- Troubleshooting Cluster Administration
  Lists the common errors and their solutions.
- Best Practices for Backing Up MapR Information
  Lists the best practices and performance considerations to follow when backing up MapR information.
6.1 Development
This section contains information related to application development for Ezmeral ecosystem components and MapR Data Platform products, including the file system, Database (Key-Value and JSON), and Event Streams.
Other Docs
This section contains release-independent information, including: MapR Installer documentation, Ecosystem release notes, interoperability matrices, security vulnerabilities, and links to other MapR version documentation.
Glossary
Definitions for commonly used terms in MapR Converged Data Platform environments.

`stream purge`

Runs the purge process, removing messages that are marked for deletion and reclaiming disk space.

For information about the purge process, see Time-to-Live for Messages.

NOTE The mapr user is not treated as a superuser. MapR Event Store For Apache Kafka does not allow the mapr user to run this command unless that user is given the relevant permission or permissions with access-control expressions.

Permissions Required

To run this command, your user ID must have the following permissions:

readAce and writeAce on the volume
lookupdir on directories in the path
adminperm permission on the stream

NOTE The mapr user is not treated as a superuser. MapR Event Store For Apache Kafka 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 stream purge -path <Stream Path>`
REST	`http[s]://<host>:<port>/rest/stream/purge?path=<path>`

Parameters

Parameter	Description
`path`	The path and name of the stream to reclaim disk space from.