dataset.listItems()

Ajouté dans : @mastra/core@1.4.0

Répertorie les éléments du dataset. Lorsque seul version est fourni, renvoie un instantané DatasetItem[] brut de tous les éléments dans cette version. Dans tous les autres cas — aucun argument, ou search / page / perPage fourni avec ou sans version — la méthode renvoie une structure paginée { items, pagination }.

Exemple d’utilisation

import { Mastra } from '@mastra/core'

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

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

// Paginated list (default: page 0, 20 per page)
const result = await dataset.listItems()

// List with search
const filtered = await dataset.listItems({ search: 'TypeScript', page: 0, perPage: 10 })

// Paginated list scoped to a specific version
const versionedPage = await dataset.listItems({ version: 2, page: 0, perPage: 20 })

// Version-only snapshot returns a bare DatasetItem[] (deprecated form —
// prefer passing page/perPage to receive the paginated shape).
const versionedItems = await dataset.listItems({ version: 2 })

Paramètres

version?:

number

Version du dataset dans laquelle répertorier les éléments. Lorsqu’il est transmis seul, ce paramètre renvoie tous les éléments de cette version sous la forme d’un instantané DatasetItem[] brut. La transmission de search / page / perPage avec version utilise la structure paginée.

page?:

number

Numéro de page pour la pagination. La valeur par défaut est 0.

perPage?:

number

Nombre d’éléments par page. La valeur par défaut est 20.

search?:

string

Chaîne de recherche utilisée pour filtrer les éléments.

Valeur renvoyée

Lorsque seul version est fourni, sans search, page ni perPage :

result:

Promise<DatasetItem[]>

Tableau brut de tous les éléments dans la version indiquée du dataset. Cette structure est conservée pour la rétrocompatibilité et est obsolète. Transmettez page / perPage (ou search) pour toujours recevoir la structure paginée ci-dessous.

Dans tous les autres cas — aucun argument, ou search / page / perPage fourni avec ou sans version :

result:

Promise<object>

Réponse paginée.

object

items:

DatasetItem[]

Tableau des éléments de la page actuelle.

pagination:

object

Métadonnées de pagination.

object

total:

number

Nombre total d’éléments.

page:

number

Numéro de la page actuelle.

perPage:

number | false

Nombre d’éléments par page, ou false en l’absence de pagination.

hasMore:

boolean

Indique si d’autres pages sont disponibles.