Referencia de la API para el conector Python de Amazon Redshift

A continuación encontrará una descripción de las operaciones de la API del conector Python de Amazon Redshift.

redshift_connector

A continuación encontrará una descripción de la operación de la API redshift_connector.

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

Establece una conexión a un clúster de Amazon Redshift. Esta función valida la entrada del usuario, se autentica opcionalmente mediante un complemento de proveedores de identidades y, a continuación, crea un objeto de conexión.

apilevel

El nivel DBAPI admite, actualmente “2.0”.

paramstyle

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

El estilo de parámetro de la API de base de datos que se va a utilizar globalmente.

Connection

A continuación encontrará una descripción de las operaciones de la API de conexión para el conector Python de Amazon Redshift.

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

Inicializa un objeto de conexión sin procesar.

cursor

Crea un objeto cursor vinculado a esta conexión.

commit

Confirma la transacción de la base de datos actual.

rollback

Retrocede la transacción de la base de datos actual.

close

Cierra la conexión a la base de datos.

execute(cursor, operation, vals)

Ejecuta los comandos SQL especificados. Puede proporcionar los parámetros en forma de secuencia o como una asignación, según el valor de redshift_connector.paramstyle.

run(sql[, stream])

Ejecuta los comandos SQL especificados. De forma opcional, puede proporcionar una secuencia para utilizarla con el comando COPY.

xid(format_id, global_transaction_id, …)

Cree un ID de transacción. Solo utiliza el parámetro global_transaction_id en postgres. format_id y branch_qualifier no se utilizan en postgres. El global_transaction_id puede ser cualquier identificador de cadena que admite postgres que devuelva una tupla (format_id, global_transaction_id, branch_qualifier).

tpc_begin(xid)

Inicia una transacción de TPC con un ID de transacción xid que consiste en un ID de formato, un ID de transacción global y un calificador de ramificación.

tpc_prepare

Realiza la primera fase de una transacción iniciada con .tpc_begin.

tpc_commit([xid])

Cuando se llama sin argumentos, .tpc_commit confirma una transacción de TPC preparada previamente con .tpc_prepare().

tpc_rollback([xid])

Cuando se llama sin argumentos, .tpc_rollback revierte una transacción de TPC.

tpc_recover

Devuelve una lista de los ID de transacción pendientes adecuados para su uso con .tpc_commit(xid) o .tpc_rollback(xid).

Cursor

A continuación encontrará una descripción de la operación de la API de cursor.

__init__(connection[, paramstyle])

Inicializa un objeto cursor sin procesar.

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

Ejecuta una instrucción INSERT masiva.

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

Ejecuta una operación de base de datos.

executemany(operation, param_sets)

Prepara una operación de base de datos y, a continuación, la ejecuta para todas las secuencias de parámetros o asignaciones proporcionadas.

fetchone

Recupera la siguiente fila de un conjunto de resultados de consultas.

fetchmany([num])

Recupera el siguiente conjunto de filas de un resultado de consultas.

fetchall

Recupera todas las filas restantes de un resultado de consultas.

close

Cierre el cursor ahora.

__iter__

Se puede iterar un objeto cursor para recuperar las filas de una consulta.

fetch_dataframe([num])

Devuelve un marco de datos de los resultados de la última consulta.

write_dataframe(df, table)

Escribe el mismo marco de datos de estructura en una base de datos de Amazon Redshift.

fetch_numpy_array([num])

Devuelve una matriz NumPy de los resultados de la última consulta.

get_catalogs

Amazon Redshift no admite varios catálogos desde una única conexión. Amazon Redshift solo devuelve el catálogo actual.

get_tables([catalog, schema_pattern, …])

Devuelve las tablas públicas únicas que están definidas por el usuario dentro del sistema.

get_columns([catalog, schema_pattern, …])

Devuelve una lista de todas las columnas de una tabla específica de una base de datos de Amazon Redshift.

Complemento AdfScredentialsProvider

A continuación se muestra la sintaxis de la operación de la API del complemento AdfsCredentialsProvider para el conector Python de Amazon Redshift.

redshift_connector.plugin.AdfsCredentialsProvider()
	

Complemento AzureCredentialsProvider

A continuación se muestra la sintaxis de la operación de la API del complemento AzureCredentialsProvider para el conector Python de Amazon Redshift.

redshift_connector.plugin.AzureCredentialsProvider()
	

Complemento BrowserAzureCredentialsProvider

A continuación se muestra la sintaxis de la operación de la API del complemento BrowserAzureCredentialsProvider para el conector Python de Amazon Redshift.

redshift_connector.plugin.BrowserAzureCredentialsProvider()
	

Complemento BrowserSamlCredentialsProvider

A continuación se muestra la sintaxis de la operación de la API del complemento BrowserSamlCredentialsProvider para el conector Python de Amazon Redshift.

redshift_connector.plugin.BrowserSamlCredentialsProvider()
	

Complemento OktaCredentialsProvider

A continuación se muestra la sintaxis de la operación de la API del complemento OktaCredentialsProvider para el conector Python de Amazon Redshift.

redshift_connector.plugin.OktaCredentialsProvider()
	

Complemento PingCredentialsProvider

A continuación se muestra la sintaxis de la operación de la API del complemento PingCredentialsProvider para el conector Python de Amazon Redshift.

redshift_connector.plugin.PingCredentialsProvider()
	

Complemento SamlCredentialsProvider

A continuación se muestra la sintaxis de la operación de la API del complemento SamlCredentialsProvider para el conector Python de Amazon Redshift.

redshift_connector.plugin.SamlCredentialsProvider()