Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hypercore API ref #3699

Merged
Changes from 1 commit
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
7bc034a
chore: space to validate initial build.
billy-the-fish Jan 9, 2025
b7e966e
chore: add first hypercore files.
billy-the-fish Jan 9, 2025
3899a6e
chore: add api ref files and alter_table to the build.
billy-the-fish Jan 9, 2025
bd9946c
chore: add remove_columnstore_policy to the build.
billy-the-fish Jan 9, 2025
5ad76e2
chore: add convert_to_columnstore to the build.
billy-the-fish Jan 9, 2025
993cf07
chore: add convert_to_rowstore to the build.
billy-the-fish Jan 9, 2025
d1fde35
chore: updates for build.
billy-the-fish Jan 9, 2025
f727241
chore: updates for build.
billy-the-fish Jan 9, 2025
67c638f
chore: remove links from steps in a list.
billy-the-fish Jan 9, 2025
39c8f8c
chore: remove links from steps in a list.
billy-the-fish Jan 9, 2025
193f0d6
Merge branch 'latest' into 235-docs-rfc-update-the-api-ref-for-hypers…
billy-the-fish Jan 9, 2025
af34323
chore: hopefully this will work now.
billy-the-fish Jan 9, 2025
a80f250
chore: add deprecation for compression.
billy-the-fish Jan 9, 2025
c03cae9
chore: simplify workflow, keep code for main docs.
billy-the-fish Jan 9, 2025
e58a7c9
chore: updates on review. .
billy-the-fish Jan 9, 2025
338bac1
Merge branch 'latest' into 235-docs-rfc-update-the-api-ref-for-hypers…
billy-the-fish Jan 10, 2025
1409dfd
chore: updates on review.
billy-the-fish Jan 10, 2025
d8008e0
Merge branch 'latest' into 235-docs-rfc-update-the-api-ref-for-hypers…
billy-the-fish Jan 13, 2025
a4bf7f1
Merge branch 'latest' into 235-docs-rfc-update-the-api-ref-for-hypers…
billy-the-fish Jan 14, 2025
de1c436
feat: update structure for hypercore
billy-the-fish Jan 6, 2025
834a406
chore: add replacedby link. Has to be hardcoded so will not work unti…
billy-the-fish Jan 15, 2025
e969ec0
Merge branch 'latest' into 235-docs-rfc-update-the-api-ref-for-hypers…
billy-the-fish Jan 15, 2025
fe6d956
Apply suggestions from code review
billy-the-fish Jan 15, 2025
8c87b3c
chore: update on review.
billy-the-fish Jan 15, 2025
25a2bcc
chore: add enable_segmentwise_recompression.
billy-the-fish Jan 16, 2025
c849517
chore: add enable_segmentwise_recompression.
billy-the-fish Jan 16, 2025
be89feb
Merge branch 'latest' into 235-docs-rfc-update-the-api-ref-for-hypers…
billy-the-fish Jan 16, 2025
93ebdde
Merge branch 'latest' into 235-docs-rfc-update-the-api-ref-for-hypers…
billy-the-fish Jan 17, 2025
e4a4a57
chore: update deprecation notices.
billy-the-fish Jan 17, 2025
8025d11
chore: update deprecation notices.
billy-the-fish Jan 17, 2025
ce662f7
chore: remove stuff breaking the build.
billy-the-fish Jan 17, 2025
cc5030d
Merge branch 'latest' into 235-docs-rfc-update-the-api-ref-for-hypers…
billy-the-fish Jan 20, 2025
7ca04c9
chore: remove stuff breaking the build.
billy-the-fish Jan 18, 2025
629d4a8
chore: updates on review.
billy-the-fish Jan 23, 2025
7e0eae4
Merge branch 'latest' into 235-docs-rfc-update-the-api-ref-for-hypers…
billy-the-fish Jan 23, 2025
da173a7
Add API description for merge_chunks() (#3738)
erimatnor Jan 23, 2025
277031e
Merge branch 'latest' into 235-docs-rfc-update-the-api-ref-for-hypers…
billy-the-fish Jan 27, 2025
41564b4
chore: update return table.
billy-the-fish Jan 28, 2025
80b0e3d
chore: change from deprecated to Old API.
billy-the-fish Jan 29, 2025
e5135b4
chore: change from deprecated to Old API.
billy-the-fish Jan 29, 2025
5deb4f8
chore: update on review.
billy-the-fish Jan 29, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: add replacedby link. Has to be hardcoded so will not work unti…
…l these docs go live.
  • Loading branch information
billy-the-fish committed Jan 15, 2025
commit 834a406b88a88a92e1fbc8ee016f73c151e32103
Original file line number Diff line number Diff line change
@@ -24,7 +24,7 @@ command. To enable compression on continuous aggregates, use the
command. To view the policies that you set or the policies that already exist,
see [informational views][informational-views].

<Deprecated2180 />
<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/add_columnstore_policy/">add_columnstore_policy()</a>.

## Required arguments

Original file line number Diff line number Diff line change
@@ -29,7 +29,7 @@ ALTER TABLE <table_name> SET (timescaledb.compress,
);
```

<Deprecated2180 />
<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/alter_table/">ALTER TABLE (Hypercore)</a>.

## Required arguments

Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@ the chunk. An insert into a compressed chunk does not update the compressed
sizes. For more information about how to compute chunk sizes, see the
`chunks_detailed_size` section.

<Deprecated2180 />
<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/chunk_columnstore_stats/">chunk_columnstore_stats()</a>.

### Required arguments

Original file line number Diff line number Diff line change
@@ -29,7 +29,7 @@ You can get a list of chunks belonging to a hypertable using the
[`show_chunks` function](/api/latest/hypertable/show_chunks/).
</Highlight>

<Deprecated2180 />
<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/convert_to_columnstore/">convert_to_columnstore()</a>.

### Required arguments

Original file line number Diff line number Diff line change
@@ -23,7 +23,7 @@ turn the policy back on. The database automatically recompresses your chunks in
the next scheduled job.
</Highlight>

<Deprecated2180 />
<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/convert_to_cconvert_to_rowstore/">convert_to_rowstore()</a>.

### Required arguments

Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@ see the [hypertable section][hypertable-docs].
For more information about compression, see the
[compression sction][compression-docs].

<Deprecated2180 />
<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/hypertable_columnstore_stats/">hypertable_columnstore_stats()</a>.

### Required arguments

2 changes: 1 addition & 1 deletion api/compression.md → api/compression/index.md
Original file line number Diff line number Diff line change
@@ -31,7 +31,7 @@ Compressed chunks have the following limitations:
after constraint creation.
* [Timescale SkipScan][skipscan] does not currently work on compressed chunks.

<Deprecated2180 />
<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/">Hypercore</a>.

## Restrictions

Original file line number Diff line number Diff line change
@@ -43,7 +43,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>

<Deprecated2180 />
<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/convert_to_columnstore/">convert_to_columnstore()</a>.

## Required arguments

Original file line number Diff line number Diff line change
@@ -16,7 +16,7 @@ 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].

<Deprecated2180 />
<Deprecated2180 /> Replaced by <a href="https://docs.timescale.com/api/latest/hypercore/remove_columnstore_policy/">remove_columnstore_policy()</a>.

### Required arguments

199 changes: 99 additions & 100 deletions api/page-index/page-index.js
Original file line number Diff line number Diff line change
@@ -168,106 +168,6 @@ module.exports = [
},
],
},
{
title: "Distributed hypertables",
type: "directory",
href: "distributed-hypertables",
children: [
{
title: "create_distributed_hypertable",
href: "create_distributed_hypertable",
},
{
title: "add_data_node",
href: "add_data_node",
},
{
title: "attach_data_node",
href: "attach_data_node",
},
{
title: "alter_data_node",
href: "alter_data_node",
},
{
title: "detach_data_node",
href: "detach_data_node",
},
{
title: "delete_data_node",
href: "delete_data_node",
},
{
title: "distributed_exec",
href: "distributed_exec",
},
{
title: "set_number_partitions",
href: "set_number_partitions",
},
{
title: "set_replication_factor",
href: "set_replication_factor",
},
{
title: "copy_chunk",
href: "copy_chunk_experimental",
},
{
title: "move_chunk",
href: "move_chunk_experimental",
},
{
title: "cleanup_copy_chunk_operation",
href: "cleanup_copy_chunk_operation_experimental",
},
{
title: "create_distributed_restore_point",
href: "create_distributed_restore_point",
},
],
},
{
title: "Compression",
type: "directory",
href: "compression",
description:
"We highly recommend reading the blog post and tutorial about compression before trying to set it up for the first time.",
children: [
{
title: "ALTER TABLE (Compression)",
href: "alter_table_compression",
},
{
title: "add_compression_policy",
href: "add_compression_policy",
},
{
title: "remove_compression_policy",
href: "remove_compression_policy",
},
{
title: "compress_chunk",
href: "compress_chunk",
},
{
title: "decompress_chunk",
href: "decompress_chunk",
},
{
title: "recompress_chunk",
href: "recompress_chunk",
},
{
title: "hypertable_compression_stats",
href: "hypertable_compression_stats",
},
{
title: "chunk_compression_stats",
href: "chunk_compression_stats",
},
],
},
{
title: "Continuous aggregates",
type: "redirect-to-child-page",
@@ -659,6 +559,105 @@ module.exports = [
description:
"An overview of what different tags represent in the API section of Timescale Documentation.",
},
{
title: "Compression (deprecated)",
href: "compression",
description:
"We highly recommend reading the blog post and tutorial about compression before trying to set it up for the first time.",
children: [
{
title: "ALTER TABLE (Compression)",
href: "alter_table_compression",
},
{
title: "add_compression_policy",
href: "add_compression_policy",
},
{
title: "remove_compression_policy",
href: "remove_compression_policy",
},
{
title: "compress_chunk",
href: "compress_chunk",
},
{
title: "decompress_chunk",
href: "decompress_chunk",
},
{
title: "recompress_chunk",
href: "recompress_chunk",
},
{
title: "hypertable_compression_stats",
href: "hypertable_compression_stats",
},
{
title: "chunk_compression_stats",
href: "chunk_compression_stats",
},
],
},
{
title: "Distributed hypertables (deprecated)",
type: "directory",
href: "distributed-hypertables",
children: [
{
title: "create_distributed_hypertable",
href: "create_distributed_hypertable",
},
{
title: "add_data_node",
href: "add_data_node",
},
{
title: "attach_data_node",
href: "attach_data_node",
},
{
title: "alter_data_node",
href: "alter_data_node",
},
{
title: "detach_data_node",
href: "detach_data_node",
},
{
title: "delete_data_node",
href: "delete_data_node",
},
{
title: "distributed_exec",
href: "distributed_exec",
},
{
title: "set_number_partitions",
href: "set_number_partitions",
},
{
title: "set_replication_factor",
href: "set_replication_factor",
},
{
title: "copy_chunk",
href: "copy_chunk_experimental",
},
{
title: "move_chunk",
href: "move_chunk_experimental",
},
{
title: "cleanup_copy_chunk_operation",
href: "cleanup_copy_chunk_operation_experimental",
},
{
title: "create_distributed_restore_point",
href: "create_distributed_restore_point",
},
],
},
],
},
];
Loading