Skip to content

SetTableSchema.md

Latest commit

 

History

History
71 lines (51 loc) · 2.37 KB

SetTableSchema.md

File metadata and controls

71 lines (51 loc) · 2.37 KB
Raw

Set schema

Set schema

Overview

Creates an independent copy of the table with an updated schema. The original table remains unchanged. The schema can be sourced from either a Record or another Table, and can either overwrite the existing schema or be appended to it.

Parameters

1. help (HELP)

  • Label: Tip
  • Description: This action creates an independent copy. To update the original table, assign the output back to the same variable.
  • Required: No (injected)
  • Default: None
  • Constraints: None

2. selectMethod (SELECT)

  • Label: Source of schema
  • Description: Specifies the source from which the schema will be copied.
  • Required: Yes
  • Default: record
  • Constraints: None
  • Options:
    • record (label "Record"): Copy the schema from a Record variable.
    • table (label "Table"): Copy the schema from another Table variable.

2.1.1 inputRecord (VARIABLE) (applicable when selectMethod is record)

  • Label: Select record whose schema is to be copied
  • Description: The Record variable from which the schema will be sourced.
  • Required: Yes
  • Default: None
  • Constraints: Variable type: Record

2.2.1 inputSchemaTable (VARIABLE) (applicable when selectMethod is table)

  • Label: Select Table whose schema is to be copied
  • Description: The Table variable from which the schema will be sourced.
  • Required: Yes
  • Default: None
  • Constraints: Variable type: Table

3. inputTable (VARIABLE)

  • Label: Base table
  • Description: The table whose schema will be updated.
  • Required: Yes
  • Default: None
  • Constraints: Variable type: Table

4. updatecriteria (RADIO)

  • Label: Update method
  • Description: Choose method to update.
  • Required: Yes
  • Default: overwrite_schema
  • Constraints: None
  • Options:
    • overwrite_schema (label "Overwrite schema"): Replaces the existing schema entirely with the source schema.
    • append_schema (label "Append schema"): Adds new columns from the source schema to the end of the existing schema.

Output

Returns a TABLE containing an independent copy of the table with the updated schema.

Exceptions

Throws BotCommandException on invalid select method, invalid update method, or internal failure.