Document apiReferenceTables

tables.moveColumn

Move a column to a new position within the same table. Direct mode only; tables with vertical merges, nested tables, or irregular column coverage are rejected, and tracked (suggesting) mode is not supported yet. Available on v2-backed sessions only; v1-backed sessions currently return `CAPABILITY_UNAVAILABLE`.

mutates documentdry runconditional
doc.tables.moveColumn(…)

Expected result

Returns a TableMutationResult receipt; reports NO_OP if the column is already at the requested position.

Inputs

targetTableAddressconditionally required
Fields
kind"block"required
nodeType"table"required
nodeIdstringrequired
nodeIdstringconditionally required
columnIndexintegerrequired
destinationfirst | last | before | afterrequired
first
kind"first"required
last
kind"last"required
before
kind"before"required
columnIndexintegerrequired
after
kind"after"required
columnIndexintegerrequired

Result

Output fields
true
successtruerequired
tableTableAddress
Fields
kind"block"required
nodeType"table"required
nodeIdstringrequired
trackedChangeRefsEntityAddress[]
false
successfalserequired
failureobjectrequired
Fields
code"NO_OP" | "INVALID_TARGET" | "TARGET_NOT_FOUND" | "CAPABILITY_UNAVAILABLE"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • CAPABILITY_UNAVAILABLE
1 more codes
  • INVALID_TARGET

Non-applied receipt codes

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • NO_OP
2 more codes
  • CAPABILITY_UNAVAILABLE
  • INVALID_CONTEXT

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas