

 Amazon Redshift 將不再支援從修補程式 198 開始建立新的 Python UDFs。現有 Python UDF 將繼續正常運作至 2026 年 6 月 30 日。如需詳細資訊，請參閱[部落格文章](https://aws.amazon.com/blogs/big-data/amazon-redshift-python-user-defined-functions-will-reach-end-of-support-after-june-30-2026/)。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# Amazon Redshift Python 連接器的 API 參考
<a name="python-api-reference"></a>

接下來，您可以找到 Amazon Redshift Python 連線器 API 操作的描述。

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

接下來，您可以找到 `redshift_connector` API 操作的描述。

`connect(user, database, password[, port, …])`  
建立對 Amazon Redshift 叢集的連線。此函數會驗證使用者輸入、選擇性地使用身分提供者外掛程式進行驗證，然後建構連線物件。

`apilevel`  
支援 DBAPI 層級，目前為「2.0」。

`paramstyle``str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str`  
要全域使用的資料庫 API 參數樣式。

## 連線
<a name="python-api-connection"></a>

接下來，您可以找到 Amazon Redshift Python 連接器的連線 API 操作描述。

`__init__(user, password, database[, host, …])`  
將原始連線物件初始化。

`cursor`  
建立繫結至此連線的游標物件。

`commit`  
遞交目前的資料庫交易。

`rollback`  
復原目前的資料庫交易。

`close`  
關閉資料庫連線。

`execute(cursor, operation, vals)`  
執行指定的 SQL 命令。根據 `redshift_connector.paramstyle` 的值，您可以提供序列或映射形式的參數。

`run(sql[, stream])`  
執行指定的 SQL 命令。您可以選擇性提供與 COPY 命令搭配使用的串流。

`xid(format_id, global_transaction_id, …)`  
建立交易 ID。只有 `global_transaction_id` 參數會用於 postgres。format\$1id 和 branch\$1qualifier 不會用於 postgres。`global_transaction_id` 可以是由傳回元組 (`format_id`, `global_transaction_id`, `branch_qualifier`) 的 postgres 支援的任何字串識別碼。

`tpc_begin(xid)`  
使用由格式 ID、全域交易 ID 和分支限定詞組成的交易 ID `xid` 來開始 TPC 交易。

`tpc_prepare`  
執行以 .tpc\$1begin 開始之交易的第一個階段。

`tpc_commit([xid])`  
以無引數方式呼叫時，.tpc\$1commit 會遞交先前使用 .tpc\$1prepare() 所準備的 TPC 交易。

`tpc_rollback([xid])`  
以無引數方式呼叫時，.tpc\$1rollback 會復原 TPC 交易。

`tpc_recover`  
傳回適合與 .tpc\$1commit(xid) 或 .tpc\$1rollback(xid) 搭配使用的待定交易 ID 清單。

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

接下來，您可以找到游標 API 操作的描述。

`__init__(connection[, paramstyle])`  
將原始游標物件初始化。

`insert_data_bulk(filename, table_name, parameter_indices, column_names, delimiter, batch_size)`  
執行大量 INSERT 陳述式。

`execute(operation[, args, stream, …])`  
執行資料庫操作。

`executemany(operation, param_sets)`  
準備資料庫操作，然後針對所提供的所有參數序列或映射執行此操作。

`fetchone`  
擷取查詢結果集的下一列。

`fetchmany([num])`  
擷取下一組查詢結果資料列。

`fetchall`  
擷取查詢結果的所有剩餘資料列。

`close`  
立即關閉游標。

`__iter__`  
可對游標物件進行迭代以從查詢中擷取資料列。

`fetch_dataframe([num])`  
傳回上次查詢結果的資料框。

`write_dataframe(df, table)`  
將相同結構資料框寫入到 Amazon Redshift 資料庫。

`fetch_numpy_array([num])`  
傳回上次查詢結果的 NumPy 陣列。

`get_catalogs`  
Amazon Redshift 不支援來自單一連線的多個型錄。Amazon Redshift 只會傳回目前的型錄。

`get_tables([catalog, schema_pattern, …])`  
傳回系統內使用者定義的唯一公有資料表。

`get_columns([catalog, schema_pattern, …])`  
傳回 Amazon Redshift 資料庫中特定資料表內所有資料欄的清單。

## AdfsCredentialsProvider 外掛程式
<a name="python-adfs-credentials-plugin"></a>

以下是 Amazon Redshift Python 連接器的 AdfsCredentialsProvider 外掛程式 API 操作語法。

```
redshift_connector.plugin.AdfsCredentialsProvider()
```

## AzureCredentialsProvider 外掛程式
<a name="python-azure-credentials-plugin"></a>

以下是 Amazon Redshift Python 連接器的 AzureCredentialsProvider 外掛程式 API 操作語法。

```
redshift_connector.plugin.AzureCredentialsProvider()
```

## BrowserAzureCredentialsProvider 外掛程式
<a name="python-browser-azure-credentials-plugin"></a>

以下是 Amazon Redshift Python 連接器的 BrowserAzureCredentialsProvider 外掛程式 API 操作語法。

```
redshift_connector.plugin.BrowserAzureCredentialsProvider()
```

## BrowserSamlCredentialsProvider 外掛程式
<a name="python-browser-saml-credentials-plugin"></a>

以下是 Amazon Redshift Python 連接器的 BrowserSamlCredentialsProvider 外掛程式 API 操作語法。

```
redshift_connector.plugin.BrowserSamlCredentialsProvider()
```

## OktaCredentialsProvider 外掛程式
<a name="python-okta-credentials-plugin"></a>

以下是 Amazon Redshift Python 連接器的 OktaCredentialsProvider 外掛程式 API 操作語法。

```
redshift_connector.plugin.OktaCredentialsProvider()
```

## PingCredentialsProvider 外掛程式
<a name="python-ping-credentials-plugin"></a>

以下是 Amazon Redshift Python 連接器的 PingCredentialsProvider 外掛程式 API 操作語法。

```
redshift_connector.plugin.PingCredentialsProvider()
```

## SamlCredentialsProvider 外掛程式
<a name="python-saml-credentials-plugin"></a>

以下是 Amazon Redshift Python 連接器的 SamlCredentialsProvider 外掛程式 API 操作語法。

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