# Collection Operations

Look up TypeScript methods for creating, describing, loading, releasing, and altering Milvus collections, schemas, aliases, and functions.

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

## Section links

- [createCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#createcollection)
- [Quick-create parameters](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#quick-create-parameters)
- [Explicit schema parameters](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#explicit-schema-parameters)
- [Schema mutation](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#schema-mutation)
- [addCollectionField](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#addcollectionfield)
- [addCollectionFields](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#addcollectionfields)
- [dropCollectionField](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#dropcollectionfield)
- [alterCollectionFieldProperties](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#altercollectionfieldproperties)
- [Collection inspection](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#collection-inspection)
- [hasCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#hascollection)
- [showCollections](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#showcollections)
- [describeCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#describecollection)
- [batchDescribeCollections](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#batchdescribecollections)
- [getCollectionStatistics](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#getcollectionstatistics)
- [Collection properties](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#collection-properties)
- [alterCollectionProperties](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#altercollectionproperties)
- [dropCollectionProperties](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#dropcollectionproperties)
- [Load and release](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#load-and-release)
- [loadCollectionAsync](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#loadcollectionasync)
- [loadCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#loadcollection)
- [refreshLoad](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#refreshload)
- [releaseCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#releasecollection)
- [getLoadingProgress](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#getloadingprogress)
- [getLoadState](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#getloadstate)
- [Rename, truncate, and drop](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#rename-truncate-and-drop)
- [renameCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#renamecollection)
- [truncateCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#truncatecollection)
- [dropCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#dropcollection)
- [Alias operations](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#alias-operations)
- [createAlias](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#createalias)
- [describeAlias](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#describealias)
- [listAliases](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#listaliases)
- [alterAlias](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#alteralias)
- [dropAlias](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#dropalias)
- [Function operations](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#function-operations)
- [alterCollectionSchema](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#altercollectionschema)
- [addFunctionField](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#addfunctionfield)
- [dropFunctionField](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#dropfunctionfield)
- [addCollectionFunction](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#addcollectionfunction)
- [alterCollectionFunction](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#altercollectionfunction)
- [dropCollectionFunction](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#dropcollectionfunction)
- [Compaction and replicas](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#compaction-and-replicas)
- [compact](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#compact)
- [getCompactionState](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#getcompactionstate)
- [getCompactionStateWithPlans](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#getcompactionstatewithplans)
- [getReplicas](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#getreplicas)
- [Primary key helpers](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#primary-key-helpers)
- [External collection refresh Milvus 3.0](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#external-collection-refresh-milvus-30)
- [refreshExternalCollection](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#refreshexternalcollection)
- [getRefreshExternalCollectionProgress](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#getrefreshexternalcollectionprogress)
- [listRefreshExternalCollectionJobs](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#listrefreshexternalcollectionjobs)
- [Snapshots Milvus 3.0](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#snapshots-milvus-30)
- [createSnapshot](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#createsnapshot)
- [dropSnapshot](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#dropsnapshot)
- [listSnapshots](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#listsnapshots)
- [describeSnapshot](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#describesnapshot)
- [restoreSnapshot](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#restoresnapshot)
- [getRestoreSnapshotState](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#getrestoresnapshotstate)
- [exportSnapshot, getExportSnapshotState, restoreExternalSnapshot](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#exportsnapshot-getexportsnapshotstate-restoreexternalsnapshot)
- [listRestoreSnapshotJobs](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#listrestoresnapshotjobs)
- [pinSnapshotData](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#pinsnapshotdata)
- [unpinSnapshotData](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#unpinsnapshotdata)
- [Related](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#related)
- [Function-field backfill](https://milvus-io.github.io/milvus-sdk-node/api-reference/collections/#function-field-backfill)

Collection APIs manage schemas, collection lifecycle, load/release state, aliases, functions, compaction, external collections, and snapshots.

```typescript
import {
  CollectionProperties,
  DataType,
  FunctionType,
  IndexType,
  MetricType,
} from '@zilliz/milvus2-sdk-node';
```

## createCollection

Create a collection. `MilvusClient#createCollection` supports both a quick-create form and explicit schema forms.

```typescript
createCollection(
  data: CreateColReq | CreateColWithSchemaAndIndexParamsReq | CreateCollectionReq
): Promise<ResStatus>
```

### Quick-create parameters

- `collection_name`: Collection name.
- `dimension`: Vector dimension.
- `primary_field_name?`: Primary key field name. Defaults to `id`.
- `id_type?`: `DataType.Int64` or `DataType.VarChar`.
- `vector_field_name?`: Vector field name. Defaults to `embedding`.
- `metric_type?`: Metric type for the default index.
- `enable_dynamic_field?` / `enableDynamicField?`: Enable dynamic field. Defaults to `true`.
- `auto_id?`: Whether primary key auto-increments.
- `consistency_level?`: Consistency level.
- `index_params?`: Optional index params.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

Example:

```typescript
await client.createCollection({
  collection_name: 'books',
  dimension: 768,
  metric_type: 'COSINE',
});
```

### Explicit schema parameters

- `collection_name`: Collection name.
- `fields` or `schema`: Field schema array.
- `shards_num?`: Number of shards.
- `description?`: Collection description.
- `consistency_level?`: Consistency level.
- `num_partitions?`: Initial partition count.
- `partition_key_field?`: Partition key field.
- `clustering_key_field?`: Clustering key field.
- `enable_dynamic_field?` / `enableDynamicField?`: Enable dynamic field.
- `properties?`: Collection properties such as TTL or mmap settings.
- `functions?`: Collection functions such as BM25 or text embedding.
- `external_source?`, `external_spec?`, `file_resource_ids?`: External collection configuration.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

Example:

```typescript
await client.createCollection({
  collection_name: 'books',
  fields: [
    { name: 'id', data_type: DataType.Int64, is_primary_key: true },
    { name: 'title', data_type: DataType.VarChar, max_length: 512 },
    { name: 'embedding', data_type: DataType.FloatVector, dim: 768 },
  ],
  properties: {
    [CollectionProperties.TTL_SECONDS]: 86_400,
  },
});
```

## Schema mutation

 Milvus 3.0 

Milvus 3.0 introduces collection schema alteration for adding and dropping fields and for atomically managing function output fields and indexes. The Node SDK exposes these operations through the following field and function methods.

### addCollectionField

Add one field to an existing collection.

```typescript
addCollectionField(data: AddCollectionFieldReq): Promise<ResStatus>
```

**Parameters**:

- `collection_name`: Collection name.
- `field`: Field schema.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

### addCollectionFields

Add multiple fields by calling `addCollectionField` for each field.

```typescript
addCollectionFields(data: AddCollectionFieldsReq): Promise<ResStatus>
```

**Parameters**:

- `collection_name`: Collection name.
- `fields`: Field schema array.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

### dropCollectionField

Drop a field by name or field ID.

```typescript
dropCollectionField(data: DropCollectionFieldReq): Promise<ResStatus>
```

Provide exactly one field identifier:

- `field_name`: Field name.
- `field_id`: Positive numeric field ID returned by `describeCollection`.
- `collection_name`: Collection name.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

```typescript
await client.dropCollectionField({
  collection_name: 'books',
  field_name: 'legacy_category',
});
```

### alterCollectionFieldProperties

Modify field properties, such as `max_length` or `mmap.enabled`.

```typescript
alterCollectionFieldProperties(data: AlterCollectionFieldPropertiesReq): Promise<ResStatus>
```

**Parameters**:

- `collection_name`: Collection name.
- `field_name`: Field name.
- `properties`: Properties to set.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

Example:

```typescript
await client.alterCollectionFieldProperties({
  collection_name: 'books',
  field_name: 'title',
  properties: { max_length: 1024 },
});
```

## Collection inspection

### hasCollection

Check if a collection exists.

```typescript
hasCollection(data: HasCollectionReq): Promise<BoolResponse>
```

**Response**: `value` is `true` when the collection exists.

### showCollections

List collections or loaded collections.

```typescript
showCollections(data?: ShowCollectionsReq): Promise<ShowCollectionsResponse>
listCollections(data?: ShowCollectionsReq): Promise<ShowCollectionsResponse> // alias
list_collections(data?: ShowCollectionsReq): Promise<ShowCollectionsResponse> // alias
```

**Parameters**:

- `type?`: `ShowCollectionsType.All` or `ShowCollectionsType.Loaded`.
- `collection_names?`: Collection names to check when using loaded status.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

**Response**:

- `data[]`: Collection info with `name`, `id`, `timestamp`, and `loadedPercentage`.

### describeCollection

Describe schema and collection metadata.

```typescript
describeCollection(data: DescribeCollectionReq): Promise<DescribeCollectionResponse>
```

**Parameters**:

- `collection_name`: Collection name.
- `cache?`: Return cached schema when `true`.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

**Response highlights**:

- `schema.fields`: Field schema list.
- `schema.functions`: Function schemas.
- `collectionID`, `collection_name`, `consistency_level`.
- `aliases`.
- `properties`.
- `anns_fields`, `scalar_fields`, `function_fields`: SDK-formatted field maps.

### batchDescribeCollections

Describe multiple collections in one request.

```typescript
batchDescribeCollections(data: BatchDescribeCollectionReq): Promise<BatchDescribeCollectionResponse>
```

**Parameters**:

- `collection_names`: Collection names.
- `collectionIDs?`: Collection IDs.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

### getCollectionStatistics

Get collection statistics.

```typescript
getCollectionStatistics(data: GetCollectionStatisticsReq): Promise<StatisticsResponse>
getCollectionStats(data: GetCollectionStatisticsReq): Promise<StatisticsResponse> // alias
```

**Response**:

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

## Collection properties

### alterCollectionProperties

Modify collection properties.

```typescript
alterCollectionProperties(data: AlterCollectionReq): Promise<ResStatus>
alterCollection(data: AlterCollectionReq): Promise<ResStatus> // deprecated alias
```

**Parameters**:

- `collection_name`: Collection name.
- `properties`: Properties to set.
- `delete_keys?`: Property keys to delete.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

Example:

```typescript
await client.alterCollectionProperties({
  collection_name: 'books',
  properties: { [CollectionProperties.MMAP_ENABLED]: true },
});
```

### dropCollectionProperties

Remove collection properties.

```typescript
dropCollectionProperties(data: DropCollectionPropertiesReq): Promise<ResStatus>
```

**Parameters**:

- `collection_name`: Collection name.
- `properties`: Property keys to remove.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

## Load and release

### loadCollectionAsync

Start loading a collection without waiting for completion.

```typescript
loadCollectionAsync(data: LoadCollectionReq): Promise<ResStatus>
```

### loadCollection

Load a collection and wait until loading progress reaches 100%.

```typescript
loadCollection(data: LoadCollectionReq): Promise<ResStatus>
loadCollectionSync(data: LoadCollectionReq): Promise<ResStatus> // alias
```

**Parameters**:

- `collection_name`: Collection name.
- `replica_number?`: Replica count.
- `resource_groups?`: Target resource groups.
- `refresh?`: Refresh loaded data.
- `load_fields?`: Fields to load.
- `skip_load_dynamic_field?`: Skip dynamic field loading.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

### refreshLoad

Refresh a loaded collection to pick up schema or data changes.

```typescript
refreshLoad(data: RefreshLoadReq): Promise<ResStatus>
```

### releaseCollection

Release a collection from query nodes.

```typescript
releaseCollection(data: ReleaseLoadCollectionReq): Promise<ResStatus>
```

### getLoadingProgress

Get load progress for a collection or partitions.

```typescript
getLoadingProgress(data: GetLoadingProgressReq): Promise<GetLoadingProgressResponse>
```

### getLoadState

Get collection or partition load state.

```typescript
getLoadState(data: GetLoadStateReq): Promise<GetLoadStateResponse>
```

## Rename, truncate, and drop

### renameCollection

Rename a collection and optionally move it to another database.

```typescript
renameCollection(data: RenameCollectionReq): Promise<ResStatus>
```

**Parameters**:

- `collection_name`: Current collection name.
- `new_collection_name`: New collection name.
- `new_db_name?`: Target database name.
- `db_name?`: Current database name.
- `timeout?`: Request timeout in milliseconds.

### truncateCollection

Delete all rows while keeping the schema.

```typescript
truncateCollection(data: DropCollectionReq): Promise<{ status: ResStatus }>
```

### dropCollection

Drop a collection and all its data.

```typescript
dropCollection(data: DropCollectionReq): Promise<ResStatus>
drop_collection(data: DropCollectionReq): Promise<ResStatus> // alias
```

## Alias operations

### createAlias

```typescript
createAlias(data: CreateAliasReq): Promise<ResStatus>
```

**Parameters**: `collection_name`, `alias`, optional `db_name`, optional `timeout`.

### describeAlias

```typescript
describeAlias(data: DescribeAliasReq): Promise<DescribeAliasResponse>
```

### listAliases

```typescript
listAliases(data: ListAliasesReq): Promise<ListAliasesResponse>
```

### alterAlias

```typescript
alterAlias(data: AlterAliasReq): Promise<ResStatus>
```

### dropAlias

```typescript
dropAlias(data: DropAliasReq): Promise<ResStatus>
```

## Function operations

### alterCollectionSchema

Low-level schema alteration API for atomically adding a function output field, its function schema, and optional bound index metadata.

```typescript
alterCollectionSchema(
  data: AlterCollectionSchemaReq
): Promise<AlterCollectionSchemaResponse>
```

**Parameters**:

- `collection_name`: Collection name.
- `field`: Function output field schema.
- `function`: Function schema.
- `index_name?`: Name of the bound index.
- `extra_params?`: Bound index parameters.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

### addFunctionField

Convenience wrapper for adding a BM25 or MinHash function output field and its bound index in one schema alteration.

```typescript
addFunctionField(data: AddFunctionFieldReq): Promise<ResStatus>
```

The output field must be `SparseFloatVector` for BM25 and `BinaryVector` for MinHash. A non-`AUTOINDEX` `index_type` is required.

```typescript
await client.addFunctionField({
  collection_name: 'documents',
  field: {
    name: 'minhash_vector',
    data_type: DataType.BinaryVector,
    dim: 512,
    is_function_output: true,
  },
  function: {
    name: 'body_minhash',
    type: FunctionType.MINHASH,
    input_field_names: ['body'],
    output_field_names: ['minhash_vector'],
    params: { num_hashes: 16, shingle_size: 3 },
  },
  index_name: 'minhash_index',
  extra_params: {
    index_type: IndexType.MINHASH_LSH,
    metric_type: MetricType.MHJACCARD,
    params: { mh_lsh_band: 8 },
  },
});
```

### dropFunctionField

Drop a function together with its output fields and bound indexes.

```typescript
dropFunctionField(data: DropFunctionFieldReq): Promise<ResStatus>
```

```typescript
await client.dropFunctionField({
  collection_name: 'documents',
  function_name: 'body_minhash',
});
```

### addCollectionFunction

Milvus 3.0.6 rejects this legacy method. Use `addFunctionField` to add a BM25 or MinHash function, its output field, and its index. Define text embedding functions when creating the collection.

```typescript
addCollectionFunction(data: AddCollectionFunctionReq): Promise<ResStatus>
```

**Parameters**:

- `collection_name`: Collection name.
- `function`: Function schema.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

### alterCollectionFunction

Update supported settings on an existing function, such as a text embedding function’s description. Milvus 3.0.6 rejects BM25 function alterations.

```typescript
alterCollectionFunction(data: AlterCollectionFunctionReq): Promise<ResStatus>
```

### dropCollectionFunction

Milvus 3.0.6 rejects this legacy method. Use `dropFunctionField` to remove the function, its output field, and its bound index.

```typescript
dropCollectionFunction(data: DropCollectionFunctionReq): Promise<ResStatus>
```

## Compaction and replicas

### compact

Trigger compaction.

```typescript
compact(data: CompactReq): Promise<CompactionResponse>
```

### getCompactionState

```typescript
getCompactionState(data: GetCompactionStateReq): Promise<GetCompactionStateResponse>
```

### getCompactionStateWithPlans

```typescript
getCompactionStateWithPlans(data: GetCompactionPlansReq): Promise<GetCompactionPlansResponse>
```

### getReplicas

Get collection replica information.

```typescript
getReplicas(data: GetReplicaReq): Promise<ReplicasResponse>
describeReplicas(data: GetReplicaReq): Promise<ReplicasResponse> // alias
```

### Primary key helpers

```typescript
getPkFieldName(data: DescribeCollectionReq, desc?: DescribeCollectionResponse): Promise<string>
getPkFieldType(data: DescribeCollectionReq, desc?: DescribeCollectionResponse): Promise<keyof typeof DataType>
getPkField(data: DescribeCollectionReq): Promise<FieldSchema>
```

## External collection refresh Milvus 3.0

### refreshExternalCollection

Trigger a refresh job for an external collection.

```typescript
refreshExternalCollection(data: RefreshExternalCollectionReq): Promise<RefreshExternalCollectionResponse>
```

**Parameters**:

- `collection_name`: Collection name.
- `external_source?`: New external source path.
- `external_spec?`: New external spec configuration.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

### getRefreshExternalCollectionProgress

```typescript
getRefreshExternalCollectionProgress(data: GetRefreshExternalCollectionProgressReq): Promise<GetRefreshExternalCollectionProgressResponse>
```

**Parameters**: `job_id`, optional `timeout`.

### listRefreshExternalCollectionJobs

```typescript
listRefreshExternalCollectionJobs(data?: ListRefreshExternalCollectionJobsReq): Promise<ListRefreshExternalCollectionJobsResponse>
```

**Parameters**: optional `db_name`, `collection_name`, and `timeout`.

## Snapshots Milvus 3.0

### createSnapshot

```typescript
createSnapshot(data: CreateSnapshotReq): Promise<ResStatus>
```

**Parameters**:

- `collection_name`: Collection name.
- `snapshot_name`: Snapshot name.
- `description?`: Snapshot description.
- `compaction_protection_seconds?`: Protection duration.
- `db_name?`: Database name.
- `timeout?`: Request timeout in milliseconds.

### dropSnapshot

```typescript
dropSnapshot(data: DropSnapshotReq): Promise<ResStatus>
```

### listSnapshots

```typescript
listSnapshots(data: ListSnapshotsReq): Promise<ListSnapshotsResponse>
```

### describeSnapshot

```typescript
describeSnapshot(data: DescribeSnapshotReq): Promise<DescribeSnapshotResponse>
```

### restoreSnapshot

Restore a snapshot into a target collection.

```typescript
restoreSnapshot(data: RestoreSnapshotReq): Promise<RestoreSnapshotResponse>
```

**Parameters**:

- `snapshot_name`: Snapshot name.
- `source_collection_name`: Source collection.
- `target_collection_name`: Target collection.
- `source_db_name?`: Source database.
- `target_db_name?`: Target database.
- `timeout?`: Request timeout in milliseconds.

### getRestoreSnapshotState

```typescript
getRestoreSnapshotState(data: GetRestoreSnapshotStateReq): Promise<GetRestoreSnapshotStateResponse>
```

### exportSnapshot, getExportSnapshotState, restoreExternalSnapshot

These methods require Milvus 3.0.6 or later. Export copies a snapshot into a standalone bundle. Export state provides the bundle’s metadata URI when the job completes. External restore creates a new collection and returns a job ID for `getRestoreSnapshotState()`.

```typescript
exportSnapshot(data: ExportSnapshotReq): Promise<ExportSnapshotResponse>
getExportSnapshotState(data: GetExportSnapshotStateReq): Promise<GetExportSnapshotStateResponse>
restoreExternalSnapshot(data: RestoreExternalSnapshotReq): Promise<RestoreSnapshotResponse>
```

### listRestoreSnapshotJobs

```typescript
listRestoreSnapshotJobs(data?: ListRestoreSnapshotJobsReq): Promise<ListRestoreSnapshotJobsResponse>
```

### pinSnapshotData

Pin snapshot data to protect it from garbage collection while it is copied out.

```typescript
pinSnapshotData(data: PinSnapshotDataReq): Promise<PinSnapshotDataResponse>
```

**Parameters**: `collection_name`, `snapshot_name`, optional `ttl_seconds`, `db_name`, and `timeout`.

### unpinSnapshotData

Release a snapshot data pin.

```typescript
unpinSnapshotData(data: UnpinSnapshotDataReq): Promise<ResStatus>
```

**Parameters**: `pin_id`, optional `timeout`.

## Related

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

## Function-field backfill

In SDK 3.0.4+, `addFunctionField()` returns after the schema change is accepted. Milvus asynchronously backfills existing sealed segments through schema-bump compaction. The wrapper supports BM25 → SparseFloatVector and MINHASH → BinaryVector; provide an explicit bound `index_type` other than `AUTOINDEX`.

```typescript
const stats = await client.getCollectionStatistics({
  collection_name: 'documents',
});
if (stats.status.error_code !== ErrorCode.SUCCESS) {
  throw new Error(stats.status.reason);
}
console.log({
  consistent: stats.data.schema_version_consistent_segments,
  total: stats.data.schema_version_total_segments,
});
```

For an existing collection with sealed segments, poll these values with a timeout until `total > 0` and `consistent === total` after numeric conversion. Missing counters do not prove completion. Also check `getIndexState({ collection_name, index_name })` reaches `Finished` (stop on `Failed`) before loading and searching the new field. Empty collections need no historical backfill.
