# Resource Group Operations

Look up TypeScript methods for managing Milvus query-node resource groups, inspecting capacity, and transferring nodes or replicas.

SDK: `@zilliz/milvus2-sdk-node@3.0.10` · Tested with Milvus 3.0.6

Canonical documentation: https://milvus-io.github.io/milvus-sdk-node/api-reference/resource-groups/

## Section links

- [createResourceGroup](https://milvus-io.github.io/milvus-sdk-node/api-reference/resource-groups/#createresourcegroup)
- [listResourceGroups](https://milvus-io.github.io/milvus-sdk-node/api-reference/resource-groups/#listresourcegroups)
- [describeResourceGroup](https://milvus-io.github.io/milvus-sdk-node/api-reference/resource-groups/#describeresourcegroup)
- [updateResourceGroups](https://milvus-io.github.io/milvus-sdk-node/api-reference/resource-groups/#updateresourcegroups)
- [transferNode](https://milvus-io.github.io/milvus-sdk-node/api-reference/resource-groups/#transfernode)
- [transferReplica](https://milvus-io.github.io/milvus-sdk-node/api-reference/resource-groups/#transferreplica)
- [dropResourceGroup](https://milvus-io.github.io/milvus-sdk-node/api-reference/resource-groups/#dropresourcegroup)
- [dropAllResourceGroups](https://milvus-io.github.io/milvus-sdk-node/api-reference/resource-groups/#dropallresourcegroups)
- [updateReplicateConfiguration](https://milvus-io.github.io/milvus-sdk-node/api-reference/resource-groups/#updatereplicateconfiguration)
- [getReplicateConfiguration](https://milvus-io.github.io/milvus-sdk-node/api-reference/resource-groups/#getreplicateconfiguration)
- [Related](https://milvus-io.github.io/milvus-sdk-node/api-reference/resource-groups/#related)
- [Replication streams and WAL recovery](https://milvus-io.github.io/milvus-sdk-node/api-reference/resource-groups/#replication-streams-and-wal-recovery)

Resource group APIs manage query-node resource groups and move nodes or loaded replicas between groups. These APIs are primarily useful for Milvus cluster deployments.

## createResourceGroup

Create a resource group.

```typescript
createResourceGroup(data: CreateResourceGroupReq): Promise<ResStatus>
```

**Parameters**:

- `resource_group`: Resource group name.
- `config?`: Resource group configuration.
- `timeout?`: Request timeout in milliseconds.

```typescript
type ResourceGroupConfig = {
  requests?: { node_num: number };
  limits?: { node_num: number };
  transfer_from?: { resource_group: string }[];
  transfer_to?: { resource_group: string }[];
  node_filter?: { node_labels: KeyValuePair[] };
};
```

Example:

```typescript
await client.createResourceGroup({
  resource_group: 'rg_search',
  config: {
    requests: { node_num: 2 },
    limits: { node_num: 4 },
  },
});
```

## listResourceGroups

List resource group names.

```typescript
listResourceGroups(data?: GrpcTimeOut): Promise<ListResourceGroupsResponse>
```

**Response**:

- `status`: Response status.
- `resource_groups`: Resource group names.

Example:

```typescript
const groups = await client.listResourceGroups();
console.log(groups.resource_groups);
```

## describeResourceGroup

Describe one resource group.

```typescript
describeResourceGroup(data: DescribeResourceGroupsReq): Promise<DescribeResourceGroupResponse>
```

**Parameters**:

- `resource_group`: Resource group name.
- `timeout?`: Request timeout in milliseconds.

**Response**:

```typescript
type ResourceGroup = {
  name: string;
  capacity: number;
  num_available_node: number;
  num_loaded_replica: { [collectionName: string]: number };
  num_outgoing_node: { [collectionName: string]: number };
  num_incoming_node: { [collectionName: string]: number };
  config?: ResourceGroupConfig;
  nodes?: {
    node_id: number;
    address: string;
    hostname: string;
  }[];
};
```

Example:

```typescript
const group = await client.describeResourceGroup({
  resource_group: 'rg_search',
});
```

## updateResourceGroups

Update multiple resource group configurations in one request.

```typescript
updateResourceGroups(data: UpdateRresourceGroupReq): Promise<ResStatus>
```

**Parameters**:

- `resource_groups`: Map from resource group name to `ResourceGroupConfig`.
- `timeout?`: Request timeout in milliseconds.

Example:

```typescript
await client.updateResourceGroups({
  resource_groups: {
    rg_search: {
      requests: { node_num: 2 },
      limits: { node_num: 4 },
    },
  },
});
```

## transferNode

Transfer query nodes between resource groups.

```typescript
transferNode(data: TransferNodeReq): Promise<ResStatus>
```

**Parameters**:

- `source_resource_group`: Source resource group.
- `target_resource_group`: Target resource group.
- `num_node`: Number of nodes to transfer.
- `timeout?`: Request timeout in milliseconds.

Example:

```typescript
await client.transferNode({
  source_resource_group: 'rg_default',
  target_resource_group: 'rg_search',
  num_node: 1,
});
```

## transferReplica

Transfer loaded replicas for a collection between resource groups.

```typescript
transferReplica(data: TransferReplicaReq): Promise<ResStatus>
```

**Parameters**:

- `collection_name`: Collection name.
- `source_resource_group`: Source resource group.
- `target_resource_group`: Target resource group.
- `num_replica`: Number of replicas to transfer.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

Example:

```typescript
await client.transferReplica({
  collection_name: 'books',
  source_resource_group: 'rg_default',
  target_resource_group: 'rg_search',
  num_replica: 1,
});
```

## dropResourceGroup

Drop a resource group.

```typescript
dropResourceGroup(data: DropResourceGroupsReq): Promise<ResStatus>
```

**Parameters**:

- `resource_group`: Resource group name.
- `timeout?`: Request timeout in milliseconds.

Example:

```typescript
await client.dropResourceGroup({ resource_group: 'rg_search' });
```

## dropAllResourceGroups

Drop all non-default resource groups after transferring nodes back to the default resource group.

```typescript
dropAllResourceGroups(): Promise<ResStatus[]>
```

Use this only in cleanup scripts or test environments.

## updateReplicateConfiguration

Update cross-cluster replication configuration.

```typescript
updateReplicateConfiguration(data: UpdateReplicateConfigurationReq): Promise<ResStatus>
update_replicate_configuration(data: UpdateReplicateConfigurationReq): Promise<ResStatus> // alias
```

**Parameters**:

- `clusters`: Cluster connection definitions. Required.
- `cross_cluster_topology?`: Source-to-target topology entries.
- `force_promote?`: Force promote the current cluster to primary.
- `timeout?`: Request timeout in milliseconds.

```typescript
type ReplicateCluster = {
  cluster_id: string;
  connection_param: {
    uri: string;
    token?: string;
  };
  pchannels?: string[];
};

type CrossClusterTopology = {
  source_cluster_id: string;
  target_cluster_id: string;
};
```

Example:

```typescript
await client.updateReplicateConfiguration({
  clusters: [
    {
      cluster_id: 'primary',
      connection_param: {
        uri: 'primary.example.com:19530',
        token: process.env.PRIMARY_TOKEN,
      },
    },
    {
      cluster_id: 'secondary',
      connection_param: {
        uri: 'secondary.example.com:19530',
        token: process.env.SECONDARY_TOKEN,
      },
    },
  ],
  cross_cluster_topology: [
    {
      source_cluster_id: 'primary',
      target_cluster_id: 'secondary',
    },
  ],
});
```

## getReplicateConfiguration

Get the current cross-cluster replication configuration.

```typescript
getReplicateConfiguration(data?: GetReplicateConfigurationReq): Promise<GetReplicateConfigurationResponse>
get_replicate_configuration(data?: GetReplicateConfigurationReq): Promise<GetReplicateConfigurationResponse> // alias
```

**Parameters**:

- `timeout?`: Request timeout in milliseconds.

**Response**:

```typescript
interface GetReplicateConfigurationResponse extends resStatusResponse {
  configuration: {
    clusters: ReplicateCluster[];
    cross_cluster_topology?: CrossClusterTopology[];
  };
}
```

Example:

```typescript
const config = await client.getReplicateConfiguration();
console.log(config.configuration.clusters);
```

## Related

- [API Reference overview](https://milvus-io.github.io/milvus-sdk-node/api-reference/)
- [Resource Management guide](https://milvus-io.github.io/milvus-sdk-node/management/resource-management/)
- [Collection Operations](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/)

## Replication streams and WAL recovery

Use `getReplicateInfo({ target_pchannel, source_cluster_id })` to read a live or salvage checkpoint. Either checkpoint may be `null`, including on a standalone primary without a matching salvage checkpoint.

Use `createReplicateStream({ cluster_id })` to open a duplex gRPC stream to the target. Write `{ replicate_message: { source_cluster_id, message } }` and read `replicate_confirmed_message_info` acknowledgements. Call `end()` once there are no more messages to send. Each stream stays on the endpoint that opened it.

Use `dumpMessages({ pchannel, start_message_id, start_timetick, end_timetick })` to read WAL messages from the old primary. Pass the salvage checkpoint’s message ID and time tick as the starting position. Messages carry a binary `payload` and string `properties`. Use decimal strings for large time ticks.

Both streams support `for await...of` and `cancel()`. The SDK uses its configured timeout by default. Pass `timeout: 0` to stream without a deadline. Closing the SDK closes its active streams. These RPCs were verified on Milvus 3.0.6.
