pytd.query_engine.HiveQueryEngine

class pytd.query_engine.HiveQueryEngine(apikey, endpoint, database, header)

An interface to Treasure Data Hive query engine.

Parameters

apikeystring

Treasure Data API key.

endpointstring

Treasure Data API server.

databasestring

Name of connected database.

headerstring or boolean

Prepend comment strings, in the form “– comment”, as a header of queries.

__init__(self, apikey, endpoint, database, header)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self, apikey, endpoint, database, …)	Initialize self.
close(self)	Close a connection to Hive.
create_header(self[, extra_lines])	Build header comments.
cursor(self, \*\*kwargs)	Get cursor defined by DB-API.
execute(self, query, \*\*kwargs)	Execute a given SQL statement and return results.

Attributes

user_agent

User agent passed to a Hive connection.

__init__(self, apikey, endpoint, database, header)

Initialize self. See help(type(self)) for accurate signature.

property user_agent

User agent passed to a Hive connection.

cursor(self, **kwargs)

Get cursor defined by DB-API.

Parameters

**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.

• 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

Returns

tdclient.cursor.Cursor

close(self)

Close a connection to Hive.