Skip to main content

dataset.listVersions()

Added in: @mastra/core@1.4.0

Lists all versions of the dataset with pagination.

Usage example
Direct link to Usage example

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
Direct link to Parameters

page?:

number
Page number. Defaults to `0`.

perPage?:

number
Number of versions per page. Defaults to `20`.

Returns
Direct link to Returns

result:

Promise<object>
Paginated version list.
object

versions:

DatasetVersion[]
Array of version records.
DatasetVersion

id:

string
Unique identifier of the version record.

datasetId:

string
ID of the parent dataset.

version:

number
Version number.

createdAt:

Date
When this version was created.

pagination:

object
Pagination metadata.
object

total:

number
Total number of versions.

page:

number
Current page number.

perPage:

number | false
Versions per page, or `false` if unpaginated.

hasMore:

boolean
Whether more pages are available.
On this page