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
stream
Manages stream functionality.
stream purge
Runs the purge process, removing messages that are marked for deletion and reclaiming disk space.

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.
      - 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.
      - stream replica remove
        Unregisters a stream as the replica of another stream.
      - stream replica resume
        Resumes replication from one stream to another stream.
      - 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 the partitions in the topics that are in a stream.
      - 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-DB tables.
    - 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.

`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.

Permission required to run this command: Your user ID must have the adminperm permission on the stream.

NOTE: The mapr user is not treated as a superuser. MapR Streams 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	`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.