UltipaDocs
Products
Solutions
Resources
Company
Start Free Trial
UltipaDocs
Start Free Trial
    • Install Ultipa
    • Install Ultipa Manager
  • Deployment with Kubernetes
  • Standalone Mode
  • License
    • Meta Servers
    • Shard Servers
    • HDC Servers
    • Vector Servers
    • Server Statistics
    • Privilege
    • Role (Policy)
    • User
    • Resource Group
  • Configuration
  • Monitoring
  • Security
  • Backup and Restore
  • Auto-Sharding Rebalancing
  • Change Data Capture (CDC)
  1. Docs
  2. /
  3. Operations & Maintenance
  4. /
  5. Access Control

Resource Group

Overview

A resource group defines resource quotas for users, preventing any single user from consuming all cluster resources. Administrators can create resource groups with limits on connections, concurrent queries, query timeouts, and accessible graphs, then bind users to these groups.

Users not bound to any resource group have no resource limits applied (backward compatible).

Showing Resource Groups

To show all resource groups:

GQL
SHOW RESOURCE GROUP

To show a specific resource group:

GQL
SHOW RESOURCE GROUP limited_group

Each resource group provides the following metadata:

Field
Description
nameThe name of the resource group.
max_connectionsMaximum number of concurrent connections (sessions). 0 means unlimited.
max_concurrent_queriesMaximum number of concurrent queries. 0 means unlimited.
max_query_timeoutMaximum query execution time in seconds. 0 means unlimited.
max_graphsMaximum number of graphs the user can access concurrently. 0 means unlimited.
creatorThe user who created the resource group.
create_timeCreation timestamp.

Creating a Resource Group

To create a resource group with all options:

GQL
CREATE RESOURCE GROUP limited_group
  SET max_connections = 10,
      max_concurrent_queries = 5,
      max_query_timeout = 30,
      max_graphs = 3

To create a resource group with partial options (unspecified options default to 0, meaning unlimited):

GQL
CREATE RESOURCE GROUP basic_group SET max_connections = 10

Altering a Resource Group

To modify specific options of a resource group (other options remain unchanged):

GQL
ALTER RESOURCE GROUP limited_group SET max_concurrent_queries = 10

To reset a limit to unlimited:

GQL
ALTER RESOURCE GROUP limited_group SET max_connections = 0

Dropping a Resource Group

All users must be unbound from the resource group before it can be dropped.

GQL
DROP RESOURCE GROUP limited_group

To suppress errors if the resource group does not exist:

GQL
DROP RESOURCE GROUP IF EXISTS limited_group

Binding Users

To bind a user to a resource group:

GQL
ALTER USER analyst SET RESOURCE GROUP limited_group

To unbind a user from its resource group:

GQL
ALTER USER analyst REMOVE RESOURCE GROUP

Resource Limits

Limit
TypeDefaultDescription
max_connectionsuint320Maximum concurrent sessions for the user.
max_concurrent_queriesuint320Maximum queries the user can execute simultaneously.
max_query_timeoutuint320Maximum query execution time in seconds. If the client sets a shorter timeout, the client's value is used. Queries exceeding this limit are automatically terminated.
max_graphsuint320Maximum number of different graphs the user can have active queries on concurrently. Accessing a graph already in the user's active list is allowed.

A value of 0 for any limit means no restriction.

Required Privileges

OperationRequired Privilege
CREATE RESOURCE GROUPSYSTEM_CREATE_POLICY
ALTER RESOURCE GROUPSYSTEM_ALTER_POLICY
SHOW RESOURCE GROUPSYSTEM_SHOW_POLICY
DROP RESOURCE GROUPSYSTEM_DROP_POLICY
ALTER USER SET/REMOVE RESOURCE GROUPSYSTEM_ALTER_USER