Skip to content

Commit 4dcbf9e

Browse files
authored
Update all URLs to point to the new documentation (#97)
1 parent 6a954f3 commit 4dcbf9e

File tree

21 files changed

+63
-63
lines changed

21 files changed

+63
-63
lines changed

Community-Supported/adjust-vertex-order/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ __Current Version__: 1.0
77

88
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`.
99

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).
1111

1212
## Background
1313

@@ -85,12 +85,12 @@ Copying table "input"."Extract"."Extract" with 1 spatial columns: [Name('Locatio
8585
## __Resources__
8686
Check out these resources to learn more:
8787

88-
- [Hyper API docs](https://help.tableau.com/current/api/hyper_api/en-us/index.html)
88+
- [Hyper API docs](https://tableau.github.io/hyper-db)
8989

90-
- [Tableau Hyper API Reference (Python)](https://help.tableau.com/current/api/hyper_api/en-us/reference/py/index.html)
90+
- [Tableau Hyper API Reference (Python)](https://tableau.github.io/hyper-db/lang_docs/py/index.html)
9191

92-
- [Hyper API SQL Reference](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/index.html)
92+
- [Hyper API SQL Reference](https://tableau.github.io/hyper-db/docs/sql/)
9393

94-
- [Add Spatial Data to a Hyper File](https://help.tableau.com/current/api/hyper_api/en-us/docs/hyper_api_geodata.html)
94+
- [Add Spatial Data to a Hyper File](https://tableau.github.io/hyper-db/docs/guides/hyper_file/geodata)
9595

96-
- [Geographic Functions in Hyper's SQL API](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/functions-geography.html)
96+
- [Geographic Functions in Hyper's SQL API](https://tableau.github.io/hyper-db/docs/sql/scalar_func/geography)

Community-Supported/clouddb-extractor/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ source env/bin/activate
150150
```
151151

152152
## 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)
154154

155155
```console
156156
pip install --upgrade pip

Community-Supported/convert-hyper-file/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ __Current Version__: 1.0
99

1010
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.
1111

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).
1313

1414
# Get started
1515

@@ -49,8 +49,8 @@ The following instructions assume that you have set up a virtual environment for
4949
## __Resources__
5050
Check out these resources to learn more:
5151

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)
5353

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)
5555

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/)

Community-Supported/defragment-hyper-file/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This sample demonstrates how you can optimize the file storage of an existing `.
1111

1212
This sample should serve as a starting point for anyone looking for a programmatic way to reduce the fragmentation of their `.hyper` file.
1313

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).
1515

1616
# Get started
1717

@@ -62,8 +62,8 @@ To learn more about what is possible with the Hyper API, see the [official Hyper
6262
## __Resources__
6363
Check out these resources to learn more:
6464

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)
6666

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)
6868

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/)

Community-Supported/flights-data-incremental-refresh/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ There are two cases for publishing the database to Server:
4444

4545
## __Resources__
4646
Check out these resources to learn more:
47-
- [Hyper API documentation](https://help.tableau.com/current/api/hyper_api/en-us/index.html)
47+
- [Hyper API documentation](https://tableau.github.io/hyper-db)
4848
- [Hyper Update API documentation](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_how_to_update_data_to_hyper.htm)
4949
- [Tableau Server Client Docs](https://tableau.github.io/server-client-python/docs/)
5050
- [REST API documentation](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api.htm)
51-
- [Tableau Tools](https://github.com/bryantbhowell/tableau_tools)
51+
- [Tableau Tools](https://github.com/bryantbhowell/tableau_tools)

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,6 @@ The script will generate a `git.hyper` file which can be used in Tableau for fur
9494
## __Resources__
9595
Check out these resources to learn more:
9696
97-
- [Hyper API docs](https://help.tableau.com/current/api/hyper_api/en-us/index.html)
97+
- [Hyper API docs](https://tableau.github.io/hyper-db)
9898
99-
- [Tableau Hyper API Reference (Python)](https://help.tableau.com/current/api/hyper_api/en-us/reference/py/index.html)
99+
- [Tableau Hyper API Reference (Python)](https://tableau.github.io/hyper-db/lang_docs/py/index.html)

Community-Supported/hyper-jupyter-kernel/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,15 @@ into your console and submit it. You should get `6` as a result. Congrats! You j
6868

6969
Independent of how you run your `hyper_kernel`, the usage is always similar:
7070
You feed SQL to it, and in return you get the query results.
71-
The [HyperAPI SQL reference](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/index.html) contains all the information you need.
71+
The [HyperAPI SQL reference](https://tableau.github.io/hyper-db/docs/sql/) contains all the information you need.
7272
For everyone who prefers to not read the whole reference first, here is a short quick start on the most common scenarios:
7373

7474

7575
## Creating a Hyper database
7676

7777
That was boring, though... Instead of only using Hyper as your calculator, you usually want to use it to crunch some data.
7878

79-
First let's [create a new database](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/sql-createdatabase.html):
79+
First let's [create a new database](https://tableau.github.io/hyper-db/docs/sql/command/create_database):
8080
```
8181
CREATE DATABASE "my_data.hyper";
8282
```
@@ -86,13 +86,13 @@ and load that newly created database into our session:
8686
\attach "patch/to/my/data.hyper" database1
8787
```
8888

89-
Next, we will need to [create a table](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/sql-createtable.html):
89+
Next, we will need to [create a table](https://tableau.github.io/hyper-db/docs/sql/command/create_table):
9090
```
9191
CREATE TABLE database1.public.my_table (column1 text, column2 bigint);
9292
```
9393
where `database1` is the alias we gave to our database when running the `\attach` command
9494

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):
9696
```
9797
INSERT INTO database1.public.my_table VALUES('one', 1),('two', 2),('three', 3)
9898
```
@@ -104,7 +104,7 @@ And close the database:
104104

105105
and voila: You have your Hyper file which you could now use with Tableau.
106106
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.
108108

109109
## Examining an existing Hyper database
110110

@@ -133,7 +133,7 @@ SELECT COUNT(*) FROM "Extract"."Extract"
133133

134134
# Built-in commands
135135

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/).
137137
In addition, this command line interface also offers a few convenience functions.
138138
In particular, you can use:
139139
* `\o <file>` to redirect the output of all following queries to a file

Community-Supported/hyper-jupyter-kernel/hyper_kernel/kernel.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ def _process_client_command(self, code, silent):
203203
cmd = args.pop(0)
204204

205205
if cmd == "?" or cmd == "help":
206-
help_text = 'SQL command reference: https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/sql-commands.html\n'
206+
help_text = 'SQL command reference: https://tableau.github.io/hyper-db/docs/sql/command/\n'
207207
help_text += 'Additional client-side commands:\n'
208208
help_text += tabulate((["\\" + c[0], c[1].__doc__] for c in commands.items()), tablefmt='plain')
209209
help_text += '\n'

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To run the script, you will need:
1818

1919
## Run the sample
2020

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).
2222

2323
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.
2424

@@ -32,12 +32,12 @@ As mentioned in pantab's [usage notes](https://pantab.readthedocs.io/en/latest/c
3232
## __Resources__
3333
Check out these resources to learn more:
3434

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)
3636

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)
3838

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/)
4040

4141
- [pantab](https://pantab.readthedocs.io/en/latest/index.html)
4242

43-
- [pandas docs](https://pandas.pydata.org/docs/)
43+
- [pandas docs](https://pandas.pydata.org/docs/)

Community-Supported/native-s3/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -55,18 +55,18 @@ This script will perform a live query on the CSV file which is stored in this pu
5555
Run the Python script
5656

5757
```bash
58-
$ python join-parquet-and-csv-on-s3.py
58+
$ python https://tableau.github.io/hyper-db/lang_docs/pyhttps://tableau.github.io/hyper-db/lang_docs/py
5959
```
6060

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://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.
6262

6363
## __Resources__
6464
Check out these resources to learn more:
6565

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)
6767

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)
6969

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/)
7171

7272
- [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

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ in the Python Standard Library.
3838
## __Resources__
3939
Check out these resources to learn more:
4040

41-
- [Hyper API docs](https://help.tableau.com/current/api/hyper_api/en-us/index.html)
41+
- [Hyper API docs](https://tableau.github.io/hyper-db)
4242

43-
- [Tableau Hyper API Reference (Python)](https://help.tableau.com/current/api/hyper_api/en-us/reference/py/index.html)
43+
- [Tableau Hyper API Reference (Python)](https://tableau.github.io/hyper-db/lang_docs/py/index.html)
4444

45-
- [The COPY command in the Hyper API SQL Reference](https://help.tableau.com/current/api/hyper_api/en-us/reference/sql/sql-copy.html)
45+
- [The COPY command in the Hyper API SQL Reference](https://tableau.github.io/hyper-db/docs/sql/command/copy_from)

Community-Supported/parquet-to-hyper/create_hyper_file_from_parquet.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ def run_create_hyper_file_from_parquet(
2929
table definition of the data to copy needs to be known and explicitly specified.
3030
3131
Reading Parquet data is analogous to reading CSV data. For more details, see:
32-
https://help.tableau.com/current/api/hyper_api/en-us/docs/hyper_api_insert_csv.html
32+
https://tableau.github.io/hyper-db/docs/guides/hyper_file/insert_csv
3333
"""
3434

3535
# Start the Hyper process.

Community-Supported/publish-multi-table-hyper-legacy/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Modify `config.json` and add the following fields:
3636
## __Data and Table Definitions__
3737
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.
3838

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.
4040

4141
__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.
4242

@@ -65,7 +65,7 @@ Leverage the [official Hyper API samples](https://github.com/tableau/hyper-api-s
6565

6666
## __Resources__
6767
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)
6969
- [TSC Docs](https://tableau.github.io/server-client-python/docs/)
7070
- [REST API docs](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api.htm)
71-
- [Tableau Tools](https://github.com/bryantbhowell/tableau_tools)
71+
- [Tableau Tools](https://github.com/bryantbhowell/tableau_tools)

0 commit comments

Comments
 (0)