Referência de API para o conector Python do Amazon Redshift - Amazon Redshift
redshift_connector Conexão Cursor Plugin AdfsCredentialsProvider Plugin AzureCredentialsProvider Plugin BrowserAzureCredentialsProvider Plugin BrowserSamlCredentialsProvider Plugin OktaCredentialsProvider Plugin PingCredentialsProvider Plugin SamlCredentialsProvider

O Amazon Redshift não permitirá mais a criação de funções definidas pelo usuário (UDFs) do Python a partir de 1.º de novembro de 2025. Se quiser usar UDFs do Python, você deve criá-las antes dessa data. As UDFs do Python existentes continuarão a funcionar normalmente. Para ter mais informações, consulte a publicação de blog .

Referência de API para o conector Python do Amazon Redshift

A seguir, você encontrará uma descrição das operações de API do conector Python do Amazon Redshift.

redshift_connector

A seguir, você encontrará uma descrição da operação de API redshift_connector.

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

Estabelece uma conexão com um cluster do Amazon Redshift. Essa função valida a entrada do usuário, autentica opcionalmente usando um plugin do provedor de identidade e cria um objeto de conexão.

apilevel

O nível DBAPI compatível, atualmente “2.0".

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

O estilo de parâmetro da API do banco de dados a ser usado globalmente.

Conexão

A seguir, você encontrará uma descrição das operações de API de conexão para o conector Python do Amazon Redshift.

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

Inicializa um objeto de conexão bruta.

cursor

Cria um objeto cursor vinculado a essa conexão.

commit

Confirma a transação de banco de dados atual.

rollback

Reverte a transação de banco de dados atual.

close

Encerra a conexão com o banco de dados.

execute(cursor, operation, vals)

Executa os comandos SQL especificados. Você pode fornecer os parâmetros como uma sequência ou como um mapeamento, conforme o valor de redshift_connector.paramstyle.

run(sql[, stream])

Executa os comandos SQL especificados. Se preferir, você também pode fornecer um fluxo a ser usado com o comando COPY.

xid(format_id, global_transaction_id, …)

Crie um ID de transação. Somente o parâmetro global_transaction_id é usado em postgres. O format_id e o branch_qualifier não são usados em postgres. O global_transaction_id pode ser qualquer identificador de string compatível com postgres que retorne uma tupla (format_id, global_transaction_id, branch_qualifier).

tpc_begin(xid)

Inicia uma transação TPC com um ID de transação xid consistindo em um ID de formato, ID de transação global e qualificador de ramificação.

tpc_prepare

Executa a primeira fase de uma transação iniciada com .tpc_begin.

tpc_commit([xid])

Quando chamado sem argumentos, o .tpc_commit confirma uma transação TPC previamente preparada com .tpc_prepare().

tpc_rollback([xid])

Quando chamado sem argumentos, o .tpc_rollback reverte uma transação TPC.

tpc_recover

Retorna uma lista de IDs de transação pendentes adequadas para uso com .tpc_commit(xid) ou .tpc_rollback(xid).

Cursor

A seguir, você encontrará uma descrição da operação de API de cursor.

__init__(connection[, paramstyle])

Inicializa um objeto cursor bruto.

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

Executa uma instrução INSERT em massa.

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

Executa uma operação de banco de dados.

executemany(operation, param_sets)

Prepara uma operação de banco de dados e a executa para todas as sequências de parâmetros ou mapeamentos fornecidos.

fetchone

Busca a próxima linha de um conjunto de resultados de consulta.

fetchmany([num])

Busca o próximo conjunto de linhas de um resultado da consulta.

fetchall

Busca todas as linhas restantes de um resultado da consulta.

close

Encerra o cursor agora.

__iter__

É possível iterar um objeto de cursor para recuperar as linhas de uma consulta.

fetch_dataframe([num])

Retorna um dataframe dos últimos resultados da consulta.

write_dataframe(df, table)

Grava o mesmo dataframe de estrutura em um banco de dados do Amazon Redshift.

fetch_numpy_array([num])

Retorna uma matriz NumPy dos últimos resultados da consulta.

get_catalogs

O Amazon Redshift não oferece suporte a vários catálogos a partir de uma única conexão. O Amazon Redshift retorna somente o catálogo atual.

get_tables([catalog, schema_pattern, …])

Retorna as tabelas públicas exclusivas que são definidas pelo usuário dentro do sistema.

get_columns([catalog, schema_pattern, …])

Retorna uma lista de todas as colunas de uma tabela específica em um banco de dados do Amazon Redshift.

Plugin AdfsCredentialsProvider

Veja a seguir a sintaxe da operação de API do plugin AdfsCredentialsProvider do conector Python do Amazon Redshift. 

redshift_connector.plugin.AdfsCredentialsProvider()

Plugin AzureCredentialsProvider

Veja a seguir a sintaxe da operação de API do plugin AzureCredentialsProvider do conector Python do Amazon Redshift.

redshift_connector.plugin.AzureCredentialsProvider()

Plugin BrowserAzureCredentialsProvider

Veja a seguir a sintaxe da operação de API do plugin BrowserAzureCredentialsProvider do conector Python do Amazon Redshift.

redshift_connector.plugin.BrowserAzureCredentialsProvider()

Plugin BrowserSamlCredentialsProvider

Veja a seguir a sintaxe da operação de API do plugin BrowserSamlCredentialsProvider do conector Python do Amazon Redshift.

redshift_connector.plugin.BrowserSamlCredentialsProvider()

Plugin OktaCredentialsProvider

Veja a seguir a sintaxe da operação de API do plugin OktaCredentialsProvider do conector Python do Amazon Redshift.

redshift_connector.plugin.OktaCredentialsProvider()

Plugin PingCredentialsProvider

Veja a seguir a sintaxe da operação de API do plugin PingCredentialsProvider do conector Python do Amazon Redshift.

redshift_connector.plugin.PingCredentialsProvider()

Plugin SamlCredentialsProvider

Veja a seguir a sintaxe da operação de API do plugin SamlCredentialsProvider do conector Python do Amazon Redshift.

redshift_connector.plugin.SamlCredentialsProvider()