You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Community-Supported/adjust-vertex-order/README.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ __Current Version__: 1.0
7
7
8
8
This sample demonstrates how you can adjust the vertex order of all polygons of an existing `.hyper` file. This is done by copying all of the tables and data into a new file while calling a SQL function (`geo_auto_vertex_order` or `geo_invert_vertex_order`) on all columns of type `GEOGRAPHY`.
9
9
10
-
For more information on Hyper's SQL functions that operate on `GEOGRAPHY` values, see [Geographic Functions](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/functions-geography.html).
10
+
For more information on Hyper's SQL functions that operate on `GEOGRAPHY` values, see [Geographic Functions](https://tableau.github.io/hyper-db/docs/sql/scalar_func/geography).
Copy file name to clipboardExpand all lines: Community-Supported/clouddb-extractor/README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -150,7 +150,7 @@ source env/bin/activate
150
150
```
151
151
152
152
## Install Hyper API Client Libraries
153
-
For latest instructions refer to: [Hyper API for Python](https://help.tableau.com/current/api/hyper_api/en-us/docs/hyper_api_installing.html#install-the-hyper-api-for-python-36-and-37)
153
+
For latest instructions refer to: [Hyper API for Python](https://tableau.github.io/hyper-db/docs/installation)
Copy file name to clipboardExpand all lines: Community-Supported/convert-hyper-file/README.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ __Current Version__: 1.0
9
9
10
10
This sample demonstrates how you can upgrade or downgrade an existing `.hyper` file to a newer or older Hyper file format by copying all of the tables and data into a new file.
11
11
12
-
Fore more information on the Hyper file formats, see [Hyper Process Settings](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/databasesettings.html#DEFAULT_DATABASE_VERSION).
12
+
Fore more information on the Hyper file formats, see [Hyper Process Settings](https://tableau.github.io/hyper-db/docs/hyper-api/hyper_process#process-settings).
13
13
14
14
# Get started
15
15
@@ -49,8 +49,8 @@ The following instructions assume that you have set up a virtual environment for
49
49
## __Resources__
50
50
Check out these resources to learn more:
51
51
52
-
-[Hyper API docs](https://help.tableau.com/current/api/hyper_api/en-us/index.html)
52
+
-[Hyper API docs](https://tableau.github.io/hyper-db)
53
53
54
-
-[Tableau Hyper API Reference (Python)](https://help.tableau.com/current/api/hyper_api/en-us/reference/py/index.html)
54
+
-[Tableau Hyper API Reference (Python)](https://tableau.github.io/hyper-db/lang_docs/py/index.html)
55
55
56
-
-[Hyper API SQL Reference](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/index.html)
56
+
-[Hyper API SQL Reference](https://tableau.github.io/hyper-db/docs/sql/)
Copy file name to clipboardExpand all lines: Community-Supported/defragment-hyper-file/README.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ This sample demonstrates how you can optimize the file storage of an existing `.
11
11
12
12
This sample should serve as a starting point for anyone looking for a programmatic way to reduce the fragmentation of their `.hyper` file.
13
13
14
-
For a description of how fragmentation can occur in the `.hyper` file and for ways of minimizing it's occurrence, see [Optimize Hyper File Storage](https://help.tableau.com/current/api/hyper_api/en-us/docs/hyper_api_defrag.html).
14
+
For a description of how fragmentation can occur in the `.hyper` file and for ways of minimizing it's occurrence, see [Optimize Hyper File Storage](https://tableau.github.io/hyper-db/docs/guides/hyper_file/optimize).
15
15
16
16
# Get started
17
17
@@ -62,8 +62,8 @@ To learn more about what is possible with the Hyper API, see the [official Hyper
62
62
## __Resources__
63
63
Check out these resources to learn more:
64
64
65
-
-[Hyper API docs](https://help.tableau.com/current/api/hyper_api/en-us/index.html)
65
+
-[Hyper API docs](https://tableau.github.io/hyper-db)
66
66
67
-
-[Tableau Hyper API Reference (Python)](https://help.tableau.com/current/api/hyper_api/en-us/reference/py/index.html)
67
+
-[Tableau Hyper API Reference (Python)](https://tableau.github.io/hyper-db/lang_docs/py/index.html)
68
68
69
-
-[Hyper API SQL Reference](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/index.html)
69
+
-[Hyper API SQL Reference](https://tableau.github.io/hyper-db/docs/sql/)
where `database1` is the alias we gave to our database when running the `\attach` command
94
94
95
-
Maybe [insert some data](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/sql-insert.html):
95
+
Maybe [insert some data](https://tableau.github.io/hyper-db/docs/sql/command/insert):
96
96
```
97
97
INSERT INTO database1.public.my_table VALUES('one', 1),('two', 2),('three', 3)
98
98
```
@@ -104,7 +104,7 @@ And close the database:
104
104
105
105
and voila: You have your Hyper file which you could now use with Tableau.
106
106
In real-life you might want to put some more useful data in it, though.
107
-
You could do so, using e.g. the [COPY command](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/sql-copy.html) to load data from a CSV file.
107
+
You could do so, using e.g. the [COPY command](https://tableau.github.io/hyper-db/docs/sql/command/copy_from) to load data from a CSV file.
108
108
109
109
## Examining an existing Hyper database
110
110
@@ -133,7 +133,7 @@ SELECT COUNT(*) FROM "Extract"."Extract"
133
133
134
134
# Built-in commands
135
135
136
-
Most of the time, you want to run [SQL commands](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/sql-commands.html).
136
+
Most of the time, you want to run [SQL commands](https://tableau.github.io/hyper-db/docs/sql/command/).
137
137
In addition, this command line interface also offers a few convenience functions.
138
138
In particular, you can use:
139
139
*`\o <file>` to redirect the output of all following queries to a file
Copy file name to clipboardExpand all lines: Community-Supported/hyper-to-csv/README.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ To run the script, you will need:
18
18
19
19
## Run the sample
20
20
21
-
Running hyper-to-csv.py will transform a given hyper file into a CSV. Simply change the values of `hyper_name`, `my_table`, and `output_name` to match your use case. Note that `my_table` is an object that can take both the table name, as well as the schema name. See more on this in the [TableName documentation](https://help.tableau.com/current/api/hyper_api/en-us/reference/py/tableauhyperapi.html#tableauhyperapi.TableName).
21
+
Running hyper-to-csv.py will transform a given hyper file into a CSV. Simply change the values of `hyper_name`, `my_table`, and `output_name` to match your use case. Note that `my_table` is an object that can take both the table name, as well as the schema name. See more on this in the [TableName documentation](https://tableau.github.io/hyper-db/lang_docs/py/tableauhyperapi.html#tableauhyperapi.TableName).
22
22
23
23
Instead of leveraging the `insert_data()` method, you will simply reference an existing `.hyper` file and use the `convert_to_csv()` method. The sample database created in the script is for demonstrative purposes only.
24
24
@@ -32,12 +32,12 @@ As mentioned in pantab's [usage notes](https://pantab.readthedocs.io/en/latest/c
32
32
## __Resources__
33
33
Check out these resources to learn more:
34
34
35
-
-[Hyper API docs](https://help.tableau.com/current/api/hyper_api/en-us/index.html)
35
+
-[Hyper API docs](https://tableau.github.io/hyper-db)
36
36
37
-
-[Tableau Hyper API Reference (Python)](https://help.tableau.com/current/api/hyper_api/en-us/reference/py/index.html)
37
+
-[Tableau Hyper API Reference (Python)](https://tableau.github.io/hyper-db/lang_docs/py/index.html)
38
38
39
-
-[Hyper API SQL Reference](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/index.html)
39
+
-[Hyper API SQL Reference](https://tableau.github.io/hyper-db/docs/sql/)
This script will perform a live query on multiple `.parquet` files which are stored on AWS S3. It shows how to use the [`ARRAY` syntax](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/functions-srf.html#FUNCTIONS-SRF-EXTERNAL) to union multiple `.parquet` files and how `.parquet` files can be joined together with `.csv` files - as you would expect from normal database tables stored inside a `.hyper` file.
61
+
This script will perform a live query on multiple `.parquet` files which are stored on AWS S3. It shows how to use the [`ARRAY` syntax](https://tableau.github.io/hyper-db/docs/sql/external/) to union multiple `.parquet` files and how `.parquet` files can be joined together with `.csv` files - as you would expect from normal database tables stored inside a `.hyper` file.
62
62
63
63
## __Resources__
64
64
Check out these resources to learn more:
65
65
66
-
-[Hyper API docs](https://help.tableau.com/current/api/hyper_api/en-us/index.html)
66
+
-[Hyper API docs](https://tableau.github.io/hyper-db)
67
67
68
-
-[Tableau Hyper API Reference (Python)](https://help.tableau.com/current/api/hyper_api/en-us/reference/py/index.html)
68
+
-[Tableau Hyper API Reference (Python)](https://tableau.github.io/hyper-db/lang_docs/py/index.html)
69
69
70
-
-[The EXTERNAL function in the Hyper API SQL Reference](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/functions-srf.html#FUNCTIONS-SRF-EXTERNAL)
70
+
-[The EXTERNAL function in the Hyper API SQL Reference](https://tableau.github.io/hyper-db/docs/sql/external/)
71
71
72
72
-[AWS command line tools documentation](https://docs.aws.amazon.com/cli/latest/reference/s3/cp.html), e.g. if you want to download some of the sample files to your local machine and explore them
Copy file name to clipboardExpand all lines: Community-Supported/publish-multi-table-hyper-legacy/README.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ Modify `config.json` and add the following fields:
36
36
## __Data and Table Definitions__
37
37
If you want to simply run the sample to test the publishing process, you do not need to make any changes to the python file. Ensure that you have installed the requirements, update the config file with authentication information and execute the python file.
38
38
39
-
Once you are ready to use your own data, you will need to change the `build_tables()` and the `get_data()` functions. `build_tables()` returns the schema of all tables to be created (an array of `TableDefinition` objects, one for each table you want to create). `get_data()` returns the data to be inserted, one array for each table (an array of arrays, one containing the data to be inserted for each table). Those functions could be a part of an existing ETL workflow, grab the data from an API request, or pull CSVs from cloud storage like AWS, Azure, or GCP. In any case, writing that code is up to you. You can [check out this doc](https://help.tableau.com/current/api/hyper_api/en-us/reference/py/tableauhyperapi.html?tableauhyperapi.Inserter) information on how to pass data to Hyper's `inserter()` method and [this doc](https://help.tableau.com/current/api/hyper_api/en-us/reference/py/tableauhyperapi.html?tableauhyperapi.SqlType) for more information on the the Hyper API's SqlType class.
39
+
Once you are ready to use your own data, you will need to change the `build_tables()` and the `get_data()` functions. `build_tables()` returns the schema of all tables to be created (an array of `TableDefinition` objects, one for each table you want to create). `get_data()` returns the data to be inserted, one array for each table (an array of arrays, one containing the data to be inserted for each table). Those functions could be a part of an existing ETL workflow, grab the data from an API request, or pull CSVs from cloud storage like AWS, Azure, or GCP. In any case, writing that code is up to you. You can [check out this doc](https://tableau.github.io/hyper-db/lang_docs/py/tableauhyperapi.html?tableauhyperapi.Inserter) information on how to pass data to Hyper's `inserter()` method and [this doc](https://tableau.github.io/hyper-db/lang_docs/py/tableauhyperapi.html?tableauhyperapi.SqlType) for more information on the the Hyper API's SqlType class.
40
40
41
41
__Note:__ The current example features two tables, but in theory, this could support as many as you'd like. Just be sure to add the proper table definitions and make sure that the order in the list of table data and table definitions properly match.
42
42
@@ -65,7 +65,7 @@ Leverage the [official Hyper API samples](https://github.com/tableau/hyper-api-s
65
65
66
66
## __Resources__
67
67
Check out these resources to learn more:
68
-
-[Hyper API docs](https://help.tableau.com/current/api/hyper_api/en-us/index.html)
68
+
-[Hyper API docs](https://tableau.github.io/hyper-db)
0 commit comments