Script to convert tde to hyper

A few changes to script

Author: TableauKyle

Community-Supported/tde-to-hyper/README.md

@@ -0,0 +1,54 @@
+# tde-to-hyper
+## __tde_to_hyper__
+
+![Community Supported](https://img.shields.io/badge/Support%20Level-Community%20Supported-53bd92.svg)
+
+__Current Version__: 1.0
+
+This script can be used to create a `.hyper` file from a `.tde` file.
+
+# Get started
+
+## __Prerequisites__
+
+To run the script, you will need:
+
+- a computer running Windows, macOS, or Linux
+
+- Python (3.7 or newer)
+
+- Install the Hyper API `pip install -r requirements.txt`
+
+## Run the sample
+
+Ensure that you have installed the requirements and then just run the sample Python file.
+The following instructions assume that you have set up a virtual environment for Python. For more information on
+creating virtual environments, see [venv - Creation of virtual environments](https://docs.python.org/3/library/venv.html)
+in the Python Standard Library.
+
+1. Open a terminal and activate the Python virtual environment (`venv`).
+
+1. Navigate to the folder where you installed the sample.
+
+1. Run the Python script:
+   
+   **python tde_to_hyper.py input_tde_path**
+
+   The script requires a path to a tde file and will convert the tde to a `.hyper` file. The `.hyper` file will be created in the directory of the tde file.
+
+   Example:
+
+   ```cli
+   (venv)c:\mydir> python tde_to_hyper.py extract.tde
+   Successfully converted extract.tde to extract.hyper
+
+   (venv)c:\mydir> python tde_to_hyper.py c:\path\to\file\extract.tde
+   Successfully converted c:\path\to\file\extract.tde to c:\path\to\file\extract.hyper
+   ```
+
+## __Resources__
+Check out these resources to learn more:
+
+- [Hyper API docs](https://help.tableau.com/current/api/hyper_api/en-us/index.html)
+
+- [Tableau Hyper API Reference (Python)](https://help.tableau.com/current/api/hyper_api/en-us/reference/py/index.html)

Community-Supported/tde-to-hyper/requirements.txt

@@ -0,0 +1 @@
+tableauhyperapi==0.0.14109

Community-Supported/tde-to-hyper/tde_to_hyper.py

@@ -0,0 +1,51 @@
+import argparse
+from pathlib import Path
+from tableauhyperapi import HyperProcess, Telemetry, \
+    Connection, CreateMode, TableDefinition, escape_name, \
+    escape_string_literal
+
+def convert_tde_to_hyper(tde_path: Path):
+    # Rename path with a .hyper extension in the directory of the tde file
+    hyper_database = tde_path.with_name(tde_path.stem + '.hyper')
+
+    with HyperProcess(telemetry=Telemetry.SEND_USAGE_DATA_TO_TABLEAU) as hyper:
+        with Connection(endpoint=hyper.endpoint, database=hyper_database, create_mode=CreateMode.CREATE_AND_REPLACE) as connection:
+            # Schema and table for TDE file is constant
+            schema = 'Extract'
+            table = 'Extract'
+
+            # Create the temp external table for the TDE file
+            create_external_table_query = _get_external_table_query(str(tde_path), schema, table)
+            connection.execute_command(create_external_table_query)
+
+            # Get the name of the table created from the catalog
+            td = connection.catalog.get_table_definition(table)
+
+            # Create the schema
+            connection.catalog.create_schema(schema)
+
+            # Create the destination table in the Hyper database
+            schema_table = f"\"{schema}\".\"{table}\"" 
+            create_table_command = f"CREATE TABLE {escape_name(schema_table)} AS SELECT * FROM {td.table_name}"
+
+            # Execute
+            connection.execute_command(create_table_command)
+
+    print(f"Successfully converted {tde_path} to {hyper_database}")
+
+def _get_external_table_query(tde_file_path: str,
+                              schema: str,
+                              table: str):
+    return f"""CREATE TEMP EXTERNAL TABLE {escape_name(table)} FOR {escape_string_literal(tde_file_path)} 
+    (WITH (FORMAT TDE, TABLE {escape_string_literal(f"{schema}.{table}")}, SANITIZE))"""
+
+if __name__ == '__main__':
+    argparser = argparse.ArgumentParser(description="Script to convert a TDE file to a Hyper file.")
+    argparser.add_argument("input_tde_path", type=Path, help="The input TDE file path that will be converted to a Hyper file.")
+    args = argparser.parse_args()
+    
+    input_tde_path = Path(args.input_tde_path)
+    if not input_tde_path.exists():
+        raise Exception(f"{input_tde_path} not found")
+
+    convert_tde_to_hyper(input_tde_path)