Prefect Docs

# Snowflake Tasks

This module contains a collection of tasks for interacting with snowflake databases via the snowflake-connector-python library.

# SnowflakeQuery

class

prefect.tasks.snowflake.snowflake.SnowflakeQuery

(account=None, user=None, password=None, private_key=None, database=None, schema=None, role=None, warehouse=None, query=None, data=None, autocommit=None, cursor_type=snowflake.connector.cursor.SnowflakeCursor, authenticator=None, token=None, **kwargs)[source]

Task for executing a query against a Snowflake database.

Args:

  • account (str): snowflake account name, see snowflake connector package documentation for details
  • user (str): user name used to authenticate
  • password (str, optional): password used to authenticate. password or private_key must be present
  • private_key (bytes, optional): pem to authenticate. password or private_key must be present
  • database (str, optional): name of the default database to use
  • schema (int, optional): name of the default schema to use
  • role (str, optional): name of the default role to use
  • warehouse (str, optional): name of the default warehouse to use
  • query (str, optional): query to execute against database
  • data (tuple, optional): values to use in query, must be specified using placeholder in query string
  • autocommit (bool, optional): set to True to autocommit, defaults to None, which takes snowflake AUTOCOMMIT parameter
  • cursor_type (SnowflakeCursor, optional): specify the type of database cursor to use for the query, defaults to SnowflakeCursor
  • authenticator (str, optional): type of authenticator to use for initiating connection (oauth, externalbrowser...), refer to snowflake documentation https://docs.snowflake.com/en/user-guide/python-connector-api.html#connect for details, note that externalbrowser will only work in an environment where a browser is available, default to None
  • token (str, optional): OAuth or JWT Token to provide when authenticator is set to oauth, default to None
  • **kwargs (dict, optional): additional keyword arguments to pass to the Task constructor

methods:                                                                                                                                                       

prefect.tasks.snowflake.snowflake.SnowflakeQuery.run

(account=None, user=None, password=None, private_key=None, database=None, schema=None, role=None, warehouse=None, query=None, data=None, autocommit=None, cursor_type=snowflake.connector.cursor.SnowflakeCursor, authenticator=None, token=None)[source]

Task run method. Executes a query against snowflake database.

Args:

  • account (str, optional): snowflake account name, see snowflake connector package documentation for details
  • user (str, optional): user name used to authenticate
  • password (str, optional): password used to authenticate. password or private_lkey must be present
  • private_key (bytes, optional): pem to authenticate. password or private_key must be present
  • database (str, optional): name of the default database to use
  • schema (int, optional): name of the default schema to use
  • role (str, optional): name of the default role to use
  • warehouse (str, optional): name of the default warehouse to use
  • query (str, optional): query to execute against database
  • data (tuple, optional): values to use in query, must be specified using placeholder in query string
  • autocommit (bool, optional): set to True to autocommit, defaults to None, which takes snowflake AUTOCOMMIT parameter
  • cursor_type (SnowflakeCursor, optional): specify the type of database cursor to use for the query, defaults to SnowflakeCursor
  • authenticator (str, optional): type of authenticator to use for initiating connection (oauth, externalbrowser...), refer to snowflake documentation https://docs.snowflake.com/en/user-guide/python-connector-api.html#connect for details, note that externalbrowser will only work in an environment where a browser is available, default to None
  • token (str, optional): OAuth or JWT Token to provide when authenticator is set to oauth, default to None
Returns:
  • List[List]: output of cursor.fetchall()
Raises:
  • ValueError: if a required parameter is not supplied
  • DatabaseError: if exception occurs when executing the query


This documentation was auto-generated from commit n/a
on February 23, 2022 at 19:26 UTC

← SodaSpark Tasks →