TML for connections

Use TML to modify a ThoughtSpot connection in a flat-file format. You can edit the connection TML file in the Data Workspace, or export the TML file to edit separately. When exporting the connection TML file, you can choose to export only the connection TML file, to export the connection TML file together with the related table TML files in a zip file, or to export either of the previous options with the FQN for each referenced object included.

Note that before the connection TML file, you could only remap connections by downloading the connection.yaml file, editing it, and re-uploading it. Currently, you can remap columns and change data types from the table TML file, or edit the connection TML file directly to change its properties, such as account name and password.

To work with TML files for connections, 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 connections, see Import and export TML files.

Import the connection TML file

You can use the import TML utility in the Data Workspace to import a connection TML file, either in .tml file format or in .zip file format. You can include table TML files in a .zip file to upload along with the Connection TML file.

To import a TML file, navigate to the Data Workspace, select Utilities from the left menu, and click Import TML. You can click the Select .zip or .tml files to upload box to upload your files, or drag and drop them to the selected area.

If you are uploading a connection TML file that maps to an existing connection, you can either create a new connection, or update the existing connection. If you are uploading a new connection TML file, you only see the Create option.

Export the connection TML file

To export a connection TML file, you can either navigate to the connection in the Data Workspace, and select Export TML from the more options menu more options icon, or you can navigate to the Utilities option and click Export TML. From the Export TML window, you can select the Connections tab and check the box next to the connection(s) you want to export. Note that you can export connection TML files individually, or in bulk.

Syntax of the connection TML file

The TML file for connections has a specific syntax.

See the TML parameters for connections 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.

guid: <connection_guid>
connection :
  name: <connection_name>
 type: <connection_type>
authentication_type: [SERVICE_ACCOUNT, KEY_PAIR]
key: <accountName>
value: <account_name>
key: <user>
value: <admin>
key: <password>
value: “”
key: <role>
value: <SYSADMIN>
key: <warehouse>
 description: “Description of the connection”

TML parameters for connections

These parameters and their definitions are specific to connections; 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 - k n - v

The type of authentication used to connect to the connection. Note that authentication type is usually SERVICE_ACCOUNT, although certain connections also support KEY_PAIR.

We do not currently support Connection TML for connections authenticated using OAuth.

A way to identify the external data warehouse connecting to ThoughtSpot.


The text that describes the connection.


The GUID for the connection. You can find this string of letters and numbers at the end of the URL for the object.


The key to define in a key-value pair. Common key-value pairs in a Connection TML file are accountName, user, password, role, and warehouse.


Name of the connection.


A container for the key-value pairs that define a connection.


Type of connection.


The value defined in a key-value pair. Common key-value pairs in a Connection TML file are accountName, user, password, role, and warehouse.

Limitations of working with TML files

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

  • You can’t import manually compressed .zip files. You can only import .zip files that you exported from ThoughtSpot: a custom set of TML files, an object and its associated data sources, or multiple objects of the same type that you exported from the object list page.

Was this page helpful?