TigerGraph

https://www.tigergraph.com/docs/
Admin
TigerGraph is the world's fastest and most scalable graph analytics platform that combines graph...
Tokens:1,011,865
Snippets:9,302
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example install_conf.json Configuration

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/installation/bare-metal-install

A complete example of the install_conf.json file used for non-interactive installation.

```json
{
  "BasicConfig": {
    "TigerGraph": {
      "Username": "mark",
      "Password": "markpassword",
      "SSHPort": 22,
      "PrivateKeyFile": "",
      "PublicKeyFile": ""
    },
    "RootDir": {
      "AppRoot": "/home/tigergraph/tigergraph/app",
      "DataRoot": "/home/tigergraph/tigergraph/data",
      "LogRoot": "/home/tigergraph/tigergraph/log",
      "TempRoot": "/home/tigergraph/tigergraph/tmp"
    },
    "License": "<license>",
    "RegionAware" : false,
    "NodeList": [
      "m1: 123.456.78.99",
      "m2: 123.456.78.98",
      "m3: 123.456.78.97",
      "m4: 123.456.78.96"
    ]
  },
  "AdvancedConfig": {
    "ClusterConfig": {
      "LoginConfig": {
        "SudoUser": "tom",
        "Method": "K",
        "P": "<sudo_user_password>",
        "K": "/home/tom/mykey.pem"
      },
      "ReplicationFactor": 2
    }
  }
}
```

--------------------------------

### PUT and GET path examples

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/cluster-and-ha-management/ha-for-gsql-server

Examples of using absolute and relative paths with PUT and GET commands.

```gsql
put ExprFunctions from "/home/path/tmp/ExprFunc.hpp"
get TokenBank to "doc/path/tmp/myTB.cpp"
```

--------------------------------

### Example using command files and inline commands

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/basics/running-gsql

Examples of executing a GSQL file, installing a query, and running a query from the command line.

```bash
$ gsql pagerank_query.gsql
$ gsql 'INSTALL QUERY names_similar'
$ gsql 'RUN QUERY names_similar (0,"michael","jackson",100)'
```

--------------------------------

### Test Spark Installation

Source: https://www.tigergraph.com/docs/savanna/main/graph-development/load-data/jdbc.md

Verify the Spark installation by running the SparkPi example.

```console
$ spark-submit --class org.apache.spark.examples.SparkPi spark/examples/jars/spark-examples_2.12-3.3.1.jar 10
```

--------------------------------

### Test Spark Installation

Source: https://www.tigergraph.com/docs/cloud/main/solutions/access-solution/jdbc.md

Verify the Spark installation by running the SparkPi example.

```console
$ spark-submit --class org.apache.spark.examples.SparkPi spark/examples/jars/spark-examples_2.12-3.3.1.jar 10
```

--------------------------------

### GET folder path example

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/cluster-and-ha-management/ha-for-gsql-server

Example of using a folder path for the GET command, which creates or overwrites the file.

```gsql
get TokenBank to "home/path/tmp/"
```

--------------------------------

### Example 4: Disjunctive 1-hop Edge Pattern Setup

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/tutorials/pattern-matching/one-hop-patterns

Initial setup for finding related comments and posts for Viktor Akhiezer using a disjunctive edge pattern.

```gsql
USE GRAPH ldbc_snb
set query_timeout=60000
```

--------------------------------

### Query Installation Log Output

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/querying/create-and-install-queries

Example of the log output displayed when installing queries, including progress, warnings for failed queries, and the final installation summary.

```text
Installing 6 queries in graph 'my_graph'.
Start installing queries, about 1 minute ...

Warning: These queries below in the graph 'my_graph' cannot be
correctly installed: [query_with_error]
For more information, please check log at node 'm1':
  /home/tigergraph/tigergraph/gsql-checker-log/ERROR.20260327-120426.340

[======================================================================] 100% (5/5) elapsed 0:34

Query installation summary for graph 'my_graph':
  succeeded: 5, skipped: 0, failed: 1.
Query installation failure report written to
  gsql-checker-log/FailedQueryReport/QUERY_INSTALLATION_REPORT.20260327-120517.json
Query installation finished.
```

--------------------------------

### Run the installation script

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/installation/bare-metal-install

Navigate to the extracted directory and execute the installation script. Sudo privileges are not required for standalone installations.

```bash
$ cd tigergraph-<version>-offline

#sudo not requried for standalone installation
$ sudo ./install.sh
```

--------------------------------

### Algorithm Installation Configuration

Source: https://www.tigergraph.com/docs/graph-ml/3.10/classification-algorithms/k-nearest-neighbors

Example configuration inputs provided during the installation of the kNN algorithm for a movie graph.

```text
Vertex types: Person
Edge types: Likes
Second Hop Edge type: Reverse_Likes
Edge attribute that stores FLOAT weight, leave blank if no such attribute:weight
Vertex attribute that stores STRING label:known_label
```

--------------------------------

### Configure environment and run setup script

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/tutorials/pattern-matching/prepare-environment

Set the LDBC_SNB_DATA_DIR environment variable, start TigerGraph services, and execute the setup_schema.gsql script.

```bash
# Change the directory to your raw file directory
export LDBC_SNB_DATA_DIR=/home/tigergraph/ldbc_snb_data/social_network/

# Start all TigerGraph services
gadmin start all

# Setup schema and loading job
gsql setup_schema.gsql
```

--------------------------------

### Download source code example

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/cluster-and-ha-management/ha-for-gsql-server

Example script to download source code files using the GSQL GET command.

```bash
temp_TokenBank2=$tempDir/tmp_TokenBank_2.cpp
temp_ExprFunctions2=$tempDir/tmp_ExprFunctions_2.hpp
temp_ExprUtil2=$tempDir/tmp_ExprUtil_2.hpp

echo "GET TokenBank.cpp, ExprFunctions.hpp and ExprUtil.hpp to current node."

eval gsql 'GET TokenBank TO \"$temp_TokenBank2\"'
eval gsql 'GET ExprFunctions TO \"$temp_ExprFunctions2\"'
eval gsql 'GET ExprUtil TO \"$temp_ExprUtil2\"'
```

