API-Referenz für den Amazon-Redshift-Python-Konnektor

Im Folgenden finden Sie eine Beschreibung der API-Operationen des Amazon-Redshift-Python-Konnektors.

redshift_connector

Im Folgenden finden Sie eine Beschreibung der redshift_connector API-Operation.

connect(user, database, password[, port, …])

Stellt eine Verbindung zu einem Amazon-Redshift-Cluster her. Diese Funktion validiert Benutzereingaben, authentifiziert sich optional mit einem Identitätsanbieter-Plug-In und erstellt dann ein Verbindungsobjekt.

apilevel

Die unterstützte DBAPI-Ebene, derzeit „2.0".

paramstyle

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Der global zu verwendende Datenbank-API-Parameterstil.

Verbindung

Im Folgenden finden Sie eine Beschreibung der Verbindungs-API-Operationen für den Amazon-Redshift-Python-Konnektor.

__init__(user, password, database[, host, …])

Initialisiert ein rohes Verbindungsobjekt.

cursor

Erstellt ein Cursor-Objekt, das an diese Verbindung gebunden ist.

commit

Führt einen Commit der aktuellen Datenbanktransaktion aus.

rollback

Rollt die aktuelle Datenbanktransaktion zurück.

close

Schließt die Datenbankverbindung.

execute(cursor, operation, vals)

Führt den angegebenen SQL-Befehl aus. Sie können die Parameter als Sequenz oder als Mapping angeben, abhängig vom Wert von redshift_connector.paramstyle.

run(sql[, stream])

Führt den angegebenen SQL-Befehl aus. Optional können Sie einen Stream zur Verwendung mit dem Befehl COPY bereitstellen.

xid(format_id, global_transaction_id, …)

Erstellen Sie eine Transaktions-ID. Nur der global_transaction_id-Parameter wird in Postgres verwendet. format_id und branch_qualifier werden nicht in Postgres verwendet. Der global_transaction_id kann jeder String-Bezeichner sein, der von Postgres unterstützt wird und ein Tupel zurückgibt (format_id, global_transaction_id, branch_qualifier).

tpc_begin(xid)

Startet eine TPC-Transaktion mit einer Transaktions-ID xid bestehend aus einer Format-ID, einer globalen Transaktions-ID und einem Branch Qualifier.

tpc_prepare

Führt die erste Phase einer mit .tpc_begin gestarteten Transaktion aus.

tpc_commit([xid])

Wenn es ohne Argumente aufgerufen wird, führt .tpc_commit einen Commit für eine TPC-Transaktion aus, die zuvor mit .tpc_prepare() vorbereitet wurde.

tpc_rollback([xid])

Wenn es ohne Argumente aufgerufen wird, rollt .tpc_rollback eine TPC-Transaktion zurück.

tpc_recover

Gibt eine Liste ausstehender Transaktions-IDs zurück, die für die Verwendung mit .tpc_commit(xid) oder .tpc_rollback(xid) geeignet sind.

Cursor

Im Folgenden finden Sie eine Beschreibung der Cursor-API-Operation.

__init__(connection[, paramstyle])

Initialisiert ein rohes Cursor-Objekt.

insert_data_bulk(filename, table_name, parameter_indices, column_names, delimiter, batch_size)

Führt eine Massen-INSERT-Anweisung aus.

execute(operation[, args, stream, …])

Führt einen Datenbankvorgang aus.

executemany(operation, param_sets)

Bereitet einen Datenbankvorgang vor und führt ihn dann für alle bereitgestellten Parametersequenzen oder Mappings aus.

fetchone

Ruft die nächste Zeile eines Abfrageergebnissatzes ab.

fetchmany([num])

Ruft die nächste Reihe von Zeilen eines Abfrageergebnisses ab.

fetchall

Ruft alle verbleibenden Zeilen eines Abfrageergebnisses ab.

close

Schließt den Cursor jetzt.

__iter__

Ein Cursorobjekt kann iteriert werden, um die Zeilen aus einer Abfrage abzurufen.

fetch_dataframe([num])

Gibt einen Datenrahmen der letzten Abfrageergebnisse zurück.

write_dataframe(df, table)

Schreibt denselben Strukturdatenrahmen in eine Amazon-Redshift-Datenbank.

fetch_numpy_array([num])

Gibt ein NumPy-Array der letzten Abfrageergebnisse zurück.

get_catalogs

Amazon Redshift unterstützt nicht mehrere Kataloge über eine einzige Verbindung. Amazon Redshift gibt nur den aktuellen Katalog zurück.

get_tables([catalog, schema_pattern, …])

Gibt die eindeutigen öffentlichen Tabellen zurück, die innerhalb des Systems benutzerdefiniert sind.

get_columns([catalog, schema_pattern, …])

Gibt eine Liste aller Spalten in einer bestimmten Tabelle einer Amazon-Redshift-Datenbank zurück.

AdfsCredentialsProvider-Plug-In

Im Folgenden finden Sie die Syntax für die API-Operation des AdfsCredentialsProvider-Plug-Ins für den Amazon-Redshift-Python-Konnektor.

redshift_connector.plugin.AdfsCredentialsProvider()
	

AzureCredentialsProvider-Plug-In

Im Folgenden finden Sie die Syntax für die API-Operationen des AzureCredentialsProvider-Plug-Ins für den Amazon Redshift Python-Konnektor.

redshift_connector.plugin.AzureCredentialsProvider()
	

BrowserAzureCredentialsProvider-Plug-In

Im Folgenden finden Sie die Syntax für die API-Operationen des BrowserAzureCredentialsProvider-Plug-Ins für den Amazon-Redshift-Python-Konnektor.

redshift_connector.plugin.BrowserAzureCredentialsProvider()
	

BrowserSamlCredentialsProvider-Plug-In

Im Folgenden finden Sie die Syntax für die API-Operationen des BrowserSamlCredentialsProvider-Plug-Ins für den Amazon-Redshift-Python-Konnektor.

redshift_connector.plugin.BrowserSamlCredentialsProvider()
	

OktaCredentialsProvider-Plug-In

Im Folgenden finden Sie die Syntax für die API-Operation des OktaCredentialsProvider-Plug-Ins für den Amazon-Redshift-Python-Konnektor.

redshift_connector.plugin.OktaCredentialsProvider()
	

PingCredentialsProvider-Plug-In

Im Folgenden finden Sie die Syntax für die API-Operation des PingCredentialsProvider-Plug-Ins für den Amazon-Redshift-Python-Konnektor.

redshift_connector.plugin.PingCredentialsProvider()
	

SamlCredentialsProvider-Plug-In

Im Folgenden finden Sie die Syntax für die API-Operationen des SamlCredentialsProvider-Plug-Ins für den Amazon-Redshift-Python-Konnektor.

redshift_connector.plugin.SamlCredentialsProvider()