dataset.listItems()

追加バージョン： @mastra/core@1.4.0

データセット内の項目を一覧表示します。version だけを指定した場合、そのバージョンの全項目を含む単独の DatasetItem[] スナップショットを返します。それ以外（引数なし、または version の有無を問わず search / page / perPage を指定）の場合は、ページネーションされた { items, pagination } 形式を返します。

使用例

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 })

パラメータ

version?:

number

項目を一覧表示するデータセットバージョン。単独で指定すると、そのバージョンの全項目を単独の DatasetItem[] スナップショットとして返します。version とともに search / page / perPage を指定すると、ページネーション形式に切り替わります。

page?:

number

ページネーションのページ番号。デフォルトは 0 です。

perPage?:

number

1ページあたりの項目数。デフォルトは 20 です。

search?:

string

項目を絞り込む検索文字列。

戻り値

version だけを指定した場合（search、page、perPage は未指定）：

result:

Promise<DatasetItem[]>

指定したデータセットバージョンの全項目を含む単独の配列。この形式は後方互換性のために維持されていますが、非推奨です。常に以下のページネーション形式を受け取るには、page / perPage（または search）を指定してください。

それ以外の場合（引数なし、または version の有無を問わず search / page / perPage を指定）：

result:

Promise<object>

ページネーションされたレスポンス。

object

items:

DatasetItem[]

現在のページの項目配列。

pagination:

object

ページネーションのメタデータ。

object

total:

number

項目の総数。

page:

number

現在のページ番号。

perPage:

number | false

1ページあたりの項目数。ページネーションしない場合は false。

hasMore:

boolean

次のページがあるかどうか。