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.

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

Checkpointing source-mssql #34182

Merged
merged 480 commits into from
Feb 8, 2024
Merged

Checkpointing source-mssql #34182

merged 480 commits into from
Feb 8, 2024

Conversation

rodireich
Copy link
Contributor

What

Describe what the change is solving
It helps to add screenshots if it affects the frontend.

How

Describe the solution

Recommended reading order

  1. x.java
  2. y.python

🚨 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 Vercel
Copy link

vercel bot commented Jan 11, 2024 •
edited
Loading

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

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
airbyte-docs ⬜️ Ignored (Inspect) Visit Preview Feb 8, 2024 10:46pm

This was referenced Jan 11, 2024
Open
Open
@octavia-squidington-iii octavia-squidington-iii added the area/connectors Connector related issues label Jan 11, 2024
This was referenced Jan 11, 2024
Open
Open
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 11, 2024 •
edited by rodireich
Loading

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • PR name follows PR naming conventions
  • Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • You've updated the connector's metadata.yaml file any other relevant changes, including a breakingChanges entry for major version bumps. See metadata.yaml docs
  • Secrets in the connector's spec are annotated with airbyte_secret
  • All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • Migration guide updated in docs/integrations/<source or destination>/<name>-migrations.md with an entry for the new version, if the version is a breaking change. See migration guide example
  • If set, you've ensured the icon is present in the platform-internal repo. (Docs)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

This was referenced Jan 11, 2024
Open
Open
@rodireich Graphite App
Copy link
Contributor Author

rodireich commented Jan 11, 2024 •
edited
Loading

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @rodireich and the rest of your teammates on Graphite Graphite

@octavia-squidington-iii octavia-squidington-iii added the CDK Connector Development Kit label Jan 11, 2024
@rodireich rodireich force-pushed the 01-11-Testing branch 2 times, most recently from 766f928 to d41a355 Compare January 16, 2024 05:07
@rodireich rodireich force-pushed the 01-11-Testing branch 2 times, most recently from b6b030d to 9f3d196 Compare January 17, 2024 19:09
@rodireich rodireich marked this pull request as ready for review January 18, 2024 16:58
@rodireich rodireich requested a review from a team as a January 18, 2024 16:58
@octavia-squidington-iv octavia-squidington-iv requested a review from a team January 18, 2024 16:59
@rodireich rodireich force-pushed the 01-11-Testing branch 2 times, most recently from cb348fb to ca59414 Compare January 19, 2024 06:16
@rodireich
Copy link
Contributor Author

rodireich commented Feb 8, 2024 •
edited by github-actions bot
Loading

/publish-java-cdk dry-run=true

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

@rodireich
Copy link
Contributor Author

rodireich commented Feb 8, 2024 •
edited by github-actions bot
Loading

/publish-java-cdk

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

@edgao
Copy link
Contributor

edgao commented Feb 8, 2024

@rodireich - can you hold off on merging this pr for a little bit? @subodh1810 published cdk 0.17.1 here

postamar
postamar reviewed Feb 8, 2024
View reviewed changes
Copy link
Contributor

@postamar postamar left a comment

Choose a reason for hiding this comment

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

No major complaints!

...nectors/source-mssql/src/main/java/io/airbyte/integrations/source/mssql/MssqlQueryUtils.java
returnValue = bytes.longValue();
}
return returnValue;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Surely there is something in apache-commons or somewhere which already does this.

Copy link
Contributor Author

@rodireich rodireich Feb 8, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I looked for and couldn't find.
Implementation will have the other way around typically
byte size to human readable:
FileUtils.byteCountToDisplaySize for example

...nectors/source-mssql/src/main/java/io/airbyte/integrations/source/mssql/MssqlQueryUtils.java Outdated
resultSet -> JdbcUtils.getDefaultSourceOperations().rowToJson(resultSet));
if (jsonNodes != null) {
jsonNodes.stream().map(node -> Jsons.convertValue(node, Index.class))
.forEach(i -> LOGGER.info(String.valueOf(i)));
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: can we add a prefix here like "Index lookup query result: {}"

also can we please stick to regular for-loops in case the Streams API isn't obviously obviously a better choice?

...nectors/source-mssql/src/main/java/io/airbyte/integrations/source/mssql/MssqlQueryUtils.java
jsonNodes.stream().map(node -> Jsons.convertValue(node, Index.class))
.forEach(i -> LOGGER.info(String.valueOf(i)));
}
} catch (final Exception ex) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we really want to catch all exceptions here? Especially considering we're just silently swallowing them? Is the final keyword really useful here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Since this is informational log I never want it to stop the sync.
There are some variations that are not known - all sorts of hosted and managed and serverless db services won't let you look under the hood.
In the past we ended up adding this to equivalent pre sync logs - getting the version and engine of mysql for example.
Not sure what you meant with final

