Home
Macro Language Elements
The section contains detailed specifications for all 1010data Macro Language elements.
Application Development
<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.
action_="setfilter"
<do action_="setfilter"> sets the filter on a specified table. (Available as of version 10.23)

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.
    - action_="allocctrl"
      <do action_="allocctrl"> changes the subprocess allocation strategy used by MDB. (Available as of version 10.25)
    - action_="api"
      <do action_="api"> sends a 1010data API transaction.
    - action_="cacheclear"
      <do action_="cacheclear"> clears the cache after running the associated 1010data query, if specified. If no query is specified, this action simply clears the cache. (Available as of version 10.15)
    - action_="cachectrl"
      <do action_="cachectrl"> controls cache behavior and inspects cache statistics. (Available as of version 10.25)
    - action_="clearcache"
      <do action_="clearcache"> clears the cache before running the associated 1010data query, if specified. If no query is specified, this action simply clears the cache.
    - action_="combine_tabs"
      <do action_="combine_tabs"> combines two or more tables into a new table. (Available as of version 19.48)
    - action_="compcheck"
      <do action_="compcheck"> performs a compatibility check on a given 1010data query. (Available as of version 10.27)
    - action_="files"
      <do action_="files"> retrieves a list of files in a valid FTP directory. (Available as of version 10.25)
    - action_="getdata"
      <do action_="getdata"> runs the given 1010data query and returns the results.
    - action_="getfilter"
      <do action_="getfilter"> gets the filter, if one exists, for a specified table. (Available as of version 10.23)
    - action_="getquery"
      <do action_="getquery"> places the Macro Language code of a given query into an XML variable and/or as text into a dynamic variable. (Available as of version 10.23)
    - action_="hashdel"
      <do action_="hashdel"> removes a key/value association from the user-specific private store. (Available as of version 10.23)
    - action_="hashget"
      <do action_="hashget"> retrieves the value associated with a given key from the user-specific private store. (Available as of version 10.23)
    - action_="hashput"
      <do action_="hashput"> saves a key/value association to the user-specific private store. (Available as of version 10.23)
    - action_="importtable"
      <do action_="importtable"> imports an iceberg-formatted table or a set of parquet files, and returns basic metadata statistics. (Available as of version 20.05)
    - action_="limits"
      <do action_="limits"> sets or inspects system settings. (Available as of version 10.25)
    - action_="log"
      <do action_="log"> sends a message to the 1010data system logger. (Available as of version 10.23)
    - action_="password"
      <do action_="password"> changes a user's 1010data password. (Available as of version 10.29)
    - action_="qqtoqa"
      <do action_="qqtoqa"> loads a legacy Quick Query and constructs a QuickApp with the same functionality. (Available as of version 10.34)
    - action_="query"
      <do action_="query"> runs the given 1010data query even if no data is retrieved or if the underlying block code has not changed. (Available as of version 10.15)
    - action_="savefile"
      <do action_="savefile"> saves the results of a 1010data query as a file in the user's FTP account or remote clous storage (ex. AWS S3, Azure Blob). (Available as of version 20)
    - action_="saveqa"
      <do action_="saveqa"> commits changes to the ops of a rendered and potentially modified QuickApp and saves them as a new QuickApp. (Available as of version 10.15)
    - action_="savequery"
      <do action_="savequery"> expands a given 1010data query and saves the ops resulting from the expansion as a query. (Available as of version 10.23)
    - action_="savetable"
      <do action_="savetable"> executes a given 1010data query and saves the results as a table. (Available as of version 10.23)
    - action_="setfilter"
      <do action_="setfilter"> sets the filter on a specified table. (Available as of version 10.23)
    - action_="sleep"
      <do action_="sleep"> sleeps for a specified period of time. (Available as of version 16.29)
    - action_="syskill"
      <do action_="syskill"> kills active user sessions. (Available as of prod-9)
    - action_="userprofile"
      <do action_="userprofile"> sets or retrieves user profile data and preferences. (Available as of version 10.29)
  - <do action_="sql">
    <do action_="sql"> provides a programmatic API to the SQL metadata store. (Available as of version 17.29)
  - <loop>
    <loop> is a special operation that allows one query to iteratively reference the data from each row in the results of another query.

`action_="setfilter"`

<do action_="setfilter"> sets the filter on a specified table. (Available as of version 10.23)

Syntax

<dynamic>
    <do action_="setfilter" path_="[PATH]">
      [XML_FILTER]
    </do>
</dynamic>

Structure of XML filter

The XML format used for [XML_FILTER] is as follows:

<filter>
  <when user="[LIST_OF_USERS_OR_GROUPS]">
    [MACRO_LANGUAGE_OPERATIONS]
  </when>
  ...
  <default>
    [MACRO_LANGUAGE_OPERATIONS]
  </default>
</filter>

A filter may contain any number of <when> clauses and an optional <default> clause. A user opening a filtered table is restricted by the operations contained within the first <when> clause for which their user ID or any of their groups appears in the clause's user list, which is a comma-separated list of users or groups. If no <when> clause matches, but there is a <default> clause, a user opening a filtered table is restricted by the operations contained therein. If there is no match and no <default>, the filter is ignored. This is the only XML format currently accepted by action_="setfilter".

Attributes for `action_="setfilter"`

path_: Specifies the pathname of an existing 1010data table that the caller owns.
The XML specified between the opening and closing <do> tags is applied as a filter on the table. If no XML is specified, any existing filter is removed from the table.

Example

<do action_="setfilter" path_="{@path}">
        <filter>
          <when user="foo,bar">
            <quote>
              <sel value="include{@suffix_}=1"/>
              <colord hide="file_name{@suffix_}" hard="1"/>
            </quote>
          </when>
        </filter>
      </do>