Hypercore API ref (#3699)

* chore: add api ref files and alter_table to the build. Signed-off-by: Iain Cox <[email protected]> Co-authored-by: Erik Nordström <[email protected]>
timescale · Feb 25, 2025 · f7e34bd · f7e34bd
1 parent 2ffe948
commit f7e34bd
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 4 deletions.
diff --git a/api/compression/add_compression_policy.md b/api/compression/add_compression_policy.md
@@ -8,6 +8,7 @@ api:
   license: community
   type: function
 ---
+import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
 
 import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
 

diff --git a/api/compression/chunk_compression_stats.md b/api/compression/chunk_compression_stats.md
@@ -8,6 +8,7 @@ api:
   license: community
   type: function
 ---
+import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
 
 import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
 

diff --git a/api/compression/compress_chunk.md b/api/compression/compress_chunk.md
@@ -31,6 +31,7 @@ You can get a list of chunks belonging to a hypertable using the
 [`show_chunks` function](/api/latest/hypertable/show_chunks/).
 </Highlight>
 
+
 ### Required arguments
 
 |Name|Type|Description|

diff --git a/api/compression/decompress_chunk.md b/api/compression/decompress_chunk.md
@@ -7,6 +7,7 @@ api:
   license: community
   type: function
 ---
+import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
 
 import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
 

diff --git a/api/compression/hypertable_compression_stats.md b/api/compression/hypertable_compression_stats.md
@@ -8,6 +8,7 @@ api:
   license: community
   type: function
 ---
+import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
 
 import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
 

diff --git a/api/compression/recompress_chunk.md b/api/compression/recompress_chunk.md
@@ -45,6 +45,7 @@ the procedure with `CALL`. Don't use a `SELECT` statement.
 chunk for the first time, use [`compress_chunk`](/api/latest/compression/compress_chunk/).
 </Highlight>
 
+
 ## Required arguments
 
 |Name|Type|Description|

diff --git a/api/compression/remove_compression_policy.md b/api/compression/remove_compression_policy.md
@@ -8,14 +8,10 @@ api:
   license: community
   type: function
 ---
-
-import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
-
 import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
 
 # remove_compression_policy() <Tag type="community" content="community" />
 
-
 <Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/remove_columnstore_policy/">remove_columnstore_policy()</a>.
 
 If you need to remove the compression policy. To restart policy-based

diff --git a/api/hypercore/convert_to_columnstore.md b/api/hypercore/convert_to_columnstore.md
@@ -31,6 +31,9 @@ To convert a single chunk to columnstore:
 CALL convert_to_columnstore('_timescaledb_internal._hyper_1_2_chunk');
 ```
 
+To retrieve the chunks belonging to a hypertable, call [`show_chunks`](/api/latest/hypertable/show_chunks/).
+
+
 ## Arguments
 
 | Name                 | Type | Default | Required | Description                                                                                                    |