API ReferenceProduct Documentation
Product Documentation
Start typing to search…

Namespaces

A namespace defines a realm within the Tetra Data Platform (TDP) where only those who have the appropriate permissions can use the artifacts in that realm.

There are three types of namespaces:

📘

NOTE

To deploy artifacts from either the client or private namespace to multiple organizations, see Add Artifacts to Multiple Organizations

common Namespace

Format: common

The common namespace is used for artifacts that are published by TetraScience and are available to all customers. Members of all organizations have read access to the artifacts in the common namespace. No one outside of TetraScience has write access to these artifacts.

private Namespace

Format: private-{orgslug/orgslugprefix}

The private namespace is used for artifacts that are published by TetraScience customers. When applied to an artifact, the private namespace must be appended with a single hyphen (-) and either of the following:

  • An orgSlug with no hyphens (for example, private-tetrascience)

    -or-

  • An orgSlug prefix if the orgslug includes a hyphen (for example, the hyphenated orgslugs tetrascience-dev and tetrascience-prd would be appended to the namespace as just private-tetrascience)

The orgslug or orgslug prefix indicates which organization has access to the artifact. Members of the specified organization are the only users that have read and write access to these artifacts.

client Namespace

📘

NOTE

To better productize solutions and help more customers, TetraScience will only create new artifacts in the client namespace by exception starting November 13, 2025. Instead, all new artifacts created by TetraScience for customers will be deployed to the common namespace, and will be available to all customers. Support provided by contract will continue for all existing artifacts in the client namespace.

For more information, see the client Namespace Deprecation for New Artifacts.

Format: client-{orgslug/orgslugprefix}

The client namespace is used for artifacts that are published by TetraScience for a specific customer. When applied to an artifact, the client namespace must be appended with a single hyphen (-) and either of the following:

  • An orgSlug with no hyphens (for example, client-tetrascience)

    -or-

  • An orgSlug prefix if the orgslug includes a hyphen (for example, the hyphenated orgslugs tetrascience-dev and tetrascience-prd would be appended to the namespace as just client-tetrascience)

The orgslug or orgslug prefix indicates which organization has access to the artifact. Members of the specified organization are the only users that have read and write access to these artifacts.

🚧

IMPORTANT

OpenSearch index mapping conflicts can occur when a client or private namespace creates a backwards-incompatible data type change. For example: If doc.myField is a string in the common Intermediate Data Schema (IDS) and an object in the non-common IDS, then it will cause an index mapping conflict, because the two namespace documents are sharing an index. When these mapping conflicts occur, the files aren't searchable through the TDP user interface or API endpoints. As a workaround, you can either create distinct, non-overlapping version numbers for your non-common IDSs or update the names of those IDSs.

Add Artifacts to Multiple Organizations

When you use Self-Service Tetra Data Pipelines (SSPs), Self-Service Data Apps, or Self-Service Connectors, you can deploy artifacts from either the private or client namespace to more than one organization.

Deploy Artifacts to Multiple Orgs on Different TDP Instances

To deploy an artifact to multiple organizations across different TDP instances (for example, https://platform.tetrascience.com and https://gxp.tetrascience.com), you must deploy the artifact separately on each instance.

For instructions, see the following Hello, World! examples for each type of self-service artifact:

📘

NOTE

On each TDP instance, you can still use orgslug prefixes to deploy artifacts to multiple organizations.

Deploy Artifacts to Multiple Orgs on the Same TDP Instance

To deploy an artifact to multiple organizations on the same TDP instance, all references to the artifact's namespace value in your artifact files and ts-cli commands should include the orgslug prefix only.

Orgslug Prefixes

An orgslug prefix is the part of each orgslug that appears before any hyphens (<orgslug prefix>-), if the orgslug includes any (for example, tetrascience-dev and tetrascience-prd).

Namespace Format for Orgslug Prefixes: private-<orgslug prefix>

For example, the orgslug prefix for the following organizations is company:

  • company-dev
  • company-test
  • company-prd

To deploy an artifact to each of these organizations (if they're on the same TDP instance), you would use the following formatting for the artifact's files' namespace fields and in your ts-cli commands: private-company

For this example, adding private-company to the namespace fields in the artifact files and ts-cli commands makes the artifact available to all of the organizations within the company orgslug prefix (company-dev, company-test, and company-prd).

Documentation Feedback

Do you have questions about our documentation or suggestions for how we can improve it? Start a discussion in TetraConnect Hub. For access, see Access the TetraConnect Hub.

📘

NOTE

Feedback isn't part of the official TetraScience product documentation. TetraScience doesn't warrant or make any guarantees about the feedback provided, including its accuracy, relevance, or reliability. All feedback is subject to the terms set forth in the TetraConnect Hub Community Guidelines.

Updated about 8 hours ago