Zum Inhalt springen

Amazon Athena-Verbindungsdetails

Einführung

Connector-Version

Diese Dokumentation basiert auf Version 23.0.8803 des Connectors.

Erste Schritte

Unterstützung für Amazon Athena-Version

Der Amazon Athena Connector stellt eine Verbindung mit der Amazon Athena Web Services API her.

Herstellen einer Verbindung

Herstellen einer Verbindung mit Amazon Athena

Geben Sie Folgendes an, um eine Verbindung zu Daten herzustellen:

  • DataSource: Der Name der Amazon Athena-Datenquelle, mit der eine Verbindung hergestellt werden soll.
  • Database: Der Name der Amazon Athena-Datenbank, mit der eine Verbindung hergestellt werden soll.
  • AWSRegion: Legen Sie dies auf die Region fest, in der Ihre Amazon Athena-Daten gehostet werden.
  • S3StagingDirectory: Legen Sie hier einen Ordner in S3 fest, in dem Sie die Ergebnisse von Abfragen speichern möchten.

Wenn Database Und DataSource nicht angegeben sind, versucht der Connector, alle Datenbanken aus den verfügbaren Datenquellen in Amazon Athena aufzulisten. Das Festlegen beider Eigenschaften verbessert die Leistung des Connectors.

Authentifizieren bei Amazon Athena

Zusätzlich zur Angabe der grundlegenden Verbindungsinformationen, die für alle Verbindungen erforderlich sind, müssen Sie eine der folgenden Authentifizierungsmethoden auswählen.

AWS-Schlüssel abrufen

So erhalten Sie die Anmeldeinformationen für einen IAM-Benutzer:

  1. Melden Sie sich bei der IAM-Konsole an.
  2. Wählen Sie im Navigationsbereich Users.
  3. Um die Zugriffsschlüssel für einen Benutzer zu erstellen oder zu verwalten, wählen Sie den Benutzer aus und gehen Sie dann zu Security Credentials Tab.

So erhalten Sie die Anmeldeinformationen für Ihr AWS-Root-Konto:

  1. Melden Sie sich mit den Anmeldeinformationen für Ihr Root-Konto bei der AWS-Managementkonsole an.
  2. Wählen Sie Ihren Kontonamen oder Ihre Kontonummer.
  3. Wählen Sie im angezeigten Menü My Security Credentials.
  4. Um Root-Konto-Zugriffsschlüssel zu verwalten oder zu erstellen, klicken Sie auf Continue to Security Credentials und erweitern Sie den Abschnitt „Zugriffsschlüssel“.
Stammanmeldeinformationen

Um sich mit den Root-Anmeldeinformationen des Kontos zu authentifizieren, legen Sie diese Konfigurationsparameter fest:

  • AuthScheme: AwsRootKeys.
  • AWSAccessKey: Der mit dem AWS-Root-Konto verknüpfte Zugriffsschlüssel.
  • AWSSecretKey: Der geheime Schlüssel, der mit dem AWS-Root-Konto verknüpft ist.

Hinweis

Amazon rät von der Verwendung dieses Authentifizierungsschemas für alles andere als einfache Tests ab. Die Root-Anmeldeinformationen des Kontos verfügen über die vollständigen Berechtigungen des Benutzers, was diese Authentifizierungsmethode zur am wenigsten sicheren macht.

Temporäre Anmeldeinformationen

Um sich mit temporären Anmeldeinformationen zu authentifizieren, geben Sie Folgendes an:

  • AuthScheme: Setzen Sie dies auf TemporaryCredentials.
  • AWSAccessKey: Der Zugriffsschlüssel des IAM-Benutzers, für den die Rolle übernommen werden soll.
  • AWSSecretKey: Der geheime Schlüssel des IAM-Benutzers, für den die Rolle übernommen werden soll.
  • AWSSessionToken: Ihr AWS-Sitzungstoken. Dieses wird zusammen mit Ihren temporären Anmeldeinformationen bereitgestellt. Siehe AWS Identity and Access Management-Benutzerhandbuch für weitere Informationen.

Der Connector kann nun Ressourcen mit denselben Berechtigungen anfordern, die durch langfristige Anmeldeinformationen (z. B. IAM-Benutzeranmeldeinformationen) für die Lebensdauer der temporären Anmeldeinformationen bereitgestellt werden.

Wenn Sie zur Authentifizierung auch eine IAM- Rolle verwenden, müssen Sie zusätzlich Folgendes angeben:

  • AWSRoleARN: Geben Sie die Rollen-ARN für die Rolle an, mit der Sie sich authentifizieren möchten. Dadurch versucht der Connector, Anmeldeinformationen für die angegebene Rolle abzurufen.
  • AWSExternalId (optional): Nur erforderlich, wenn Sie eine Rolle in einem anderen AWS-Konto übernehmen.
EC2-Instanzen

Satz AuthScheme Zu AwsEC2Roles.

Wenn Sie den Connector von einer EC2-Instanz aus verwenden und der Instanz eine IAM-Rolle zugewiesen haben, können Sie die IAM-Rolle zur Authentifizierung verwenden. Da der Connector Ihre IAM-Rollenanmeldeinformationen automatisch abruft und sich mit ihnen authentifiziert, ist es nicht erforderlich, anzugeben AWSAccessKey Und AWSSecretKey.

Wenn Sie zur Authentifizierung auch eine IAM- Rolle verwenden, müssen Sie zusätzlich Folgendes angeben:

  • AWSRoleARN: Geben Sie die Rollen-ARN für die Rolle an, mit der Sie sich authentifizieren möchten. Dadurch versucht der Connector, Anmeldeinformationen für

    die angegebene Rolle.

  • AWSExternalId (optional): Nur erforderlich, wenn Sie eine Rolle in einem anderen AWS-Konto übernehmen.

IMDSv2-Unterstützung

Der Amazon Athena-Connector unterstützt jetzt IMDSv2. Im Gegensatz zu IMDSv1 erfordert die neue Version ein Authentifizierungstoken. Endpoints und Antworten sind in beiden Versionen gleich.

In IMDSv2 versucht der Amazon Athena-Connector zunächst, das IMDSv2-Metadatentoken abzurufen und verwendet es dann, um AWS- Endpoints aufzurufen. Wenn das Token nicht abgerufen werden kann, kehrt der Connector zu IMDSv1 zurück.

