Skip to content
SHAMPOO

Tool catalogue

export

Read · Ordinary · Tasks and notes

export

  • Category: tasks
  • Access: read
  • Audience: ordinary (an ordinary user normally calls this directly)

Purpose

Export caller-visible rows as portable pocket-export-v1 JSON.

Arguments

Optional: tables.

  • tables. Note: Subset of tables; omitted means all exportable.

Result

Envelope with format, schema_version, export_id, tables map and row count.

Boundaries

Project-scoped reads; foreign projects read empty. Import writes only in-scope rows, skipping others with counts.

Lifecycle / side effects

Read-only feed/export. Import merges idempotently in one transaction.

Errors

Bad types/anchors/envelopes rejected. Failures move nothing (atomic).

Example

{}

Result shape:

{
  "format": "shampoo-export-v1"
}

See also

import, changes_since.

On this page