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.
      - cluster feature enable
        Allows features to be enabled. Used after upgrading.
      - cluster feature list
        Allows features to be listed. Used after upgrading.
      - cluster gateway delete
        Deletes the list of MapR gateways from a source MapR cluster.
      - cluster gateway get
        Lists the MapR gateways that a source MapR cluster is using.
      - cluster gateway list
        Lists all of the gateways that a source MapR cluster is using.
      - cluster gateway local
        Lists the gateways that are configured on the MapR cluster where this command is run.
      - cluster gateway resolve
        Lists the gateways configured on a MapR cluster that are up and running at the time that the command is issued.
      - cluster gateway set
        Specifies the locations of the MapR gateways that a source MapR cluster can use for table replication to a destination MapR cluster, or for indexing table data in an Elasticsearch cluster.
      - cluster info
      - cluster mapreduce get
        Displays the cluster-wide default for the MapReduce mode.
      - cluster mapreduce set
        Sets the cluster-wide MapReduce mode.
      - cluster queryservice
        Describes the commands to enable/disable and view the settings for the OJAI Distributed Query Service.
        cluster queryservice getconfig
        Retrieves the configuration of the OJAI Distributed Query Service.
        cluster queryservice setconfig
        Enables or disables the OJAI Distributed Query Service. When enabling the service, you can specify the configuration of the service.
    - 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.
    - 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.

cluster queryservice setconfig

Enables or disables the OJAI Distributed Query Service. When enabling the service, you can specify the configuration of the service.

Permissions Required

Only the user that enabled the OJAI Distributed Query Service can run this command. If the service was enabled during installation, user 'mapr' must run the command.

Syntax

CLI

maprcli cluster queryservice setconfig 
              [ -cluster < cluster-name > ]
              -enabled < true | false >
              -clusterid < cluster-id of MapR Drill cluster >
              -storageplugin < Name of MapR Drill Storage plug-in >
              -znode < Root Zookeeper node user by MapR Drill cluster >

REST

Not available

Parameters

Parameter	Description
cluster	(Optional) Name of the cluster that is using secondary indexes to query MapR Database JSON tables
enabled	(Required) Whether the OJAI Distributed Query Service is enabled Values: true or false
clusterid	(Required) Cluster ID of your MapR Drill cluster Refer to the value of the `cluster-id` parameter in the `drill-distrib.conf` file. You can find this file in the `/opt/mapr/drill/drill-<version number>/conf` directory.
storageplugin	(Required) Name of the MapR Drill Storage plug-in instance used to run OJAI queries (usually dfs)
znode	(Required) Name of the root Zookeeper node used by the MapR Drill cluster (usually /drill)

Example

maprcli cluster queryservice setconfig \
   -enabled true \
   -clusterid mycluster \
   -storageplugin dfs \
   -znode /drill