Add custom templates to a clean room¶

Both providers and consumers can add custom templates to a clean room. Custom templates are run the same way as Snowflake-provided templates.

Note

A clean room template is a valid JinjaSQL template. You should read the clean room reference guide for custom templates before trying to create your own clean room templates.

Provider-written custom templates¶

Providers can add a custom template to a clean room without consumer approval. Consumers can run a provider-written template without approval. The next sections describe how a provider can add a custom template, and a consumer run that template, using the API.

If the provider wants to design a template that a consumer can run in the clean rooms UI, they must create a user input form for the template.

Add a provider-written template¶

Providers add custom templates one at a time by calling provider.add_custom_sql_template, passing in the template JinjaSQL as a string. Custom templates appear in the clean room’s template list, and behave the same as Snowflake-provided templates. A clean room can contain any mix of custom and Snowflake-provided templates.

You can also upload custom Python UDFs for your template to call.

Tip

When you add a custom template for consumers to use, you should provide documentation that describes what the template does, and the required and optional arguments used by the template.

The following example shows how a provider adds a custom template to a clean room:

CALL samooha_by_snowflake_local_db.provider.add_custom_sql_template(
    $cleanroom_name,
    $basic_template_name,
    $$
    SELECT
      COUNT(*) AS total_count
    FROM IDENTIFIER({{ my_table[0] }}) AS c
      INNER JOIN IDENTIFIER({{ source_table[0] }}) AS p
      ON IDENTIFIER({{ consumer_id | join_policy }}) = IDENTIFIER({{ provider_id | join_policy }})
    {% if where_clause %}
    WHERE {{ where_clause | sqlsafe }}
    {% endif %};
  $$
);
Copy

In most templates, including the previous example, column names must be fully qualified with the table name to avoid column name conflicts. This is because it is not easy to concatenate a table name prefix to a column name in the prefix and get a valid identifier (IDENTIFIER(p.{{col_name | sqlsafe }}) is an error). Therefore, you might need the caller to provide a fully qualified table name rather than just a column name. Table names should use the approved p and c aliases.

Run a provider-written template¶

When using the clean rooms API, consumers call consumer.run_analysis to run a template, and providers call provider.submit_analysis_request for provider-run analyses.

If you want a template to be runnable in the clean rooms UI, the provider must create a user input form for the template. Only provider-written templates can be run in the clean rooms UI.

Clean room collaborators can see the JinjaSQL for any template in a clean room by calling consumer.view_template_definition, unless the provider obfuscated the template. Only provider-written templates can be obfuscated.

You can call consumer.get_arguments_from_template to parse and list the variables used in a template. However, for large or complex templates this procedure might not list all template variables, so ensure that you provide helpful documentation for your template users.

The following example shows how a consumer runs the provider’s custom template that was shown previously:

 CALL samooha_by_snowflake_local_db.consumer.run_analysis(
  $cleanroom_name,
  'basic_template',
  ['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS'],  -- Populates the my_table array.
  ['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS'],  -- Populates the source_table array.
  OBJECT_CONSTRUCT(
  'consumer_id', 'c.hashed_email',  -- hashed_email column from the consumer's table.
  'provider_id', 'p.hashed_email',  -- hashed_email column from the provider's table.
  'where_clause','c.status = $$MEMBER$$ AND c.age_band > 30' -- $$...$$ is used to stringify the column value.
  )
);
Copy

Provider template example code¶

Here is a full code example showing how a provider adds a custom template, and how the consumer runs it. You need two separate accounts with the clean rooms API installed to run the code; one account to act as the provider and the other account to act as the consumer.

Consumer-written custom templates¶

A consumer can add a custom template to the clean room if the provider approves. Once added to the clean room, the consumer-written template can be run the same as a provider-written template. Here is how a consumer adds a custom template:

  1. The provider creates, shares, and publishes a clean room in the standard way.

  2. The consumer installs and configures the clean room in the standard way.

  3. The consumer calls consumer.create_template_request and passes in the custom template string.

  4. The provider calls provider.list_pending_template_requests to see pending requests.

  5. The provider can approve (provider.approve_template_request) or reject (provider.reject_template_request) the consumer’s request to run their own template. (There are also bulk versions of these methods for approving or rejecting multiple requests.) If the provider approves, the template is added to the clean room immediately.

    • If the provider approves the template, the provider should add any necessary join and column policies for that template and their data. If the provider does not have a join or column policy in the clean room, the default is that all the provider’s columns are joinable and projectable.

  6. The consumer checks the status of their request by calling either consumer.list_template_requests (which shows the status, including rejection status with an explanation) or consumer.view_added_templates (to see if their template was added to the clean room).

  7. The consumer optionally adds column policies for the template.

  8. The consumer runs the template by calling consumer.run_analysis in the standard way.

Note

A provider can run a template added by a consumer if the consumer grants permission.

Consumer template example¶

