☰ Table of Contents


Release Notes for TigerGraph Platform version 2.1.3

Document updated:

TigerGraph v2.1.3 is the Enterprise Edition companion to TigerGraph v2.1 Developer Edition.  There are a few additional improvements, marked as v2.1.3 below:

New Features

Enterprise Edition

Distributed Query option (new in v2.1.3 Enterprise)

  • New option for CREATE QUERY with distributed graphs provides greater parallelism, when the query pattern is likely to start on several machine nodes and continue to traverse across several machine nodes.
  • See Distributed Query Mode

Improved Backup and Restore (new in v2.1.3 Enterprise)

  • Better support for backing up a cluster.
  • Parallel processing for better speed.
  • New file structure for backup archives.
  • Minor changes to the user interaction, to make the overall process more robust.
  • See GBAR - Graph Backup and Restore v2.1

Developer Edition

The TigerGraph Platform will now be available in two editions: Developer Edition and Enterprise Edition.

  • Developer Edition supports one user, one graph, one machine - free for noncommercial use.
  • Enterprise Edition adds Distributed Graphs, MultiGraph, and full Enterprise (security, system administration) support.

See Comparison of TigerGraph Editions for full details.

GraphStudio Enhancements

Assistance with Schema Change

  • When the user publishes a revised graph schema, GraphStudio will automatically make changes to Data Mapping.
  • Provides guidances on the consequences of making a schema change in GraphStudio.

Data Filters for Data Loading

  • On the Map Data to Graph page, users can define Data Filters to fine-tune which input records are loaded into the graph.
  • Data Filters corresponds to the WHERE clause in GSQL Load statements.

More Parsing Options for Mapping Data (new in v2.1.3)

  • In the Map Data to Graph step, when configuring the file parser, the user can specify a character to enclose a token, overriding the usual token separator: single or double quotes.

More Browser Support

  • Now supports Firefox, Safari, and Opera, in addition to Chrome.

See the TigerGraph GraphStudio UI Guide v2.1 .

Other Additions

Admin Portal Configuration Page

  • Admin Portal now has a Configuration page in addition to the Dashboard monitoring page.
  • First configuration option: install a GraphStudio license key. More configuration options in upcoming releases.
  • See the TigerGraph Admin Portal UI Guide v2.1 .

HA Configuration during Installation (Enterprise Edition)

Documentation Additions and Improvements

  • NEW : GSQL 101 - updated tutorial to learn how to use GSQL to define a graph, load data, write parameterized queries and run them, in about 1 hour.
  • Updated : Knowledge Base and FAQs - additional How To entries targeted at new users.
  • Corrections and Clarifications:
    • gsql command: The -p password option is now shown in the gsql syntax summary.
    • loading job syntax: The "any" prefix option is now shown in the filepath_string syntax summary.
    • ORDER BY clause of SELECT statement: items which cannot be sorted are listed after all the sorted items.
    • In the built-in SELECT query, described in GSQL 101 (and which corresponds to the GET /graph REST endpoint), a maximum of 10240 items can be returned.

Specification Changes

For clarify, this section lists changes between adjacent release versions separately (e.g.,  v1.1 → v1.2 is separate from v1.2 → v2.0).

v2.1 Changes


  • DEPRECATED : In CREATE QUERY, the "TO REPLACE" option (e.g., CREATE OR REPLACE QUERY) is deprecated.
  • NEW : In CREATE QUERY, there is is a new option: DISTRIBUTED (e.g., CREATE DISTRIBUTED QUERY).

GraphStudio UI

  • NEW : Data Filter in Map Data to Graph page.
  • CHANGED : Data Mapping is automatically changed publishing a revised graph schema.


  • CHANGED : New backup archive format.  Restore command has stricter requirements.

v2.0 Changes

Graph and User Management

  • CHANGED : The "architect" role is renamed "designer". The "public" role is renamed "observer".

