Details zur Google Directory Verbindung
Einführung
Connector-Version
Diese Dokumentation basiert auf Version 23.0.8804 des Connectors.
Erste Schritte
Versionsunterstützung für Google Directory
Herstellen einer Verbindung
Authentifizieren beim Google Directory
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 Directory 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-Anwendung 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 aufGETANDREFRESH
, 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 Directory registrieren. Anschließend können Sie den Connector verwenden, um die OAuth-Tokenwerte abzurufen und zu verwalten. Siehe Erstellen einer benutzerdefinierten OAuth-Anwendung für weitere Informationen zu benutzerdefinierten Anwendungen.
Holen Sie sich ein OAuth-Zugriffstoken
Legen Sie die folgenden Verbindungseigenschaften fest, um das zu erhalten OAuthAccessToken
:
OAuthClientId
: Stellen Sie dies in Ihren Anwendungseinstellungen auf die Client-ID ein.OAuthClientSecret
: Legen Sie dies in Ihren Anwendungseinstellungen auf das Client-Geheimnis fest.
Rufen Sie dann gespeicherte Prozeduren auf, um den OAuth-Austausch abzuschließen:
- 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.
- 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.
- 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 aufREFRESH
.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.
- Wählen Sie eine von zwei Optionen:
- Option 1: Erhalten Sie die
OAuthVerifier
Wert 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.
- Option 1: Erhalten Sie die
- 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.
Führen Sie die folgenden Schritte aus, um sich vom Computer aus mit einem Internetbrowser zu authentifizieren und die OAuthVerifier
Verbindungseigenschaft.
-
Wählen Sie eine dieser Optionen:
-
Wenn Sie die eingebettete OAuth-Anwendung verwenden, klicken Sie auf Google Directory 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 setzenOFF
.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.
-
Tauschen Sie als Nächstes den OAuth-Verifiziercode gegen OAuth-Aktualisierungs- und Zugriffstoken aus. Legen Sie die folgenden Eigenschaften fest:
Legen Sie auf der Headless-Maschine die folgenden Verbindungseigenschaften fest, um die OAuth-Authentifizierungswerte abzurufen:
InitiateOAuth
: Setzen Sie dies aufREFRESH
.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, setzen Sie die folgenden Eigenschaften zurück, um eine Verbindung herzustellen:
InitiateOAuth
: Setzen Sie dies aufREFRESH
.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 aufREFRESH
.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-Anwendung folgen.
Legen Sie für eine JSON-Datei diese Eigenschaften fest:
AuthScheme
: Setzen Sie dies aufOAuthJWT
.InitiateOAuth
: Setzen Sie dies aufGETANDREFRESH
.OAuthJWTCertType
: Setzen Sie dies aufGOOGLEJSON
.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 diese Eigenschaften fest:
AuthScheme
: Setzen Sie dies aufOAuthJWT
.InitiateOAuth
: Setzen Sie dies aufGETANDREFRESH
.OAuthJWTCertType
: Setzen Sie dies aufPFXFILE
.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 verwendenOAuthJWTCertType
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äneiam.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-Anwendung
Erstellen einer benutzerdefinierten OAuth-Anwendung
bettet OAuth-Anwendungsanmeldeinformationen mit Branding ein, die beim Herstellen einer Verbindung mit Google Directory ü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 zum Google Directory“.)
Sie müssen jedoch eine benutzerdefinierte OAuth-Anwendung erstellen, um über das Web eine Verbindung zum Google Directory 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
- Führen Sie CUD-Operationen durch, indem Sie eine benutzerdefinierte OAuth-App mit den erforderlichen Bereichen erstellen und dieselben Bereiche über die Verbindungseigenschaft „Bereich“ übergeben.
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 der Directory API
Befolgen Sie diese Schritte, um die Directory API zu aktivieren:
- Navigieren Sie zur Google Cloud Console.
- Wählen Sie
Library
aus dem linken Navigationsmenü. Dies öffnet dasLibrary
Seite. - Geben Sie im Suchfeld „Directory API“ ein und wählen Sie
Directory API
aus den Suchergebnissen. - Auf der
Directory API
Seite, klickENABLE
.
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:
- Navigieren Sie zur Google Cloud Console.
- Erstellen Sie ein neues Projekt oder wählen Sie ein vorhandenes Projekt aus.
- Wählen Sie im linken Navigationsmenü
Credentials
. - 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. - Auf der
Credentials
Seite, auswählenCreate Credentials > OAuth Client ID
. - Im
Application Type
Menü, auswählenWeb application
. - Geben Sie einen Namen für Ihre benutzerdefinierte OAuth-Anwendung an.
- Unter
Authorized redirect URIs
, klickADD URI
und geben Sie eine Umleitungs-URI ein. - Klicken Sie auf
Enter
, DannCREATE
. Die Cloud Console führt Sie zurück zurCredentials
Seite.
Es öffnet sich ein Fenster, in dem Ihre Client-ID und Ihr Client-Geheimnis angezeigt werden. - Notieren Sie die Client-ID und das Client-Geheimnis zur späteren Verwendung als
OAuthClientId
UndOAuthClientSecret
Verbindungseigenschaften.
Hinweis
Das Client-Geheimnis bleibt über die Google Cloud Console zugänglich.
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:
- Navigieren Sie zur Google Cloud Console.
- Erstellen Sie ein neues Projekt oder wählen Sie ein vorhandenes Projekt aus.
- Wählen Sie im linken Navigationsmenü
Credentials
. - Auswählen
Create Credentials > Service account
. - Auf der
Create service account
Seite, geben Sie den Dienstkontonamen, die Dienstkonto-ID und optional eine Beschreibung ein. - Klicken Sie auf
DONE
. Die Cloud Console zeigt erneut dieCredentials
Seite. - Im
Service Accounts
Abschnitt, wählen Sie das Servicekonto aus, das Sie gerade erstellt haben. - Klicken Sie auf
KEYS
Tab. - Klicken Sie auf
ADD KEY > Create new key
. - Wählen Sie einen unterstützten Schlüsseltyp aus (siehe
OAuthJWTCert
UndOAuthJWTCertType
). - 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. - 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 Directory 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 das Google Directory und verarbeitet den Rest der Abfrage dann im Speicher (clientseitig).
Benutzerdefinierte Ansichten
Mit dem Google Directory 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 Group 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
Der Google Directory Connector modelliert Google Directory APIs als relationale Tabellen, Ansichten und gespeicherte Prozeduren. API Einschränkungen und-Anforderungen für die verfügbaren Objekte sind in diesem Abschnitt dokumentiert.
Tabellen
Der Connector-Anbieter modelliert die Google Directory API als relationale Tabellen.
Ansichten
Ansichten bieten zusätzliche Informationen aus dem Google Directory.
Gespeicherte Prozeduren
Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zur Datenquelle.
Tabellen
Der Connector modelliert die Daten im Google Directory als Liste von Tabellen in einer relationalen Datenbank, die mit Standard-SQL-Anweisungen abgefragt werden können.
Google Directory Connector-Tabellen
Name | Beschreibung |
---|---|
ChromeOsDevices | Alle Chrome Geräte für ein Konto abrufen. |
DomainAliases | Aliase einer Domäne erstellen, aktualisieren und Abfrage. |
Domains | Domänen für einen Benutzer erstellen, löschen und Abfrage. |
GroupAliases | Aliase für eine Gruppe erstellen, löschen und Abfrage. |
GroupMembers | Mitglieder für eine Gruppe erstellen, aktualisieren, löschen und Abfrage. |
Groups | Gruppen erstellen, aktualisieren, löschen und Abfrage. |
Notifications | Benachrichtigungen für einen Kunden aktualisieren, löschen und Abfrage. |
OrganizationUnits | Organisationseinheiten für einen Kunden erstellen, aktualisieren, löschen und Abfrage. |
RoleAssignments | Benutzern zugewiesene Rollen erstellen, löschen und Abfrage. |
Tokens | Token für einen Benutzer abfragen und löschen. |
UserAliases | Listet Aliase auf, bei denen es sich um alternative Email Adressen für einen Benutzer handelt. |
Users | Benutzerinformationen abfragen. |
ChromeOS-Geräte
Rufen Sie alle Chrome Geräte für ein Konto ab.
Tabellenspezifische Informationen
Wählen
Um eine Liste aller Chrome Geräte für ein Konto zu erhalten, ist die Spalte CustomerId erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Wenn sie nicht angegeben ist, wird die CustomerId des aktuellen Kontos verwendet.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM ChromeOsDevices
EINFÜGEN
INSERTs werden für diese Tabelle nicht unterstützt.
Aktualisieren
Aktualisiert die Eigenschaften „annotatedUser“, „annotatedLocation“ oder „notes“ eines Geräts. Zum Aktualisieren einer Benachrichtigung sind die folgenden Spalten erforderlich: CustomerId und Id. Wenn nicht angegeben, wird die CustomerId des aktuellen Kontos verwendet.
UPDATE ChromeOsDevices SET AnnotatedUser = 'User_2' WHERE ID = '12345' AND CustomerId = '1234'.
Löschen
Löschvorgänge werden für diese Tabelle nicht unterstützt.
Spalten
Name | Typ | Nur Lesen | Beschreibung |
---|---|---|---|
Id [KEY] | String | True | Die eindeutige ID des Chrome Geräts. |
SerialNumber | String | True | Die Seriennummer des Chrome-Geräts, die bei der Aktivierung des Geräts eingegeben wurde. Dieser Wert ist derselbe wie die Seriennummer der Admin-Konsole auf der Tab „Chrome OS-Geräte“. |
Model | String | True | Die Modellinformationen des Geräts. Wenn das Gerät diese Informationen nicht hat, ist diese Eigenschaft nicht in der Antwort enthalten. |
MEID | String | True | Der Mobile Equipment Identifier (MEID) für die 3G-Mobilfunkkarte in einem Mobilgerät. Ein MEID wird normalerweise verwendet, wenn ein Gerät zum Postpaid-Serviceplan eines Mobilfunkanbieters hinzugefügt wird. Wenn das Gerät diese Informationen nicht hat, ist diese Eigenschaft nicht in der Antwort enthalten. |
LastSync | Datetime | True | Datum und Uhrzeit der letzten Registrierung des Geräts. |
AnnotatedUser | String | Falsch | Der vom Administrator angegebene Benutzer des Geräts. Die maximale Länge beträgt 100 Zeichen. Leere Werte sind zulässig. |
AnnotatedLocation | String | Falsch | Die vom Administrator angegebene Adresse oder der Standort des Geräts. Die maximale Länge beträgt 200 Zeichen. Leere Werte sind zulässig. |
AnnotatedAssetId | String | Falsch | Die Anlagenkennung, wie sie von einem Administrator notiert oder während der Registrierung angegeben wurde. |
Notes | String | Falsch | Vom Administrator hinzugefügte Hinweise zu diesem Gerät. Diese Eigenschaft kann mit dem Abfrage der Listenmethode gesucht werden. Die maximale Länge beträgt 500 Zeichen. Leere Werte sind zulässig. |
OrgUnitPath | String | Falsch | Der vollständige übergeordnete Pfad mit dem Namen der Organisationseinheit, die dem Gerät zugeordnet ist. Bei Pfadnamen wird die Groß-/Kleinschreibung nicht berücksichtigt. Wenn die übergeordnete Organisationseinheit die Organisation der obersten Ebene ist, wird sie als Schrägstrich / dargestellt. Diese Eigenschaft kann mithilfe der API aktualisiert werden |
OrderNumber | String | True | Die Bestellnummer des Geräts. Nur direkt bei Google gekaufte Geräte haben eine Bestellnummer. |
MacAddress | String | True | Die drahtlose MAC-Adresse des Geräts. Wenn das Gerät diese Informationen nicht hat, werden sie nicht in die Antwort aufgenommen. |
WillAutoRenew | Boolean | True | Legt fest, ob der Support für das Gerät nach dem Support-Enddatum automatisch verlängert wird. Dies ist eine schreibgeschützte Eigenschaft. |
OsVersion | String | True | Die Operationssystemversion des Chrome Geräts. |
PlatformVersion | String | True | Die Plattformversion des Chrome Geräts. |
FirmwareVersion | String | True | Die Firmware-Version des Chrome Geräts. |
BootMode | String | True | Der Startmodus für das Gerät. |
LastEnrollmentTime | String | True | Datum und Uhrzeit der letzten Registrierung des Geräts. |
TmpVersionInfoAggr | String | Wahr | Trusted Platform Module (TPM). |
ActiveTimeRangesAggr | String | True | Liste der aktiven Zeitbereiche. |
RecentUsersAggr | String | True | Liste der letzten Gerätebenutzer in absteigender Reihenfolge nach der letzten Anmeldezeit. |
DeviceFilesAggr | String | True | Liste der herunterzuladenden Gerätedateien. |
ETag | String | True | ETag der Ressource. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
CustomerId | String | ID des Kunden |
Domänen-Aliase
Erstellen, aktualisieren und Abfrage Aliase einer Domäne ab.
Tabellenspezifische Informationen
Wählen
Um eine Liste aller Aliase für eine Domäne zu erhalten, ist die Spalte CustomerId erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Wenn sie nicht angegeben ist, wird die CustomerId des aktuellen Kontos verwendet.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM DomainAliases
Einfügen
Zum Einfügen eines Alias sind folgende Spalten erforderlich: CustomerId, ParentDomain und DomainAliasName.
INSERT INTO DomainAliases (CustomerId, DomainAliasName, ParentDomain) VALUES ('12345', 'Alias', 'parentdomain.com')
Aktualisieren
UPDATES werden für diese Tabelle nicht unterstützt.
Löschen
Zum Löschen eines Alias sind folgende Spalten erforderlich: CustomerId und DomainAliasName.
DELETE FROM DomainAliases WHERE CustomerId = 'C020vaw0q' AND DomainAliasName = 'Alias'
Spalten
Name | Typ | Nur Lesen | Beschreibung |
---|---|---|---|
DomainAliasName [KEY] | String | Falsch | Der Domänen-Aliasname. |
ParentDomain | String | Falsch | Der übergeordnete Domänenname, mit dem der Domänenalias verknüpft ist. |
IsVerified | Boolean | True | Gibt den Verifizierungsstatus eines Domänenalias an. |
CreationDate | Timestamp | True | Zeitstempel des Erstellungsdatums des Domänenalias in Millisekunden. |
ETag | String | True | ETag der Ressource |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
CustomerId | String | ID des Kunden |
Domänen
Erstellen, löschen und Abfrage die Domänen für einen Benutzer.
Tabellenspezifische Informationen
Wählen
Um eine Liste aller Domänen zu erhalten, ist die Spalte CustomerId erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Wenn sie nicht angegeben wird, wird die CustomerId des aktuellen Kontos verwendet, wie in der folgenden Abfrage.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM Domains
Einfügen
Zum Einfügen einer Domain sind folgende Spalten erforderlich: CustomerId und DomainName.
INSERT INTO Domains (CustomerId, DomainName) VALUES ('12345', 'exampledomain.com')
Aktualisieren
UPDATES werden für diese Tabelle nicht unterstützt.
Löschen
Zum Löschen einer Domain ist die Spalte DomainName erforderlich.
DELETE FROM Domains WHERE DomainName = 'exampledomain.com'
Spalten
Name | Typ | Nur Lesen | Beschreibung |
---|---|---|---|
DomainName [KEY] | String | Falsch | Der Domänenname. |
IsPrimary | Boolean | True | Gibt an, ob die Domäne eine primäre Domäne ist. |
IsVerified | Boolean | True | Gibt den Verifizierungsstatus einer Domäne an. |
CreationDate | Datetime | True | Das Erstellungsdatum der Domäne. |
Aliases | String | True | Die Aliase der Domäne. |
ETag | String | True | ETag der Ressource. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
CustomerId | String | ID des Kunden |
Gruppenaliase
Erstellen, löschen und Abfrage Aliase für eine Gruppe.
Tabellenspezifische Informationen
Wählen
Um eine Liste aller Aliase für eine Gruppe zu erhalten, ist die Spalte GroupId erforderlich. Wenn sie nicht angegeben ist, wird die GroupId der ersten Gruppe aus der Gruppentabelle verwendet.
Die folgende Abfrage zeigt den einzigen Filter, der serverseitig von der Google Directory API verarbeitet wird:
SELECT * FROM GroupAliases WHERE GroupId = '12345'
Einfügen
Um einen Alias einzufügen, sind folgende Spalten erforderlich: GroupId und Alias.
INSERT INTO GroupAliases (GroupId, Alias) VALUES ('12345', 'Alias')
Aktualisieren
UPDATES werden für diese Tabelle nicht unterstützt.
Löschen
Zum Löschen eines Alias sind folgende Spalten erforderlich: GroupId und Alias.
DELETE FROM GroupAliases WHERE GroupId = '12345' AND Alias = 'Alias'
Spalten
Name | Typ | Nur Lesen | Beschreibung |
---|---|---|---|
Alias [KEY] | String | Falsch | Die Alias-Email Adresse. |
GroupId | String | True | ID der Gruppe. |
PrimaryEmail | String | True | Primäre E-Mail-Adresse der Gruppe. |
ETag | String | True | ETag der Ressource. |
Gruppenmitglieder
Erstellen, aktualisieren, löschen und Abfrage die Mitglieder einer Gruppe ab.
Tabellenspezifische Informationen
Wählen
Um eine Liste aller Mitglieder einer Gruppe zu erhalten, ist die Spalte GroupId erforderlich. Wenn sie nicht angegeben ist, wird die ID der ersten Gruppe aus der Tabelle „Groups“ verwendet.
Die folgende Abfrage zeigt den einzigen Filter, der serverseitig von der Google Directory API verarbeitet wird:
SELECT * FROM GroupMembers WHERE GroupId = '12345'
Einfügen
Zum Einfügen eines Mitglieds sind die folgenden Spalten erforderlich: Email und Gruppen-ID. Die Spalte „Rolle“ akzeptiert nur die folgenden Werte: MITGLIED, MANAGER und EIGENTÜMER.
INSERT INTO GroupMembers (Email, GroupId, Role) VALUES ('john@example.com', '12345', 'MEMBER')
Aktualisieren
Um ein Mitglied zu aktualisieren, sind die folgenden Spalten erforderlich: GroupId und Id.
UPDATE GroupMembers SET Role = 'MEMBER' WHERE GroupId = '1234' AND ID = '12345'
Löschen
Zum Löschen eines Mitglieds sind folgende Spalten erforderlich: GroupId und Id.
DELETE FROM GroupMembers WHERE GroupId = '1234' AND ID = '12345'
Spalten
Name | Typ | Nur Lesen | Beschreibung |
---|---|---|---|
Id [KEY] | String | Falsch | Die eindeutige Kennung für das Mitglied. |
GroupId | String | True | Die eindeutige Kennung für das Mitglied. |
Email | String | Falsch | Die Email des Mitglieds. |
Role | String | Falsch | Der Name des Mitglieds. |
Status | String | True | Der Status des Mitglieds. |
Type | String | True | Der Typ der Mitglieder. |
ETag | String | True | ETag der Ressource |
Gruppen
Gruppen erstellen, aktualisieren, löschen und Abfrage.
Tabellenspezifische Informationen
Wählen
Um eine Liste aller Gruppen zu erhalten, ist die CustomerId erforderlich. Sie können sie entweder in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festlegen. Wenn sie nicht angegeben ist, wird die CustomerId des aktuellen Kontos verwendet.
Beispielsweise wird die folgende Abfrage serverseitig von der Google Directory API verarbeitet:
SELECT * FROM Groups
Einfügen
Zum Einfügen einer Gruppe ist die Spalte „Email“ erforderlich.
INSERT INTO Groups (Email, Name, Description) VALUES ('group@example.com', 'Group Example Name', 'Example Description')
Aktualisieren
Zum Aktualisieren einer Gruppe ist die ID erforderlich.
UPDATE Groups SET Email = 'group@example.com', Name = 'Group', Description = 'Description' WHERE ID = 1231
Löschen
Zum Löschen einer Gruppe ist die ID-Spalte erforderlich.
DELETE FROM Groups WHERE ID = '12345'
Spalten
Name | Typ | Nur Lesen | Beschreibung |
---|---|---|---|
Id [KEY] | String | True | Die eindeutige Kennung für die Gruppe. |
Email | String | Falsch | Die Email der Gruppe. |
Name | String | Falsch | Der Name der Gruppe. |
MembersCount | Long | True | Die Anzahl der Mitglieder. |
Description | String | Falsch | Beschreibung der Gruppe. |
Aliases | String | True | Aliase der Gruppe. |
AdminCreated | Boolean | True | Gibt an, ob die Gruppe von einem Administrator erstellt wurde. |
ETag | String | True | ETag der Ressource |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
CustomerId | String | Die Kunden-ID der Gruppe. |
Domain | String | Domänenname. |
Benachrichtigungen
Benachrichtigungen für einen Kunden aktualisieren, löschen und Abfrage.
Tabellenspezifische Informationen
Wählen
Um eine Liste aller Benachrichtigungen zu erhalten, ist die Spalte CustomerId erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Wenn sie nicht angegeben ist, wird die CustomerId des aktuellen Kontos verwendet.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM Notifications
EINFÜGEN
INSERTs werden für diese Tabelle nicht unterstützt.
Aktualisieren
Um eine Benachrichtigung zu aktualisieren, sind folgende Spalten erforderlich: CustomerId und Id. Wenn nicht angegeben, wird die CustomerId des aktuellen Kontos verwendet.
UPDATE Notifications SET IsUnread = true WHERE ID = '12345' AND CustomerId = '1234'.
Löschen
Zum Löschen einer Benachrichtigung sind folgende Spalten erforderlich: CustomerId und Id. Wenn nicht angegeben, wird die CustomerId des aktuellen Kontos verwendet.
DELETE FROM Notifications WHERE CustomerId = '1234' AND ID = '12345'
Spalten
Name | Typ | Nur Lesen | Beschreibung |
---|---|---|---|
Id [KEY] | String | True | Id der Benachrichtigung |
Subject | String | Falsch | Betreff der Meldung |
Body | String | True | Der Hauptteil der Benachrichtigung |
SendDate | Datetime | True | Das Datum, an dem die Benachrichtigung gesendet wurde |
FromAddress | String | True | Die Adresse, von der die Benachrichtigung empfangen wird |
IsUnread | Boolean | Falsch | Gibt an, ob die Benachrichtigung ungelesen ist oder nicht |
ETag | String | True | ETag der Ressource |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
CustomerId | String | ID des Kunden |
Organisationseinheiten
Erstellen, aktualisieren, löschen und Abfrage die Organisationseinheiten für einen Kunden.
Tabellenspezifische Informationen
Wählen
Um eine Liste aller Organisationseinheiten zu erhalten, ist die Spalte CustomerId erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Wenn sie nicht angegeben ist, wird die CustomerId des aktuellen Kontos verwendet.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM OrganizationUnits
Einfügen
Zum Einfügen einer Organisationseinheit sind folgende Spalten erforderlich: CustomerId, Name und ParentOrgUnitId. Wenn nicht angegeben, wird die CustomerId des aktuellen Kontos verwendet.
INSERT INTO OrganizationUnits (CustomerId, Name, Description, OrgUnitPath, ParentOrgUnitId, ParentOrgUnitPath) VALUES ('12345', 'OrgUnit Name', 'OrgUnit Description', 'Path', '123456', 'ParentPath', '1234')
Aktualisieren
Um eine Organisationseinheit zu aktualisieren, sind folgende Spalten erforderlich: CustomerId und Id. Wenn nicht angegeben, wird die CustomerId des aktuellen Kontos verwendet.
UPDATE OrganizationUnits SET Name = 'OrgUnit Name', 'Description = 'OrgUnit Description', OrgUnitPath = 'Path', ParentOrgUnitId = '123456', ParentOrgUnitPath = 'ParentPath' WHERE CustomerId = '1234' AND ID = '12345'
Löschen
Zum Löschen einer Organisationseinheit sind folgende Spalten erforderlich: CustomerId und Id. Wenn nicht angegeben, wird die CustomerId des aktuellen Kontos verwendet.
DELETE FROM OrganizationUnits WHERE CustomerId = '1234' AND ID = '12345'
Spalten
Name | Typ | Nur Lesen | Beschreibung |
---|---|---|---|
Id [KEY] | String | True | ID der Organisationseinheit. |
Name | String | Falsch | Name der Organisationseinheit. |
Description | String | False | Beschreibung der Organisationseinheit. |
OrgUnitPath | String | False | Pfad der OrgOrganization Unit.Unit |
ParentOrgUnitPath | String | Falsch | Pfad der übergeordneten Organisationseinheit. |
ParentOrgUnitId | String | Falsch | ID der übergeordneten Organisationseinheit |
ETag | String | True | ETag der Ressource. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
CustomerId | String | ID des Kunden |
Rollenzuweisungen
Erstellen, löschen und Abfrage Rollen, die Benutzern zugewiesen sind.
Tabellenspezifische Informationen
Wählen
Um eine Liste aller den Benutzern zugewiesenen Rollen zu erhalten, ist die Spalte CustomerId erforderlich. Wenn sie nicht angegeben ist, wird die CustomerId des aktuellen Kontos verwendet.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM RoleAssignments
Einfügen
Um einem Benutzer eine Rolle zuzuweisen, sind die folgenden Spalten erforderlich: RoleId, UserId, ScopeType und CustomerId. Wenn nicht angegeben, wird die CustomerId des aktuellen Kontos verwendet. ScopeType hat nur zwei zulässige Werte: CUSTOMER und ORG_UNIT.
INSERT INTO RoleAssignments (RoleId, UserId, ScopeType) VALUES ('12345', '123456', 'CUSTOMER')
Aktualisieren
UPDATES werden für diese Tabelle nicht unterstützt.
Löschen
Um einem Benutzer eine zugewiesene Rolle zu entfernen, sind die Spalten ID und CustomerId erforderlich. Wenn nicht angegeben, wird die CustomerId des aktuellen Kontos verwendet.
DELETE FROM RoleAssignments WHERE ID = '12345'
Spalten
Name | Typ | Nur Lesen | Beschreibung |
---|---|---|---|
Id [KEY] | String | True | Die eindeutige Kennung der Rolle. |
RoleId | String | Falsch | Die ID der zugewiesenen Rolle. |
UserId | String | Falsch | Die ID des Benutzers, dem diese Rolle zugewiesen ist. |
OrgUnitId | String | False | Wenn die Rolle auf eine Organisationseinheit beschränkt ist, enthält dies die ID für die Organisationseinheit, auf die die Ausübung dieser Rolle beschränkt ist. |
ScopeType | String | Falsch | Der Bereich, in dem diese Rolle zugewiesen wird. Zulässige Werte sind |
Etag | String | True | Etag der Ressource. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
CustomerId | String | ID des Kunden |
Token
Token für einen Benutzer abfragen und löschen.
Tabellenspezifische Informationen
Wählen
Um einen aktuellen Satz von Token abzurufen, die ein bestimmter Benutzer an Drittanbieteranwendungen ausgegeben hat, ist die Spalte „UserId“ erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Wenn sie nicht angegeben ist, wird die ID des ersten Benutzers aus der Tabelle „Benutzer“ verwendet.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM Tokens
EINFÜGEN
INSERTs werden für diese Tabelle nicht unterstützt.
Aktualisieren
UPDATES werden für diese Tabelle nicht unterstützt.
Löschen
Zum Löschen eines Tokens sind die Spalten UserId und ID erforderlich.
DELETE FROM Tokens WHERE UserId = '12345' AND ID = '123456'
Spalten
Name | Typ | Nur Lesen | Beschreibung |
---|---|---|---|
Id [KEY] | String | Falsch | Die Client-ID der Anwendung, für die das Token ausgestellt wurde. |
UserId | String | Falsch | Gesamtheit der untergeordneten Berechtigungen. |
DisplayText | String | Falsch | Der anzeigbare Name der Anwendung, für die das Token ausgestellt wurde. |
IsAnonymous | Boolean | False | Gibt den Namen des Privilegs an. |
IsNativeApp | Boolean | Falsch | Gibt an, ob das Token an eine installierte Anwendung ausgegeben wird. |
ScopesAggregate | String | Falsch | Gesamtheit der untergeordneten Berechtigungen. |
Etag | String | Falsch | Etag der Ressource. |
BenutzerAliase
Listet Aliase auf, bei denen es sich um alternative Email Adressen für einen Benutzer handelt.
Tabellenspezifische Informationen
Wählen
Um eine Liste aller Aliase für einen Benutzer zu erhalten, ist die Spalte „UserId“ erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Andernfalls verwendet der Connector automatisch die ID des ersten Benutzers aus der Tabelle „Benutzer“.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM Aliases
Einfügen
Um einen Alias einzufügen, sind folgende Spalten erforderlich: UserId und Alias.
INSERT INTO Aliases (UserId, Alias) VALUES ('12345', 'Alias')
Aktualisieren
UPDATES werden für diese Tabelle nicht unterstützt.
Löschen
Zum Löschen eines Alias sind folgende Spalten erforderlich: UserId und Alias.
DELETE FROM Aliases WHERE ID = '12345' AND Alias = 'Alias'
Spalten
Name | Typ | Nur Lesen | Beschreibung |
---|---|---|---|
Alias [KEY] | String | Falsch | Die Alias-Email Adresse. |
UserId | String | True | ID des Benutzers. |
PrimaryEmail | String | True | Primäre E-Mail des Benutzers. |
ETag | String | True | ETag der Ressource. |
Benutzer
Benutzerinformationen abfragen.
Tabellenspezifische Informationen
Wählen
Um eine Liste aller Benutzer zu erhalten, ist die Kunden-ID erforderlich. Sie können sie entweder in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festlegen. Wenn sie nicht angegeben ist, wird die Kunden-ID des aktuellen Kontos verwendet.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM Users
Einfügen
Zum Einfügen eines Benutzers sind folgende Spalten erforderlich: Primäre E-Mail, Vorname, Nachname und Passwort.
INSERT INTO Users (PrimaryEmail, FirstName, Surname, Password, Suspended) VALUES ('john@example.com', 'John', 'Doe', '12345', true)
Aktualisieren
Um einen Benutzer zu aktualisieren, ist die ID-Spalte erforderlich.
UPDATE Users SET PrimaryEmail = 'john@example.com', FirstName = 'John', Surname = 'Doe', Suspended = true WHERE ID = 1231
Löschen
Zum Löschen von Benutzern ist die ID-Spalte erforderlich.
DELETE FROM Users WHERE ID = '12345'
Spalten
Name | Typ | Nur Lesen | Beschreibung |
---|---|---|---|
Id [KEY] | String | True | Die eindeutige Kennung für den Benutzer. |
CustomerId | String | True | Die Kunden-ID des Benutzers. |
PrimaryEmail | String | Falsch | Die primäre Email des Benutzers. |
FirstName | String | Falsch | Der Vorname des Benutzers. |
Surname | String | False | Der Nachname des Benutzers. |
Aliases | String | True | Die Aliase des Benutzers. |
IsAdmin | Boolean | True | Gibt an, ob der Benutzer ein Administrator ist. |
IsDelegatedAdmin | Boolean | True | Gibt an, ob der Benutzer ein delegierter Administrator ist. |
LastLoginDate | Datetime | True | Letzte Anmeldung des Benutzers. |
CreationDate | Datetime | True | Erstellungsdatum des Benutzers. |
DeletionDate | Datetime | True | Löschdatum des Benutzers. |
AgreedToTerms | Boolean | True | Gibt an, ob der Benutzer den Bedingungen zugestimmt hat oder nicht. |
Suspended | Boolean | Falsch | Gibt an, ob der Benutzer gesperrt wurde. |
SuspensionReason | String | True | Der Grund, warum der Benutzer gesperrt wurde. |
OrgUnitPath | String | Falsch | Der vollständige Pfad der übergeordneten Organisation, die dem Benutzer zugeordnet ist. Wenn es sich bei der übergeordneten Organisation um die oberste Ebene handelt, wird dies als Schrägstrich (/de/) dargestellt. |
IsMailBoxSetup | Boolean | True | Gibt an, ob das Google-Postfach des Benutzers erstellt wurde. Diese Eigenschaft ist nur anwendbar, wenn dem Benutzer eine Gmail-Lizenz zugewiesen wurde. |
IsEnrolledIn2Sv | Boolean | True | Gibt an, ob der Benutzer für die zweistufige Verifizierung registriert ist. |
IsEnforcedIn2Sv | Boolean | True | Gibt an, ob für den Benutzer die zweistufige Verifizierung erzwungen wird. |
IncludeInGlobalAddressList | Boolean | True | Gibt an, ob das Profil des Benutzers in der globalen Adressliste von G Suite sichtbar ist, wenn die Funktion zur Kontaktfreigabe für die Domäne aktiviert ist. |
ThumbnailPhotoUrl | String | True | Foto-URL des Benutzers |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Password | String | Das Passwort des Benutzers. |
Domain | String | Domänenname |
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 Directory Connector-Ansichten
Name | Beschreibung |
---|---|
AppSpecificPasswords | Listet alle anwendungsspezifischen Passwörter (Passwörter, die mit Anwendungen verwendet werden, die keine Bestätigungscodes akzeptieren) auf, die von einem Benutzer vergeben wurden. |
MobileDevices | Listet Mobilgeräte für ein Konto auf. |
Privileges | Listet alle Privilegien auf. |
Roles | Listet Rollen in einer Domäne auf. |
UserAddresses | Listet die Adressen eines Benutzers auf. |
UserEmails | Emails eines Benutzers abfragen. |
UserInstantMessagingAccounts | Fragen Sie die IM-Konten eines Benutzers ab. |
UserLocations | Standorte eines Benutzers abfragen. |
UserOrganizations | Organisationen für einen Benutzer abfragen. |
UserPhones | Abfrage der Telefonnummern eines Benutzers. |
UserWebsites | Eine Liste der Websites eines Benutzers abrufen. |
VerificationCodes | Abfrage von Bestätigungscodes für einen Benutzer. |
AppspezifischePasswörter
Listet alle anwendungsspezifischen Passwörter auf (Passwörter, die mit Anwendungen verwendet werden, die keine Bestätigungscodes akzeptieren), die von einem Benutzer vergeben wurden.
Tabellenspezifische Informationen
Wählen
Um eine Liste aller anwendungsspezifischen Token zu erhalten, die von einem Benutzer ausgegeben wurden, ist die Spalte „UserId“ erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Wenn sie nicht angegeben wird, wird die ID des ersten Benutzers aus der Tabelle „Benutzer“ verwendet.
Beispielsweise wird die folgende Abfrage serverseitig von der Google Directory API verarbeitet:
SELECT * FROM AppSpecificPasswords
Spalten
Name | Typ | Beschreibung |
---|---|---|
Id [KEY] | String | Die eindeutige Kennung des ASP. |
UserId | String | Die eindeutige Kennung des Benutzers, der den ASP ausgestellt hat. |
Name | String | Name des ASP. |
CreationDate | Datetime | Das Datum, an dem der ASP erstellt wurde. |
LastTimeUsed | Datetime | Der Zeitpunkt der letzten Verwendung des ASP. |
Etag | String | Etag der Ressource. |
Mobilgeräte
Listet Mobilgeräte für ein Konto auf.
Tabellenspezifische Informationen
Wählen
Um eine Liste aller Mobilgeräte für ein Konto zu erhalten, ist die Spalte CustomerId erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Wenn sie nicht angegeben ist, wird die CustomerId des aktuellen Kontos verwendet.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM MobileDevices
Spalten
Name | Typ | Beschreibung |
---|---|---|
Id [KEY] | String | Die Seriennummer für ein mobiles Google Sync-Gerät. Für Android- und iOS-Geräte ist dies eine softwaregenerierte eindeutige Kennung. |
ResourceId | String | Die eindeutige ID, die der API Dienst zur Identifizierung des Mobilgeräts verwendet. |
Name | String | Liste der Benutzernamen des Besitzers. |
AccountsList | String | Liste der zum Gerät hinzugefügten Konten. |
Email | String | Liste der Emails des Besitzers. |
Model | String | Der Modellname des Mobilgeräts. |
OS | String | Das Operationssystem des Mobilgeräts |
Type | String | Der Typ des Mobilgeräts. |
Status | String | Der Status des Geräts. |
HardwareId | String | Die eindeutige IMEI/MEID-Kennung für Android-Hardware. |
FirstSyncDate | Datetime | Datum und Uhrzeit der ersten Synchronisierung des Geräts mit den Richtlinieneinstellungen in der Admin-Konsole. |
LastSyncDate | Datetime | Datum und Uhrzeit der letzten Synchronisierung des Geräts mit den Richtlinieneinstellungen in der Admin-Konsole. |
UserAgent | String | Gibt Informationen über das Gerät, beispielsweise die Operationssystemversion. |
SerialNumber | String | Die Seriennummer des Geräts. |
IMEI | String | Die IMEI-Nummer des Geräts. |
MEID | String | Die MEID-Nummer des Geräts. |
WiFiMacAddress | String | Die MAC-Adresse des Geräts in Wi-Fi-Netzwerken. |
NetworkOperator | String | Mobilgerät, Mobilfunk- oder Netzbetreiber. |
DefaultLanguage | String | Die auf dem Gerät verwendete Standardsprache. |
DeviceCompromisedStatus | String | Der Status des kompromittierten Geräts. |
BuildNumber | String | Die Buildnummer des Operationssystems des Geräts. |
KernelVersion | String | Die Kernelversion des Geräts. |
BasebandVersion | String | Die Basisbandversion des Geräts. |
Manufacturer | String | Der Hersteller des Geräts. |
ReleaseVersion | String | Version der Veröffentlichung für Mobilgeräte. |
SecurityPatchLevel | String | Die Sicherheitspatch-Ebene des Geräts. |
Brand | String | Die Marke des Geräts. |
BootloaderVersion | String | Die Bootloader-Version des Geräts. |
Hardware | String | Die Hardware des Geräts. |
EncryptionStatus | String | Der Verschlüsselung des Geräts. |
DevicePasswordStatus | String | Der Passwortstatus des Geräts |
Privilege | String | DMAgentPermission. |
UnknownSourcesStatus | Boolean | Zeigt an, ob unbekannte Quellen auf dem Gerät aktiviert oder deaktiviert sind |
AdbStatus | Boolean | Gibt an, ob ADB (USB-Debugging) auf dem Gerät aktiviert oder deaktiviert ist |
IsOnOwnerProfile | Boolean | Gibt an, ob sich dieses Konto im Besitzer-/Primärprofil befindet oder nicht. |
SupportsWorkProfile | Boolean | Gibt an, ob das Arbeitsprofil auf dem Gerät unterstützt wird. |
Etag | String | Etag der Ressource |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
CustomerId | String | Die ID des Kunden |
Privilegien
Listet alle Privilegien auf.
Tabellenspezifische Informationen
Wählen
Um eine Liste aller Berechtigungen für ein Konto zu erhalten, ist die Spalte CustomerId erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Wenn sie nicht angegeben ist, wird die CustomerId des aktuellen Kontos verwendet.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM Privileges
Spalten
Name | Typ | Beschreibung |
---|---|---|
ServiceId [KEY] | String | Die verschleierte ID des Dienstes, für den dieses Privileg gilt. |
ServiceName [KEY] | String | Der Name des Dienstes, für den dieses Privileg gilt. |
PrivilegeName | String | Der Name des Privilegs. |
ParentServiceId | String | Die Service-ID des übergeordneten Privilegs. |
ParentPrivilegeName | String | Der Berechtigungsname der übergeordneten Berechtigung. |
IsOrganizationUnitRestrictable | Boolean | Gibt an, ob das Privileg auf eine Organisationseinheit beschränkt werden kann. |
Etag | String | Etag der Ressource. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
CustomerId | String | ID des Kunden |
Rollen
Listet Rollen in einer Domäne auf.
Tabellenspezifische Informationen
Wählen
Um eine Liste aller Rollen zu erhalten, ist die Spalte CustomerId erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Wenn sie nicht angegeben ist, wird die CustomerId des aktuellen Kontos verwendet.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM Roles
Spalten
Name | Typ | Beschreibung |
---|---|---|
Id [KEY] | String | Die eindeutige Kennung für die Rolle. |
Name | String | Name der Rolle. |
Description | String | Eine kurze Beschreibung der Rolle. |
PrivilegeName | String | Der Name des Privilegs. |
ServiceId | String | Die ID des Dienstes, für den das Privileg gilt. |
IsSystemRole | Boolean | Gibt an, ob es sich um eine vordefinierte Rolle handelt. |
IsSuperAdminRole | Boolean | Gibt an, ob es sich bei der Rolle um eine Rolle handelt. |
Etag | String | Etag der Ressource. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
CustomerId | String | ID des Kunden |
Benutzeradressen
Listet die Adressen eines Benutzers auf.
Tabellenspezifische Informationen
Wählen
Um eine Liste mit Adressen für einen Benutzer zu erhalten, ist die Spalte „UserId“ erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Andernfalls verwendet der Connector automatisch die UserId des ersten Benutzers aus der Tabelle „Benutzer“.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM UserAddresses
Spalten
Name | Typ | Beschreibung |
---|---|---|
UserId | String | Die eindeutige Kennung für den Benutzer. |
Type | String | Der Adresstyp. |
CustomType | String | Der benutzerdefinierte Typ der Adresse. |
FormattedAddress | String | Die vollständige, unstrukturierte Postanschrift. |
PoBox | String | Postfach der Adresse. |
ExtendedAddress | String | Die erweiterte Adresse |
StreetAddress | String | Die Adresse |
Locality | String | Der Ort oder die Stadt der Adresse. |
Region | String | Die Abkürzung für Provinz oder Staat. |
PostalCode | String | Die Postleitzahl, sofern zutreffend. |
Country | String | Land in der Adresse. |
CountryCode | String | Der Ländercode. Verwendet den Standard ISO 3166-1. |
IsPrimary | Boolean | Gibt an, ob dies die primäre Adresse des Benutzers ist |
BenutzerE-Mails
Fragen Sie die Emails eines Benutzers ab.
Tabellenspezifische Informationen
Wählen
Um eine Liste der Email-Adressen eines Benutzers zu erhalten, ist die Spalte „UserId“ erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Andernfalls verwendet der Connector automatisch die ID des ersten Benutzers aus der Tabelle „Benutzer“.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM UserEmails
Spalten
Name | Typ | Beschreibung |
---|---|---|
Address | String | Die Email Adresse des Benutzers |
UserId | String | Die eindeutige Kennung für den Benutzer. |
IsPrimary | String | Gibt an, ob dies die primäre Email des Benutzers ist. |
CustomType | String | Der benutzerdefinierte Typ der Email. |
Type | String | Der Typ des Email Kontos. |
BenutzerInstantMessagingKonten
Fragen Sie die IM-Konten eines Benutzers ab.
Tabellenspezifische Informationen
Wählen
Um eine Liste der IM-Konten für einen Benutzer zu erhalten, ist die Spalte „UserId“ erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Andernfalls verwendet der Connector automatisch die ID des ersten Benutzers aus der Tabelle „Benutzer“.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM UserInstantMessagingAccounts
Spalten
Name | Typ | Beschreibung |
---|---|---|
IM | String | Die IM-Netzwerk-ID des Benutzers. |
UserId | String | Die eindeutige Kennung für den Benutzer. |
Protocol | String | Das IM-Protokoll identifiziert das IM-Netzwerk. |
CustomProtocol | String | Der benutzerdefinierte Typ des IM-Protokolls. |
IsPrimary | String | Gibt an, ob dies die primäre IM des Benutzers ist. |
CustomType | String | Der benutzerdefinierte Typ des IM-Kontos. |
Type | String | Der Typ des IM-Kontos. |
Benutzerstandorte
Standortabfrage für einen Benutzer.
Tabellenspezifische Informationen
Wählen
Um eine Liste der Standorte für einen Benutzer zu erhalten, ist die Spalte „UserId“ erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Andernfalls verwendet der Connector automatisch die ID des ersten Benutzers aus der Tabelle „Benutzer“.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM UserLocations
Spalten
Name | Typ | Beschreibung |
---|---|---|
Area | String | Textueller Standort des Benutzers. |
UserId | String | Die eindeutige Kennung für den Benutzer. |
BuildingId | String | Die Gebäudekennung. |
DeskCode | String | Der Schreibtischstandort. |
FloorName | String | Der Name/die Nummer des Stockwerks |
FloorSection | String | Der Bodenbereich. |
CustomType | String | Der benutzerdefinierte Typ des Standorts. |
Type | String | Der Typ des Standorts. |
Benutzerorganisationen
Fragen Sie die Organisationen nach einem Benutzer ab.
Tabellenspezifische Informationen
Wählen
Um eine Liste der Organisationen für einen Benutzer zu erhalten, ist die Spalte „UserId“ erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Andernfalls verwendet der Connector automatisch die ID des ersten Benutzers aus der Tabelle „Benutzer“.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM UserOrganizations
Spalten
Name | Typ | Beschreibung |
---|---|---|
Name | String | Der Name der Organisation. |
UserId | String | Die eindeutige Kennung für den Benutzer. |
OrganizationDomain | String | Die Domäne, zu der die Organisation gehört. |
Department | String | Gibt die Abteilung innerhalb der Organisation an. |
Description | String | Die Beschreibung der Organisation. |
Title | String | Der Titel des Benutzers innerhalb der Organisation. |
CostCenter | String | Die Kostenstelle der Organisation des Benutzers. |
Location | String | Der physische Standort der Organisation. |
IsPrimary | Boolean | Gibt an, ob dies die primäre Organisation des Benutzers ist. |
Symbol | String | Textzeichenfolgensymbol der Organisation. |
Type | String | Land in der Adresse. |
CustomType | String | Wenn der Wert des Typs „benutzerdefiniert“ ist, enthält diese Eigenschaft den benutzerdefinierten Typ. |
BenutzerTelefone
Fragen Sie die Telefonnummern eines Benutzers ab.
Tabellenspezifische Informationen
Wählen
Um eine Liste der Telefone für einen Benutzer zu erhalten, ist die Spalte „UserId“ erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Andernfalls verwendet der Connector automatisch die ID des ersten Benutzers aus der Tabelle „Benutzer“.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM UserPhones
Spalten
Name | Typ | Beschreibung |
---|---|---|
PhoneNumber | String | Die Telefonnummer des Benutzers. |
UserId | String | Die eindeutige Kennung für den Benutzer. |
IsPrimary | String | Gibt an, ob dies die primäre IM des Benutzers ist. |
CustomType | String | Der benutzerdefinierte Typ der Telefonnummer. |
Type | String | Der Typ der Telefonnummer. |
Benutzerwebsites
Eine Liste der Websites eines Benutzers abrufen.
Tabellenspezifische Informationen
Wählen
Um eine Liste von Websites für einen Benutzer zu erhalten, ist die Spalte „UserId“ erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Andernfalls verwendet der Connector automatisch die ID des ersten Benutzers aus der Tabelle „Benutzer“.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM UserWebsites
Spalten
Name | Typ | Beschreibung |
---|---|---|
URL | String | Die URL der Website. |
UserId | String | Die eindeutige Kennung für den Benutzer. |
CustomType | String | Der benutzerdefinierte Typ der Website. |
Type | String | Der Typ der Website. |
IsPrimary | Boolean | Gibt an, ob dies die primäre Website des Benutzers ist oder nicht |
Verifizierungscodes
Verifizierungscodes für einen Benutzer abfragen.
Tabellenspezifische Informationen
Wählen
Um einen aktuellen Satz gültiger Backup-Verifizierungscodes für einen angegebenen Benutzer abzurufen, ist die Spalte „UserId“ erforderlich. Sie kann in der Verbindungszeichenfolge oder in der Bedingung der WHERE-Klausel festgelegt werden. Wenn sie nicht angegeben wird, wird die ID des ersten Benutzers aus der Tabelle „Benutzer“ verwendet.
Beispielsweise wird die folgende Abfrage serverseitig von den Google Directory APIs verarbeitet:
SELECT * FROM VerificationCodes
Spalten
Name | Typ | Beschreibung |
---|---|---|
UserId | String | Die eindeutige ID des Benutzers. |
VerificationCode | String | Ein aktueller Bestätigungscode für den Benutzer. |
Etag | String | Etag der Ressource. |
Gespeicherte Prozeduren
Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT/INSERT/UPDATE/DELETE-Operationen mit Google Directory hinaus erweitern.
Gespeicherte Prozeduren akzeptieren eine Liste von Parametern, führen ihre beabsichtigte Funktion aus und geben dann alle relevanten Antwortdaten aus dem Google Directory zurück, zusammen mit einer Angabe, ob die Prozedur erfolgreich war oder fehlgeschlagen ist.
Gespeicherte Prozeduren im Google Directory Connector
Name | Beschreibung |
---|---|
ChangeAdminStatus | Den Admin-Status eines Benutzers ändern. |
GenerateVerificationCodes | Bestätigungscodes für einen Benutzer generieren. |
GetOAuthAccessToken | Ruft den OAuth-Zugriffstoken ab, der zur Authentifizierung bei verschiedenen Google-Diensten verwendet werden soll. |
GetOAuthAuthorizationURL | Ruft die OAuth-Autorisierungs URL ab, die für die Authentifizierung bei verschiedenen Google-Diensten verwendet wird. |
InvalidateVerificationCodes | Bestätigungscodes für einen Benutzer ungültig machen. |
RefreshOAuthAccessToken | Ruft den OAuth-Zugriffstoken ab, der zur Authentifizierung bei verschiedenen Google-Diensten verwendet werden soll. |
ChangeAdminStatus
Den Administratorstatus eines Benutzers ändern.
Eingang
Name | Typ | Beschreibung |
---|---|---|
UserId | String | ID des Benutzers. Der Wert kann die primäre Email Adresse des Benutzers, eine Alias-Email Adresse oder eine eindeutige Benutzer-ID sein. |
Status | String | Neuer Admin-Status des Benutzers. |
Verifizierungscodes generieren
Verifizierungscodes für einen Benutzer generieren.
Eingang
Name | Typ | Beschreibung |
---|---|---|
UserId | String | ID des Benutzers. |
GetOAuthAccessToken
Erhält den OAuth-Zugriffstoken, der zur Authentifizierung bei verschiedenen Google-Diensten verwendet werden soll.
Hinweis
Wenn nach dem Ausführen dieser gespeicherten Prozedur das OAuthRefreshToken nicht als Teil des Ergebnissatzes zurückgegeben wurde, ändern Sie den Eingabeaufforderungswert in CONSENT und führen Sie die Prozedur erneut aus. Dadurch wird die App gezwungen, sich erneut zu authentifizieren und neue Token-Informationen zu senden.
Eingang
Name | Typ | Beschreibung |
---|---|---|
AuthMode | String | Der zu verwendende Authentifizierungsmodustyp. Die zulässigen Werte sind APP, WEB. Der Standardwert ist WEB. |
Verifier | String | Der von Google zurückgegebene Prüfcode, nachdem die Verbindungsberechtigung für die App erteilt wurde. Nur WEB-Authentifizierungsmodus. |
Scope | String | Der Umfang des Zugriffs auf Google APIs. Standardmäßig wird der Zugriff auf alle von diesem Datenanbieter verwendeten APIs angegeben. Der Standardwert ist * https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly https://www.googleapis.com/auth/admin.directory.domain.readonly https://www.googleapis.com/auth/admin.directory.user.readonly https://www.googleapis.com/auth/admin.directory.user.alias.readonly https://www.googleapis.com/auth/admin.directory.group.member.readonly <a |
href="https://www.googleapis.com/auth/admin.directory.group.readonly">https://www.googleapis.com/auth/admin.directory.group.readonly https://www.googleapis.com/auth/admin.directory.orgunit.readonly https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly https://www.googleapis.com/auth/admin.directory.device.mobile.readonly*. | ||
CallbackURL | String | Dieses Feld bestimmt, wohin die Antwort gesendet wird. Der Wert dieses Parameters muss genau mit einem der in der APIs Konsole registrierten Werte übereinstimmen, einschließlich der HTTP- oder HTTPS-Schemata, der Groß- und Kleinschreibung und des abschließenden Schrägstrichs ('/'). |
Prompt | String | Dieses Feld gibt die Eingabeaufforderung an, die dem Benutzer angezeigt werden soll. Es akzeptiert einen der folgenden Werte: NONE, CONSENT, SELECT ACCOUNT. Der Standardwert ist SELECT_ACCOUNT, sodass ein bestimmter Benutzer aufgefordert wird, das Konto auszuwählen, mit dem eine Verbindung hergestellt werden soll. Wenn es auf CONSENT eingestellt ist, wird dem Benutzer jedes Mal eine Zustimmungsseite angezeigt, auch wenn er der Anwendung zuvor für einen bestimmten Satz von Bereichen zugestimmt hat. Wenn es auf NONE eingestellt ist, werden dem Benutzer keine Authentifizierungs- oder Zustimmungsbildschirme angezeigt. Der Standardwert ist SELECT_ACCOUNT. |
AccessType | String | Dieses Feld gibt an, ob Ihre Anwendung auf eine Google API zugreifen muss, wenn der Benutzer nicht im Browser ist. Dieser Parameter ist standardmäßig auf OFFLINE eingestellt. Wenn Ihre Anwendung Zugriffstoken aktualisieren muss, wenn der Benutzer nicht im Browser ist, verwenden Sie OFFLINE. Dies führt dazu, dass Ihre Anwendung ein Aktualisierungstoken erhält, wenn Ihre Anwendung zum ersten Mal einen Autorisierungscode für einen Benutzer austauscht. Die zulässigen Werte sind ONLINE, OFFLINE. Der Standardwert ist OFFLINE. |
State | String | Dieses Feld zeigt alle Zustände an, die für Ihre Anwendung nach Erhalt der Antwort nützlich sein können. Ihre Anwendung erhält denselben Wert, den sie gesendet hat, da dieser Parameter einen Hin- und Rückweg zum Google-Autorisierungsserver und zurück durchführt. Zu den Verwendungsmöglichkeiten gehören die Umleitung des Benutzers zur richtigen Ressource auf Ihrer Site, die Verwendung von Nonces und die Minderung von Cross-Site-Request-Forgery. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
OAuthAccessToken | String | Das von Google zurückgegebene Authentifizierungstoken. Dieses kann bei nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden. |
OAuthRefreshToken | String | Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann. |
ExpiresIn | String | Die verbleibende Lebensdauer des Zugriffstokens. |
GetOAuthAuthorizationURL
Ruft die OAuth-Autorisierungs URL ab, die für die Authentifizierung bei verschiedenen Google-Diensten verwendet wird.
Eingang
Name | Typ | Beschreibung |
---|---|---|
Scope | String | Der Umfang des Zugriffs auf Google APIs. Standardmäßig wird der Zugriff auf alle von diesem Datenanbieter verwendeten APIs angegeben. Der Standardwert ist * https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly https://www.googleapis.com/auth/admin.directory.domain.readonly https://www.googleapis.com/auth/admin.directory.user.readonly https://www.googleapis.com/auth/admin.directory.user.alias.readonly https://www.googleapis.com/auth/admin.directory.group.member.readonly <a |
href="https://www.googleapis.com/auth/admin.directory.group.readonly">https://www.googleapis.com/auth/admin.directory.group.readonly https://www.googleapis.com/auth/admin.directory.orgunit.readonly https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly https://www.googleapis.com/auth/admin.directory.device.mobile.readonly*. | ||
CallbackURL | String | Dieses Feld bestimmt, wohin die Antwort gesendet wird. Der Wert dieses Parameters muss genau mit einem der in der APIs Konsole registrierten Werte übereinstimmen, einschließlich der HTTP- oder HTTPS-Schemata, Groß-/Kleinschreibung und des abschließenden Schrägstrichs ('/'). |
Prompt | String | Dieses Feld gibt die Eingabeaufforderung an, die dem Benutzer angezeigt werden soll. Es akzeptiert einen der folgenden Werte: NONE, CONSENT, SELECT ACCOUNT. Der Standardwert ist SELECT_ACCOUNT, sodass ein bestimmter Benutzer aufgefordert wird, das Konto auszuwählen, mit dem eine Verbindung hergestellt werden soll. Wenn es auf CONSENT eingestellt ist, wird dem Benutzer jedes Mal eine Zustimmungsseite angezeigt, auch wenn er der Anwendung zuvor für einen bestimmten Satz von Bereichen zugestimmt hat. Wenn es auf NONE eingestellt ist, werden dem Benutzer keine Authentifizierungs- oder Zustimmungsbildschirme angezeigt. Der Standardwert ist SELECT_ACCOUNT. |
AccessType | String | Dieses Feld gibt an, ob Ihre Anwendung auf eine Google API zugreifen muss, wenn der Benutzer nicht im Browser ist. Dieser Parameter ist standardmäßig auf OFFLINE eingestellt. Wenn Ihre Anwendung Zugriffstoken aktualisieren muss, wenn der Benutzer nicht im Browser ist, verwenden Sie OFFLINE. Dadurch erhält Ihre Anwendung ein Aktualisierungstoken, wenn Ihre Anwendung zum ersten Mal einen Autorisierungscode für einen Benutzer austauscht. Die zulässigen Werte sind ONLINE, OFFLINE. Der Standardwert ist OFFLINE. |
State | String | Dieses Feld zeigt alle Zustände an, die für Ihre Anwendung nach Erhalt der Antwort nützlich sein können. Ihre Anwendung erhält denselben Wert, den sie gesendet hat, da dieser Parameter einen Hin- und Rückweg zum Google-Autorisierungsserver und zurück durchführt. Mögliche Verwendungen sind die Umleitung des Benutzers zur richtigen Ressource auf Ihrer Site, die Verwendung von Nonces und die Minderung von Cross-Site-Request-Forgery. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
URL | String | Die URL zum Abschließen der Benutzerauthentifizierung. |
Verifizierungscodes ungültig machen
Verifizierungscodes für einen Benutzer ungültig machen.
Eingang
Name | Typ | Beschreibung |
---|---|---|
UserId | String | ID des Benutzers. |
Aktualisieren Sie das OAuthAccessToken
Erhält den OAuth-Zugriffstoken, der zur Authentifizierung bei verschiedenen Google-Diensten verwendet werden soll.
Eingang
Name | Typ | Beschreibung |
---|---|---|
OAuthRefreshToken | String | Das vom ursprünglichen Autorisierungscode-Austausch zurückgegebene Aktualisierungstoken. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
OAuthAccessToken | String | Das von Google zurückgegebene Authentifizierungstoken. Dieses kann bei nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden. |
OAuthRefreshToken | String | Das von Google zurückgegebene Authentifizierungstoken. Dieses kann bei nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden. |
ExpiresIn | String | Die verbleibende Lebensdauer des Zugriffstokens. |
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 Directory 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
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Datenbankname. |
Sys_schemas
Listet die verfügbaren Schemas auf.
Die folgende Abfrage ruft alle verfügbaren Schemata ab:
SELECT * FROM sys_schemas
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Datenbankname. |
SchemaName | String | Der Schema. |
Sys_tables
Listet die verfügbaren Tabellen auf.
Die folgende Abfrage ruft die verfügbaren Tabellen und Ansichten ab:
SELECT * FROM sys_tables
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Die Datenbank, die die Tabelle oder Ansicht enthält. |
SchemaName | String | Das Schema, das die Tabelle oder Ansicht enthält. |
TableName | String | Der Name der Tabelle oder Ansicht. |
TableType | String | Der Tabellentyp (Tabelle oder Ansicht). |
Description | String | Eine Beschreibung der Tabelle oder Ansicht. |
IsUpdateable | Boolean | Ob die Tabelle aktualisiert werden kann. |
Sys_tablecolumns
Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.
Die folgende Abfrage gibt die Spalten und Datentypen für die Gruppentabelle zurück:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Group'
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die die Tabelle oder Ansicht enthält. |
SchemaName | String | Das Schema, das die Tabelle oder Ansicht enthält. |
TableName | String | Der Name der Tabelle oder Ansicht, die die Spalte enthält. |
ColumnName | String | Der Spaltenname. |
DataTypeName | String | Der Name des Datentyps. |
DataType | Int32 | Eine Ganzzahl, die den Datentyp angibt. Dieser Wert wird zur Laufzeit basierend auf der Umfeld bestimmt. |
Length | Int32 | Die Speichergröße der Spalte. |
DisplaySize | Int32 | Die normale Maximalbreite der angegebenen Spalte in Zeichen. |
NumericPrecision | Int32 | Die maximale Anzahl von Ziffern in numerischen Daten. Die Spaltenlänge in Zeichen für Zeichen- und Datums-/Uhrzeitdaten. |
NumericScale | Int32 | Die Spaltenskala oder Anzahl der Ziffern rechts vom Dezimalpunkt. |
IsNullable | Boolean | Ob die Spalte Null enthalten kann. |
Description | String | Eine kurze Beschreibung der Spalte. |
Ordinal | Int32 | Die Sequenznummer der Spalte. |
IsAutoIncrement | String | Ob der Spaltenwert in festen Schritten zugewiesen wird. |
IsGeneratedColumn | String | Ob die Spalte generiert wird. |
IsHidden | Boolean | Ob die Spalte ausgeblendet ist. |
IsArray | Boolean | Ob die Spalte ein Array ist. |
IsReadOnly | Boolean | Ob die Spalte schreibgeschützt ist. |
IsKey | Boolean | Gibt an, ob ein von sys_tablecolumns zurückgegebenes Feld der Primärschlüssel der Tabelle ist. |
Sys_procedures
Listet die verfügbaren gespeicherten Prozeduren auf.
Die folgende Abfrage ruft die verfügbaren gespeicherten Prozeduren ab:
SELECT * FROM sys_procedures
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Die Datenbank, die die gespeicherte Prozedur enthält. |
SchemaName | String | Das Schema, das die gespeicherte Prozedur enthält. |
ProcedureName | String | Der Name der gespeicherten Prozedur. |
Description | String | Eine Beschreibung der gespeicherten Prozedur. |
ProcedureType | String | Der Typ der Prozedur, z. B. PROZEDUR oder FUNKTION. |
Sys_procedureparameters
Beschreibt Parameter gespeicherter Prozeduren.
Die folgende Abfrage gibt Informationen zu allen Eingabeparametern für die gespeicherte Prozedur „RefreshOAuthAccessToken“ zurück:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='RefreshOAuthAccessToken' AND Direction=1 OR Direction=2
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die die gespeicherte Prozedur enthält. |
SchemaName | String | Der Name des Schema, das die gespeicherte Prozedur enthält. |
ProcedureName | String | Der Name der gespeicherten Prozedur, die den Parameter enthält. |
ColumnName | String | Der Name des gespeicherten Prozedurparameters. |
Direction | Int32 | Eine Ganzzahl, die dem Typ des Parameters entspricht: Eingabe (1), Eingabe/Ausgabe (2) oder Ausgabe (4). Parameter vom Typ Eingabe/Ausgabe können sowohl Eingabe- als auch Ausgabeparameter sein. |
DataTypeName | String | Der Name des Datentyps. |
DataType | Int32 | Eine Ganzzahl, die den Datentyp angibt. Dieser Wert wird zur Laufzeit basierend auf der Umfeld bestimmt. |
Length | Int32 | Die Anzahl der für Zeichendaten zulässigen Zeichen. Die Anzahl der für numerische Daten zulässigen Ziffern. |
NumericPrecision | Int32 | Die maximale Genauigkeit für numerische Daten. Die Spaltenlänge in Zeichen für Zeichen- und Datums-/Uhrzeitdaten. |
NumericScale | Int32 | Die Anzahl der Ziffern rechts vom Dezimalkomma in numerischen Daten. |
IsNullable | Boolean | Ob der Parameter Null enthalten kann. |
IsRequired | Boolean | Ob der Parameter zur Ausführung der Prozedur erforderlich ist. |
IsArray | Boolean | Ob der Parameter ein Array ist. |
Description | String | Die Beschreibung des Parameters. |
Ordinal | Int32 | Der Index des Parameters. |
Sys_keycolumns
Beschreibt die Primär- und Fremdschlüssel.
Die folgende Abfrage ruft den Primärschlüssel für die Gruppentabelle ab:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Group'
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die den Schlüssel enthält. |
SchemaName | String | Der Name des Schema, das den Schlüssel enthält. |
TableName | String | Der Name der Tabelle, die den Schlüssel enthält. |
ColumnName | String | Der Name der Schlüsselspalte. |
IsKey | Boolean | Ob die Spalte ein Primärschlüssel in der Tabelle ist, auf die im Feld „TableName“ verwiesen wird. |
IsForeignKey | Boolean | Ob die Spalte ein Fremdschlüssel ist, auf den im Feld TableName verwiesen wird. |
PrimaryKeyName | String | Der Name des Primärschlüssels. |
ForeignKeyName | String | Der Name des Fremdschlüssels. |
ReferencedCatalogName | String | Die Datenbank, die den Primärschlüssel enthält. |
ReferencedSchemaName | String | Das Schema, das den Primärschlüssel enthält. |
ReferencedTableName | String | Die Tabelle, die den Primärschlüssel enthält. |
ReferencedColumnName | String | Der Spaltenname des Primärschlüssels. |
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
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die den Schlüssel enthält. |
SchemaName | String | Der Name des Schema, das den Schlüssel enthält. |
TableName | String | Der Name der Tabelle, die den Schlüssel enthält. |
ColumnName | String | Der Name der Schlüsselspalte. |
PrimaryKeyName | String | Der Name des Primärschlüssels. |
ForeignKeyName | String | Der Name des Fremdschlüssels. |
ReferencedCatalogName | String | Die Datenbank, die den Primärschlüssel enthält. |
ReferencedSchemaName | String | Das Schema, das den Primärschlüssel enthält. |
ReferencedTableName | String | Die Tabelle, die den Primärschlüssel enthält. |
ReferencedColumnName | String | Der Spaltenname des Primärschlüssels. |
ForeignKeyType | String | Gibt an, ob der Fremdschlüssel ein Importschlüssel (zeigt auf andere Tabellen) oder ein Exportschlüssel (referenziert von anderen Tabellen) ist. |
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
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die den Schlüssel enthält. |
SchemaName | String | Der Name des Schema, das den Schlüssel enthält. |
TableName | String | Der Name der Tabelle, die den Schlüssel enthält. |
ColumnName | String | Der Name der Schlüsselspalte. |
KeySeq | String | Die Sequenznummer des Primärschlüssels. |
KeyName | String | Der Name des Primärschlüssels. |
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
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die den Index enthält. |
SchemaName | String | Der Name des Schema, das den Index enthält. |
TableName | String | Der Name der Tabelle, die den Index enthält. |
IndexName | String | Der Indexname. |
ColumnName | String | Der Name der mit dem Index verknüpften Spalte. |
IsUnique | Boolean | Wahr, wenn der Index eindeutig ist. Andernfalls falsch. |
IsPrimary | Boolean | Wahr, wenn der Index ein Primärschlüssel ist. Andernfalls falsch. |
Type | Int16 | Ein ganzzahliger Wert, der dem Indextyp entspricht: Statistik (0), gruppiert (1), gehasht (2) oder Sonstiges (3). |
SortOrder | String | Die Sortierreihenfolge: A für aufsteigend oder D für absteigend. |
OrdinalPosition | Int16 | Die Sequenznummer der Spalte im Index. |
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:googledirectory: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
Name | Typ | Beschreibung |
---|---|---|
Name | String | Der Name der Verbindungseigenschaft. |
ShortDescription | String | Eine kurze Beschreibung. |
Type | String | Der Datentyp der Verbindungseigenschaft. |
Default | String | Der Standardwert, sofern nicht explizit einer festgelegt wurde. |
Values | String | Eine durch Kommas getrennte Liste möglicher Werte. Wenn ein anderer Wert angegeben wird, wird ein Validierungsfehler ausgegeben. |
Value | String | Der von Ihnen festgelegte Wert oder ein vorkonfigurierter Standard. |
Required | Boolean | Ob für die Immobilie eine Verbindung erforderlich ist. |
Category | String | Die Kategorie der Verbindungseigenschaft. |
IsSessionProperty | String | Ob die Eigenschaft eine Sitzungseigenschaft ist, die zum Speichern von Informationen zur aktuellen Verbindung verwendet wird. |
Sensitivity | String | Die Vertraulichkeitsstufe der Eigenschaft. Diese gibt Aufschluss darüber, ob die Eigenschaft in Protokollierungs- und Authentifizierungsformularen verschleiert wird. |
PropertyName | String | Eine verkürzte Form des Verbindungseigenschaftsnamens in Camel-Case-Schreibweise. |
Ordinal | Int32 | Der Index des Parameters. |
CatOrdinal | Int32 | Der Index der Parameterkategorie. |
Hierarchy | String | Zeigt zugehörige abhängige Eigenschaften an, die zusammen mit dieser festgelegt werden müssen. |
Visible | Boolean | Informiert, ob die Eigenschaft in der Verbindungs-Benutzeroberfläche sichtbar ist. |
ETC | String | Verschiedene sonstige Informationen zum Objekt. |
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.
Name | Beschreibung | Mögliche Werte |
---|---|---|
AGGREGATE_FUNCTIONS | Unterstützte Aggregatfunktionen. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Ob die COUNT-Funktion unterstützt wird. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | Das öffnende Zeichen, das zum Escapen eines Bezeichners verwendet wird. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | Das abschließende Zeichen, das zum Escapen eines Bezeichners verwendet wird. | ] |
SUPPORTED_OPERATORS | Eine Liste unterstützter SQL-Operatoren. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Ob GROUP BY unterstützt wird und wenn ja, in welchem Umfang. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Unterstützte String-Funktionen. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Unterstützte numerische Funktionen. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Unterstützte Datums-/Uhrzeitfunktionen. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Zeigt an, dass während der Replikation Tabellen übersprungen wurden. | |
REPLICATION_TIMECHECK_COLUMNS | Ein Zeichenfolgenarray mit einer Liste von Spalten, die (in der angegebenen Reihenfolge) zur Überprüfung verwendet werden, ob sie während der Replikation als geänderte Spalte verwendet werden sollen. | |
IDENTIFIER_PATTERN | Zeichenfolgenwert, der angibt, welche Zeichenfolge für einen Bezeichner gültig ist. | |
SUPPORT_TRANSACTION | Gibt an, ob der Anbieter Transaktionen wie Commit und Rollback unterstützt. | YES , NO |
DIALECT | Gibt den zu verwendenden SQL-Dialekt an. | |
KEY_PROPERTIES | Gibt die Eigenschaften an, die die einheitliche Datenbank identifizieren. | |
SUPPORTS_MULTIPLE_SCHEMAS | Gibt an, ob für den Anbieter mehrere Schemas vorhanden sein können. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Gibt an, ob für den Anbieter mehrere Kataloge vorhanden sein können. | YES , NO |
DATASYNCVERSION | Die für den Zugriff auf diesen Treiber erforderliche Data Sync-Version. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | Die Kategorie „Datensynchronisierung“ dieses Treiber. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Ob erweiterte SQL-Funktionen über das hinaus, was die API bietet, unterstützt werden. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Ob Charge Operationen unterstützt werden. | YES , NO |
SQL_CAP | Alle unterstützten SQL-Funktionen für diesen Treiber. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | Ein Zeichenfolgenwert gibt die bevorzugten Cacheoptionen an. | |
ENABLE_EF_ADVANCED_QUERY | Gibt an, ob der Treiber erweiterte Abfragen aus dem Entity Framework direkt unterstützt. Wenn nicht, werden die Abfragen clientseitig verarbeitet. | YES , NO |
PSEUDO_COLUMNS | Ein Zeichenfolgenarray, das die verfügbaren Pseudospalten angibt. | |
MERGE_ALWAYS | Wenn der Wert „true“ ist, wird der Merge-Modus in der Datensynchronisierung zwangsweise ausgeführt. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | Eine Abfrage zum Zurückgeben des Startdatums und der Startzeit der Replikation. | |
REPLICATION_MIN_FUNCTION | Ermöglicht einem Anbieter, den Formelnamen anzugeben, der zum Ausführen eines serverseitigen Minimums verwendet werden soll. | |
REPLICATION_START_DATE | Ermöglicht einem Anbieter, ein Replikationsstartdatum anzugeben. | |
REPLICATION_MAX_DATE_QUERY | Eine Abfrage zum Zurückgeben des Enddatums und der Endzeit der Replikation. | |
REPLICATION_MAX_FUNCTION | Ermöglicht einem Anbieter, den Formelnamen anzugeben, der zur Ausführung eines serverseitigen Max. verwendet werden soll. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | Eine Liste von Tabellen, bei denen das Aufteilen der Replikation in Blöcke bei der ersten Replikation übersprungen wird. | |
CHECKCACHE_USE_PARENTID | Gibt an, ob die CheckCache-Anweisung für die übergeordnete Schlüsselspalte ausgeführt werden soll. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Gibt gespeicherte Prozeduren an, die zum Generieren von Schema verwendet werden können. |
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
Name | Typ | Beschreibung |
---|---|---|
NAME | String | Eine Komponente der SQL-Syntax oder eine Funktion, die auf dem Server verarbeitet werden kann. |
VALUE | String | Details zum unterstützten SQL bzw. zur SQL-Syntax. |
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
Name | Typ | Beschreibung |
---|---|---|
Id | String | Die von einer Operation zurückgegebene, von der Datenbank generierte ID. |
Batch | String | Eine Kennung für den Charge. 1 für einen einzelnen Operation. |
Operation | String | Das Ergebnis der Operation im Charge: EINGEFÜGT, AKTUALISIERT oder GELÖSCHT. |
Message | String | SUCCESS oder eine Fehlermeldung, wenn das Update im Charge fehlgeschlagen ist. |
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.
Eigenschaft | Beschreibung |
---|---|
AuthScheme | Der zu verwendende Authentifizierungstyp für die Verbindung mit Google Directory. |
Eigenschaft | Beschreibung |
---|---|
InitiateOAuth | Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten. |
OAuthClientId | Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren. |
OAuthClientSecret | Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren. |
OAuthAccessToken | Der Zugriffstoken für die Verbindung mittels OAuth. |
OAuthSettingsLocation | Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://' . |
CallbackURL | 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. |
Scope | Geben Sie den Bereich an, um den ersten Zugriffs- und Aktualisierungstoken zu erhalten. |
OAuthVerifier | Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode. |
OAuthRefreshToken | Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken. |
OAuthExpiresIn | Die Lebensdauer des OAuth AccessToken in Sekunden. |
OAuthTokenTimestamp | Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde. |
Eigenschaft | Beschreibung |
---|---|
OAuthJWTCert | Der JWT-Zertifikatspeicher. |
OAuthJWTCertType | Der Typ des Schlüsselspeichers, der das JWT-Zertifikat enthält. |
OAuthJWTCertPassword | Das Passwort für das OAuth JWT-Zertifikat. |
OAuthJWTCertSubject | Der Betreff des OAuth-JWT-Zertifikats. |
OAuthJWTIssuer | Der Herausgeber des Java Web Token. |
OAuthJWTSubject | Das Benutzersubjekt, für das die Anwendung delegierten Zugriff anfordert. |
Eigenschaft | Beschreibung |
---|---|
SSLServerCert | Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL. |
Eigenschaft | Beschreibung |
---|---|
Location | Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren. |
BrowsableSchemas | Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA, TabelleB, TabelleC. |
Views | Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA, AnsichtB, AnsichtC. |
Eigenschaft | Beschreibung |
---|---|
CustomerId | Abfrage auf diesen Kunden beschränken. |
Domain | Abfragen auf diese Domäne beschränken. |
GroupId | Abfrage auf diese Gruppe beschränken. |
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. |
Other | Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet. |
Pagesize | Die maximale Anzahl der Ergebnisse, die pro Seite aus dem Google Directory zurückgegeben werden sollen. |
PseudoColumns | Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht. |
Timeout | Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird. |
UserDefinedViews | Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält. |
UserId | Abfrage auf diesen Benutzer beschränken. |
Authentifizierung
Dieser Abschnitt enthält eine vollständige Liste der Authentifizierungseigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
AuthScheme | Der zu verwendende Authentifizierungstyp für die Verbindung mit Google Directory. |
AuthScheme
Der Authentifizierungstyp, der bei der Verbindung mit Google Directory 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.
OAuth
Dieser Abschnitt enthält eine vollständige Liste der OAuth-Eigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
InitiateOAuth | Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten. |
OAuthClientId | Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren. |
OAuthClientSecret | Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren. |
OAuthAccessToken | Der Zugriffstoken für die Verbindung mittels OAuth. |
OAuthSettingsLocation | Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://' . |
CallbackURL | 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. |
Scope | Geben Sie den Bereich an, um den ersten Zugriffs- und Aktualisierungstoken zu erhalten. |
OAuthVerifier | Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode. |
OAuthRefreshToken | Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken. |
OAuthExpiresIn | Die Lebensdauer des OAuth AccessToken in Sekunden. |
OAuthTokenTimestamp | Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde. |
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:
OFF
: Gibt an, dass der OAuth-Flow vollständig vom Benutzer gehandhabt wird. Zur Authentifizierung ist ein OAuthAccessToken erforderlich.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.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%\GoogleDirectory 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%\GoogleDirectory 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:
Plattform | %APPDATA% |
---|---|
Windows | Der Wert der Umfeld APPDATA |
Mac | ~/Bibliothek/Anwendungsunterstützung |
Linux | ~/.config |
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
""
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.
Umfang
Geben Sie den Umfang an, um den ersten Zugriff und das Aktualisierungstoken zu erhalten.
Datentyp
string
Standardwert
""
Hinweise
Geben Sie den Umfang an, um den ersten Zugriff und das Aktualisierungstoken zu erhalten.
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.
Eigenschaft | Beschreibung |
---|---|
OAuthJWTCert | Der JWT-Zertifikatspeicher. |
OAuthJWTCertType | Der Typ des Schlüsselspeichers, der das JWT-Zertifikat enthält. |
OAuthJWTCertPassword | Das Passwort für das OAuth JWT-Zertifikat. |
OAuthJWTCertSubject | Der Betreff des OAuth-JWT-Zertifikats. |
OAuthJWTIssuer | Der Herausgeber des Java Web Token. |
OAuthJWTSubject | Das Benutzersubjekt, für das die Anwendung delegierten Zugriff anfordert. |
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:
Eigenschaft | Beschreibung |
---|---|
MY | Ein Zertifikatsspeicher, der persönliche Zertifikate mit den zugehörigen privaten Schlüsseln enthält. |
CA | Zertifikate der Zertifizierungsstelle. |
ROOT | Stammzertifikate. |
SPC | Zertifikate von Softwareherstellern. |
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:
Eigenschaft | Beschreibung |
---|---|
USER | Unter Windows gibt dies an, dass es sich bei dem Zertifikatspeicher um einen Zertifikatspeicher handelt, der dem aktuellen Benutzer gehört. Hinweis: Dieser Speichertyp ist in Java nicht verfügbar. |
MACHINE | Für Windows gibt dies an, dass es sich bei dem Zertifikatspeicher um einen Maschinenspeicher handelt. Hinweis: Dieser Speichertyp ist in Java nicht verfügbar. |
PFXFILE | Der Zertifikatsspeicher ist der Name einer PFX-Datei (PKCS12), die Zertifikate enthält. |
PFXBLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen Zertifikatsspeicher im PFX-Format (PKCS12) darstellt. |
JKSFILE | Der Zertifikatsspeicher ist der Name einer Java Key Store (JKS)-Datei, die Zertifikate enthält. Hinweis: Dieser Speichertyp ist nur in Java verfügbar. |
JKSBLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen Zertifikatsspeicher im Java Key Store-Format (JKS) darstellt. Hinweis: Dieser Speichertyp ist nur in Java verfügbar. |
PEMKEY_FILE | Der Zertifikatsspeicher ist der Name einer PEM-codierten Datei, die einen privaten Schlüssel und ein optionales Zertifikat enthält. |
PEMKEY_BLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (base64-codiert), die einen privaten Schlüssel und ein optionales Zertifikat enthält. |
PUBLIC_KEY_FILE | Der Zertifikatsspeicher ist der Name einer Datei, die ein PEM- oder DER-codiertes öffentliches Schlüsselzertifikat enthält. |
PUBLIC_KEY_BLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die ein PEM- oder DER-codiertes öffentliches Schlüsselzertifikat enthält. |
SSHPUBLIC_KEY_FILE | Der Zertifikatsspeicher ist der Name einer Datei, die einen öffentlichen Schlüssel im SSH-Stil enthält. |
SSHPUBLIC_KEY_BLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen öffentlichen Schlüssel im SSH-Stil enthält. |
P7BFILE | Der Zertifikatsspeicher ist der Name einer PKCS7-Datei, die Zertifikate enthält. |
PPKFILE | Der Zertifikatsspeicher ist der Name einer Datei, die einen PPK (PuTTY Private Key) enthält. |
XMLFILE | Der Zertifikatsspeicher ist der Name einer Datei, die ein Zertifikat im XML-Format enthält. |
XMLBLOB | Der Zertifikatsspeicher ist eine Zeichenfolge, die ein Zertifikat im XML-Format enthält. |
GOOGLEJSON | Der Zertifikatsspeicher ist der Name einer JSON-Datei, die die Dienstkontoinformationen enthält. Nur gültig bei Verbindung mit einem Google-Dienst. |
GOOGLEJSONBLOB | Der Zertifikatsspeicher ist eine Zeichenfolge, die das JSON des Dienstkontos enthält. Nur gültig bei Verbindung mit einem Google-Dienst. |
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.
Feld | Bedeutung |
---|---|
CN | Allgemeiner Name. Dies ist normalerweise ein Host wie www.server.com. |
O | Organisation |
OU | Organisationseinheit |
L | Ort |
S | Staat |
C | Land |
E | Email Adresse |
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.
Eigenschaft | Beschreibung |
---|---|
SSLServerCert | Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL. |
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:
Beschreibung | Beispiel |
---|---|
Ein vollständiges PEM-Zertifikat (Beispiel der Kürze halber gekürzt) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
Ein Pfad zu einer lokalen Datei, die das Zertifikat enthält | C:\\cert.cer |
Der öffentliche Schlüssel (Beispiel der Kürze halber gekürzt) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
Der MD5-Fingerabdruck (Hex-Werte können auch durch Leerzeichen oder Doppelpunkte getrennt sein) | ecadbdda5a1529c58a1e9e09828d70e4 |
Der SHA1-Fingerabdruck (Hex-Werte können auch durch Leerzeichen oder Doppelpunkte getrennt sein) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
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.
Eigenschaft | Beschreibung |
---|---|
Location | Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren. |
BrowsableSchemas | Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA, TabelleB, TabelleC. |
Views | Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA, AnsichtB, AnsichtC. |
Standort
Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren.
Datentyp
string
Standardwert
%APPDATA%\GoogleDirectory 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%\GoogleDirectory Data Provider\Schema“ mit %APPDATA%
wird auf das Konfigurationsverzeichnis des Benutzers eingestellt:
Plattform | %APPDATA% |
---|---|
Windows | Der Wert der Umfeld APPDATA |
Mac | ~/Bibliothek/Anwendungsunterstützung |
Linux | ~/.config |
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.
Eigenschaft | Beschreibung |
---|---|
CustomerId | Abfrage auf diesen Kunden beschränken. |
Domain | Abfragen auf diese Domäne beschränken. |
GroupId | Abfrage auf diese Gruppe beschränken. |
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. |
Other | Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet. |
Pagesize | Die maximale Anzahl der Ergebnisse, die pro Seite aus dem Google Directory zurückgegeben werden sollen. |
PseudoColumns | Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht. |
Timeout | Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird. |
UserDefinedViews | Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält. |
UserId | Abfrage auf diesen Benutzer beschränken. |
Kunden-ID
Beschränken Sie die Abfrage auf diesen Kunden.
Datentyp
string
Standardwert
my_customer
Hinweise
Diese Eigenschaft kann in der Verbindungszeichenfolge oder Abfrage festgelegt werden. Andernfalls verwendet der Connector die Kunden-ID des authentifizierten Benutzers. Sie können diesen Wert auch aus der Tabelle „Benutzer“ abrufen.
Domain
Abfragen auf diese Domain beschränken.
Datentyp
string
Standardwert
""
Hinweise
Der Domänenname (z. B. cdata.com). Verwenden Sie diese Verbindungseigenschaft, um Ergebnisse von nur einer Domäne zu erhalten.
Gruppen-ID
Beschränken Sie die Abfrage auf diese Gruppe.
Datentyp
string
Standardwert
""
Hinweise
Diese Eigenschaft muss in der Verbindungszeichenfolge oder Abfrage festgelegt werden. Andernfalls verwendet der Connector die erste gefundene Gruppen-ID. Sie können diesen Wert aus der Gruppentabelle abrufen.
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
Eigenschaft | Beschreibung |
---|---|
DefaultColumnSize | Legt die Standardlänge von Zeichenfolgefeldern fest, wenn die Datenquelle keine Spaltenlänge in den Metadaten bereitstellt. Der Standardwert ist 2000. |
ConvertDateTimeToGMT | Bestimmt, ob Datums-/Uhrzeitwerte in GMT statt in die lokale Zeit des Computers konvertiert werden sollen. |
RecordToFile=filename | Protokolliert den zugrunde liegenden Socket-Datenübertragungsvorgang in die angegebene Datei. |
Seitengröße
Die maximale Anzahl der Ergebnisse, die pro Seite aus dem Google Directory zurückgegeben werden sollen.
Datentyp
int
Standardwert
100
Hinweise
Der Pagesize
Die Eigenschaft beeinflusst die maximale Anzahl von Ergebnissen, die pro Seite aus dem Google Directory zurückgegeben werden. Wenn Sie einen höheren Wert festlegen, ist die Leistung möglicherweise besser, allerdings wird pro belegter Seite mehr Speicher zugewiesen.
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. „*=*“.
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 Group 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
Beachten Sie, dass der angegebene Pfad nicht in Anführungszeichen steht.
Benutzer-ID
Beschränken Sie die Abfrage auf diesen Benutzer.
Datentyp
string
Standardwert
""
Hinweise
Die ID des Benutzers. Wenn nicht angegeben, wird der erste Benutzer aus der Benutzertabelle verwendet.