{: #section}
AWS IAM-Rollen

Satz AuthScheme Zu AwsIAMRoles.

In vielen Situationen kann es vorzuziehen sein, eine IAM- Rolle zur Authentifizierung zu verwenden, anstatt die direkten Sicherheitsanmeldeinformationen eines AWS-Root-Benutzers. Wenn Sie die AWSAccessKey Und AWSSecretKey eines AWS-Root-Benutzers dürfen Sie keine Rollen verwenden.

Um sich als AWS- Rolle zu authentifizieren, legen Sie diese Eigenschaften fest:

  • AWSAccessKey: Der Zugriffsschlüssel des IAM-Benutzers, für den die Rolle übernommen werden soll.

  • AWSSecretKey: Der geheime Schlüssel des IAM-Benutzers, für den die Rolle übernommen werden soll.

  • AWSRoleARN: Geben Sie die Rollen-ARN für die Rolle an, mit der Sie sich authentifizieren möchten. Dadurch versucht der Connector, Anmeldeinformationen für

    die angegebene Rolle.

  • AWSExternalId (optional): Nur erforderlich, wenn Sie eine Rolle in einem anderen AWS-Konto übernehmen.

ADFS

Um eine Verbindung zu ADFS herzustellen, setzen Sie AuthScheme Zu ADFS, und legen Sie diese Eigenschaften fest:

  • User: Der ADFS-Benutzer.
  • Password: Das Passwort des ADFS-Benutzers.
  • SSOLoginURL: Die Login URL des SSO-Anbieters.

Beispiel-Verbindungszeichenfolge:

AuthScheme=ADFS; AWSRegion=Ireland; Database=sampledb; User=user@cdata.com; Password=CH8WerW121235647iCa6; SSOLoginURL='https://adfs.domain.com'; AWSRoleArn=arn:aws:iam:1234:role/ADFS_SSO; AWSPrincipalArn=arn:aws:iam:1234:saml-provider/ADFSProvider; S3StagingDirectory=s3://athena/staging;
Okta

Um eine Verbindung mit Okta herzustellen, setzen Sie die AuthScheme Zu Okta, und legen Sie diese Eigenschaften fest:

  • User: Der Okta Benutzer.
  • Password: Das Passwort des Okta Benutzers.
  • SSOLoginURL: Die Login URL des SSO-Anbieters.

Wenn Sie eine vertrauenswürdige Anwendung oder einen Proxy verwenden, der die Okta Clientanforderung überschreibt, ODER MFA konfigurieren, müssen Sie Kombinationen aus verwenden SSOProperties zur Authentifizierung mit Okta. Legen Sie je nach Bedarf die folgenden Optionen fest:

  • APIToken: Wenn Sie einen Benutzer über eine vertrauenswürdige Anwendung oder einen Proxy authentifizieren, der den Anforderungskontext des Okta Clients überschreibt, legen Sie dies auf das API Token fest, das der Kunde aus der Okta-Organisation erstellt hat.

  • MFAType: Wenn Sie den MFA-Flow konfiguriert haben, legen Sie ihn auf einen der folgenden unterstützten Typen fest: OktaVerify, Email, oder SMS.

  • MFAPassCode: Wenn Sie den MFA-Flow konfiguriert haben, legen Sie hier einen gültigen Passcode fest.

    Wenn Sie dies auf leer oder einen ungültigen Wert setzen, sendet der Connector eine Einmalkennwort-Abfrage an Ihr Gerät oder Email. Nachdem der Passcode empfangen wurde, öffnen Sie die Verbindung erneut, wobei der abgerufene Einmalkennwortwert auf die Verbindungseigenschaft MFAPassCode gesetzt wird.

  • MFARememberDevice: True standardmäßig. Okta unterstützt das Speichern von Geräten, wenn MFA erforderlich ist. Wenn das Speichern von Geräten gemäß den konfigurierten Authentifizierungsrichtlinien zulässig ist, sendet der Connector ein Gerätetoken, um die Lebensdauer der MFA-Authentifizierung zu verlängern. Wenn Sie nicht möchten, dass MFA gespeichert wird, setzen Sie diese Variable auf False.

Beispiel-Verbindungszeichenfolge:

AuthScheme=Okta; AWSRegion=Ireland; Database=sampledb; User=user@cdata.com; Password=CH8WerW121235647iCa6; SSOLoginURL='https://cdata-us.okta.com/home/amazon_aws/0oa35m8arsAL5f5NrE6NdA356/272'; SSOProperties='ApiToken=01230GGG2ceAnm_tPAf4MhiMELXZ0L0N1pAYrO1VR-hGQSf;'; AWSRoleArn=arn:aws:iam:1234:role/Okta_SSO; AWSPrincipalARN=arn:aws:iam:1234:saml-provider/OktaProvider; S3StagingDirectory=s3://athena/staging;

Um eine Verbindung zu PingFederate herzustellen, setzen Sie AuthScheme Zu PingFederate, und legen Sie diese Eigenschaften fest:

  • User: Der PingFederate-Benutzer.
  • Password: Das Passwort des PingFederate-Benutzers.
  • SSOLoginURL: Die Login URL des SSO-Anbieters.
  • AWSRoleARN (optional): Wenn Sie mehrere Rolle-ARNs haben, geben Sie die an, die Sie für die Autorisierung verwenden möchten.
  • AWSPrincipalARN (optional): Wenn Sie mehrere Haupt-ARNs haben, geben Sie die an, die Sie für die Autorisierung verwenden möchten.
  • SSOExchangeUrl: Der Partner Service Identifier URI konfiguriert in Ihrer PingFederate-Serverinstanz unter: SP Connections > SP Connection > WS-Trust > Protocol Settings. Dies sollte eine PingFederate SP-Verbindung eindeutig identifizieren, daher ist es eine gute Idee, es auf Ihre einzustellen AWS SSO ACS URL. Sie finden es unter AWS SSO > Settings > View Details neben dem Authentication Feld.
  • SSOProperties (optional): Authscheme=Basic wenn Sie Ihren Benutzernamen und Ihr Passwort als Header in Anfragen an Amazon S3 einschließen möchten.

So aktivieren Sie die gegenseitige SSL-Authentifizierung für SSOLoginURL, der WS-Trust STS- Endpoint, konfigurieren Sie diese SSOProperties:

  • SSLClientCert
  • SSLClientCertType
  • SSLClientCertSubject
  • SSLClientCertPassword

Beispiel-Verbindungszeichenfolge:

authScheme=pingfederate;SSOLoginURL=https://mycustomserver.com:9033/idp/sts.wst;SSOExchangeUrl=https://us-east-1.signin.aws.amazon.com/platform/saml/acs/764ef411-xxxxxx;user=admin;password=PassValue;AWSPrincipalARN=arn:aws:iam:215338515180:saml-provider/pingFederate;AWSRoleArn=arn:aws:iam:215338515180:role/SSOTest2;AWSRegion=Ireland;S3StagingDirectory=s3://somedirectory/staging;Database=athenadatabase;
MFA

Geben Sie für Benutzer und Rollen, die eine Multi-Faktor-Authentifizierung erfordern, zur Authentifizierung Folgendes an:

  • AuthScheme: Setzen Sie dies auf AwsMFA.
  • CredentialsLocation: Der Speicherort der Einstellungsdatei, in der die MFA-Anmeldeinformationen gespeichert sind. Weitere Informationen finden Sie auf der Seite „Speicherort der Anmeldeinformationsdatei“ unter „Verbindungszeichenfolgenoptionen“.
  • MFASerialNumber: Die Seriennummer des MFA-Geräts, falls eines verwendet wird.
  • MFAToken: Das temporäre Token, das von Ihrem MFA-Gerät verfügbar ist.

Wenn Sie eine Verbindung zu AWS herstellen (anstatt bereits verbunden zu sein, z. B. mit einer EC2-Instanz), müssen Sie zusätzlich Folgendes angeben:

  • AWSAccessKey: Der Zugriffsschlüssel des IAM-Benutzers, für den MFA ausgestellt wird.
  • AWSSecretKey: Der geheime Schlüssel des IAM-Benutzers, dem MFA ausgestellt wird.

Wenn Sie zur Authentifizierung auch eine IAM- Rolle verwenden, müssen Sie zusätzlich Folgendes angeben:

  • AWSRoleARN: Geben Sie die Rollen-ARN für die Rolle an, mit der Sie sich authentifizieren möchten. Dadurch versucht der Connector, mithilfe von MFA Anmeldeinformationen für die angegebene Rolle abzurufen.
  • AWSExternalId (optional): Nur erforderlich, wenn Sie eine Rolle in einem anderen AWS-Konto übernehmen.

Dies bewirkt, dass der Connector die MFA-Anmeldeinformationen in einer Anforderung zum Abrufen temporärer Authentifizierungsanmeldeinformationen übermittelt.

Beachten Sie, dass Sie die Dauer der temporären Anmeldeinformationen steuern können, indem Sie den TemporaryTokenDuration-Eigenschaft (Standard 3600 Sekunden).

Anmeldeinformationsdateien

Sie können zur Authentifizierung eine Datei mit Anmeldeinformationen verwenden. Alle Konfigurationen im Zusammenhang mit AccessKey/SecretKey-Authentifizierung, temporären Anmeldeinformationen, Rolle oder MFA können verwendet werden. Legen Sie dazu die folgenden Eigenschaften zur Authentifizierung fest:

  • AuthScheme: Setzen Sie dies auf AwsCredentialsFile.
  • AWSCredentialsFile: Legen Sie hier den Speicherort Ihrer Anmeldeinformationsdatei fest.
  • AWSCredentialsFileProfile (optional): Legen Sie hier optional den Namen des Profils fest, das Sie aus der angegebenen Anmeldeinformationsdatei verwenden möchten. Wenn nicht angegeben, wird das Profil mit dem Namen default verwendet.

Siehe AWS Command Line Interface User Guide für weitere Informationen.

AWS Cognito-Anmeldeinformationen

Wenn Sie den Connector mit einem Benutzer verwenden möchten, der in einem Benutzerpool in AWS Cognito registriert ist, legen Sie zur Authentifizierung die folgenden Eigenschaften fest:

  • AuthScheme: Setzen Sie dies auf AwsCognitoSrp (empfohlen). Sie können auch AwsCognitoBasic verwenden.
  • AWSCognitoRegion: Stellen Sie dies auf die Region des Benutzerpools ein.
  • AWSUserPoolId: Setzen Sie dies auf die Benutzerpool-ID.
  • AWSUserPoolClientAppId: Setzen Sie dies auf die Client-App-ID des Benutzerpools.
  • AWSUserPoolClientAppSecret: Setzen Sie dies auf das Client-Geheimnis des Benutzerpools.
  • AWSIdentityPoolId: Setzen Sie dies auf die Identitätspool-ID des Identitätspools, der mit dem Benutzerpool verknüpft ist.
  • User: Setzen Sie dies auf den Benutzernamen des im Benutzerpool registrierten Benutzers.
  • Password: Setzen Sie dies auf das Passwort des im Benutzerpool registrierten Benutzers.
Azure Active Directory/ Microsoft Entra ID

Notiz

Azure AD ist jetzt Microsoft Entra ID.

Diese Konfiguration verwendet den 2.0 On-Behalf-Of-Flow (Microsoft Identity Platform und OAuth 2.0 On-Behalf-Of-Flow), wofür zwei Microsoft Entra-Anwendungen erforderlich sind:

  • die Anwendung „Amazon Athena“, die für die einmalige Anmeldung verwendet wird
  • eine separate „Connector“-Anwendung mit user_impersonation-Berechtigung für die Anwendung „Amazon Athena“

Sie müssen die in Microsofts AWS Single-Account Access beschriebenen Schritte befolgen Dokumentation zum Erstellen der SSO-Anwendung und Festlegen der Microsoft Entra ID als SAML IdP für eine AWS-Einzelkonto-App.

Gehen Sie folgendermaßen vor, um eine Anwendung mit der Berechtigung „user_impersonation“ für die SSO-Anwendung zu erstellen:

  1. Melden Sie sich beim Microsoft Entra Admin Center mindestens als Cloud-Anwendungsadministrator an.
  2. Navigieren Sie zu Identity > Applications > App registrations.
  3. Klicken Sie auf New application oben auf der Seite.
  4. Geben Sie einen Namen ein und wählen Sie nach Wunsch unterstützte Kontotypen aus.
  5. Wählen Sie Web in der Dropdown-Liste „Umleitungs-URI“ und geben Sie ein http://localhost:33333.
  6. Wählen Sie Register.
  7. Im Abschnitt „Übersicht“ können Sie Ihre OAuthClientId (Anwendungs-ID) sehen.
  8. Wählen Sie API permissions > Add a permission.
  9. Wählen Sie die API Ihrer SSO-Anwendung aus, indem Sie ihren Namen oder ihre Anwendungs-ID auf der Tab „Von meiner Organisation verwendete APIs “ angeben.
  10. Wählen Sie user_impersonation aus der verfügbaren Berechtigungsliste.
  11. Wählen Sie Add permissions.
  12. Auswählen Certificates & secrets.
  13. Auswählen New client secret.
  14. Geben Sie optional eine Beschreibung ein und ändern Sie den Standardwert „Ablauf“, und wählen Sie dann Add.
  15. Speichern Sie Ihr Client-Geheimnis (das angezeigte Feld „Wert“ des OAuth-Geheimnisses).

Nachdem Sie beide Anwendungen konfiguriert haben, geben Sie die folgenden OAuth-Verbindungseigenschaften an, um eine Verbindung mit dem Treiber herzustellen:

  • OAuthClientId: Die Anwendungs-ID der Connector-Anwendung, die im Abschnitt „Übersicht“ der Anwendungsregistrierung aufgeführt ist.
  • OAuthClientSecret: Der geheime Clientschlüsselwert der Connector-Anwendung. Microsoft Entra ID zeigt diesen an, wenn Sie einen neuen geheimen Clientschlüssel erstellen.
  • CallbackURL: Legen Sie hier die Umleitungs-URI der Connector-Anwendung fest. Beispiel: https://localhost:33333.
  • InitiateOAuth: GETANDREFRESH.

Verwenden Sie die folgenden SSO-Eigenschaften zur Authentifizierung bei Microsoft Entra ID:

  • Ressource: Die Anwendungs-ID-URI der Amazon Athena-Anwendung, die im Abschnitt „Übersicht“ der Anwendungsregistrierung aufgeführt ist. In den meisten Fällen ist dies die URL Ihrer benutzerdefinierten Amazon Athena Domäne.
  • AzureTenant: Die ID des Microsoft Entra ID Mandanten, bei dem die Anwendungen registriert sind.

Nachfolgend sehen Sie ein Beispiel für eine Verbindungszeichenfolge:

AuthScheme=AzureAD;InitiateOAuth=GETANDREFRESH;OAuthClientId=3ea1c786-d527-4399-8c3b-2e3696ae4b48;OauthClientSecret=xxx;CallbackUrl=https://localhost:33333;SSOProperties='Resource=https://signin.aws.amazon.com/saml;AzureTenant=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';

Optimieren des Datenzugriffs

Anpassen des Amazon Athena-Verhaltens

Führen Sie die folgenden Schritte aus, um die Connector-Standardeinstellungen für die Abfrage von Amazon Athena zu konfigurieren.

Verwenden von QueryPassthrough

Amazon Athena unterstützt eine Reihe von Abfragen, die nicht im regulären SQL-92-Standard angegeben sind. Um diese Abfragen auszuführen, setzen Sie einfach QueryPassthrough auf true. Dadurch wird die Abfrage direkt an Amazon Athena weitergeleitet, ohne sie intern zu analysieren.

Verschachtelte Objekte und Arrays vereinfachen

Der Connector kann Array-Elemente und Objekteigenschaften in Spalten zusammenfassen. Siehe die Seiten für FlattenArrays Und FlattenObjects für weitere Informationen.

Abfrageergebnisse nach S3 verschlüsseln

Satz EncryptionKey Und EncryptionType wenn Sie den in S3 gespeicherten Ergebnissatz nach der Abfrageausführung verschlüsseln möchten.

Um in S3 gespeicherte Ergebnisse zu verschlüsseln, führen Sie die folgenden Schritte aus:

  1. Navigieren Sie zur Amazon Athena Konsole.
  2. Klicken Sie auf „Einstellungen“.
  3. Aktivieren Sie die Option „Abfrageergebnisse verschlüsseln“.
  4. Wählen Sie den Verschlüsselungstyp und stellen Sie ein EncryptionType wenn Sie eine Verbindung herstellen.
  5. Wenn Sie SSE-KMS oder CSE-KMS ausgewählt haben, legen Sie beide fest EncryptionType Und EncryptionKey: Wählen Sie im Menü einen Verschlüsselung aus oder klicken Sie auf „KMS-Schlüssel erstellen“.

Leistung

Bereinigen Sie die Abfrageergebnisse

Amazon Athena speichert die Ergebnisse jeder Abfrage, die Sie ausführen, in CSV-Dateien in S3StagingDirectory; diese können schnell viel Platz in Amazon S3 beanspruchen. Sie können verwenden CleanQueryResults, standardmäßig aktiviert, um diese Dateien bei jeder ausgeführten Abfrage zu bereinigen.

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

Verwenden Sie Athenas Abfrage-Caching

Sie konfigurieren QueryCachingLevel um die Verwendung der in gespeicherten Abfrage zu ändern S3StagingDirectory; beachten Sie, dass Sie die Verbindung offen halten müssen, um von dieser Funktion zu profitieren. Dies ist besonders hilfreich, wenn eine bestimmte Abfrage mehrmals ausgeführt wird. Das bedeutet, dass Amazon Athena dieselben Daten nicht erneut scannt und einfach die Ergebnisse der vorherigen Ausführung verwendet. Diese Ergebnisse werden in der in angegebenen Sekundenzahl bereinigt QueryTolerance.

Beachten Sie, dass eine fehlerhafte Trennung der Verbindung bei QueryCachingLevel ist auf Cloud eingestellt, was zu einer großen Anzahl gespeicherter Abfragen in Athena führen kann. Für die meisten Anwendungsfälle ist die Einstellung QueryCachingLevel zu Local sollte genügen.

Feinabstimmung der Leistung

Sie können verwenden PageSize Eigenschaft zur Optimierung der Nutzung Ihres bereitgestellten Durchsatzes, basierend auf der Größe Ihrer Elemente und der Seitengröße von 1000 MB von Amazon Athena. Legen Sie diese Eigenschaft auf die Anzahl der zurückzugebenden Elemente fest.

Im Allgemeinen verringert eine kleinere Seitengröße Durchsatzspitzen, die zu einer drosselung führen. Eine kleinere Seitengröße fügt außerdem Pausen zwischen den Anfragen ein. Dieses Intervall gleicht die Verteilung der Anfragen aus und ermöglicht durch Vermeidung einer drosselung, dass mehr Anfragen erfolgreich sind.

Mindestanforderungen für IAM

Wir empfehlen, vordefinierte Rollen für Dienste zu verwenden, anstatt benutzerdefinierte IAM-Richtlinien zu erstellen. Wenn Sie jedoch benutzerdefinierte Richtlinien erstellen möchten, verwenden Sie die in der folgenden Tabelle beschriebenen Rollen. Beachten Sie, dass die vom Amazon Athena Treiber benötigten spezifischen Richtlinien in zukünftigen Versionen geändert werden können. Amazon Athena erfordert mindestens die folgenden Berechtigungen:

IAM-Rolle Beschreibung
s3:Bucketliste Listet alle Elemente der Quell-Buckets auf. Diese Elemente sind normalerweise die Tabellen, aus denen Sie Daten Abfrage möchten. Diese Aktion unterstützt Berechtigungen auf Ressourcenebene, sodass Sie die Buckets in „Ressource“ angeben können.
s3:Objekt abrufen Lesen Sie die Datei mit den Daten, die Sie Abfrage möchten. Sie können die Berechtigung zum Lesen bestimmter Elemente im Bucket erteilen, z. B. arn:aws:s3::source-bucket1/Customers.csv, oder die Berechtigung zum Lesen aller Elemente im Bucket erteilen, z. B. arn:aws:s3::source-bucket1/*.
s3:BucketLocation abrufen
s3:Objekt abrufen
s3:Bucket-Liste
s3:ListBucketMultipartUploads
s3:AbortMultipartUpload
s3:Objekt einfügen
s3:ListMultipartUploadParts
s3:Objekt löschen
Diese Aktionen müssen gleichzeitig aktiv sein, um die Ergebnisse der Abfrage in den Ziel-Bucket zu schreiben, der der Verbindungseigenschaft S3StagingDirectory entspricht. Der Treiber liest dann die Metadaten und Daten von diesem Speicherort und löscht diese temporären Dateien am Ende. Weitere Informationen finden Sie unter Zugriff verweigert-Fehler.
athena:ListDataCatalogs Rufen Sie die Liste der Datenkataloge für das aktuelle AWS-Konto ab. Diese Aktion unterstützt keine ressourcenspezifischen Berechtigungen, daher ist die Ressource immer *.
athena:GetDataCatalog Metadaten zu einem bestimmten Datenkatalog abrufen. Diese Aktion unterstützt ressourcenspezifische Berechtigungen. Beispiel: Erteilen Sie allen Datenkatalogen in der Region Northern Virginia die Berechtigung: „Ressource“:
"arn:aws:athena:us-east-1:987654321098:datacatalog/*"
athena:GetTableMetadata Metadaten zu einer bestimmten Tabelle abrufen. Diese Aktion unterstützt ressourcenspezifische Berechtigungen, genau wie athena:GetDataCatalog.
athena:ListTableMetadata Listen Sie Tabellenmetadaten in einer Datenbank für einen bestimmten Datenkatalog auf. Diese Aktion unterstützt ressourcenspezifische Berechtigungen, genau wie athena:GetDataCatalog.
athena:StartQueryExecution Starten Sie die Ausführung einer Abfrage in Athena. Diese Aktion unterstützt ressourcenspezifische Berechtigungen. Beispielsweise erteilen Sie der primären Arbeitsgruppe in der Region Northern Virginia die Berechtigung: arn:aws:athena:us-east-1:987654321098:workgroup/primary
athena:GetQueryResults Abfrage abrufen. Diese Aktion unterstützt ressourcenspezifische Berechtigungen, genau wie athena:StartQueryExecution.
athena:GetQueryExecution Informationen zur Abfrage abrufen, um beispielsweise zu prüfen, ob die Abfrage noch ausgeführt wird. Diese Aktion unterstützt ressourcenspezifische Berechtigungen, genau wie athena:StartQueryExecution.
kleber:GetTables Listet die Tabellen in einer Datenbank auf. Diese Aktion unterstützt ressourcenspezifische Berechtigungen. So listen Sie beispielsweise alle Tabellen in der Region Northern Virginia auf:
 "Ressource": [
„arn:aws:glue:region123:111111111111:table/*/*“,
„arn:aws:glue:region123:111111111111:database/*“,
„arn:aws:glue:region123:111111111111:catalog“
]
glue:Datenbanken abrufen Listet alle Datenbanken in einem Datenkatalog auf. Diese Aktion unterstützt ressourcenspezifische Berechtigungen, genau wie glue:GetTables.
Kleber:GetTable Eine Tabelle abrufen. Diese Aktion unterstützt ressourcenspezifische Berechtigungen, genau wie glue:GetTables.

Föderierte Abfragen

Wenn Sie föderierte Abfragen verwenden, d. h. Lambda-Funktionen verwenden, um Daten aus anderen Quellen abzurufen, benötigen Sie auch Lambda-Berechtigungen. Um beispielsweise lambda:InvokeFunction Berechtigungen für eine Ressource mit dem Namen cloudwatchtest1 in Nord-Virginia:

{
"Effect": "Allow",
"Action": [
"lambda:InvokeFunction"
],
"Resource": [
"arn:aws:lambda:us-east-1:987654321098:function:cloudwatchtest1"
]
}

Nur die Lambda-Berechtigung ist optional. Alle anderen Berechtigungen sind erforderlich, um ein einfaches SELECT mit dem Treiber durchzuführen.

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 Amazon Athena-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 Amazon Athena und verarbeitet den Rest der Abfrage dann im Speicher (clientseitig).

Benutzerdefinierte Ansichten

Mit dem Amazon Athena-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 [AwsDataCatalog].[sampledb].Customers 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 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

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zu Amazon Athena. Sie können zum Suchen, Aktualisieren und Ändern von Informationen in Amazon Athena verwendet werden.

Systemtabellen

Systemtabellen sind ein bereitgestellter Satz von Tabellen, die Treiber enthalten. Sie können Systemtabellen verwenden, um auf Schema, Datenquellenfunktionen und Charge zuzugreifen.

Modellierungsobjekte

Amazon Athena Connector-Datenmodell

Der Connector extrahiert dynamisch alle relevanten Schema aus Amazon Athena über die REST API.

Schemas entdecken

Standardmäßig werden alle Amazon Athena Entitäten als Ansichten angezeigt. Der Connector kann Objekttypen aus der Amazon Athena API jedoch auch in die folgenden Typen unterteilen:

  • TISCH
  • SICHT
  • EXTERNAL_TABLE
  • VERWALTETE_TABELLE
  • VIRTUELLE_ANSICHT

Sie können diese Funktionalität aktivieren, indem Sie setzen MetadataDiscoveryMethod Zu Glue. Bei dieser Methode müssen Sie auch die erforderlichen IAM-Profile für den Benutzer hinzufügen.

Alternativ können Sie die Athena-Erkennungsmethode verwenden, diese ist jedoch langsamer.

  • MetadataDiscoveryMethod: Setzen Sie dies auf Athena.
  • IncludeTableTypes: Setzen Sie dies auf True.

Beachten Sie, dass der Connector Amazon Athena-Objekte zwar in diese Typen aufteilen kann, sie jedoch alle als betrachtet werden read-only. Stellen Sie die Verbindung erneut her, um alle Änderungen in den Metadaten zu laden, z. B. hinzugefügte oder entfernte Spalten oder Änderungen im Datentyp.

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT/INSERT-Operationen mit Amazon Athena hinaus erweitern.

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

Gespeicherte Prozeduren für den Amazon Athena Connector

Name Beschreibung
CreateSchema Erstellt eine Schema für die angegebene Tabelle oder Ansicht.
GetOAuthAccessToken Wenn Sie eine Windows-Anwendung verwenden, setzen Sie den Authmode auf App. Wenn Sie eine Web-Anwendung verwenden, setzen Sie den Authmode auf Web und geben Sie den von GetOAuthAuthorizationUrl erhaltenen Verifier an.
GetOAuthAuthorizationURL Ruft die Autorisierungs-URL ab.
RefreshOAuthAccessToken Aktualisiert das OAuth-Token oder die Sitzungs-ID, nachdem die Sitzung abgelaufen ist. In Ihrer OAuth-Anwendung muss der Bereich „refresh_token“ aktiviert sein.

Schema erstellen

Erstellt eine Schema für die angegebene Tabelle oder Ansicht.

Schema erstellen

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

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

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

Eingang
Name Typ Erforderlich Akzeptiert Ausgabestreams Beschreibung
TableName String True False Der Name der Tabelle oder Ansicht.
FileName String Falsch Falsch Der vollständige Dateipfad und Name des zu generierenden Schema. Beispiel: „C:\Benutzer\Benutzer\Desktop\Filter\Filters.rsd“
FileStream String Falsch Wahr Eine Instanz eines Ausgabestreams, in den Dateidaten geschrieben werden. Wird nur verwendet, wenn LocalFolderPath nicht festgelegt ist.
Ergebnissatzspalten
Name Typ Beschreibung
Result String Gibt „Erfolg“ oder „Fehler“ zurück.
FileData String Wenn die Eingabe „FileName“ leer ist.

GetOAuthAccessToken

Wenn Sie eine Windows Anwendung verwenden, legen Sie den Authmode auf App fest. Wenn Sie eine Web-App verwenden, legen Sie den Authmode auf Web fest und geben Sie den von GetOAuthAuthorizationUrl erhaltenen Verifier an.

Eingang
Name Typ Erforderlich Beschreibung
Authmode String Falsch Der zu verwendende Authentifizierungsmodustyp. Wählen Sie „App“, um Authentifizierungstoken über eine Desktop-App abzurufen. Wählen Sie „Web“, um Authentifizierungstoken über eine Web-App abzurufen. Die zulässigen Werte sind APP, WEB. Der Standardwert ist APP.
Verifier String Falsch Das Prüftoken wurde nach Verwendung der mit GetOAuthAuthorizationUrl erhaltenen URL zurückgegeben.
CallbackUrl String Falsch Die Seite, zu der der Benutzer nach Abschluss der Autorisierung zurückgeleitet werden soll.
State String Falsch Jeder Wert, der mit dem Rückruf gesendet werden soll.
GrantType String Falsch Autorisierungsgewährungstyp. Nur für OAuth 2.0 verfügbar. Wenn nicht angegeben, ist der Standardwert der Wert der Verbindungseigenschaft OAuthGrantType. Die zulässigen Werte sind CODE, PASSWORD.
Prompt String Falsch Standardmäßig ist „select_account“ eingestellt, wodurch der Benutzer bei der Authentifizierung aufgefordert wird, ein Konto auszuwählen. Auf „None“ eingestellt, um keine Eingabeaufforderung zu erhalten, auf „login“, um den Benutzer zur Eingabe seiner Anmeldeinformationen zu zwingen, oder auf „consent“, um nach der Anmeldung des Benutzers den OAuth-Zustimmungsdialog auszulösen, in dem der Benutzer aufgefordert wird, der App Berechtigungen zu erteilen.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Das OAuth-Zugriffstoken.
OAuthRefreshToken String Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens. Eine -1 bedeutet, dass es nicht abläuft.

GetOAuthAuthorizationURL

Ruft die Autorisierungs URL ab.

Eingang
Name Typ Erforderlich Beschreibung
CallbackUrl String Falsch Die Seite, auf die der Benutzer nach Abschluss der Autorisierung zurückgeleitet wird.
State String Falsch Jeder Wert, der mit dem Rückruf gesendet werden soll.
Prompt String Falsch Standardmäßig ist „select_account“ eingestellt, wodurch der Benutzer bei der Authentifizierung aufgefordert wird, ein Konto auszuwählen. Auf „None“ eingestellt, um keine Eingabeaufforderung zu erhalten, auf „login“, um den Benutzer zur Eingabe seiner Anmeldeinformationen zu zwingen, oder auf „consent“, um nach der Anmeldung des Benutzers den OAuth-Zustimmungsdialog auszulösen, in dem der Benutzer aufgefordert wird, der App Berechtigungen zu erteilen.
Ergebnissatzspalten
Name Typ Beschreibung
Url String Die Autorisierungs URL.

Aktualisieren Sie das OAuthAccessToken

Aktualisiert das OAuth-Token oder die Sitzungs-ID, nachdem die Sitzung abgelaufen ist. In Ihrer OAuth-Anwendung muss der Bereich „refresh_token“ aktiviert sein.

Eingang
Name Typ Erforderlich Beschreibung
OAuthRefreshToken String True Das Aktualisierungstoken wurde zurückgegeben, als das OAuth-Token erstmals erstellt wurde.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Das OAuth-Zugriffstoken.
OAuthRefreshToken String Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens. Eine -1 bedeutet, dass es nicht abläuft.

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

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, einschließlich Charge:

  • 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 Schemas 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 Tabelle [AwsDataCatalog].[sampledb].Customers zurück:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Customers' AND CatalogName='AwsDataCatalog' AND SchemaName='sampledb'
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 SelectEntries zurück:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' 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 Tabelle [AwsDataCatalog].[sampledb].Customers ab:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Customers' AND CatalogName='AwsDataCatalog' AND SchemaName='sampledb'
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:amazonathena: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 Anschlusspflicht besteht.
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.

Authentifizierung

Eigenschaft Beschreibung
AthenaVPCEndpoint Ihr Athena VPC- Endpoint. Er überschreibt den standardmäßigen Endpoint athena.{region}.amazonaws.com.
S3StagingDirectory Gibt den Speicherort an, den Amazon Athena zum Speichern der Ergebnisse einer Abfrage verwendet.
EncryptionType Gibt die Verschlüsselung für Abfrage in Athena an.
EncryptionKey Gibt den Verschlüsselung für die Verschlüsselung von in S3 gespeicherten Ergebnissen an.
DataSource Der Name der Athena-Datenquelle.
Database Der Name der Athena-Datenbank.

Verbindung

Eigenschaft Beschreibung
CrossAccountId Die zu verwendende Konto-ID beim Abrufen von Metadaten aus Glue. Standard ist die aktuelle Konto-ID.
SimpleUploadLimit Diese Einstellung gibt den Schwellenwert in Bytes an, oberhalb dessen der Anbieter einen mehrteiligen Upload durchführt, anstatt alles in einer Anfrage hochzuladen.
UseLakeFormation Wenn diese Eigenschaft auf „true“ gesetzt ist, wird der AWSLakeFormation-Dienst verwendet, um temporäre Anmeldeinformationen abzurufen, die basierend auf der konfigurierten IAM- Rolle Zugriffsrichtlinien für den Benutzer durchsetzen. Der Dienst kann bei der Authentifizierung über OKTA, ADFS, Microsoft Entra ID, PingFederate verwendet werden, während eine SAML Assertion bereitgestellt wird.

AWS-Authentifizierung

Eigenschaft Beschreibung
AuthScheme Das für die Authentifizierung verwendete Schema. Akzeptierte Einträge sind: Auto,, AwsRootKeys, AwsIAMRoles, AwsEC2Roles, AwsMFA, ADFS, Okta, PingFederate, AwsCredentialsFile, AwsCognitoBasic, AwsCognitoSrp.
AWSAccessKey Ihr AWS-Kontozugriffsschlüssel. Auf diesen Wert kann über die Seite mit den AWS-Sicherheitsanmeldeinformationen zugegriffen werden.
AWSSecretKey Ihr geheimer AWS-Kontoschlüssel. Auf diesen Wert kann über die Seite mit den AWS-Sicherheitsanmeldeinformationen zugegriffen werden.
AWSRoleARN Der Amazon-Ressourcenname der Rolle, die bei der Authentifizierung verwendet werden soll.
AWSPrincipalARN Die ARN des SAML Identitätsanbieters in Ihrem AWS-Konto.
AWSRegion Die Hosting-Region für Ihre Amazon Web Services.
AWSCredentialsFile Der Pfad zur AWS-Anmeldeinformationsdatei, die für die Authentifizierung verwendet werden soll.
AWSCredentialsFileProfile Der Name des zu verwendenden Profils aus der bereitgestellten AWSCredentialsFile.
AWSSessionToken Ihr AWS-Sitzungstoken.
AWSExternalId Eine eindeutige Kennung, die möglicherweise erforderlich ist, wenn Sie eine Rolle in einem anderen Konto übernehmen.
MFASerialNumber Die Seriennummer des MFA-Geräts, falls eines verwendet wird.
MFAToken Das temporäre Token, das auf Ihrem MFA-Gerät verfügbar ist.
TemporaryTokenDuration Die Dauer (in Sekunden), für die ein temporäres Token gültig ist.
AWSCognitoRegion Die Hosting-Region für AWS Cognito.
AWSUserPoolId Die Benutzerpool-ID.
AWSUserPoolClientAppId Die Client-App-ID des Benutzerpools.
AWSUserPoolClientAppSecret Optional. Das Client-App-Geheimnis des Benutzerpools.
AWSIdentityPoolId Die Identitätspool-ID.

SSO

Eigenschaft Beschreibung
User Der IDP-Benutzer, der zur Authentifizierung des IDP über SSO verwendet wird.
Password Das Passwort, das zur Authentifizierung des IDP-Benutzers über SSO verwendet wird.
SSOLoginURL Die Anmelde URL des Identitätsanbieters.
SSOProperties Zusätzliche Eigenschaften, die für die Verbindung mit dem Identitätsanbieter erforderlich sind, in einer durch Semikolon getrennten Liste.
SSOExchangeUrl Die URL, die zum Konsumieren der SAML -Antwort und zum Austauschen gegen dienstspezifische Anmeldeinformationen verwendet wird.

OAuth

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 eingestellt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://'.
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.
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.

SSL

Eigenschaft Beschreibung
SSLServerCert Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL.

Schema

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.
FlattenArrays Standardmäßig werden Arrays als JSON-Strings zurückgegeben. Mit der Eigenschaft FlattenArrays können die Elemente von Arrays in eigene Spalten umgewandelt werden. Legen Sie FlattenArrays auf die Anzahl der Elemente fest, die Sie aus Arrays zurückgeben möchten.
FlattenObjects Setzen Sie FlattenObjects auf true, um Objekteigenschaften in eigene Spalten zu reduzieren. Andernfalls werden in Arrays verschachtelte Objekte als JSON-Strings zurückgegeben.

Verschiedenes

Eigenschaft Beschreibung
CleanQueryResults Amazon Athena erstellt bei jeder Abfrage Cache-Dateien im in S3StagingDirectory angegebenen Ordner. CleanQueryResults gibt an, ob diese Dateien gelöscht werden sollen, sobald die Verbindung geschlossen wird.
EnableFIPSMode Ein Boolescher Wert, der angibt, ob FIPS- URLs aktiviert werden sollen.
IncludeTableTypes Wenn auf „true“ gesetzt, Abfrage der Anbieter die Typen der einzelnen Tabellen ab.
MaximumColumnSize Die maximale Spaltengröße.
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.
MetadataDiscoveryMethod Zu verwendende API zum Abrufen der Metadaten für Amazon Athena.
Other Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet.
PageSize Die Anzahl der zurückzugebenden Ergebnisse pro Seite mit von Amazon Athena abgerufenen Daten.
PollingInterval Hiermit wird das Polling-Intervall in Millisekunden festgelegt, um zu prüfen, ob das Ergebnis zum Abruf bereit steht.
PseudoColumns Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.
PushEmptyValuesAsNull Gibt an, ob die leeren Werte als leer oder als null gelesen werden sollen.
QueryCachingLevel Ändert die Verwendung von Abfrage, die im S3StagingDirectory gespeichert sind. Zwischengespeicherte Abfragen werden von Amazon Athena erst erneut gescannt, wenn die in QueryTolerance angegebene Anzahl von Sekunden verstrichen ist.
QueryPassthrough Diese Option übergibt die Abfrage unverändert an den Amazon Athena-Server.
QueryTimeout Das Timeout in Sekunden für vom Anbieter gesendete Anfragen zum Herunterladen großer Ergebnismengen.
QueryTolerance Gibt die Zeit in Sekunden an, für die Abfragen im Cache gespeichert werden, wenn QueryCachingLevel nicht auf „None“ festgelegt ist.
ShowS3Filepath Ob die Spalte _S3Path für die Amazon Athena-Tabellen verfügbar gemacht werden soll oder nicht.
SkipHeaderLineCount Gibt die Anzahl der Header an, die bei SELECT-Abfragen übersprungen werden sollen.
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.
Workgroup Arbeitsgruppe der ausgeführten Abfragen.

Authentifizierung

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

Eigenschaft Beschreibung
AthenaVPCEndpoint Ihr Athena VPC- Endpoint. Er überschreibt den standardmäßigen Endpoint athena.{region}.amazonaws.com.
S3StagingDirectory Gibt den Speicherort an, den Amazon Athena zum Speichern der Ergebnisse einer Abfrage verwendet.
EncryptionType Gibt die Verschlüsselung für Abfrage in Athena an.
EncryptionKey Gibt den Verschlüsselung für die Verschlüsselung von in S3 gespeicherten Ergebnissen an.
DataSource Der Name der Athena-Datenquelle.
Database Der Name der Athena-Datenbank.

AthenaVPCEndpoint

Ihr Athena VPC- Endpoint. Er überschreibt den Standardendpunkt athena.{region} Endpoint.

Datentyp

string

Standardwert

""

Hinweise

Ihr Athena VPC- Endpoint. Er überschreibt den Standardendpunkt athena.{region} Endpoint.

S3StagingDirectory

Gibt den Speicherort an, den Amazon Athena zum Speichern der Ergebnisse einer Abfrage verwendet.

Datentyp

string

Standardwert

""

Hinweise

Gibt den Speicherort an, den Amazon Athena zum Speichern der Ergebnisse einer Abfrage verwendet. Dieser Ordner kann im Laufe der Zeit Speicherplatz beanspruchen und Sie sollten ihn möglicherweise manuell bereinigen, wenn CleanQueryResults ist nicht aktiviert.

Verschlüsselungstyp

Gibt die Verschlüsselung für Abfrage in Athena an.

Mögliche Werte

None, SSE_S3, SSE_KMS, CSE_KMS

Datentyp

string

Standardwert

None

Hinweise

Gibt die Verschlüsselung für Abfrage in Athena an. Diese Option ist erforderlich, wenn Sie Amazon Athena so konfiguriert haben, dass Abfrage verschlüsseln werden. Setzen Sie EncryptionType und EncryptionKey, wenn Sie den in S3 gespeicherten Ergebnissatz nach der Abfrage verschlüsseln möchten. Beachten Sie, dass durch das Festlegen dieser Eigenschaften der Ergebnissatz in S3StagingDirectory nicht verschlüsseln wird.

Um Amazon Athena Abfrage zu verschlüsseln, führen Sie die folgenden Schritte aus:

  1. Navigieren Sie zur Amazon Athena Konsole.
  2. Klicken Sie auf „Einstellungen“.
  3. Aktivieren Sie die Option „Abfrageergebnisse verschlüsseln“.
  4. Wählen Sie den Verschlüsselungstyp.
  5. Wenn Sie SSE-KMS oder CSE-KMS ausgewählt haben, wählen Sie im Menü einen Verschlüsselung aus oder klicken Sie auf KMS-Schlüssel erstellen. Legen Sie EncryptionKey zusätzlich zu EncryptionType wenn Sie eine Verbindung herstellen.

Verschlüsselungsschlüssel

Gibt den Verschlüsselung beim Verschlüsseln der in S3 gespeicherten Ergebnisse an.

Datentyp

string

Standardwert

""

Hinweise

Gibt den Verschlüsselung für die Verschlüsselung von in S3 gespeicherten Ergebnissen an. Diese Option ist erforderlich, wenn der EncryptionType ist auf SSE_KMS oder CSE_KMS eingestellt.

EncryptionType einstellen Und EncryptionKey wenn Sie den in S3 gespeicherten Ergebnissatz nach der Abfrageausführung verschlüsseln möchten. Beachten Sie, dass dadurch der Ergebnissatz in S3StagingDirectory nicht verschlüsseln wird.

Verschlüsselung aktivieren

Informationen zum Aktivieren der Verschlüsselung der in S3 gespeicherten Ergebnisse finden Sie unter Feinabstimmung des Datenzugriffs.

Einen Verschlüsselungsschlüssel erhalten

Sie können einen Schlüssel erstellen, wenn Sie die Verschlüsselung aktivieren. Oder erstellen Sie einen Schlüssel in der IAM-Konsole: Klicken Sie auf „Verschlüsselungsschlüssel“, wählen Sie eine Region aus und klicken Sie dann auf „Schlüssel erstellen“. Um den Schlüssel abzurufen, melden Sie sich bei der AWS-Managementkonsole an und klicken Sie auf „Dienste“ -> „IAM“ -> „Verschlüsselungsschlüssel“ -> „Schlüssel erstellen“.

Datenquelle

Der Name der Athena-Datenquelle.

Datentyp

string

Standardwert

""

Hinweise

Die Datenquelle, mit der bei Abfragen an Athena eine Verbindung hergestellt werden soll. Für MetadataDiscoveryMethod=Glue wird AwsDataCatalog als Standarddatenquelle verwendet.

Datenbank

Der Name der Athena-Datenbank.

Datentyp

string

Standardwert

""

Hinweise

Die Datenbank, mit der bei Abfragen an Athena eine Verbindung hergestellt werden soll.

Verbindung

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

Eigenschaft Beschreibung
CrossAccountId Die zu verwendende Konto-ID beim Abrufen von Metadaten aus Glue. Standard ist die aktuelle Konto-ID.
SimpleUploadLimit Diese Einstellung gibt den Schwellenwert in Bytes an, oberhalb dessen der Anbieter einen mehrteiligen Upload durchführt, anstatt alles in einer Anfrage hochzuladen.
UseLakeFormation Wenn diese Eigenschaft auf „true“ gesetzt ist, wird der AWSLakeFormation-Dienst verwendet, um temporäre Anmeldeinformationen abzurufen, die basierend auf der konfigurierten IAM- Rolle Zugriffsrichtlinien für den Benutzer durchsetzen. Der Dienst kann bei der Authentifizierung über OKTA, ADFS, Microsoft Entra ID, PingFederate verwendet werden, während eine SAML Assertion bereitgestellt wird.

CrossAccountId

Die zu verwendende Konto-ID beim Abrufen von Metadaten aus Glue. Standardmäßig wird die aktuelle Konto-ID verwendet.

Datentyp

string

Standardwert

""

Hinweise

Wenn die Eigenschaft MetadataDiscoveryMethod auf „Glue“ eingestellt wurde, kann der Benutzer eine Cross-Account-ID angeben, für die er Zugriffsberechtigungen hat. Dieses Konto wird dann zum Abrufen von Metadaten verwendet. Weitere Informationen finden Sie hier: https://docs.aws.amazon.com/glue/latest/dg/cross-account-access.html

SimpleUploadLimit

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

Datentyp

string

Standardwert

""

Hinweise

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

Verwenden Sie LakeFormation

Wenn diese Eigenschaft auf „true“ gesetzt ist, wird der AWSLakeFormation-Dienst verwendet, um temporäre Anmeldeinformationen abzurufen, die Zugriffsrichtlinien für den Benutzer basierend auf der konfigurierten IAM- Rolle durchsetzen. Der Dienst kann bei der Authentifizierung über OKTA, ADFS, Microsoft Entra ID, PingFederate verwendet werden, während eine SAML Assertion bereitgestellt wird.

Datentyp

bool

Standardwert

false

Hinweise

Wenn diese Eigenschaft auf „true“ gesetzt ist, wird der AWSLakeFormation-Dienst verwendet, um temporäre Anmeldeinformationen abzurufen, die Zugriffsrichtlinien für den Benutzer basierend auf der konfigurierten IAM- Rolle durchsetzen. Der Dienst kann bei der Authentifizierung über OKTA, ADFS, Microsoft Entra ID, PingFederate verwendet werden, während eine SAML Assertion bereitgestellt wird.

AWS-Authentifizierung

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

Eigenschaft Beschreibung
AuthScheme Das für die Authentifizierung verwendete Schema. Akzeptierte Einträge sind: Auto,, AwsRootKeys, AwsIAMRoles, AwsEC2Roles, AwsMFA, ADFS, Okta, PingFederate, AwsCredentialsFile, AwsCognitoBasic, AwsCognitoSrp.
AWSAccessKey Ihr AWS-Kontozugriffsschlüssel. Auf diesen Wert kann über die Seite mit den AWS-Sicherheitsanmeldeinformationen zugegriffen werden.
AWSSecretKey Ihr geheimer AWS-Kontoschlüssel. Auf diesen Wert kann über die Seite mit den AWS-Sicherheitsanmeldeinformationen zugegriffen werden.
AWSRoleARN Der Amazon-Ressourcenname der Rolle, die bei der Authentifizierung verwendet werden soll.
AWSPrincipalARN Die ARN des SAML Identitätsanbieters in Ihrem AWS-Konto.
AWSRegion Die Hosting-Region für Ihre Amazon Web Services.
AWSCredentialsFile Der Pfad zur AWS-Anmeldeinformationsdatei, die für die Authentifizierung verwendet werden soll.
AWSCredentialsFileProfile Der Name des zu verwendenden Profils aus der bereitgestellten AWSCredentialsFile.
AWSSessionToken Ihr AWS-Sitzungstoken.
AWSExternalId Eine eindeutige Kennung, die möglicherweise erforderlich ist, wenn Sie eine Rolle in einem anderen Konto übernehmen.
MFASerialNumber Die Seriennummer des MFA-Geräts, falls eines verwendet wird.
MFAToken Das temporäre Token, das auf Ihrem MFA-Gerät verfügbar ist.
TemporaryTokenDuration Die Dauer (in Sekunden), für die ein temporäres Token gültig ist.
AWSCognitoRegion Die Hosting-Region für AWS Cognito.
AWSUserPoolId Die Benutzerpool-ID.
AWSUserPoolClientAppId Die Client-App-ID des Benutzerpools.
AWSUserPoolClientAppSecret Optional. Das Client-App-Geheimnis des Benutzerpools.
AWSIdentityPoolId Die Identitätspool-ID.

AuthScheme

Das für die Authentifizierung verwendete Schema. Akzeptierte Einträge sind: Auto,, AwsRootKeys, AwsIAMRoles, AwsEC2Roles, AwsMFA, ADFS, Okta, PingFederate, AwsCredentialsFile, AwsCognitoBasic, AwsCognitoSrp.

Datentyp

string

Standardwert

AwsRootKeys

Hinweise

Verwenden Sie die folgenden Optionen, um Ihr Authentifizierungsschema auszuwählen:

  • Automatisch: Legen Sie diese Option fest, damit der Connector versucht, basierend auf den anderen angegebenen Verbindungseigenschaften automatisch das richtige zu verwendende Authentifizierungsschema aufzulösen.
  • TemporaryCredentials: Legen Sie dies fest, um für die Verbindung temporäre Sicherheitsanmeldeinformationen zusammen mit einem Sitzungstoken zu nutzen.
  • AwsRootKeys: Legen Sie dies fest, um den Zugriffsschlüssel und das Geheimnis des Root-Benutzers zu verwenden. Nützlich für schnelle Tests, aber in Produktionsfällen wird empfohlen, etwas mit eingeschränkten Berechtigungen zu verwenden.
  • AwsIAMRoles: Eingestellt, um IAM-Rollen für die Verbindung zu verwenden.
  • AwsEC2Roles: Legen Sie dies fest, um automatisch IAM-Rollen zu verwenden, die der EC2-Maschine zugewiesen sind, auf der der Amazon Athena Connector derzeit ausgeführt wird.
  • AwsMFA: Auf Verwendung der Multi-Faktor-Authentifizierung einstellen.
  • Okta: Eingestellt auf die Verwendung einer Single Sign-On-Verbindung mit OKTA als Identitätsanbieter.
  • ADFS: Eingestellt auf die Verwendung einer Single Sign-On-Verbindung mit ADFS als Identitätsanbieter.
  • PingFederate: Eingestellt auf die Verwendung einer Single Sign-On-Verbindung mit PingFederate als Identitätsanbieter.
  • AwsCredentialsFile: Einrichten, um eine Anmeldeinformationsdatei für die Authentifizierung zu verwenden.
  • AwsCognitoSrp: Legen Sie fest, ob die Cognito-basierte Authentifizierung verwendet werden soll. Dies wird gegenüber AwsCognitoBasic empfohlen, da diese Option das Kennwort NICHT zur Authentifizierung an den Server sendet, sondern stattdessen das SRP-Protokoll verwendet.
  • AwsCognitoBasic: Eingestellt auf Verwendung der Cognito-basierten Authentifizierung.

AWSAccessKey

Ihr AWS-Kontozugriffsschlüssel. Auf diesen Wert kann über die Seite mit den AWS-Sicherheitsanmeldeinformationen zugegriffen werden.

Datentyp

string

Standardwert

""

Hinweise

Ihr AWS-Kontozugriffsschlüssel. Auf diesen Wert können Sie über Ihre AWS-Sicherheitsanmeldeinformationen-Seite zugreifen:

  1. Melden Sie sich mit den Anmeldeinformationen für Ihr Root-Konto bei der AWS-Verwaltungskonsole an.

  2. Wählen Sie Ihren Kontonamen oder Ihre Kontonummer und wählen Sie im angezeigten Menü „Meine Sicherheitsanmeldeinformationen“.

  3. Klicken Sie auf „Weiter zu Sicherheitsanmeldeinformationen“ und erweitern Sie den Abschnitt „Zugriffsschlüssel“, um Zugriffsschlüssel für Root-Konten zu verwalten oder zu erstellen.

AWSGeheimer Schlüssel

Ihr geheimer AWS-Kontoschlüssel. Auf diesen Wert können Sie über Ihre AWS-Sicherheitsanmeldeinformationenseite zugreifen.

Datentyp

string

Standardwert

""

Hinweise

Ihr geheimer AWS-Kontoschlüssel. Auf diesen Wert können Sie über Ihre AWS-Sicherheitsanmeldeinformationen-Seite zugreifen:

  1. Melden Sie sich mit den Anmeldeinformationen für Ihr Root-Konto bei der AWS-Verwaltungskonsole an.

  2. Wählen Sie Ihren Kontonamen oder Ihre Kontonummer und wählen Sie im angezeigten Menü „Meine Sicherheitsanmeldeinformationen“.

  3. Klicken Sie auf „Weiter zu Sicherheitsanmeldeinformationen“ und erweitern Sie den Abschnitt „Zugriffsschlüssel“, um Zugriffsschlüssel für das Root-Konto zu verwalten oder zu erstellen.

AWSRoleARN

Der Amazon-Ressourcenname der Rolle, die bei der Authentifizierung verwendet werden soll.

Datentyp

string

Standardwert

""

Hinweise

Bei der Authentifizierung außerhalb von AWS ist es üblich, anstelle der direkten AWS-Kontoanmeldeinformationen eine Rolle zur Authentifizierung zu verwenden. Durch Eingabe der AWSRoleARN bewirkt, dass der Amazon Athena-Connector eine Rolle Authentifizierung durchführt, anstatt den AWSAccessKey zu verwenden und AWSSecretKey direkt. Der AWSAccessKey und AWSSecretKey muss noch angegeben werden, um diese Authentifizierung durchzuführen. Sie können beim Festlegen von RoleARN nicht die Anmeldeinformationen eines AWS-Root-Benutzers verwenden. Der AWSAccessKey und AWSSecretKey müssen die eines IAM-Benutzers sein.

AWSPrincipalARN

Die ARN des SAML Identitätsanbieters in Ihrem AWS-Konto.

Datentyp

string

Standardwert

""

Hinweise

Die ARN des SAML Identitätsanbieters in Ihrem AWS-Konto.

AWSRegion

Die Hosting-Region für Ihre Amazon Web Services.

Mögliche Werte

OHIO, NORTHERNVIRGINIA, NORTHERNCALIFORNIA, OREGON, CAPETOWN, HONGKONG, JAKARTA, MUMBAI, OSAKA, SEOUL, SINGAPORE, SYDNEY, TOKYO, CENTRAL, BEIJING, NINGXIA, FRANKFURT, IRELAND, LONDON, MILAN, PARIS, STOCKHOLM, ZURICH, BAHRAIN, UAE, SAOPAULO, GOVCLOUDEAST, GOVCLOUDWEST

Datentyp

string

Standardwert

NORTHERNVIRGINIA

Hinweise

Die Hosting-Region für Ihre Amazon Web Services. Verfügbare Werte sind OHIO, NORTHERNVIRGINIA, NORTHERNCALIFORNIA, OREGON, CAPETOWN, HONGKONG, JAKARTA, MUMBAI, OSAKA, SEOUL, SINGAPUR, SYDNEY, TOKIO, CENTRAL, PEKING, NINGXIA, FRANKFURT, IRLAND, LONDON, MAILAND, PARIS, STOCKHOLM, ZÜRICH, BAHRAIN, VAE, SAOPAULO, GOVCLOUDEAST und GOVCLOUDWEST.

AWSCredentialsFile

Der Pfad zur AWS-Anmeldeinformationsdatei, die zur Authentifizierung verwendet werden soll.

Datentyp

string

Standardwert

""

Hinweise

Der Pfad zur AWS-Anmeldeinformationsdatei, die zur Authentifizierung verwendet werden soll. Siehe https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html für weitere Informationen.

AWSCredentialsFileProfile

Der Name des zu verwendenden Profils aus der bereitgestellten AWSCredentialsFile.

Datentyp

string

Standardwert

default

Hinweise

Der Name des zu verwendenden Profils aus der bereitgestellten AWSCredentialsFile. Siehe https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html für weitere Informationen.

AWSSessionToken

Ihr AWS-Sitzungstoken.

Datentyp

string

Standardwert

""

Hinweise

Ihr AWS-Sitzungstoken. Dieser Wert kann auf verschiedene Arten abgerufen werden. Siehe diesen Link für weitere Informationen.

AWSExternalId

Eine eindeutige Kennung, die möglicherweise erforderlich ist, wenn Sie eine Rolle in einem anderen Konto übernehmen.

Datentyp

string

Standardwert

""

Hinweise

Eine eindeutige Kennung, die möglicherweise erforderlich ist, wenn Sie eine Rolle in einem anderen Konto übernehmen.

MFASeriennummer

Die Seriennummer des MFA-Geräts, falls eines verwendet wird.

Datentyp

string

Standardwert

""

Hinweise

Sie können das Gerät für einen IAM-Benutzer finden, indem Sie zur AWS Management Console gehen und die Sicherheitsanmeldeinformationen des Benutzers anzeigen. Bei virtuellen Geräten ist dies tatsächlich ein Amazon-Ressourcenname (z. B. arn:aws:iam:123456789012:mfa/user).

MFAToken

Das temporäre Token, das von Ihrem MFA-Gerät verfügbar ist.

Datentyp

string

Standardwert

""

Hinweise

Wenn MFA erforderlich ist, wird dieser Wert zusammen mit der MFASerialNumber verwendet, um temporäre Anmeldeinformationen abzurufen. Die von AWS verfügbaren temporären Anmeldeinformationen sind standardmäßig nur bis zu 1 Stunde gültig (siehe TemporaryTokenDuration). Sobald die Zeit abgelaufen ist, muss die Verbindung aktualisiert werden, um ein neues MFA-Token anzugeben, damit neue Anmeldeinformationen abgerufen werden können.

Temporäre Tokendauer

Die Dauer (in Sekunden), die ein temporäres Token gültig ist.

Datentyp

string

Standardwert

3600

Hinweise

Temporäre Token werden sowohl bei der MFA als auch bei der rollenbasierten Authentifizierung verwendet. Temporäre Token laufen irgendwann ab, und dann muss ein neuer temporärer Token angefordert werden. In Situationen, in denen MFA nicht verwendet wird, ist dies kein großes Problem. Der Amazon Athena Connector fordert intern einen neuen temporären Token an, sobald der temporäre Token abgelaufen ist.

Für eine MFA-erforderliche Verbindung wird jedoch ein neuer MFAToken muss in der Verbindung angegeben werden, um ein neues temporäres Token abzurufen. Dies ist ein eher aufdringliches Problem, da es eine Aktualisierung der Verbindung durch den Benutzer erfordert. Der maximal und minimal anzugebende Wert hängt weitgehend von der verwendeten Verbindung ab.

Bei rollenbasierter Authentifizierung beträgt die Mindestdauer 900 Sekunden (15 Minuten), die Höchstdauer 3600 Sekunden (1 Stunde). Auch wenn MFA mit Rolle Authentifizierung verwendet wird, sind 3600 Sekunden immer noch das Maximum.

Für die alleinige MFA-Authentifizierung (mithilfe eines IAM-Benutzers oder Root-Benutzers) beträgt das Minimum 900 Sekunden (15 Minuten), das Maximum 129600 (36 Stunden).

AWSCognitoRegion

Die Hostingregion für AWS Cognito.

Mögliche Werte

OHIO, NORTHERNVIRGINIA, NORTHERNCALIFORNIA, OREGON, CAPETOWN, HONGKONG, MUMBAI, OSAKA, SEOUL, SINGAPORE, SYDNEY, TOKYO, CENTRAL, BEIJING, NINGXIA, FRANKFURT, IRELAND, LONDON, MILAN, PARIS, STOCKHOLM, BAHRAIN, SAOPAULO, GOVCLOUDEAST, GOVCLOUDWEST

Datentyp

string

Standardwert

NORTHERNVIRGINIA

Hinweise

Die Hostingregion für AWS Cognito. Verfügbare Werte sind OHIO, NORTHERNVIRGINIA, NORTHERNCALIFORNIA, OREGON, CAPETOWN, HONGKONG, MUMBAI, OSAKA, SEOUL, SINGAPUR, SYDNEY, TOKIO, CENTRAL, PEKING, NINGXIA, FRANKFURT, IRLAND, LONDON, MAILAND, PARIS, STOCKHOLM, BAHRAIN, SAOPAULO, GOVCLOUDEAST und GOVCLOUDWEST.

AWSUserPoolId

Die Benutzerpool-ID.

Datentyp

string

Standardwert

""

Hinweise

Sie finden dies in AWS Cognito -> Benutzerpools verwalten -> wählen Sie Ihren Benutzerpool aus -> Allgemeine Einstellungen -> Pool-ID.

AWSUserPoolClientAppId

Die Client-App-ID des Benutzerpools.

Datentyp

string

Standardwert

""

Hinweise

Sie finden dies in AWS Cognito -> Identitätspools verwalten -> wählen Sie Ihren Benutzerpool aus -> Allgemeine Einstellungen -> App-Clients -> App-Client-ID.

AWSUserPoolClientAppSecret

Optional. Das Benutzerpool-Client-App-Geheimnis.

Datentyp

string

Standardwert

""

Hinweise

Sie finden dies in AWS Cognito -> Identitätspools verwalten -> Benutzerpool auswählen -> Allgemeine Einstellungen -> App-Clients -> App-Client-Geheimnis.

AWSIdentityPoolId

Die Identitätspool-ID.

Datentyp

string

Standardwert

""

Hinweise

Sie finden dies in AWS Cognito -> Identitätspools verwalten -> Ihren Identitätspool auswählen -> Identitätspool bearbeiten -> Identitätspool-ID

SSO

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

Eigenschaft Beschreibung
User Der IDP-Benutzer, der zur Authentifizierung des IDP über SSO verwendet wird.
Password Das Passwort, das zur Authentifizierung des IDP-Benutzers über SSO verwendet wird.
SSOLoginURL Die Anmelde URL des Identitätsanbieters.
SSOProperties Zusätzliche Eigenschaften, die für die Verbindung mit dem Identitätsanbieter erforderlich sind, in einer durch Semikolon getrennten Liste.
SSOExchangeUrl Die URL, die zum Konsumieren der SAML -Antwort und zum Austauschen gegen dienstspezifische Anmeldeinformationen verwendet wird.

Benutzer

Der IDP-Benutzer, der zur Authentifizierung des IDP über SSO verwendet wird.

Datentyp

string

Standardwert

""

Hinweise

Zusammen mit Passwort, wird dieses Feld zur Authentifizierung bei SSO-Verbindungen gegenüber dem Amazon Athena-Server verwendet.

Passwort

Das Passwort, das zur Authentifizierung des IDP-Benutzers über SSO verwendet wird.

Datentyp

string

Standardwert

""

Hinweise

Der Benutzer Und Password werden gemeinsam in SSO-Verbindungen zur Authentifizierung beim Server verwendet.

SSOLoginURL

Die Anmelde-URL des Identitätsanbieters.

Datentyp

string

Standardwert

""

Hinweise

Die Anmelde-URL des Identitätsanbieters.

SSO-Eigenschaften

Zusätzliche Eigenschaften, die für die Verbindung mit dem Identitätsanbieter erforderlich sind, in einer durch Semikolon getrennten Liste.

Datentyp

string

Standardwert

""

Hinweise

Zusätzliche Eigenschaften, die für die Verbindung mit dem Identitätsanbieter erforderlich sind, in einer durch Semikolon getrennten Liste. SSOProperties wird in Verbindung mit dem AWSRoleARN verwendet und AWSPrincipalARN. Der folgende Abschnitt enthält ein Beispiel mit dem Identitätsanbieter OKTA.

ADFS

Um eine Verbindung zu ADFS herzustellen, legen Sie das AuthScheme fest Zu ADFS, und legen Sie diese Eigenschaften fest:

Beispiel-Verbindungszeichenfolge:

AuthScheme=ADFS; AWSRegion=Ireland; Database=sampledb; User=user@cdata.com; Password=CH8WerW121235647iCa6; SSOLoginURL='https://adfs.domain.com'; AWSRoleArn=arn:aws:iam:1234:role/ADFS_SSO; AWSPrincipalArn=arn:aws:iam:1234:saml-provider/ADFSProvider; S3StagingDirectory=s3://athena/staging;
Okta

Um eine Verbindung mit Okta herzustellen, legen Sie das AuthScheme fest Zu Okta, und legen Sie diese Eigenschaften fest:

Wenn Sie eine vertrauenswürdige Anwendung oder einen Proxy verwenden, der die Okta Clientanforderung überschreibt, ODER MFA konfigurieren, müssen Sie Kombinationen aus verwenden SSOProperties zur Authentifizierung mit Okta. Legen Sie je nach Bedarf die folgenden Optionen fest:

  • APIToken: Wenn Sie einen Benutzer über eine vertrauenswürdige Anwendung oder einen Proxy authentifizieren, der den Anforderungskontext des Okta Clients überschreibt, legen Sie dies auf das API Token fest, das der Kunde aus der Okta-Organisation erstellt hat.

  • MFAType: Wenn Sie den MFA-Flow konfiguriert haben, legen Sie ihn auf einen der folgenden unterstützten Typen fest: OktaVerify, Email, oder SMS.

  • MFAPassCode: Wenn Sie den MFA-Flow konfiguriert haben, legen Sie hier einen gültigen Passcode fest.

    Wenn Sie dies auf leer oder einen ungültigen Wert setzen, sendet der Connector eine Einmalkennwort-Abfrage an Ihr Gerät oder Email. Nachdem der Passcode empfangen wurde, öffnen Sie die Verbindung erneut, wobei der abgerufene Einmalkennwortwert auf die Verbindungseigenschaft MFAPassCode gesetzt wird.

  • MFARememberDevice: True standardmäßig. Okta unterstützt das Speichern von Geräten, wenn MFA erforderlich ist. Wenn das Speichern von Geräten gemäß den konfigurierten Authentifizierungsrichtlinien zulässig ist, sendet der Connector ein Gerätetoken, um die Lebensdauer der MFA-Authentifizierung zu verlängern. Wenn Sie nicht möchten, dass MFA gespeichert wird, setzen Sie diese Variable auf False.

Beispiel-Verbindungszeichenfolge:

AuthScheme=Okta; AWSRegion=Ireland; Database=sampledb; User=user@cdata.com; Password=CH8WerW121235647iCa6; SSOLoginURL='https://cdata-us.okta.com/home/amazon_aws/0oa35m8arsAL5f5NrE6NdA356/272'; SSOProperties='ApiToken=01230GGG2ceAnm_tPAf4MhiMELXZ0L0N1pAYrO1VR-hGQSf;'; AWSRoleArn=arn:aws:iam:1234:role/Okta_SSO; AWSPrincipalARN=arn:aws:iam:1234:saml-provider/OktaProvider; S3StagingDirectory=s3://athena/staging;

SSOExchangeUrl

Die URL, die zum Verwenden der SAML -Antwort und zum Austauschen gegen dienstspezifische Anmeldeinformationen verwendet wird.

Datentyp

string

Standardwert

""

Hinweise

Der Amazon Athena-Connector verwendet die hier angegebene URL, um eine SAML -Antwort abzurufen und sie gegen dienstspezifische Anmeldeinformationen auszutauschen. Die abgerufenen Anmeldeinformationen sind das letzte Element während der SSO-Verbindung, das zur Kommunikation mit Amazon Athena verwendet wird.

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 eingestellt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://'.
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.
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:

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

OAuthClientId

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

Datentyp

string

Standardwert

""

Hinweise

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

OAuthClientSecret

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

Datentyp

string

Standardwert

""

Hinweise

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

OAuth-Zugriffstoken

Der Zugriffstoken für die Verbindung per OAuth.

Datentyp

string

Standardwert

""

Hinweise

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

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

OAuthSettingsLocation

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

Datentyp

string

Standardwert

%APPDATA%\\CData\\Acumatica Data Provider\\OAuthSettings.txt

Hinweise

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

Anstatt einen Dateipfad anzugeben, können Sie auch den Speicherort angeben. Speicherorte werden durch einen Wert angegeben, der mit 'memory://' gefolgt von einer eindeutigen Kennung für diesen Satz von Anmeldeinformationen (z. B. memory://user1). Die Kennung können Sie frei wählen, sie sollte jedoch für den Benutzer eindeutig sein. Im Gegensatz zur dateibasierten Speicherung, bei der die Anmeldeinformationen über Verbindungen hinweg bestehen bleiben, werden die Anmeldeinformationen bei der Speicherspeicherung in den statischen Speicher geladen und die Anmeldeinformationen werden für die Dauer des Prozesses unter Verwendung derselben Kennung zwischen Verbindungen geteilt. Um 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_propsSystemtabelle. Wenn mehrere Verbindungen mit denselben Anmeldeinformationen bestehen, werden die Eigenschaften aus der zuvor geschlossenen Verbindung gelesen.

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

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

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

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

Plattform %APPDATA%
Windows Der Wert der Umfeld APPDATA
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.

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.

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 (Hexadezimalwerte 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.
FlattenArrays Standardmäßig werden Arrays als JSON-Strings zurückgegeben. Mit der Eigenschaft FlattenArrays können die Elemente von Arrays in eigene Spalten umgewandelt werden. Legen Sie FlattenArrays auf die Anzahl der Elemente fest, die Sie aus Arrays zurückgeben möchten.
FlattenObjects Setzen Sie FlattenObjects auf true, um Objekteigenschaften in eigene Spalten zu reduzieren. Andernfalls werden in Arrays verschachtelte Objekte als JSON-Strings zurückgegeben.

Standort

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

Datentyp

string

Standardwert

%APPDATA%\AmazonAthena 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%\AmazonAthena 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.

Arrays abflachen

Standardmäßig werden Arrays als JSON-Strings zurückgegeben. Mit der Eigenschaft FlattenArrays können die Elemente von Arrays in eigene Spalten abgeflacht werden. Legen Sie FlattenArrays auf die Anzahl der Elemente fest, die Sie aus Arrays zurückgeben möchten.

Datentyp

int

Standardwert

0

Hinweise

Standardmäßig werden Arrays als JSON-Strings zurückgegeben. Das FlattenArrays-Eigenschaft kann verwendet werden, um die Elemente von Arrays in eigene Spalten zu reduzieren. Dies wird nur für Arrays empfohlen, die voraussichtlich kurz sind.

Set FlattenArrays zur Anzahl der Elemente, die Sie aus Arrays zurückgeben möchten. Die angegebenen Elemente werden als Spalten zurückgegeben. Der nullbasierte Index wird an den Spaltennamen angehängt. Andere Elemente werden ignoriert.

Sie können beispielsweise eine beliebige Anzahl von Elementen aus einem Array von Zeichenfolgen zurückgeben:

["FLOW-MATIC","LISP","COBOL"]

Wenn FlattenArrays auf 1 gesetzt ist, wird das vorhergehende Array in die folgende Tabelle abgeflacht:

Spaltenname Spaltenwert
languages.0 FLOW-MATIC

Einstellung FlattenArrays auf -1 reduziert alle Elemente des Arrays.

Objekte abflachen

Setzen Sie FlattenObjects auf true, um Objekteigenschaften in eigene Spalten zu reduzieren. Andernfalls werden in Arrays verschachtelte Objekte als JSON-Strings zurückgegeben.

Datentyp

bool

Standardwert

false

Hinweise

Satz FlattenObjects auf true, um Objekteigenschaften in eigene Spalten zu reduzieren. Andernfalls werden in Arrays verschachtelte Objekte als JSON-Zeichenfolgen zurückgegeben. Um den Spaltennamen zu generieren, verknüpft der Connector den Eigenschaftsnamen mit einem Punkt mit dem Objektnamen.

Sie können beispielsweise die folgenden verschachtelten Objekte zum Zeitpunkt der Verbindung reduzieren:

[
     { "grade": "A", "score": 2 },
     { "grade": "A", "score": 6 },
     { "grade": "A", "score": 10 },
     { "grade": "A", "score": 9 },
     { "grade": "B", "score": 14 }
]

Wenn FlattenObjects ist auf true gesetzt und FlattenArrays auf 1 gesetzt ist, wird das vorhergehende Array in die folgende Tabelle abgeflacht:

Spaltenname Spaltenwert
grades.0.grade EIN
grades.0.score 2

Verschiedenes

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

Eigenschaft Beschreibung
CleanQueryResults Amazon Athena erstellt bei jeder Abfrage Cache-Dateien im in S3StagingDirectory angegebenen Ordner. CleanQueryResults gibt an, ob diese Dateien gelöscht werden sollen, sobald die Verbindung geschlossen wird.
EnableFIPSMode Ein Boolescher Wert, der angibt, ob FIPS- URLs aktiviert werden sollen.
IncludeTableTypes Wenn auf „true“ gesetzt, Abfrage der Anbieter die Typen der einzelnen Tabellen ab.
MaximumColumnSize Die maximale Spaltengröße.
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.
MetadataDiscoveryMethod Zu verwendende API zum Abrufen der Metadaten für Amazon Athena.
Other Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet.
PageSize Die Anzahl der zurückzugebenden Ergebnisse pro Seite mit von Amazon Athena abgerufenen Daten.
PollingInterval Hiermit wird das Polling-Intervall in Millisekunden festgelegt, um zu prüfen, ob das Ergebnis zum Abruf bereit steht.
PseudoColumns Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.
PushEmptyValuesAsNull Gibt an, ob die leeren Werte als leer oder als null gelesen werden sollen.
QueryCachingLevel Ändert die Verwendung von Abfrage, die im S3StagingDirectory gespeichert sind. Zwischengespeicherte Abfragen werden von Amazon Athena erst erneut gescannt, wenn die in QueryTolerance angegebene Anzahl von Sekunden verstrichen ist.
QueryPassthrough Diese Option übergibt die Abfrage unverändert an den Amazon Athena-Server.
QueryTimeout Das Timeout in Sekunden für vom Anbieter gesendete Anfragen zum Herunterladen großer Ergebnismengen.
QueryTolerance Gibt die Zeit in Sekunden an, für die Abfragen im Cache gespeichert werden, wenn QueryCachingLevel nicht auf „None“ festgelegt ist.
ShowS3Filepath Ob die Spalte _S3Path für die Amazon Athena-Tabellen verfügbar gemacht werden soll oder nicht.
SkipHeaderLineCount Gibt die Anzahl der Header an, die bei SELECT-Abfragen übersprungen werden sollen.
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.
Workgroup Arbeitsgruppe der ausgeführten Abfragen.

CleanQueryResults

Amazon Athena erstellt bei jeder Abfrage Cache-Dateien im in S3StagingDirectory angegebenen Ordner. CleanQueryResults gibt an, ob diese Dateien gelöscht werden sollen, sobald die Verbindung geschlossen wird.

Datentyp

bool

Standardwert

true

Hinweise

Amazon Athena speichert die Ergebnisse jeder von Ihnen ausgeführten Abfrage als CSV-Datei in S3StagingDirectory. Diese CSV-Dateien können in Amazon S3 schnell viel Platz beanspruchen.

Sie können verwenden CleanQueryResults, standardmäßig aktiviert, um diese Dateien bei jeder ausgeführten Abfrage zu bereinigen. Beachten Sie, dass dieses Verhalten zu geringfügigen Leistungseinbußen führt, wenn Sie die letzte Verbindung in einem Prozess trennen.

Siehe auch

Siehe Feinabstimmung des Datenzugriffs für weitere Informationen zum Konfigurieren des Abfrage Cachings von Athena.

EnableFIPSMode

Ein Boolescher Wert, der angibt, ob FIPS- URLs aktiviert werden sollen.

Datentyp

bool

Standardwert

false

Hinweise

FIPS oder Federal Information Processing Standard sind separate Endpoints in Amazon, die für bestimmte Regierungsorganisationen erforderlich sein können. Set EnableFIPSMode auf true, um zur Verwendung dieser Endpoints zu wechseln. Weitere Informationen finden Sie hier: https://aws.amazon.com/compliance/fips/.

Tabellentypen einschließen

Wenn der Wert auf „true“ gesetzt ist, Abfrage der Anbieter die Typen der einzelnen Tabellen ab.

Datentyp

bool

Standardwert

false

Hinweise

Wenn auf „true“ gesetzt, Abfrage der Connector entweder Athena oder Glue nach den Typen der einzelnen Tabellen ab. MetadataDiscoveryMethod schaltet den Dienst um, der zum Abrufen der Typen verwendet wird.

MaximaleSpaltengröße

Die maximale Spaltengröße.

Datentyp

int

Standardwert

255

Hinweise

Einige Tools beschränken die größte Größe einer Spalte oder die Gesamtgröße aller ausgewählten Spalten. Sie können die MaximumColumnSize um diese schemabasierten Einschränkungen zu überwinden. Der Connector meldet keine Spalte, die größer ist als MaximumColumnSize.

Setze ein MaximumColumnSize von Null, um Beschränkungen der Spaltengröße aufzuheben, wie im folgenden Beispiel gezeigt:

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.

MetadataDiscoveryMethod

Zu verwendende API zum Abrufen der Metadaten für Amazon Athena.

Mögliche Werte

Glue, Athena

Datentyp

string

Standardwert

Athena

Hinweise

Zu verwendende API zum Abrufen der Metadaten für Amazon Athena.

Eigenschaft Beschreibung
Glue Wann MetadataDiscoveryMethod ist auf Glue eingestellt. Der Treiber Abfrage, um Amazon Athena Metadaten abzurufen.
Athena Wann MetadataDiscoveryMethod auf Athena eingestellt ist, Abfrage der Treiber AWSAthena ab, um Amazon Athena Metadaten abzurufen.

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 Anzahl der zurückzugebenden Ergebnisse pro Seite der von Amazon Athena abgerufenen Daten.

Datentyp

string

Standardwert

1000

Hinweise

Die Anzahl der Ergebnisse, die pro Seite mit von Amazon Athena abgerufenen Daten zurückgegeben werden sollen. Der maximal zulässige Wert ist 1000. Siehe Feinabstimmung des Datenzugriffs für weitere Informationen zum Einstellen dieser Eigenschaft, um eine drosselung zu vermeiden.

PollingIntervall

Damit wird das Abfrageintervall in Millisekunden bestimmt, um zu prüfen, ob das Ergebnis zum Abruf bereit steht.

Datentyp

string

Standardwert

100

Hinweise

Diese Eigenschaft bestimmt, wie lange zwischen der Überprüfung gewartet wird, ob die Ergebnisse der Abfrage bereit sind oder nicht. Die Verarbeitung sehr großer Ergebnismengen oder komplexer Abfragen kann länger dauern, und ein kurzes Abfrageintervall kann dazu führen, dass viele unnötige Anfragen zum Überprüfen des Abfrage gestellt werden.

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

PushEmptyValuesAsNull

Gibt an, ob die leeren Werte als leer oder als Null gelesen werden sollen.

Datentyp

bool

Standardwert

false

Hinweise

Gibt an, ob die leeren Werte als leer oder als Null gelesen werden sollen.

Abfrage-Caching-Level

Ändert die Verwendung von Abfrage, die im S3StagingDirectory gespeichert sind. Zwischengespeicherte Abfragen werden von Amazon Athena erst erneut gescannt, wenn die in QueryTolerance angegebene Anzahl von Sekunden verstrichen ist.

Mögliche Werte

None, Local, Cloud

Datentyp

string

Standardwert

Local

Hinweise

Ändert die Verwendung der im S3StagingDirectory gespeicherten Abfrage. Zwischengespeicherte Abfragen werden von Amazon Athena erst nach der in QueryTolerance angegebenen Anzahl von Sekunden erneut gescannt ist vergangen. Die Groß-/Kleinschreibung der Abfragen muss genau übereinstimmen, um das Verhalten auszulösen, das unten erklärt wird:

Eigenschaft Beschreibung
Local Einstellung QueryCachingLevel to Local speichert die von Amazon Athena zurückgegebene Abfrage ID nach der Ausführung einer Abfrage für jede Verbindung einzeln. Durch Schließen der Verbindung wird der Cache geleert, sodass nur eine einzige Verbindung die Ergebnisse nutzen kann.
Cloud Einstellung QueryCachingLevel to Cloud speichert die Abfrage ID in Form einer benannten Abfrage in Amazon Athena. Das Schließen der Verbindung bereinigt die Ergebnisse nur, wenn es sich um die letzte offene Verbindung in einem Prozess handelt, sodass mehrere Verbindungen die Ergebnisse nutzen können.
None Einstellung QueryCachingLevel auf „Keine“ deaktiviert die Funktion.

QueryPassthrough

Diese Option übergibt die Abfrage unverändert an den Amazon Athena-Server.

Datentyp

bool

Standardwert

false

Hinweise

Wenn dies festgelegt ist, werden Abfragen direkt an Amazon Athena weitergeleitet.

AbfrageTimeout

Das Timeout in Sekunden für Anfragen des Anbieters zum Herunterladen großer Ergebnismengen.

Datentyp

int

Standardwert

1800

Hinweise

Wenn die QueryTimeout-Eigenschaft auf 0 gesetzt ist, werden Vorgänge nicht abgebrochen. Stattdessen werden sie ausgeführt, bis sie erfolgreich abgeschlossen sind oder ein Fehler auftritt. Diese Eigenschaft unterscheidet sich von Timeout, was für einzelne HTTP-Operationen gilt, während QueryTimeout gilt für die Ausführungszeit der gesamten Operation.

Wenn QueryTimeout abläuft und die Anfrage noch nicht vollständig verarbeitet wurde, löst der Connector einen Fehlerzustand aus.

Abfragetoleranz

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

Datentyp

string

Standardwert

600

Hinweise

Gibt die Zeitspanne in Sekunden an, für die Abfragen zwischengespeichert werden, wenn QueryCachingLevel ist nicht auf Keine gesetzt. Werte unter 1 werden nicht akzeptiert.

ShowS3Filepath

Ob die Spalte _S3Path für die Amazon Athena-Tabellen verfügbar gemacht werden soll oder nicht.

Datentyp

bool

Standardwert

false

Hinweise

Die Spalte _S3Path bezieht sich auf die Spalte $path von Amazon Athena, die den Pfad der Amazon S3 Quelldatei für jede Zeile in der Ausgabe zurückgibt.

Der Connector stellt die Spalte _S3Path für jede Tabelle nur dann bereit, wenn diese Verbindungseigenschaft auf TRUE gesetzt ist.

Überspringenheaderlinecount

Gibt die Anzahl der Header an, die bei SELECT-Abfragen übersprungen werden sollen.

Datentyp

string

Standardwert

""

Hinweise

Gibt die Anzahl der Header an, die bei SELECT-Abfragen übersprungen werden sollen. Dies wird am häufigsten für Athena-Tabellen verwendet, die auf eine CSV-Datenquelle verweisen. Wenn die CSV-Datenquelle Headern hat, setzen Sie SkipHeaderLineCount zu 1.

Wenn Sie AWS Glue zum Generieren von Tabellen in Athena verwendet haben, finden Sie dies in der Tabelleneigenschaft „Header“.

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 [AwsDataCatalog].[sampledb].Customers 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.

Arbeitsgruppe

Arbeitsgruppe der ausgeführten Abfragen.

Datentyp

string

Standardwert

""

Hinweise

Arbeitsgruppe der ausgeführten Abfragen.