Freigeben über

remote_query Tabellenwertfunktion

Gilt für:mit Häkchen markiert: Ja Databricks SQL mit Häkchen markiert: Ja Databricks Runtime

Von Bedeutung

Dieses Feature befindet sich in der Public Preview.

Gibt das tabellarische Ergebnis der Abfrage zurück, die im Remotedatenbankmodul ausgeführt wird.

remote_query Ruft Daten von Remotesystemen mithilfe von Anmeldeinformationen aus einer Verbindung ab. Die Funktion akzeptiert eine Reihe von Connectoroptionen zusätzlich zu den Abfrageoptionen.

Diese Funktion erfordert einen Aufruf benannter Parameter für die Optionsschlüssel.

Syntax

remote_query(connectionName [, connectorOptionKey => connectorOptionValue ] [...])

Arguments

  • connectionName

    Ein obligatorisches STRING Literal, das auf den Verbindungsnamen des Unity Catalog verweist. Wenn der Verbindungsname nicht vorhanden ist, löst Databricks CONNECTION_NOT_FOUND aus.

    Die folgenden Verbindungen werden unterstützt:

    • BigQuery
    • MySQL
    • Oracle
    • PostgreSQL
    • Redshift
    • Schneeflocke
    • SQL Server
    • Teradata

    Wenn die Verbindung nicht unterstützt wird, wird CONNECTION_TYPE_NOT_SUPPORTED_FOR_REMOTE_QUERY_FUNCTION ausgelöst.

  • connectorOptionKey

    Ein Connectoroptionsschlüssel, bei dem es sich um einen Bezeichner mit Groß-/Kleinschreibung handelt. Jeder Verbindungstyp verfügt über entsprechende obligatorische Optionen (Verbindungen mit SQL-Datenbanken erfordern die Option query oder table, während NoSQL-Datenbanken die Option collection erfordern) und zusätzliche optionale Konfigurationsoptionen (z. B. MySQL, PostgreSQL, SQLServer und andere JDBC-ähnliche Verbindungen unterstützen fetchSize, welche die Größe der abgerufenen Batches konfiguriert). Wenn ein Schlüssel nicht unterstützt wird, wird PARAMETER_NOT_SUPPORTED_FOR_REMOTE_QUERY_FUNCTION ausgelöst.

  • connectorOptionValue

    Ein konstanter Ausdruck , der den Connectoroptionswert darstellt.

Rückkehr

Gibt eine Tabelle zurück. Das Ausgabeschema hängt von der Abfrage oder den Tabellen ab, die auf einem Remotesystem gescannt werden.

Hinweise

Diese Funktion kann nicht in Streamingabfragen (UNSUPPORTED_STREAMING_TABLE_VALUED_FUNCTION) verwendet werden.

Examples

-- Simple example with MySQL connection
> SELECT a, b FROM remote_query('mysql_connection', query => 'SELECT * FROM mysql_database.mysql_table WHERE sin(b) = 0.5');
  a        b
  angle_1  30

-- Simple example with MongoDB (NoSQL) connection
> SELECT a, b FROM remote_query('mongo_connection', collection => 'collection1', pipeline => '[{''$match'': {''b'': 30}}]');
  a        b
  angle_1  30

-- Connection name does not exist
> SELECT * FROM remote_query('non_existent_uc_connection', query => '');
  Error: CONNECTION_NOT_FOUND

-- Connection type is not supported
> SELECT * FROM remote_query('google_drive_connection', query => '');
  Error: CONNECTION_TYPE_NOT_SUPPORTED_FOR_REMOTE_QUERY_FUNCTION
  • Last updated on