Updated docs #4
Merged
Updated docs #4
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
Collaborator
AdalbertMemSQL
commented
Nov 18, 2024
AdalbertMemSQL
commented
- mentioned that the connector is in the preview state
- added notes on how to avoid stale offset errors
pmishchenko-ua
approved these changes
Nov 19, 2024
docs/setup-guide.md
Outdated
| @@ -55,6 +55,20 @@ To authorize Fivetran to connect to your SinlgeStore database, follow these inst | |||
| SET enable_observe_queries=1 | |||
| ``` | |||
|
|
|||
| 4. (Optional) Configure `snapshots_to_keep` and `snapshot_trigger_size` engine variables. At some | |||
There was a problem hiding this comment.
Maybe add a link to SingleStore docs, if there is more information about these variables there?
There was a problem hiding this comment.
Can we have a one-line paragraph here?
UPDATE: The reason for this is that having deliberate line breaks makes Fivetran doc code (if we want to have identical doc code) non-uniform and makes it difficult to use regex for search and replace during doc updates.
docs/setup-guide.md
Outdated
| retrieve data associated with that logical point in the WAL (Write-Ahead Log). In practical | ||
| terms, `offsets` become stale once they are older than the oldest snapshot in the system. The | ||
| `snapshots_to_keep` and `snapshot_trigger_size` variables control the number and size of | ||
| snapshots, providing you with some control over the data retention window. If offsets become |
There was a problem hiding this comment.
I would elaborate "some control" a bit - e.g. if you increase snapshots_to_keep, offsets will become stale later.
docs/overview.md
Outdated
| @@ -12,6 +12,13 @@ transactional and analytical workloads with a unified engine. It provides real-t | |||
| transactions, and streaming capabilities, enabling users to handle diverse workloads on a single | |||
| platform. | |||
|
|
|||
| **Note:** this connector utilizes | |||
| SingleStore's [OBSERVE](https://docs.singlestore.com/cloud/reference/sql-reference/data-manipulation-language-dml/observe/) | |||
| queries which are currently in a preview state. As such, it is intended for experimental use only. | |||
There was a problem hiding this comment.
Suggested change
| queries which are currently in a preview state. As such, it is intended for experimental use only. |
| @@ -58,9 +65,8 @@ Fivetran adds the following columns to table in your destination: | |||
|
|
|||
| - `_fivetran_deleted` (BOOLEAN) marks deleted rows in the source database. | |||
| - `_fivetran_synced` (UTC TIMESTAMP) indicates when Fivetran last successfully synced the row. | |||
| - `_fivetran_index` (INTEGER) shows the order of updates for tables that do not have a primary key. | |||
| - `_fivetran_id` (STRING) is the hash of the non-Fivetran values of each row. It's a unique ID that | |||
| Fivetran uses to avoid duplicate rows in tables that do not have a primary key. | |||
There was a problem hiding this comment.
Are _fivetran_index and _fivetran_id deprecated/removed?
Co-authored-by: Alex Ilyichov <[email protected]>
Co-authored-by: Alex Ilyichov <[email protected]>
Co-authored-by: Alex Ilyichov <[email protected]>
Co-authored-by: Alex Ilyichov <[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.