Details zur Google Cloud Storage Verbindung

Einführung

Connector-Version

Diese Dokumentation basiert auf Version 23.0.8804 des Connectors.

Erste Schritte

Versionsunterstützung für Google Cloud Storage

Der Connector nutzt V1 der Google Cloud Storage JSON API, um einen bidirektionalen Zugriff auf Ihre Google Cloud Storage Daten zu ermöglichen.

Herstellen einer Verbindung

Mit Google Cloud Storage verbinden

Geben Sie die folgenden Verbindungseigenschaften an, bevor Sie die Authentifizierungseigenschaften hinzufügen.

• ProjectId: Setzen Sie hier die ID des Projekts, mit dem Sie sich verbinden möchten.

Authentifizieren bei Google Cloud Storage

Der Connector unterstützt die Verwendung von Benutzerkonten, Dienstkonten und GCP-Instanzkonten zur Authentifizierung.

In den folgenden Abschnitten werden die verfügbaren Authentifizierungsschemata für Google Cloud Storage erläutert:

• Benutzerkonten (OAuth)
• Dienstkonto (OAuthJWT)
• GCP-Instanzkonto

Benutzerkonten (OAuth)

AuthScheme muss auf gesetzt werden OAuth in allen Benutzerkonto-Flows.

Desktop-Anwendungen

Es wird eine eingebettete OAuth-Anwendung bereitgestellt, die die OAuth-Desktop-Authentifizierung vereinfacht. Alternativ können Sie eine benutzerdefinierte OAuth-Anwendung erstellen. Siehe Erstellen einer benutzerdefinierten OAuth-App für Informationen zum Erstellen benutzerdefinierter Anwendungen und Gründe dafür.

Der einzige Unterschied zwischen den beiden Methoden zur Authentifizierung besteht darin, dass Sie bei Verwendung benutzerdefinierter OAuth-Anwendungen zwei zusätzliche Verbindungseigenschaften festlegen müssen.

Nachdem Sie die folgenden Verbindungseigenschaften festgelegt haben, können Sie eine Verbindung herstellen:

• InitiateOAuth: Setzen Sie dies auf GETANDREFRESH, das den Connector anweist, automatisch zu versuchen, das OAuth-Zugriffstoken abzurufen und zu aktualisieren.
• OAuthClientId: (nur benutzerdefinierte Anwendungen) Legen Sie dies in den Einstellungen Ihrer benutzerdefinierten OAuth-Anwendung auf die Client-ID fest.
• OAuthClientSecret: (nur benutzerdefinierte Anwendungen) Legen Sie dies in den benutzerdefinierten OAuth-Anwendungseinstellungen auf das Client-Geheimnis fest.

Wenn Sie eine Verbindung herstellen, öffnet der Connector den OAuth-Endpoint in Ihrem Standardbrowser. Melden Sie sich an und erteilen Sie der Anwendung Berechtigungen. Der Connector schließt dann den OAuth-Prozess wie folgt ab:

• Extrahiert den Zugriffstoken aus der Rückruf URL.
• Erhält einen neuen Zugriffstoken, wenn der alte abläuft.
• Speichert OAuth-Werte in OAuthSettingsLocation die über Verbindungen hinweg bestehen bleiben.

Webanwendungen

Wenn Sie eine Verbindung über eine Webanwendung herstellen, müssen Sie eine benutzerdefinierte OAuth-Anwendung erstellen und bei Google Cloud Storage registrieren. Anschließend können Sie den Connector verwenden, um die OAuth-Tokenwerte abzurufen und zu verwalten. Siehe Erstellen einer benutzerdefinierten OAuth-App für weitere Informationen zu benutzerdefinierten Anwendungen.

OAuth-Zugriffstoken abrufen

Legen Sie die folgenden Verbindungseigenschaften fest, um das zu erhalten OAuthAccessToken:

• OAuthClientId: Legen Sie dies in Ihren Anwendungseinstellungen auf die Client-ID fest.
• OAuthClientSecret: Legen Sie dies in Ihren Anwendungseinstellungen auf das Client-Geheimnis fest.

Rufen Sie dann gespeicherte Prozeduren auf, um den OAuth-Austausch abzuschließen:

1. Rufen Sie GetOAuthAuthorizationURL auf gespeicherte Prozedur. Legen Sie die CallbackURL-Eingabe auf die Callback URL fest, die Sie in Ihren Anwendungseinstellungen angegeben haben. Die gespeicherte Prozedur gibt die URL an den OAuth-Endpoint zurück.
2. Navigieren Sie zu der URL, die die gespeicherte Prozedur in Schritt 1 zurückgegeben hat. Melden Sie sich bei der benutzerdefinierten OAuth-Anwendung an und autorisieren Sie die Webanwendung. Nach der Authentifizierung leitet Sie der Browser zur Rückruf-URL weiter.
3. Rufen Sie den GetOAuthAccessToken gespeicherte Prozedur. Setzen Sie AuthMode auf WEB und den Verifier-Eingang für den Parameter „Code“ in der Abfrage der Rückruf URL.

Sobald Sie die Zugriffs- und Aktualisierungstoken erhalten haben, können Sie eine Verbindung zu Daten herstellen und das OAuth-Zugriffstoken entweder automatisch oder manuell aktualisieren.

Automatische Aktualisierung des OAuth-Zugriffstokens

Damit der Treiber den OAuth-Zugriffstoken automatisch aktualisiert, legen Sie bei der ersten Datenverbindung Folgendes fest:

• InitiateOAuth: Setzen Sie dies auf REFRESH.
• OAuthClientId: Stellen Sie dies in Ihren Anwendungseinstellungen auf die Client-ID ein.
• OAuthClientSecret: Legen Sie dies in Ihren Anwendungseinstellungen auf das Client-Geheimnis fest.
• OAuthAccessToken: Setzen Sie dies auf den von GetOAuthAccessToken zurückgegebenen Zugriffstoken.
• OAuthRefreshToken: Setzen Sie dies auf das von GetOAuthAccessToken zurückgegebene Aktualisierungstoken.
• OAuthSettingsLocation: Legen Sie hier den Speicherort fest, an dem der Connector die OAuth-Tokenwerte speichert, die über Verbindungen hinweg bestehen bleiben.

Bei nachfolgenden Datenverbindungen werden die Werte für OAuthAccessToken und OAuthRefreshToken von übernommen OAuthSettingsLocation.

Manuelle Aktualisierung des OAuth-Zugriffstokens

Der einzige Wert, der zum manuellen Aktualisieren des OAuth-Zugriffstokens bei der Verbindung mit Daten benötigt wird, ist das OAuth-Aktualisierungstoken.

Verwenden Sie das RefreshOAuthAccessToken gespeicherte Prozedur zum manuellen Aktualisieren der OAuthAccessToken nach dem von GetOAuthAccessToken zurückgegebenen ExpiresIn-Parameterwert abgelaufen ist, legen Sie die folgenden Verbindungseigenschaften fest:

• OAuthClientId: Legen Sie dies in Ihren Anwendungseinstellungen auf die Client-ID fest.
• OAuthClientSecret: Legen Sie dies in Ihren Anwendungseinstellungen auf das Client-Geheimnis fest.

Rufen Sie dann RefreshOAuthAccessToken auf mit OAuthRefreshToken gesetzt auf das von GetOAuthAccessToken zurückgegebene OAuth-Aktualisierungstoken. Nachdem die neuen Token abgerufen wurden, öffnen Sie eine neue Verbindung, indem Sie die Eigenschaft OAuthAccessToken auf den von RefreshOAuthAccessToken zurückgegebenen Wert setzen.

Speichern Sie abschließend das OAuth-Aktualisierungstoken, damit Sie es nach Ablauf des OAuth-Zugriffstokens manuell aktualisieren können.

Kopflose Maschinen

Um den Treiber für die Verwendung von OAuth mit einem Benutzerkonto auf einem Headless-Computer zu konfigurieren, müssen Sie sich auf einem anderen Gerät authentifizieren, das über einen Internetbrowser verfügt.

1. Wählen Sie eine von zwei Optionen:
   • Option 1: Erhalten Sie die OAuthVerifierWert wie unten unter „Erhalten und Umtauschen eines Prüfcodes“ beschrieben.
   • Option 2: Installieren Sie den Connector auf einem Computer mit einem Internetbrowser und übertragen Sie die OAuth-Authentifizierungswerte, nachdem Sie sich über den üblichen browserbasierten Ablauf authentifiziert haben, wie unten unter „OAuth-Einstellungen übertragen“ beschrieben.
2. Konfigurieren Sie dann den Connector so, dass der Zugriffstoken auf der Headless-Maschine automatisch aktualisiert wird.

Option 1: Einen Verifier-Code erhalten und umtauschen

Um einen Prüfcode zu erhalten, müssen Sie sich bei der OAuth-Autorisierungs URL authentifizieren.

Befolgen Sie die nachstehenden Schritte, um sich vom Computer aus mit einem Internetbrowser zu authentifizieren und die OAuthVerifier Verbindungseigenschaft.

1. Wählen Sie eine dieser Optionen:

   • Wenn Sie die eingebettete OAuth-Anwendung verwenden, klicken Sie auf Google Cloud Storage OAuth-Endpoint, um den Endpoint in Ihrem Browser zu öffnen.

   • Wenn Sie eine benutzerdefinierte OAuth-Anwendung verwenden, erstellen Sie die Autorisierungs-URL, indem Sie die folgenden Eigenschaften festlegen:

     • InitiateOAuth: Auf setzen OFF.
     • OAuthClientId: Auf die Client-ID eingestellt, die Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
     • OAuthClientSecret: Auf das Client-Geheimnis setzen, das Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.

     Rufen Sie dann GetOAuthAuthorizationURL auf gespeicherte Prozedur mit der entsprechenden CallbackURL. Öffnen Sie die von der gespeicherten Prozedur zurückgegebene URL in einem Browser. 2. Melden Sie sich an und erteilen Sie dem Connector die entsprechenden Berechtigungen. Sie werden dann zur Callback-URL weitergeleitet, die den Prüfcode enthält. 3. Speichern Sie den Wert des Prüfcodes. Später setzen Sie diesen in OAuthVerifier Verbindungseigenschaft.

Als Nächstes müssen Sie den OAuth-Verifiziercode gegen OAuth-Aktualisierungs- und Zugriffstoken austauschen. Legen Sie die folgenden Eigenschaften fest:

Legen Sie auf der Headless-Maschine die folgenden Verbindungseigenschaften fest, um die OAuth-Authentifizierungswerte zu erhalten:

• InitiateOAuth: Setzen Sie dies auf REFRESH.
• OAuthVerifier: Setzen Sie dies auf den Prüfcode.
• OAuthClientId: (nur benutzerdefinierte Anwendungen) Legen Sie dies in den Einstellungen Ihrer benutzerdefinierten OAuth-Anwendung auf die Client-ID fest.
• OAuthClientSecret: (nur benutzerdefinierte Anwendungen) Legen Sie dies in den benutzerdefinierten OAuth-Anwendungseinstellungen auf das Client-Geheimnis fest.
• OAuthSettingsLocation: Legen Sie dies fest, um die verschlüsselten OAuth-Authentifizierungswerte am angegebenen Speicherort beizubehalten.

Nachdem die OAuth-Einstellungsdatei generiert wurde, müssen Sie die folgenden Eigenschaften neu festlegen, um eine Verbindung herzustellen:

• InitiateOAuth: Setzen Sie dies auf REFRESH.
• OAuthClientId: (nur benutzerdefinierte Anwendungen) Legen Sie hier die Client-ID fest, die Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
• OAuthClientSecret: (nur benutzerdefinierte Anwendungen) Legen Sie hier das Client-Geheimnis fest, das Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
• OAuthSettingsLocation: Legen Sie dies auf den Speicherort fest, der die verschlüsselten OAuth-Authentifizierungswerte enthält. Stellen Sie sicher, dass dieser Speicherort dem Connector Lese- und Schreibberechtigungen erteilt, um die automatische Aktualisierung des Zugriffstokens zu ermöglichen.

Option 2: OAuth-Einstellungen übertragen

Bevor Sie eine Verbindung auf einem Headless-Computer herstellen, müssen Sie eine Verbindung mit dem Treiber auf einem Gerät herstellen und installieren, das einen Internetbrowser unterstützt. Legen Sie die Verbindungseigenschaften wie oben unter „Desktop-Anwendungen“ beschrieben fest.

Nach Abschluss der Anweisungen unter „Desktopanwendungen“ werden die resultierenden Authentifizierungswerte verschlüsselt und an den durch angegebenen Speicherort geschrieben OAuthSettingsLocation. Der Standarddateiname ist OAuthSettings.txt.

Nachdem Sie die Verbindung erfolgreich getestet haben, kopieren Sie die OAuth-Einstellungsdatei auf Ihren Headless-Rechner.

Legen Sie auf dem Headless-Rechner die folgenden Verbindungseigenschaften fest, um eine Verbindung zu Daten herzustellen:

• InitiateOAuth: Setzen Sie dies auf REFRESH.
• OAuthClientId: (nur benutzerdefinierte Anwendungen) Legen Sie hier die Client-ID fest, die Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
• OAuthClientSecret: (nur benutzerdefinierte Anwendungen) Legen Sie hier das Client-Geheimnis fest, das Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
• OAuthSettingsLocation: Legen Sie hier den Speicherort Ihrer OAuth-Einstellungsdatei fest. Stellen Sie sicher, dass dieser Speicherort dem Connector Lese- und Schreibberechtigungen erteilt, um die automatische Aktualisierung des Zugriffstokens zu ermöglichen.

Dienstkonten (OAuthJWT)

Um sich mit einem Dienstkonto zu authentifizieren, müssen Sie ein neues Dienstkonto erstellen und über eine Kopie des Kontozertifikats verfügen. Wenn Sie noch kein Dienstkonto haben, können Sie eines erstellen, indem Sie dem Verfahren unter Erstellen einer benutzerdefinierten OAuth-App folgen.

Legen Sie für eine JSON-Datei diese Eigenschaften fest:

• AuthScheme: Setzen Sie dies auf OAuthJWT.
• InitiateOAuth: Setzen Sie dies auf GETANDREFRESH.
• OAuthJWTCertType: Setzen Sie dies auf GOOGLEJSON.
• OAuthJWTCert: Setzen Sie hier den Pfad zum .json Datei bereitgestellt von Google.
• OAuthJWTSubject: (optional) Legen Sie diesen Wert nur fest, wenn das Dienstkonto Teil einer GSuite-Domäne ist und Sie die Delegation aktivieren möchten. Der Wert dieser Eigenschaft sollte die Email-Adresse des Benutzers sein, auf dessen Daten Sie zugreifen möchten.

Legen Sie für eine PFX-Datei stattdessen diese Eigenschaften fest:

• AuthScheme: Setzen Sie dies auf OAuthJWT.
• InitiateOAuth: Setzen Sie dies auf GETANDREFRESH.
• OAuthJWTCertType: Setzen Sie dies auf PFXFILE.
• OAuthJWTCert: Setzen Sie hier den Pfad zum .pfx Datei bereitgestellt von Google.
• OAuthJWTCertPassword: (optional) Setzen Sie dies auf .pfx Dateikennwort. In den meisten Fällen müssen Sie dies angeben, da Google PFX-Zertifikate verschlüsselt.
• OAuthJWTCertSubject: (optional) Legen Sie dies nur fest, wenn Sie ein verwenden OAuthJWTCertType speichert mehrere Zertifikate. Sollte nicht für von Google generierte PFX-Zertifikate festgelegt werden.
• OAuthJWTIssuer: Setzen Sie hier die Email-Adresse des Dienstkontos. Diese Adresse enthält normalerweise die Domäne iam.gserviceaccount.com.
• OAuthJWTSubject: (optional) Legen Sie diesen Wert nur fest, wenn das Dienstkonto Teil einer GSuite-Domäne ist und Sie die Delegation aktivieren möchten. Der Wert dieser Eigenschaft sollte die Email-Adresse des Benutzers sein, auf dessen Daten Sie zugreifen möchten.

GCP-Instanzkonten

Wenn der Connector auf einer virtuellen GCP-Maschine ausgeführt wird, kann er sich mithilfe eines an die virtuelle Maschine gebundenen Dienstkontos authentifizieren. Um diesen Modus zu verwenden, setzen Sie AuthScheme Zu GCPInstanceAccount.

Erstellen einer benutzerdefinierten OAuth-App

Erstellen einer benutzerdefinierten OAuth-Anwendung

bettet OAuth-Anwendungsanmeldeinformationen mit Branding ein, die beim Herstellen einer Verbindung mit Google Cloud Storage über eine Desktopanwendung oder eine Headless-Maschine verwendet werden können.

(Informationen zum Abrufen und Festlegen der OAuthAccessToken und andere Konfigurationsparameter finden Sie im Abschnitt Desktop-Authentifizierung unter „Herstellen einer Verbindung mit Google Cloud Storage“.)

Sie müssen jedoch eine benutzerdefinierte OAuth-Anwendung erstellen, um über das Web eine Verbindung zu Google Cloud Storage herzustellen. Und da benutzerdefinierte OAuth-Anwendungen alle drei häufig verwendeten Authentifizierungsabläufe nahtlos unterstützen, möchten Sie für diese Authentifizierungsabläufe möglicherweise ohnehin benutzerdefinierte OAuth-Anwendungen erstellen (verwenden Sie Ihre eigenen OAuth-Anwendungsanmeldeinformationen).

Benutzerdefinierte OAuth-Anwendungen sind nützlich, wenn Sie:

• Steuerung des Brandings des Authentifizierungsdialogs
• Kontrollieren Sie die Umleitungs-URI, zu der die Anwendung den Benutzer nach der Authentifizierung umleitet.
• Passen Sie die Berechtigungen an, die Sie vom Benutzer anfordern

In den folgenden Abschnitten wird beschrieben, wie Sie die Directory-API aktivieren und benutzerdefinierte OAuth-Anwendungen für Benutzerkonten (OAuth) und Dienstkonten (OAuth/JWT) erstellen.

Aktivieren Sie die Cloud Storage API

Befolgen Sie diese Schritte, um die Cloud Storage API zu aktivieren:

1. Navigieren Sie zur Google Cloud Console.
2. Wählen Sie Library aus dem linken Navigationsmenü. Dies öffnet das Library Seite.
3. Geben Sie im Suchfeld „Cloud Storage API“ ein und wählen Sie Cloud Storage API aus den Suchergebnissen.
4. Auf der Cloud Storage API Seite, klick ENABLE.

Erstellen einer OAuth-Anwendung

Um benutzerdefinierte OAuth-Anwendungen zu erstellen, die die erforderlichen OAuth-Verbindungseigenschaften abrufen, befolgen Sie diese Verfahren.

Benutzerkonten (OAuth)

Für Benutzer, deren AuthScheme Ist OAuth und die sich über eine Webanwendung authentifizieren müssen, müssen Sie immer eine benutzerdefinierte OAuth-Anwendung erstellen. (Für Desktop- und Headless-Flows ist das Erstellen einer benutzerdefinierten OAuth-Anwendung optional.)

Gehen Sie folgendermaßen vor:

1. Navigieren Sie zur Google Cloud Console.
2. Erstellen Sie ein neues Projekt oder wählen Sie ein vorhandenes Projekt aus.
3. Wählen Sie im linken Navigationsmenü Credentials.
4. Wenn für dieses Projekt noch kein Zustimmungsbildschirm konfiguriert ist, klicken Sie auf CONFIGURE CONSENT SCREEN um eines zu erstellen. Wenn Sie kein Google Workspace-Konto verwenden, können Sie nur einen externen Zustimmungsbildschirm erstellen, für den Sie eine Support-Email und eine Email für den Entwickler angeben müssen. Weitere Informationen sind optional.
5. Auf der Credentials Seite, auswählen Create Credentials > OAuth Client ID.
6. Im Application Type Menü, auswählen Web application.
7. Geben Sie einen Namen für Ihre benutzerdefinierte OAuth-Anwendung an.
8. Unter Authorized redirect URIs, klick ADD URI und geben Sie eine Umleitungs-URI ein.
9. Klicken Sie auf Enter, Dann CREATE. Die Cloud Console führt Sie zurück zur Credentials Seite.
   Es öffnet sich ein Fenster, in dem Ihre Client-ID und Ihr Client-Geheimnis angezeigt werden.
