WIP: Iceberg Integration documentation #5918
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jstirnaman
requested changes
Mar 19, 2025
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
|
Thank you for the suggestions and help! I should probably go slower and triple check that I am using the Google developers documentation style guide. @jstirnaman |
MeelahMe
added
Feature-WIP
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Ideally, Vale should be catching violations as well, but I think we're missing some config for the newer directories.
|
jstirnaman
requested changes
Mar 20, 2025
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
sanderson
requested changes
Mar 21, 2025
Comment on lines
+153
to
+161
| #### Example: Enable Iceberg feature and export a snapshot | ||
|
|
||
| ```sh | ||
| # Enable Iceberg feature | ||
| $ influxctl enable-iceberg | ||
|
|
||
| # Export a snapshot | ||
| $ influxctl export --namespace foo --table bar | ||
| ``` |
There was a problem hiding this comment.
This commands should be used in the process above, not influxdb_iox
Comment on lines
+163
to
+190
| ### Use the API to manage and configure snapshots | ||
|
|
||
| Use the {{% product-name %}} HTTP API to export snapshots and check status. | ||
|
|
||
| #### Example: Export a snapshot | ||
|
|
||
| This example demonstrates how to export a snapshot of your data from InfluxDB to an Iceberg table using the HTTP API. | ||
|
|
||
| - **Method**: `POST` | ||
| - **Endpoint**: `/snapshots/export` | ||
| - **Request body**: | ||
|
|
||
| ```json | ||
| { | ||
| "namespace": "foo", | ||
| "table": "bar" | ||
| } | ||
| ``` | ||
| The `POST` request to the `/snapshots/export` endpoint triggers the export of data from the specified namespace and table in InfluxDB to an Iceberg table. The request body specifies the namespace (`foo`) and the table (`bar`) to be exported. | ||
|
|
||
| #### Example: Check snapshot status | ||
|
|
||
| This example shows how to check the status of an ongoing or completed snapshot export using the HTTP API. | ||
|
|
||
| - **Method**: `GET` | ||
| - **Endpoint**: `/snapshots/status` | ||
|
|
||
| The `GET` request to the `/snapshots/status` endpoint retrieves the status of the snapshot export. This can be used to monitor the progress of the export or verify its completion. |
There was a problem hiding this comment.
I think we should use tabs above and explain how to do each of these via CLI and API in the actual process flow rather than down at the bottom.
Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Scott Anderson <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding documentation for Iceberg Integration with Snowflake.