Skip to content

Commit

Permalink
Update links to Hyper API's documentation (#180)
Browse files Browse the repository at this point in the history
  • Loading branch information
vogelsgesang committed Apr 20, 2023
1 parent be26411 commit e7869b5
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions doc/source/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -155,14 +155,14 @@ Providing your own HyperProcess

.. versionadded:: 2.0

For convenience, pantab's functions internally spawn a `HyperProcess <https://help.tableau.com/current/api/hyper_api/en-us/reference/py/tableauhyperapi.html#tableauhyperapi.HyperProcess>`_. In case you prefer to spawn your own ``HyperProcess``, you can supply it to pantab through the ``hyper_process`` keyword argument.
For convenience, pantab's functions internally spawn a `HyperProcess <https://tableau.github.io/hyper-db/docs/hyper-api/hyper_process>`_. In case you prefer to spawn your own ``HyperProcess``, you can supply it to pantab through the ``hyper_process`` keyword argument.

By using your own ``HyperProcess``, you have full control over all its startup paramters.
In the following example we use that flexibility to:

- enable telemetry, thereby making sure the Hyper team at Tableau knows about our use case and potential issues we might be facing
- `disable log files <https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/loggingsettings.html#LOG_CONFIG>`_, as we operate in some environment with really tight disk space
- opt-in to the `new Hyper file format <https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/databasesettings.html#DEFAULT_DATABASE_VERSION>`_
- `disable log files <https://tableau.github.io/hyper-db/docs/hyper-api/hyper_process#log_config>`_, as we operate in some environment with really tight disk space
- opt-in to the `new Hyper file format <https://tableau.github.io/hyper-db/docs/hyper-api/hyper_process#default_database_version>`_

By reusing the same ``HyperProcess`` for multiple operations, we also save a few milliseconds. While not noteworthy in this simple example, this might be a good optimization in case you call ``frame_to_hyper`` repeatedly in a loop.

Expand Down Expand Up @@ -193,7 +193,7 @@ Providing your own Hyper Connection

.. versionadded:: 2.0

In order to interface with Hyper, pantab functions need a HyperAPI `Connection <https://help.tableau.com/current/api/hyper_api/en-us/reference/py/tableauhyperapi.html#tableauhyperapi.Connection>`_ to interface with Hyper.
In order to interface with Hyper, pantab functions need a HyperAPI `Connection <https://tableau.github.io/hyper-db/docs/hyper-api/connection>`_ to interface with Hyper.
For convenience, pantab creates those connections implicitly for you.
However, establishing a connection is not for free, and by reusing the same ``Connection`` for multiple operations, we can save time.
Hence, pantab also allows you to pass in a HyperAPI connection instead of the name / location of your Hyper file.
Expand Down
2 changes: 1 addition & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ pantab
What is it?
-----------

``pantab`` is a Python wrapper around Tableau's `Hyper API <https://help.tableau.com/current/api/hyper_api/en-us/index.html>`_ which promotes usage of the `pandas DataFrame <https://pandas.pydata.org/pandas-docs/version/0.23.4/generated/pandas.DataFrame.html>`_ to seamlessly generate and read hyper extracts.
``pantab`` is a Python wrapper around Tableau's `Hyper API <https://tableau.github.io/hyper-db/>`_ which promotes usage of the `pandas DataFrame <https://pandas.pydata.org/pandas-docs/version/0.23.4/generated/pandas.DataFrame.html>`_ to seamlessly generate and read hyper files.

How do I get it?
----------------
Expand Down

0 comments on commit e7869b5

Please sign in to comment.