Add count in state message for incremental syncs #33005

xiaohansong · 2023-11-30T23:25:47Z

What

Previous merged PR #33312 will only send counts in initial syncs. To send counts in follow up incremental syncs we need this PR to be merged in

How

Base class will have counts stat added into state message; and those base classes will be inherited by MySQL incremental iterator.

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user?

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Actions

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

Community member? Grant edit access to maintainers (instructions)
Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
Connector version is set to 0.0.1
- Dockerfile has version 0.0.1
Documentation updated
- Connector's README.md
- Connector's bootstrap.md. See description and examples
- docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. See changelog example
- docs/integrations/README.md

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.

Updating a connector

Community member or Airbyter

Grant edit access to maintainers (instructions)
Unit & integration tests added

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.

Connector Generator

Issue acceptance criteria met
PR name follows PR naming conventions
If adding a new generator, add it to the list of scaffold modules being tested
The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:generateScaffolds then checking in your changes
Documentation which references the generator is updated as needed

Updating the Python CDK

Airbyter

Before merging:

Pull Request description explains what problem it is solving
Code change is unit tested
Build and my-py check pass
Smoke test the change on at least one affected connector
- On Github: Run this workflow, passing --use-local-cdk --name=source-<connector> as options
- Locally: airbyte-ci connectors --use-local-cdk --name=source-<connector> test
PR is reviewed and approved

After merging:

Publish the CDK
- The CDK does not follow proper semantic versioning. Choose minor if this the change has significant user impact or is a breaking change. Choose patch otherwise.
- Write a thoughtful changelog message so we know what was updated.
Merge the platform PR that was auto-created for updating the Connector Builder's CDK version
- This step is optional if the change does not affect the connector builder or declarative connectors.

vercel · 2023-11-30T23:25:52Z

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

Name	Status	Preview	Comments	Updated (UTC)
airbyte-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 10, 2024 0:50am

...yte-cdk/airbyte-commons/src/main/java/io/airbyte/commons/version/AirbyteProtocolVersion.java

...ain/java/io/airbyte/cdk/integrations/debezium/internals/DebeziumStateDecoratingIterator.java

...-sources/src/main/java/io/airbyte/cdk/integrations/source/relationaldb/AbstractDbSource.java

akashkulk · 2023-12-05T18:23:26Z

...s/src/main/java/io/airbyte/cdk/integrations/source/relationaldb/StateDecoratingIterator.java