--------------------------------

### Check query installation status via GET

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/API/built-in-endpoints

Retrieve the status of a query installation request using the request ID returned by the installation endpoint.

```bash
curl --user tigergraph:tigergraph -X GET 'http://localhost:14240/gsql/v1/queries/install/1234'
```

```json
{
  "state": "RUNNING", __**(1)**
  "error": false,
  "message": "",
  "results": "",
  "queries": [
    {
      "name": "t1",
      "state": "SUCCESS"
    },
    {
      "name": "t2",
      "state": "RUNNING"
    },
    {
      "name": "t3",
      "state": "RUNNING"
    }
  ],
  "graph": "poc_graph"
}
```

--------------------------------

### Example install.conf for Region-Awareness

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/cluster-and-ha-management/region-aware

This configuration file enables region-awareness for non-interactive installations. It requires RegionAware to be set to true, a valid NodeList with region information, and a ReplicationFactor greater than 1.

```json
{
  "BasicConfig": {
    "TigerGraph": {
      "Username": "mark",
      "Password": "markpassword",
      "SSHPort": 22,
      "PrivateKeyFile": "",
      "PublicKeyFile": ""
    },
    "RootDir": {
      "AppRoot": "/home/tigergraph/tigergraph/app",
      "DataRoot": "/home/tigergraph/tigergraph/data",
      "LogRoot": "/home/tigergraph/tigergraph/log",
      "TempRoot": "/home/tigergraph/tigergraph/tmp"
    },
    "License": "<license>",
    "RegionAware" : true,
    "NodeList": [
      "us-east-1: m1: 123.456.78.99",
      "us-east-2: m2: 123.456.78.98",
      "us-east-3: m3: 123.456.78.97",
      "us-east-3: m4: 123.456.78.96"
    ]
  },
  "AdvancedConfig": {
    "ClusterConfig": {
      "LoginConfig": {
        "SudoUser": "tom",
        "Method": "K",
        "P": "<sudo_user_password>",
        "K": "/home/tom/mykey.pem"
      },
      "ReplicationFactor": 2
    }
  }
}
```

--------------------------------

### ALL:path example

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/ddl-and-loading/creating-a-loading-job

Example of defining a path for all machines in a cluster.

```gsql
"ALL:/data/graph.csv"
```

--------------------------------

### Create user example

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/user-access/user-management

An example of the interactive prompts for creating a standard user.

```text
User Name : user1
New Password : ************
Re-enter Password : ************
The user "user1" is created.
```

--------------------------------

### Install all GSQL functions

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/user-access/rbac-row-policy/rbac-row-policy

Commands to install all available functions.

```GSQL
GSQL > install function  ALL
GSQL > install function **
```

--------------------------------

### ANY:path example

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/ddl-and-loading/creating-a-loading-job

Example of defining a path for any machine in a cluster.

```gsql
"ANY:/data/graph.csv"
```

--------------------------------

### Load composite key to vertex and edge

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/ddl-and-loading/creating-a-loading-job

Example showing schema setup and loading job for vertices and edges with composite keys.

```gsql
// Schema setup
CREATE VERTEX Composite_Person (id uint, name string, PRIMARY KEY (name,id))
CREATE VERTEX Composite_Movie (id uint, title string, country string, year uint, primary key (title,year,id))
CREATE DIRECTED EDGE Composite_Roles (from Composite_Person,to Composite_Movie, role string) with reverse_edge="composite_roles_reverse"
CREATE GRAPH My_Graph(*)

// Loading job
CREATE LOADING JOB composite_load FOR GRAPH My_Graph {
  LOAD "$sys.data_root/movies.csv" TO VERTEX Composite_Movie VALUES
       ($"id", $"title", $"country" ,$"year") USING header ="true", separator=",";

  LOAD "$sys.data_root/persons.csv" TO VERTEX Composite_Person VALUES
       ($"id",$"name") USING header = "true", separator =",";
```

--------------------------------

### Define Kafka Filename Parameters

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/data-loading/load-from-kafka

Examples showing how to define a filename with a specific start timestamp or partition offsets for Kafka consumption.

```gsql
// Example 1: Specify the start timestamp to consume from
DEFINE FILENAME file_Person="""$s1:{
    "topic": "topic_Person",
    "time": "1745203693324"
}""";

// Example 2: Specify partition offsets: partition 0 starts at offset 200, partition 1 starts at offset 100, and partition 2 starts at the latest offset
DEFINE FILENAME file_Person="""$s1:{
    "topic": "topic_Person",
    "partition.offsets": "0:200,2:100,3:-1"
}""";
```

--------------------------------

### Run query via HTTP GET request

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/api/built-in-endpoints

Basic example of running an installed query on a specific graph with a vertex parameter.

```bash
curl -X GET "http://localhost:14240/restpp/query/social/hello?p=Tom"
bashCopied!
```

--------------------------------

### INSTALL QUERY Syntax

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/querying/create-and-install-queries

The basic syntax for the INSTALL QUERY command.

```ebnf
installQuery := INSTALL QUERY [installOptions] ( "*" | ALL | queryName ["," queryName]* )
```

--------------------------------

### Filename descriptor examples

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/data-loading/load-from-kafka

Concrete examples showing topic-only, configuration file, and inline JSON configuration formats for filename definitions.

```go
// Format 1: topic only
DEFINE FILENAME file_Person = "$s1:topic_Person";

// Format 2: topic and configuration file
DEFINE FILENAME file_Person = "$s1:myfile.json";

// Format 3: topic and inline configuration
DEFINE FILENAME file_Person="""$s1:{
    "topic": "topic_Person",
    "partition.offsets": "0:0,1:3,2:-1"
}""";
```

