Snowflake Data Clean Rooms: Anbieter-API-Referenzhandbuch¶
Auf dieser Seite werden die Prozeduren beschrieben, die die Verbraucher in der Clean Room API zur Verwaltung ihrer Clean Rooms verwenden. Anweisungen zur Einrichtung der Codierung finden Sie unter Codierung einrichten.
Reinräume erstellen, konfigurieren und löschen¶
view_cleanrooms¶
- Schema:
PROVIDER
Beschreibung: Listet alle vorhandenen Reinräume auf, die von diesem Anbieterkonto erstellt wurden.
Argumente: Keine
Rückgabe: (Tabelle) Eine Liste der von diesem Anbieterkonto erstellten Reinräume. Reinräume müssen nicht für Verbraucher freigegeben, installiert oder von ihnen genutzt werden. Gelöschte Reinräume werden aus der Datenbank gelöscht und werden nicht in dieser Liste angezeigt.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.view_cleanrooms();
describe_cleanroom¶
- Schema:
PROVIDER
Beschreibung: Erhalten Sie eine Zusammenfassung von Informationen über einen Reinraum, wie z. B. Vorlagen, Join-Richtlinien, Spaltenrichtlinien und Verbraucher.
Argumente:
cleanroom_name (string) – Name des Reinraums, über den Sie Informationen erhalten möchten.
Rückgabe: (string) Eine Zusammenfassung der Metadaten des Reinraums.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.describe_cleanroom($cleanroom_name);
cleanroom_init¶
- Schema:
PROVIDER
Beschreibung: Erzeugt einen Clean Room mit dem angegebenen Namen in Ihrem Konto. Diese Prozedur kann eine Minute oder mehr in Anspruch nehmen. Der Clean Room wird erst nach dem Aufruf von create_or_update_cleanroom_listing
in der Clean Rooms-UI oder für Teilnehmer sichtbar.
Argumente:
cleanroom_name (string) – Name des Reinraums, maximal 80 Zeichen. Der Name enthält [A‑Z,a‑z,0‑9, ,_].
distribution (Zeichenfolge, Optional) – Einer der folgenden Werte:
INTERNAL (Default): Der Clean Room ist nur für Benutzer in derselben Organisation sichtbar und löst vor Änderung der Standardversion keinen Sicherheitsscan aus.
EXTERNAL – Der Reinraum ist produktionsbereit und kann auch außerhalb des Unternehmens genutzt werden. Der Clean Room löst einen Sicherheitsscan vor Änderung der Standardversion aus. Wenn Sie die Verteilung ändern möchten, nachdem ein Clean Room erstellt wurde, rufen Sie
ALTERPACKAGE
wie hier gezeigt auf:ALTER APPLICATION PACKAGE samooha_cleanroom_<CLEANROOM_ID> SET DISTRIBUTION = EXTERNAL;
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
-- Create an internal clean room
CALL samooha_by_snowflake_local_db.provider.cleanroom_init($cleanroom_name, 'INTERNAL');
set_default_release_directive¶
- Schema:
PROVIDER
Beschreibung: Gibt die Version und den Patch eines Clean Rooms an, die von Teilnehmern geladen werden, wenn sie eine neue Browsersitzung in der Clean Room-UI starten oder von der API aus auf den Clean Room zugreifen. Diese muss aufgerufen werden, bevor der Reinraum mit den Verbrauchern geteilt werden kann.
Die Reinraum-Anwendung erstellt eine neue Version eines Reinraums, wenn Sie Python-Code hochladen oder ändern. Wenn Sie möchten, dass den Benutzern die neueste Version zur Verfügung gestellt wird, rufen Sie diese Prozedur mit der neuen Versionsnummer auf. Um die verfügbaren Versionen anzuzeigen und die aktuelle Standardversion zu erfahren, führen Sie aus:
Wenn Sie die Nummer des neuesten Patches vergessen haben, können Sie den folgenden Code ausführen, um zu sehen, welche Versionen verfügbar sind (wahrscheinlich möchten Sie die neueste Version als Standard verwenden):
SHOW VERSIONS IN APPLICATION PACKAGE SAMOOHA_CLEANROOM_<cleanroom_name>
Dabei folgt <cleanroom_name>
diesem Format.
Alle Reinräume werden mit den folgenden Versions- und Patchnummern erstellt:
Version: V1_0
Patch: 0
Bemerkung
Wenn die Reinraumverteilung auf EXTERNAL eingestellt ist, kann diese Prozedur erst aufgerufen werden, nachdem der Reinraum-Sicherheitsscan in den Zustand APPROVED übergegangen ist. Um den Sicherheitsstatus anzuzeigen, rufen Sie view_cleanrooom_scan_status
auf.
Argumente:
cleanroom_name (string) – Name des Reinraums.
version (string) – Version. Muss immer „V1_0“ sein.
patch (string) – Vom Verbraucher geladene Patch-Nummer. Dieser Wert beginnt bei 0, und Sie sollten ihn erhöhen, sobald eine neue Reinraumversion verfügbar ist. Sie können die verfügbaren Versionen wie oben beschrieben anzeigen.
Rückgabe: (Zeichenfolge) Erfolgsmeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.set_default_release_directive($cleanroom_name, 'V1_0', '0');
drop_cleanroom¶
- Schema:
PROVIDER
Beschreibung: Löschen des Clean Rooms. Teilnehmer, die den Reinraum installiert haben, können ihn nicht mehr betreten oder nutzen. Der Clean Room erscheint nicht mehr in der Clean Rooms-UI, wenn der Browser das nächste Mal aktualisiert wird.
Argumente:
cleanroom_name (string) – Name des zu löschenden Reinraums.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.drop_cleanroom($cleanroom_name);
enable_consumer_run_analysis¶
- Schema:
PROVIDER
Beschreibung: Ermöglicht es dem Verbraucher, Analysen im Reinraum durchzuführen. Diese Funktion ist in allen neuen Reinräumen standardmäßig aktiviert, sodass diese Prozedur nur ausgeführt werden muss, wenn Sie die Verbraucheranalyse für einen Reinraum ausdrücklich deaktiviert haben.
Argumente:
cleanroom_name (string) – Name des Reinraums, in dem Verbraucheranalysen erlaubt sind.
consumer_accounts (Array aus Zeichenfolgen) – Die Konto-Locator aller Verbraucher, für die dieses Feature aktiviert werden soll. NOTE: Diese Verbraucher müssen bereits zum Clean Room hinzugefügt worden sein.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.enable_consumer_run_analysis($cleanroom_name, ['<CONSUMER_ACCOUNT_LOCATOR_1>']);
disable_consumer_run_analysis¶
- Schema:
PROVIDER
Beschreibung: Verhindert, dass die angegebenen Verbraucher in dem angegebenen Reinraum Analysen durchführen können. Standardmäßig dürfen alle Verbraucher eine Analyse in einem Reinraum durchführen.
Argumente:
cleanroom_name (string) – Reinraum, in dem die Verbraucheranalyse deaktiviert ist.
consumer_accounts (Array aus Zeichenfolgen) – Konto-Locator von Verbrauchern, die in diesem Reinraum keine Analyse durchführen können. NOTE: Diese Verbraucher müssen dem Reinraum bereits hinzugefügt worden sein.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.disable_consumer_run_analysis($cleanroom_name, ['<CONSUMER_ACCOUNT_LOCATOR_1>']);
is_consumer_run_enabled¶
- Schema:
LIBRARY
Beschreibung: Prüft, ob in diesem Reinraum vom Verbraucher ausgeführte Analysen zugelassen sind.
Argumente:
cleanroom_name (string) – Name des zu prüfenden Reinraums.
Rückgabe: (string) Ob in diesem Reinraum Verbraucheranalysen zugelassen sind oder nicht.
Beispiel:
CALL samooha_by_snowflake_local_db.library.is_consumer_run_enabled($cleanroom_name)
create_or_update_cleanroom_listing¶
- Schema:
PROVIDER
Beschreibung: Publiziert einen neuen Reinraum oder aktualisiert einen bestehenden Reinraum. Sie sollten diese Methode immer dann aufrufen, wenn Sie Änderungen an einem Reinraum vornehmen, um sicherzustellen, dass die Änderungen an die Verbraucher weitergegeben werden.
Wenn Sie einen Clean Room zum ersten Mal veröffentlichen, kann es bis zu 15 Minuten dauern, bis der Clean Room in der Clean Rooms-UI angezeigt wird.
Wenn Sie Aktualisierungen an einem Clean Room vornehmen, ohne diese Methode anschließend aufzurufen, gibt es keine Garantie, dass die Änderungen an die Verbraucher weitergegeben werden.
Die Anzahl der Clean Rooms+-Teilnehmer, die Sie über ein einzelnes Konto erstellen können, ist begrenzt. Wenn Sie zu viele Test-Clean Rooms erstellen, müssen Sie möglicherweise einige löschen, um neue Clean Rooms zu erstellen. Wenn Sie mehr Clean Rooms benötigen, als Ihr Konto aufnehmen kann, wenden Sie sich an den Snowflake-Support.
Bemerkung
Sie müssen die Freigaberichtlinie mindestens einmal festlegen, bevor Sie diese Prozedur aufrufen. Weitere Informationen finden Sie unter provider.set_default_release_directive.
Argumente:
cleanroom_name (string) – Name des zu veröffentlichenden oder zu aktualisierenden Reinraums.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Fehlerbehandlung:
Wenn Sie die Fehlermeldung erhalten, dass die Cloud-übergreifende automatische Ausführung für dieses Konto nicht aktiviert ist, bedeutet dies, dass sich einer der Verbraucher in einer anderen Cloud-Hosting-Region befindet. Sie müssen die Cloud-übergreifende automatische Ausführung aktivieren, wie unter Cloud-übergreifende automatische Ausführung in Snowflake Data Clean Rooms verwalten beschrieben.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.create_or_update_cleanroom_listing($cleanroom_name);
Daten registrieren und abmelden¶
Verwenden Sie den folgenden Befehl, um Datenbanken, Schemas und Objekte zu registrieren und die Registrierung aufzuheben. Tabellen und Ansichten müssen registriert werden, bevor sie mit dem Reinraum verknüpft werden können. Wenn Sie eine Datenbank oder ein Schema registrieren, werden alle Objekte in dieser Datenbank oder diesem Schema registriert.
Erfahren Sie mehr über die Registrierung von Daten
register_db¶
- Schema:
PROVIDER
Beschreibung: Ermöglicht die Verknüpfung einer Datenbank und aller darin enthaltenen Objekte mit einzelnen Clean Rooms in dieser Clean Room-Umgebung. Diese Prozedur gewährt USAGE SELECT- und SAMOOHA_APP_ROLE-Berechtigungen auf der Datenbank, die von der Clean Room-Umgebung für den Datenzugriff verwendet wird.
Sie müssen über MANAGE GRANTS Zugriff auf die Datenbank haben, um diese Prozedur aufrufen zu können. Andere Anbieter in dieser Reinraumumgebung können diese Objekte dann in ihre eigenen Reinräume einbinden, ohne eine eigene SELECT-Berechtigung zu benötigen.
Erfahren Sie mehr über die Registrierung von Daten
Wichtig
Diese Prozedur registriert keine Objekte, die nach dem Aufruf der Prozedur erstellt wurden. Wenn der Datenbank neue Objekte hinzugefügt wurden und Sie diese ebenfalls registrieren möchten, müssen Sie diese Prozedur erneut aufrufen.
Argumente:
db_name (string) – Name der zu registrierenden Datenbank.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
USE ROLE <ROLE_WITH_MANAGE_GRANTS>;
CALL samooha_by_snowflake_local_db.provider.register_db('SAMOOHA_SAMPLE_DATABASE');
register_schema¶
- Schema:
LIBRARY
Beschreibung: Ähnlich wie register_db
, arbeitet aber auf Schema-Ebene. Sie müssen über die Berechtigung MANAGE GRANTS für das Schema verfügen, um diese Prozedur aufrufen zu können.
Diese Prozedur gewährt USAGE SELECT- und SAMOOHA_APP_ROLE-Berechtigungen für das Schema, das von der Clean Room-Umgebung für den Zugriff auf Daten verwendet wird.
Wenn Sie ein verwaltetes Zugriffsschema registrieren möchten (d. h. ein Schema, das mit dem Parameter WITH MANAGED ACCESS erstellt wurde), verwenden Sie stattdessen library.register_managed_access_schema
.
Wichtig
Diese Prozedur registriert keine Objekte, die nach dem Aufruf der Prozedur erstellt wurden. Wenn der Datenbank neue Objekte hinzugefügt wurden und Sie diese ebenfalls registrieren möchten, müssen Sie diese Prozedur erneut aufrufen.
Argumente:
schema_name (Array aus Zeichenfolgen) – Ein Array mit einem oder mehreren vollständig qualifizierten Schemanamen, die registriert werden sollen.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
USE ROLE <ROLE_WITH_MANAGE GRANTS>;
CALL samooha_by_snowflake_local_db.library.register_schema(['SAMOOHA_SAMPLE_DATABASE.DEMO']);
register_managed_access_schema¶
- Schema:
LIBRARY
Beschreibung: Ähnlich wie register_schema
, registriert jedoch ein Schema, das mit dem Parameter WITH MANAGED ACCESS erstellt wurde. Sie müssen über die Berechtigungen MANAGE GRANTS für das Schema verfügen, um diese Prozedur aufrufen zu können.
Diese Prozedur gewährt SAMOOHA_APP_ROLE die Berechtigung zur Nutzung des verwalteten Schemas, das von der Reinraumumgebung für den Datenzugriff verwendet wird.
Wichtig
Diese Prozedur registriert keine Objekte, die nach dem Aufruf der Prozedur erstellt wurden. Wenn der Datenbank neue Objekte hinzugefügt wurden und Sie diese ebenfalls registrieren möchten, müssen Sie diese Prozedur erneut aufrufen.
Argumente:
schema_name (Array aus Zeichenfolgen) – Ein Array mit einem oder mehreren vollständig qualifizierten Schemanamen.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
USE ROLE <ROLE_WITH_MANAGE GRANTS>;
CALL samooha_by_snowflake_local_db.library.register_managed_access_schema(['SAMOOHA_SAMPLE_DATABASE.DEMO']);
register_objects¶
- Schema:
LIBRARY
Beschreibung: Ermöglicht dem Reinraum den Zugriff auf Tabellen und Ansichten aller Arten, sodass sie durch den Aufruf von provider.link_datasets
für die Verknüpfung mit dem Reinraum verfügbar sind. Sie können breitere Gruppen von Objekten registrieren, indem Sie library.register_schema
, library.register_managed_access_schema
oder provider.register_db
aufrufen.
Diese Prozedur gewährt SAMOOHA_APP_ROLE die Berechtigung zur Nutzung des Objekts, das von der Reinraumumgebung für den Zugriff auf Daten verwendet wird.
Sie müssen über die Berechtigung MANAGE GRANTS für das Objekt verfügen, um diese Prozedur aufzurufen. Diese Prozedur kann nicht zur Registrierung einer Datenbank verwendet werden.
Wenn Sie eine Ansicht registrieren, die auf einem Objekt in einer anderen Datenbank basiert, müssen Sie auch der systemeigenen Anwendung die Berechtigung zum Zugriff auf das Quellobjekt erteilen.
Argumente:
object_names (array) – Array mit vollständig qualifizierten Objektnamen. Diese Objekte können dann mit dem Reinraum verknüpft werden.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiele
So registrieren Sie eine Tabelle und eine Ansicht:
USE ROLE <ROLE_WITH_MANAGE GRANTS>;
CALL samooha_by_snowflake_local_db.library.register_objects(
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS',
'SAMOOHA_SAMPLE_DATABASE.INFORMATION_SCHEMA.FIELDS'
]
);
enable_external_tables_on_account¶
- Schema:
LIBRARY
Beschreibung: Aktivieren Sie die Verwendung von Iceberg- oder externen Tabellen in allen Clean Rooms in diesem Konto. Muss von einem ACCOUNTADMIN in sowohl dem Anbieter- als auch dem Verbraucherkonto aufgerufen werden, damit Iceberg- oder externe Tabellen über eines der beiden Konten verknüpft werden können. Um diese Fähigkeit auf bestimmte Clean Rooms in diesem Konto zu beschränken, rufen Sie stattdessen enable_external_tables_for_cleanroom
auf.
Wenn erfolgreich und alle Sicherheitsscans bestanden wurden, wird eine neue Patchversion des Clean Rooms generiert.
Argumente: Keine
Rückgabe: (string) Erfolgs- oder Fehlermeldung. Bei Erfolg wird ein Sicherheitsscan ausgelöst und die Nummer des Patches angegeben, der bei einem erfolgreichen Sicherheitsscan generiert wird.
Beispiel:
USE ROLE ACCOUNTADMIN;
CALL samooha_by_snowflake_local_db.library.enable_external_tables_on_account();
enable_external_tables_for_cleanroom¶
- Schema:
PROVIDER
Beschreibung: Ermöglicht die Verknüpfung von Iceberg- oder externen Tabellen mit dem angegebenen Clean Room in diesem Konto durch den Anbieter. Um Iceberg- und externe Tabellen für alle Clean Rooms in diesem Konto zuzulassen, rufen Sie stattdessen enable_external_tables_on_account
auf.
Wenn dies erfolgreich ist, wird eine neue Patch-Version des Clean Room erstellt.
Argumente:
cleanroom_name (string) - Der Name des Clean Room, mit dem der Anbieter Iceberg- oder externe Tabellen verknüpfen kann.
Rückgabe: (string) Erfolgs- oder Fehlermeldung. Bei Erfolg wird ein Sicherheitsscan ausgelöst und die Nummer des Patches angegeben, der bei einem erfolgreichen Sicherheitsscan generiert wird.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.enable_external_tables_for_cleanroom(
$cleanroom_name);
unregister_db¶
- Schema:
LIBRARY
Beschreibung: Macht die Prozedur register_db
rückgängig und entfernt die Berechtigungen auf Datenbankebene, die der Rolle SAMOOHA_APP_ROLE und der nativen Snowflake Data Clean Room-Anwendung gewährt wurden. Dadurch wird auch jede Datenbank aus dem Selektor in der Clean Rooms-UI entfernt.
Argumente:
db_name (string) – Name der Datenbank, deren Registrierung aufgehoben werden soll.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
USE ROLE <ROLE_WITH_MANAGE GRANTS>;
CALL samooha_by_snowflake_local_db.library.unregister_db('SAMOOHA_SAMPLE_DATABASE');
unregister_schema¶
- Schema:
LIBRARY
Beschreibung: Hebt die Registrierung eines Schemas auf, wodurch Benutzer daran gehindert werden, dessen Tabellen und Ansichten mit dem Reinraum zu verknüpfen.
Wenn Sie die Registrierung eines verwalteten Zugriffsschemas (d. h. eines Schemas, das mit dem Parameter WITH MANAGED ACCESS erstellt wurde) aufheben möchten, verwenden Sie stattdessen library.unregister_managed_access_schema
.
Argumente:
schema_name (array) – Schemas, deren Registrierung aufgehoben werden soll.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
USE ROLE <ROLE_WITH_MANAGE GRANTS>;
CALL samooha_by_snowflake_local_db.library.unregister_schema(['SAMOOHA_SAMPLE_DATABASE.DEMO']);
unregister_managed_access_schema¶
- Schema:
LIBRARY
Beschreibung: Ähnlich wie unregister_schema
, hebt jedoch die Registrierung eines Schemas auf, das mit dem Parameter WITH MANAGED ACCESS erstellt wurde.
Argumente:
schema_name (array) – Verwaltete Schemas, die nicht mehr registriert werden sollen.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
USE ROLE <ROLE_WITH_MANAGE GRANTS>;
CALL samooha_by_snowflake_local_db.library.unregister_managed_access_schema(['SAMOOHA_SAMPLE_DATABASE.DEMO']);
unregister_objects¶
- Schema:
LIBRARY
Beschreibung: Widerruft den Reinraum-Zugriff auf Tabellen und Ansichten aller Art. Die Objekte sind für Benutzer in allen von diesem Konto verwalteten Reinräumen nicht mehr verfügbar.
Argumente:
object_names (array) – Array der vollqualifizierten Objektnamen, für die der Zugriff widerrufen werden soll.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiele
So heben Sie die Registrierung einer Tabelle und einer Ansicht auf:
USE ROLE <ROLE_WITH_MANAGE GRANTS>;
CALL samooha_by_snowflake_local_db.library.unregister_objects(
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS',
'SAMOOHA_SAMPLE_DATABASE.INFORMATION_SCHEMA.FIELDS'
]
);
Daten und Tabellen verknüpfen¶
Verwenden Sie die folgenden Befehle, um Tabellen und Ansichten in einem Reinraum hinzuzufügen oder zu entfernen.
link_datasets¶
- Schema:
PROVIDER
Beschreibung: Verknüpft eine Snowflake-Tabelle oder -Ansicht im Clean Room. Die Prozedur macht die Tabelle automatisch für den Reinraum zugänglich, indem es eine sichere Ansicht der Tabelle im Reinraum erstellt. Die Tabelle ist immer noch mit ihrer Quelle verknüpft, sodass Aktualisierungen in der Quelle in der sicheren Version im Clean Room wiedergegeben werden.
Alle hier verknüpften Elemente müssen zuerst registriert werden, und zwar auf Datenbank-, Schema- oder Objektebene.
Argumente:
cleanroom_name (string) – Name des Reinraums mit Zugriff auf die Objekte.
tables_list (Array aus Zeichenfolgen) – Liste der Tabellen oder Ansichten, die mit dem Reinraum verknüpft werden sollen. Objekte müssen registriert werden, bevor sie verknüpft werden können.
consumer_list (Array aus Zeichenfolgen, Optional) – Wenn vorhanden, können nur die hier aufgeführten Verbraucher auf diese Objekte zugreifen. Falls nicht vorhanden, kann jeder, der Zugang zum Reinraum hat, auf diese Daten zugreifen.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.link_datasets(
$cleanroom_name,
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS',
'MYDB.MYSCH.EXPOSURES'
]
);
Bemerkung
Wenn Sie eine Ansicht mit dem Clean Room verknüpfen und die Ansicht auf einer Tabelle in einer anderen Datenbank basiert, müssen Sie sowohl die Ansicht als auch die Quelle der Ansicht registrieren.
unlink_datasets¶
- Schema:
PROVIDER
Beschreibung: Entfernt den Zugriff auf die angegebenen Tabellen im angegebenen Reinraum für alle Benutzer. Die angegebenen Tabellen müssen vom Anbieter verknüpft worden sein.
Argumente:
cleanroom_name (string) – Name des mit diesen Datensätzen verknüpften Reinraums.
tables_list (array) – Array aus Namen von Tabellen oder Ansichten, die aus dem Reinraum entkoppelt werden sollen.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.unlink_datasets(
$cleanroom_name,
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS',
'MYDB.MYSCH.EXPOSURES'
]
);
view_provider_datasets¶
- Schema:
PROVIDER
Beschreibung: Zeigen Sie alle Tabellen und Ansichten an, die von einem beliebigen Anbieter in diesem Konto mit dem angegebenen Reinraum verknüpft sind.
Argumente:
cleanroom_name (string) – Der Name des Reinraums.
Rückgabe: Tabelle der Objekte, die mit dem angegebenen Reinraum verknüpft sind, zusammen mit dem Namen der internen Ansicht des Reinraums für jedes Objekt.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.view_provider_datasets($cleanroom_name);
restrict_table_options_to_consumers¶
- Schema:
PROVIDER
Beschreibung: Steuert, ob ein bestimmter Verbraucher auf eine Tabelle im Reinraum zugreifen kann. Diese Prozedur ist nur ersetzen, d. h. sie überschreibt vollständig alle Werte, die in einem früheren Aufruf gesetzt wurden.
Verbraucher, denen der Zugriff über provider.link_datasets
, provider.restrict_table_options_to_consumers
oder eine andere Methode gewährt wurde, verlieren den Zugriff auf eine Tabelle, wenn diese beim Aufruf dieser Methode nicht angegeben wird.
Bemerkung
Einschränkungen, die Sie durch den Aufruf dieser Prozedur erstellen, verhalten sich in der Clean Rooms-UI möglicherweise nicht wie erwartet. Sie sollten diese Prozedur nicht für einen Clean Room aufrufen, der in der Clean Rooms-UI verwendet werden kann.
Argumente:
cleanroom_name (string) - Name des zu beschränkenden Clean Room.
*access_details (Objekt) - Ein JSON-Objekt, bei dem jeder Feldname der vollständig qualifizierte Name einer Tabelle oder Ansicht ist und der Feldwert ein Array von Konto-Locators von Benutzern ist, die auf diese Tabelle oder Ansicht zugreifen können.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.restrict_table_options_to_consumers(
$cleanroom_name,
{
'DB.SCHEMA.TABLE1': ['CONSUMER_1_LOCATOR'],
'DB.SCHEMA.TABLE2': ['CONSUMER_1_LOCATOR', 'CONSUMER_2_LOCATOR']
}
);
Richtlinien verwalten¶
Verknüpfungsrichtlinien in Data Clean Rooms sind nicht dasselbe wie Snowflake-weite Verknüpfungsrichtlinien. Verknüpfungsrichtlinien für Clean Rooms werden nur mit dieser Prozedur festgelegt; Verknüpfungsrichtlinien, die für Tabellen außerhalb von Clean Rooms festgelegt wurden, werden von Clean Rooms ignoriert.
Mehr über Tabellenrichtlinien in Clean Rooms.
view_join_policy¶
- Schema:
PROVIDER
Beschreibung: Zeigt die Verknüpfungsrichtlinien an, die derzeit auf den Reinraum angewendet werden.
Argumente:
cleanroom_name (string) – Name des abzufragenden Reinraums.
Rückgabe: (Tabelle) Liste der verknüpfbaren Zeilen in allen Tabellen oder Ansichten im Reinraum.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.view_join_policy($cleanroom_name);
set_join_policy¶
- Schema:
PROVIDER
Beschreibung: Legt fest, auf welche Spalten der Verbraucher zugreifen kann, wenn er Vorlagen in diesem Reinraum ausführt. Beachten Sie, dass die Richtlinie nur ersetzen ist. Wenn die Prozedur also erneut aufgerufen wird, wird die zuvor festgelegte Verknüpfungsrichtlinie vollständig durch die neue ersetzt.
Wichtig
Verknüpfungsrichtlinien werden nur durchgesetzt, wenn die Vorlage die Filter join_policy
oder join_and_column_policy
JinjaSQL auf die zu verknüpfenden Zeilen anwendet.
Bemerkung
Verknüpfungsrichtlinien in Daten-Clean-Rooms sind nicht dasselbe wie Snowflake-weite Verknüpfungsrichtlinien. Verknüpfungsrichtlinien für Reinräume werden nur mit dieser Prozedur festgelegt; Verknüpfungsrichtlinien, die für Tabellen außerhalb von Reinräumen festgelegt wurden, werden von Reinräumen ignoriert.
Argumente:
cleanroom_name (string) – Name des Reinraums, in dem die Verknüpfungsrichtlinie durchgesetzt werden soll.
table_and_col_names (Array aus Zeichenfolgen) – Vollständig qualifizierter Spaltenname im Format
database_name.schema_name.table_or_view_name:column_name
. Beachten Sie die korrekte Verwendung von . versus : marks
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.set_join_policy(
$cleanroom_name,
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:HASHED_EMAIL',
'MYDB.MYSCH.EXPOSURES:HASHED_EMAIL'
]
);
Anbietervorlagen verwalten¶
Verwenden Sie die folgenden Befehle, um die Vorlagen/Analysen hinzuzufügen, die in diesem Reinraum unterstützt werden.
view_added_templates¶
- Schema:
PROVIDER
Beschreibung: Zeigt die vom Anbieter hinzugefügten Vorlagen im Reinraum an. Es gibt keine Methode, um alle Vorlagen in allen Reinräumen für diesen Anbieter aufzulisten.
Argumente:
cleanroom_name (string) – Der abzufragende Reinraum.
Rückgabe: (Tabelle) – Liste der im angegebenen Reinraum verfügbaren Vorlagen mit Details zu jeder Vorlage.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.view_added_templates($cleanroom_name);
view_template_definition¶
- Schema:
PROVIDER
Beschreibung: Zeigt Informationen über eine bestimmte Vorlage an. Verbraucher, die sich eine Anbietervorlage ansehen, sollten consumer.view_template_definition
verwenden.
Argumente:
cleanroom_name (string) – Name des Reinraums mit dieser Vorlage.
template_name (string) – Name der Vorlage, über die Sie Informationen anfragen möchten.
Rückgabe: Die Definition der Vorlage (string)
Beispiel:
CALL samooha_by_snowflake_local_db.provider.view_template_definition(
$cleanroom_name,
$template_name);
add_templates¶
- Schema:
PROVIDER
Beschreibung: Fügt dem Reinraum eine Liste von Vorlagen hinzu. Die vorhandene Vorlagenliste wird dadurch nicht ersetzt.
Argumente:
cleanroom_name (string) – Name des Reinraums, dem Vorlagen hinzugefügt werden sollen.
template_names (Array of string): Name der Vorlagen, die hinzugefügt werden sollen. Dies sind nur von Snowflake zur Verfügung gestellte Vorlagen. Um eine benutzerdefinierte Vorlage hinzuzufügen, rufen Sie
add_custom_sql_template
auf.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.add_templates(
$cleanroom_name,
['my_custom_template']);
clear_template¶
- Schema:
PROVIDER
Beschreibung: Entfernt eine angegebene Vorlage aus dem Reinraum.
Argumente:
cleanroom_name (string) – Der Name des Reinraums.
template_name (string) – Name der Vorlage, die aus diesem Reinraum entfernt werden soll.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.clear_template(
$cleanroom_name,
'prod_custom_template');
clear_all_templates¶
- Schema:
PROVIDER
Beschreibung: Entfernt alle Vorlagen, die dem Reinraum hinzugefügt wurden.
Argumente:
cleanroom_name (string) – Name des Reinraums, aus dem alle Vorlagen entfernt werden sollen.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.clear_all_templates($cleanroom_name);
set_column_policy¶
- Schema:
PROVIDER
Beschreibung: Legt fest, welche Spalten in den Daten für eine bestimmte Vorlage im Reinraum als nicht zu verknüpfende Zeilen verfügbar sind. Die Spalten müssen entweder hier oder in set_join_policy
deklariert werden, um im Reinraum verwendet werden zu können. Die hier aufgeführten Spalten können überall in der Vorlage verwendet werden, außer als Verknüpfungsspalte. Eine Spalte kann nicht sowohl in einer Spaltenrichtlinie als auch in einer Verknüpfungsrichtlinie aufgeführt sein.
Standardmäßig ist die Spaltenrichtlinie für eine Tabelle leer, was bedeutet, dass keine Spalten in den Ergebnissen angezeigt werden.
Diese Prozedur ist die Verhaltensweise vollständig ersetzen, sodass sie bei jedem Aufruf die vorherige Spaltenliste vollständig überschreibt.
Beachten Sie, dass die Überprüfung der Spaltenrichtlinie durchgeführt wird, indem die SQL-Abfrage, die gegen die Daten ausgeführt werden soll, auf nicht zugelassene Spalten analysiert wird. Abfragen mit Platzhaltern werden von diesen Prüfungen möglicherweise nicht erfasst, sodass Sie bei der Gestaltung der Analysevorlage bedacht vorgehen sollten. Wenn einige Spalten wirklich nie abgefragt werden sollen, sollten Sie eine Ansicht Ihrer Quelltabelle erstellen, die diese sensiblen Spalten eliminiert, und stattdessen eine Verknüpfung in dieser Ansicht erstellen.
Argumente:
cleanroom_name (string) – Der Name des Reinraums.
analysis_and_table_and_cols(Array aus Zeichenfolgen) – Array von Spalten, die von Vorlagen verwendet werden können. Das Format ist:
template_name:full_table_name:column_name
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.set_column_policy($cleanroom_name,
['prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:STATUS',
'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:AGE_BAND',
'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:DAYS_ACTIVE']);
-- Same example, but using a variable name for the template.
CALL samooha_by_snowflake_local_db.provider.set_column_policy($cleanroom_name,
[$template_name || ':SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:STATUS',
$template_name || ':SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:AGE_BAND',
$template_name || ':SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:DAYS_ACTIVE']);
view_column_policy¶
- Schema:
PROVIDER
Beschreibung: Listet die derzeit im Reinraum aktiven Spaltenrichtlinien auf. Eine Spaltenrichtlinie legt fest, welche Tabellenspalten in welchen Vorlagen angezeigt werden können.
**Argumente:**cleanroom_name (string)
Rückgabe: (Tabelle) Welche Spalten in welchen Vorlagen verwendet werden können.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.view_column_policy($cleanroom_name);
add_custom_sql_template¶
- Schema:
PROVIDER
Beschreibung: Fügt eine benutzerdefinierte JinjaSQL-Vorlage in den Reinraum ein. Dadurch wird die Vorlage für den Verbraucher aufrufbar. Erfahren Sie, wie Sie benutzerdefinierte Vorlagen erstellen.
Sie können diese API mehrmals aufrufen, um dem Reinraum mehrere benutzerdefinierte Vorlagen hinzuzufügen. Die Prozedur überschreibt alle vorherigen Vorlagen mit demselben Namen in diesem Reinraum.
Wenn die Vorlage vom Benutzer verwendet wird, um Ergebnisse beim Anbieter zu aktivieren, muss der Befehl die folgenden Anforderungen erfüllen:
Der Name der benutzerdefinierten Vorlage muss mit der Zeichenfolge
activation
beginnen. Zum Beispiel:activation_custom_template
.Die Vorlage muss eine Tabelle erstellen, die mit
cleanroom.activation_data_
beginnt. Zum Beispiel:CREATE TABLE cleanroom.activation_data_analysis_results AS ...
.Die Vorlage muss den eindeutigen Teil des Tabellennamens zurückgeben, der in der Definition erstellt wurde, d. h. die Zeichenfolge, die an
cleanroom.activation_data_
angehängt ist. Zum Beispiel:return 'data_analysis_results'
.
Argumente:
cleanroom_name (string) – Name des Reinraums, auf den diese Vorlage angewendet wird.
template_name (string) – Name der Vorlage. Müssen alle Kleinbuchstaben, Zahlen, Leerzeichen oder Unterstriche sein. Aktivierungsvorlagen müssen einen Namen haben, der mit „Aktivierung“ beginnt.-
template (string) – Die JinjaSQL Vorlage.
sensitivity (Float, Optional) - Wenn die differentielle Privatsphäre für diesen Clean Room aktiviert ist, steuert sie die Stärke des differentiellen Datenschutzrauschens, das auf die von dieser Vorlage zurückgegebenen Daten angewendet wird. Muss eine Zahl größer als 0 sein. Der Standardwert ist 1,0. Die Aufgabe der differentiellen Privatsphäre muss in diesem Clean Room ausgeführt werden, damit dieses Argument eine Wirkung hat.
consumer_locators (Array aus Zeichenfolgen, Optional) - Ein Array mit einem oder mehreren Konto-Locators. Falls vorhanden, wird diese Vorlage nur für diese Konten in den Reinraum aufgenommen. Sie können diese Liste später ändern, indem Sie
provider.restrict_template_options_to_consumers
aufrufen. Wenn Sie keine Liste von Verbrauchern angeben, können alle Verbraucher die benutzerdefinierte Vorlage in dem angegebenen Reinraum verwenden.is_obfuscated (boolesch, optional) - Wenn TRUE, wird verhindert, dass Verbraucher den Vorlagen-Body sehen können. Beachten Sie, dass Sie die Snowflake Enterprise Edition oder höher verwenden müssen, um eine verschleierte Vorlage auszuführen. Wenn diese Vorlage für eine vom Anbieter durchgeführte Analyse verwendet wird, muss der Verbraucher die Analyseanfrage jedes Mal neu genehmigen, wenn Sie den Status
is_obfuscated
ändern.is_obfuscated
kann nicht zusammen mitsensitivity
verwendet werden.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.add_custom_sql_template(
$cleanroom_name, 'prod_custom_template',
$$
SELECT
identifier({{ dimensions[0] | column_policy }})
FROM
identifier({{ my_table[0] }}) c
inner join
identifier({{ source_table[0] }}) p
ON
c.identifier({{ consumer_id }}) = identifier({{ provider_id | join_policy }})
{% if where_clause %}
WHERE {{ where_clause | sqlsafe | join_and_column_policy }}
{% endif %};
$$);
add_ui_form_customizations¶
- Schema:
PROVIDER
Beschreibung: Definiert ein Anpassungsformular für eine Vorlage in einem Clean Room, wenn der Clean Room in Clean Rooms-UI ausgeführt wird. Dies ist nützlich, wenn Sie Verbrauchern die Möglichkeit geben, Vorlagenparameter wie Tabellen oder Spalten auszuwählen. Sie müssen mindestens Werte für display_name
, description
und methodology
im Argument template_information
angeben.
Es wird empfohlen, Tabellenauswahlelemente vor Spaltenauswahlelementen zu platzieren, insbesondere wenn die Spaltenauswahl auf der Grundlage der Tabellenauswahl aufgefüllt wird.
Erfahren Sie, wie Sie Benutzereingabeformulare für benutzerdefinierte Vorlagen entwerfen.
Sie müssen den Clean Room nach dem Aufruf dieser Funktion aktualisieren. Wenn Sie provider.create_or_update_cleanroom_listing
nach der Aktualisierung der UI nicht aufrufen, sehen die Teilnehmer keine Aktualisierungen.
Argumente:
cleanroom_name (string): Der Name des Reinraums, der diese Vorlage enthält. Das eingereichte Formular gilt nur für die angegebene Vorlage im angegebenen Reinraum.
template_name (String): Name der Vorlage, für die diese UI gilt. Dies ist nicht der für den Benutzer sichtbare Titel, der über das Feld
template_information.display_name
festgelegt wird.template_information (Dict): Metainformationen über die Vorlage, die in der Clean Rooms-UI angezeigt werden soll. Die folgenden Eigenschaften müssen oder können definiert werden:
display_name
(erforderlich): Anzeigename der Vorlage in der Clean Rooms-UI.description
(Erforderlich): Beschreibung der Vorlage.methodology
(erforderlich): Beschreibung der Argumente und des Ergebnisses.warehouse_hints
(Objekt): Empfiehlt, welche Art von Warehouse für die Analyse zu verwenden ist. Dies ist ein Objekt mit den folgenden Feldern:warehouse_size
: Siehe warehouse_size in CREATE WAREHOUSE für gültige Werte.snowpark_optimized
(Boolean): ob ein Snowpark-optimiertes Warehouse zur Verarbeitung der Abfrage verwendet werden soll. Für die meisten Anwendungsfälle des maschinellen Lernens empfiehlt Snowflake TRUE.
render_table_dropdowns
(Objekt): Ob die Standard-Dropdown-Listen angezeigt werden sollen, mit denen der Benutzer auswählen kann, welche Anbieter- oder Verbrauchertabellen in der Abfrage verwendet werden sollen. Dies ist ein Objekt mit den folgenden Feldern:render_consumer_table_dropdown
: (Boolean) Wenn TRUE, die Standardauswahl für Verbrauchertabellen anzeigen. Wenn FALSE, blenden Sie den Selektor für Verbrauchertabellen aus. Die Vorlage kann über diemy_table
-Vorlagenvariable auf die ausgewählten Werte als Liste zugreifen. Wenn ein Elementreferences=CONSUMER_TABLES
festlegt, ist der Standardwert FALSE, andernfalls ist der Standardwert TRUE.render_provider_table_dropdown
: (Boolean) Wenn TRUE, die Standardauswahl für Verbrauchertabellen anzeigen. Falls FALSE, blenden Sie den Selektor für Anbieterabellen aus. Die Vorlage kann über diesource_table
-Vorlagenvariable auf die ausgewählten Werte als Liste zugreifen. Wenn ein Elementreferences=PROVIDER_TABLES
festlegt, ist der Standardwert FALSE, andernfalls ist der Standardwert TRUE.
activation_template_name
: (String) Name einer Aktivierungsvorlage in diesem Clean Room. Verwenden Sie den Namen der Vorlage ohnecleanroom
-Präfix. Erfahren Sie mehr über Aktivierungsvorlagen.enabled_activations
: (Zeichenfolge) Welche Arten von Aktivierungen aktiviert sind. Mögliche Werte:consumer
,provider
. Kein Standardwert; muss angegeben werden, wennactivation_template_name
angegeben wird.
details (Dict, optional): Definiert vom Benutzer konfigurierbare Eingabefelder, die Werte an die Vorlage übergeben. Dies ist ein Wörterbuch mit Schlüssel/Objekt-Paaren, wobei jedes Paar ein Formularelement darstellt. Der Schlüssel ist ein Variablenname, der für die verknüpfteJinjaSQL-Vorlage verfügbar ist. Der Wert ist ein Objekt, das das Formularelement definiert. Wenn für eine Vorlagenvariable hier kein entsprechendes Formularelement definiert ist, generiert Clean Rooms automatisch ein Standard-Formularelement. Jedes Objekt kann die folgenden Felder definieren:
<field_name>: { ['display_name': <string>,] ['order': <number>,] ['description': <string>,] ['type': <enum>,] ['default': <value>,] ['choices': <string array>,] ['infoMessage': <string>,] ['size': <enum>,] ['required': <bool>,] ['group': <string>,] ['references': <array of string>,] ['provider_parent_table_field': <string>,] ['consumer_parent_table_field': <string>] }
display_name
: Labeltext für dieses Element im UI-Formular.order
: 1-basierte Reihenfolge, in der dieses Element in Formular angezeigt werden soll. Wenn nicht angegeben, werden die Elemente in der Reihenfolge gerendert, in der sie im Objekt erscheinen.description
: Eine Beschreibung des Zwecks des Elements, die unter dem Label angezeigt wird. Geben Sie hier kurze Hilfeinformationen oder Beispiele an. Wenn nichts angegeben wird, wird nichts angezeigt.type
: Der Typ des UI-Elements. Wenn Referenzen für dieses Eingabefeld angegeben sind, dann lassen Sie diesen Eintrag weg (der Typ wird für Sie ermittelt). Unterstützte Werte:any
(Standard): Reguläres Texteingabefeld.boolean
: Wahr/Falsch-Selektorinteger
: Verwenden Sie Pfeile, um die Zahl zu ändernmultiselect
: Wählen Sie mehrere Elemente aus einer Dropdown-Liste ausdropdown
: Wählen Sie ein Element aus einer Dropdown-Listedate
: Datumsselektor
default
: Standardwert für dieses Elementchoices
: (Array aus Zeichenfolgen) Liste der Auswahlmöglichkeiten für Dropdown- und Multiselect-ElementeinfoMessage
: Informativer Hovertext wird neben dem Element angezeigt. Wenn keine Angaben gemacht werden, wird keine QuickInfo angezeigt.size
: Elementgröße. Unterstützte Werte:XS
,S
,M
,L
,XL
required
: Ob ein Wert für den Benutzer erforderlich ist. Geben Sie TRUE oder FALSE an.group
: Ein Gruppenname, der verwendet wird, um Elemente in der UI zu gruppieren. Verwenden Sie denselben Gruppennamen für Artikel, die in der UI zusammen gruppiert werden sollen. Wenn Sie die Standard-Dropdown-Listen ausblenden, können Sie die speziellen Argumente{{ source_table }}
und{{ my_table}}
in der benutzerdefinierten Vorlage verwenden und dann Ihre eigene Dropdown-Liste definieren, die die gewünschten Tabellen enthält. Weitere Informationen zur Verwendung dieser speziellen Variablen bei der Definition der benutzerdefinierten Vorlage finden Sie unter provider.add_custom_sql_template.references
: Füllt eine Dropdown-Liste mit Tabellen oder Spalten des angegebenen Typs im Clean Room auf. Falls verwendet, musstype
entwedermultiselect
oderdropdown
sein. Die folgenden Zeichenfolgenwerte werden unterstützt:PROVIDER_TABLES
: Listet alle Tabellen des Anbieters im Clean Room auf. Falls angegeben, mussrender_table_dropdowns. render_provider_table_dropdown
FALSE sein.PROVIDER_JOIN_POLICY
: Listet alle Spalten in der Verknüpfungsrichtlinie des Anbieters für die Tabelle auf, die derzeit im Elementprovider_parent_table_field
ausgewählt ist.PROVIDER_COLUMN_POLICY
: Listet alle Spalten in der Spaltenrichtlinie des Anbieters für die aktuelle Vorlage und die improvider_parent_table_field
-Element ausgewählte Tabelle auf.PROVIDER_ACTIVATION_POLICY
: Listet alle Spalten in der Aktivierungsrichtlinie des Anbieters auf.CONSUMER_TABLES
: Listen Sie alle Verbrauchertabellen im Clean Room auf. Falls angegeben, mussrender_table_dropdowns. render_consumer_table_dropdown
FALSE sein.CONSUMER_COLUMNS
: Listet alle Spalten in der Verbrauchertabelle nachconsumer_parent_table_field
auf. Sie sollten keine Verbraucher-Spaltenreferenzen in vom Anbieter ausgeführten Vorlagen verwenden, da der Verbraucher auf diese Spalten möglicherweise Verknüfungs- und Spaltenrichtlinien anwendet. Verwenden Sie für vom Anbieter ausgeführte Vorlagen stattdessenCONSUMER_JOIN_POLICY
oderCONSUMER_COLUMN_POLICY
.CONSUMER_JOIN_POLICY
: Listet alle Spalten in der Verknüpfungsrichtlinie des Verbrauchers auf, die im Elementconsumer_parent_table_field
ausgewählt sind.CONSUMER_COLUMN_POLICY
: Listen Sie alle Spalten in der Spaltenrichtlinie des Verbrauchers für die aktuelle Vorlage und die im Feldconsumer_parent_table_field
ausgewählte Tabelle auf.
provider_parent_table_field
: Der Name des UI-Elements, in dem der Benutzer eine Anbietertabelle auswählt. Geben Sie hier nicht den Tabellennamen selbst an. Nur verwenden, wennreferences
aufPROVIDER_COLUMN_POLICY
oderPROVIDER_JOIN_POLICY
festgelegt ist. Um auf die Standardauswahl der Anbietertabelle zu verweisen, geben Sie hiersource_table
an und legen Sierender_table_dropdowns. render_provider_table_dropdown
auf TRUE fest.consumer_parent_table_field
: Der Name des UI-Elements, in dem der Benutzer eine Verbrauchertabelle auswählt. Geben Sie hier nicht den Tabellennamen selbst an. Nur verwenden, wennreferences
aufCONSUMER_COLUMNS
,CONSUMER_JOIN_POLICY
oderCONSUMER_COLUMN_POLICY
festgelegt ist. Um auf die Standardauswahl für die Verbrauchertabelle zu verweisen, geben hiermy_table
an und legen Sierender_table_dropdowns.render_provider_table_dropdown
auf TRUE fest.
output_config (Dict): Legt fest, wie die Ergebnisse der Vorlagen in der Webanwendung grafisch dargestellt werden sollen. Wenn Sie keine Angaben machen, werden die Ergebnisse nicht in einem Diagramm, sondern nur in einer Tabelle angezeigt. Wenn Sie kein Diagramm wünschen, geben Sie für dieses Argument ein leeres Objekt {} an. Zulässige Felder:
measure_columns
: Namen der Spalten, die Messgrößen und Dimensionen enthalten, die in dem von der Clean Rooms-UI generierten Diagramm verwendet werden sollen.default_output_type
: Das Standardformat für die Anzeige der Ergebnisse. Der Benutzer kann das Anzeigeformat in der Regel in der UI ändern, wenn die Daten im richtigen Format vorliegen. Unterstützte Typen:TABLE
: (Standard) TabellenformatBAR
: Balkendiagramm, das sich gut für den Vergleich verschiedener Kategorien eignetLINE
: Zeilendiagramm, das gut geeignet ist, um Trends im Zeitverlauf oder kontinuierliche Daten darzustellenPIE
: Kreisdiagramm, das sich für die Darstellung von Proportionen oder Prozentsätzen eignet
Die folgende Tabelle zeigt eine Matrix von Werten, die im details
-Objekt für Werte zulässig sind, die kollidieren können:
|
|
|
|
|
|
---|---|---|---|---|---|
|
|
Nicht erlaubt |
Nicht erlaubt |
FALSE |
TRUE oder FALSE |
|
|
Nicht erlaubt |
TRUE |
TRUE oder FALSE |
|
|
|
Nicht erlaubt |
TRUE oder FALSE |
TRUE oder FALSE |
|
|
|
Nicht erlaubt |
TRUE |
TRUE oder FALSE |
|
|
|
Nicht erlaubt |
TRUE oder FALSE |
TRUE oder FALSE |
|
|
Nicht erlaubt |
Nicht erlaubt |
TRUE oder FALSE |
FALSE |
|
|
Nicht erlaubt |
|
TRUE oder FALSE |
TRUE |
|
|
Nicht erlaubt |
|
TRUE oder FALSE |
TRUE |
|
|
Nicht erlaubt |
|
TRUE oder FALSE |
TRUE |
|
|
Nicht erlaubt |
Nicht erlaubt |
TRUE oder FALSE |
TRUE oder FALSE |
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
-- Specify the display name, description, and warehouse, and hide the default table dropdown lists.
-- Define the following two fields in the UI:
-- A provider table selector that shows all provider tables. Chosen tables can be accessed by the template with the variable 'a_provider_table'
-- (This dropdown list is equivalent to setting `render_table_dropdowns.render_provider_table_dropdown: True`)
-- A column selector for the tables chosen in 'a_provider_table'. Chosen columns can be accessed by the template with the variable 'a_provider_col'
CALL samooha_by_snowflake_local_db.provider.add_ui_form_customizations(
$cleanroom_name,
'prod_custom_template',
{
'display_name': 'Custom Analysis Template',
'description': 'Use custom template to run a customized analysis.',
'methodology': 'This custom template dynamically renders a form for you to fill out, which are then used to generate a customized analysis fitting your request.',
'warehouse_hints': {
'warehouse_size': 'xsmall',
'snowpark_optimized': FALSE
},
'render_table_dropdowns': {
'render_consumer_table_dropdown': false,
'render_provider_table_dropdown': false
},
'activation_template_name': 'activation_my_template',
'enabled_activations': ['consumer', 'provider']
},
{
'a_provider_table': {
'display_name': 'Provider table',
'order': 3,
'description': 'Provider table selection',
'size': 'S',
'group': 'Seed Audience Selection',
'references': ['PROVIDER_TABLES'],
'type': 'dropdown'
},
'a_provider_col': {
'display_name': 'Provider column',
'order': 4,
'description': 'Which col do you want to count on',
'size': 'S',
'group': 'Seed Audience Selection',
'references': ['PROVIDER_COLUMN_POLICY'],
'provider_parent_table_field': 'a_provider_table',
'type': 'dropdown'
}
},
{
'measure_columns': ['col1', 'col2'],
'default_output_type': 'PIE'
}
);
restrict_template_options_to_consumers¶
- Schema:
PROVIDER
Beschreibung: Steuert, welche Benutzer auf eine bestimmte Vorlage in einem bestimmten Reinraum zugreifen können. Diese Prozedur setzt alle Zugriffslisten außer Kraft, die zuvor durch eine andere Prozedur für ein Reinraum/Vorlagen-Paar festgelegt wurden.
Bemerkung
Einschränkungen, die Sie durch den Aufruf dieser Prozedur erstellen, verhalten sich in der Clean Rooms-UI möglicherweise nicht wie erwartet. Sie sollten diese Prozedur nicht für einen Clean Room aufrufen, der in der Clean Rooms-UI verwendet werden kann.
Argumente:
cleanroom_name (string) – Der Name des Reinraums.
access_details(JSON-Object) – Der Name einer Vorlage und die Benutzer, die auf diese Vorlage in diesem Reinraum zugreifen können. Wenn eine Vorlage angegeben ist, können nur die hier aufgeführten Benutzer auf diese Vorlage in diesem Reinraum zugreifen. Dies ist ein Objekt mit einem untergeordneten Objekt pro Vorlage im folgenden Format:
{'template_name': ['user1_locator','user2_locator','userN_locator']}
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.restrict_template_options_to_consumers(
$cleanroom_name,
{
'prod_template_1': ['CONSUMER_1_LOCATOR', 'CONSUMER_2_LOCATOR']
}
);
Verbraucherdefinierte Vorlagen¶
Mit den folgenden APIs können Sie die Anfrage eines Verbrauchers, eine Vorlage zum Reinraum hinzuzufügen, genehmigen oder ablehnen. Eine vom Verbraucher definierte Vorlage wird nur dann zu einem Reinraum hinzugefügt, wenn der Anbieter der Anfrage des Verbrauchers auf Hinzufügen zustimmt. Weitere Informationen finden Sie unter label-dcr_consumer_ written_templates.
list_pending_template_requests¶
- Schema:
PROVIDER
Beschreibung: Listet alle nicht genehmigten Anfragen von Verbrauchern auf, die eine vom Verbraucher definierte Vorlage zu einem Clean Room hinzufügen möchten. Dazu gehören ausstehende, genehmigte und abgelehnte Anfragen. Verwenden Sie diese Prozedur, um nach ausstehenden Anfragen zu suchen und diese zu genehmigen (provider.approve_template_request
) oder abzulehnen (provider.reject_template_request
).
Argumente:
cleanroom_name (string) – Ansicht der Verbraucheranfragen zum Hinzufügen einer Vorlage zu diesem Reinraum.
Rückgabe: Eine Tabelle mit u. a. den folgenden Werten:
request_id (String) – ID der Anfrage, die für das Annehmen oder Ablehnen der Anfrage benötigt wird.
consumer_locator (String) – Konto-Locator der Person, die die Anfrage stellt.
template_name (String) – Name der vom Verbraucher bereitgestellten Vorlage.
template_definition (String) – Vollständige Definition der vom Verbraucher vorgeschlagenen Vorlage.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.list_pending_template_requests($template_name);
list_template_requests¶
- Schema:
PROVIDER
Beschreibung: Listet alle Anfragen von Verbrauchern auf, die eine vom Verbraucher definierte Vorlage zu einem Reinraum hinzufügen möchten. Dazu gehören ausstehende, genehmigte und abgelehnte Anfragen. Verwenden Sie diese, um nach ausstehenden Anfragen zu suchen und diese zu genehmigen (provider.approve_template_request
) oder abzulehnen (provider.reject_template_request
).
Argumente:
cleanroom_name (string) – Ansicht der Verbraucheranfragen zum Hinzufügen einer Vorlage zu diesem Reinraum.
Rückgabe: Eine Tabelle mit u. a. den folgenden Werten:
request_id (String) – ID der Anfrage, die für das Annehmen oder Ablehnen der Anfrage benötigt wird.
consumer_identifier (String) – Konto-Locator der Person, die die Anfrage stellt.
template_name (String) – Name der vom Verbraucher bereitgestellten Vorlage.
template_definition (String) – Vollständige Definition der vom Verbraucher vorgeschlagenen Vorlage.
status (String) – Status der Anfrage: PENDING, APPROVED, REJECTED.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.list_template_requests($template_name);
approved_template_request¶
- Schema:
PROVIDER
Beschreibung: Genehmigt eine Anfrage zum Hinzufügen einer Vorlage zum Reinraum.
Argumente:
cleanroom_name (string) – Name des Reinraums, dem der Benutzer die Vorlage hinzufügen möchte.
request_id (string) – ID der zu genehmigenden Anfrage. Rufen Sie
provider.list_template_requests
auf, um die Anfrage IDs anzuzeigen.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.approve_template_request($cleanroom_name,
'815324e5-54f2-4039-b5fb-bb0613846a5b');
approved_multiple_template_requests¶
- Schema:
PROVIDER
Beschreibung: Genehmigt mehrere Verbraucheranfragen zum Hinzufügen einer Vorlage zu einem Clean Room. Alle Anfragen müssen sich auf einen einzigen Clean Room beziehen.
Argumente:
cleanroom_name (string) - Der Name des Clean Room, für den diese Anfrage gilt.
request_ids (Array von Zeichenfolgen) - Die IDs aller zu genehmigenden Vorlagenanfragen. Um eine Anfragen-ID zu erhalten, rufen Sie
provider.list_template_requests
auf.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.approve_multiple_template_requests(
$cleanroom_name,
['cfd538e2-3a17-48e3-9773-14275e7d2cc9',
'2982fb0a-02b7-496b-b1c1-56e6578f5eac']);
reject_template_request¶
- Schema:
PROVIDER
Beschreibung: Lehnt eine Anfrage zum Hinzufügen einer Vorlage zu einem Reinraum ab.
Argumente:
cleanroom_name (string) – Name des Reinraums, dem der Benutzer die Vorlage hinzufügen möchte.
request_id (string) – ID der abzulehnenden Anfrage. Rufen Sie
provider.list_template_requests
auf, um die Anfrage IDs anzuzeigen.reason_for_rejection (string) – Grund für die Ablehnung der Anfrage.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.reject_template_request(
$cleanroom_name,
'cfd538e2-3a17-48e3-9773-14275e7d2cc9',
'Failed security assessment');
reject_multiple_template_requests¶
- Schema:
PROVIDER
Beschreibung: Lehnt mehrere Verbraucheranfragen zum Hinzufügen einer Vorlage zu einem Clean Room ab. Alle Anfragen müssen sich auf denselben Clean Room beziehen.
Argumente:
cleanroom_name (string) - Name des Clean Room, für den diese Anfrage gilt.
rejected_templates (Array von Objekten) - Ein Array von Objekten mit den folgenden Feldern, eines pro Ablehnung:
request_id (string) - ID der abzulehnenden Anfrage. Um eine Anfragen-ID zu erhalten, rufen Sie
provider.list_template_requests
auf.reason_for_rejection(string) - Eine Freitextbeschreibung, warum die Anfrage abgelehnt wird.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.reject_multiple_template_requests($cleanroom_name,
[OBJECT_CONSTRUCT('request_id', '815324e5-54f2-4039-b5fb-bb0613846a5b', 'reason_for_rejection', 'Failed security assessment'),
OBJECT_CONSTRUCT('request_id', '2982fb0a-02b7-496b-b1c1-56e6578f5eac', 'reason_for_rejection', 'Some other reason')
]);
Vorlagenketten¶
Verwenden Sie die folgenden Befehle, um Vorlagenketten zu erstellen und zu verwalten.
add_template_chain¶
- Schema:
PROVIDER
Beschreibung: Erzeugt eine neue Vorlagenkette. Vorlagen müssen vorhanden sein, bevor sie der Vorlagenkette hinzugefügt werden. Nachdem eine Vorlagenkette erstellt wurde, kann sie nicht mehr geändert werden, aber Sie können eine neue Vorlagenkette mit demselben Namen erstellen, um die alte zu überschreiben.
Argumente:
cleanroom_name (string) – Name des Reinraums, dem die Vorlagenkette hinzugefügt werden soll.
template_chain_name (string) – Name der Vorlagenkette.
templates (Array von Objekten) – Array von Objekten, eines pro Vorlage. Das Objekt kann die folgenden Felder enthalten:
template_name
(string) – Gibt die Vorlage an, die der Vorlagenkette hinzugefügt wird. Die Vorlage muss bereits zum Reinraum hinzugefügt worden sein, indem Sieprovider.add_template_chain
aufrufen.cache_results
(boolean) – Legt fest, ob die Ergebnisse der Vorlage vorübergehend gespeichert werden, damit andere Vorlagen in der Vorlagenkette darauf zugreifen können. Um Ergebnisse zwischenzuspeichern, geben Sie TRUE an.output_table_name
(string) – Wenncache_results
= TRUE, gibt dies den Namen der Snowflake-Tabelle an, in der die Vorlagenergebnisse gespeichert werden.jinja_output_table_param
(string) – Wenncache_results
= TRUE, gibt dies den Namen des Jinja-Parameters an, den andere Vorlagen enthalten müssen, um die inoutput_table_name
gespeicherten Ergebnisse zu akzeptieren.cache_expiration_hours
(Ganzzahl) – Wenncache_results
= TRUE, gibt dies die Anzahl der Stunden an, bevor die Ergebnisse im Cache gelöscht werden. Wenn der Cache abläuft, wird der Cache bei der nächsten Ausführung der Vorlagenkette mit den Ergebnissen der Vorlage aufgefrischt.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.add_template_chain(
$cleanroom_name,
'my_chain',
[
{
'template_name': 'crosswalk',
'cache_results': True,
'output_table_name': 'crosswalk',
'jinja_output_table_param': 'crosswalk_table_name',
'cache_expiration_hours': 2190
},
{
'template_name': 'transaction_insights',
'cache_results': False
}
]
);
view_added_template_chains¶
- Schema:
PROVIDER
Beschreibung: Listet die Vorlagenketten im angegebenen Reinraum auf.
Argumente:
cleanroom_name (string) – Der Name des Reinraums.
Rückgabe: (Tabelle) Beschreibung aller Vorlagenketten, die diesem Reinraum hinzugefügt wurden.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.view_added_template_chains($cleanroom_name);
view_template_chain_definition¶
- Schema:
PROVIDER
Beschreibung: Gibt die Definition einer Vorlagenkette zurück.
Argumente:
cleanroom_name (string) – Name des mit dieser Vorlagenkette verbundenen Reinraums.
template_chain_name (string) – Name der mit diesem Reinraum verbundenen Vorlagenkette.
Rückgabe: (Tabelle) Beschreibung der angegebenen Vorlagenkette.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.view_template_chain_definition(
$cleanroom_name,
'my_chain');
clear_template_chain¶
- Schema:
PROVIDER
Beschreibung: Löscht eine bestimmte Vorlagenkette aus einem bestimmten Reinraum. Die Kette wird nirgendwo gespeichert. Wenn Sie also die Kette neu erstellen möchten, müssen Sie sie von Grund auf neu erstellen.
Argumente:
cleanroom_name (string) – Der Reinraum, dem diese Vorlagenkette zugewiesen ist.
template_chain_name (string) – Die Vorlagenkette, die aus diesem Reinraum entfernt werden soll.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.clear_template_chain($cleanroom_name, 'my_chain');
Multi-Anbieter-Analyse¶
Diese Prozeduren ermöglichen die Multi-Anbieter-Analyse.
enable_multiprovider_computation¶
- Schema:
PROVIDER
Beschreibung: Diese Prozedur ermöglicht es, Tabellen aus Ihrem Clean Room in Kombination mit der angegebenen Vorlage zu verwenden, wenn sie vom angegebenen Benutzer angefragt werden, und in Kombination mit Tabellen aus den angegebenen Clean Rooms. Diese Prozedur ermöglicht es einem Verbraucher, eine Abfrage für Daten aus mehreren Clean Rooms auszuführen. Diese Prozedur genehmigt diese Anfragen nicht automatisch, ermöglicht es aber, den manuellen oder automatischen Genehmigungsprozess für den angegebenen Benutzer und die Clean Rooms zu beginnen, indem Anfragen an das Multi-Anbieter-Anfrageprotokoll für diesen Clean Room protokolliert werden.
Alle Aufrufe, die mit consumer.prepare_multiprovider_flow
an diesen Clean Room gerichtet werden, werden gespeichert und sichtbar, noch bevor Sie enable_multiprovider_computation
für diesen Clean Room aufrufen.
Um einem Verbraucher den Zugang zu mehreren Clean Rooms in Ihrem Konto zu ermöglichen, geben Sie einen Clean Room im Argument cleanroom_name
und die anderen im Argument approved_other_cleanrooms
an.
Für diese Prozedur muss im Clean Room eine Verknüpfungsrichtlinie festgelegt werden.
Wenn eine Anfrage protokolliert wird, erfolgt die Genehmigung gemäß dem Anfrage-Workflow für einen bestimmten Benutzer und eine bestimmte Abfrage.
Es gibt keine Möglichkeit, die Protokollierung von Anfragen zu deaktivieren, nachdem sie gestartet wurde, aber Sie können die automatische Genehmigung für einen bestimmten Benutzer aussetzen (wenn Sie sie durch den Aufruf von provider.suspend_multiprovider_tasks
gewährt haben) und dann keine weiteren Anfragen mehr genehmigen.
Argumente:
cleanroom_name (string) – Name eines Reinraums, den Sie besitzen. Alle Daten in diesem Clean Room können mit den unter
approved_other_cleanrooms
aufgelisteten Clean Rooms in Multi-Anbieter-Anfragen vonconsumer_account
gemeinsam genutzt werden.consumer_account (string) – Konto-Locator eines Verbrauchers, der berechtigt ist, die Anfrage zu stellen und, falls genehmigt, eine Abfrage gegen alle Tabellen in diesem Reinraum in Kombination mit Daten aus allen unter
approved_other_cleanrooms
aufgeführten Reinräumen durchzuführen.approved_other_cleanrooms (Array aus Zeichenfolgen) – Array mit vollständig qualifizierten Namen von Reinräumen, mit denen Daten aus diesem Reinraum kombiniert werden können. Das Format der einzelnen Einträge ist
provider_org_name.provider_account_name.cleanroom_name
. Wichtig: Geben Sie den Kontonamen, nicht den Konto-Locator, in jeder Clean Room-Beschreibung an.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.enable_multiprovider_computation(
$cleanroom_name,
$consumer_account_locator,
<org_name>.<account_locator>.<cleanroom_name>);
view_multiprovider_requests¶
- Schema:
PROVIDER
Beschreibung: Zeigt alle Anfragen für Multi-Anbieter-Analysen von einem bestimmten Konto und Reinraum. Dies umfasst sowohl genehmigte als auch abgelehnte Anträge. Anbieter können diese Prozedur verwenden, um Anfragen abzufragen, um sie manuell zu genehmigen, indem sie provider.process_multiprovider_request
aufrufen, oder um alle Anfragen eines bestimmten Verbrauchers in einem bestimmten Clean Room zu sehen.
Sie müssen enable_multiprovider_computation
für diesen Clean Room und dieses Verbraucherkonto aufrufen, bevor Sie view_multiprovider_requests
aufrufen können.
Argumente:
cleanroom_name (string) - Zeigt Anfragen des angegebenen Kunden aus diesem Clean Room an.
consumer_account (string) - Zeigt die Anfragen von diesem Konto-Locator aus dem angegebenen Clean Room.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.view_multiprovider_requests(
$cleanroom_name,
$consumer_locator);
process_multiprovider_request¶
- Schema:
PROVIDER
Beschreibung: Genehmigt die Ausführung der angegebenen Abfrage mit mehreren Anbietern, wenn alle Prüfungen bestanden wurden. Geprüft wird u. a. das Alter der Anfrage und ob der Anbieter die Anfrage in einem früheren Aufruf an provider.enable_multiprovider_computation
genehmigt hat oder nicht. Der Verbraucher muss dennoch consumer.execute_multiprovider_flow
aufrufen, um die Abfrage auszuführen. Eine Anfrage wird nach vier Stunden gelöscht, wenn sie nicht genehmigt wird.
Standardmäßig müssen alle Multi-Anbieter-Anfragen mit dieser Prozedur bearbeitet werden. Wenn Sie es vorziehen, dass alle Anfragen von diesem Verbraucher in diesem Clean Room automatisch genehmigt werden, geben Sie -1
für request_id
an. Wenn Sie möchten, dass alle Anfragen von allen Verbrauchern in diesem Clean Room genehmigt werden, rufen Sie provider.resume_multiprovider_tasks
auf. Erfahren Sie, wie Sie bereits genehmigte Anfragen widerrufen können.
Nachdem die Anfrage bewertet wurde, werden die Anfrage und der Bewertungsstatus in die Protokolltabelle für diesen Clean Room geschrieben.
Argumente:
cleanroom_name (string) – Der Name Ihres Reinraums, den ein Verbraucher in eine Analyse mit mehreren Anbietern aufnehmen möchte.
consumer_account (string) – Der Verbraucherkonto-Locator des Benutzers, der eine Analyse mit mehreren Anbietern anfragt. Dieser Locator muss für diesen Reinraum und die anderen in der Anfrage aufgeführten Reinräume in einem Aufruf an
provider.enable_multiprovider_computation
genehmigt worden sein.request_id (string) – Zu genehmigende Anfrage ID von
provider.view_multiprovider_requests
. Geben Sie-1
ein, um alle Anfragen für diesen Verbraucher in diesem Clean Room zu genehmigen.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.process_multiprovider_request(
$cleanroom_name_1,
$consumer_account_locator,
$request_id);
suspend_multiprovider_tasks¶
- Schema:
PROVIDER
Beschreibung: Stoppt die automatische Überprüfung und Genehmigung (für qualifizierte Abfragen) in einer Abfrage mit mehreren Anbietern in dem angegebenen Clean Room. Abfragen mit mehreren Anbietern sind für den Clean Room immer noch möglich, aber jede Abfrage muss jetzt explizit vom Anbieter genehmigt werden, indem provider.process_multiprovider_request
aufgerufen wird.
Der Standardstatus für alle Clean Rooms ist, dass die automatische Genehmigung für mehrere Anbieter deaktiviert ist. Um sie zu aktivieren, rufen Sie provider.resume_multiprovider_tasks
auf.
Argumente:
cleanroom_name (string) – Der Name des Reinraums.
consumer_account (string) - Konto-Locator des Verbrauchers, dessen Multi-Anbieter-Anfragen für alle Vorlagen in diesem Clean Room ausgesetzt werden sollen. Spätere Anfragen dieses Benutzers in diesem Clean Room werden nicht mehr berücksichtigt.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.suspend_multiprovider_tasks(
$cleanroom_name,
$consumer_locator);
resume_multiprovider_tasks¶
- Schema:
PROVIDER
Beschreibung: Ermöglicht die automatische Überprüfung und Genehmigung (für qualifizierte Abfragen) von Multi-Anbieter-Analysen für den jeweiligen Benutzer im jeweiligen Clean Room. Die automatische Überprüfung ist für einen Clean Room standardmäßig deaktiviert.
Um die automatische Genehmigung zu beenden, rufen Sie provider.suspend_multiprovider_tasks
auf.
Argumente:
cleanroom_name (string) – Der Name des Reinraums.
consumer_account (string) - Konto des Verbrauchers, dessen Multi-Anbieter-Anfragen in diesem Clean Room nun in die Warteschlange gestellt werden.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.resume_multiprovider_tasks(
$cleanroom_name,
$consumer_locator);
Aktivierung¶
Aktivierung bedeutet den Export von Ergebnissen an einen Anbieter, einen Verbraucher oder einen Dritten. Mehr über die Aktivierung.
set_activation_policy¶
- Schema:
PROVIDER
Beschreibung: Legt fest, welche Anbieterspalten innerhalb einer Aktivierungsvorlage verwendet werden können. Nur die in einer Aktivierungsrichtlinie aufgeführten Spalten können aus dem Datensatz des Anbieters aktiviert werden. Wenn Sie keine Aktivierungsrichtlinie festlegen, können keine Anbieterdaten aktiviert werden.
Der Aufruf dieser Prozedur löscht alle vorherigen Aktivierungsrichtlinien, die der Anbieter festgelegt hat.
Argumente:
cleanroom_name (string) – Name des Reinraums, in dem die Aktivierung erlaubt sein soll.
columns (Array aus Zeichenfolgen) – Nur die hier aufgeführten Spalten können in einer Aktivierungsvorlage in diesem Reinraum verwendet werden. Das Format der Spaltennamen lautet
template_name:fully_qualified_table_name:column_name
. Beachten Sie die korrekte Verwendung der Markierungen Punkt . und Doppelpunkt :.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.set_activation_policy('my_cleanroom', [
'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:HASHED_EMAIL',
'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:REGION_CODE' ]);
request_provider_activation_consent¶
- Schema:
PROVIDER
Beschreibung: Sendet eine Anfrage an den Verbraucher, damit der Anbieter eine bestimmte Vorlage ausführen und die Ergebnisse an das Snowflake-Konto des Anbieters senden kann. Im Hintergrund wird eine Vorlage zur Liste der Anbieter-Aktivierungsvorlagen im Clean Room hinzugefügt. Sobald eine Vorlage als Aktivierungsvorlage gekennzeichnet ist, kann sie nur noch in Aktivierungsanfragen verwendet werden.
Argumente:
cleanroom_name (string) – Reinraum, der die Aktivierungsvorlage enthält.
template_name (string) – Name der Aktivierungsvorlage, für die Sie die Genehmigung anfragen. Diese Vorlage muss dem Reinraum in einem früheren Aufruf hinzugefügt worden sein. Der Name der Vorlage muss mit „activation_“ beginnen.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.request_provider_activation_consent(
$cleanroom_name, 'activation_my_activation_template');
update_activation_warehouse¶
- Schema:
PROVIDER
Beschreibung: Geben Sie an, welche Größe das Warehouse haben soll, wenn die Ergebnisse in die Ausgabetabelle in einer Anbieteraktivierung entschlüsselt werden. Das für die Entschlüsselung verwendete Warehouse ist DCR_ACTIVATION_WAREHOUSE. Der Anbieter zahlt für dieses Warehouse.
Argumente:
size (string) - Größe des Warehouse. Wählen Sie einen der WAREHOUSE_SIZE-Werte aus dem Befehl CREATE WAREHOUSE.
Rückgabe: (Zeichenfolge) Erfolgsmeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.update_activation_warehouse('LARGE');
dcr_health.provider_run_provider_activation_history¶
Beschreibung: Gibt einen Verlauf der Anfragen zur Anbieteraktivierung für den angegebenen Clean Room zurück. Anfragen zur Anbieteraktivierung, die sowohl vom Anbieter als auch vom Verbraucher initiiert wurden, werden angezeigt. Diese Prozedur liefert zusätzliche Informationen zum Debuggen von Problemen bei der Anbieteraktivierung.
Argumente:
cleanroom_name (String) – Name des Clean Rooms, in dem die Aktivierung angefragt wurde. Sie müssen ein Anbieter oder Verbraucher in diesem Clean Room sein.
Rückgabe: (Tabelle) – Eine Liste von Aktivierungsanfragen mit Informationen zu jeder Anfrage, einschließlich Vorlagen- und Segmentname, Status, Konto-Locator des Verbrauchers und etwaige Fehlermeldungen, die von der Anfrage zurückgegeben werden.
Beispiel:
CALL samooha_by_snowflake_local_db.dcr_health.provider_run_provider_activation_history(
$cleanroom_name);
view_external_activation_history¶
- Schema:
LIBRARY
Beschreibung: Zeigen Sie den Verlauf der Aktivierungsanfragen für das aktuelle Konto an.
Argumente: Keine
Rückgabe: Eine Tabelle mit den Details und dem Status der Aktivierungsanfragen.
Beispiel:
CALL samooha_by_snowflake_local_db.library.view_external_activation_history();
Analysen als Anbieter durchführen¶
Erfahren Sie, wie Sie eine Anbieter-Analyse durchführen
enable_provider_run_analysis¶
- Schema:
PROVIDER
Beschreibung: Ermöglicht es dem Anbieter (Ersteller des Reinraums), Analysen in einem bestimmten Reinraum durchzuführen. Diese Funktion ist standardmäßig deaktiviert. Der Verbraucher muss dann consumer.enable_templates_for_provider_run
aufrufen, um die vom Anbieter durchgeführten Analysen für bestimmte Vorlagen im Clean Room zu aktivieren. Danach kann der Anbieter eine Analyse durchführen, indem er provider.submit_analysis_request
aufruft.
Erfahren Sie mehr über die Analyse des Anbieters
Wichtig
Diese Prozedur muss aufgerufen werden nach provider.add_consumers
und bevor ein Verbraucher einen Reinraum installiert. Wenn dies geändert wird, nachdem ein Verbraucher seinen Reinraum bereits installiert hat, muss er den Reinraum neu installieren, um die neue Konfiguration zu berücksichtigen.
Argumente:
cleanroom_name (string) – Name des Reinraums, der eine vom Anbieter durchgeführte Analyse ermöglichen soll.
consumer_accounts (Array aus Zeichenfolgen) – Konto-Locator aller Verbraucherkonten, die Daten zu diesem Reinraum hinzugefügt haben.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.enable_provider_run_analysis($cleanroom_name, ['<CONSUMER_ACCOUNT_LOCATOR>']);
disable_provider_run_analysis¶
- Schema:
PROVIDER
Beschreibung: Verhindert, dass der Anbieter (Ersteller des Reinraums) eine Analyse im Reinraum durchführt (dies ist standardmäßig deaktiviert).
Wichtig
Diese Prozedur muss aufgerufen werden nach provider.add_consumers
und bevor ein Verbraucher einen Reinraum installiert. Wenn dies geändert wird, nachdem ein Verbraucher seinen Reinraum bereits installiert hat, muss er den Reinraum neu installieren, damit die neue Konfiguration berücksichtigt wird.
Argumente:
cleanroom_name (string) – Name des Reinraums, in dem die vom Anbieter durchgeführte Analyse deaktiviert werden soll.
consumer_account_locator (string) – Dieselbe Liste von Namen von Verbraucherkonten, die an
provider.enable_provider_run_analysis
übergeben wird.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.disable_provider_run_analysis(
$cleanroom_name,
['<CONSUMER_ACCOUNT_LOCATOR>']);
is_provider_run_enabled¶
- Schema:
LIBRARY
Beschreibung: Prüft, ob dieser Reinraum vom Anbieter durchgeführte Analysen erlaubt.
Argumente:
cleanroom_name (string) – Name des zu prüfenden Reinraums.
Rückgabe: (string) Ob dieser Reinraum vom Anbieter durchgeführte Analysen erlaubt oder nicht.
Beispiel:
CALL samooha_by_snowflake_local_db.library.is_provider_run_enabled($cleanroom_name)
view_warehouse_sizes_for_template¶
- Schema:
PROVIDER
Beschreibung: Zeigen Sie die Liste der Warehouse-Größen und -Typen an, die in von Anbietern durchgeführten Analysen mit einer bestimmten Vorlage verwendet werden können. Der Verbraucher muss die Liste zunächst in seinem Aufruf an consumer.enable_templates_for_provider_run
auffüllen.
Argumente:
consumer_account (string) - Konto-Locator des Verbrauchers, der die vom Anbieter gestellte Anfrage genehmigt.
cleanroom_name (string) – Der Name des Reinraums.
template_name (string) - Name der Vorlage, die der Anbieter ausführen möchte.
consumer_account (string) - Konto-Locator des Verbrauchers, der die vom Anbieter gestellte Anfrage genehmigt.
Rückgabe: Eine Tabelle der zulässigen Warehouse-Größen und -Typen. Unterstützte Zeichenfolgen für Warehouse-Typ und -Größe sind die, die von den Eigenschaften WAREHOUSE_TYPE und WAREHOUSE_SIZE im Befehl CREATE WAREHOUSE verwendet werden.
Beispiel:
CALL samooha_by_snowflake_local_db.PROVIDER.VIEW_WAREHOUSE_SIZES_FOR_TEMPLATE(
$cleanroom_name,
$template_name,
$consumer_account_loc);
submit_analysis_request¶
- Schema:
PROVIDER
Beschreibung: Übermittelt eine Analyse zur Ausführung im Clean Room. Alle folgenden Bedingungen müssen erfüllt sein, bevor Sie diese Prozedur aufrufen:
Der Anbieter muss in diesem Reinraum Anbieter-Analysen aktiviert haben.
Der Verbraucher muss für die angegebene Vorlage über genehmigte Anbieter-Analysen verfügen.
Alle join und column Richtlinien für die Verbraucherdaten und die Vorlage müssen beachtet werden.
Die Vorlage wird im Reinraum ausgeführt, und die Ergebnisse werden sicher im Reinraum gespeichert. Die Ergebnisse werden verschlüsselt, sodass nur der Anbieter die Ergebnisse sehen kann.
Argumente:
cleanroom_name (string) – Name des Reinraums, in dem die Vorlage ausgeführt werden soll.
consumer_account_locator (string) – Konto-Locator des Verbrauchers in diesem Reinraum, der Anbieter-Analysen durch den Aufruf von
consumer.enable_templates_for_provider_run
zugelassen hat.template_name (string) – Name der Vorlage, die ausgeführt werden soll.
provider_tables (array) – Liste der Anbietertabellen, die in der Vorlage angezeigt werden sollen. Diese Liste wird die Array-Variable
source_table
füllen.consumer_tables (array) – Liste der Verbrauchertabellen, die der Vorlage zur Verfügung gestellt werden sollen. Diese Liste wird die Array-Variable
my_table
füllen.analysis_arguments (Objekt) – JSON Objekt, bei dem jeder Schlüssel ein Argumentname ist, der in der von Ihnen erstellten Vorlage verwendet wird. Wenn Sie einen bestimmten Warehouse-Typ und eine bestimmte Größe verwenden möchten, wählen Sie einen Typ und eine Größe, die unter
provider.view_warehouse_sizes_for_template
aufgelistet sind, und geben Sie diese dann in den folgenden Feldern an:warehouse_type
(string) - Ein Warehouse-Typ, den der Verbraucher für vom Anbieter durchgeführte Analysen mit der angegebenen Vorlage unterstützt.warehouse_size
(string) - Eine Warehouse-Größe, die der Verbraucher für vom Anbieter durchgeführte Analysen mit der angegebenen Vorlage unterstützt.
Rückgabe: (string) Eine Anfrage-ID, die dazu dient, den Status der Anfrage zu überprüfen und auch auf die Ergebnisse zuzugreifen. Speichern Sie diese ID, denn Sie werden sie benötigen, um die Analyseergebnisse anzuzeigen.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.submit_analysis_request(
$cleanroom_name,
'<CONSUMER_ACCOUNT>',
'prod_overlap_analysis',
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS'],
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS'],
object_construct(
'dimensions', ['c.REGION_CODE'],
'measure_type', ['AVG'],
'measure_column', ['c.DAYS_ACTIVE'],
'warehouse_type', 'STANDARD', -- If this type and size pair were not listed by view_warehouse_sizes_for_template,
'warehouse_size', 'LARGE' -- the request will automatically fail.
));
check_analysis_status¶
- Schema:
PROVIDER
Beschreibung: Der Anbieter ruft diese Prozedur auf, um den Status der Anbieteranalyseanfrage zu überprüfen. Es kann eine erhebliche Verzögerung geben, bis Sie den Status einer Anfrage sehen können. Wenn eine Analyse als abgeschlossen markiert ist, rufen Sie provider.get_analysis_result
auf, um die Ergebnisse anzuzeigen.
Argumente:
cleanroom_name (string) – Name des Reinraums, in dem die Anfrage gestellt wurde.
request_id (string) – ID der Anfrage, zurückgegeben von
provider.submit_analysis_request
.consumer_account_locator (string) – Konto-Locator des Verbrauchers, an den die Anfrage gesendet wurde.
Rückgabe: (string) Status der Anfrage, wobei COMPLETED
einen erfolgreichen Abschluss der Analyse bedeutet. Mögliche Status:
IN-PROGRESS: Die Analyse ist in Arbeit.
PENDING: Weist auf einen der folgenden Fälle hin:
Die Anfrage wird immer noch übertragen, was einige Minuten dauern kann. Versuchen Sie es nach ein paar Minuten erneut.
Der Benutzer hat die Anfrage nicht durch Aufruf von
consumer.enable_templates_for_provider_run
genehmigt. Versuchen Sie es nach ein paar Minuten erneut.Sie haben die Anforderungsprotokolle für diesen Verbraucher nicht eingebunden. Rufen Sie
provider.is_request_back_share_mount
auf. Wenn diese Prozedur nicht SUCCESS zurückgibt, rufen Sieprovider.mount_request_logs_for_all_consumers
auf.
COMPLETED: Die Analyse ist abgeschlossen. Sie können
provider.get_analysis_result
aufrufen.
Beispiel:
-- It can take up to 2 minutes for this to pick up the request ID after the initial request
CALL samooha_by_snowflake_local_db.provider.check_analysis_status(
$cleanroom_name,
$request_id,
'<CONSUMER_ACCOUNT>'
);
get_analysis_result¶
- Schema:
PROVIDER
Beschreibung: Rufen Sie die Ergebnisse für eine vom Anbieter durchgeführte Analyse ab. Rufen Sie get_analysis_result
erst auf, wenn provider.check_analysis_status
COMPLETED zurückgibt. Die Analyseergebnisse bleiben im Clean Room auf unbestimmte Zeit erhalten.
Argumente:
cleanroom_name (string) – Name des Reinraums, für den die Anfrage gesendet wurde.
request_id (string) – ID der Anfrage, zurückgegeben von
submit_analysis_request
.consumer_account_locator (string) – Konto-Locator des Verbrauchers, der an
submit_analysis_request
übergeben wird.
Ergebnisse: (Tabelle) Abfrageergebnisse.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.get_analysis_result(
$cleanroom_name,
$request_id,
$locator
);
Verwalten Sie die gemeinsame Nutzung von Reinräumen¶
Verwenden Sie die folgenden Befehle, um die gemeinsame Nutzung eines Reinraums mit Verbrauchern zu verwalten.
view_consumers¶
- Schema:
PROVIDER
Beschreibung: Listet die Verbraucher auf, die Zugang zum Reinraum haben. Es wird nicht angezeigt, ob ein Verbraucher den Reinraum installiert hat.
Argumente:
cleanroom_name (string) – Der Reinraum von Interesse.
Rückgabe: (Tabelle) – Liste der Konten von Verbrauchern, die auf den Reinraum zugreifen können.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.view_consumers($cleanroom_name);
add_consumers¶
- Schema:
PROVIDER
Beschreibung: Gewährt den angegebenen Benutzern Zugriff auf den angegebenen Clean Room. Der Clean Room kann sowohl über die Clean Rooms-UI als auch über die API aufgerufen werden. Dabei werden die Verbraucherlisten aus früheren Aufrufen nicht überschrieben. Der Zugang zum Clean Room wird einem bestimmten Benutzer gewährt, nicht einem ganzen Konto. Das Konto des Verbrauchers muss sich in der gleichen Snowflake-Region wie der Anbieter befinden, um auf einen Clean Room zugreifen zu können. Sie können Ihre Region überprüfen, indem Sie select current_region();
aufrufen.
Sie können die aktuelle Liste der Verbraucher einsehen, indem Sie provider.view_consumers
aufrufen.
Argumente:
cleanroom_name (String) – Name des Clean Rooms, der für die angegebenen Benutzer freigegeben werden soll. Benutzer können den Clean Room entweder über die Clean Rooms-API oder die UI installieren.
consumer_account_locators (string) – Eine durch Komma getrennte Liste von Verbraucherkonto-Locator, wie sie von CURRENT_ACCOUNT zurückgegeben wird. Diese Liste sollte die gleiche Anzahl von Einträgen in der gleichen Reihenfolge enthalten, wie sie in
consumer_account_names
enthalten ist.consumer_account_names (string) - Eine durch Kommas getrennte Liste von Datenfreigabe-Verbraucherkonto-IDs für den Verbraucher im Format
org_name.account_name
. Der Organisationsname kann durch Aufruf von CURRENT_ORGANIZATION_NAME abgerufen werden. Der Name des Kontos kann durch den Aufruf von CURRENT_ACCOUNT_NAME abgerufen werden. Diese Liste sollte die gleiche Anzahl von Elementen in der gleichen Reihenfolge enthalten, wie sie inconsumer_account_locators
aufgeführt sind.enable_differential_privacy_tasks (boolesch, optional) - TRUE, um differentielle Privatsphäre in allen Abfragen der aufgeführten Benutzer in diesem Clean Room zu erzwingen. Dies ist eine einfache Möglichkeit, die differentielle Privatsphäre mit Standardwerten für die aufgeführten Benutzer zu aktivieren. Um erweiterte Einstellungen festzulegen, geben Sie stattdessen das Argument
privacy_settings
an. Die Aufgabe der differentiellen Privatsphäre muss in diesem Clean Room ausgeführt werden, um die differentielle Privatsphäre zu aktivieren. Der Standardwert ist FALSE.privacy_settings (Zeichenfolge, optional) - Falls vorhanden, werden die Datenschutzeinstellungen auf benutzerdefinierte Vorlagen angewendet, wenn diese von einem der Benutzer in
consumer_account_names
verwendet werden. Dies ist eine Zeichenfolgenversion eines Objekts mit einem einzelnen NULL-Schlüssel und einem Wert, der verschiedene Datenschutzeinstellungen angibt. Geben Sie nicht gleichzeitigenable_differential_privacy_tasks
undprivacy_settings
an. Die Aufgabe der differentiellen Privatsphäre muss in diesem Clean Room ausgeführt werden, um die differentielle Privatsphäre zu aktivieren. Siehe die verfügbaren Felder für dieses Objekt.
Rückgabe: Erfolgsmeldung. Beachten Sie, dass die Prozedur keine Benutzer-Locator oder Kontonamen validiert, sodass der Erfolg nur anzeigt, dass die eingereichten Locator der Datenbank für diesen Reinraum hinzugefügt wurden.
Beispiele:
-- Add consumer without differential privacy.
CALL samooha_by_snowflake_local_db.provider.add_consumers($cleanroom_name,
'LOCATOR1,LOCATOR2',
'ORG1.NAME1,ORG2.NAME2');
-- Add consumer and turn on differential privacy for all their queries.
CALL samooha_by_snowflake_local_db.provider.add_consumers($cleanroom_name,
'LOCATOR1',
'ORGNAME.ACCOUNTNAME',
'{
"null": {
"threshold_value": 5000,
"differential": 1,
"privacy_budget": 10,
"epsilon": 0.1,
"noise_mechanism": "Laplace"
}}');
remove_consumers¶
- Schema:
PROVIDER
Beschreibung: Entfernt den Zugriff eines Kontos auf einen bestimmten Reinraum. Diese Methode sperrt den Zugriff für alle Benutzer der angegebenen Konten.
Sie können die aktuelle Liste der Verbraucher einsehen, indem Sie provider.view_consumers
aufrufen.
Argumente:
cleanroom_name (string) – Die ID des Reinraums (nicht der benutzerfreundliche Name).
cleanroom_account_locators (string) – Eine durch Kommata getrennte Liste von Locator für Benutzerkonten. Alle Benutzer des Kontos verlieren den Zugang zum Reinraum.
Rückgabe: (string) – Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.remove_consumers($cleanroom_name, 'locator1,locator2,locator3');
set_cleanroom_ui_accessibility¶
- Schema:
PROVIDER
Beschreibung: Hiermit wird der Clean Room in der Clean Rooms-UI für alle Benutzer angezeigt oder ausgeblendet, die bei diesem Anbieterkonto angemeldet sind.
Argumente:
cleanroom_name (string) – Der Name des Reinraums.
visibility_status (string) – Einer der folgenden Werte (Groß- und Kleinschreibung beachten):
HIDDEN – Blendet den Clean Room in der Clean Rooms-UI für alle Benutzern im aktuellen Anbieterkonto aus. Der Clean Room ist weiterhin für API-Aufrufe zugänglich.
EDITABLE – Macht den Clean Room in der Clean Rooms-UI sichtbar.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.set_cleanroom_ui_accessibility($cleanroom_name, 'HIDDEN');
Cloud-übergreifende Zusammenarbeit¶
Ermöglichen Sie die gemeinsame Nutzung eines Clean Room mit einem Verbraucher in einer anderen Cloudregion. Weitere Informationen.
enable_laf_on_account¶
- Schema:
LIBRARY
Beschreibung: Aktiviert die Cloud-übergreifende automatische Ausführung für das aktuelle Konto. Zum Ausführen dieser Prozedur ist die ACCOUNTADMIN-Rolle erforderlich.
Wichtig
Sie müssen zunächst die Cloud-übergreifende automatische Ausführung für Ihr Konto aktivieren, indem Sie SYSTEM$ENABLE_GLOBAL_DATA_SHARING_FOR_ACCOUNT aufrufen. Erfahren Sie mehr über die automatische Auftragsausführung und Verwalten von Berechtigungen für die automatische Auftragsausführung.
Argumente: Keine
Rückgabe: (Zeichenfolge) Erfolgsmeldung.
Beispiel:
USE ROLE ACCOUNTADMIN;
CALL samooha_by_snowflake_local_db.library.enable_laf_on_account();
disable_laf_on_account¶
- Schema:
LIBRARY
Beschreibung: Deaktiviert die Cloud-übergreifende automatische Ausführung für das aktuelle Konto. Zum Ausführen dieser Prozedur ist die ACCOUNTADMIN-Rolle erforderlich.
Wichtig
Sie müssen zuerst SYSTEM$ENABLE_GLOBAL_DATA_SHARING_FOR_ACCOUNT aufrufen, bevor Sie die Cloud-übergreifende automatische Ausführung für ein Konto deaktivieren können. Erfahren Sie mehr über die automatische Auftragsausführung und das Verwalten von Berechtigungen für die automatische Auftragsausführung.
Argumente: Keine
Rückgabe: (Zeichenfolge) Erfolgsmeldung.
Beispiel:
USE ROLE ACCOUNTADMIN;
CALL samooha_by_snowflake_local_db.library.disable_laf_on_account();
is_laf_enabled_on_account¶
- Schema:
LIBRARY
Beschreibung: Gibt zurück, ob die Cloud-übergreifende automatische Ausführung für dieses Konto aktiviert ist.
Argumente: Keine
Rückgabe: TRUE, wenn die Cloud-übergreifende automatische Ausführung für dieses Konto aktiviert ist, andernfalls FALSE.
Beispiel:
CALL samooha_by_snowflake_local_db.library.is_laf_enabled_on_account();
set_laf_dcr_refresh_schedule¶
- Schema:
PROVIDER
Beschreibung: Legt das Aktualisierungsintervall für Clean Room-Daten zwischen dem Anbieter und dem Verbraucher fest, wenn sie sich in unterschiedlichen Cloudregionen befinden. Zu diesen Daten gehören Anbieter-Datensets, Anbieterausführungsanfragen, Clean Room-Richtlinien und Clean Room-Metadaten. Wenn Sie eine sofortige Aktualisierung benötigen, können Sie SYSTEM$TRIGGER_LISTING_REFRESH aufrufen.
Argumente:
schedule (Int) – Intervall in Minuten zwischen den Aktualisierungen. Der zulässige Mindestwert ist 10.
Rückgabe: (String) - Erfolgsmeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.set_laf_dcr_refresh_schedule(10);
Verwenden von Python in einem Reinraum¶
load_python_into_cleanroom¶
- Schema:
PROVIDER
Beschreibung: Lädt benutzerdefinierten Python-Code in den Clean Room. Code, der mit dieser Prozedur in den Reinraum geladen wird, ist für Verbraucher nicht sichtbar. Der hochgeladene Code kann von Ihrer Jinja-Vorlage aufgerufen werden. Auch wenn Ihr Code mehrere Funktionsdefinitionen enthalten kann, wird nur eine Funktion für eine Vorlage angezeigt, die aufgerufen werden kann.
Erfahren Sie, wie Sie Python-Code in einem Clean Room hochladen und verwenden können
Diese Prozedur erhöht die Patch-Nummer Ihres Reinraums und löst einen Sicherheitsscan aus. Sie müssen warten, bis der Scan-Status APPROVED angezeigt wird, bevor Sie die neueste Version für Teilnehmer freigeben können.
Diese Prozedur ist überladen und hat zwei Signaturen, die sich durch den Datentyp des fünften Arguments unterscheiden, der bestimmt, ob Sie den Code inline hochladen oder aus einer Datei im Stagingbereich laden:
load_python_into_cleanroom
hat die folgende Signatur für das Hochladen von Inline-Code. Übergeben Sie Ihre Codezeichenfolge an das -code
-Argument.
(cleanroom_name String, function_name String, arguments Array, packages Array, rettype String, handler String, code String)
Argumente:
cleanroom_name (string) – Name des Reinraums, in den das Skript geladen werden soll.
function_name (String) – Name, den eine Vorlage verwendet, um die durch
handler
angegebene Funktion aufzurufen. Die Vorlage muss den Funktionsnamen mit demClean Room
-Namespace qualifizieren. Beispiel:cleanroom.my_func(val1, val2)
.arguments (Array aus Zeichenfolgenpaaren) – Ein Array von Argumenten, die von der Funktion
function_name
benötigt werden. Jedes Element ist ein durch Leerzeichen getrenntes „Name
-Datentyp
“-Paar, das den Namen des Arguments und den Snowflake-SQL-Datentyp angibt. Beispiel:['size INT', 'start_date DATE']
.packages (Array aus Zeichenfolgen) – Liste der vom Code verwendeten Python-Paketnamen. Clean Rooms unterstützt nativ alle Pakete in dieser Liste oder der Snowpark-API. Wenn Sie ein Paket benötigen, das dort nicht aufgeführt ist, müssen Sie Snowpark Container Services in einem Clean Room verwenden.
ret_type (string) – SQL-Datentyp des von der Funktion
handler
zurückgegebenen Wertes. (Siehe einige gleichwertige Python- und SQL-Typen. Snowflake SQL-Typ-Synonyme werden akzeptiert, wie z. B. STRING für VARCHAR.) Für eine UDFist der Rückgabetyp ein einzelner SQL-Typ. Für eine UDTFist der Rückgabetyp eine TABLE-Funktion mit<column name> <SQL column type>
-Paaren. Beispiel:TABLE (item_name STRING, gesamt FLOAT)
.handler (String) – Die Funktion, die in Ihrem Code aufgerufen wird, wenn eine Vorlage
function_name
aufruft. Bei einer UDF sollte dies der Funktionsname selbst sein. Bei einer UDTF sollte dies der Name der Klasse sein, die die UDTF implementiert.code (string) – Ihr Python-Code als Zeichenfolge. Dies sollte eine Python-UDF sein.
Laden Sie Ihren Code in einen Snowflake-Stagingbereich hoch und stellen Sie dann den Speicherort des Stagingbereichs in der Clean Room-API bereit. Sie müssen den für Ihren speziellen Clean Room aktivierten Stagingbereich verwenden, indem Sie provider.get_stage_for_python_files
aufrufen.
load_python_into_cleanroom
hat die folgende Signatur, um Code aus einem Stagingbereich in den Clean Room hochzuladen.
(cleanroom_name String, function_name String, arguments Array, packages Array, imports Array, rettype String, handler String)
Argumente:
cleanroom_name (string) – Name des Reinraums, in den das Skript geladen werden soll.
function_name (String) – Name, den eine Vorlage verwendet, um die durch
handler
angegebene Funktion aufzurufen. Die Vorlage muss den Funktionsnamen mit demClean Room
-Namespace qualifizieren. Beispiel:cleanroom.my_func(val1, val2)
.arguments (Array aus Zeichenfolgenpaaren) – Ein Array von Argumenten, die von der Funktion
function_name
benötigt werden. Jedes Element ist ein durch Leerzeichen getrenntes „Name
-Datentyp
“-Paar, das den Namen des Arguments und den Snowflake-SQL-Datentyp angibt. Beispiel:['size INT', 'start_date DATE']
.packages (Array aus Zeichenfolgen) – Liste der vom Code verwendeten Python-Paketnamen. Clean Rooms unterstützt nativ alle Pakete in dieser Liste oder der Snowpark-API.
imports (Array aus Zeichenfolgen) – Liste der Dateien, die aus dem Stagingbereich importiert werden sollen. Jede Dateiadresse ist relativ zu dem Stagingbereich, in den Sie den Code hochgeladen haben, z. B.:
['/my_func.py']
. Suchen Sie den Clean Room-Stagingbereich, indem Sieprovider.get_stage_for_python_files
aufrufen.ret_type (string) – SQL-Datentyp des von der Funktion
handler
zurückgegebenen Wertes. (Siehe einige gleichwertige Python- und SQL-Typen. Snowflake SQL-Typ-Synonyme werden akzeptiert, wie z. B. STRING für VARCHAR.) Für eine UDFist der Rückgabetyp ein einzelner SQL-Typ. Für eine UDTFist der Rückgabetyp eine TABLE-Funktion mit<column name> <SQL column type>
-Paaren. Beispiel:TABLE (item_name STRING, gesamt FLOAT)
.handler (String) – Die Funktion, die in Ihrem Code aufgerufen wird, wenn eine Vorlage
function_name
aufruft. Bei einer UDF sollte dies der Funktionsname selbst sein. Bei einer UDTF sollte dies der Name der Klasse sein, die die UDTF implementiert.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiele:
-- Inline UDF
CALL samooha_by_snowflake_local_db.provider.load_python_into_cleanroom(
$cleanroom_name,
'assign_group', -- Name of the UDF.
['data STRING', 'index INTEGER'], -- Arguments of the UDF, along with their type.
['pandas', 'numpy'], -- Packages UDF will use.
'INTEGER', -- Return type of UDF.
'main', -- Handler.
$$
import pandas as pd
import numpy as np
def main(data, index):
df = pd.DataFrame(data) # you can do something with df but this is just an example
return np.random.randint(1, 100)
$$
);
-- Upload from stage
CALL samooha_by_snowflake_local_db.provider.load_python_into_cleanroom(
$cleanroom_name,
'myfunc', -- Name of the UDF.
['data STRING', 'index INTEGER'], -- Arguments of the UDF.
['numpy', 'pandas'], -- Packages UDF will use.
['/assign_group.py'] -- Python file to import from a stage.
'INTEGER', -- Return type of UDF.
'assign_group.main' -- Handler, scoped to file name.
);
get_stage_for_python_files¶
- Schema:
PROVIDER
Beschreibung: Gibt den Pfad zum Stagingbereich zurück, in den Python-Dateien hochgeladen werden sollen, wenn Sie planen, in einen Stagingbereich hochgeladene Codedateien anstelle von Inline-Code-Definitionen zu verwenden, um benutzerdefinierten Python-Code in einem Reinraum zu definieren. Der Stagingbereich existiert nicht und kann erst nach dem Hochladen der Dateien durch den Aufruf von provider.load_python_into_cleanroom
untersucht werden.
Erfahren Sie, wie Sie Python-Code in einem Clean Room hochladen und verwenden können
Argumente:
cleanroom_name (string) – Name des Reinraums, in den Sie Dateien hochladen möchten.
Rückgabe: (string) Der Pfad, in den Sie die Codedateien hochladen sollten. Verwenden Sie dies für das imports-Argument in provider.load_python_into_cleanroom
.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.get_stage_for_python_files($cleanroom_name);
view_cleanroom_scan_status¶
- Schema:
PROVIDER
Beschreibung: Meldet den Bedrohungs-Scan-Status für einen Reinraum, bei dem DISTRIBUTION auf EXTERNAL eingestellt ist. Der Scan muss als „APPROVED“ markiert sein, bevor Sie die Standard-Freigaberichtlinie festlegen oder ändern können. Der Scan-Status muss nur mit EXTERNAL Reinräumen überprüft werden.
Argumente:
cleanroom_name (string) – Name des Reinraums, dessen Status geprüft werden soll.
Rückgabe: (String) Der Status der Überprüfung. Die folgenden Werte sind möglich:
NOT_REVIEWED
: Der Scan ist im Gange.APPROVED
: Der Scan wurde bestanden.REJECTED
: Der Scan ist fehlgeschlagen. Eine neue Clean Room-Version wird nicht veröffentlicht. Versuchen Sie, die Probleme in Ihrem Code zu finden, und versuchen Sie die letzte Aktion erneut.MANUAL_REVIEW
: Der Scan erfordert eine manuelle Überprüfung durch Snowflake. Dies kann einige Tage dauern, sehen Sie also in regelmäßigen Abständen erneut nach.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.view_cleanroom_scan_status($cleanroom_name);
Anforderungsprotokolle¶
Verwenden Sie die folgenden Befehle, um Protokolle für Verbraucheranfragen zu verwalten. Anforderungsprotokolle ermöglichen es dem Verbraucher, Nachrichten an den Anbieter zu senden, und müssen eingebunden werden, um Funktionen wie benutzerdefinierte Vorlagenanfragen des Verbrauchers, die Genehmigung von vom Anbieter ausgeführten Anfragen durch die Verbraucher und die Cloud-übergreifende automatische Ausführung zu ermöglichen.
mount_request_logs_for_all_consumers¶
- Schema:
PROVIDER
Beschreibung: Ermöglicht Anbietern den Zugriff auf Anfragen von Verbrauchern. Sie müssen Anfrageprotokolle einbinden, um verschiedene Funktionen zu unterstützen, einschließlich benutzerdefinierter Vorlagenanfragen von Verbrauchern, Verbrauchergenehmigung von Anfragen, die vom Anbieter ausgeführt werden, und Cloud-übergreifende automatische Ausführung.
Dadurch werden Anforderungsprotokolle nur für Verbraucher eingebunden, die den angegebenen Clean Room bereits installiert haben. Wenn ein Verbraucher einen Clean Room installiert, nachdem der Anbieter diese Prozedur aufgerufen hat, muss der Anbieter diese Prozedur erneut aufrufen.
Argumente:
cleanroom_name (string) – Name des Reinraums, für den die Anfrageprotokolle erstellt werden sollen.
Rückgabe: (Tabelle) Eine Tabelle mit Verbrauchern, mit dem jeweiligen Status des Anforderungsprotokolls. Wenn einem Verbraucher Zugang zu einem Clean Room gewährt wurde, dieser aber den Clean Room noch nicht installiert hat, wird der Status als ausstehend beschrieben und Sie sollten mount_request_logs_for_all_consumers
erneut aufrufen, nachdem sie den Clean Room installiert haben.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.mount_request_logs_for_all_consumers($cleanroom_name);
view_request_mount_status_for_all_consumers¶
- Schema:
PROVIDER
Beschreibung: Zeigt den Einbindungsstatus der Anforderungsprotokolle für alle Verbraucher im angegebenen Clean Room an. Nur Verbraucher, die in einem Aufruf vonprovider.mount_request_logs_for_all_consumers
enthalten waren, werden angezeigt. Anforderungsprotokolle ermöglichen die Weitergabe von Nachrichten vom Verbraucher an den Anbieter.
Argumente:
cleanroom_name (string) – Der Name des Reinraums.
Rückgabe: (Tabelle) – Eine Tabelle mit Verbrauchern und dem Status jedes Verbrauchers.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.view_request_mount_status_for_all_consumers($cleanroom_name);
view_request_logs¶
- Schema:
PROVIDER
Beschreibung: Zeigt die von Verbrauchern in diesem Clean Room gesendeten Anforderungsprotokolle an. Nur Anfragen von Verbrauchern, die in einem früheren erfolgreichen Aufruf von mount_request_logs_for_all_consumers
einbezogen wurden, werden angezeigt.
Argumente:
cleanroom_name (string) – Name des Reinraums, für den die Anfrageprotokolle überprüft werden sollen.
Rückgabe: (Tabelle) Die Anfragen, die der Verbraucher an den Anbieter im angegebenen Reinraum gesendet hat.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.view_request_logs($cleanroom_name);
Differential Privacy¶
Diese Befehle steuern die differentielle Privatsphäre auf der Ebene des Benutzers oder des Anbieterkontos. Erfahren Sie mehr über differentielle Privatsphäre.
set_privacy_settings¶
- Schema:
PROVIDER
Beschreibung: Legt die Datenschutzeinstellungen fest (oder setzt sie zurück), die erzwungen werden, wenn der angegebene Verbraucher eine benutzerdefinierte Vorlage ausführt. Damit werden alle bestehenden Einstellungen für diesen Verbraucher überschrieben.
Argumente:
cleanroom_name (string) – Der Name des Reinraums.
consumer_account_locator (string) - Konto-Locator eines oder mehrerer Verbraucher, in einer durch Komma getrennten Liste.
privacy_settings (Objekt) - Ein JSON-Objekt, das Einstellungen für differentielle Privatsphäre für eine oder mehrere Vorlagen angibt. Die Einstellungen werden auf alle Vorlagen angewendet, die von dem angegebenen Verbraucher ausgeführt werden. Siehe die verfügbaren Felder für dieses Objekt.
Rückgabe: Erfolgsmeldung.
Beispiel:
-- Enforce differential privacy on queries by this consumer
-- with the settings provided.
CALL samooha_by_snowflake_local_db.provider.set_privacy_settings(
$cleanroom_name,
$consumer_locator,
{ 'differential': 1,
'epsilon': 0.1,
'privacy_budget': 3 });
is_dp_enabled_on_account¶
- Schema:
PROVIDER
Beschreibung: Beschreibt, ob die differentielle Privatsphäre für dieses Konto aktiviert ist oder nicht.
Argumente: Keine
Rückgabe: TRUE, wenn der differenzierte Datenschutz für dieses Konto aktiviert ist, andernfalls FALSE.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.is_dp_enabled_on_account();
suspend_account_dp_task¶
- Schema:
PROVIDER
Beschreibung: Deaktiviert die Aufgabe, die Budgets für differentielle Privatsphäre überwacht und durchsetzt. Damit können Sie die Kosten im Zusammenhang mit der differentiellen Privatsphäre in Ihrem Konto kontrollieren. Wenn die Aufgabe „Differentielle Privatsphäre“ deaktiviert ist, wird bei Abfragen von Benutzern, Vorlagen oder Clean Rooms, in denen differentielle Privatsphäre angegeben ist, immer noch Rauschen hinzugefügt, aber Budgetlimits werden nicht durchgesetzt und Ihnen entstehen keine Kosten durch differentielle Privatsphäre. Erfahren Sie mehr über die Verwaltung der differentiellen Privatsphäre
Argumente: Keine
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.suspend_account_dp_task();
resume_account_dp_task¶
- Schema:
PROVIDER
Beschreibung: Setzt die Aufgabenüberwachung für differentielle Privatsphäre im aktuellen Konto fort, und die Budgets für differentielle Privatsphäre werden durchgesetzt. Zuvor eingestellte unterschiedliche Datenschutzwerte (z. B. Empfindlichkeit oder zugehörige Benutzer) werden beibehalten.
Argumente: Keine
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.resume_account_dp_task();
Snowpark Container Services-Befehle¶
Mit diesen Prozeduren können Sie Snowpark Container Services in einem Clean Room verwenden.
load_service_into_cleanroom¶
- Schema:
PROVIDER
Beschreibung: Erzeugt oder aktualisiert einen Containerdienst in einem Clean Room. Wenn Sie diese Prozedur aufrufen, wird die Clean Room Patch-Nummer aktualisiert. Sie müssen also nach dem Aufruf dieser Prozedur provider.set_default_release_directive
aufrufen. Sie müssen diese Prozedur jedes Mal aufrufen, wenn Sie den Dienst erstellen oder aktualisieren. Der Client muss dann consumer.start_or_update_service
aufrufen, um alle Aktualisierungen zu sehen.
Erfahren Sie mehr über die Verwendung von Snowpark Container Services in einem Clean Room.
Argumente:
cleanroom_name (string) – Der Name des Reinraums.
service_spec (string) - Eine YAML-Spezifikation für den Dienst, die auf das Element
spec
zurückgeht.service_config (string) - Eine Konfiguration im YAML-Format für den Dienst. Die folgenden Eigenschaften werden unterstützt:
default_service_options
- Ein optionales Array mit Standardwerten für die Dienstebene. Diese Werte können vom Verbraucher überschrieben werden, wenn er seinen Dienst erstellt. Die folgenden untergeordneten Eigenschaften werden unterstützt:min_instances
(Ganzzahl, optional)max_instances
(Ganzzahl, optional)allow_monitoring
(boolesch, optional) - Wenn TRUE, kann der Verbraucher die Dienstprotokolle einsehen. Der Standardwert ist FALSE.
functions
- Ein Array von Funktionen, die der Dienst anbietet. Jede Funktionsdefinition wird der SPCS-Dienstfunktionsdefinition zugeordnet. In dieser Dokumentation finden Sie die Details zu den einzelnen Elementen. Die folgenden untergeordneten Eigenschaften werden unterstützt:name
args
returns
endpoint
Pfad
max_batch_rows
(optional)context_headers
(optional)
Rückgabe: (Zeichenfolge) Erfolgsmeldung, falls erfolgreich. Gibt einen Fehler aus, wenn er nicht erfolgreich ist.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.load_service_into_cleanroom(
$cleanroom_name,
$$
spec:
containers:
- name: lal
image: /dcr_spcs/repos/lal_example/lal_service_image:latest
env:
SERVER_PORT: 8000
readinessProbe:
port: 8000
path: /healthcheck
endpoints:
- name: lalendpoint
port: 8000
public: false
$$,
$$
default_service_options:
min_instances: 1
max_instances: 1
allow_monitoring: true
functions:
- name: train
args: PROVIDER_TABLE VARCHAR, PROVIDER_JOIN_COL VARCHAR, CONSUMER_TABLE VARCHAR, CONSUMER_JOIN_COL VARCHAR, DIMENSIONS ARRAY, FILTER VARCHAR
returns: VARCHAR
endpoint: lalendpoint
path: /train
- name: score
args: PROVIDER_TABLE VARCHAR, PROVIDER_JOIN_COL VARCHAR, CONSUMER_TABLE VARCHAR, CONSUMER_JOIN_COL VARCHAR, DIMENSIONS ARRAY
returns: VARCHAR
endpoint: lalendpoint
path: /score
- name: score_batch
args: ID VARCHAR, FEATURES ARRAY
returns: VARIANT
max_batch_rows: 1000
endpoint: lalendpoint
path: /scorebatch
$$);
Umgebungsmanagement¶
Verwenden Sie die folgenden Befehle, um die Reinraumfunktionalität und die unterstützten Abläufe allgemein zu nutzen.
manage_datastats_task_on_account¶
- Schema:
PROVIDER
Beschreibung: Aktiviert oder deaktiviert die Hintergrundaufgabe, die Clean Room-Statistiken berechnet. Die Aufgabe wird standardmäßig ausgeführt, aber Sie können sie deaktivieren, um Ihre Kosten zu senken. Um die Aufgabe zu verwalten, müssen alle Teilnehmer die entsprechende Anbieter
- oder Verbraucher
-Version dieser Prozedur mit demselben Wert aufrufen.
Argumente:
enable (Boolean) – TRUE, um die Aufgabe zu aktivieren, FALSE, um die Aufgabe zu deaktivieren.
Rückgabe: Erfolgsmeldung.
Beispiel:
-- Disable the task in this account.
CALL samooha_by_snowflake_local_db.provider.manage_datastats_task_on_account(FALSE);
enable_local_db_auto_upgrades¶
- Schema:
LIBRARY
Beschreibung: Aktiviert die Aufgabe, die die Snowflake Data Clean Rooms-Umgebung automatisch aktualisiert, wenn neue Prozeduren oder Funktionen veröffentlicht werden (die Aufgabe lautet samooha_by_snowflake_local_db.admin.expected_version_task
.) Rufen Sie diese Prozedur auf, um Upgrades zu automatisieren, anstatt library.apply_patch
mit jedem neuen Release aufzurufen.
Obwohl Sie die Kosten senken könnten, wenn Sie diese Aufgabe deaktivieren, empfehlen wir, sie weiter auszuführen, um sicherzustellen, dass Sie die neueste Version der nativen Clean Rooms-Umgebung auf Ihrem System haben.
Argumente: Keine
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.library.enable_local_db_auto_upgrades();
disable_local_db_auto_upgrades¶
- Schema:
LIBRARY
Beschreibung: Deaktiviert die Aufgabe, die die Snowflake Data Clean Rooms-Umgebung automatisch aktualisiert, wenn neue Versionen veröffentlicht werden. Wenn Sie automatische Upgrades deaktivieren, müssen Sie library.apply_patch
mit jedem neuen Release aufrufen.
Argumente: Keine
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.library.disable_local_db_auto_upgrades();
apply_patch¶
- Schema:
LIBRARY
Beschreibung: Aktualisiert Ihre Clean Room-Umgebung und aktiviert neue Features und Korrekturen in Ihrer Umgebung. Rufen Sie dies auf, wenn eine neue Version der Clean Room-Umgebung veröffentlicht wurde. (Dies geschieht normalerweise wöchentlich; siehe Clean Room-Einträge in Neueste Feature-Updates.) Diese Prozedur aktualisiert samooha_by_snowflake_local_db.
Sie können Patch-Updates automatisieren, indem Sie library.enable_local_db_auto_upgrades
aufrufen. Wir empfehlen, automatische Updates zu aktivieren.
Argumente: Keine
Rückgabe: (Zeichenfolge) Erfolgsmeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.library.apply_patch();
patch_cleanroom¶
- Schema:
PROVIDER
Beschreibung: Aktualisiert den angegebenen Clean Room auf die neueste Version und aktiviert neue Features und Korrekturen für diesen Clean Room. Normalerweise rufen Sie dies nur auf, wenn der Snowflake-Support Sie anweist, es aufzurufen.
Der Anbieter sollte library.patch_cleanroom
aufrufen, bevor der Verbraucher library.patch_cleanroom
aufruft. Andernfalls gibt es keinen Patch, der angewendet werden kann.
Argumente:
cleanroom_name (String) – Name des Clean Rooms, der gepatcht werden soll.
Rückgabe: (Zeichenfolge) Erfolgsmeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.patch_cleanroom($cleanroom_name);
dcr_health.dcr_tasks_health_check¶
Beschreibung: Zeigt Informationen über laufende oder kürzlich angehaltene Clean Room-Aufgaben an.
Argumente: Keine
Rückgabe: (Tabelle) Informationen über Clean Room-Aufgaben, einschließlich Zeitplan, Warehouse-Name und Warehouse-Größe.
Beispiel:
CALL samooha_by_snowflake_local_db.dcr_health.dcr_tasks_health_check();
Veraltete Prozeduren¶
Die folgenden Prozedurn sind veraltet und hier nur der Vollständigkeit halber aufgeführt. Wenn eine Ersatzprozedur angezeigt ist, verwenden Sie die neuere Prozedur.
request_laf_cleanroom_requests (verwaltet)¶
- Schema:
PROVIDER
Diese Funktion ist jetzt veraltet. Rufen Sie stattdessen provider.mount_request_logs_for_all_consumers
auf.
Beschreibung: Richtet die Freigabe für Cloud-übergreifende Anfragen auf der Seite des Anbieters für einen bestimmten Verbraucher ein. Ein Kontoadministrator muss zunächst die Cloud-übergreifende automatische Ausführung aktivieren, und der Verbraucher muss consumer.setup_cleanroom_request_share_for_laf
aufgerufen haben.
Dieser Prozess ist für verbraucherdefinierte Vorlagen erforderlich, bei denen sich Anbieter und Verbraucher in unterschiedlichen Cloudregionen befinden.
Sie können diese Prozedur wiederholt aufrufen, um den Status der Anfrage zu überprüfen. Wenn der Status FULFILLED erreicht ist, können Sie provider.mount_laf_cleanroom_requests_share
aufrufen. Es kann 10 Minuten dauern, bis der Status FULFILLED erreicht ist.
Argumente:
cleanroom_name (string) - Name des Clean Room, der die Freigabe für Cloud-übergreifende Anfragen ermöglicht.
consumer_locator (string) - Konto-Locator des Verbrauchers, für den die Freigabe für Cloud-übergreifende Anfragen aktiviert werden soll.
Rückgabe: (String) Statusmeldung der Anfrage: CREATED, PENDING, FULFILLED, FAILURE, „FAILURE, Eintrag nicht gefunden“ bedeutet, dass der Verbraucher den Clean Room nicht installiert hat (oder ihn deinstalliert hat).
Beispiel:
CALL samooha_by_snowflake_local_db.provider.request_laf_cleanroom_requests(
$cleanroom_name, $consumer_locator);
enable_laf_for_cleanroom (Veraltet)¶
- Schema:
PROVIDER
Diese Funktion ist jetzt veraltet und ihre Funktionalität wird von provider.create_or_update_cleanroom_listing
übernommen.
Beschreibung: Aktiviert Cloud-übergreifende automatische Ausführung, mit der Sie den Clean Room für Teilnehmer freigeben können, deren Snowflake-Konto sich in einer anderen Region befindet als das Konto des Anbieters. Die Cloud-übergreifende automatische Ausführung (Cross-Cloud Auto-Fulfillment) wird auch als automatische Auftragsausführung von Freigabeangeboten (Listing Auto-Fulfillment, LAF) bezeichnet.
Standardmäßig ist die Cloud-übergreifende automatische Ausführung für neue Reinräume deaktiviert, selbst wenn es für die Umgebung aktiviert ist.
Wichtig
Ein Snowflake-Administrator mit der Rolle ACCOUNTADMIN muss die Cloud-übergreifende automatische Ausführung in Ihrem Snowflake-Konto aktivieren, bevor Sie diese Prozedur ausführen können. Erfahren Sie mehr über die Cloud-übergreifende automatische Ausführung.
Die Zusammenarbeit mit Verbrauchern in anderen Regionen ist mit zusätzlichen Kosten verbunden. Weitere Informationen zu diesen Kosten finden Sie unter Kosten für Cloud-übergreifende automatische Ausführung.
Argumente:
cleanroom_name (string) – Der Name des Reinraums, der über Regionen hinweg gemeinsam genutzt werden soll. Die Cloud-übergreifende automatische Ausführung muss von einem Administrator für das Konto aktiviert werden, bevor einzelne Reinräume gemeinsam genutzt werden können.
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.enable_laf_for_cleanroom($cleanroom_name);
view_ui_registration_request_log – DEPRECATED¶
- Schema:
PROVIDER
Achtung
Dieser Befehl ist jetzt veraltet. Sie müssen eine Clean Room-Vorlage nicht mehr manuell für die Verwendung in der Clean Rooms-UI registrieren.
Beschreibung: Zeigt die Liste der vom Konto ausgelösten Anfragen zur Registrierung von Clean Rooms in der Clean Rooms-UI an. Jeder Anfrage ist eine ID zugeordnet, die in Verbindung mit der Prozedur view_ui_registration_log
verwendet werden kann, um den Status der Anfragen einzusehen. Die Anfragen werden an das Backend weitergeleitet, wo sie verarbeitet werden und der Clean Room dem Clean Room hinzugefügt wird.
Argumente:
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.view_ui_registration_request_log();
register_table_or_view – Veraltet¶
- Schema:
LIBRARY
Achtung
Dieser Befehl ist jetzt veraltet. Verwenden Sie stattdessen library.register_objects.
Beschreibung: Registriert Tabellen und Ansichten aller Art.
Argumente: object_names (array), is_view (boolean), is_iceberg (boolean), is_external (boolean), is_under_managed_access_schema (boolean)
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiele
Um eine Tabelle zu registrieren:
CALL samooha_by_snowflake_local_db.library.register_table_or_view(
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS'],
false,
false,
false,
false);
Um eine Iceberg-Tabelle zu registrieren:
CALL samooha_by_snowflake_local_db.library.register_table_or_view(
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS'],
false,
true,
false,
false);
register_table – Veraltet¶
- Schema:
LIBRARY
Achtung
Dieser Befehl ist jetzt veraltet. Verwenden Sie stattdessen library.register_objects.
Beschreibung: Ähnlich wie register_db
, arbeitet aber auf Tabellenebene. Gewähren Sie der Rolle SAMOOHA_APP_ROLE die Berechtigung SELECT für diese Tabelle, sodass der Benutzer die Tabelle mit dem Reinraum verbinden kann.
Wenn Sie Tabellen in einem Schema mit verwaltetem Zugriff registrieren möchten (d. h. ein Schema, das mit dem Parameter WITH MANAGED ACCESS erstellt wurde), verwenden Sie stattdessen library.register_managed_access_table
.
Argumente: table_name (array)
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.library.register_table(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
register_managed_access_table – Veraltet¶
- Schema:
LIBRARY
Achtung
Dieser Befehl ist jetzt veraltet. Verwenden Sie stattdessen library.register_objects.
Beschreibung: Ähnlich wie register_table
, registriert aber die Tabellen in einem Schema, das mit dem Parameter WITH MANAGED ACCESS erstellt wurde. Ein Array oder eine Zeichenfolge, die den vollqualifizierten Tabellennamen repräsentiert, kann übergeben werden, und SELECT-Zuweisungen für die Rolle SAMOOHA_APP_ROLE werden ausgeführt, sodass der Benutzer die Tabelle mit dem Reinraum verknüpfen kann.
Argumente: table_name (array)
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.library.register_managed_access_table(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
register_view – Veraltet¶
- Schema:
LIBRARY
Achtung
Dieser Befehl ist jetzt veraltet. Verwenden Sie stattdessen library.register_objects.
Beschreibung: Ähnlich wie register_db
, arbeitet aber auf der Ebene einer Ansicht. Ein Array oder eine Zeichenfolge, die den vollqualifizierten Ansichtsnamen repräsentiert, kann übergeben werden, und SELECT-Zuweisungen für die Rolle SAMOOHA_APP_ROLE werden ausgeführt, sodass der Benutzer die Ansicht mit dem Reinraum verknüpfen kann.
Wenn Sie Ansichten in einem Schema mit verwaltetem Zugriff registrieren möchten (d. h. in einem Schema, das mit dem Parameter WITH MANAGED ACCESS erstellt wurde), verwenden Sie stattdessen library.register_managed_access_view
.
Argumente: view_name (array)
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.library.register_view(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
register_managed_access_view – Veraltet¶
- Schema:
LIBRARY
Achtung
Dieser Befehl ist jetzt veraltet. Verwenden Sie stattdessen library.register_objects.
Beschreibung: Ähnlich wie register_view
, registriert jedoch die Ansichten in einem Schema, das mit dem Parameter WITH MANAGED ACCESS erstellt wurde. Ein Array oder eine Zeichenfolge, die den vollqualifizierten Ansichtsnamen repräsentiert, kann übergeben werden, und SELECT-Zuweisungen für die Rolle SAMOOHA_APP_ROLE werden ausgeführt, sodass der Benutzer die Ansicht mit dem Reinraum verknüpfen kann.
Argumente: view_name (array)
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.library.register_managed_access_view(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
unregister_table_or_view – Veraltet¶
- Schema:
LIBRARY
Achtung
Dieser Befehl ist jetzt veraltet. Verwenden Sie stattdessen library.unregister_objects.
Beschreibung: Hebt die Registrierung von Tabellen und Ansichten aller Arten auf.
Argumente: object_names (array), is_view (boolean), is_iceberg (boolean), is_external (boolean), is_under_managed_access_schema (boolean)
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiele
So heben Sie die Registrierung einer Tabelle auf:
CALL samooha_by_snowflake_local_db.library.unregister_table_or_view(
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS'],
false,
false,
false,
false);
unregister_table – Veraltet¶
- Schema:
LIBRARY
Achtung
Dieser Befehl ist jetzt veraltet. Verwenden Sie stattdessen library.unregister_objects.
Beschreibung: Ähnlich wie unregister_db
, arbeitet aber auf Tabellenebene. Ein Array oder eine Zeichenfolge, die den vollqualifizierten Tabellennamen repräsentiert, kann übergeben werden, um die Registrierung der Tabellen aufzuheben. Benutzer können keine nicht registrierten Tabellen mit einem Reinraum verknüpfen.
Wenn Sie die Registrierung von Tabellen in einem Schema mit verwaltetem Zugriff aufheben möchten (d. h. ein Schema, das mit dem Parameter WITH MANAGED ACCESS erstellt wurde), verwenden Sie stattdessen library.unregister_managed_access_table
.
Argumente: table_name (array)
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.library.unregister_table(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
unregister_managed_access_table – Veraltet¶
- Schema:
LIBRARY
Achtung
Dieser Befehl ist jetzt veraltet. Verwenden Sie stattdessen library.unregister_objects.
Beschreibung: Ähnlich wie unregister_table
, hebt jedoch die Registrierung von Tabellen in einem Schema mit verwaltetem Zugriff auf (d. h. ein Schema, das mit dem Parameter WITH MANAGED ACCESS erstellt wurde).
Argumente: table_name (array)
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.library.unregister_managed_access_table(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
unregister_view – Veraltet¶
- Schema:
LIBRARY
Achtung
Dieser Befehl ist jetzt veraltet. Verwenden Sie stattdessen library.unregister_objects.
Beschreibung: Ähnlich wie unregister_db
, arbeitet aber auf der Ebene einer Ansicht. Ein Array oder eine Zeichenfolge, die den vollständig qualifizierten Namen der Ansicht repräsentiert, kann übergeben werden, um die Registrierung der Ansichten aufzuheben. Benutzer können keine nicht registrierten Ansichten mit einem Reinraum verknüpfen.
Wenn Sie die Registrierung von Ansichten in einem Schema mit verwaltetem Zugriff (d. h. einem Schema, das mit dem Parameter WITH MANAGED ACCESS erstellt wurde) aufheben möchten, verwenden Sie stattdessen library.unregister_managed_access_view
.
Argumente: view_name (array)
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.library.unregister_view(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
unregister_managed_access_view – Verwaltet¶
- Schema:
LIBRARY
Achtung
Dieser Befehl ist jetzt veraltet. Verwenden Sie stattdessen library.unregister_objects.
Beschreibung: Ähnlich wie unregister_view
, hebt jedoch die Registrierung von Ansichten in einem verwalteten Zugriffsschema auf (d. h. einem Schema, das mit dem Parameter WITH MANAGED ACCESS erstellt wurde).
Argumente: view_name (array)
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.library.unregister_managed_access_view(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
provider.create_cleanroom_listing – Veraltet¶
- Schema:
PROVIDER
Achtung
Dieser Befehl ist jetzt veraltet. Verwenden Sie stattdessen provider.create_or_update_cleanroom_listing.
Beschreibung: Nachdem ein Reinraum konfiguriert wurde, erstellt er einen privates Freigabeangebot mit dem Reinraum auf dem Snowflake Marketplace und teilt es mit den angegebenen Teilnehmern.
Sie identifizieren den Teilnehmer anhand des Formats orgname.account_name
seiner Konto-URL. Der Benutzer kann diese Zeichenfolge finden, indem er die Anweisungen unter Suche nach der Organisation und dem Kontonamen für ein Konto befolgt.
Bemerkung
Um diese Prozedur zu verwenden, müssen Sie die Freigaberichtlinie festlegen. Weitere Informationen finden Sie unter provider.set_default_release_directive.
Argumente: cleanroom_name (string), consumer_account_name (string)
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.create_cleanroom_listing($cleanroom_name, <consumerorg.consumeracct>);
register_cleanroom_in_ui – DEPRECATED¶
- Schema:
PROVIDER
Achtung
Dieser Befehl ist jetzt veraltet. Sie müssen eine Clean Room-Vorlage nicht mehr manuell für die Verwendung in der Clean Rooms-UI registrieren.
Beschreibung: Registriert einen Clean Room zur Verwendung in der Clean Room-UI durch den Verbraucher. Der Reinraum wird vom Anbieter mit den Entwickler-APIs erstellt und konfiguriert. Dieser Befehl registriert dann den Clean Room in der Clean Rooms-UI, damit Verbraucher diesen installieren, ihre Tabelle hinzufügen und alle von Ihnen hinzugefügten benutzerdefinierten Analysen ausführen können, ohne die Entwickler-APIs verwenden zu müssen. Verbraucher arbeiten mit dem Clean Room ausschließlich über die Benutzeroberfläche der Clean Rooms-UI.
Sie können diese API mehrmals aufrufen, um mehrere benutzerdefinierte Vorlagen in die Clean Rooms-UI einzubinden.
**Argumente:**cleanroom_name (string), template name (string), consumer_account_locator (string), user_email (string)
Rückgabe: (string) Erfolgs- oder Fehlermeldung.
Beispiel:
CALL samooha_by_snowflake_local_db.provider.register_cleanroom_in_ui($cleanroom_name, 'prod_custom_template', <CONSUMER ACCOUNT LOCATOR>, <USER_EMAIL>)