# Database Operations

Look up request fields and return types for creating, listing, describing, altering, and dropping Milvus databases in Node.js.

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

## Section links

- [createDatabase](https://milvus-io.github.io/milvus-sdk-node/api-reference/databases/#createdatabase)
- [listDatabases](https://milvus-io.github.io/milvus-sdk-node/api-reference/databases/#listdatabases)
- [describeDatabase](https://milvus-io.github.io/milvus-sdk-node/api-reference/databases/#describedatabase)
- [alterDatabaseProperties](https://milvus-io.github.io/milvus-sdk-node/api-reference/databases/#alterdatabaseproperties)
- [dropDatabaseProperties](https://milvus-io.github.io/milvus-sdk-node/api-reference/databases/#dropdatabaseproperties)
- [dropDatabase](https://milvus-io.github.io/milvus-sdk-node/api-reference/databases/#dropdatabase)
- [Working with database context](https://milvus-io.github.io/milvus-sdk-node/api-reference/databases/#working-with-database-context)
- [Related](https://milvus-io.github.io/milvus-sdk-node/api-reference/databases/#related)

Database APIs manage Milvus databases and database-level properties. Most collection and data APIs accept `db_name`; you can also set the active database with [`client.use`](https://milvus-io.github.io/milvus-sdk-node/api-reference/client/#use).

## createDatabase

Create a database.

```typescript
createDatabase(data: CreateDatabaseRequest): Promise<ResStatus>
```

**Parameters**:

- `db_name`: Database name.
- `properties?`: Database properties.
- `timeout?`: Request timeout in milliseconds.

Example:

```typescript
await client.createDatabase({
  db_name: 'analytics',
  properties: {
    owner: 'recommendation-team',
  },
});
```

## listDatabases

List databases.

```typescript
listDatabases(data?: ListDatabasesRequest): Promise<ListDatabasesResponse>
```

**Parameters**:

- `timeout?`: Request timeout in milliseconds.

**Response**:

```typescript
interface ListDatabasesResponse {
  status: ResStatus;
  db_names: string[];
  db_ids: string[];
  created_timestamp: string[];
}
```

Example:

```typescript
const databases = await client.listDatabases();
console.log(databases.db_names);
```

## describeDatabase

Describe database metadata and properties.

```typescript
describeDatabase(data: DescribeDatabaseRequest): Promise<DescribeDatabaseResponse>
```

**Parameters**:

- `db_name`: Database name.
- `timeout?`: Request timeout in milliseconds.

**Response**:

```typescript
interface DescribeDatabaseResponse {
  status: ResStatus;
  db_name: string;
  dbID: number;
  created_timestamp: number;
  properties: KeyValuePair[];
}
```

Example:

```typescript
const db = await client.describeDatabase({ db_name: 'analytics' });
```

## alterDatabaseProperties

Modify database properties.

```typescript
alterDatabaseProperties(data: AlterDatabaseRequest): Promise<ResStatus>
alterDatabase(data: AlterDatabaseRequest): Promise<ResStatus> // alias
```

**Parameters**:

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

Example:

```typescript
await client.alterDatabaseProperties({
  db_name: 'analytics',
  properties: {
    description: 'Analytics workloads',
  },
});
```

## dropDatabaseProperties

Remove database properties by key.

```typescript
dropDatabaseProperties(data: DropDatabasePropertiesRequest): Promise<ResStatus>
```

**Parameters**:

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

Example:

```typescript
await client.dropDatabaseProperties({
  db_name: 'analytics',
  properties: ['description'],
});
```

## dropDatabase

Drop a database.

```typescript
dropDatabase(data: DropDatabasesRequest): Promise<ResStatus>
```

**Parameters**:

- `db_name`: Database name.
- `timeout?`: Request timeout in milliseconds.

Example:

```typescript
await client.dropDatabase({ db_name: 'analytics' });
```

## Working with database context

```typescript
await client.createDatabase({ db_name: 'analytics' });
await client.use({ db_name: 'analytics' });

await client.createCollection({
  collection_name: 'events',
  dimension: 128,
});
```

Alternatively pass `db_name` per request:

```typescript
await client.showCollections({ db_name: 'analytics' });
```

## Related

- [API Reference overview](https://milvus-io.github.io/milvus-sdk-node/api-reference/)
- [Database Operations guide](https://milvus-io.github.io/milvus-sdk-node/operations/database-operations/)
- [User & Role Operations](https://milvus-io.github.io/milvus-sdk-node/api-reference/users-roles/)