10. Notieren Sie die Client-ID und das Client-Geheimnis zur späteren Verwendung als OAuthClientId Und OAuthClientSecret Verbindungseigenschaften.

Dienstkonten (OAuthJWT)

Dienstkonten (AuthScheme OAuthJWT) kann in einem OAuth-Flow verwendet werden, um auf Google APIs zuzugreifen im Namen von

Benutzer in einer Domäne. Ein Domänenadministrator kann domänenweiten Zugriff auf das Dienstkonto delegieren.

So erstellen Sie ein neues Dienstkonto:

1. Navigieren Sie zur Google Cloud Console.
2. Erstellen Sie ein neues Projekt oder wählen Sie ein vorhandenes Projekt aus.
3. Wählen Sie im linken Navigationsmenü Credentials.
4. Auswählen Create Credentials > Service account.
5. Auf der Create service account Seite, geben Sie den Dienstkontonamen, die Dienstkonto-ID und optional eine Beschreibung ein.
6. Klicken Sie auf DONE. Die Cloud Console zeigt erneut die Credentials Seite.
7. Im Service Accounts Abschnitt, wählen Sie das Servicekonto aus, das Sie gerade erstellt haben.
8. Klicken Sie auf KEYS Tab.
9. Klicken Sie auf ADD KEY > Create new key.
10. Wählen Sie einen unterstützten Schlüsseltyp aus (siehe OAuthJWTCert Und OAuthJWTCertType).
11. Klicken Sie auf CREATE. Der Schlüssel wird automatisch auf Ihr Gerät heruntergeladen und alle weiteren, für den Schlüssel spezifischen Informationen werden angezeigt.
12. Notieren Sie die zusätzlichen Informationen zur zukünftigen Verwendung.

Um den Servicekonto-Flow abzuschließen, generieren Sie einen privaten Schlüssel in der Google Cloud Console. Im Servicekonto-Flow tauscht der Treiber ein JSON Web Token (JWT) gegen das OAuthAccessToken. Der private Schlüssel ist zum Signieren des JWT erforderlich. Der Treiber verfügt über dieselben Berechtigungen wie das Dienstkonto.

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 Google Cloud Storage 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 einen möglichst großen Teil der Verarbeitung der SELECT-Anweisung auf Google Cloud Storage und verarbeitet den Rest der Abfrage dann im Speicher (clientseitig).

Benutzerdefinierte Ansichten

Mit dem Google Cloud Storage 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 Buckets WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Verwenden Sie die 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

In diesem Abschnitt wird beschrieben, wie der Connector die Google Cloud Storage API als relationale Ansichten und gespeicherte Prozeduren modelliert.

Hauptmerkmale

• Der Connector modelliert Google Cloud Storage Buckets, Bucket-Informationen und Objekte als relationale Ansichten, sodass Sie SQL schreiben können, um Google Cloud Storage Daten Abfrage.
• Mit gespeicherten Prozeduren können Sie Vorgänge in Google Cloud Storage ausführen, einschließlich des Herunterladens und Hochladens von Objekten.
• Die Live-Konnektivität zu diesen Objekten bedeutet, dass alle Änderungen an Ihrem Google Cloud Storage Konto bei Verwendung des Connectors sofort berücksichtigt werden.

Ansichten

Vordefinierte Ansichten sind für den schreibgeschützten Zugriff auf Daten aus Google Cloud Storage verfügbar, einschließlich Buckets, Bucket-Informationen und Objekten.

Gespeicherte Prozeduren

Mit gespeicherten Prozeduren können Sie Vorgänge in Google Cloud Storage ausführen, einschließlich des Herunterladens und Hochladens von Objekten.

Systemtabellen

Systemtabellen enthält Informationen zu den Objekten und Ressourcen, die zu Ihrer Datenbank gehören.

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.

Google Cloud Storage Connector-Ansichten

BucketACLs

Gibt Informationen zu ACLs eines bestimmten Buckets zurück.

Tabellenspezifische Informationen

Wählen

Der Connector verwendet die Google Cloud Storage API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Bucket unterstützt die Vergleiche '=,LIKE'.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM BucketACLs WHERE Bucket = 'TestBucket'

Spalten

EimerCORS

Gibt Informationen für CORS eines bestimmten Buckets zurück.

Tabellenspezifische Informationen

Wählen

Der Connector verwendet die Google Cloud Storage API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Bucket unterstützt die Vergleiche '=,LIKE'.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM BucketCORS WHERE Bucket = 'TestBucket'

Spalten

BucketLebenszyklus

Gibt Informationen zum Lebenszyklus eines bestimmten Buckets zurück.

Tabellenspezifische Informationen

Wählen

Der Connector verwendet die Google Cloud Storage API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Bucket unterstützt die Vergleiche '=,LIKE'.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM BucketLifecycle WHERE Bucket = 'TestBucket'

Spalten

Eimer

Gibt Informationen für Buckets zurück. Buckets werden zum Speichern von Objekten verwendet, die aus Daten und deren Metadaten bestehen.

Tabellenspezifische Informationen

Wählen

