pytd.query_engine.QueryEngine

class pytd.query_engine.QueryEngine(apikey: str, endpoint: str, database: str, header: str | bool)

An interface to Treasure Data query engine.

Parameters:

• apikey (str) – Treasure Data API key.

• endpoint (str) – Treasure Data API server.

• database (str) – Name of connected database.

• header (str or bool) – Prepend comment strings, in the form “– comment”, as a header of queries.

__init__(apikey: str, endpoint: str, database: str, header: str | bool) → None

Methods

__init__(apikey, endpoint, database, header)
close()
create_header([extra_lines])	Build header comments.
cursor([force_tdclient])
execute(query, **kwargs)	Execute a given SQL statement and return results.

Attributes

user_agent

User agent passed to a query engine connection.

__init__(apikey: str, endpoint: str, database: str, header: str | bool) → None

property user_agent: str

User agent passed to a query engine connection.

execute(query: str, **kwargs: Any) → QueryResult

Execute a given SQL statement and return results.

Executed result returned by Cursor object is stored in self.executed.

Parameters:

• query (str) – Query.

• **kwargs –

  Treasure Data-specific optional query parameters. Giving these keyword arguments forces query engine to issue a query via Treasure Data REST API provided by tdclient, rather than using a direct connection established by the trino package.

  • db (str): use the database

  • result_url (str): result output URL

  • priority (int or str): priority

    • -2: “VERY LOW”

    • -1: “LOW”

    • 0: “NORMAL”

    • 1: “HIGH”

    • 2: “VERY HIGH”

  • retry_limit (int): max number of automatic retries

  • wait_interval (int): sleep interval until job finish

  • wait_callback (function): called every interval against job itself

  • engine_version (str): run query with Hive 2 if this parameter is set to "stable" in HiveQueryEngine. https://api-docs.treasuredata.com/en/tools/hive/writing_hive_queries

  Meanwhile, when a following argument is set to True, query is deterministically issued via tdclient.

  • force_tdclient (bool): force Presto engines to issue a query via tdclient rather than its default trino interface.

Returns:

dict –

‘data’

List of rows. Every single row is represented as a list of column values.

’columns’

List of column names.

Return type:

keys (‘data’, ‘columns’)

create_header(extra_lines: str | list[str] | tuple[str, ...] | None = None) → str

Build header comments.

Parameters:

extra_lines (string or array-like, default: []) – Comments appended to the default one, which corresponds to a user agent string. If self.header=None, empty string is returned regardless of this argument.

Return type:

str

abstractmethod cursor(force_tdclient: bool = False, **kwargs: Any) → CustomTrinoCursor | Cursor

abstractmethod close() → None