Annotating Schema in TD Console

Annotating your table schema can be done in the Data Workbench through the UI, API, or TD command-line interface.

  1. Open TD Console.

  2. Navigate to Data Workbench > Databases.


  3. Select a database.

  4. Select a table.

  5. Select Schema for the table.


  6. Select Edit Schema.

  7. Using the Identity Type drop-down for the column you want to annotate, select the annotation you want to set for that column. The identity types pre-defined by Treasure Data are:

    • 1st Party Cookie (Client-side)

    • 1st Party Cookie (Server-side)

    • 3rd Party Cookie (Partner)

    • 3rd Party Cookie (TD)

    • Email (Hashed)

    • Email (Raw)

    • Home address

    • Phone Number (Hashed)

    • Phone Number (Raw)

    • Vehicle Identification Number (VIN)


  8. After selecting the Identity Type, indicate whether the column contains sensitive data or not by selecting True or False from the Sensitive drop-down.


  9. After creating the annotations for the desired columns, select Save.

After you have completed annotating the schema for the table, you can use the API to search annotations. Contact support for more information.

Removing Schema Annotations

  1. Open TD Console.

  2. Navigate to Data Workbench > Databases.


  3. Select a database.

  4. Select a table.

  5. Select Schema for the table.


  6. Select Edit Schema.

  7. Select None from the Identity Type drop-down menu for the column from which you want to remove the annotation. Repeat this for any other column annotations you want to remove.

  8. Select Save.

Annotating Schema via API

Annotated Schema APIs allow you to create, update, and delete annotated schemas. For more information about these APIs, contact support.


  • No labels