Update docstring for TD-specific query params

treasure-data · Sep 5, 2019 · eda21b8 · eda21b8
1 parent 5278cbd
commit eda21b8
Show file tree

Hide file tree

Showing 3 changed files with 110 additions and 5 deletions.
diff --git a/pytd/client.py b/pytd/client.py
@@ -146,6 +146,25 @@ def query(self, query, engine=None, **kwargs):
             Query engine. If not given, default query engine created in the
             constructor will be used.
 
+        **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``; that is, if ``engine`` is
+            Presto, you cannot enjoy efficient direct access to the query
+            engine provided by ``prestodb``.
+
+            - ``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
         -------
         dict : keys ('data', 'columns')

diff --git a/pytd/pandas_td/__init__.py b/pytd/pandas_td/__init__.py
@@ -121,12 +121,23 @@ def read_td_query(
         See https://prestodb.io/docs/current/release/release-0.77.html
 
     params : dict, optional
-        Parameters to pass to execute method.
+        Parameters to pass to execute method. pytd does not support parameter
+        ``type`` ('hive', 'presto'), and query type needs to be defined by
+        ``engine``.
+
         Available parameters:
-        - result_url (str): result output URL
-        - priority (int or str): priority (e.g. "NORMAL", "HIGH", etc.)
-        - retry_limit (int): retry limit
-        pytd: This argument will be ignored.
+
+        - ``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
     -------

diff --git a/pytd/query_engine.py b/pytd/query_engine.py
@@ -49,6 +49,24 @@ def execute(self, query, **kwargs):
         query : string
             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 ``prestodb`` 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
+
         Returns
         -------
         dict : keys ('data', 'columns')
@@ -125,6 +143,24 @@ def _get_tdclient_cursor(self, con, **kwargs):
         con : tdclient.connection.Connection
             Handler created by ``tdclient#connect``.
 
+        **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 ``prestodb`` 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
+
         Returns
         -------
         tdclient.cursor.Cursor
@@ -221,6 +257,26 @@ def presto_api_host(self):
     def 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``, rather than using a direct
+            connection established by the ``prestodb`` 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
+
         Returns
         -------
         prestodb.dbapi.Cursor, or tdclient.cursor.Cursor
@@ -288,6 +344,25 @@ def user_agent(self):
     def 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