exportrecord

type Appending struct {
	Name, Destination, Format string
	Rows, Bytes               int
	Preview                   bool
}

type Record struct {
	Name string `json:"name"`
	// Destination is the name the script wrote, so a run that sends one result
	// to two places reads as two records rather than as a repeat.
	Destination string `json:"destination"`
	Format      string `json:"format"`
	RowCount    int    `json:"row_count"`
	// Document marks an output written verbatim from a string body, whose
	// RowCount is therefore not a fact about it: without the marker a surface
	// rendering "N rows as html" would describe a dashboard as an empty table.
	Document bool `json:"document,omitempty"`
	// Refresh marks a platform.publish_data call: the run replaced the data
	// region of an existing asset rather than writing a whole output, and
	// Bytes is the payload spliced in, not the document around it.
	Refresh bool `json:"refresh,omitempty"`
	// Bytes is the serialized length of the output in its declared format. A
	// preview serializes to measure rather than estimating, so the number is
	// the same one a real run would report for the same rows.
	Bytes int `json:"bytes"`
	// Preview is true when nothing was persisted.
	Preview      bool   `json:"preview"`
	AssetID      string `json:"asset_id,omitempty"`
	AssetVersion int    `json:"asset_version,omitempty"`
	Bucket       string `json:"bucket,omitempty"`
	Key          string `json:"key,omitempty"`
	// ResourceID, ResourceRef, ResourceURI and ResourceVersion name the managed
	// resource a library output landed in (#1663). A script reads the reference
	// and the uri off the record to cite the file it just wrote, and they are
	// the same ones the next run reports.
	ResourceID      string `json:"resource_id,omitempty"`
	ResourceRef     string `json:"reference,omitempty"`
	ResourceURI     string `json:"uri,omitempty"`
	ResourceVersion int    `json:"version,omitempty"`
	// TableChanges is what the version did to the tables registered over the
	// output's file (#1536): one sentence per table, saying it followed onto
	// the version or is pinned and now behind it. The same sentences are
	// printed into the run log, so the run's history says the table moved, or
	// did not, without the script having to print anything.
	//
	// It is a change report, not the `tables` a fetched reference carries,
	// and is named apart from them for that reason (#1666).
	TableChanges []string `json:"table_changes,omitempty"`
	// Table is the registration the export's register= argument made over
	// the written file (#1820), or the one a draft would have made.
	Table *exporttable.Table `json:"table,omitempty"`
	// References is what references= declared, or a draft would have, and [] a
	// clearing (omitzero keeps it apart from absent). UndeclaredReferences is
	// each reference a portal document names that it did not list (#1834).
	References           []string `json:"references,omitzero"`
	UndeclaredReferences []string `json:"undeclared_references,omitempty"`
	// Sheets is an xlsx output's sheets and the data rows in each (#1849).
	Sheets []tablexlsx.SheetShape `json:"sheets,omitempty"`
}