+
Skip to content

DMS: Fix primary key / where clause rendering #114

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 21, 2025
Merged

DMS: Fix primary key / where clause rendering #114

merged 1 commit into from
Jun 21, 2025

Conversation

amotl
Copy link
Member

@amotl amotl commented Jun 21, 2025 •
edited
Loading

About

A few more fixes about processing CDC events from DMS/Kinesis regarding the "universal" column mapping paradigm.

References

@amotl amotl requested review from hammerhead and zolbatar June 21, 2025 12:36
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jun 21, 2025 •
edited
Loading

Walkthrough

The changes update the SQL generation logic for AWS DMS event translation to CrateDB, specifically revising how primary key columns and WHERE clauses are rendered. Tests and documentation are updated to align with the new approach, ensuring primary keys are handled as a separate pk object and referenced accordingly in generated SQL statements.

Changes

File(s) Change Summary
CHANGES.md Updated changelog to note the fix for primary key and WHERE clause rendering in DMS SQL generation.
src/commons_codec/transform/aws_dms.py Refactored SQL generation: primary key is now a distinct pk OBJECT(STRICT) column and WHERE clauses use pk.
tests/transform/test_aws_dms.py Adjusted tests to expect pk object usage for primary key columns and WHERE clauses in generated SQL statements.

Sequence Diagram(s)

sequenceDiagram
    participant DMS_Translator as DMSTranslatorCrateDBRecord
    participant CrateDB as CrateDB

    DMS_Translator->DMS_Translator: to_sql()
    DMS_Translator->DMS_Translator: pk_clause()
    DMS_Translator->DMS_Translator: keys_to_where()
    DMS_Translator->CrateDB: Generate SQL (CREATE/UPDATE/DELETE) with pk OBJECT(STRICT) and WHERE pk['id']=?
    CrateDB-->>DMS_Translator: SQL execution result
Loading

Possibly related PRs

  • DMS: Fix handling of primary keys #104: Refines and corrects the SQL generation for primary keys and WHERE clauses in the same class and methods, directly building upon and adjusting the primary key handling logic established there.

Suggested reviewers

  • hammerhead
  • surister

Poem

In fields of SQL, the rabbits hop,
Tweaking keys so queries won't stop.
Now pk stands proud, no longer shy,
WHERE clauses point with a keen rabbit eye.
With tests in tow and syntax neat,
This patch ensures our data's fleet! 🐇

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2d5f87d and 0fd8924.

📒 Files selected for processing (3)
  • CHANGES.md (1 hunks)
  • src/commons_codec/transform/aws_dms.py (3 hunks)
  • tests/transform/test_aws_dms.py (3 hunks)
🔇 Additional comments (7)
src/commons_codec/transform/aws_dms.py (3)

95-95: LGTM: Cleaner SQL structure with separated column declaration.

The separation of pk OBJECT(STRICT) column declaration from the AS clause improves SQL readability and prevents duplication of the column type in the pk_clause() method.

154-154: LGTM: Consistent with the CREATE TABLE change.

The pk_clause() method now correctly returns only the AS clause part, which works well with the separated column declaration approach in the CREATE TABLE statement.

232-233: LGTM: Logical improvement with defensive programming.

The changes make logical sense:

  1. Adding the null check prevents invalid WHERE conditions with null values
  2. Referencing pk column instead of data column is correct since primary keys are stored in the dedicated pk column

This ensures WHERE clauses only include valid primary key conditions.

tests/transform/test_aws_dms.py (3)

244-245: LGTM: Test correctly updated to match implementation.

The test expectation now includes the explicit pk OBJECT(STRICT) column declaration, which aligns with the separated column declaration approach in the implementation.

287-287: LGTM: WHERE clause test properly updated.

The test now expects pk['id']=:id instead of data['id']=:id, which is consistent with the implementation change to reference primary keys from the dedicated pk column.

314-314: LGTM: DELETE WHERE clause test properly updated.

The test expectation correctly uses pk['id']=:id to match the implementation's change to reference primary keys from the pk column instead of the data column.

CHANGES.md (1)

9-9: LGTM: Clear and accurate changelog entry.

The changelog entry appropriately documents this fix, providing users with visibility into the primary key and WHERE clause rendering improvements.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch dms-improvements

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@amotl amotl requested a review from surister June 21, 2025 12:58
@amotl amotl marked this pull request as ready for review June 21, 2025 12:58
@amotl amotl merged commit 076fca7 into main Jun 21, 2025
22 checks passed
@amotl amotl deleted the dms-improvements branch June 21, 2025 12:58
@coderabbitai coderabbitai bot mentioned this pull request Jun 29, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hammerhead hammerhead Awaiting requested review from hammerhead

@zolbatar zolbatar Awaiting requested review from zolbatar

@surister surister Awaiting requested review from surister

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@amotl
点击 这是indexloc提供的php浏览器服务，不要输入任何密码和下载