--------------------------------

### Get Disk Space Report Example

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/API/built-in-endpoints

Example curl command to get a disk space report from host m2.

```bash
curl -X POST localhost:14240/informant/metrics/get/diskspace -d '{"HostID":"m2"}'
```

--------------------------------

### Kafka file descriptor examples

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/data-loading/load-from-kafka-mm

Examples showing topic-only, configuration file, and inline configuration formats.

```go
// Format 1: topic only
DEFINE FILENAME file_Person = "$s1:topic_Person";

// Format 2: topic and configuration file
DEFINE FILENAME file_Person = "$s1:myfile.json";

// Format 3: topic and inline configuration
DEFINE FILENAME file_Person="""$s1:{
    "topic": "topic_Person",
    "tasks.max": "10"
}""";
```

--------------------------------

### Start Kafka server

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/system-management/change-data-capture/cdc-setup

Start the external Kafka cluster server.

```bash
KAFKA_ROOT=/home/tigergraph/test_cdc/download_kafka/kafka_2.13-3.3.1

$KAFKA_ROOT/bin/kafka-server-start.sh $KAFKA_ROOT/config/server.properties
```

--------------------------------

### Get Network Usage Report Example

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/API/built-in-endpoints

Example curl command to get a network usage report with the two most recent items.

```bash
curl -X POST localhost:14240/informant/metrics/get/network -d '{"LatestNum":"2"}'
```

--------------------------------

### CREATE GRAPH Examples

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/ddl-and-loading/defining-a-graph-schema

Examples showing how to include all vertex and edge types using the wildcard operator or how to create an empty graph.

```gsql
CREATE GRAPH Everything_Graph (*)
CREATE GRAPH Empty_Graph ()
gsqlCopied!
```

--------------------------------

### Install All Queries

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/querying/create-and-install-queries

Commands to install all uninstalled queries on a graph.

```gsql
INSTALL QUERY *
```

```gsql
INSTALL QUERY ALL
```

--------------------------------

### Get CPU and Memory Report Example

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/API/built-in-endpoints

Example curl command to get a CPU and memory report for the GSE service with partition and replica specified.

```bash
curl -X POST  localhost:14240/informant/metrics/get/cpu-memory -d '{"ServiceDescriptors":[{"ServiceName":"gse","Partition": 1,"Replica":1}]}'
```

--------------------------------

### Full connection example

Source: https://www.tigergraph.com/docs/pytigergraph/1.8/getting-started/connection

A complete example showing the initialization of the connection and the generation of the authentication token using a specific host, graph, and secret.

```python
from pyTigerGraph import TigerGraphConnection

conn = TigerGraphConnection(host="r_alliance.i.tgcloud.io", graphname="GoodsDelivery", gsqlSecret="oodvd1upqbj96vq22jof21o8nl8cjkd5") __**(1)**
conn.getToken('oodvd1upqbj96vq22jof21o8nl8cjkd5') __**(1)**
```

--------------------------------

### GET /gsql/v1/loading-jobs/status

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/api/gsql-endpoints

Get the status of one or more loading jobs that have been started.

```APIDOC
## GET /gsql/v1/loading-jobs/status

### Description
Get the status of one or more loading jobs that have been started, equivalent to GSQL SHOW LOADING STATUS.

### Method
GET

### Endpoint
/gsql/v1/loading-jobs/status

### Parameters
#### Query Parameters
- **jobIds** (string) - Required - ID of the loading job

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred
- **message** (string) - Status message
- **results** (array) - List of job status details
```

--------------------------------

### Run installation script with upgrade flag

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/installation/upgrade

Execute the installation script with the -U flag to initiate the upgrade process.

```bash
$ ./install.sh -U
Copied!
```

--------------------------------

### Example Restore Command

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/backup-and-restore/point-in-time-restore

An example of restoring the cluster to the specific time 2024-06-01T14:24:31Z.

```bash
$ gadmin backup restore 2024-06-01T14:24:31Z --time-point
```

--------------------------------

### Install Prerequisites

Source: https://www.tigergraph.com/docs/cloud/main/solutions/access-solution/jdbc.md

Install Java, Python, and download the Spark binary on an Ubuntu 18.04 machine.

```console
$ sudo apt update
$ sudo apt-get -y install openjdk-8-jdk-headless
$ sudo apt install python3
$ wget https://downloads.apache.org/spark/spark-3.3.1/spark-3.3.1-bin-hadoop2.tgz
```

--------------------------------

### Install Prerequisites

Source: https://www.tigergraph.com/docs/savanna/main/graph-development/load-data/jdbc.md

Install Java, Python, and download the Spark binary on an Ubuntu 18.04 machine.

```console
$ sudo apt update
$ sudo apt-get -y install openjdk-8-jdk-headless
$ sudo apt install python3
$ wget https://downloads.apache.org/spark/spark-3.3.1/spark-3.3.1-bin-hadoop2.tgz
```

--------------------------------

### Get Query Information Example

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/API/gsql-endpoints

Example of retrieving information for queries associated with the financialGraph.

```bash
curl -H 'Content-Type: application/json' -X GET 'localhost:14240/gsql/v1/queries/info?graph=financialGraph'
```

```json
{"error":false,"message":"","results":[{"graphUpdate":false,"installed":true,"endpoint":{"query":{"financialGraph":{"q1":{"GET/POST":{"graphUpdate":false,"summary":"This is query entrance","readDataList":{},"alternative_endpoint":"/query/q1","graph_name":"financialGraph","needReadRole":false,"executeGranted":false,"updateDataList":{},"enabled":true,"target":"GPE","deleteDataList":{},"libudf":"libudf-financialGraph-1","payload":[{"rule":"AS_JSON"},{"rule":"AS_QUERY_STRING"}],"function":"queryDispatcher","needCurrentRoles":false,"createDataList":{},"action":"query","executorList":[],"parameters":{"query":{"default":"q1","type":"STRING"}}}}}}},"code":"create query q1(){ print 1;}","callerQueries":[],"isACLSpecified":false,"name":"q1","syntax":"GSQL v2","installing":false,"enabled":true,"isHidden":false,"status":"VALID"}]}
```

--------------------------------

### SHOW command examples with globbing and regex

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/ddl-and-loading/defining-a-graph-schema

Examples demonstrating how to use Linux globbing and regular expressions to filter schema elements.

```gsql
Linux Globbing examples
SHOW VERTEX us*            //shows all vertices that start with the letters "Us"
SHOW VERTEX co?*y          //shows the vertices that starts with co and ends with y
SHOW VERTEX ?????          //shows all vertices that are 5 letters long

Regular Expression Examples
SHOW VERTEX -r "skil{2}"    //match the pattern "skill"
SHOW EDGE -r "test[1][13579]*"    //match pattern that only contains odd numbers after "test"
SHOW JOB -r "[a-zA-Z]*"     //match all jobs that contain only letters
```

--------------------------------

### Install GSQL Queries

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/API/gsql-endpoints

Install specific queries on a graph using the GET /gsql/v1/queries/install endpoint.

```bash
curl -X GET -H "Content-type: text/plain" "http://localhost:14240/gsql/v1/queries/install?graph=financialGraph1&queries=q1,q2&flag=-single"
```

```json
{
"requestId": ": "121212121331",
"message": "Successfully submitted request",
"startTime":  "2024-07-07T23:17:06.831474Z"
}
```

--------------------------------

### gadmin init help

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/system-management/management-commands

Displays help information for the gadmin init command, used to initialize the cluster or Kafka services.

```bash
$ gadmin init -h

Init the whole cluster or given service

Usage:
  gadmin init [flags]
  gadmin init [command]

Description:
  Init command initializes the cluster/kafka. When "cluster" is specified,
  a config path is required.

Available Commands:
  cluster     Init the whole cluster
  kafka       Init the KAFKA

Flags:
  -h, --help   help for init

Global Flags:
      --debug   enable debug log output to stdout

Use "gadmin init [command] --help" for more information about a command.
```

--------------------------------

### Prepare to Install Query

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/tutorials/pattern-matching/example

Set the syntax version and select the graph before installing a query.

```gsql
// before installing the query, need to set the syntax version
SET syntax_version="v2"
USE GRAPH ldbc_snb

// install query
INSTALL QUERY recommend_message
```

--------------------------------

### RESTPP query parameter example

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/querying/run-manage-queries

Example of a GET request to a RESTPP endpoint with a vertex parameter.

```bash
curl -X GET "http://localhost:14240/restpp/query/Entity_Resolution/getEntityByVertex?vertex_param=Entity_1"
```

--------------------------------

### Quick Loading Job Example

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/data-loading/load-from-iceberg

A comprehensive loading job example demonstrating how to define filenames using Iceberg queries and map them to vertices and edges.

```gsql
CREATE LOADING JOB loadSocialNet FOR GRAPH socialNet {
  DEFINE FILENAME f1 = "$s1:SELECT personId, id, gender FROM iceberg_connector.person WHERE gender = 'male'";
  DEFINE FILENAME f2 = "$s1:SELECT fromF, toF FROM iceberg_connector.friend";
  DEFINE FILENAME f3 = "$s1:SELECT postId, subject, postTime FROM iceberg_connector.post WHERE postId > 50";
  DEFINE FILENAME f4 = "$s1:SELECT fromP, toP FROM iceberg_connector.posted";
  DEFINE FILENAME f5 = "$s1:SELECT fromL, toL, actionTime FROM iceberg_connector.liked";
  LOAD f1 TO VERTEX person VALUES ($0, $1, $2);
  LOAD f2 TO EDGE friend VALUES ($0, $1);
  LOAD f3 TO VERTEX post VALUES ($0, $1, $2);
  LOAD f4 TO EDGE posted VALUES ($0, $1);
  LOAD f5 TO EDGE liked VALUES ($0, $1, $2);
}
```

--------------------------------

### GET /restpp/query/{graph_name}/{query_name}

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/API/built-in-endpoints

Executes an installed TigerGraph query via an HTTP GET request.

```APIDOC
## GET /restpp/query/{graph_name}/{query_name}

### Description
Executes an installed TigerGraph query. Parameters are passed through the query string.

### Method
GET

### Endpoint
/restpp/query/{graph_name}/{query_name}

### Parameters
#### Path Parameters
- **graph_name** (string) - Required - The name of the graph.
- **query_name** (string) - Required - The name of the installed query.
```

--------------------------------

### SHOW ROLE Example

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/user-access/role-management

Example command and output for listing all roles in the current scope.

```gsql
GSQL > SHOW ROLE
```

```text
  - Builtin Roles:
    observer
    queryreader
    querywriter
    designer
    admin
    globaldesigner
    superuser

  - User Defined Roles:
    - Graph 'tpc_graph' Roles:
      role1
      role2
```

--------------------------------

### GET /gsql/v1/queries/install/{requestid}

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/API/built-in-endpoints

Checks the installation status of a query installation request using the request ID.

```APIDOC
## GET /gsql/v1/queries/install/{requestid}

### Description
Returns the state of the installation request for each query and the overall state of the request.

### Method
GET

### Endpoint
/gsql/v1/queries/install/{requestid}

### Parameters
#### Path Parameters
- **requestid** (string) - Required - The ID of the installation request.

### Response
#### Success Response (200)
- **state** (string) - Overall status of the query installation request.
- **queries** (array) - List of queries and their individual installation states.
- **graph** (string) - The name of the graph.

### Response Example
{
  "state": "RUNNING",
  "error": false,
  "message": "",
  "results": "",
  "queries": [
    {
      "name": "t1",
      "state": "SUCCESS"
    }
  ],
  "graph": "poc_graph"
}
```

