system offheap-pools

Retrieves usage and available capacity per off-heap memory pool name.

Command properties

Property	Description
Command type	Driver query
Required permission	None
License usage	Not counted
Parallel execution	Not supported
Distributed execution	Not supported

Syntax

system offheap-pools

Output fields

Field	Type	Description
type	string	Memory type. Always `offheap`
name	string	Off-heap memory pool name
using	long	Current usage of the memory pool (bytes)
available	long	Available capacity of the memory pool (bytes). The total pool size minus current usage.

Error codes

Parsing errors

N/A

Runtime errors

N/A

Description

The system offheap-pools command retrieves the current usage of off-heap memory by pool. Off-heap memory is a memory area managed directly outside the JVM heap, used for indexes and large buffers.

Each pool's name, current usage (using), and remaining available capacity (available) can be checked.

Examples

Retrieve off-heap memory pool status
```
system offheap-pools
```
Retrieves the usage and available capacity of all off-heap memory pools.

Retrieve usage converted to MB

system offheap-pools
| eval using_mb = round(using / 1048576, 2)
| eval available_mb = round(available / 1048576, 2)
| fields name, using_mb, available_mb

Converts current usage and available capacity for each pool to MB.