# Partition Operations

Look up TypeScript methods for creating, listing, loading, releasing, and dropping Milvus collection partitions.

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/partitions/

## Section links

- [createPartition](https://milvus-io.github.io/milvus-sdk-node/api-reference/partitions/#createpartition)
- [hasPartition](https://milvus-io.github.io/milvus-sdk-node/api-reference/partitions/#haspartition)
- [listPartitions](https://milvus-io.github.io/milvus-sdk-node/api-reference/partitions/#listpartitions)
- [getPartitionStatistics](https://milvus-io.github.io/milvus-sdk-node/api-reference/partitions/#getpartitionstatistics)
- [loadPartitions](https://milvus-io.github.io/milvus-sdk-node/api-reference/partitions/#loadpartitions)
- [loadPartitionsSync](https://milvus-io.github.io/milvus-sdk-node/api-reference/partitions/#loadpartitionssync)
- [releasePartitions](https://milvus-io.github.io/milvus-sdk-node/api-reference/partitions/#releasepartitions)
- [dropPartition](https://milvus-io.github.io/milvus-sdk-node/api-reference/partitions/#droppartition)
- [Related](https://milvus-io.github.io/milvus-sdk-node/api-reference/partitions/#related)

Partition APIs manage collection partitions. Use partitions to organize data within a collection and optionally load or release only selected partitions.

## createPartition

Create a partition in a collection.

```typescript
createPartition(data: CreatePartitionReq): Promise<ResStatus>
```

**Parameters**:

- `collection_name`: Collection name.
- `partition_name`: Partition name.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

Example:

```typescript
await client.createPartition({
  collection_name: 'books',
  partition_name: 'tenant_a',
});
```

## hasPartition

Check whether a partition exists.

```typescript
hasPartition(data: HasPartitionReq): Promise<BoolResponse>
```

**Parameters**:

- `collection_name`: Collection name.
- `partition_name`: Partition name.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

**Response**:

- `status`: Response status.
- `value`: `true` when the partition exists.

Example:

```typescript
const exists = await client.hasPartition({
  collection_name: 'books',
  partition_name: 'tenant_a',
});
```

## listPartitions

List partitions in a collection.

```typescript
listPartitions(data: ShowPartitionsReq): Promise<ShowPartitionsResponse>
showPartitions(data: ShowPartitionsReq): Promise<ShowPartitionsResponse> // alias
```

**Parameters**:

- `collection_name`: Collection name.
- `type?`: `ShowPartitionsType.All` or `ShowPartitionsType.Loaded`.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

**Response**:

- `partition_names`: Partition names.
- `partitionIDs`: Partition IDs.
- `data[]`: Formatted partition info with `name`, `id`, `timestamp`, and `loadedPercentage`.

Example:

```typescript
const partitions = await client.listPartitions({ collection_name: 'books' });
console.log(partitions.partition_names);
```

## getPartitionStatistics

Get partition statistics.

```typescript
getPartitionStatistics(data: GetPartitionStatisticsReq): Promise<StatisticsResponse>
getPartitionStats(data: GetPartitionStatisticsReq): Promise<StatisticsResponse> // alias
```

**Parameters**:

- `collection_name`: Collection name.
- `partition_name`: Partition name.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

**Response**:

- `stats`: Raw key-value statistics.
- `data.row_count`: Parsed row count.

Example:

```typescript
const stats = await client.getPartitionStatistics({
  collection_name: 'books',
  partition_name: 'tenant_a',
});
```

## loadPartitions

Load one or more partitions into query nodes.

```typescript
loadPartitions(data: LoadPartitionsReq): Promise<ResStatus>
```

**Parameters**:

- `collection_name`: Collection name.
- `partition_names`: Partition names to load.
- `replica_number?`: Number of replicas.
- `resource_groups?`: Resource groups to load into.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

Example:

```typescript
await client.loadPartitions({
  collection_name: 'books',
  partition_names: ['tenant_a'],
  replica_number: 1,
});
```

## loadPartitionsSync

Load partitions and wait until loading progress reaches 100%.

```typescript
loadPartitionsSync(data: LoadPartitionsReq): Promise<ResStatus>
```

Throws if loading fails.

## releasePartitions

Release partitions from query nodes.

```typescript
releasePartitions(data: ReleasePartitionsReq): Promise<ResStatus>
```

**Parameters**:

- `collection_name`: Collection name.
- `partition_names`: Partition names to release.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

Example:

```typescript
await client.releasePartitions({
  collection_name: 'books',
  partition_names: ['tenant_a'],
});
```

## dropPartition

Drop a partition and all data in it. The default partition cannot be dropped.

```typescript
dropPartition(data: DropPartitionReq): Promise<ResStatus>
```

**Parameters**:

- `collection_name`: Collection name.
- `partition_name`: Partition name.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

Example:

```typescript
await client.dropPartition({
  collection_name: 'books',
  partition_name: 'tenant_a',
});
```

## Related

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