-          cursorInfo.map(CursorInfo::getCursor).orElse(null),
-          cursorInfo.map(CursorInfo::getCursorRecordCount).orElse(null));
-    }
+    LOGGER.info("State report for stream {} - original: {} = {} (count {}) -> latest: {} = {} (count {})",


probably want to keep the reduced verbosity

can we still keep the reduced verbosity?

sorry missed this one before. fixed.

...s/src/main/java/io/airbyte/cdk/integrations/source/relationaldb/StateDecoratingIterator.java

akashkulk · 2024-01-09T22:04:52Z

...ain/java/io/airbyte/cdk/integrations/debezium/internals/DebeziumStateDecoratingIterator.java

    if (trackSchemaHistory && schemaHistoryManager == null) {
      throw new RuntimeException("Schema History Tracking is true but manager is not initialised");
    }
    if (offsetManager == null) {
      throw new RuntimeException("Offset can not be null");
    }

-    return cdcStateHandler.saveState(offset, schemaHistoryManager != null ? schemaHistoryManager.read() : null);
+    final AirbyteMessage message = cdcStateHandler.saveState(offset, schemaHistoryManager != null ? schemaHistoryManager.read() : null);
+    message.getState().withSourceStats(new AirbyteStateStats().withRecordCount((double) recordCount));


curious why is recordCount a double? seems like it can only be an integer

protocol defined this as a "number" in Json, which translated to double value in java thus here comes casting.

akashkulk

Small nits

xiaohansong · 2024-01-09T23:30:22Z

/publish-java-cdk

xiaohansong · 2024-01-09T23:32:12Z

/publish-java-cdk

🕑 https://github.com/airbytehq/airbyte/actions/runs/7468173202
✅ Successfully published Java CDK version=0.11.4!

Co-authored-by: xiaohansong <xiaohansong@users.noreply.github.com>

draft

e197071

octavia-squidington-iii added the CDK Connector Development Kit label Nov 30, 2023

sample of initial iterator

a76a8dc

octavia-squidington-iii added area/connectors Connector related issues connectors/source/mysql connectors/source/postgres labels Nov 30, 2023

xiaohansong and others added 4 commits December 4, 2023 10:45

save work

0fed139

Merge remote-tracking branch 'origin/master' into xiaohan/state

0c2381d

save work

4bb1c50

Automated Commit - Formatting Changes

7e308c3

akashkulk reviewed Dec 5, 2023

View reviewed changes

...yte-cdk/airbyte-commons/src/main/java/io/airbyte/commons/version/AirbyteProtocolVersion.java Outdated Show resolved Hide resolved

akashkulk reviewed Dec 5, 2023

View reviewed changes

...ain/java/io/airbyte/cdk/integrations/debezium/internals/DebeziumStateDecoratingIterator.java Show resolved Hide resolved

akashkulk reviewed Dec 5, 2023

View reviewed changes

...-sources/src/main/java/io/airbyte/cdk/integrations/source/relationaldb/AbstractDbSource.java Outdated Show resolved Hide resolved

akashkulk reviewed Dec 5, 2023

View reviewed changes

...s/src/main/java/io/airbyte/cdk/integrations/source/relationaldb/StateDecoratingIterator.java Outdated Show resolved Hide resolved

Merge remote-tracking branch 'origin/master' into xiaohan/state

6c6a1f9

vercel bot deployed to Preview January 9, 2024 17:12 View deployment

xiaohansong added 2 commits January 9, 2024 09:33

save work

39c9fdc

add tests

63774d9

xiaohansong changed the title ~~[draft] Add count in state message~~ Add count in state message for incremental syncs Jan 9, 2024

xiaohansong marked this pull request as ready for review January 9, 2024 18:40

xiaohansong requested a review from a team as a code owner January 9, 2024 18:40

xiaohansong added 4 commits January 9, 2024 10:41

revert unrelated change

09c54db

add test for state decorating iterator

982c8d9

format

3490db1

fix test

0c625a0

xiaohansong requested a review from akashkulk January 9, 2024 19:48

akashkulk reviewed Jan 9, 2024

View reviewed changes

akashkulk requested changes Jan 9, 2024

View reviewed changes

fix logging

e3f37f6

xiaohansong requested a review from akashkulk January 9, 2024 22:29

akashkulk approved these changes Jan 9, 2024

View reviewed changes

cdk version

346f190

Merge remote-tracking branch 'origin/master' into xiaohan/state

e084dc0

vercel bot deployed to Preview January 9, 2024 23:33 View deployment

xiaohansong added 2 commits January 9, 2024 15:33

version bump

ab2624b

add comment

61660cd

octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Jan 10, 2024

vercel bot deployed to Preview January 10, 2024 00:50 View deployment

xiaohansong enabled auto-merge (squash) January 10, 2024 01:05

xiaohansong merged commit b290208 into master Jan 10, 2024
25 checks passed

xiaohansong deleted the xiaohan/state branch January 10, 2024 01:05

jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024

Add count in state message for incremental syncs (airbytehq#33005)

1ee70aa

Co-authored-by: xiaohansong <xiaohansong@users.noreply.github.com>

jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024

Add count in state message for incremental syncs (airbytehq#33005)

58d052d

Co-authored-by: xiaohansong <xiaohansong@users.noreply.github.com>

jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024

Add count in state message for incremental syncs (airbytehq#33005)

f2772a2

Co-authored-by: xiaohansong <xiaohansong@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add count in state message for incremental syncs #33005

Add count in state message for incremental syncs #33005

xiaohansong commented Nov 30, 2023 •

edited

Loading

vercel bot commented Nov 30, 2023 •

edited

Loading

akashkulk Dec 5, 2023

akashkulk Jan 9, 2024

xiaohansong Jan 9, 2024

akashkulk Jan 9, 2024

xiaohansong Jan 9, 2024

akashkulk left a comment

xiaohansong commented Jan 9, 2024

xiaohansong commented Jan 9, 2024 •

edited by github-actions bot

Loading

Add count in state message for incremental syncs #33005

Add count in state message for incremental syncs #33005

Conversation

xiaohansong commented Nov 30, 2023 • edited Loading

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Actions

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Airbyter

vercel bot commented Nov 30, 2023 • edited Loading

akashkulk Dec 5, 2023

Choose a reason for hiding this comment

akashkulk Jan 9, 2024

Choose a reason for hiding this comment

xiaohansong Jan 9, 2024

Choose a reason for hiding this comment

akashkulk Jan 9, 2024

Choose a reason for hiding this comment

xiaohansong Jan 9, 2024

Choose a reason for hiding this comment

akashkulk left a comment

Choose a reason for hiding this comment

xiaohansong commented Jan 9, 2024

xiaohansong commented Jan 9, 2024 • edited by github-actions bot Loading

xiaohansong commented Nov 30, 2023 •

edited

Loading

vercel bot commented Nov 30, 2023 •

edited

Loading

xiaohansong commented Jan 9, 2024 •

edited by github-actions bot

Loading