Hyper API Samples

This repo is the home of the Hyper API samples. It contains both Tableau-Supported Samples and Community-Supported Samples:

• The official samples are packaged and shipped within the Hyper API itself. All of the official samples are available for each language supported by the Hyper API: Python, Java, C++, and C#/.Net (.NET Standard 2.0) and are entirely supported and maintained by Tableau.
• The community samples focus on individual use cases and are Python-only. They have been written by members of the Tableau development team but receive the level of 'Community Supported' as they may not be maintained in newer releases. Each of the samples has been manually tested and reviewed before publishing and will still be open to pull requests and issues.
• See our support page for more information.

If you are looking to learn more about the Hyper API, please check out the official documentation.

What is the Hyper API?

For the unfamiliar, the Hyper API contains a set of functions you can use to automate your interactions with Tableau extract (.hyper) files. You can use the API to create new extract files, or to open existing files, and then insert, delete, update, or read data from those files. Using the Hyper API developers and administrators can:

• Create extract files for data sources not currently supported by Tableau.
• Automate custom extract, transform and load (ETL) processes (for example, implement rolling window updates or custom incremental updates).
• Retrieve data from an extract file.

How do I install the Hyper API?

It is a prerequisite that to work with these code samples, the Hyper API is installed in your language of choice. Head to our official Hyper API Documentation to get it up and running.

How do I get help or give feedback?

If you have questions, want to submit ideas, or give feedback on the code, please do so by submitting an issue on this project.

Contributions

Code contributions and improvements by the community are welcomed and accepted on a case-by-case basis. See the LICENSE file for current open-source licensing and use information.

Before we can accept pull requests from contributors, we require a signed Contributor License Agreement (CLA).

Hyper API License

Note that the Hyper API comes with a proprietary license, see the LICENSE file in the Hyper API package.