Attributes: Metadata, Tags, and Labels
You can use attributes to annotate (decorate) your files and trigger pipelines without changing the actual data in your files. There are three different attribute types:
- Metadata
- Tags
- Labels
Each attribute is designed to be used differently. This table provides information describing the different attributes and their usage:
Attribute -> | Metadata | Tag | Label |
---|---|---|---|
Format | key:value pair Example: SignOff:False | String Example: ChromaTest099 | name:value pairs Example: sample_id: "041020K001","Glucose Control 1","mAb sample_4" |
Description | Immutable: Modifying the metadata of a file generates a new file version with a new fileId .Attached as native S3 metadata to the underlining S3 object. Multiple versions from changes leads to add'l S3 storage usages | Immutable: Modifying the tags of a file generates a new file version with a new fileId .Attached as native S3 metadata to the underlining S3 object. Multiple versions from changes leads to add'l S3 storage usages | Mutable: Modifying the labels of a file does not generate a new file version. Files cannot have two labels with the same name:value combination.Files can have two labels with the same name |
Usage | Use to annotate the file with simple information that could be tracked. | Use to store data (for example, the name of a test event). | Use for annotations, or to annotate more complex information. |
Sizing | Metadata value: Up to 2 KB The limit of all metadata and tags associated with a single file is 2 KB. Limited to one key:value | Tag value: Up to 128 characters The limit of all metadata and tags associated with a single file is 2 KB. Limited to one value. | Label name: 128 characters Label value: 256 characters More than one value is allowed because a label is an array, and one field may store several values. Unlimited number of labels per file. |
Characters Allowed | Keys can include only letters, numbers, spaces and selected symbols (+ , - , or _ )Values can include only letters, numbers, spaces and selected symbols ( + , - , . , _ , / , or , )Does not support empty string. | Tags can include only letters, numbers, spaces and selected symbols (+ , - , . , _ or / )Does not support empty string. | Names can include only letters, numbers, spaces and selected symbols (+ , - , . or _ )Values can include only letters, numbers, spaces and selected symbols ( + , - , . , _ , / or , )Does not support empty string. |
Trigger Pipeline? | Yes | Yes | Yes |
Attribute validation rules apply to all places where you can use metadata, tags, and labels:
- Adding attributes to sources (for example, Tetra Agents)
- Adding attributes to files
- Using the Web API
- Using the ts-sdk
To learn how to manage attributes from the Tetra Data Platform Attribute Management page, click here.
Updated 26 days ago