GSQL Language

  • NEW : Queries can construct FILE objects, and pass the FILE objects as parameters, for enhanced flexibility for writing data to files.
  • NEW : PRINT to a FILE object or FILE.println
  • NEW : Unified syntax for loading jobs
  • NEW : Commands to manage loading jobs: SHOW LOADING STATUS, ABORT/RESUME LOADING JOB.
  • NEW : CREATE/SHOW/DROP GROUP commands, used for LDAP support.
  • NEW : The heapAccum now has a pop()  function
  • NEW : Three new string functions: lower(), upper(), and trim()
  • CHANGED : The + operator can be used to add two ListAccums, SetAccums, or MapAccums.The old semantics for (ListAccum + element) is dropped.
  • CHANGED : In the SELECT statement, the LIMIT...OFFSET option may only be used when the ORDER BY clause is also used.

GraphStudio UI

  • NEW : Full log in support, including user-based and graph-based access control, LDAP, and Single Sign-On.
  • NEW : Choose which graph to work with. See TigerGraph GraphStudio UI Guide v2.1 for details.

v1.2 Changes

Graph and User Management

NEW/ CHANGED : The MultiGraph service introduces changes to how graphs are managed, even when there is only a single graph.

  • User roles are granted or revoked on a per-graph basis.
  • A user can work with only one graph at a time. The user must set their working graph, either with the -g option for the GSQL command, or with the USE GRAPH statement. This requirement holds even when there is only a single graph in existence.
  • The privileges of the admin and designer (architect) roles have been reduced. They can no longer CREATE or DROP a VERTEX/EDGE/GRAPH.  However, they can CREATE and RUN a SCHEMA_CHANGE JOB, which accomplishes much the same thing.
  • The admin and designer (architect) roles can no longer run DROP ALL or CLEAR GRAPH STORE.
  • DROP GRAPH <gname> only drops vertex and edge types which are exclusive to that graph.  It does not drop shared types.
  • When a new user is created, previously the user began with the public (observer) role. Now, the new user has no role until assigned one.

GSQL Language

  • NEW : Container type attributes (e.g., a LIST or SET) can be updated (assigned a new value) in a query.  Previously, only simple type attributes could be updated. See the examples of Update statement in the Data Modification Statements chapter of the GSQL Language Reference Part 2 - Querying v2.1

  • REMOVED : In the CREATE VERTEX schema definition statement, the WITH STATS = "outdegree" option is no longer supported. The "outdegree_by_edgetype" and "null" options are still available.
  • REMOVED : The gsql -s option is dropped.  A secret cannot be used in place of a password.

System Configuration

  • CHANGED : The default TCP/IP port numbers for GraphStudio and its related services have changed, to avoid the possibility of conflict with other services. These port numbers are not mandatory. As before, users can set the port number with gadmin --configure

    • GraphStudio (and other Nginx services): from 44240 to 14240
    • GraphStudio.WebSocket.Port: from 44241 to 14241
    • GraphStudio.Web.Private_port: from 44242 to 14242

GraphStudio UI

  • NEW : In the Map Data to Graph step, users can now load a constant value (string or numeric). The constant value can either be applied directly to an attribute, or it can be one input of a token function.

Bug Fix

  • REST API output format for tuple type data is now consistent with standard JSON.

Known Bugs

  • A query cannot call itself. A fix is in progress.
  • PRINT a vertex set to a file using TO_CSV does not work.

Upgrading to v2.1

Developer Edition upgrade is not supported

The Developer Edition is not designed for upgrade from one version to another.
It is not possible to upgrade a Developer Edition installation to Enterprise Edition.

Always refer to all the incremental Release Notes between your current version and your target version before undertaking an Upgrade.  Pay attention to changes in features and compatibility of the data and application files. Release Notes and documentation are available at https://doc-archive.tigergraph.com. Contact support@tigergraph.com if you have any questions.

v2.0 can be upgraded to v2.1 Enterprise Edition. The data store format and GSQL language scripts in v2.0 are forward compatible to v2.1.

TigerGraph 2.0 is a major revision. Simple update (defined as installing the new software and making no other changes) is not supported.  Most of the GSQL language features from 1.x are supported, so most queries and loading jobs will still work.  The graph storage format has changed.  Please contact support@tigergraph.com for assistance with migrating a 1.x system to 2.x.