Here is a full code example showing how a consumer can submit and run a custom template. Upload the following workbook files into your Snowflake account. You need two separate accounts with the clean rooms API installed to run the code; one account to act as the provider and the other to act as the consumer.

Define a user input form for a custom template¶

For a custom template to be runnable in the clean rooms UI, the provider must define an input form for the template. This requirement applies even if the template has no arguments for the consumer to set. Consumers cannot define a user input form for a template.

Important

If you used provider.restrict_table_options_to_consumers or provider.restrict_template_options_to_consumers to restrict tables or templates to specific users, these restrictions won’t work as expected in the clean rooms UI. You should not enable templates for UI usage in clean rooms with these restrictions.

A configuration form enables users in the clean rooms UI to pass values to the custom template, similar to how you pass values to a template when using the API.

The following example shows a custom template that uses three variables, max_age, favorite_color, and source_table:

CALL samooha_by_snowflake_local_db.provider.add_custom_sql_template(
  $cleanroom_name,
  'color_picker_template',
  $$
  SELECT p.hashed_email
    FROM source_table[0] AS p
    WHERE
      p.age <= {{ max_age }} AND
      UPPER(p.favorite_color) = UPPER({{ favorite_color }});
  $$);
Copy

The following example shows how to pass in the template variables when you run the previous custom template in code:

CALL samooha_by_snowflake_local_db.consumer.run_analysis(
  $cleanroom_name,
  'color_picker_template',
  [],                                   -- Consumer tables, assigned to my_table array.
  ['MYDB.MYSCH.COLOR_PREFERENCES'],     -- Provider tables, assigned to source_table array.
  object_construct(
    'max_age', 30,                      -- Assign max_age.
    'favorite_color', 'blue'            -- Assign favorite_color.
  )
);
Copy

To run this template in the clean rooms UI, you must define a form where the consumer assigns these template variables. The following example shows how to define a simple form where the consumer can assign values to max_age, favorite_color, and source_table:

CALL samooha_by_snowflake_local_db.provider.add_ui_form_customizations(
    $cleanroom_name,
    'color_picker_template',
    {                                     -- Top-level template settings.
      'display_name': 'Color matcher',
      'description': 'See which users like the same color as you',
      'methodology': 'Choose a color and a max age',
      'render_table_dropdowns': {
        'render_consumer_table_dropdown': false,
        'render_provider_table_dropdown': true    -- Show a dropdown of provider tables.
      }                                           -- Chosen value is assigned to source_table.
    },
    { -- Form entry elements, one per template argument.
      'max_age': {
        'type': 'integer',
        'display_name': 'Maximum age',
        'description': 'Matching user must be less than or equal to this value.',
        'required': TRUE
      },
      'favorite_color': {
        'type': 'dropdown',
        'display_name': 'Favorite color',
        'description': 'Choose the favorite color to match.',
        'choices': ['Red', 'Blue', 'Green', 'Yellow'],
        'required': TRUE
      }
    },
    {} -- Output config not used in this example.
);

-- You must always call this procedure to propagate UI changes.
CALL samooha_by_snowflake_local_db.provider.create_or_update_cleanroom_listing(
  $cleanroom_name);
Copy

The previously defined form appears in the clean rooms UI when the consumer runs the template in the Configure Analysis & Query step. The form includes a table chooser for source_table, labeled Collaborator table, an integer chooser element for max_age labeled Maximum age, and a dropdown menu of color names for favorite_color labeled Favorite color, as shown in this image:

Rendered user input form with table, age, and color pickers.

You can also define drop-down menus that are pre-populated with columns from the provider’s or consumer’s join policies, column policies, tables, and more. For more information about form element types, see add_ui_form_customizations.

Populate source_table and my_table¶

The standard source_table and my_table template variables can be populated as follows:

  • Enable the default table selector drop-down menus: These drop-down menus are single-selection. You can show or hide them by using the render_provider_table_dropdown and render_consumer_table_dropdown settings. The drop-down menus pass fully qualified table names to the source_table and my_table template variables, respectively.

Qualify your column names¶

Most templates require all column names to be fully qualified to avoid column-name ambiguity.

The template must alias all tables as p or c, depending on whether they are provider or consumer tables. The template should reference all columns using their p or c aliases. Learn more about aliasing.

If you create a drop-down column selector, you must either supply the p or c table alias explicitly in a choices array of the drop-down menu, or you must add the alias in your template.

The following example shows how to provide the table alias in a drop-down menu:

  'provider_join_col': {
    'display_name': 'Provider Join Column',
    'choices': ['p.HASHED_EMAIL', 'p.HASHED_SSN'],
    'type': 'dropdown',
    'description': 'Select the provider column to join users on.',
    'infoMessage': 'We recommend using HASHED_EMAIL.',
    'size': 'M',
    'group': 'Enable Provider Features'
}
Copy

However, this method is limiting because you must know all the column names in advance.

As an alternative, you can dynamically populate a column drop-down menu by providing a references property. However, such a selector returns bare column names — for example, hashed_email — rather than fully-qualified column names — for example, p.hashed_email. If bare column names are returned, you must scope the column to the table explicitly in your template. For example, the following code creates a drop-down menu where a user can select a column from the provider’s join policy:

'p_join_col': {
  'type': 'dropdown',
  'references': ['PROVIDER_JOIN_POLICY']
}
Copy

To use the column name in a template, the template must hard-code the table alias in front of the column name as shown in the following example:

SELECT p.{{ p_join_col | sqlsafe }} FROM table_col AS p;
Copy

Recommendations for developing a template that can be run in the clean rooms UI¶

The following steps show a recommended workflow for developing a template that can be run in the clean rooms UI:

1. Develop the template¶

First develop your template and any scripts that it calls by using only the clean rooms API in both the provider and consumer accounts. Testing the template in the API is much faster and less error-prone than using the UI.

Test your template thoroughly in the API, both on the provider and consumer side, to ensure that the template does exactly what you want it to do. Testing in the API is very quick, and changes are propagated immediately to the consumer account.

After you test your template and it runs exactly as you want, then move on to designing the input form.

2. Develop the input form¶

When the template and any uploaded scripts are working as intended, then start working on the input form. At this stage, you use the API in the provider account, but the UI in the consumer account.

When you make changes using the API, some values in the UI are refreshed immediately, some are refreshed when the user clicks Refresh, and some are refreshed only every 10 minutes. Therefore, when you work on the input form, create and update the form on the provider side using the API, but install and configure the clean room in the consumer account using the clean rooms UI, not the API. This ensures that you are using fresh data in the clean room UI.

Additionally, each time that you make changes to the input form in the API, create a new clean room to ensure that you use the latest clean room data. Use an incrementing number in the name; for example, “My clean room 1,” “My clean room 2,” and so on. Then, install the clean room in the client by using the UI. Finally, delete the old clean rooms because there is a limit to the number of clean rooms an account can hold.

An input form must be attached to a template, otherwise the clean room and form won’t be runnable in the clean rooms UI. When you develop your form, consider using a template that simply mirrors back all the values that are selected in the form so that you can verify what values are sent to the template.

For example, let’s suppose that your production template looks like the following template:

SELECT {{ col1 | sqlsafe | column_policy }}, {{ col2 | sqlsafe | column_policy }}
  FROM IDENTIFIER({{ source_table[0] }}) AS p
  JOIN IDENTIFIER({{ my_table[0] }}) AS c
Copy

You could create the following template that mirrors back all the values of that production template:

SELECT
  {{ col1 | default('Undefined')}},
  {{ col2 | default('Undefined') }},
  {{ source_table[0] | default('Undefined') }},
  {{ my_table[0] | default('Undefined') }},
  {{ provider_join_col | default('Undefined') }},
  {{ consumer_join_col | default('Undefined') }}
;
Copy

Then design a form that sets those six variable values, and attach the form to the mirror template rather than the production template.

General tips for developing the input form

The following list provides detailed tips to help you develop an effective input form:

  • If you encounter a generic “Installation failed” or “Something went wrong” message when you install, configure, or run a clean room in the UI, the message could mean that there is an error with the UI form or associated template that was not caught when you added the form or template.

  • When one field depends on another field — for example, a column drop-down menu that is based on the value chosen by a table drop-down menu — put the parent field first, possibly right above the child field, so that users populate the parent field before they populate the child field. With dependent fields, the child drop-down menu is empty until a value is chosen for the parent field.

  • If you don’t specify an order or group value, items are rendered in the order that they are defined.

  • Include informative infoMessage and description text, and show example values that a user might enter.

  • Choose the precise element type for the variable data type. For example, for an integer, choose integer rather than a free-form text box. Your template can cast values by using Jinja filters; for example: SELECT {{ max_age | int }};.

  • If you don’t define a minimal configuration form for a custom template, the template can’t be run in the clean rooms UI.

  • If you don’t define a form element for a variable in the template, a plain text box is rendered for that variable in the user form. This is probably not what you want, because the text box is labeled with the template variable name and has no description or suggestions.

  • Form elements specified in add_ui_form_customizations aren’t rendered unless there is a matching template variable with the same name as the element.

  • Template changes made in the API propagate quickly and reliably to the UI, so you don’t need to create a new clean room for template changes. However, you should develop and test your template in the API :emph: before you reach the UI stage.

  • You can’t auto-populate a drop-down menu with column values from a given table. You can hard-code values in a drop-down menu, but can’t show values from a table at runtime.

3. Connect the input form to the production template¶

After the form looks exactly like you want it and the form makes all template variables accessible by the user, then assign your working template to the input form in your call to provider.add_ui_form_customizations.

Language: English