Prefect Docs

# SQLite Tasks

Verified by Prefect

These tasks have been tested and verified by Prefect.

# SQLiteQuery

class

prefect.tasks.database.sqlite.SQLiteQuery

(db=None, query=None, data=(), **kwargs)[source]

Task for executing a single query against a sqlite3 database; returns the result (if any) from the query.

Args:

  • db (str, optional): the location of the database (.db) file
  • query (str, optional): the optional default query to execute at runtime; can also be provided as a keyword to run, which takes precedence over this default. Note that a query should consist of a single SQL statement.
  • data (tuple, optional): values to use when query is a parametrized string. See https://docs.python.org/3/library/sqlite3.html for more details.
  • **kwargs (optional): additional keyword arguments to pass to the standard Task initalization

methods:                                                                                                                                                       

prefect.tasks.database.sqlite.SQLiteQuery.run

(db=None, query=None, data=())[source]

Args:

  • db (str, optional): the location of the database (.db) file; if not provided, self.db will be used instead.
  • query (str, optional): the optional query to execute at runtime; if not provided, self.query will be used instead. Note that a query should consist of a single SQL statement.
  • data (tuple, optional): values to use when query is a parametrized string. See https://docs.python.org/3/library/sqlite3.html for more details.
Returns:
  • [Any]: the results of the query


# SQLiteScript

class

prefect.tasks.database.sqlite.SQLiteScript

(db=None, script=None, **kwargs)[source]

Task for executing a SQL script against a sqlite3 database; does not return any values, but useful for creating tables and inserting values into the tables.

Args:

  • db (str, optional): the location of the database (.db) file
  • script (str, optional): the optional default script string to render at runtime; can also be provided as a keyword to run, which takes precedence over this default.
  • **kwargs (optional): additional keyword arguments to pass to the standard Task initialization

methods:                                                                                                                                                       

prefect.tasks.database.sqlite.SQLiteScript.run

(db=None, script=None)[source]

Args:

  • db (str, optional): the location of the database (.db) file; if not provided, self.db will be used instead.
  • script (str, optional): the optional script to execute at runtime; if not provided, self.script will be used instead.


This documentation was auto-generated from commit bd9182e
on July 31, 2024 at 18:02 UTC

← String Templating Tasks →