Back to Mastra

Reference: dataset.listVersions() | Datasets

docs/src/content/en/reference/datasets/listVersions.mdx

2025-12-183.0 KB
Original Source

dataset.listVersions()

Added in: @mastra/[email protected]

Lists all versions of the dataset with pagination.

Usage example

typescript
import { Mastra } from '@mastra/core'

const mastra = new Mastra({
  /* storage config */
})

const dataset = await mastra.datasets.get({ id: 'dataset-id' })

const { versions, pagination } = await dataset.listVersions({ page: 0, perPage: 10 })

for (const version of versions) {
  console.log(`Version ${version.version} created at ${version.createdAt}`)
}

Parameters

<PropertiesTable content={[ { name: 'page', type: 'number', isOptional: true, description: 'Page number. Defaults to 0.', }, { name: 'perPage', type: 'number', isOptional: true, description: 'Number of versions per page. Defaults to 20.', }, ]} />

Returns

<PropertiesTable content={[ { name: 'result', type: 'Promise<object>', description: 'Paginated version list.', properties: [ { type: 'object', parameters: [ { name: 'versions', type: 'DatasetVersion[]', description: 'Array of version records.', properties: [ { type: 'DatasetVersion', parameters: [ { name: 'id', type: 'string', description: 'Unique identifier of the version record.', }, { name: 'datasetId', type: 'string', description: 'ID of the parent dataset.', }, { name: 'version', type: 'number', description: 'Version number.', }, { name: 'createdAt', type: 'Date', description: 'When this version was created.', }, ], }, ], }, { name: 'pagination', type: 'object', description: 'Pagination metadata.', properties: [ { type: 'object', parameters: [ { name: 'total', type: 'number', description: 'Total number of versions.', }, { name: 'page', type: 'number', description: 'Current page number.', }, { name: 'perPage', type: 'number | false', description: 'Versions per page, or false if unpaginated.', }, { name: 'hasMore', type: 'boolean', description: 'Whether more pages are available.', }, ], }, ], }, ], }, ], }, ]} />