TML for tables

Use TML to modify a ThoughtSpot object in a flat-file format. Then, migrate the object to a different cluster, or restore it to the same cluster.

To work with TML files for tables, you can download these objects to flat files in .TML format, modify the files, and subsequently upload the files either to the same cluster, or to a different cluster. To learn how to export, change, and update tables, see Import and export TML files.

The syntax examples in this article contain every possible parameter in TML files for tables. Some of these parameters are not in these files by default. If you want to use them, you must add them yourself. For example, the fqn parameter is not present in any TML file by default, but you can add it to differentiate a table from another table with the same name.

As you work with TML files, keep in mind that changing elements of the TML file, such as the name of a column or table, may affect dependents. This is specifically true if you are editing TML files outside ThoughtSpot. When you change the name of a table in a TML file, and then import that file into ThoughtSpot, ThoughtSpot automatically updates that table name in any dependents, such as Answers that use the table as a data source. However, if you download multiple TML files from one ThoughtSpot cluster, then change the table name in TML, and upload all the files to a brand-new cluster, ThoughtSpot doesn’t know that the dependents should use that table. You must also change the table name in the dependents.

Syntax of the table TML file

The TML file for tables has a specific syntax.

See the TML parameters for tables for details about the keywords used in this example.

See Limitations of working with TML files for more information about actions you can’t perform using TML.

You may not see each of these parameters in your own TML files, depending on whether each variable is explicitly defined. For example, if you did not define any RLS rules, the rls_rules variable does not appear. You can add that variable in the TML file to specify RLS rules.

Refer to TML for joins for more information on the functionality and syntax of table joins in TML.

To reduce ambiguity, you may need to add the optional fqn parameter to your TML file when you reference source tables or connections. This is necessary if you have multiple connections or tables with the same name. If you do not add the fqn parameter, and the connection or table you reference does not have a unique name, the file import fails.

guid: <table_guid>
table :
  name: <table_name>
  description: <table_description>
  db: <database_name>
  schema: <schema_name>
  db_table: <database_table_name>
  connection:
    name: <connection_name>
    fqn: <optional_connection_GUID>
  columns:
  - name: <column_name_1>
    db_column_name: <database_column_name>
    data_type: [ BOOL | VARCHAR | DOUBLE | FLOAT | INT32 | INT64 | DATE | TIME ]
  parameters:
  - id: <id>
    name: <table_name>
    data_type: [ BOOL | VARCHAR | DOUBLE | FLOAT | INT32 | INT64 | DATE | TIME ]
    default_value: <default_value>
    <sap_parameter_name: <sap_parameter_name>
    properties:
      column_type: [ MEASURE | ATTRIBUTE ]
      aggregation: [ SUM | COUNT | AVERAGE | MAX | MIN |
                     COUNT_DISTINCT | NONE | STD_DEVIATION | VARIANCE]
      index_type: [ DONT_INDEX | DEFAULT | PREFIX_ONLY |
                    PREFIX_AND_SUBSTRING | PREFIX_AND_WORD_SUBSTRING ]
      index_priority: <index_priority>
      synonyms:
             <synonym_1>
             <synonym_2>
      is_attribution_dimension: [true | false]
      is_additive: [ true | false ]
      calendar: [ default | calendar_name ]
      format_pattern: <format_pattern_string>
      currency_type:
        is_browser : true
          OR
        column : <column_name>
          OR
        iso_code : <valid_ISO_code>
      is_hidden: [ true | false ]
      geo_config:
        latitude : true
          OR
        longitude : true
          OR
        country : true
          OR
        region_name:
        - country : <name_supported_country>
        - region_name : <region_name_in_UI>
          OR
        custom_file_guid: <custom_map_guid>
        geometryType: <custom_map_geometry_type>
      spotiq_preference: <spotiq_preference_string>
    db_column_properties:
      data_type: [ BOOL | VARCHAR | DOUBLE | FLOAT | INT32 | INT64 | DATE | TIME ]
  - name: <column_name_2>
  - name: <column_name_n>
  rls_rules:
    tables:
    - name: <table_name_1>
      id: <optional_table_id>
      fqn: <optional_table_GUID>
    - name: <table_name_2>
    - name: <table_name_n>
    joins:
    - name: <join_name_1>
      source: <source_table_name>
      destination: <destination_table_name>
      type: [RIGHT_OUTER | LEFT_OUTER | INNER | OUTER]
      on: <join_expression_string>
      is_one_to_one: [ false | true ]
    table_paths:
    - id: <table_path_name_1>
      table: <table_name_1>
      join_path:
      - join:
        - <join_name_1>
        - <join_name_n>
   - id: <table_path_name_2>
      table: <table_name_2>
      join_path:
      - join:
        - <join_name_2>
   - id: <table_path_name_n>
      table: <table_name_n>
      join_path:
      - join:
        - <join_name_n>
    rules:
    - name: <rls_rule_name_1>
      expr: <rls_rule_expression_1>
    - name: <rls_rule_name_2>
      expr: <rls_rule_expression_2>
    - name: <rls_rule_name_n>
      expr: <rls_rule_expression_n>
  joins_with:
  - name: <join_name_1>
    description: <optional_join_description_1>
    destination:
      name: <destination_table_name_1>
      fqn: <optional_table_guid_1>
    on: <join_expression_string_1>
    type: [RIGHT_OUTER | LEFT_OUTER | INNER | OUTER]
    is_one_to_one: [ false | true ]
  - name: <join_name_2>
  - name: <join_name_n>