...nectors/source-mssql/src/main/java/io/airbyte/integrations/source/mssql/MssqlQueryUtils.java

}

public static String getMaxOcValueForStream(final JdbcDatabase database,
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it be worth returning an Optional<String> value instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This max value is a must to be able to upper bound our sync - so failing to retrieve it should error out.

...nectors/source-mssql/src/main/java/io/airbyte/integrations/source/mssql/MssqlQueryUtils.java Outdated
return String.join(", ", columnNames.stream()
.map(
el -> hierarchyIdColumns.contains(el) ? String
.format("%s.ToString() as %s%s%s", el, identifierQuoteString, el, identifierQuoteString)
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: String and .format on same line please

@rodireich
Copy link
Contributor Author

No problem @edgao
I already sent for publishing cdk v0.18
not sure whose got in first

@subodh1810
Copy link
Contributor

@rodireich I think you will have to republish the CDK after pulling in my changes! I merged the PR so you can pull in master and re-publish

@rodireich
Copy link
Contributor Author

rodireich commented Feb 8, 2024 •
edited by github-actions bot
Loading

/publish-java-cdk force=true

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

@evantahler
Copy link
Contributor

/approve-and-merge reason="unpublished source-mssql merge until we fix CI testing"

@octavia-approvington
Copy link
Contributor

Lets merge it
sheep thumbs up

@octavia-approvington octavia-approvington merged commit c8d5927 into master Feb 8, 2024
21 of 23 checks passed
@octavia-approvington octavia-approvington deleted the 01-11-Testing branch February 8, 2024 23:20
@postamar postamar mentioned this pull request Feb 9, 2024
Closed
xiaohansong added a commit that referenced this pull request Feb 13, 2024
@rodireich @xiaohansong @postamar
Checkpointing source-mssql (#34182)
d0176aa 
Co-authored-by: nguyenaiden <duy@airbyte.io>
Co-authored-by: Xiaohan Song <xiaohan@airbyte.io>
Co-authored-by: Marius Posta <marius@airbyte.io>
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 21, 2024
@rodireich @xiaohansong
@postamar @jatinyadav-cc
Checkpointing source-mssql (airbytehq#34182)
aaacfe6 
Co-authored-by: nguyenaiden <duy@airbyte.io>
Co-authored-by: Xiaohan Song <xiaohan@airbyte.io>
Co-authored-by: Marius Posta <marius@airbyte.io>
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024
@rodireich @xiaohansong
@postamar @jatinyadav-cc
Checkpointing source-mssql (airbytehq#34182)
d6f96fc 
Co-authored-by: nguyenaiden <duy@airbyte.io>
Co-authored-by: Xiaohan Song <xiaohan@airbyte.io>
Co-authored-by: Marius Posta <marius@airbyte.io>
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024
@rodireich @xiaohansong
@postamar @jatinyadav-cc
Checkpointing source-mssql (airbytehq#34182)
18be2ea 
Co-authored-by: nguyenaiden <duy@airbyte.io>
Co-authored-by: Xiaohan Song <xiaohan@airbyte.io>
Co-authored-by: Marius Posta <marius@airbyte.io>
xiaohansong added a commit that referenced this pull request Feb 27, 2024
@rodireich @xiaohansong @postamar
Checkpointing source-mssql (#34182)
66aa35b 
Co-authored-by: nguyenaiden <duy@airbyte.io>
Co-authored-by: Xiaohan Song <xiaohan@airbyte.io>
Co-authored-by: Marius Posta <marius@airbyte.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xiaohansong xiaohansong xiaohansong left review comments

@postamar postamar postamar left review comments

@octavia-approvington octavia-approvington octavia-approvington approved these changes

@akashkulk akashkulk akashkulk approved these changes

@lazebnyi lazebnyi lazebnyi approved these changes

Assignees
No one assigned
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation CDK Connector Development Kit connectors/destination/postgres connectors/destination/postgres-strict-encrypt connectors/destination/redshift connectors/source/google-analytics-v4 connectors/source/google-sheets connectors/source/mongodb-v2 connectors/source/mssql connectors/source/mysql connectors/source/sftp connectors/source/stripe
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
10 participants
@rodireich @edgao @subodh1810 @evantahler @octavia-approvington @postamar @xiaohansong @lazebnyi @akashkulk @octavia-squidington-iii