get_="column"

<do action_="sql" get_="column" schema_="[SCHEMA]" table_="[TABLE]" objname_="[COLUMN]" value_="@r"/> populates @r with metadata for the specified column from the specified table in the specified schema.

Description

<do action_="sql" get="column"/> is equivalent to looking up the column by name in the table returned by <do action_=”sql” get_=”table”/>, but is more convenient.

Syntax

<dynamic>
    <do action_="sql" get_="column"
     schema_="[SCHEMA]"
     table_="[TABLE]"
     objname_="[COLUMN]"
     value_="@r"/>
</dynamic>

Attributes for get_="column"

schema_
The specified schema from which to retrieve information.
table_
The specified table from which to retrieve information.
objname_
The name of the column from which to retrieve information.
value_
The information returned by get_="column" is saved as a package to the dynamic variable @r. @r contains 11 entries.
name
The name of the column. This name must agree with [COLUMN].
col
The MDB column name from the underlying table.
utype
The basic MDB datatype of the underlying column. utype can be one of the following values:
  • i (integer)
  • f (float)
  • a (alphanumeric)
  • j (bigint)
  • n (other)
type
Indicates the SQL datatype of the column. type can be one of the following values:
  • integer
  • double
  • bigint
  • varchar
  • text
  • date
  • timestamp
  • time
  • intervalytm
  • intervaldts
  • boolean
  • json
  • jsonb
unique
A boolean value. unique=1 if each value in the column is known to be unique (it is a key). Otherwise, unique=0.
sorted
A boolean value. sorted=1 if each value in the column is known to be sorted. Otherwise, sorted=0.
indexed
A boolean value. indexed=1 if the column is indexed. Otherwise, indexed=0.
width
An integer, which may be 0N (NA), and indicates the width of the column if known. This might be reported in metadata queries.
case
A boolean value. case=1 if the column should be treated as case-insensitive. Otherwise, case=0 (case-sensitive). This field may be 0N (NA) for numeric fields.
null
A boolean value. null=1 if the column may contain null (NA) entries. Otherwise, null=0 (null entries not permitted).
card
An approximation to the cardinality of the column, or the number of unique values in the column.