Class RestoreJobs

Restore jobs track the creation of indexes from backups. Access them through Pinecone.restoreJobs; do not construct this class directly. Start a restore with Backups.createIndex.

Example

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

const pc = new Pinecone();
const jobs = await pc.restoreJobs.list();

Index

Constructors

constructor

Methods

describe list

Constructors

constructor

new RestoreJobs(config: PineconeConfiguration): RestoreJobs
Parameters
- config: PineconeConfiguration
Returns RestoreJobs
- Defined in src/control/restoreJobs/restoreJobs.ts:27

Methods

describe

describe(jobId: string): Promise<RestoreJobModel>
Retrieves the current progress of a restore job.
Parameters
- jobId: string
  The restoreJobId returned by Backups.createIndex.
Returns Promise<RestoreJobModel>
The restore status, target index, and completion percentage.
Throws
Errors.PineconeArgumentError when the restore job ID is empty.
Example
```
import { Pinecone } from '@pinecone-database/pinecone';

const pc = new Pinecone();
const job = await pc.restoreJobs.describe('4d4c8693-10fd-4204-a57b-1e3e626fca07');
console.log(job.status, job.percentComplete);
```
See
Backups.createIndex to start a restore.
- Defined in src/control/restoreJobs/restoreJobs.ts:68

list

list(options?: ListRestoreJobsOptions): Promise<RestoreJobList>
Lists one page of restore jobs in the project.
Parameters
- Optionaloptions: ListRestoreJobsOptions
  Page size and continuation token. Omit to fetch the first page with the default size.
Returns Promise<RestoreJobList>
Jobs in data; pass pagination.next as paginationToken to fetch the next page.
Example
```
import { Pinecone } from '@pinecone-database/pinecone';

const pc = new Pinecone();
const page = await pc.restoreJobs.list({ limit: 10 });
console.log(page.data, page.pagination?.next);
```
- Defined in src/control/restoreJobs/restoreJobs.ts:46

Class RestoreJobs

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RestoreJobs

Methods

describe

Parameters

Returns Promise<RestoreJobModel>

Throws

Example

See

list

Parameters

Returns Promise<RestoreJobList>

Example

Settings

On This Page