Der Connector verwendet die Google Cloud Storage API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Name unterstützt die Vergleiche '=,LIKE'.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Buckets WHERE Name = 'TestBucket'

Spalten

Objekt-ACLs

Gibt Informationen zu ACLs eines bestimmten Objekts zurück.

Tabellenspezifische Informationen

Wählen

Der Connector verwendet die Google Cloud Storage API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Object unterstützt die '=,LIKE'-Vergleiche.
• Bucket unterstützt den '='-Vergleich.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM ObjectACLs WHERE Object = 'TestObject'

SELECT * FROM ObjectACLs WHERE Bucket = 'TestBucket'

SELECT * FROM ObjectACLs WHERE Object = 'TestObject' AND Bucket = 'TestBucket'

Spalten

Objekte

Gibt Informationen zu Objekten innerhalb eines bestimmten Buckets zurück.

Tabellenspezifische Informationen

Wählen

Der Connector verwendet die Google Cloud Storage API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Name unterstützt die '=,LIKE'-Vergleiche.
• Bucket unterstützt den '='-Vergleich.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM Objects WHERE Name = 'TestObject'

SELECT * FROM Objects WHERE Bucket = 'TestBucket'

SELECT * FROM Objects WHERE Name LIKE 'Test%' AND Bucket = 'TestBucket'

Spalten

Objektversionen

Gibt Informationen zu Objektversionen innerhalb eines bestimmten Buckets zurück.

Tabellenspezifische Informationen

Wählen

Der Connector verwendet die Google Cloud Storage API, um WHERE-Klauselbedingungen zu verarbeiten, die mit der folgenden Spalte und dem folgenden Operator erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

• Bucket unterstützt den '='-Vergleich.
• Name unterstützt den '='-Vergleich.

Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:

SELECT * FROM ObjectVersions WHERE Name = 'TestName'

SELECT * FROM ObjectVersions WHERE Bucket = 'TestBucket'

Spalten

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT-Operationen mit Google Cloud Storage hinaus erweitern.

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

Gespeicherte Prozeduren im Google Cloud Storage Connector

Objekt kopieren

Kopiert ein Objekt von einem Bucket in einen anderen.

Eingang

Ergebnissatzspalten

Eimer erstellen

Erstellt einen Bucket. Der authentifizierte Benutzer muss über die IAM-Berechtigung storage.buckets.create verfügen, um diese StoredProcedure verwenden zu können.

Eingang

Ergebnissatzspalten

Objekt löschen

Löscht ein Objekt aus einem Bucket.

Eingang

Ergebnissatzspalten

Objekt herunterladen

Gibt den Namen eines Buckets und eines herunterzuladenden Objekts weiter.

Eingang

Ergebnissatzspalten

Versionierung aktivieren

Aktiviert die Objektversionierung in einem bestimmten Bucket.

Eingang

Ergebnissatzspalten

GetOAuthAccessToken

Erhält den OAuth-Zugriffstoken, der zur Authentifizierung bei verschiedenen Google-Diensten verwendet werden soll.

Eingang

Ergebnissatzspalten

GetOAuthAuthorizationURL

Ruft die OAuth-Autorisierungs URL ab, die für die Authentifizierung bei verschiedenen Google-Diensten verwendet wird.

Eingang

Ergebnissatzspalten

Objekt verschieben

Verschiebt ein Objekt von einem Bucket in einen anderen.

Eingang

Ergebnissatzspalten

Aktualisieren Sie das OAuthAccessToken

Erhält den OAuth-Zugriffstoken, der zur Authentifizierung bei verschiedenen Google-Diensten verwendet werden soll.

Eingang

Ergebnissatzspalten

URL unterzeichnen

Lädt Objekte in einem einzigen Operation hoch. Verwenden Sie die Verbindungseigenschaft SimpleUploadLimit, um den Schwellenwert in Bytes anzupassen und einen mehrteiligen Upload durchzuführen.

• storage.objects.create (ermöglicht Ihnen, eine signierte URL zum Hochladen eines Objekts zu erstellen)
• storage.objects.get (ermöglicht Ihnen, eine signierte URL zum Herunterladen des Objekts zu erstellen)

Eingang

Ergebnissatzspalten

Objekt hochladen

Lädt Objekte in einem einzigen Operation hoch. Verwenden Sie die Verbindungseigenschaft SimpleUploadLimit, um den Schwellenwert in Bytes anzupassen und einen mehrteiligen Upload durchzuführen.

Ausführen

Der Treiber verwendet #TEMP-Tabellen als Felder für die eingegebenen aggregierten Informationen

Ihre Abfrage muss Folgendes enthalten:

INSERT INTO ObjectInformationAggregate#TEMP (LocalFilePath) VALUES ('C:/amazons3/test/testfile.txt')

Wenn Sie eine Liste von Dateien angeben, können Sie zusätzlich den Wert von ContentType festlegen:

INSERT INTO ObjectInformationAggregate#TEMP (LocalFilePath, ContentType) VALUES ('C:/amazons3/test/testfile.txt', 'text/plain')

Anschließend führen Sie die Prozedur aus, indem Sie den Wert von ObjectInformationAggregate mit dem Namen der verwendeten #TEMP-Tabelle ObjectInformationAggregate#TEMP angeben.

