Skip to content

DOCS: Improve Documentation on Write Support #1008

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

Open
sungwy opened this issue Aug 6, 2024 · 5 comments
Open

DOCS: Improve Documentation on Write Support #1008

sungwy opened this issue Aug 6, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@sungwy
Copy link
Collaborator

sungwy commented Aug 6, 2024

Feature Request / Improvement

We currently have Write support through two modes:

  1. through the Table API
  2. through the Transaction API

We also have support for different modes of writes like:

  1. append
  2. overwrite
  3. delete

Which make use of different arg parameters.

It would be great to update our docs to describe each of these operations and API modes explicitly in detail as separate subsections, and pad in any missing details (like the use of overwrite_filter in overwrite)

@sungwy sungwy added good first issue Good for newcomers documentation Improvements or additions to documentation labels Aug 6, 2024
@guitcastro
Copy link
Contributor

@sungwy When using overwrite how can we compare fields between source and target? like:

  source.id = target.id and source.updated < target.updated

@kevinjqliu
Copy link
Contributor

someone asked about merge/upserts use cases in the slack channel as well, similar to overwrite_filter

@kevinjqliu
Copy link
Contributor

@iamvyshnavi
Copy link

Hi, I am new to open source and would love to contribute to this issue. Can I work on this?

@shrutisachan08
Copy link

Hii, I would like to work on this. I can update documentation by adding separate subsections for each write mode(append, overwrite, delete). I can insert some examples like including about overwrite_filter usage. Please let me know if there are any formatting details you would like me to include. Please assign me this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants