Skip to content
uc-apx

uc-apx edit column

Edit an existing column <NAME> ( ... ) inside an interactiveGrid, classicReport, or interactiveReport region. Common rewrites:

  • switch a varchar2/number column to a selectList backed by an LOV;
  • add a PL/SQL function-body default (e.g. return v(‘APP_USER’));
  • flip the column to read-only.

Each —flag corresponds to a single property or block. Combine flags to apply multiple changes in one shot; the column is re-parsed after the edits to fail-fast on a broken splice.

Usage

Section titled “Usage”
uc-apx edit column [flags]

Flags

Section titled “Flags”
FlagTypeDefaultDescription
--avatar-css-classesstringAvatar column: settings.cssClasses, e.g. u-color-13.
--avatar-iconstringAvatar column: settings.icon (when —avatar-type icon).
--avatar-image-columnstringAvatar column: settings.image.urlColumn (when —avatar-type image).
--avatar-initials-columnstringAvatar column: settings.initials (when —avatar-type initials).
--avatar-typestringAvatar column: settings.type (image, initials, or icon). Implies —type avatar.
--badge-iconstringBadge column: settings.icon (a column → &COL., or a static fa-* class).
--badge-labelstringBadge column: settings.label (static text or column). Implies —type badge.
--badge-state-columnstringBadge column: settings.state (column driving the badge color).
--badge-value-columnstringBadge column: settings.value (the column to render as the badge). Implies —type badge.
--columnstringColumn id (NAME) to edit [required]
--default-plsqlSet default.type: functionBody + plsqlFunctionBody: <body>. Body is wrapped in a `plsql code block. Accepts @path/to/file.plsql to read from disk; @@ escapes a literal leading @.
--default-staticstringSet default.type: static + staticValue: <value>.
--dry-runPrint the rewritten file content to stdout without writing
--help-textstringSet help.helpText to this text. Pass an empty string (—help-text "") to remove the help block.
--lovstringSet lov.type: sharedComponent + lov: @<alias>. Strip a leading @ if present.
--lov-sqlstringSet lov.type: sqlQuery with the given SELECT (must return (display, return) pairs). Accepts @path/to/file.sql to read from disk; @@ escapes a literal leading @.
--lov-staticstringSet lov.type: staticValues with entries “Display1;Return1,Display2;Return2”.
--null-display-valuestringSet lov.nullDisplayValue. Only meaningful when the column uses an LOV.
--pagestringTarget page (numeric ID, alias, or name) [required]
--query-onlySet source.queryOnly: true so APEX’s auto-DML / auto-row-processing skips this column on insert/update (canonical for identity-generated PKs; required to avoid ORA-32795). Pass —query-only=false to remove the property — e.g. for a writable natural-key PK.
--readonlyAdd readOnly { type: always } so end-users can’t edit the cell.
--regionstringParent region id on the page [required]
--typetype:Rewrite top type: property. Accepts kebab-case (select-list, number, text, date, hidden, display-only, textarea, switch, radio-group, checkbox-group, rich-text) or the raw apexlang token (selectList / numberField / textField / …).

Global Flags

Section titled “Global Flags”
FlagTypeDefaultDescription
--app-dirstring.Path to the APEX application directory
--json-prettyOutput in pretty-printed JSON (human-readable) instead of minified JSON
--toonOutput in TOON format (human-readable, token-efficient) instead of JSON

Examples (from help)

Section titled “Examples (from help)”
Terminal window
uc-apx edit column --page 50 --region my-predictions \
      --column MATCH_ID --type select-list --lov @matches-lov \
      --null-display-value '- Select Match -'


  uc-apx edit column --page 50 --region my-predictions \
      --column USERNAME --default-plsql "return v('APP_USER');"