Hypercore API ref

_partials/_deprecated_2_18_0.md

@@ -0,0 +1 @@
+<Tag variant="hollow">Old API from [TimescaleDB v2.18.0](https://github.com/timescale/timescaledb/releases/tag/2.18.0)</Tag>

_partials/_hypercore_policy_workflow.md

@@ -0,0 +1,65 @@
+1. **Enable columnstore**
+
+   * [Use `ALTER TABLE` for a hypertable][alter_table_hypercore]
+     ```sql
+     ALTER TABLE stocks_real_time SET (timescaledb.enable_columnstore = true, timescaledb.segmentby = 'symbol');
+     ```
+   * [Use ALTER MATERIALIZED VIEW for a continuous aggregate][compression_continuous-aggregate]
+     ```sql
+     ALTER MATERIALIZED VIEW stock_candlestick_daily set (timescaledb.enable_columnstore = true, timescaledb.segmentby = 'symbol' );
+     ```
+
+1. **Add a policy to move chunks to the columnstore at a specific time interval**
+
+   For example, 60 days after the data was added to the table:
+   ``` sql
+   CALL add_columnstore_policy('older_stock_prices', after => INTERVAL '60d');
+   ```
+   See [add_columnstore_policy][add_columnstore_policy].
+
+1. **View the policies that you set or the policies that already exist**
+
+   ``` sql
+   SELECT * FROM timescaledb_information.jobs
+   WHERE proc_name='policy_compression';
+   ```
+   See [timescaledb_information.jobs][informational-views].
+
+1. **Pause a columnstore policy**
+
+   ``` sql
+   SELECT * FROM timescaledb_information.jobs where proc_name = 'policy_compression' AND relname = 'stocks_real_time'
+
+   -- Select the JOB_ID from the results
+
+   SELECT alter_job(JOB_ID, scheduled => false);
+   ```
+   See [alter_job][alter_job].
+
+1. **Restart a columnstore policy**
+   ``` sql
+   SELECT alter_job(JOB_ID, scheduled => true);
+   ```
+   See [alter_job][alter_job].
+
+1. **Remove a columnstore policy**
+   ``` sql
+   CALL remove_columnstore_policy('older_stock_prices');
+   ```
+   See [remove_columnstore_policy][remove_columnstore_policy].
+1. **Disable columnstore**
+
+   If your table has chunks in the columnstore, you have to
+   [convert the chunks back to the rowstore][convert_to_rowstore] before you disable the columnstore.
+   ``` sql
+   ALTER TABLE stocks_real_time SET (timescaledb.enable_columnstore = false);
+   ```
+   See [alter_table_hypercore][alter_table_hypercore]. 
+
+
+[alter_table_hypercore]: /api/:currentVersion:/hypercore/alter_table/
+[alter_job]: /api/:currentVersion:/actions/alter_job/
+[add_columnstore_policy]: /api/:currentVersion:/hypercore/add_columnstore_policy/
+[informational-views]: /api/:currentVersion:/informational-views/jobs/
+[remove_columnstore_policy]: /api/:currentVersion:/hypercore/remove_columnstore_policy/
+[convert_to_rowstore]: /api/:currentVersion:/hypercore/convert_to_rowstore/

_partials/_multi-node-deprecation.md

@@ -1,9 +1,10 @@
 <Highlight type="warning">
 
-[Multi-node support is deprecated][multi-node-deprecation].
+[Multi-node support is sunsetted][multi-node-deprecation].
 
 TimescaleDB v2.13 is the last release that includes multi-node support for PostgreSQL 
 versions 13, 14, and 15.
+
 </Highlight>
 
 [multi-node-deprecation]: https://github.com/timescale/timescaledb/blob/main/docs/MultiNodeDeprecation.md

_partials/_since_2_18_0.md

@@ -0,0 +1 @@
+<Tag variant="hollow">Since [TimescaleDB v2.18.0](https://github.com/timescale/timescaledb/releases/tag/2.18.0)</Tag>

api/add_compression_policy.md → api/compression/add_compression_policy.md

@@ -8,9 +8,12 @@ api:
   license: community
   type: function
 ---
+import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
 
 # add_compression_policy() <Tag type="community" content="community" />
 
+<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/add_columnstore_policy/">add_columnstore_policy()</a>.
+
 Allows you to set a policy by which the system compresses a chunk
 automatically in the background after it reaches a given age.
 
@@ -89,3 +92,4 @@ SELECT add_compression_policy('cpu_weekly', INTERVAL '8 weeks');
 [compression_continuous-aggregate]: /api/:currentVersion:/continuous-aggregates/alter_materialized_view/
 [set_integer_now_func]: /api/:currentVersion:/hypertable/set_integer_now_func
 [informational-views]: /api/:currentVersion:/informational-views/jobs/
+

api/compression/alter_table_compression.md

@@ -0,0 +1,82 @@
+---
+api_name: ALTER TABLE (Compression)
+excerpt: Change compression settings on a compressed hypertable
+topics: [compression]
+keywords: [compression]
+tags: [settings, hypertables, alter, change]
+api:
+  license: community
+  type: command
+---
+import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
+
+# ALTER TABLE (Compression) <Tag type="community" content="community" />
+
+<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/alter_table/">ALTER TABLE (Hypercore)</a>.
+
+'ALTER TABLE' statement is used to turn on compression and set compression
+options.  
+
+By itself, this `ALTER` statement alone does not compress a hypertable. To do so, either create a
+compression policy using the [add_compression_policy][add_compression_policy] function or manually
+compress a specific hypertable chunk using the [compress_chunk][compress_chunk] function.
+
+The syntax is:
+
+``` sql
+ALTER TABLE <table_name> SET (timescaledb.compress,
+   timescaledb.compress_orderby = '<column_name> [ASC | DESC] [ NULLS { FIRST | LAST } ] [, ...]',
+   timescaledb.compress_segmentby = '<column_name> [, ...]',
+   timescaledb.compress_chunk_time_interval='interval'
+);
+```
+
+## Required arguments
+
+|Name|Type|Description|
+|-|-|-|
+|`timescaledb.compress`|BOOLEAN|Enable or disable compression|
+
+## Optional arguments
+
+|Name|Type| Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+|-|-|--|
+|`timescaledb.compress_orderby`|TEXT| Order used by compression, specified in the same way as the ORDER BY clause in a SELECT query. The default is the descending order of the hypertable's time column.                                                                                                                                                                                                                                                                                                                                              |
+|`timescaledb.compress_segmentby`|TEXT| Column list on which to key the compressed segments. An identifier representing the source of the data such as `device_id` or `tags_id` is usually a good candidate. The default is no `segment by` columns.                                                                                                                                                                                                                                                                                                     |
+|`timescaledb.enable_segmentwise_recompression`|TEXT| Set to `OFF` to disable segmentwise recompression on compressed chunks. This can be beneficial for some user workloads where segmentwise recompression is slow, and full recompression is more performant.  The default is `ON`. |
+|`timescaledb.compress_chunk_time_interval`|TEXT| EXPERIMENTAL: Set compressed chunk time interval used to roll chunks into. This parameter compresses every chunk, and then irreversibly merges it into a previous adjacent chunk if possible, to reduce the total number of chunks in the hypertable. Note that chunks will not be split up during decompression. It should be set to a multiple of the current chunk interval. This option can be changed independently of other compression settings and does not require the `timescaledb.compress` argument. |
+
+
+## Parameters
+
+|Name|Type|Description|
+|-|-|-|
+|`table_name`|TEXT|Hypertable that supports compression|
+|`column_name`|TEXT|Column used to order by or segment by|
+|`interval`|TEXT|Time interval used to roll compressed chunks into|
+
+## Sample usage
+
+Configure a hypertable that ingests device data to use compression. Here, if the hypertable
+is often queried about a specific device or set of devices, the compression should be
+segmented using the `device_id` for greater performance.
+
+```sql
+ALTER TABLE metrics SET (timescaledb.compress, timescaledb.compress_orderby = 'time DESC', timescaledb.compress_segmentby = 'device_id');
+```
+
+You can also specify compressed chunk interval without changing other
+compression settings:
+
+```sql
+ALTER TABLE metrics SET (timescaledb.compress_chunk_time_interval = '24 hours');
+```
+
+To disable the previously set option, set the interval to 0:
+
+```sql
+ALTER TABLE metrics SET (timescaledb.compress_chunk_time_interval = '0');
+```
+
+[add_compression_policy]: /api/:currentVersion:/compression/add_compression_policy/
+[compress_chunk]: /api/:currentVersion:/compression/compress_chunk/

api/chunk_compression_stats.md → api/compression/chunk_compression_stats.md

@@ -8,9 +8,12 @@ api:
   license: community
   type: function
 ---
+import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
 
 # chunk_compression_stats() <Tag type="community">Community</Tag>
 
+<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/chunk_columnstore_stats/">chunk_columnstore_stats()</a>.
+
 Get chunk-specific statistics related to hypertable compression.
 All sizes are in bytes.
 

api/compress_chunk.md → api/compression/compress_chunk.md

@@ -9,8 +9,12 @@ api:
   type: function
 ---
 
+import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
+
 # compress_chunk() <Tag type="community">Community</Tag>
 
+<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/convert_to_columnstore/">convert_to_columnstore()</a>.
+
 The `compress_chunk` function is used to compress (or recompress, if necessary) 
 a specific chunk. This is most often used instead of the
 [`add_compression_policy`][add_compression_policy] function, when a user
@@ -27,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|

api/decompress_chunk.md → api/compression/decompress_chunk.md

@@ -7,9 +7,12 @@ api:
   license: community
   type: function
 ---
+import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
 
 # decompress_chunk() <Tag type="community">Community</Tag>
 
+<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/convert_to_cconvert_to_rowstore/">convert_to_rowstore()</a>.
+
 If you need to modify or add a lot of data to a chunk that has already been
 compressed, you should decompress the chunk first. This is especially
 useful for backfilling old data.

api/hypertable_compression_stats.md → api/compression/hypertable_compression_stats.md

@@ -8,9 +8,12 @@ api:
   license: community
   type: function
 ---
+import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
 
 # hypertable_compression_stats() <Tag type="community">Community</Tag>
 
+<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/hypertable_columnstore_stats/">hypertable_columnstore_stats()</a>.
+
 Get statistics related to hypertable compression. All sizes are in bytes.
 
 For more information about using hypertables, including chunk size partitioning,

api/compression.md → api/compression/index.md

@@ -4,8 +4,13 @@ excerpt: Compress your hypertable
 keywords: [compression]
 tags: [hypertables]
 ---
+import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
 
-# Compression <Tag type="community">Community</Tag>
+# Compression (Old API, use Hypercore) <Tag type="community">Community</Tag>
+
+<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/">Hypercore</a>.
+
+Compression functionality is included in Hypercore. 
 
 Before you set up compression, you need to
 [configure the hypertable for compression][configure-compression] and then
@@ -30,6 +35,7 @@ Compressed chunks have the following limitations:
     after constraint creation.
 *   [Timescale SkipScan][skipscan] does not currently work on compressed chunks.
 
+
 ## Restrictions
 
 In general, compressing a hypertable imposes some limitations on the types
@@ -59,3 +65,4 @@ You can also use advanced insert statements like `ON CONFLICT` and `RETURNING`.
 [compress_chunk]: /api/:currentVersion:/compression/compress_chunk/
 [configure-compression]: /api/:currentVersion:/compression/alter_table_compression/
 [skipscan]: /use-timescale/:currentVersion:/query-data/skipscan/
+[hypercore]: /api/:currentVersion:/hypercore/

api/recompress_chunk.md → api/compression/recompress_chunk.md

@@ -9,8 +9,12 @@ api:
   type: function
 ---
 
+import Deprecated2180 from "versionContent/_partials/_deprecated_2_18_0.mdx";
+
 # recompress_chunk() <Tag type="community" content="Community" />
 
+<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/convert_to_columnstore/">convert_to_columnstore()</a>.
+
 Recompresses a compressed chunk that had more data inserted after compression.
 
 ```sql
@@ -41,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|

api/remove_compression_policy.md → api/compression/remove_compression_policy.md

@@ -8,9 +8,12 @@ api:
   license: community
   type: function
 ---
+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
 compression you need to add the policy again. To view the policies that
 already exist, see [informational views][informational-views].

api/distributed-hypertables.md

@@ -1,5 +1,5 @@
 ---
-title: Distributed hypertables
+title: Distributed hypertables ( Sunsetted v2.14.x )
 excerpt: Create and manage distributed hypertables
 keywords: [distributed hypertables]
 ---
@@ -8,7 +8,7 @@ import MultiNodeDeprecation from "versionContent/_partials/_multi-node-deprecati
 
 <MultiNodeDeprecation />
 
-# Distributed Hypertables <Tag type="community">Community</Tag>
+# Distributed hypertables ( Sunsetted v2.14.x) <Tag type="community">Community</Tag>
 
 Distributed hypertables are an extension of regular hypertables, available when
 using a [multi-node installation][getting-started-multi-node] of TimescaleDB.