--------------------------------

### Example Execution and Output

Source: https://www.tigergraph.com/docs/graph-ml/3.10/centrality-algorithms/betweenness-centrality

Example of running the query with default parameters and the resulting JSON output.

```gsql
# Use _ for default values
RUN QUERY tg_betweenness_cent(["Person"], ["Friend"], _, _, _, _, _, _)
```

```json
[
  {
    "@@BC": {
      "Alice": 0,
      "Frank": 0,
      "Claire": 17,
      "Sam": 6,
      "Brian": 0,
      "David": 6,
      "Richard": 0,
      "Victor": 0
    }
  }
]
```

--------------------------------

### 1-Hop Step Example

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/querying/select-statement/select-statement-v1

A simple example of a 1-hop traversal step using aliases.

```gsql
Person:s -( (Bought|Rented):e )- (Product|Service):t
```

--------------------------------

### Get Query Signature Example

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/API/gsql-endpoints

Example of retrieving the signature for a specific query named q1 in the financialGraph.

```bash
curl -H 'Content-Type: text/plain' -X GET 'localhost:14240/gsql/v1/queries/signature?queryName=q1&graph=financialGraph'
```

```json
{"output":[{"1":"int"}],"input":[],"queryname":"q1","error":false,"message":"","version":{"schema":0,"edition":"ENTERPRISE_EDITION","api":"V2"}}
```

--------------------------------

### IMPORT GRAPH ALL Basic Example

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/backup-and-restore/database-import-export

A standard example of importing a graph from a specified directory path.

```text
IMPORT GRAPH ALL FROM "/tmp/export_graphs/"
```

--------------------------------

### Example Memory Threshold Configuration

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/system-management/memory-management

An example showing how to set SysMinFreePct and SysAlertFreePct within the GPE configuration.

```bash
> gadmin config entry GPE.BasicConfig.Env

GPE.BasicConfig.Env [ LD_PRELOAD=$LD_PRELOAD; LD_LIBRARY_PATH=$LD_LIBRARY_PATH; CPUPROFILE=/tmp/tg_cpu...(too long to show the full content, please use 'gadmin config get GPE.BasicConfig.Env' to get it) ]:

The runtime environment variables, separated by ';'

✔ New: LD_PRELOAD=$LD_PRELOAD; LD_LIBRARY_PATH=$LD_LIBRARY_PATH; CPUPROFILE=/tmp/tg_cpu_profiler; CPUPROFILESIGNAL=12; MALLOC_CONF=prof:true,prof_active:false

; SysMinFreePct=20;SysAlertFreePct=30 __**(1)**
bashCopied!
```

--------------------------------

### substr() function examples

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/querying/func/string-functions

Examples demonstrating substring extraction with varying start positions and optional length parameters.

```GSQL
substr("ABCDE", 2) -> "CDE"
substr("ABCDE", 2, 2) -> "CD"
substr("ABCDE", -2, 1) -> "D"
```

--------------------------------

### gsql_find() usage example

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/ddl-and-loading/functions/token/gsql_find

This example demonstrates finding the starting index of the substring 'bcd' within the string 'abcd'.

```gsql
gsql_find("abcd", "bcd") -> 1
```

--------------------------------

### Dropping a Query Example

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/querying/run-manage-queries

Example workflow showing the creation, installation, and subsequent dropping of a query, which results in dependent queries being disabled.

```gsql
GSQL > create query A(){print 1;}
Successfully created queries: [A].

GSQL > create query B(){ A();}
Successfully created queries: [B].

GSQL > install query *
Start installing queries, about 1 minute ...
<....>
Query installation finished.

GSQL > drop query A
Successfully dropped queries on the graph 'g': [A].

GSQL > ls
---- Graph g
Vertex Types:
Edge Types:

Graphs:
  - Graph g()
Jobs:
Queries:
  - B() (disabled)
```

--------------------------------

### Run the Installed Query

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/tutorials/pattern-matching/example

Install the query and execute it with specific parameters, showing the resulting JSON output.

```gsql
GSQL > INSTALL QUERY recommend_message
Start installing queries, about 1 minute ...
recommend_message query: curl -X GET 'http://127.0.0.1:14240/restpp/query/ldbc_snb/recommend_message?fn=VALUE&ln=VALUE'. Add -H "Authorization: Bearer TOKEN" if authentication is enabled.

[========================================================================================================] 100% (1/1)
GSQL > run query recommend_message("Viktor", "Akhiezer")
{
  "error": false,
  "message": "",
  "version": {
    "schema": 0,
    "edition": "enterprise",
    "api": "v2"
  },
  "results": [{"recommended_message": [
    {
      "v_id": "549760294602",
      "attributes": {
        "recommended_message.@rank": 4855.49219,
        "recommended_message.content": "About Indira Gandhi, Gandhi established closer relatAbout Mick Jagger, eer of the band. In 1989, he waAbout Ho Chi Minh, ce Unit and ECA International, About Ottoman Empire,  After t"
      },
      "v_type": "Post"
    },
    {
      "v_id": "549760292109",
      "attributes": {
        "recommended_message.@rank": 4828.7251,
        "recommended_message.content": "About Ho Chi Minh, nam, as an anti-communist state, fought against the communisAbout Shiny Happy People, sale in the U."
      },
      "v_type": "Post"
    }
  ]}]
}
```

--------------------------------

### Retrieve groups via SCIM GET /gsql/scim/v2/Groups

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/api/gsql-endpoints

Retrieves a list of groups using SCIM format, supporting filters and attribute exclusion.

```bash
curl -X GET -H "Content-type: text/plain" "http://localhost:14240/gsql/scim/v2/Groups?excludedAttributes=members&filter=displayName%ne%20'g2'%20and%20displayName%20sw%20'g1'"
```

```json
{"totalResults":1,"startIndex":1,"itemsPerPage":100,"schemas":true,"Resources":[{"displayName":"g1","meta":{"location":"/scim/v2/Groups/0570fc42-79ea-427e-aa2e-2b53a0470163","resourceType":"Group"},"id":"0570fc42-79ea-427e-aa2e-2b53a0470163"}]}
```

--------------------------------

### GSQL Query Status Examples

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/querying/run-manage-queries

Examples of various query statuses including draft, installed, deprecated, blocked, disabled, pending, and failed.

```gsql
# draft                          <-- a query that is set to DRAFT status because it calls a query with DRAFT status
CREATE QUERY draft_callDraft2(){
  draft2();
  PRINT "I am a draft too";
}

# installed v2                 <-- query is valid and has been installed successfully
CREATE QUERY valid2(){
  PRINT 1;
}

# deprecated                  <-- the query is deprecated if it is incompatible with the schema after a schema change
CREATE QUERY valid3(){
  v = SELECT src
      FROM unexistentType:src;
}

# blocked                    <-- the query is blocked by the file output policy
CREATE QUERY blockedQuery(){
  FILE f("/root");
}

# disabled                   <-- the query is disabled if it calls a deleted sub-query.
CREATE QUERY disabledQuery(){
  deletedQuery();
}

# pendingInstall            <-- the query is installing
CREATE QUERY valid3(){
  PRINT 1;
}

# failedCompilation         <-- query installation failed
CREATE QUERY valid3(){
  PRINT 1;
}
```

--------------------------------

### Configure NodeList with Hostnames

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/installation/bare-metal-install

Example format for defining the NodeList using hostnames in the install_conf.json file.

```json
"NodeList": [
  "m1: hostname1",
  "m2: hostname2",
  "m3: hostname3",
  "m4: hostname4"
]"
```

--------------------------------

### GET /gsql/v1/queries/install

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/API/gsql-endpoints

Installs specified GSQL queries for a given graph.

```APIDOC
## GET /gsql/v1/queries/install

### Description
This api is used for installing queries.

### Method
GET

### Endpoint
/gsql/v1/queries/install

### Parameters
#### Query Parameters
- **graph** (string) - Required - which graph to install queries
- **queries** (string) - Required - query names(join with `,` separated); value `*` or `all` mean all the queries.
- **flag** (string) - Optional - Possible values: `-single`, `-force`, `-legacy`, `-debug`, `-cost`.

### Response
#### Success Response (200)
- **requestId** (string) - The ID of the installation request
- **message** (string) - Status message
- **startTime** (string) - Timestamp of the request start
```

--------------------------------

### Login example with inline command or command file

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/basics/running-gsql

Syntax for running GSQL commands or files from the operating system shell.

```bash
gsql [-u username] [-g graphname] ['command_string' | command_file]
```

--------------------------------

### GET /restpp/endpoints/{graph_name}

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/API/built-in-endpoints

Returns a list of installed endpoints and their parameters.

```APIDOC
## GET /restpp/endpoints/{graph_name}

### Description
Returns a list of installed endpoints, including built-in, dynamic, and static types.

### Method
GET

### Endpoint
/restpp/endpoints/{graph_name}

### Parameters
#### Path Parameters
- **graph_name** (string) - Required - The name of the graph.

#### Query Parameters
- **builtin** (boolean) - Optional - Returns built-in endpoints if true.
- **dynamic** (boolean) - Optional - Returns dynamic endpoints if true.
- **static** (boolean) - Optional - Returns user-installed endpoints if true.
```

--------------------------------

### RESUME LOADING JOB Example

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/ddl-and-loading/managing-loading-job

An example of executing the resume command via the GSQL CLI.

```gsql
gsql -g demo_graph "RESUME LOADING JOB demo_graph_m1.1519111662589"
[RESUME_SUCCESS] m1
[MESSAGE] The current job got resummed
```

--------------------------------

### GET /restpp/eco

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/querying/run-manage-queries

Example of an error response when an invalid endpoint is requested via the REST++ interface.

```APIDOC
## GET /restpp/eco

### Description
This example demonstrates the error response returned by the REST++ interface when an invalid endpoint is accessed.

### Method
GET

### Endpoint
http://localhost:14240/restpp/eco

### Response
#### Success Response (200)
- **version** (object) - Contains edition, api, and schema information.
- **error** (boolean) - Indicates if an error occurred.
- **message** (string) - Description of the error.
- **code** (string) - Specific error code.

#### Response Example
{
  "version": {"edition":"developer","api":"v2","schema":0},
  "error": true,
  "message": "Endpoint is not found from url = /eco, please use GET /endpoints to list all valid endpoints.",
  "code": "REST-1000"
}
```

--------------------------------

### Query Failure Error Message

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/installation/upgrade

Example of an error message encountered when installed queries fail after a rolling upgrade.

```json
{"version":{"edition":"enterprise","api":"v2","schema":8},"error":true,
"message":"error_: unknown function error {\"data\":\"\",\"func\":\"queryDispatcher\",
\"libudf\":\"libudf-ldbc_snb-1\",\"options\":{\"_api_\":\"v2\",\"graph_id\":[\"26\"],
\"query\":[\"test_query\"]}}"}
```

--------------------------------

### Authenticate API Request with cURL

Source: https://www.tigergraph.com/docs/savanna/main/rest-api/authentication.md

Example of a GET request to the workgroups endpoint using an API key in the header.

```bash
curl -X GET "https://api.tgcloud.io/controller/v4/v2/workgroups" \
     -H 'Content-Type: application/json' \
     -H "x-api-key: <your-api-key>"
```

--------------------------------

### Run FILE parameter query in RESTPP

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/querying/run-manage-queries

Example of passing a file path via a GET request to RESTPP.

```bash
curl -X GET "http://127.0.0.1:14240/restpp/query/Entity_Resolution/testFILE?file_param=%2Fhome%2Ftigergraph%2Fdata%2Ftest.csv"
```

--------------------------------

### Example of connecting to a node with gssh

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/cluster-and-ha-management/cluster-commands

Demonstrates the transition from node m1 to node m3 using the gssh command.

```bash
# Originally on m1
[tigergraph@ip-172-31-88-111 ~]$ gssh m3
Last login: Fri Apr 23 18:24:27 2021
# Now connected to m3 via ssh
[[tigergraph@ip-172-31-93-187 ~]$
```

--------------------------------

### Execute k-core algorithm example

Source: https://www.tigergraph.com/docs/graph-ml/3.10/community-algorithms/k-core-decomposition

An example of running the k-core algorithm on a 'person' vertex type and 'friendship' edge type.

```gsql
RUN QUERY tg_kcore("person", "friendship", 0, -1, TRUE, "", "", FALSE, FALSE)
```

--------------------------------

### gsql_substring() Usage Example

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/ddl-and-loading/functions/token/gsql_substring

Demonstrates extracting a substring from the 'Name' column starting at index 1 with a length of 3.

```gsql
gsql_substring($"Name", 1, 3) -> "ayl"
```

--------------------------------

### Workload Queue Configuration Example

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/system-management/workload-management

A sample configuration output showing defined workload queues and their access permissions.

```json
{
  "OLTP": {
    "description": "OLTP queries",
    "isDefault": true,
    "maxConcurrentQueries": 100,
    "maxDelayQueueSize": 100,
    "granted": {
      "USER": [],
      "GROUP": ["g1", "g2"],
      "ROLE": []
    }
  },
  "scheduled_jobs": {
    "description": "Scheduled jobs",
    "maxConcurrentQueries": 5,
    "maxDelayQueueSize": 0,
    "granted": {
      "USER": ["u1"],
      "GROUP": [],
      "ROLE": ["r1"]
    }
  },
  "AdHoc": {
    "description": "Ad-hoc queries",
    "isDefault": false,
    "maxConcurrentQueries": 10,
    "maxDelayQueueSize": 10,
    "granted": {
      "USER": [],
      "GROUP": ["g3"],
      "ROLE": ["r2"]
    }
  }
}
```

--------------------------------

### Execute query via curl

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/API/built-in-endpoints

Example curl command to execute the installed query using a request body file.

```bash
$ curl -X POST -d @<path_to_request_body> ""http://localhost:14240/restpp/query/Social/print_params"
```

--------------------------------

### Run SET parameter query in RESTPP

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/querying/run-manage-queries

Examples of passing a set of integers via GET and POST requests to RESTPP.

```bash
curl -X POST "http://localhost:14240/restpp/query/Entity_Resolution/testSET?set_param=1&set_param=2&set_param=3&set_param=4"
```

```bash
curl -X POST -H "Content-Type: application/json" \
-d '{"set_param": [1, 2, 3, 4]}' \
"http://localhost:14240/restpp/query/Entity_Resolution/testSET"
```

--------------------------------

### Run Installation Script

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/installation/bare-metal-install

Execute the installation script in non-interactive mode using the configuration file.

```bash
sudo ./install.sh -n
```

--------------------------------

### Run BAG parameter query in RESTPP

Source: https://www.tigergraph.com/docs/gsql-ref/4.3/querying/run-manage-queries

Examples of passing a bag of integers via GET and POST requests to RESTPP.

```bash
curl -X GET "http://localhost:14240/restpp/query/Entity_Resolution/testBAG?bag_param=1&bag_param=2&bag_param=3&bag_param=2"
```

```bash
curl -X POST -H "Content-Type: application/json" \
-d '{"bag_param": [1, 2, 3, 2]}' \
"http://localhost:14240/restpp/query/Entity_Resolution/testBAG"
```

--------------------------------

### gadmin Command Execution Audit Log

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/troubleshooting/audit-log

Example of an audit log entry generated after executing the 'gadmin start all' command.

```json
{
"timestamp": "2024-05-13 23:45:34.940",
"session id": 1418,
"OS username": "tigergraph",
"host": "10.128.0.48",
"command": "gadmin start all",
"status": "SUCCESS"
}
```

--------------------------------

### View gadmin start help

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/system-management/management-commands

Displays the help menu for the gadmin start command, detailing service ID syntax and available flags.

```bash
$ gadmin start -h

Start services by service id

Usage:
  gadmin start [serviceID...] [flags]

Description:
  ServiceID should be [serviceName][_partition][#replica], e.g., GSE_1#3. Leave
  replica field empty(e.g. GSE_1) to either refer to all replicas of given
  partition, or if the service has no replicas(e.g. EXE_1). Same for parititons.
  If no serviceID is specified, it only starts services excluding the
  infrastructure. Use 'gadmin start all' to start all services.

Flags:
      --auto-restart         auto restart the service on crash
      --dry-run              dry run and output command to start the service
  -h, --help                 help for start
      --ignore-error         ignore errors when starting services
      --no-dep               start service without dependency
      --timeout int          request timeout(in MilliSecond) to start the service
      --wait-online          wait until the services go online, the time limit can be specified by '--timeout'
      --with-config string   start with given config file and dump it to each node (only for executor)
      --local                start only local services in cluster instance

Global Flags:
      --debug   enable debug log output to stdout
```

--------------------------------

### Extract CREATE GRAPH privileged actions

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/security/audit-privileged-actions

This example demonstrates how to filter the logs for all privileged actions starting with 'CREATE GRAPH'.

```bash
$ awk '/^(E|I|D)@.*/ {p=0}; /^(E|I|D)@.*_ACCESS_CHECK_.*Command Type: CREATE GRAPH.*/ {p=1; printf FILENAME ":" FNR ":"}; p { print }' ~/tigergraph/log/gsql/INFO.*
```

