Skip to main content

Projects

A project within Tigris is a conceptual container for Tigris products, configuration, and access using application keys.

Every Tigris project contains the following:

Regions

Projects can be created in the following regions and accessed using the associated URI:

Region IdentifierURI
aws-us-east-1api.cell1.us-east-1.aws.tigrisdata.cloud
aws-us-west-2api.preview.tigrisdata.cloud
aws-eu-west-2api.cell1.eu-west-2.aws.tigrisdata.cloud

Each region maps to an AWS region.

Application keys

Application keys to enable programmatic access to the Tigris HTTP API either directly using a Tigris SDK or other Tigris tool.

Application keys consist of a client ID and a client secret.

Application keys can be managed within the Application Keys section of a project in the Tigris Cloud web console or by using the Tigris CLI create app_key command.

Project configuration

Configuration for a project is required to use the Tigris APIs either directly or using an SDK. Project configuration consists of:

ConfigurationValue description
Project namethe name you've given the project
Urithe URI to the region the project has been created within
Client IDthe application key client ID used to authenticate with Tigris
Client secretthe application key client secret used to authenticate with Tigris
Database branchthe database branch to use with the database for the project

Project configuration environment variables

Project configuration is conventionally stored within environment variables. The Tigris SDKs look for values within these environmental variables by default. However, you can also pass values to the SDKs directly.

The environment variables for project configuration are as follows:

Environment variable nameValue description
TIGRIS_PROJECTthe name you've given the project
TIGRIS_URIthe URI to the region the project has been created within
TIGRIS_CLIENT_IDthe application key client ID used to authenticate with Tigris
TIGRIS_CLIENT_SECRETthe application key client secret used to authenticate with Tigris
TIGRIS_DB_BRANCHthe database branch to use with the database for the project