EXEC UploadObject ObjectInformationAggregate = 'ObjectInformationAggregate#TEMP'

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 Google Cloud Storage 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 Schemas 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 Buckets-Tabelle zurück:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Buckets'

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 DownloadObject zurück:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='DownloadObject' 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 Buckets-Tabelle ab:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Buckets'

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:googlecloudstorage: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

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

OAuth

JWT OAuth

SSL

Schema

Verschiedenes

Authentifizierung

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

AuthScheme

Der Authentifizierungstyp, der bei der Verbindung mit Google Cloud Storage verwendet werden soll.

Mögliche Werte

Auto, OAuth, OAuthJWT, GCPInstanceAccount

Datentyp

string

Standardwert

Auto

Hinweise

• Automatisch: Lässt den Treiber automatisch basierend auf den anderen von Ihnen festgelegten Verbindungseigenschaften entscheiden.
• OAuth: Legen Sie diese Option fest, um die OAuth-Authentifizierung mit einem Standardbenutzerkonto durchzuführen.
• OAuthJWT: Legen Sie dies fest, um die OAuth-Authentifizierung mit einem OAuth-Dienstkonto durchzuführen.
• GCPInstanceAccount: Legen Sie dies fest, um einen Zugriffstoken von der Google Cloud Platform-Instanz zu erhalten.

ProjektID

Die ID des Projekts, in dem sich Ihre Google Cloud Storage Instanz befindet.

Datentyp

string

Standardwert

""

Hinweise

Die ID des Projekts, in dem sich Ihre Google Cloud Storage Instanz befindet. Sie finden diesen Wert, indem Sie zur Google Cloud Console gehen und oben links auf dem Bildschirm auf den Projektnamen klicken. Die Projekt-ID wird in der ID-Spalte des entsprechenden Projekts angezeigt.

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

OFF

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.

OAuthClientId

Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.

Datentyp

string

Standardwert

""

Hinweise

Im Rahmen der Registrierung einer OAuth-Anwendung erhalten Sie die OAuthClientId-Wert, manchmal auch Consumer-Schlüssel genannt, und ein Client-Geheimnis, das OAuthClientSecret.

OAuthClientSecret

Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.

Datentyp

string

Standardwert

""

Hinweise

Im Rahmen der Registrierung einer OAuth-Anwendung erhalten Sie die OAuthClientId, auch Consumer-Schlüssel genannt. Sie erhalten außerdem ein Client-Geheimnis, auch Consumer-Geheimnis genannt. Legen Sie das Client-Geheimnis im OAuthClientSecret Eigentum.

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%\CData\Acumatica Data Provider\OAuthSettings.txt

Hinweise

Wenn InitiateOAuth ist auf gesetzt GETANDREFRESH oder REFRESH, der Treiber 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 auch den Speicherort angeben. Speicherorte werden durch einen Wert angegeben, der mit '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 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_propsSystemtabelle. Wenn mehrere Verbindungen mit denselben Anmeldeinformationen bestehen, werden die Eigenschaften aus der zuvor geschlossenen Verbindung gelesen.

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

• Windows: "register://%DSN"
• Unix: "%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:

Rückruf-URL

Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.

Datentyp

string

Standardwert

http://127.0.0.1/

Hinweise

Während des Authentifizierungsprozesses leitet der OAuth-Autorisierungsserver den Benutzer an diese URL weiter. Dieser Wert muss mit der Rückruf URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.

OAuthVerifier

Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode.

Datentyp

string

Standardwert

""

Hinweise

Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode. Dieser kann auf Systemen verwendet werden, auf denen kein Browser gestartet werden kann, z. B. auf Headless-Systemen.

Authentifizierung auf Headless-Maschinen

Siehe, um die zu erhalten OAuthVerifier Wert.

OAuthSettingsLocation festlegen zusammen mit OAuthVerifier. Beim Verbinden tauscht der Connector die OAuthVerifier für die OAuth-Authentifizierungstoken und speichert sie verschlüsselt am angegebenen Speicherort. Setzen Sie InitiateOAuth zu GETANDREFRESH, um den Austausch zu automatisieren.

Sobald die OAuth-Einstellungsdatei generiert wurde, können Sie entfernen OAuthVerifier aus den Verbindungseigenschaften und verbinden Sie sich mit OAuthSettingsLocation festgelegt.

Um die OAuth-Tokenwerte automatisch zu aktualisieren, legen Sie OAuthSettingsLocation fest und setzen Sie zusätzlich InitiateOAuth zum AKTUALISIEREN.

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.

OAuthLäuftAbIn

Die Lebensdauer des OAuth AccessToken in Sekunden.

Datentyp

string

Standardwert

""

Hinweise

Mit OAuthTokenTimestamp kombinieren, um zu bestimmen, wann der AccessToken abläuft.

OAuthTokenTimestamp

Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde.

Datentyp

string

Standardwert

""

Hinweise

Kombinieren Sie es mit OAuthExpiresIn, um zu bestimmen, wann das AccessToken abläuft.

JWT OAuth

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

OAuthJWTCert

Der JWT-Zertifikatspeicher.

Datentyp

string

Standardwert

