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: Highlight view+index in debezium pages and lower prominence for Postg… #29150

Merged
merged 11 commits into from
Oct 3, 2024

Conversation

kay-kim
Copy link
Contributor

@kay-kim kay-kim commented Aug 21, 2024

…reSQL and MySQL kafka+deb pages

  • Highlight that indexes on views perform incremental updates
  • Moved PostgreSQL/MySQL kafka+deb pages to Appendix
    • Also, replaced the Mat View step with View + Index steps (single-sourced)
    • Created index pages for MySQL/ and PostgreSQL/ so that we have a place to point people to. These landing pages will be tweaked when I work on the frontmatter for the ingest-data section.

@kay-kim kay-kim requested a review from a team as a code owner August 21, 2024 15:55
identifier: "mysql-dbz"
---

{{< tip >}}
- As an alternative to using Kafka and Debezium, Materialize also provides
native support for MySQL.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Once we sort out our docs frontmatter so that there is a landing page under Ingest data/MySQL/, we can update this to link there.

identifier: "pg-dbz"
---

{{< tip >}}
- As an alternative to using Kafka and Debezium, Materialize also provides
native support for PostgreSQL.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Once we sort out our docs frontmatter so that there is a landing page under Ingest data/PostgreSQL/, we can update this to link there.

@kay-kim kay-kim changed the title Highlight view+index in debezium pages and lower prominence for Postg… docs: Highlight view+index in debezium pages and lower prominence for Postg… Aug 21, 2024
Materialize, [indexes](/concepts/indexes/) on a view maintain view results in
memory within a [cluster](/concepts/clusters/ "pools of compute resources (CPU,
memory, and scratch disk space)"). As the underlying data changes, indexes
**incrementally update** the view results in memory.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Once #29090 is merged, will also sprinkle some links to the usage patterns section in this page.

Copy link
Contributor

Choose a reason for hiding this comment

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

Can we make the changes to the dbt documentation in a separate PR?

@morsapaes
Copy link
Contributor

Not sure about this approach to de-emphasize Debezium. I was thinking we could either just leave it as is, but rephrase the introduction of each page to highlight that native connectors exist (mostly for scenarios where someone lands on the Kafka + Debezium page from a web search), or add a single "Using Kafka and Debezium" under /ingest-data/kafka. We also need to consider this page, which is linked from the Kafka source reference page.

---
title: "PostgreSQL"
description: "Connect and ingest data from PostgreSQL."
---
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Later on, may use a section template in the docs, but for this work, just using the regular single page template.

Copy link
Contributor

@morsapaes morsapaes left a comment

Choose a reason for hiding this comment

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

I have a local branch with more extensive changes that I'll incorporate your suggestion intos, in order to not butcher this PR.

@kay-kim
Copy link
Contributor Author

kay-kim commented Sep 16, 2024

Also, I can just close this PR (unless the work on that will take a while).

Copy link
Contributor

@morsapaes morsapaes left a comment

Choose a reason for hiding this comment

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

Sorry for the delay here, @kay-kim! Ended up pushing my local changes to your branch, along with some new stuff (like an overview page for both MySQL and PostgreSQL). Also tentatively removed Kafka + Debezium from the dropdowns for MySQL and PostgreSQL, since that could still leave room for confusion; let's just mention Debezium for databases that aren't natively supported, and in context in the Kafka source reference page.

Can you just remove the edits to the dbt page? We should handle that in a separate PR, since this one snowballed into something bigger than just replacing the use of materialized views with indexed views.

@kay-kim kay-kim merged commit ed60977 into MaterializeInc:main Oct 3, 2024
11 checks passed
@kay-kim kay-kim deleted the docs-debezium-tweaks branch October 3, 2024 15:01
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.

2 participants