TML parameters for tables

These parameters and their definitions are specific to tables; this list doesn’t contain every parameter in every TML file. Similarly, the parameter definitions may vary from object to object, since the parameters may have different roles in different objects.

a - e	f - j	n - t
aggregation calendar column column_type columns connection currency_type custom_file_guid data_type db db_column_name db_column_properties db_table default_value description destination expr	format_pattern fqn geo_config geometryType guid id index_priority index_type is_additive is_attribution_dimension is_hidden is_one_to_one join join_path joins joins_with	name on parameters properties rls_rules rule rules sap_parameter_name schema source spotiq_preference synonyms table table_paths tables type

a - e

f - j

n - t

is_attribution_dimension

aggregation: The default aggregation of the view column.

Aggregation options depend on the data type.

Possible values are SUM, COUNT, AVERAGE, MAX, MIN, COUNT_DISTINCT, NONE, STD_DEVIATION, and VARIANCE

Default: SUM.

calendar: Specifies the calendar used by a date column.

Can be the Gregorian calendar (default), a fiscal calendar, or any custom calendar.

See Set up a custom calendar.

column: The id of the column(s) being filtered on.

column_type: The type of data the column represents.

Possible values: MEASURE or ATTRIBUTE

columns: The columns in the table.

connection: A way to identify the external data warehouse connection that the table or column resides in. To add tables or columns to an external connection, you must specify this parameter.

currency_type

The source of the currency type.

One of:

is_browser : true: infer the currency data from the locale of your browser
column : <column_name>: extracts the currency information from a specified column
iso_code : <valid_ISO_code>: applies currency based on the ISO code;

See ISO 4217 Currency Codes and Set currency type for more information.

custom_file_guid: The GUID for a custom map uploaded by an administrator.

data_type: The data type of the column.

db: The database that a table resides in. Note that this is not the same as the data warehouse (Falcon, Amazon Redshift, or Snowflake, for example).

db_column_name: The name of the column in the database. Note that this database is not the same as the data warehouse (Amazon Redshift, or Snowflake, for example).

db_column_properties: The properties of the column in the database. Note that this database is not the same as the data warehouse (Amazon Redshift or Snowflake, for example).

db_table: The name of the table in the database. Note that this database is not the same as the data warehouse (Falcon, Amazon Redshift, or Snowflake, for example).

default_value

The default value of the parameter.

Only applicable for tables imported from SAP Hana.

description: The text that describes an object: a table, a join, and so on.

destination: The name of the destination table or view for a join.

expr: The definition of the row-level security (RLS) rule. The syntax for variables in TML should be the same as the syntax of the variables in the rule on the table.

format_pattern: The format pattern string that controls the display of a number, date, or currency column.

See Set number, date, and currency formats.

fqn: The table or connection’s GUID. You can find this string of letters and numbers at the end of the URL for that table or connection.

For example, in https://<company>.thoughtspot.com/#/data/tables/34226aaa-4bcf-4d6b-9045-24cb1e9437cb, the GUID is 34226aaa-4bcf-4d6b-9045-24cb1e9437cb.

Use this optional parameter to reduce ambiguity and identify a specific table, if you have multiple tables with the same name. When exporting a TML file, you have the option to Export FQNs of referenced objects, which ensures that the TML files you export contain FQNs for the underlying tables and connections. If you do not add the fqn parameter, and the connection or table you reference does not have a unique name, the file import fails.

geo_config

Specifies the geographic information of a column. See Add a geographical data setting.

One of:

latitude : true

for columns that specify the latitude

longitude : true

for columns that specify the longitude

country : true

for columns that specify the country

region_name

for specifying a region in a country

Uses two paired parameters:

country: <country_name>
region_name: <region_name_in_UI>; can be State, Postal Code, District, and so on.

custom_file_guid: <custom map GUID>

for columns that use a custom map. Must be followed by geometryType.

geometryType: <custom_map_geometry_type>

for columns that use a custom map. Must be preceded by custom_file_guid. Accepts the following values: POINT, LINE_STRING, LINEAR_RING, POLYGON, MULTI_POINT, MULTI_LINE_STRING, MULTI_POLYGON, GEOMETRY_COLLECTION, CIRCLE

geometryType: Specifies the geometry type of the TopoJSON file. Required for geographical configuration of Worksheet or table columns that use a custom map. Accepts the following values: POINT, LINE_STRING, LINEAR_RING, POLYGON, MULTI_POINT, MULTI_LINE_STRING, MULTI_POLYGON, GEOMETRY_COLLECTION, CIRCLE

guid: The GUID for the table. You can find this string of letters and numbers at the end of the URL for an object.

id: Specifies the id of an object, such as table_paths, name.

index_priority: A value (1-10) that determines where to rank a column’s name and values in the search suggestions

ThoughtSpot prioritizes columns with higher values.

See Change a column’s suggestion priority.

index_type: The indexing option of the table column.

Possible values: DONT_INDEX, DEFAULT (see Understand the default indexing behavior), PREFIX_ONLY, PREFIX_AND_SUBSTRING, and PREFIX_AND_WORD_SUBSTRING

Default: DEFAULT

See Index Type Values.

is_additive: Controls extended aggregate options for attribute columns.

For attribute columns that have a numeric data type (FLOAT, DOUBLE, or INTEGER) or a date data type (DATE, DATETIME, TIMESTAMP, or TIME)

Possible values: true or false.

Default: true.

See Making an ATTRIBUTE column ADDITIVE.

is_attribution_dimension: Controls if the column is an attribution dimension.

Used in managing chasm traps.

Possible values: true by default, false to designate a column as not producing meaningful attributions across a chasm trap

Default: true

See Change the attribution dimension.

is_hidden: The visibility of the column.

Possible values: true to hide the column, false not to hide the column
Default: false

See Hide a column or define a synonym.

is_one_to_one: Specifies the cardinality of the join. This is an optional parameter.

Possible values: true, false

Default: false

join: Specific join, used in defining higher-level objects, such as table paths.

Defined as name within joins definition

join_path: Specification of a composite join as a list of distinct join attributes.

These join attributes list relevant joins, previously defined in the joins, by name.

Default: {}

joins: Contains a list of joins between the tables and views.

If you edit the joins in the Worksheet or View TML file, you are only editing the joins for that specific Worksheet or view. You are not editing the joins at the table level. To modify table-level joins, you must edit the source table’s TML file.

Each join is identified by name, and the additional attributes of source, destination, type, and is_one_to_one.

joins_with: Contains a list of external joins for which this table is the source. Each join is identified by name and optional description, and the additional attributes of destination, type, on, and is_one_to_one.

name: The name of an object. Applies to table, joins, connection, and so on.

on: The join expression: the relationship definition, or the keys that your tables are joined on. For example, [sale::Sale_Last Name] = [employee::Employee_Last Name] AND [sale::Sale_First Name] = [employee::Employee_First Name].

To alter a relationship definition, edit this parameter.

parameters: The parameter that corresponds to the input parameter in a Connection. Currently applicable only to tables imported from SAP Hana. For this field, you must fill in the name, data type, default value, and sap parameter name.

properties: The list of properties of a table column.

Each column can have the following properties, depending on its definition: column_type, aggregation, index_type, is_hidden, index_priority, synonyms, is_attribution_dimension, is_additive, calendar, format_pattern, currency_type, geo_config, and spotiq_preference.

rls_rules: A container for the full definition of row-level security rules for the table.

rule: A conditional formatting rule.

rules: A container for the names and expressions of row-level security rules for the table.

sap_parameter_name: The name of the parameter from the SAP Hana calculated view.

schema: The schema that the table is a part of.

source: Name of the source table or view for a join.

spotiq_preference: Specifies whether to include a column in SpotIQ analysis. Specify EXCLUDE, or this property defaults to include the column in SpotIQ Analysis.

Refer to Set columns to exclude from SpotIQ analyses.

synonyms: Alternate names for the column, used in search.

See Hide a column or define a synonym.

table: Top-level container for all object definitions within the table.

table_paths: The list of table paths.

Each table path is identified by the id, and additional attributes of table and join_path.

tables: List of tables used by the RLS rule.

Each table is identified by name.

type: The connection type.

Possible values: Snowflake, Google BigQuery, Microsoft Azure, or Amazon Redshift.

Limitations of working with TML files

There are certain limitations to the changes you can apply by editing tables through TML.

Columns can either have a new name, or a new expression. You can’t change both, unless migrating or updating the Worksheet two times.
It isn’t possible to reverse the join direction in the TML script.
You can only change logical tables using TML files. You can’t change the physical version of the table that exists in a database. When you change the column_name, for example, the name changes in the application, but not in the physical table in the database.
Joins only appear in the table TML file of the source table in a join, or the table on the Many side of a Many-to-One join. You can only add and edit table joins from the TML file of the table on the Many side of the join. You can’t view or modify table-level joins from the destination table’s TML file.
You can’t remove tables from a connection. You can only add them.
You can only delete table columns that have no dependents. If the table column has any dependents, ThoughtSpot returns an error when you try to import or validate the TML file. To delete a table column, you must first delete the dependents.
When deleting columns, you only delete ThoughtSpot’s record of the column. You don’t delete the column in your external database.
If there is an error in any row-level security (RLS) rule when importing a table, all RLS rules for the table are removed. ThoughtSpot warns you about this on import, and highlights the rule that is in an error state, so you can fix it or remove it.

Was this page helpful?Give us feedback!

TML for tables

Syntax of the table TML file

TML parameters for tables

Limitations of working with TML files

Product

By Role

By Department

Solutions

About Us

Connect