

 O Amazon Redshift não permitirá mais a criação de UDFs do Python a partir do Patch 198. As UDFs do Python existentes continuarão a funcionar normalmente até 30 de junho de 2026. Para ter mais informações, consulte a [publicação de blog ](https://aws.amazon.com/blogs/big-data/amazon-redshift-python-user-defined-functions-will-reach-end-of-support-after-june-30-2026/). 

# Referência de API para o conector Python do Amazon Redshift
<a name="python-api-reference"></a>

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

## redshift\$1connector
<a name="python-api-redshift_connector"></a>

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 name="python-api-connection"></a>

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\$1id e o branch\$1qualifier 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\$1begin.

`tpc_commit([xid])`  
Quando chamado sem argumentos, o .tpc\$1commit confirma uma transação TPC previamente preparada com .tpc\$1prepare().

`tpc_rollback([xid])`  
Quando chamado sem argumentos, o .tpc\$1rollback reverte uma transação TPC.

`tpc_recover`  
Retorna uma lista de IDs de transação pendentes adequadas para uso com .tpc\$1commit(xid) ou .tpc\$1rollback(xid).

## Cursor
<a name="python-api-cursor"></a>

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
<a name="python-adfs-credentials-plugin"></a>

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
<a name="python-azure-credentials-plugin"></a>

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
<a name="python-browser-azure-credentials-plugin"></a>

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
<a name="python-browser-saml-credentials-plugin"></a>

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
<a name="python-okta-credentials-plugin"></a>

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
<a name="python-ping-credentials-plugin"></a>

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
<a name="python-saml-credentials-plugin"></a>

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

```
redshift_connector.plugin.SamlCredentialsProvider()
```