Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
get_table_info [2016/05/17 06:53] hermann [Notes] |
get_table_info [2026/08/28 03:22] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ===== Description ===== | ===== Description ===== | ||
| - | This functor retrieves information about each column from a given input table. | + | Gets information about the columns of a given input table or lookup table. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Table | [[Table Type|Table]] | Input table. | | + | | Table | [[Base Table Type]] | Input table or lookup table whose column information will be retrieved. | |
| + | |||
| + | ===== Optional Inputs ===== | ||
| + | |||
| + | None. | ||
| ===== Outputs ===== | ===== Outputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Table Info | [[Table Type|Table]] | Table containing the detailed information about the format of each input table column. | | + | | Table Info | [[Table Type]] | Table with detailed information about every input table column, in the format "Column_Index*:real, Column_Name:string, Is_Key_Column:real, Column_Type:real, Column_Type_Name:string". Is_Key_Column is 1 for a key column and 0 for a data column; Column_Type is 0 for a string column and 1 for a real (numeric) column; Column_Type_Name spells out the same information as "string" or "real". | |
| - | | Column Names | [[Table Type|Table]] | Table containing name and corresponding index for each input table column. | | + | | Column Names | [[Table Type]] | Table mapping each input table column's name to its index, in the format "Column_Name*:string, Column_Index:real". | |
| ===== Group ===== | ===== Group ===== | ||
| - | [[Functor List#Table|Table]] | + | [[Functor List#Table | Table]] |
| ===== Notes ===== | ===== Notes ===== | ||
| - | The table containing the resulting information about the input has the following format. | + | Table Info has the following format: |
| ^ Column Name ^ Key or Data? ^ Column Type ^ Description ^ | ^ Column Name ^ Key or Data? ^ Column Type ^ Description ^ | ||
| - | | “Column_Index” | Key | Real | Index of the corresponding table column | | + | | "Column_Index" | Key | Real | Index of the corresponding table column. | |
| - | | “Column_Name” | Data | String | Name of the corresponding table column | | + | | "Column_Name" | Data | String | Name of the corresponding table column. | |
| - | | “Is_Key_Column” | Data | Real | Flag indicating if the corresponding column is a key column. Value 1 are used to represent key columns and 0 represents data columns | | + | | "Is_Key_Column" | Data | Real | 1 if the corresponding column is a key column, 0 if it is a data column. | |
| - | | “Column_Type” | Data | Real | Value representing the type of the data contained in the column. Values 0 represents “String” and 1 represents “Real Numbers” | | + | | "Column_Type" | Data | Real | 0 if the column holds strings, 1 if it holds real numbers. | |
| - | | “Column_Type_Name” | Data | String | Name of the column type. The possible values are “string” and “real” | | + | | "Column_Type_Name" | Data | String | Name of the column type: "string" or "real". | |
| - | The table containing the column names has the following format. | + | Column Names has the following format: |
| ^ Column Name ^ Key or Data? ^ Column Type ^ Description ^ | ^ Column Name ^ Key or Data? ^ Column Type ^ Description ^ | ||
| - | | “Column_Name” | Key | String | Name of the corresponding table column | | + | | "Column_Name" | Key | String | Name of the corresponding table column. | |
| - | | “Column_Index” | Data | Real | Index of the corresponding table column | | + | | "Column_Index" | Data | Real | Index of the corresponding table column. | |
| ===== Internal Name ===== | ===== Internal Name ===== | ||
| - | GetTableInfo | + | GetTableInfo |