Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Verwenden der Amazon Redshift Redshift-Daten API

Amazon Redshift Data API vereinfacht den Zugriff auf Ihr Amazon Redshift Data Warehouse, da Datenbanktreiber, Verbindungen, Netzwerkkonfigurationen, Datenpufferung, Anmeldeinformationen und mehr nicht mehr verwaltet werden müssen. Sie können SQL Anweisungen mithilfe der API Datenoperationen mit dem ausführen. AWS SDK Weitere Informationen zu den API Datenoperationen finden Sie in der Amazon Redshift API Redshift-Datenreferenz.

Für die Daten API ist keine dauerhafte Verbindung zu Ihrer Datenbank erforderlich. Stattdessen bietet es einen sicheren HTTP Endpunkt und eine sichere Integration mit AWS SDKs. Sie können den Endpunkt verwenden, um SQL Anweisungen auszuführen, ohne Verbindungen zu verwalten. Aufrufe der Daten API sind asynchron. Die Daten API verwenden entweder in gespeicherten Anmeldeinformationen AWS Secrets Manager oder temporäre Datenbankanmeldeinformationen. Bei beiden Autorisierungsmethoden müssen Sie bei den API Aufrufen keine Passwörter übergeben. Weitere Informationen zu AWS Secrets Manager finden Sie unter Was ist AWS Secrets Manager? im AWS Secrets Manager Benutzerhandbuch.

Mit den Daten können Sie mit Webservice-basierten AnwendungenAPI, einschließlich AWS Lambda Amazon-Notebooks und, programmgesteuert auf Amazon Redshift-Daten zugreifen. SageMaker AWS Cloud9 Weitere Informationen zu diesen Anwendungen finden Sie AWS Lambdaunter Amazon SageMaker und AWS Cloud9.

Weitere Informationen zu den Daten API finden Sie unter Erste Schritte mit Amazon Redshift Data API im AWS Big Data-Blog.

Arbeiten mit den Amazon Redshift Redshift-Daten API

Bevor Sie die Amazon Redshift Redshift-Daten verwendenAPI, überprüfen Sie die folgenden Schritte:

Überlegungen beim Aufrufen der Amazon Redshift Redshift-Daten API

Beachten Sie beim Aufrufen der Daten FolgendesAPI:

Auswahl der Anmeldeinformationen für die Datenbankauthentifizierung beim Aufrufen der Amazon Redshift Redshift-Daten API

Mit diesen Methoden können Sie auch einen region Wert angeben, der angibt, AWS-Region wo sich Ihre Daten befinden.

Zuordnen von JDBC Datentypen beim Aufrufen der Amazon Redshift Redshift-Daten API

In der folgenden Tabelle werden die Datentypen von Java Database Connectivity (JDBC) den Datentypen zugeordnet, die Sie in API Datenaufrufen angeben.

Zeichenfolgenwerte werden an die Amazon-Redshift-Datenbank übergeben und implizit in einen Datenbankdatentyp umgewandelt.

Ausführen von SQL Anweisungen mit Parametern beim Aufrufen der Amazon Redshift Redshift-Daten API

Sie können den SQL Text steuern, der an die Datenbank-Engine gesendet wird, indem Sie die API Operation Data mithilfe von Parametern für Teile der SQL Anweisung aufrufen. Benannte Parameter bieten eine flexible Möglichkeit, Parameter zu übergeben, ohne sie im SQL Text fest zu kodieren. Sie helfen Ihnen, SQL Text wiederzuverwenden und SQL Injektionsprobleme zu vermeiden.

Das folgende Beispiel zeigt die benannten Parameter eines parameters execute-statement AWS CLI Befehlsfeldes.

--parameters "[{\"name\": \"id\", \"value\": \"1\"},{\"name\": \"address\", \"value\": \"Seattle\"}]"

Beachten Sie Folgendes, wenn Sie benannte Parameter verwenden:

Ausführen von SQL Anweisungen mit einem Idempotenz-Token beim Aufrufen der Amazon Redshift Redshift-Daten API

Wenn Sie eine mutierende API Anforderung stellen, gibt die Anforderung in der Regel ein Ergebnis zurück, bevor die asynchronen Workflows des Vorgangs abgeschlossen sind. Es können auch ein Timeout oder andere Serverprobleme auftreten, bevor Operationen abgeschlossen sind, obwohl die Anfrage bereits ein Ergebnis zurückgegeben hat. Dadurch lässt sich möglicherweise nur schwer feststellen, ob die Anfrage erfolgreich war oder nicht, und es werden möglicherweise mehrere Wiederholungsversuche vorgenommen, um sicherzustellen, dass die Operation erfolgreich abgeschlossen wird. Wenn die ursprüngliche Anfrage und die nachfolgenden Wiederholungsversuche jedoch erfolgreich sind, wird die Operation mehrmals abgeschlossen. Das bedeutet, dass Sie möglicherweise mehr Ressourcen aktualisieren als beabsichtigt.

Idempotenz stellt sicher, dass eine API Anfrage nicht öfter als einmal abgeschlossen wird. Wenn bei einer idempotenten Anfrage die ursprüngliche Anfrage erfolgreich abgeschlossen wird, werden alle nachfolgenden Wiederholungen erfolgreich abgeschlossen, ohne dass weitere Aktionen ausgeführt werden. Die Daten API ExecuteStatement und BatchExecuteStatement Operationen haben einen optionalen ClientToken idempotenten Parameter. Das ClientToken läuft nach 8 Stunden ab.

Der folgende execute-statement AWS CLI Befehl veranschaulicht den optionalen client-token Parameter für Idempotenz.

aws redshift-data execute-statement 
    --region us-west-2 
    --secret arn:aws:secretsmanager:us-west-2:123456789012:secret:myuser-secret-hKgPWn 
    --cluster-identifier mycluster-test 
    --sql "select * from stl_query limit 1" 
    --database dev 
    --client-token b855dced-259b-444c-bc7b-d3e8e33f94g1                       

Die folgende Tabelle zeigt einige allgemeine Antworten, die Sie möglicherweise auf idempotente API Anfragen erhalten, und enthält Empfehlungen für Wiederholungsversuche.

Informationen zu Amazon Redshift Redshift-Antwortcodes finden Sie unter Häufige Fehler in der Amazon Redshift Redshift-Referenz API.

Ausführen von SQL Anweisungen mit Wiederverwendung von Sitzungen beim Aufrufen der Amazon Redshift Redshift-Daten API

Wenn Sie die Ausführung einer SQL Anweisung API anfordern, wird die Sitzung, in der die Anweisung SQL ausgeführt wird, normalerweise beendet, wenn die ausgeführt SQL wird. Um die Sitzung für eine bestimmte Anzahl von Sekunden aktiv zu halten, verfügen die Daten API ExecuteStatement und BatchExecuteStatement Operationen über einen optionalen SessionKeepAliveSeconds Parameter. Ein SessionId Antwortfeld enthält die Identität der Sitzung, die dann für nachfolgende ExecuteStatement BatchExecuteStatement Operationen verwendet werden kann. Bei nachfolgenden Aufrufen können Sie einen anderen angebenSessionKeepAliveSeconds, um die Leerlaufzeit zu ändern. Wenn das nicht geändert SessionKeepAliveSeconds wird, bleibt die ursprüngliche Einstellung für das Leerlauf-Timeout bestehen. Beachten Sie Folgendes, wenn Sie die Wiederverwendung von Sitzungen verwenden:

Um das abzurufenSessionId, was von Aufrufen ExecuteStatement und BatchExecuteStatement Vorgängen verwendet wird, rufen Sie DescribeStatement und ListStatements Operationen auf.

Das folgende Beispiel zeigt, wie die SessionId Parameter SessionKeepAliveSeconds und verwendet werden, um eine Sitzung aufrechtzuerhalten und wiederzuverwenden. Rufen Sie zunächst den execute-statement AWS CLI Befehl auf, wobei der optionale session-keep-alive-seconds Parameter auf 2 gesetzt ist.

aws redshift-data execute-statement 
    --session-keep-alive-seconds 2 
    --sql "select 1" 
    --database dev 
    --workgroup-name mywg                     

Die Antwort enthält die Sitzungs-ID.

{
    "WorkgroupName": "mywg",
    "CreatedAt": 1703022996.436,
    "Database": "dev",
    "DbUser": "awsuser",
    "Id": "07c5ffea-76d6-4786-b62c-4fe3ef529680",
    "SessionId": "5a254dc6-4fc2-4203-87a8-551155432ee4"
}

Rufen Sie dann den execute-statement AWS CLI Befehl mit dem vom ersten Aufruf SessionId zurückgegebenen Befehl auf. Geben Sie optional den session-keep-alive-seconds Parameter an, der auf gesetzt ist, 10 um den Wert für das Leerlauf-Timeout zu ändern.

aws redshift-data execute-statement 
    --sql "select 1" 
    --session-id 5a254dc6-4fc2-4203-87a8-551155432ee4
    --session-keep-alive-seconds 10