Home
Macro Language Elements
The section contains detailed specifications for all 1010data Macro Language elements.
Application Development
<do action_="sql">
<do action_="sql"> provides a programmatic API to the SQL metadata store. (Available as of version 17.29)
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.

Macro Language Elements
The section contains detailed specifications for all 1010data Macro Language elements.
- Data Transformation
  Data transformation operations use functions and expressions to functionally alter tabular data. These operations take 0, 1, or 2 tables as input and produce a single table as a result.
- Blocks
  Blocks allow users to reuse sections of Macro Language code and to parameterize values in that code for greater flexibility and power.
- Application Development
  - <dynamic>
    The <dynamic> element creates an environment in 1010data that maintains the state of system interactions and controls the running of queries.
  - <render>
    The <render> element provides the ability to configure certain QuickApp widgets when rendered to available output targets. A single <render> element contains one or more elements that specify output targets and settings for the final output.
  - <layout>
    The <layout> element is a nestable pseudo-operation that can be used to organize <widget> elements and other <layout> elements.
  - <widget>
    <widget> is used to define all visual components of a QuickApp, including drop-downs, text boxes, tables, and calendars. The form a widget takes is controlled by the class_ attribute.
  - <do>
    A <do> clause within a <dynamic> provides the ability for <dynamic> variables to be updated when some variable within the scope of the <dynamic> is changed.
  - <do action_="sql">
    <do action_="sql"> provides a programmatic API to the SQL metadata store. (Available as of version 17.29)
    - add_="column"
      <do action_="sql" add_="column" schema_="[SCHEMA]" table_="[TABLE]" objname_="[COLUMN]"/> creates a new dummy column in the specified table.
    - add_="schema"
      <do action_="sql" add_="schema" objname_="[SCHEMA]" desc_="[DESCRIPTION]" users_="[USERS]" admins_="[ADMINS]"/> creates a new empty schema with the name [SCHEMA].
    - add_="table"
      <do action_="sql" add_="table" schema_="[SCHEMA]" objname_="[TABLE]"/> adds an empty table to a specified schema.
    - add_="tvf"
      <do action_="sql" add_="tvf"> adds a new table-valued function to a specified schema.
    - add_="view"
      <do action_="sql" add_="view" schema_="[SCHEMA]" objname_="[TABLE]"/> adds an empty table to a specified schema.
    - analyze_="column"
      <do action_="sql" analyze_="column" path_="[PATH]" col_="[COLNAME]" value_="@r"/> analyzes the 1010data table at [PATH] and populates @r with complete SQL metadata for the single column.
    - analyze_="table"
      <do action_="sql" analyze_="table" path_="[PATH]" value_="@r"/> analyzes the 1010data table at [PATH] and populates @r with complete SQL metadata for the table.
    - analyze_="view"
      <do action_="sql" analyze_="view" sql_="[SQL]" value_="@r"/> populates @r with complete SQL metadata for the view, based on the SQL query [SQL].
    - check_="parse"
      <do action_="sql" check_="parse" sql_="[SQL]" value_="@r"/> attempts to parse the SQL statement.
    - del_="column"
      <do action_="sql" del_="column" schema_="[SCHEMA]" table_="[TABLE]" objname_="[COLUMN]"/> deletes a column from the specified table.
    - del_="schema"
      <do action_="sql" del_="schema" objname_="[SCHEMA]"/> deletes a schema from the catalog.
    - del_="table"
      <do action_="sql" del_="table" schema_="[SCHEMA]" objname_="[TABLE]"/> deletes a table from the specified schema.
    - del_="tvf"
      <do action_="sql" del_="tvf"> deletes a table-valued function with a given signature from the schema.
    - del_="view"
      <do action_="sql" del_="view" schema_="[SCHEMA]" objname_="[TABLE]"/> deletes a view from the specified schema.
    - get_="catalog"
      <do action_="sql" get_="catalog" catalog_="[CATALOG]" value_="@r"/> populates @r with a specified database catalog.
    - 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.
    - get_="schema"
      <do action_="sql" get_="schema" objname_="[SCHEMA]" value_="@r"/> populates @r with a specified schema.
    - get_="table"
      <do action_="sql" get_="table" schema_="[SCHEMA]" objname_="[TABLE]" value_="@r"/> populates @r with metadata for the specified table from the specified schema.
    - get_="tvf"
      <do action_="sql" get_="tvf" schema_="[SCHEMA]" objname_="[FUNCTION]" signature_="[SIGNATURE]" value_="@r"/> populates @r with metadata for the specified table-valued function from the specified schema and signature.
    - get_="view"
      <do action_="sql" get_="view" schema_="[SCHEMA]" objname_="[TABLE]" value_="@r"/> populates @r with metadata for the specified view from the specified schema.
    - info_="privileges"
      <do action_="sql" info_="privileges" value_="@r"/> populates @r with a dictionary containing user privileges.
    - list_="catalogs"
      <do action_="sql" list_="catalogs" value_"@r"/> populates @r with a list of the names of all available SQL catalogs.
    - list_="columns"
      <do action_="sql" list_="columns" schema_="[SCHEMA]" table_="[TABLE]" value_"@r"/> populates @r with a list of the names of all available columns in the specified table.
    - list_="schemas"
      <do action_="sql" list_="schemas" catalog_="[CATALOG]" value_"@r"/> populates @r with a list of the names of all available schemas to which the user has access in the specified catalog.
    - list_="signatures"
      <do action_="sql" list_="signatures" schema_="[SCHEMA]" tvf_="[FUNCTION]" value_="@r"/> populates @r with a list of all the signatures associated with the table-valued function [FUNCTION].
    - list_="tables"
      <do action_="sql" list_="tables" schema_="[SCHEMA]" value_="@r"/> populates @r with a list of the names of all available tables in the specified schema.
    - list_="tvfs"
      <do action_="sql" list_="tvfs" schema_="[SCHEMA]" value_="@r"/> populates @r with a list of the names of all table-valued functions in the specified schema.
    - list_="views"
      <do action_="sql" list_="views" schema_="[SCHEMA]" value_="@r"/> populates @r with a list of the names of all available views in the specified schema.
    - put_="column"
      <do action_="sql" put_="column" schema_="[SCHEMA]" table_="[TABLE]" objname_="[COLUMN]" data_="{...}"/> updates a column with the specified properties.
    - put_="schema"
      <do action_="sql" put_="schema" objname_="[SCHEMA]" data_="{...}"/> updates a schema with the properties contained in data_.
    - put_="table"
      <do action_="sql" put_="table" schema_="[SCHEMA]" objname_="[TABLE]" data_="{...}"/> updates a table with the specified properties.
    - put_="view"
      <do action_="sql" put_="view" schema_="[SCHEMA]" objname_="[TABLE]" data_="{...}"/> updates a table with the specified properties.
    - reload_="catalog"
      <do action_="sql" reload_="catalog"/> refreshes the entire database catalog in the caller's session.
  - <loop>
    <loop> is a special operation that allows one query to iteratively reference the data from each row in the results of another query.

`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.