Class Collections

Collections preserve snapshots of pod-based indexes. Access them through Pinecone.collections; do not construct this class directly. Use Backups for index backups instead of pod-based collections.

Example

import { Pinecone } from '@pinecone-database/pinecone';

const pc = new Pinecone();
const collections = await pc.collections.list();

Index

Constructors

constructor

Methods

create delete describe list

Constructors

constructor

new Collections(config: PineconeConfiguration): Collections
Parameters
- config: PineconeConfiguration
Returns Collections
- Defined in src/control/collections/collections.ts:26

Methods

create

create(options: CreateCollectionOptions): Promise<CollectionModel>
Starts creating a collection from a pod-based index.
Parameters
- options: CreateCollectionOptions
  The collection name and the source pod-based index name.
Returns Promise<CollectionModel>
The collection metadata and status; check Collections.describe for readiness.
Throws
Errors.PineconeArgumentError when the collection name or source is empty.
Example
```
import { Pinecone } from '@pinecone-database/pinecone';

const pc = new Pinecone();
const collection = await pc.collections.create({
  name: 'catalog-snapshot',
  source: 'catalog-pod-index',
});
console.log(collection.status);
```
- Defined in src/control/collections/collections.ts:67

delete

delete(collectionName: string): Promise<void>
Deletes a collection.
Parameters
- collectionName: string
  The collection name, such as catalog-snapshot.
Returns Promise<void>
Resolves when the deletion request succeeds.
Throws
Errors.PineconeArgumentError when the collection name is empty.
Example
```
import { Pinecone } from '@pinecone-database/pinecone';

const pc = new Pinecone();
await pc.collections.delete('catalog-snapshot');
```
- Defined in src/control/collections/collections.ts:106

describe

describe(collectionName: string): Promise<CollectionModel>
Retrieves the metadata and status of a collection.
Parameters
- collectionName: string
  The collection name, such as catalog-snapshot.
Returns Promise<CollectionModel>
The collection status, size, dimension, and record count.
Throws
Errors.PineconeArgumentError when the collection name is empty.
Example
```
import { Pinecone } from '@pinecone-database/pinecone';

const pc = new Pinecone();
const collection = await pc.collections.describe('catalog-snapshot');
console.log(collection.status);
```
- Defined in src/control/collections/collections.ts:87

list

list(): Promise<CollectionList>
Lists all collections in the project.

Returns Promise<CollectionList>
The collections and their current status.
Example
```
import { Pinecone } from '@pinecone-database/pinecone';

const pc = new Pinecone();
const result = await pc.collections.list();
console.log(result.collections);
```
- Defined in src/control/collections/collections.ts:44

Class Collections

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Collections

Methods

create

Parameters

Returns Promise<CollectionModel>

Throws

Example

delete

Parameters

Returns Promise<void>

Throws

Example

describe

Parameters

Returns Promise<CollectionModel>

Throws

Example

list

Returns Promise<CollectionList>

Example

Settings

On This Page