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

Add the installation and configuration documentation for the Huawei GaussDB and GaussDB(DWS) adapter dbt-gaussdbdws #6619

Open
wants to merge 4 commits into
base: current
Choose a base branch
from

Conversation

pangpang20
Copy link

…aussDB and GaussDB(DWS) adapter dbt-gaussdbdws

What are you changing in this pull request and why?

I have developed a plugin called dbt-gaussdbdws to adapt Huawei GaussDB and GaussDB (DWS). This plugin is designed to provide native support for GaussDB and GaussDB (DWS) databases in dbt, enabling users to easily perform data modeling and management tasks on these databases. The plugin includes the following features:

Support for GaussDB and GaussDB (DWS) database features, such as materialized views and index creation.
Implementation of incremental data processing strategies (e.g., append, merge, delete+insert).
Query and index optimizations to enhance database performance.
The plugin is available on GitHub at https://github.com/pangpang20/dbt-gaussdbdws.git, and I hope it will provide more options for dbt users.

Checklist

  • [ x ] I have reviewed the Content style guide so my content adheres to these guidelines.
  • [ x ] The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the version a whole page and/or version a block of content guidelines.
  • [ x ] I have added checklist item(s) to this list for anything anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."
  • [ x ] The content in this PR requires a dbt release note, so I added one to the release notes page.

…aussDB and GaussDB(DWS) adapter dbt-gaussdbdws
@pangpang20 pangpang20 requested review from dataders and a team as code owners December 9, 2024 12:55
Copy link

welcome bot commented Dec 9, 2024

Hello!👋 Thanks for contributing to the dbt product documentation and opening this pull request! ✨
We use Markdown and some HTML to write the dbt product documentation. When writing content, you can use our style guide and content types to understand our writing standards and how we organize information in the dbt product docs.
We'll review your contribution and respond as soon as we can. 😄

Copy link

vercel bot commented Dec 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Dec 9, 2024 0:57am

Copy link

vercel bot commented Dec 9, 2024

@pangpang20 is attempting to deploy a commit to the dbt-labs Team on Vercel.

A member of the Team first needs to authorize it.

@runleonarun runleonarun added the new contributor Label for first-time contributors label Dec 9, 2024
@github-actions github-actions bot added content Improvements or additions to content size: large This change will more than a week to address and might require more than one person labels Dec 9, 2024
Copy link
Collaborator

@amychen1776 amychen1776 left a comment

Choose a reason for hiding this comment

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

I think you're missing adding yourself to the community supported adapters table so it's a little hard to find the preview https://docs.getdbt.com/docs/community-adapters

description: "Read this guide to learn about the Gaussdb(DWS) warehouse setup in dbt."
id: "gaussdbdws-setup"
meta:
maintained_by: dbt Labs
Copy link
Collaborator

Choose a reason for hiding this comment

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

please update this - this should be changed over to you

id: "gaussdbdws-setup"
meta:
maintained_by: dbt Labs
authors: 'core dbt maintainers'
Copy link
Collaborator

Choose a reason for hiding this comment

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

not true anymore

meta:
maintained_by: dbt Labs
authors: 'core dbt maintainers'
github_repo: 'n/a'
Copy link
Collaborator

Choose a reason for hiding this comment

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

can you link to the github repo?

authors: 'core dbt maintainers'
github_repo: 'n/a'
pypi_package: 'dbt-gaussdbdws'
min_core_version: 'v0.4.0'
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm pretty sure this is incorrect. What is the earliest version you support?

pypi_package: 'dbt-gaussdbdws'
min_core_version: 'v0.4.0'
cloud_support: Not supported
min_supported_version: 'n/a'
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are there versions of GaussDB that are not supported?

dbname: [database name] # or database instead of dbname
schema: [dbt schema]
threads: [optional, 1 or more]
[keepalives_idle](#keepalives_idle): 0 # default 0, indicating the system default. See below
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
[keepalives_idle](#keepalives_idle): 0 # default 0, indicating the system default. See below
keepalives_idle: 0 # default 0, indicating the system default. See below

threads: [optional, 1 or more]
[keepalives_idle](#keepalives_idle): 0 # default 0, indicating the system default. See below
connect_timeout: 10 # default 10 seconds
[retries](#retries): 1 # default 1 retry on error/timeout when opening connections
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
[retries](#retries): 1 # default 1 retry on error/timeout when opening connections
retries: 1 # default 1 retry on error/timeout when opening connections

Copy link
Collaborator

Choose a reason for hiding this comment

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

Could you please take a look at your profiles.yml sample file? I think your fields are coming out a bit funny here. Thank you!

Copy link
Author

Choose a reason for hiding this comment

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

like this:
jaffle_shop:
target: dev_dws
outputs:
dev_dws:
type: gaussdbdws
host: 121.xxx.xxx.199
user: xxx
password: xxx@123
port: 8000
dbname: gaussdb
schema: xxx
threads: 1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content new contributor Label for first-time contributors size: large This change will more than a week to address and might require more than one person
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants