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

docs: docs update for dozer replication #87

Merged
merged 20 commits into from
Feb 27, 2024
Merged

docs: docs update for dozer replication #87

merged 20 commits into from
Feb 27, 2024

Conversation

MrunmayS
Copy link
Contributor

@MrunmayS MrunmayS commented Feb 4, 2024

No description provided.

Copy link

github-actions bot commented Feb 4, 2024

docs/installation.mdx Outdated Show resolved Hide resolved
Copy link

github-actions bot commented Feb 5, 2024

Copy link

github-actions bot commented Feb 6, 2024

Copy link

github-actions bot commented Feb 6, 2024

Copy link

github-actions bot commented Feb 6, 2024

Copy link

github-actions bot commented Feb 7, 2024

@CLAassistant
Copy link

CLAassistant commented Feb 7, 2024

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

✅ MrunmayS
✅ v3g42
❌ aaryaattrey


aaryaattrey seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

github-actions bot commented Feb 7, 2024

Copy link

github-actions bot commented Feb 8, 2024

1 similar comment
Copy link

github-actions bot commented Feb 9, 2024

docs: removed aarch section in installtion
@MrunmayS MrunmayS force-pushed the mrunmay/docs-update branch from cd7c720 to fc4089a Compare February 9, 2024 07:06
Copy link

github-actions bot commented Feb 9, 2024

@MrunmayS MrunmayS marked this pull request as ready for review February 12, 2024 04:02
Copy link

docs/installation.mdx Outdated Show resolved Hide resolved
docs/installation.mdx Show resolved Hide resolved
docs/sinks/oracle.md Show resolved Hide resolved
docs/sinks/clickhouse.md Outdated Show resolved Hide resolved
docs/sinks/aerospike.md Outdated Show resolved Hide resolved
f.rental_rate
into actor_films
FROM actors a
JOIN film_actors fa ON a.actor_id = fa.actor_id
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We won't support stateful transforms anymore, so the example should not contain joins

docs/getting_started/core/connecting-to-sources.mdx Outdated Show resolved Hide resolved
MrunmayS and others added 3 commits February 13, 2024 10:46
Co-authored-by: Jesse <[email protected]>
Signed-off-by: Mrunmay Shelar <[email protected]>
Co-authored-by: Jesse <[email protected]>
Signed-off-by: Mrunmay Shelar <[email protected]>
Copy link

Copy link

Copy link

Copy link

| `from_set` | String | The set within the namespace for the source record. |
| `key` | String | The key to use to join the source and destination records. |
| `columns` | List | A list of columns to copy from the source record to the destination record. |
With denormalization, you can combine tables that were previously seperated. This can be useful when you have a table with a lot of reads and you want to avoid joins. In essence, it is like a left-join, so the below example is equivalent to the following SQL query:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we don't need to describe why you would use denormalization. If someone uses the product, they know whether they want to denormalize or not.

@@ -48,7 +48,7 @@ Dozer allows you to create destination tables in Clickhouse using custom setting
|--------------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `engine` | String | The table engine of the destination table. Default is `MergeTree` |
| `partition_by` | String | The partition key for the destination table. |
| `order_by` | List Of Strings | The sorting key. A tuple of column names or arbitrary expressions. By default, the sorting key is same as the `primary_key` if the primary key is not specified. |
| `order_by` | List Of Strings | The sorting key. A tuple of column names or arbitrary expressions. The key used to sort the data in the destination table. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is both The key used to sort the data in the destination table does not really say anything different than The sorting key.

Most of these parameters only apply to the MergeTree table engine, and I think it's better to just link to the clickhouse documentation for them.

@@ -7,8 +7,9 @@ description: Replicate data from your sources to Oracle Database.

### Configuration

To start, define a new connection to Oracle in your `dozer-config.yaml` file using the steps outlined [here](../sources/oracle.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Try using something more descriptive than here for your link. Tell the user where it's going to take them, like

using the steps outlined in the Oracle connection configuration section


The following configuration block can be used in `dozer-config.yaml` to define a new Oracle sink:
Thereby, the following configuration block can be added to define a new Oracle sink:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence doesn't really add any clarity. Try explaining that this sink configuration defines that it will replicate the table named transactions to the table by the same name in the oracle database defined in connections with the name oracle

@Jesse-Bakker Jesse-Bakker requested a review from v3g42 February 23, 2024 11:35
@v3g42 v3g42 merged commit 26e03a8 into main Feb 27, 2024
1 of 2 checks passed
@v3g42 v3g42 deleted the mrunmay/docs-update branch February 27, 2024 08:53
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants