hana-cli/docs/02-commands/performance-monitoring/workload-management.md

HANA Developer Command Line Interface

# workloadManagement

> Command: `workloadManagement`  
> Category: **Performance Monitoring**  
> Status: Production Ready

## Description

Configure and view workload classes and mappings in the SAP HANA database. This command helps manage workload management configuration, including priority settings, active sessions, and available workload views.

## Syntax

```bash
hana-cli workloadManagement [schema] [group] [options]
```

## Aliases

- `wlm`
- `workloads`
- `workloadClass`
- `workloadmgmt`

## Command Diagram

```mermaid
graph TD
    Start([hana-cli workloadManagement]) --> Input{Input Parameters}
    Input -->|schema| Schema[Schema Name<br/>Default: CURRENT_SCHEMA]
    Input -->|group| Group[Workload Group<br/>Default: *]
    Input -->|showViews| ShowViews[Show Workload Views]
    
    Schema --> CalcSchema[Calculate Schema<br/>Name]
    Group --> CalcSchema
    
    CalcSchema --> CheckViews{Show<br/>Views?}
    
    CheckViews -->|Yes| GetViews[Query Available<br/>Workload Views]
    CheckViews -->|No| QueryWorkload[Query Workload<br/>Configuration]
    
    GetViews --> DisplayViews[Display Views<br/>and Columns]
    DisplayViews --> QueryWorkload
    
    QueryWorkload --> CheckFilters{Apply<br/>Filters?}
    
    CheckFilters -->|priority| FilterPriority[Filter by<br/>Priority]
    CheckFilters -->|activeOnly| FilterActive[Filter Active<br/>Sessions Only]
    CheckFilters -->|group| FilterGroup[Filter by<br/>Workload Group]
    
    FilterPriority --> ApplyLimit[Apply Limit<br/>Default: 200]
    FilterActive --> ApplyLimit
    FilterGroup --> ApplyLimit
    CheckFilters -->|none| ApplyLimit
    
    ApplyLimit --> Display[Display Workload<br/>Configuration]
    
    Display --> Complete([Command Complete])
    
    style Start fill:#0092d1
    style Complete fill:#2ecc71
    style Input fill:#f39c12
    style CheckViews fill:#f39c12
    style CheckFilters fill:#f39c12
    style ShowViews fill:#9b59b6
```

## Parameters

### Positional Arguments

| Parameter | Type   | Description                                    |
|-----------|--------|------------------------------------------------|
| `schema`  | string | Schema name (default: current schema)          |
| `group`   | string | Workload group name pattern (default: `*`)     |

### Options

| Option        | Alias           | Type    | Default               | Description                                                  |
|---------------|-----------------|---------|------------------------|--------------------------------------------------------------|
| `--group`     | `-g`            | string  | `*`                   | Workload group name pattern                                  |
| `--workload`  | `-w`            | string  | -                     | Workload class name                                          |
| `--schema`    | `-s`            | string  | `**CURRENT_SCHEMA**`  | Schema name                                                  |
| `--priority`  | `-p`            | string  | -                     | Workload priority filter                                     |
| `--activeOnly`| `-a`            | boolean | `false`               | Show only workload groups with active sessions               |
| `--showViews` | `--sv`, `--views`| boolean | `false`               | Include available workload views and their columns           |
| `--limit`     | `-l`            | number  | `200`                 | Maximum number of results to display                         |

### Connection Parameters

| Option    | Alias | Type    | Default | Description                                          |
|-----------|-------|---------|---------|------------------------------------------------------|
| `--admin` | `-a`  | boolean | `false` | Connect via admin (default-env-admin.json)           |
| `--conn`  | -     | string  | -       | Connection filename to override default-env.json     |

### Troubleshooting

| Option              | Alias     | Type    | Default | Description                                                                 |
|---------------------|-----------|---------|---------|-----------------------------------------------------------------------------|
| `--disableVerbose`  | `--quiet` | boolean | `false` | Disable verbose output                                                      |
| `--debug`           | `-d`      | boolean | `false` | Debug hana-cli itself by adding output of intermediate details             |

## Examples

### Show Available Workload Views

```bash
hana-cli workloadManagement --showViews
```

Display all available workload management views and their column definitions.

### View Workload Configuration

```bash
hana-cli workloadManagement --schema MYSCHEMA --group DEFAULT
```

Display workload configuration for a specific schema and group.

### Filter Active Workloads Only

```bash
hana-cli workloadManagement --activeOnly --limit 100
```

Show only workload groups with active sessions, limited to 100 results.

### View All Workload Classes

```bash
hana-cli workloadManagement
```

Display all workload classes for the current schema with default settings.

## Related Commands

See the [Commands Reference](../all-commands.md) for other commands in this category.

## See Also

- [Category: Performance Monitoring](..)
- [All Commands A-Z](../all-commands.md)