IBM Cloud Data Engine Verbindungsdetails

Einführung

Connector-Version

Diese Dokumentation basiert auf Version 23.0.8895 des Connectors.

Erste Schritte

Versionsunterstützung für IBM Cloud Data Engine

Der Connector nutzt die IBM Cloud Data Engine API, um einen bidirektionalen Zugriff auf IBM Cloud zu ermöglichen.

Herstellen einer Verbindung

Authentifizierung gegenüber IBM Cloud Data Engine (OAuth)

Für die OAuth-Authentifizierung ist keine Interaktion mit dem Browser erforderlich, um die IBM Cloud Data Engine zu verwenden. Der Connector erleichtert diesen Prozess wie in Herstellen einer Verbindung mit IBM Cloud beschrieben

Herstellen einer Verbindung zur IBM Cloud

Um eine Verbindung mit IBM Cloud herzustellen, benötigen Sie ApiKey. Sie können optional auch die Region wenn alle Ihre Buckets zur selben Region gehören. Nach dem Einstellen InitiateOAuth auf GETANDREFRESH (Standard), sind Sie bereit zur Verbindung.

Wenn Sie die Verbindung herstellen, schließt der Connector den OAuth-Prozess ab.

1. Extrahiert das Zugriffstoken und authentifiziert Anfragen.
2. Speichert OAuth-Werte in OAuthSettingsLocation muss über Verbindungen hinweg bestehen bleiben.

Nachdem Sie ein Konto in IBM Cloud erstellt haben, sollten Sie das folgende Verfahren befolgen, um die Verbindungseigenschaften abzurufen:

API Schlüssel

Um die zu erhalten ApiKey, führen Sie die folgenden Schritte aus:

1. Melden Sie sich bei Ihrem IBM Cloud-Konto an.
2. Navigieren Sie zu Plattform-API Schlüssel Seite.
3. Klicken Sie in der mittleren rechten Ecke auf „IBM Cloud API Schlüssel erstellen“, um einen neuen API Schlüssel zu erstellen.
4. Geben Sie im Popup-Fenster den API Schlüsselnamen an und klicken Sie auf „Erstellen“. Speichern Sie die ApiKey irgendwo, da Sie vom Dashboard aus nie wieder darauf zugreifen können.

Cloud Object Storage CRN und SQL Query CRN

Um eine Verbindung herzustellen, muss ein CloudObjectStorageCRN und ein SqlQueryCRN sind erforderlich. Diese Werte werden automatisch ermittelt. Wenn dies fehlschlägt oder Sie über mehrere SQL-Abfragedienste verfügen, wird empfohlen, diese Verbindungseigenschaften festzulegen. Um die entsprechenden Werte zu finden, können Sie:

• Verwenden Sie die Dienste anzeigen. Dadurch werden Ihre IBM Cloud-Dienste zusammen mit der jeweiligen CRN aufgelistet.
• Suchen Sie die CRN direkt in der IBM Cloud. Navigieren Sie dazu zu Ihrem IBM Cloud Dashboard. Suchen Sie in der Ressourcenliste unter „Dienste“ nach Ihrem SQL-Abfragedienst und wählen Sie ihn aus. Die CRN wird angezeigt. Wählen Sie unter „Speicher“ Ihre Cloud Object Storage-Ressource aus, um deren CRN abzurufen.
• Navigieren Sie zu SQL-Abfrage-Seite, wählen Sie einen Namen für Ihre Instanz und klicken Sie auf „Erstellen“. Sie werden zu der Instanz von SQL Query weitergeleitet, die Sie gerade erstellt haben.

Eine neue Instanz von Cloud Object Storage registrieren

Wenn Sie Cloud Object Storage noch nicht in Ihrem IBM Cloud-Konto haben, können Sie das folgende Verfahren befolgen, um eine Instanz von SQL Query in Ihrem Konto zu installieren:

1. Melden Sie sich bei Ihrem IBM Cloud-Konto an.
2. Navigieren Sie zu Cloud Object Storage-Seite, wählen Sie einen Namen für Ihre Instanz und klicken Sie auf „Erstellen“. Sie werden zu der Instanz von Cloud Object Storage weitergeleitet, die Sie gerade erstellt haben.

Registrieren einer neuen Instanz von SQL Query

Wenn Sie SQL Query noch nicht in Ihrem IBM Cloud-Konto haben, können Sie das folgende Verfahren befolgen, um eine Instanz von SQL Query in Ihrem Konto zu installieren:

1. Melden Sie sich bei Ihrem IBM Cloud-Konto an.
2. Navigieren Sie zu SQL Query-Seite, wählen Sie einen Namen für Ihre Instanz und klicken Sie auf „Erstellen“. Sie werden zu der Instanz von SQL Query weitergeleitet, die Sie gerade erstellt haben.

Generieren von Schemadateien

Mit dem IBM Cloud Data Engine Connector können Sie Schema in Konfigurationsdateien dauerhaft speichern. Mit Schemadateien können Sie die dynamisch erkannten Schemas ganz einfach anpassen und speichern oder Ihre eigene Datenansicht definieren.

Sie können das CreateSchema aufrufen gespeicherte Prozedur, um manuell eine Schema basierend auf den bereitgestellten Eingabeparametern zu generieren. Dies ist insbesondere in Situationen nützlich, in denen der Name der Datei in CloudStorageObject nicht (die richtige) Dateierweiterung hat.

Nachdem Sie ein Schema erstellt haben, können Sie den Namen der generierten Datei verwenden, um aus dieser Ansicht Abfrage.

Standardverhalten anpassen

Anpassen des Verhaltens der IBM Cloud Data Engine

Führen Sie die folgenden Schritte aus, um die Connector-Standardeinstellungen für die Abfrage von IBM Cloud Data Engine zu konfigurieren.

Überprüfen des Auftragsstatus

Sobald ein Job serverseitig initiiert wurde, prüft IBM Cloud Data Engine automatisch, ob die Verarbeitung dieses Jobs abgeschlossen ist. Sie können verwenden PollingInterval um die Wartezeit der Anfragen zu konfigurieren, die der Anbieter in Bezug auf den Auftragsstatus stellt.

Beachten Sie, dass einige Abfragen komplex sein können und es länger dauert, bis das Ergebnis abgerufen wird. Deshalb PollingInterval kann länger konfiguriert werden, um nicht so viele unnötige Anfragen zu stellen. Ein Job wird nur dann serverseitig initiiert, wenn die SELECT Abfrage keine einfache „Select * FROM Table“ Abfrage ist, sondern mindestens ein Kriterium oder eine Projektion enthält. Das Ergebnis jedes Jobs wird als Ansicht betrachtet, da es nur die Operation„Select“ unterstützt.

Bereinigen Sie die Abfrageergebnisse

IBM Cloud Data Engine speichert die Ergebnisse jeder Abfrage, die Sie in CSV- oder JSON-Dateien ausführen, in ResultLocationURI. Sie können verwenden CleanQueryResults, um diese Dateien bei jeder ausgeführten Abfrage automatisch zu bereinigen.

Beachten Sie, dass dieses Verhalten zu geringfügigen Leistungseinbußen führt, wenn Sie die letzte Verbindung in einem Prozess trennen.

Verwenden Sie das Query Caching der IBM Cloud

Sie konfigurieren QueryCachingLevel um die Verwendung der in gespeicherten Abfrage zu ändern ResultLocationURI. Dies ist besonders hilfreich, wenn eine bestimmte Abfrage mehrmals ausgeführt wird. Das bedeutet, dass IBM Cloud Data Engine dieselben Daten nicht erneut scannt und einfach die Ergebnisse der vorherigen Ausführung verwendet. Diese Ergebnisse werden nicht verwendet, wenn der Job früher als die in angegebene Anzahl von Sekunden gestartet wurde QueryTolerance.

Standard-Bucket

Ein Standard-Bucket kann durch Setzen von angegeben werden Bucket und Verbindungseigenschaft. Dies ist optional und wird verwendet, wenn Sie bei der Abfrage keinen Bucket angeben. Wenn nein Bucket gesetzt ist, dann muss der Bucket-Name als Schema in der Abfrage im Format [Schema].[Tabelle] verwendet werden.

Ergebnisse speichern

Ergebnisse können in verschiedenen Datentypen gespeichert werden. Standardmäßig verwendet der IBM Cloud Data Engine Connector CSV. Dies kann durch Ändern von geändert werden StoreResultsAs.

Wichtige Hinweise

Konfigurationsdateien und ihre Pfade

• Alle Verweise auf das Hinzufügen von Konfigurationsdateien und deren Pfaden beziehen sich auf Dateien und Speicherorte auf dem Jitterbit-Agenten, auf dem der Connector installiert ist. Diese Pfade sind je nach Agent und Operationssystem entsprechend anzupassen. Wenn mehrere Agenten in einer Agentengruppe verwendet werden, werden auf jedem Agenten identische Dateien benötigt.

Erweiterte Funktionen

In diesem Abschnitt wird eine Auswahl erweiterter Funktionen des IBM Cloud Data Engine Connectors beschrieben.

Benutzerdefinierte Ansichten

Der Connector ermöglicht Ihnen die Definition virtueller Tabellen, sogenannter benutzerdefinierter Ansichten, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese Ansichten sind nützlich, wenn Sie die an die Treiber gesendeten Abfragen nicht direkt steuern können. Siehe Benutzerdefinierte Ansichten für einen Überblick über das Erstellen und Konfigurieren benutzerdefinierter Ansichten.

SSL-Konfiguration

Verwenden Sie SSL-Konfiguration, um anzupassen, wie der Connector TLS/SSL-Zertifikatsverhandlungen handhabt. Sie können aus verschiedenen Zertifikatsformaten wählen; siehe SSLServerCert-Eigenschaft unter „Verbindungszeichenfolgenoptionen“ für weitere Informationen.

Proxy

So konfigurieren Sie den Connector mit privaten Agent-Proxy-Einstellungen, wählen Sie die Use Proxy Settings Kontrollkästchen auf dem Verbindungskonfigurationsbildschirm.

Abfrageverarbeitung

Der Connector verlagert die Verarbeitung der SELECT-Anweisung so weit wie möglich auf die IBM Cloud Data Engine und verarbeitet dann den Rest der Abfrage im Speicher (clientseitig).

Siehe Abfrageverarbeitung für weitere Informationen.

Benutzerdefinierte Ansichten

Mit dem IBM Cloud Data Engine Connector können Sie eine virtuelle Tabelle definieren, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese werden als benutzerdefinierte Ansichten bezeichnet und sind in Situationen nützlich, in denen Sie die an den Treiber gesendete Abfrage nicht direkt steuern können, z. B. wenn Sie den Treiber von Jitterbit verwenden. Die benutzerdefinierten Ansichten können verwendet werden, um Prädikate zu definieren, die immer angewendet werden. Wenn Sie in der Abfrage an die Ansicht zusätzliche Prädikate angeben, werden diese mit der bereits als Teil der Ansicht definierten Abfrage kombiniert.

Es gibt zwei Möglichkeiten, benutzerdefinierte Ansichten zu erstellen:

• Erstellen Sie eine Konfigurationsdatei im JSON-Format, die die gewünschten Ansichten definiert.
• DDL-Anweisungen.

Definieren von Ansichten mithilfe einer Konfigurationsdatei

Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json. Der Connector erkennt die in dieser Datei angegebenen Ansichten automatisch.

Sie können auch mehrere Ansichtsdefinitionen haben und diese mit steuern UserDefinedViews Verbindungseigenschaft. Wenn Sie diese Eigenschaft verwenden, werden vom Connector nur die angegebenen Ansichten angezeigt.

Diese Konfigurationsdatei für benutzerdefinierte Ansichten ist wie folgt formatiert:

• Jedes Stammelement definiert den Namen einer Ansicht.
• Jedes Stammelement enthält ein untergeordnetes Element namens query, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.

Zum Beispiel:

{
    "MyView": {
        "query": "SELECT * FROM [CloudObjectStorage_1].[SampleBucket_1].Jobs WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Verwenden Sie UserDefinedViews Verbindungseigenschaft, um den Speicherort Ihrer JSON-Konfigurationsdatei anzugeben. Beispiel:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Definieren von Ansichten mit DDL-Anweisungen

Der Connector kann das Schema auch über DDL-Anweisungen wie CREATE LOCAL VIEW, ALTER LOCAL VIEW und DROP LOCAL VIEW erstellen und ändern.

Erstellen einer Ansicht

Um eine neue Ansicht mit DDL-Anweisungen zu erstellen, geben Sie den Ansichtsnamen und die Abfrage wie folgt an:

CREATE LOCAL VIEW`[MeinAnsichtsname] `AS SELECT * FROM Customers LIMIT 20;

Wenn keine JSON-Datei vorhanden ist, erstellt der obige Code eine. Die Ansicht wird dann in der JSON-Konfigurationsdatei erstellt und ist nun erkennbar. Der Speicherort der JSON-Datei wird durch angegeben UserDefinedViews Verbindungseigenschaft.

Ändern einer Ansicht

Um eine vorhandene Ansicht zu ändern, geben Sie den Namen der vorhandenen Ansicht zusammen mit der neuen Abfrage an, die Sie stattdessen verwenden möchten:

ALTER LOCAL VIEW`[MeinAnsichtsname] `AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

Die Ansicht wird dann in der JSON-Konfigurationsdatei aktualisiert.

Löschen einer Ansicht

Um eine vorhandene Ansicht zu löschen, geben Sie den Namen eines vorhandenen Schema neben der neuen Abfrage an, die Sie stattdessen verwenden möchten.

DROP LOCAL VIEW [MyViewName]

Dadurch wird die Ansicht aus der JSON-Konfigurationsdatei entfernt. Sie kann nicht mehr abgefragt werden.

Schema für benutzerdefinierte Ansichten

Benutzerdefinierte Ansichten werden im angezeigt UserViews Schema standardmäßig. Dies geschieht, um zu vermeiden, dass der Name der Ansicht mit einer tatsächlichen Entität im Datenmodell kollidiert. Sie können den Namen des für UserViews verwendeten Schema ändern, indem Sie festlegen UserViewsSchemaName Eigentum.

Arbeiten mit benutzerdefinierten Ansichten

Beispielsweise eine SQL-Anweisung mit einer benutzerdefinierten Ansicht namens UserViews.RCustomers listet nur Kunden in Raleigh auf:

SELECT * FROM Customers WHERE City = 'Raleigh';

Ein Beispiel für eine Abfrage an den Treiber:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Daraus ergibt sich die effektive Abfrage an die Quelle:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Dies ist ein sehr einfaches Beispiel für eine Abfrage an eine benutzerdefinierte Ansicht, die tatsächlich eine Kombination aus der Abfrage und der Ansichtsdefinition ist. Es ist möglich, diese Abfragen in viel komplexeren Mustern zusammenzustellen. Alle SQL-Operationen sind in beiden Abfragen zulässig und werden bei Bedarf kombiniert.

SSL-Konfiguration

Anpassen der SSL-Konfiguration

Standardmäßig versucht der Connector, SSL/TLS auszuhandeln, indem er das Zertifikat des Servers mit dem vertrauenswürdigen Zertifikatspeicher des Systems vergleicht.

Um ein anderes Zertifikat anzugeben, siehe SSLServerCert Eigenschaft für die verfügbaren Formate, um dies zu tun.

Datenmodell

Schemata entdecken

Der IBM Cloud Data Engine Connector ruft die IBM Cloud Data Engine Schemas dynamisch ab. Stellen Sie die Verbindung erneut her, um alle Änderungen in den Metadaten zu laden, z. B. hinzugefügte oder entfernte Spalten oder Änderungen im Datentyp. Jede SELECT-Anweisung, die Kriterien enthält, wird in der IBM Cloud SQL Query-Instanz ausgeführt und ruft eine neue Ansicht für das angegebene Schema ab.

Ansichten

Ansichten ähneln Tabellen in der Art und Weise, wie Daten dargestellt werden; Ansichten sind jedoch schreibgeschützt.

Abfragen können für eine Ansicht ausgeführt werden, als wäre sie eine normale Tabelle.

IBM Cloud Data Engine Connector-Ansichten

AktuelleJobs

Fragen Sie Informationen zu kürzlich ausgeführten Jobs ab. Es werden höchstens Informationen zu den letzten 30 Jobs zurückgegeben.

Tabellenspezifische Informationen

Wählen

Der Treiber verwendet die IBM Cloud Data Engine API, um Suchkriterien zu verarbeiten, die sich auf JobId-Spalten beziehen.

• JobId unterstützt die = Operator.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM RecentJobs WHERE JobId = '86402b0c-4665-4936-b0ff-e5051f5f5a49'

Spalten

Dienstleistungen

Ressourceninstanzen abfragen, die dem aktuell authentifizierten Benutzer gehören.

Spalten

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT/INSERT/UPDATE/DELETE-Operationen mit IBM Cloud Data Engine hinaus erweitern.

Gespeicherte Prozeduren akzeptieren eine Liste von Parametern, führen ihre beabsichtigte Funktion aus und geben dann alle relevanten Antwortdaten von IBM Cloud Data Engine zurück, zusammen mit einer Angabe, ob die Prozedur erfolgreich war oder fehlgeschlagen ist.

Gespeicherte Prozeduren für den IBM Cloud Data Engine Connector

Schema erstellen

Erstellt eine Schema für die Ressource.

Schema erstellen

Erstellt eine lokale Schema (.rsd) aus einer vorhandenen Tabelle oder Ansicht im Datenmodell.

Die Schema wird in dem Verzeichnis erstellt, das in festgelegt ist Location Verbindungseigenschaft, wenn dieses Verfahren ausgeführt wird. Sie können die Datei bearbeiten, um Spalten ein- oder auszuschließen, Spalten umzubenennen oder Spaltendatentypen anzupassen.

Der Connector überprüft die Location um zu bestimmen, ob die Namen von .rsd-Dateien mit einer Tabelle oder Ansicht im Datenmodell übereinstimmen. Wenn ein Duplikat vorhanden ist, hat die Schema Vorrang vor der Standardinstanz dieser Tabelle im Datenmodell. Wenn eine Schema in vorhanden ist Location das nicht mit einer vorhandenen Tabelle oder Ansicht übereinstimmt, wird dem Datenmodell des Connectors ein neuer Tabellen- oder Ansichtseintrag hinzugefügt.

Eingang

Ergebnissatzspalten

GetOAuthAccessToken

Ruft ein Authentifizierungstoken von IBM Cloud ab. Beim Aufrufen dieser gespeicherten Prozedur muss die Verbindungseigenschaft ApiKey angegeben werden.

Ergebnissatzspalten

Aktualisieren Sie das OAuthAccessToken

Aktualisiert das OAuth-Zugriffstoken, das für die Authentifizierung mit IBM Cloud verwendet wird. Die Verbindungseigenschaft ApiKey muss beim Aufruf dieser gespeicherten Prozedur angegeben werden.

Eingang

Ergebnissatzspalten

Systemtabellen

Sie können die in diesem Abschnitt beschriebenen Systemtabellen Abfrage, um auf Schema, Informationen zur Datenquellenfunktionalität und Statistiken zu Operation Charge.

Schematabellen

Die folgenden Tabellen geben Datenbankmetadaten für IBM Cloud Data Engine zurück:

• sys_catalogs: Listet die verfügbaren Datenbanken auf.
• sys_schemas: Listet die verfügbaren Schemata auf.
• sys_tables: Listet die verfügbaren Tabellen und Ansichten auf.
• sys_tablecolumns: Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.
• sys_procedures: Beschreibt die verfügbaren gespeicherten Prozeduren.
• sys_procedureparameters: Beschreibt Parameter gespeicherter Prozeduren.
• sys_keycolumns: Beschreibt die Primär- und Fremdschlüssel.
• sys_indexes: Beschreibt die verfügbaren Indizes.

Datenquellentabellen

Die folgenden Tabellen enthalten Informationen dazu, wie eine Verbindung zur Datenquelle hergestellt und diese Abfrage wird:

• sys_connection_props: Gibt Informationen zu den verfügbaren Verbindungseigenschaften zurück.
• sys_sqlinfo: Beschreibt die SELECT-Abfragen, die der Connector an die Datenquelle auslagern kann.

Abfrageinformationstabellen

Die folgende Tabelle gibt Abfrage für Datenänderungsabfragen zurück:

• Systemidentität: Gibt Informationen zu Charge oder einzelnen Updates zurück.

Sys_catalogs

Listet die verfügbaren Datenbanken auf.

Die folgende Abfrage ruft alle durch die Verbindungszeichenfolge ermittelten Datenbanken ab:

SELECT * FROM sys_catalogs

Spalten

Sys_schemas

Listet die verfügbaren Schemas auf.

Die folgende Abfrage ruft alle verfügbaren Schemata ab:

SELECT * FROM sys_schemas

Spalten

Sys_tables

Listet die verfügbaren Tabellen auf.

Die folgende Abfrage ruft die verfügbaren Tabellen und Ansichten ab:

SELECT * FROM sys_tables

Spalten

Sys_tablecolumns

Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.

Die folgende Abfrage gibt die Spalten und Datentypen für die Tabelle [CloudObjectStorage_1].[SampleBucket_1].Jobs zurück:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Jobs' AND CatalogName='CloudObjectStorage_1' AND SchemaName='SampleBucket_1'

Spalten

Sys_procedures

Listet die verfügbaren gespeicherten Prozeduren auf.

Die folgende Abfrage ruft die verfügbaren gespeicherten Prozeduren ab:

SELECT * FROM sys_procedures

Spalten

Sys_procedureparameters

Beschreibt Parameter gespeicherter Prozeduren.

Die folgende Abfrage gibt Informationen zu allen Eingabeparametern für die gespeicherte Prozedur SelectEntries zurück:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2

Spalten

Sys_keycolumns

Beschreibt die Primär- und Fremdschlüssel.

Die folgende Abfrage ruft den Primärschlüssel für die Tabelle [CloudObjectStorage_1].[SampleBucket_1].Jobs ab:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Jobs' AND CatalogName='CloudObjectStorage_1' AND SchemaName='SampleBucket_1'

Spalten

Sys_foreignkeys

Beschreibt die Fremdschlüssel.

Die folgende Abfrage ruft alle Fremdschlüssel ab, die auf andere Tabellen verweisen:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Spalten

Sys_primarykeys

Beschreibt die Primärschlüssel.

Die folgende Abfrage ruft die Primärschlüssel aus allen Tabellen und Ansichten ab:

SELECT * FROM sys_primarykeys

Spalten

Sys_indexes

Beschreibt die verfügbaren Indizes. Durch das Filtern nach Indizes können Sie selektivere Abfragen mit schnelleren Abfrage schreiben.

Die folgende Abfrage ruft alle Indizes ab, die keine Primärschlüssel sind:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Spalten

Sys_connection_props

Gibt Informationen zu den verfügbaren Verbindungseigenschaften und den in der Verbindungszeichenfolge festgelegten Eigenschaften zurück.

Bei der Abfrage dieser Tabelle sollte die Konfigurationsverbindungszeichenfolge verwendet werden:

jdbc:cdata:ibmcloudsqlquery:config:

Mit dieser Verbindungszeichenfolge können Sie diese Tabelle ohne eine gültige Verbindung Abfrage.

Die folgende Abfrage ruft alle Verbindungseigenschaften ab, die in der Verbindungszeichenfolge festgelegt oder über einen Standardwert gesetzt wurden:

SELECT * FROM sys_connection_props WHERE Value <> ''

Spalten

Sys_sqlinfo

Beschreibt die SELECT- Abfrage, die der Connector an die Datenquelle auslagern kann.

Entdecken der SELECT-Funktionen der Datenquelle

Nachfolgend sehen Sie einen Beispieldatensatz mit SQL-Funktionen. Einige Aspekte der SELECT-Funktionalität werden in einer durch Kommas getrennten Liste zurückgegeben, sofern sie unterstützt werden. Andernfalls enthält die Spalte NO.

Die folgende Abfrage ruft die Operatoren ab, die in der WHERE-Klausel verwendet werden können:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Beachten Sie, dass einzelne Tabellen unterschiedliche Einschränkungen oder Anforderungen an die WHERE-Klausel haben können; siehe Datenmodell Abschnitt für weitere Informationen.

Spalten

Systemidentität

Gibt Informationen zu versuchten Änderungen zurück.

Die folgende Abfrage ruft die IDs der geänderten Zeilen in einer Operation Charge:

SELECT * FROM sys_identity

Spalten

Systeminformationen

Beschreibt die verfügbaren Systeminformationen.

Die folgende Abfrage ruft alle Spalten ab:

SELECT * FROM sys_information

Spalten

Erweiterte Konfigurationseigenschaften

Die erweiterten Konfigurationseigenschaften sind die verschiedenen Optionen, die zum Herstellen einer Verbindung verwendet werden können. Dieser Abschnitt enthält eine vollständige Liste der Optionen, die Sie konfigurieren können. Klicken Sie auf die Links, um weitere Einzelheiten zu erfahren.

Authentifizierung

Verbindung

OAuth

SSL

Schema

Verschiedenes

Authentifizierung

Dieser Abschnitt enthält eine vollständige Liste der Authentifizierungseigenschaften, die Sie konfigurieren können.

API-Schlüssel

Der API Schlüssel, der zur Identifizierung des Benutzers gegenüber IBM Cloud verwendet wird.

Datentyp

string

Standardwert

""

Hinweise

Der Zugriff auf Ressourcen in der IBM Cloud Data Engine REST- API wird über einen API Schlüssel geregelt, um Token abzurufen. Ein API Schlüssel wird erstellt, indem Sie zu Verwalten --> Zugriff (IAM) --> Benutzer navigieren und auf „Erstellen“ klicken.

CloudObjectStorageCRN

Die CRN, die Ihre Cloud Object Storage-Instanz in IBM Cloud eindeutig identifiziert.

Datentyp

string

Standardwert

""

Hinweise

Der Zugriff auf Ressourcen wie Daten in der IBM Cloud Data Engine REST- API wird durch einen Instance Cloud Resource Name geregelt. Um Ihren CloudObjectStorage CRN abzurufen, wählen Sie Ihre Cloud Object Storage-Instanz im Dashboard aus, klicken Sie dann auf der rechten Seite auf die Tab „Service-Anmeldeinformationen“ und erstellen oder wählen Sie einen der vorhandenen Anmeldeinformationen aus, indem Sie auf „Anmeldeinformationen anzeigen“ klicken. Unter den angezeigten Informationen finden Sie den CloudObjectStorageCRN (resource_instance_id). Verwenden Sie diesen Wert für diese Eigenschaft. Wenn nicht angegeben, ruft die IBM Cloud Data Engine den CloudObjectStorageCRN automatisch ab. Wenn mehr als ein CloudObjectStorage-Dienst verfügbar ist, wird der erste in der Liste ausgewählt.

SqlQueryCRN

Die CRN, die Ihre SQL-Abfrageinstanz in IBM Cloud eindeutig identifiziert.

Datentyp

string

Standardwert

""

Hinweise

Der Zugriff auf Ressourcen wie Jobs in der IBM Cloud Data Engine REST- API wird durch einen Instance Cloud Resource Name geregelt. Um Ihren SqlQuery CRN abzurufen, wählen Sie Ihre SQL Query-Instanz aus dem Dashboard aus. Auf der linken Seite sollte die Tab „Verwalten“ automatisch ausgewählt sein. Auf dieser Seite finden Sie den SqlQuery CRN dieser Instanz im Bereich „Bereitstellungsdetails“. Wenn nicht angegeben, ruft die IBM Cloud Data Engine den SqlQueryCRN automatisch ab. Wenn mehr als ein SqlQuery-Dienst verfügbar ist, wird der erste in der Liste ausgewählt.

Verbindung

Dieser Abschnitt enthält eine vollständige Liste der Verbindungseigenschaften, die Sie konfigurieren können.

Eimer

Der Name des Buckets in IBM Cloud, mit dem Sie eine Verbindung herstellen.

Datentyp

string

Standardwert

""

Hinweise

Um auf Ressourcen in der IBM Cloud Data Engine REST API zuzugreifen, ist ein Bucket kann verwendet werden. Alle Bucket-Namen werden im IBM Cloud Dashboard aufgelistet. Dieser Wert ist optional und kann leer gelassen werden, damit der IBM Cloud Data Engine Connector automatisch den bestimmen kann Bucket.

ErgebnisStandortURI

Ein COSURI (z. B. cos://region/bucket), in dem Jobdateien gespeichert werden.

Datentyp

string

Standardwert

""

Hinweise

Ein COSURI (z. B. cos://region/bucket), in dem Jobdateien gespeichert werden.

Region

Der geografische Standort des Buckets, mit dem Sie sich verbinden.

Datentyp

string

Standardwert

""

Hinweise

Der geografische Standort des Buckets, mit dem Sie sich verbinden. Wenn angegeben, versucht der Connector nicht, den Standort des Buckets aufzulösen. Geben Sie diesen Wert nur an, wenn Bucket ist ebenfalls eingestellt.

OAuth

Dieser Abschnitt enthält eine vollständige Liste der OAuth-Eigenschaften, die Sie konfigurieren können.

OAuth initiieren

Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten.

Mögliche Werte

OFF, GETANDREFRESH, REFRESH

Datentyp

string

Standardwert

GETANDREFRESH

Hinweise

Folgende Optionen stehen zur Verfügung:

1. OFF: Gibt an, dass der OAuth-Flow vollständig vom Benutzer gehandhabt wird. Zur Authentifizierung ist ein OAuthAccessToken erforderlich.
2. GETANDREFRESH: Gibt an, dass der gesamte OAuth-Flow vom Connector verarbeitet wird. Wenn derzeit kein Token vorhanden ist, wird es durch eine entsprechende Aufforderung an den Benutzer über den Browser abgerufen. Wenn ein Token vorhanden ist, wird es bei Bedarf aktualisiert.
3. REFRESH: Gibt an, dass der Connector nur das Aktualisieren des OAuthAccessToken übernimmt. Der Benutzer wird vom Connector nie aufgefordert, sich über den Browser zu authentifizieren. Der Benutzer muss zunächst das Abrufen des OAuthAccessToken und des OAuthRefreshToken übernehmen.

OAuth-Zugriffstoken

Der Zugriffstoken für die Verbindung per OAuth.

Datentyp

string

Standardwert

""

Hinweise

Der OAuthAccessToken Eigenschaft wird für die Verbindung über OAuth verwendet. Die OAuthAccessToken wird im Rahmen des Authentifizierungsprozesses vom OAuth-Server abgerufen. Es hat ein serverabhängiges Timeout und kann zwischen Anfragen wiederverwendet werden.

Das Zugriffstoken wird anstelle Ihres Benutzernamens und Passworts verwendet. Das Zugriffstoken schützt Ihre Anmeldeinformationen, indem es sie auf dem Server speichert.

OAuthSettingsLocation

Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH eingestellt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://'.

Datentyp

string

Standardwert

%APPDATA%\IBMCloudSQLQuery Data Provider\OAuthSettings.txt

Hinweise

Wenn InitiateOAuth ist auf gesetzt GETANDREFRESH oder REFRESH, der Connector speichert OAuth-Werte, damit der Benutzer die OAuth-Verbindungseigenschaften nicht manuell eingeben muss und die Anmeldeinformationen über Verbindungen oder Prozesse hinweg gemeinsam genutzt werden können.

Anstatt einen Dateipfad anzugeben, können Sie den Speicher verwenden. Speicherorte werden durch einen Wert angegeben, der mit beginnt 'memory://' gefolgt von einer eindeutigen Kennung für diesen Satz von Anmeldeinformationen (z. B. memory://user1). Die Kennung können Sie frei wählen, sie sollte jedoch für den Benutzer eindeutig sein. Im Gegensatz zur dateibasierten Speicherung, bei der die Anmeldeinformationen über Verbindungen hinweg bestehen bleiben, werden die Anmeldeinformationen bei der Speicherspeicherung in den statischen Speicher geladen und die Anmeldeinformationen werden für die Dauer des Prozesses unter Verwendung derselben Kennung zwischen Verbindungen geteilt. Um die Anmeldeinformationen außerhalb des aktuellen Prozesses beizubehalten, müssen Sie die Anmeldeinformationen vor dem Schließen der Verbindung manuell speichern. Auf diese Weise können Sie sie in der Verbindung festlegen, wenn der Prozess erneut gestartet wird. Sie können OAuth-Eigenschaftswerte mit einer Abfrage an abrufen sys_connection_props Systemtabelle. Wenn mehrere Verbindungen mit denselben Anmeldeinformationen bestehen, werden die Eigenschaften aus der zuvor geschlossenen Verbindung gelesen.

Der Standardspeicherort ist „%APPDATA%\IBMCloudSQLQuery Data Provider\OAuthSettings.txt“ mit %APPDATA% auf das Konfigurationsverzeichnis des Benutzers gesetzt. Die Standardwerte sind

• Windows: "register://%DSN"
• Unix: "%AppData%..."
• Mac: "%AppData%..."

wobei DSN der Name des aktuellen DSN ist, der in der offenen Verbindung verwendet wird.

Die folgende Tabelle listet den Wert von auf %APPDATA% nach Operationssystem:

OAuthRefreshToken

Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken.

Datentyp

string

Standardwert

""

Hinweise

Der OAuthRefreshToken Eigenschaft wird verwendet, um den OAuthAccessToken zu aktualisieren bei Verwendung der OAuth-Authentifizierung.

SSL

Dieser Abschnitt enthält eine vollständige Liste der SSL-Eigenschaften, die Sie konfigurieren können.

SSLServerCert

Das vom Server zu akzeptierende Zertifikat bei einer Verbindung über TLS/SSL.

Datentyp

string

Standardwert

""

Hinweise

Bei Verwendung einer TLS/SSL-Verbindung kann diese Eigenschaft verwendet werden, um das vom Server zu akzeptierende TLS/SSL-Zertifikat anzugeben. Jedes andere Zertifikat, dem der Computer nicht vertraut, wird abgelehnt.

Diese Eigenschaft kann folgende Formen annehmen:

Wenn nicht angegeben, wird jedes vom Computer vertrauenswürdige Zertifikat akzeptiert.

Zertifikate werden vom Computer basierend auf dem Trust Store des Systems als vertrauenswürdig validiert. Der verwendete Trust Store ist der für das System angegebene Wert „javax.net.ssl.trustStore“. Wenn für diese Eigenschaft kein Wert angegeben ist, wird der Standard-Trust Store von Java verwendet (z. B. JAVA_HOME\lib\security\cacerts).

Verwenden Sie „*“, um anzugeben, dass alle Zertifikate akzeptiert werden. Beachten Sie, dass dies aus Sicherheitsgründen nicht empfohlen wird.

Schema

Dieser Abschnitt enthält eine vollständige Liste der Schema, die Sie konfigurieren können.

Standort

Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren.

Datentyp

string

Standardwert

%APPDATA%\IBMCloudSQLQuery Data Provider\Schema

Hinweise

Der Pfad zu einem Verzeichnis, das die Schema für den Connector enthält (.rsd-Dateien für Tabellen und Ansichten, .rsb-Dateien für gespeicherte Prozeduren). Der Ordnerspeicherort kann ein relativer Pfad vom Speicherort der ausführbaren Datei sein. Der Location Eigenschaft wird nur benötigt, wenn Sie Definitionen anpassen möchten (z. B. einen Spaltennamen ändern, eine Spalte ignorieren usw.) oder das Datenmodell mit neuen Tabellen, Ansichten oder gespeicherten Prozeduren erweitern möchten.

Wenn nichts angegeben wird, ist der Standardspeicherort „%APPDATA%\IBMCloudSQLQuery Data Provider\Schema“ mit %APPDATA% wird auf das Konfigurationsverzeichnis des Benutzers eingestellt:

DurchsuchbareSchemas

Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Datentyp

string

Standardwert

""

Hinweise

Das Auflisten der Schemata aus Datenbanken kann aufwändig sein. Die Bereitstellung einer Liste von Schemata in der Verbindungszeichenfolge verbessert die Leistung.

Tabellen

Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA,TabelleB,TabelleC.

Datentyp

string

Standardwert

""

Hinweise

Das Auflisten der Tabellen aus einigen Datenbanken kann teuer sein. Die Bereitstellung einer Liste von Tabellen in der Verbindungszeichenfolge verbessert die Leistung des Connectors.

Diese Eigenschaft kann auch als Alternative zum automatischen Auflisten von Ansichten verwendet werden, wenn Sie bereits wissen, mit welchen Sie arbeiten möchten, und es sonst zu viele wären.

Geben Sie die gewünschten Tabellen in einer durch Kommas getrennten Liste an. Jede Tabelle sollte ein gültiger SQL-Bezeichner sein, wobei alle Sonderzeichen mit eckigen Klammern, Anführungszeichen oder Backticks maskiert werden. Beispiel: Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Beachten Sie, dass Sie beim Herstellen einer Verbindung zu einer Datenquelle mit mehreren Schemata oder Katalogen den vollqualifizierten Namen der Tabelle in dieser Eigenschaft angeben müssen, wie im letzten Beispiel hier, um Mehrdeutigkeiten zwischen Tabellen zu vermeiden, die in mehreren Katalogen oder Schemata vorhanden sind.

Ansichten

Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA,AnsichtB,AnsichtC.

Datentyp

string

Standardwert

""

Hinweise

Das Auflisten der Ansichten aus einigen Datenbanken kann teuer sein. Die Bereitstellung einer Liste von Ansichten in der Verbindungszeichenfolge verbessert die Leistung des Connectors.

Diese Eigenschaft kann auch als Alternative zum automatischen Auflisten von Ansichten verwendet werden, wenn Sie bereits wissen, mit welchen Sie arbeiten möchten, und es sonst zu viele wären.

Geben Sie die gewünschten Ansichten in einer durch Kommas getrennten Liste an. Jede Ansicht sollte ein gültiger SQL-Bezeichner sein, wobei alle Sonderzeichen mit eckigen Klammern, Anführungszeichen oder Backticks maskiert werden. Beispiel: Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Beachten Sie, dass Sie beim Herstellen einer Verbindung zu einer Datenquelle mit mehreren Schemata oder Katalogen den vollqualifizierten Namen der Tabelle in dieser Eigenschaft angeben müssen, wie im letzten Beispiel hier, um Mehrdeutigkeiten zwischen Tabellen zu vermeiden, die in mehreren Katalogen oder Schemata vorhanden sind.

Verschiedenes

Dieser Abschnitt enthält eine vollständige Liste verschiedener Eigenschaften, die Sie konfigurieren können.

CleanQueryResults

CleanQueryResults gibt an, ob Abfrage Cache-Dateien gelöscht werden sollen, sobald die Verbindung geschlossen wird.

Datentyp

bool

Standardwert

false

Hinweise

IBM Cloud Data Engine speichert die Ergebnisse jeder Abfrage, die Sie ausführen, als CSV- oder JSON-Datei in Bucket.

Sie können verwenden CleanQueryResults, um diese Dateien für jede ausgeführte Abfrage zu bereinigen. Beachten Sie, dass dieses Verhalten zu geringfügigen Leistungseinbußen führt, wenn Sie die letzte Verbindung in einem Prozess trennen.

Siehe auch

Siehe Standardverhalten anpassen für weitere Informationen zum Konfigurieren des Abfrage Cachings von IBM Cloud.

MaxRows

Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.

Datentyp

int

Standardwert

-1

Hinweise

Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.

Andere

Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet.

Datentyp

string

Standardwert

""

Hinweise

Die unten aufgeführten Eigenschaften sind für bestimmte Anwendungsfälle verfügbar. Für normale Anwendungsfälle und Funktionen von Treiber sollten diese Eigenschaften nicht erforderlich sein.

Geben Sie mehrere Eigenschaften in einer durch Semikolon getrennten Liste an.

Integration und Formatierung

PollingIntervall

Gibt die Zeit in Sekunden an, die der Anbieter zwischen den Jobstatusanfragen warten soll.

Datentyp

int

Standardwert

1

Hinweise

Sobald ein Job serverseitig initiiert wurde, prüft IBM Cloud automatisch, ob die Verarbeitung dieses Jobs abgeschlossen ist. Mit PollingInterval können Sie die Wartezeit der Anfragen konfigurieren, die der Anbieter für den Jobstatus ausführt.

Beachten Sie, dass einige Abfragen komplex sein können und es länger dauert, bis das Ergebnis abgerufen wird. Aus diesem Grund kann das PollingInterval länger konfiguriert werden, um nicht so viele unnötige Anfragen zu stellen. Ein Job wird nur dann serverseitig initiiert, wenn die Select Abfrage keine einfache „Select * From Table“ Abfrage ist, sondern mindestens ein Kriterium oder eine Projektion enthält. Das Ergebnis jedes Jobs wird als Ansicht betrachtet, da es nur die Operation„Select“ unterstützt.

Pseudospalten

Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.

Datentyp

string

Standardwert

""

Hinweise

Diese Einstellung ist besonders hilfreich im Entity Framework, da Sie dort keinen Wert für eine Pseudospalte festlegen können, es sei denn, es handelt sich um eine Tabellenspalte. Der Wert dieser Verbindungseinstellung hat das Format „Tabelle1=Spalte1, Tabelle1=Spalte2, Tabelle2=Spalte3“. Sie können das Zeichen „*“ verwenden, um alle Tabellen und alle Spalten einzuschließen, z. B. „*=*“.

Abfrage-Caching-Level

Legt die Caching-Stufe für ausgeführte Abfragen fest.

Mögliche Werte

None, Local, Cloud

Datentyp

string

Standardwert

Local

Hinweise

Legt die Caching-Stufe für ausgeführte Abfragen fest.

Abfragetoleranz

Gibt die Zeit in Sekunden an, für die Abfragen im Cache gespeichert werden, wenn QueryCachingLevel auf „Lokal“ oder „Cloud“ eingestellt ist.

Datentyp

string

Standardwert

600

Hinweise

Werte unter 1 werden nicht akzeptiert.

Ergebnisse speichern als

Gibt den Datentyp der generierten Ergebnisdatei nach Abschluss eines Auftrags an.

Mögliche Werte

CSV, JSON

Datentyp

string

Standardwert

CSV

Hinweise

Zeitüberschreitung

Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird.

Datentyp

int

Standardwert

60

Hinweise

Wenn Timeout = 0, Operationen werden nicht abgebrochen. Die Operationen werden ausgeführt, bis sie erfolgreich abgeschlossen sind oder bis ein Fehler auftritt.

Wenn Timeout abläuft und der Operation noch nicht abgeschlossen ist, löst der Connector eine Ausnahme aus.

BenutzerdefinierteAnsichten

Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält.

Datentyp

string

Standardwert

""

Hinweise

Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json. Der Connector erkennt die in dieser Datei angegebenen Ansichten automatisch.

Sie können auch mehrere Ansichtsdefinitionen haben und diese mit steuern UserDefinedViews Verbindungseigenschaft. Wenn Sie diese Eigenschaft verwenden, werden vom Connector nur die angegebenen Ansichten angezeigt.

Diese Konfigurationsdatei für benutzerdefinierte Ansichten ist wie folgt formatiert:

• Jedes Stammelement definiert den Namen einer Ansicht.
• Jedes Stammelement enthält ein untergeordnetes Element namens query, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.

Zum Beispiel:

{
    "MyView": {
        "query": "SELECT * FROM [CloudObjectStorage_1].[SampleBucket_1].Jobs WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Verwenden Sie UserDefinedViews Verbindungseigenschaft, um den Speicherort Ihrer JSON-Konfigurationsdatei anzugeben. Beispiel:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Beachten Sie, dass der angegebene Pfad nicht in Anführungszeichen steht.