```text
/home/tigergraph/tigergraph/log/gsql/INFO.20220914-163940.595:603:I@20220914 16:40:57.157 tigergraph|127.0.0.1:53046|00000000008 (PermissionUtil.java:371) User Name: tigergraph, _ACCESS_CHECK_RBAC_, Command Type: CREATE GRAPH ldbc_snb ( * ), Validation Result: SUCCESS, Required RBAC Permission: [], Required Data Access Permission: [], Required Application Access Permission: []
```

--------------------------------

### Example Backup Tag Sequence

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/backup-and-restore/incremental-backup

A conceptual list of tags for a series of full and incremental backups starting on January 1.

```text
full-weekly-jan-01 // contains a full backup
incr-daily-jan-02  // contains only what changed on Jan. 2
incr-daily-jan-03  // contains only what changed on Jan. 3
incr-daily-jan-04  // contains only waht changed on Jan. 4
```

--------------------------------

### File Config Provider Example

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/data-loading/externalizing-kafka-configs

Demonstrates using a properties file to store secrets and referencing them in a data source configuration.

```text
S3_ACCESS_KEY=thisisakey
S3_SECRET_KEY=anotherkey
```

```json
{
    "type": "s3",
    "access.key":"${file:/tmp/secret.properties:S3_ACCESS_KEY}",
    "secret.key":"${file:/tmp/secret.properties:S3_SECRET_KEY}",
    "config.providers":"file",
    "config.providers.file.class":"org.apache.kafka.common.config.provider.FileConfigProvider"
}
```

--------------------------------

### Legacy RBAC Privilege Syntax Behavior Changes

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/user-access/fine-grained-query-privileges

Examples of legacy privilege commands and their updated behavior starting in version 4.1.

```GSQL
GRANT PRIVILEGE WRITE_QUERY ON GLOBAL TO r1
```

```GSQL
GRANT PRIVILEGE READ_QUERY ON GRAPH g1 TO r1
```

```GSQL
GRANT WRITE ON ALL QUERIES IN GRAPH g1 TO r1
```

--------------------------------

### Example connection to a local graph

Source: https://www.tigergraph.com/docs/pytigergraph/1.8/getting-started/connection

A complete example showing how to import the connection class, initialize it with host and credentials, and authenticate with a secret.

```python
from pyTigerGraph import TigerGraphConnection

conn = TigerGraphConnection(host="127.0.0.1", graphname="GoodsDelivery", username="hsolo", password="f4lc0n")
conn.getToken('oodvd1upqbj96vq22jof21o8nl8cjkd5') __**(1)**
```

--------------------------------

### Initialize Featurizer for Offline Environments

Source: https://www.tigergraph.com/docs/pytigergraph/1.8/gds/factory-functions

Demonstrates how to initialize the Featurizer using a manually downloaded repository path when the environment lacks public internet access.

```python
import pyTigerGraph as tg
from pyTigerGraph.gds.featurizer import Featurizer

conn = tg.TigerGraphConnection(host="HOSTNAME_HERE", username="USERNAME_HERE", password="PASSWORD_HERE", graphname="GRAPHNAME_HERE")
conn.getToken(conn.createSecret())
feat = conn.gds.featurizer(repo="PATH/TO/MANUALLY_DOWNLOADED_REPOSITORY")

res = feat.runAlgorithm("tg_pagerank", params={"v_type": "Paper", "e_type": "CITES"})

print(res)
```

--------------------------------

### Loading Job Configuration File Example

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/security/gsql-file-input-policy

Example of defining a loading job that utilizes a configuration file path.

```gsql
CREATE DATA_SOURCE KAFKA ka = "/tmp/kafka_broker.json" FOR GRAPH g
CREATE LOADING JOB load_kafka {
    // This path should also be considered
    DEFINE FILENAME f1 = "$ka:/tmp/kafka_topic.json";
    LOAD f1 TO VERTEX v1 VALUES($0, $1);
}
```

--------------------------------

### Run query with parameters via cURL

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/api/gsql-endpoints

Example of executing an installed query using the GSQL endpoint with a JSON payload containing parameters.

```bash
curl -H 'Content-Type: application/json' -X POST 'http://localhost:14240/gsql/v1/queries/paramEx?graph=financialGraph
-d '{"diagnose":false,"denseMode":false,"allvertex":false,"asyncRun":false,
"parameters":{"name":"Fred", "age":35,
"neighbors":[["Mr. McFeely","Person"],["Daniel Tiger","Puppet"]]}}''
```

--------------------------------

### Retrieve schema metadata via GET /gsql/v1/schema

Source: https://www.tigergraph.com/docs/tigergraph-server/4.3/API/built-in-endpoints

Example request and response for fetching schema details of a specific vertex type in a graph.

```bash
curl -u tigergraph:tigergraph \
"localhost:14240/gsql/v1/schema?graph=workNet&type=company"

{
  "error": false,
  "message": "",
  "results": {
    "Config": {
      "STATS": "OUTDEGREE_BY_EDGETYPE",
      "PRIMARY_ID_AS_ATTRIBUTE": false
    },
    "Attributes": [
      {
        "AttributeType": {
          "Name": "STRING"
        },
        "IsPartOfCompositeKey": false,
        "PrimaryIdAsAttribute": false,
        "AttributeName": "id",
        "HasIndex": false,
        "IsPrimaryKey": false
      },
      {
        "AttributeType": {
          "Name": "STRING"
        },
        "IsPartOfCompositeKey": false,
        "PrimaryIdAsAttribute": false,
        "AttributeName": "country",
        "HasIndex": false,
        "IsPrimaryKey": false
      }
    ],
    "PrimaryId": {
      "AttributeType": {
        "Name": "STRING"
      },
      "IsPartOfCompositeKey": false,
      "PrimaryIdAsAttribute": false,
      "AttributeName": "clientId",
      "HasIndex": false,
      "IsPrimaryKey": false
    },
    "Name": "company"
  }
}
```
Tokens:
Raw