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:

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.

client Namespace

Format: client-orgslug

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 an orgSlug to indicate which organization has access to the artifact (for example, client-tetrascience). Members of the specified organization are the only users that have read access to the artifact. No one outside of TetraScience has write access to these artifacts.

๐Ÿ“˜

NOTE

Make sure that you donโ€™t include multiple dashes outside of the initial client-orgslug, because they're not supported.

private Namespace

Format: private-orgslug

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 an orgSlug to indicate which organization has access to the artifact (for example, private-tetrascience). Members of the specified organization are the only users that have read and write access to theses artifacts.

๐Ÿ“˜

NOTE

Make sure that you donโ€™t include multiple dashes outside of the initial client-orgslug, because they're not supported.

๐Ÿšง

IMPORTANT

Elasticsearch 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.