Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
get_table_column [2013/08/06 19:44] admin created |
get_table_column [2026/08/28 03:22] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ===== Description ===== | ===== Description ===== | ||
| - | This functor retrieves a data column from the specified table. | + | Retrieves a data column from the specified table. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Table | [[Index Or Name Type|Index Or Name]] | Index or name of the column to be retrieved. The column must represent a data column. | | + | | Table | [[Table Type]] | Table from where the data column will be retrieved. | |
| + | | Column Index Or Name | [[Index Or Name Type]] | Index or name of the column to be retrieved. The first, i.e. the leftmost, data column has index 1. The index or name must correspond to a data column; if it corresponds to a key column, this functor reports an error. | | ||
| + | |||
| + | ===== Optional Inputs ===== | ||
| + | |||
| + | None. | ||
| ===== Outputs ===== | ===== Outputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Result | [[Table Type|Table]] | The resulting table formed by the retrieved column and the corresponding keys. | | + | | Result | [[Table Type]] | The resulting table formed by the retrieved column and the table's key columns. | |
| ===== Group ===== | ===== Group ===== | ||
| - | [[Functor List#Table|Table]] | + | [[Functor List#Table | Table]] |
| ===== Notes ===== | ===== Notes ===== | ||
| - | This functor removes all data columns from a table keeping the key columns and the specified data column. For example, given the table below | + | This functor removes all data columns from the table, keeping only the key columns and the specified data column. |
| + | |||
| + | **Example:** | ||
| + | |||
| + | Given the table below | ||
| ^ Key1* ^ Key2* ^ Value1 ^ Value2 ^ | ^ Key1* ^ Key2* ^ Value1 ^ Value2 ^ | ||
| Line 29: | Line 38: | ||
| | 2 | 2 | 3.2 | 6.1 | | | 2 | 2 | 3.2 | 6.1 | | ||
| - | retrieving the column "Value1" yields | + | retrieving the column "Value1" results in the following table |
| ^ Key1* ^ Key2* ^ Value1 ^ | ^ Key1* ^ Key2* ^ Value1 ^ | ||