""

Hinweise

Der Name des Zertifikatspeichers für das Client-Zertifikat.

Der OAuthJWTCertType Feld gibt den Typ des durch angegebenen Zertifikatspeichers an OAuthJWTCert. Wenn der Store kennwortgeschützt ist, geben Sie das Kennwort in OAuthJWTCertPassword an.

OAuthJWTCert wird in Verbindung mit OAuthJWTCertSubject verwendet

Feld, um Client-Zertifikate anzugeben. Wenn OAuthJWTCert hat einen Wert und OAuthJWTCertSubject gesetzt ist, wird eine Suche nach einem Zertifikat eingeleitet. Bitte beachten Sie das OAuthJWTCertSubject für weitere Einzelheiten.

Die Bezeichnungen der Zertifikatsspeicher sind plattformabhängig.

Nachfolgend sind die Bezeichnungen der gebräuchlichsten Benutzer- und Maschinen-Zertifikatspeicher in Windows aufgeführt:

In Java ist der Zertifikatsspeicher normalerweise eine Datei, die Zertifikate und optionale private Schlüssel enthält.

Wenn der Zertifikatsspeichertyp PFXFile ist, muss diese Eigenschaft auf den Namen der Datei gesetzt werden. Wenn der Typ PFXBlob ist, muss die Eigenschaft auf den binären Inhalt einer PFX-Datei (d. h. PKCS12-Zertifikatsspeicher) gesetzt werden.

OAuthJWTCertType

Der Typ des Schlüsselspeichers, der das JWT-Zertifikat enthält.

Datentyp

string

Standardwert

USER

Hinweise

Diese Eigenschaft kann einen der folgenden Werte annehmen:

OAuthJWTCertPasswort

Das Passwort für das OAuth JWT-Zertifikat.

Datentyp

string

Standardwert

""

Hinweise

Wenn der Zertifikatspeicher von einem Typ ist, der ein Passwort erfordert, wird diese Eigenschaft verwendet, um dieses Passwort anzugeben, damit der Zertifikatspeicher geöffnet werden kann.

Dies ist nicht erforderlich, wenn GOOGLEJSON OAuthJWTCertType verwendet wird. Google JSON-Schlüssel sind nicht verschlüsselt.

OAuthJWTCertSubject

Der Betreff des OAuth JWT-Zertifikats.

Datentyp

string

Standardwert

*

Hinweise

Beim Laden eines Zertifikats wird der Betreff verwendet, um das Zertifikat im Speicher zu lokalisieren.

Wenn keine genaue Übereinstimmung gefunden wird, wird der Speicher nach Betreffs durchsucht, die den Wert der Eigenschaft enthalten.

Wenn immer noch keine Übereinstimmung gefunden wird, wird die Eigenschaft auf eine leere Zeichenfolge gesetzt und kein Zertifikat ausgewählt.

Der spezielle Wert „*“ wählt das erste Zertifikat im Zertifikatspeicher aus.

Der Betreff des Zertifikats ist eine durch Kommas getrennte Liste von Distinguished Name-Feldern und-Werten. Zum Beispiel „CN=www.server.com, OU=test, C=US, E=example@jbexample.com“. Allgemeine Felder und ihre Bedeutungen werden unten angezeigt.

Wenn ein Feldwert ein Komma enthält, muss es in Anführungszeichen gesetzt werden.

OAuthJWTIssuisse

Der Herausgeber des Java Web Token.

Datentyp

string

Standardwert

""

Hinweise

Der Aussteller des Java Web Token. Geben Sie den Wert der Email Adresse eines delegierten Benutzers ein.

Dies ist bei Verwendung des GOOGLEJSON OAuthJWTCertType nicht erforderlich. Google JSON-Schlüssel enthalten eine Kopie des Ausstellerkontos.

Der Aussteller des Java Web Token. Geben Sie den Wert der Email Adresse eines delegierten Benutzers ein.

Dies ist bei Verwendung des GOOGLEJSON OAuthJWTCertType nicht erforderlich. Google JSON-Schlüssel enthalten eine Kopie des Ausstellerkontos.

OAuthJWT-Betreff

Das Benutzersubjekt, für das die Anwendung delegierten Zugriff anfordert.

Datentyp

string

Standardwert

""

Hinweise

Der Benutzer, für den die Anwendung delegierten Zugriff anfordert. Geben Sie den Wert der Email Adresse des Dienstkontos ein.

Der Benutzer, für den die Anwendung delegierten Zugriff anfordert. Geben Sie den Wert der Email Adresse des Dienstkontos ein.

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 per 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%\Google Cloud Storage 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 Die Eigenschaft wird nur benötigt, wenn Sie Definitionen anpassen (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%\ Google Cloud Storage 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.

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

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. „*=*“.

SimpleUploadLimit

Diese Einstellung gibt den Schwellenwert in Bytes an, oberhalb dessen der Anbieter einen mehrteiligen Upload durchführt, anstatt alles in einer Anfrage hochzuladen.

Datentyp

string

Standardwert

5242880

Hinweise

Der Standardwert beträgt 5242880 Bytes. Der Mindestwert für diese Eigenschaft beträgt 262144 Bytes.

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 Buckets 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.