✨Use base64 to encode mssql binary field by xiaohansong · Pull Request #33755 · airbytehq/airbyte

Xiaohan Song (xiaohansong) · 2023-12-22T19:39:27Z

What

#19337

Since airbyte transport everything in Json, binary was converted into String using default char set - thus for many cases they are not converted into a human readable string and cause confusion. Currently we did not specify how airbyte is going to handle binary in our official doc; so I propose we encode that in base64.

Slack discussion: https://airbytehq-team.slack.com/archives/C03C4AVJWG4/p1700173565688209

Result:
before:


2023-12-22 00:03:54 INFO i.a.w.g.BufferedReplicationWorker(writeToDestination):424 - writeToDestination: done. (forDest.isDone:true, isDestRunning:true)
2023-12-22 00:03:54 destination > INFO i.a.i.d.e.l.FirstNLogger(log):27 [2023-12-22T00:03:50.862Z] NewTable #0001: {"id":"2","bin":"\u0003\u0001Ȋ��\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000"}
2023-12-22 00:03:54 destination > INFO i.a.i.d.e.l.FirstNLogger(log):27 [2023-12-22T00:03:50.862Z] NewTable #0002: {"id":"12","bin":" 3\u0001Ȋ��\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000"}

===
after:


2023-12-22 19:34:29 destination > INFO i.a.i.d.e.l.FirstNLogger(log):27 [2023-12-22T19:34:24.674Z] NewTable #0001: {"id":"2","bin":"AwHIit3vAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=="}
2023-12-22 19:34:29 destination > INFO i.a.i.d.e.l.FirstNLogger(log):27 [2023-12-22T19:34:24.674Z] NewTable #0002: {"id":"12","bin":"IDMByIrd7wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=="}

How

Describe the solution

🚨 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-12-22T19:39:34Z

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		Jan 4, 2024 0:02am

github-actions · 2023-12-22T19:39:42Z

Warning

🚨 Connector code freeze is in effect until 2024-01-02. This PR is changing connector code. Please contact the current OC engineers if you want to merge this change to master.

github-actions · 2023-12-22T19:39:53Z

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,

Check for hidden checklists in your PR description
Toggle the github label checklist-action-run on/off to re-run the checklist CI.

Rodi Reich Zilberman (rodireich)

This looks good.
But how is it helping with the mentioned issue of 6GB updates failing?

Rodi Reich Zilberman (rodireich) · 2023-12-22T19:43:57Z

      throws SQLException {
    final byte[] bytes = resultSet.getBytes(index);
-    final String value = new String(bytes, Charset.defaultCharset());
+    final String value = Base64.encodeBase64String(bytes);


this I think is in line with what we do in other java connectors 👍

You can add a test also for binary type

Does that mean that a binary field in the source database is encoded as a AirbyteType String? Is that something that was discussed, or just how it was implemented for simplicity reasons?

the current behavior for binary column is undefined in our public doc (and see slack discussion with destination team here https://airbytehq-team.slack.com/archives/C03C4AVJWG4/p1700173565688209), it sounds like base64 is the direction we are heading to; so yes mostly for simplicity reason.

Xiaohan Song (xiaohansong) · 2023-12-22T19:56:01Z

Rodi Reich Zilberman (@rodireich) Apologize! I linked the wrong ticket. This is the one. Updated #19337

Xiaohan Song (xiaohansong) · 2023-12-26T18:32:12Z

I'll have to update version after code freeze to avoid any confliction!

Rodi Reich Zilberman (rodireich)

Change looks good.
I just wanted to understand for myself if mssql is different from mysql and postgres where I think we're doing specific type conversions.

Vadym S (sukolenvo) · 2024-04-17T08:11:01Z

I fully support this change (this solves other issue that we had: #30856). But from my POV this is a breaking change? My view of the situation:
For sample byte array [0x68, 0x65, 0x6c, 0x6c, 0x6f]
Previously message json was:

{
  "my-byte-array": "hello"
}

In destination connector we were using json.get("my-byte-array").getBytes() to get original byte array.

Now json is

{
  "my-byte-array": "aGVsbG8="
}

same destination connector would save array [0x61, 0x46, 0x56, 0x73, 0x62, 0x47, 0x38, 0x3d, 0x0a].

So necessary steps for upgrade are:

stop source connector;
let destination drain queue;
deploy new destination connector that decodes using Base64.decode() instead of String.getBytes();
update source connector to new version.

Which is non-trivial upgrade process typically expected for patch. Am I missing something?

use base64 to encode binary

d2dc792

Xiaohan Song (xiaohansong) requested a review from a team as a code owner December 22, 2023 19:39

Xiaohan Song (xiaohansong) requested a review from Rodi Reich Zilberman (rodireich) December 22, 2023 19:39

Octavia Squidington III (octavia-squidington-iii) added the area/connectors Connector related issues label Dec 22, 2023

Octavia Squidington III (octavia-squidington-iii) added the connectors/source/mssql label Dec 22, 2023

Rodi Reich Zilberman (rodireich) reviewed Dec 22, 2023

View reviewed changes

fix test

4176fa7

Xiaohan Song added 6 commits December 26, 2023 10:47

format fix

b234935

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

1d9a76a

bump version up

5d9c989

fix varbinary test

7d556ed

tell debezium to convert to base64 for binary

baa0a38

add doc

4cea23e

Octavia Squidington III (octavia-squidington-iii) added the area/documentation Improvements or additions to documentation label Jan 2, 2024

Xiaohan Song (xiaohansong) changed the title ~~Use base64 to encode mssql binary field~~ ✨Use base64 to encode mssql binary field Jan 2, 2024

vercel Bot deployed to Preview January 2, 2024 18:34 View deployment

Xiaohan Song (xiaohansong) requested a review from Rodi Reich Zilberman (rodireich) January 2, 2024 19:00

Merge branch 'master' into xiaohan/binaryencode

fe31f50

vercel Bot deployed to Preview January 3, 2024 04:42 View deployment

Rodi Reich Zilberman (rodireich) approved these changes Jan 3, 2024

View reviewed changes

Merge branch 'master' into xiaohan/binaryencode

014998c

vercel Bot deployed to Preview January 3, 2024 21:23 View deployment

use custom converter instead

fcb4f87

Xiaohan Song (xiaohansong) merged commit 609bcb2 into master Jan 4, 2024

Xiaohan Song (xiaohansong) deleted the xiaohan/binaryencode branch January 4, 2024 00:32

Navigation Menu

Repository navigation

✨Use base64 to encode mssql binary field - #33755

✨Use base64 to encode mssql binary field#33755
Xiaohan Song (xiaohansong) merged 11 commits into
masterfrom
xiaohan/binaryencode

Xiaohan Song (xiaohansong) commented Dec 22, 2023 •

edited

Loading

Uh oh!

vercel Bot commented Dec 22, 2023 •

edited

Loading

Uh oh!

github-actions Bot commented Dec 22, 2023 •

edited

Loading

Uh oh!

github-actions Bot commented Dec 22, 2023 •

edited by xiaohansong

Loading

Uh oh!

Rodi Reich Zilberman (rodireich) left a comment

Uh oh!

Rodi Reich Zilberman (rodireich) Dec 22, 2023

Uh oh!

Rodi Reich Zilberman (rodireich) Dec 22, 2023

Uh oh!

Stephane Geneix (stephane-airbyte) Dec 27, 2023

Uh oh!

Xiaohan Song (xiaohansong) Dec 28, 2023

Uh oh!

Xiaohan Song (xiaohansong) commented Dec 22, 2023

Uh oh!

Xiaohan Song (xiaohansong) commented Dec 26, 2023

Uh oh!

Rodi Reich Zilberman (rodireich) left a comment

Uh oh!

Vadym S (sukolenvo) commented Apr 17, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

Xiaohan Song (xiaohansong) commented Dec 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Actions

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Airbyter

Uh oh!

vercel Bot commented Dec 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Dec 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Dec 22, 2023 • edited by xiaohansong Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before Merging a Connector Pull Request

Uh oh!

Rodi Reich Zilberman (rodireich) left a comment

Choose a reason for hiding this comment

Uh oh!

Rodi Reich Zilberman (rodireich) Dec 22, 2023

Choose a reason for hiding this comment

Uh oh!

Rodi Reich Zilberman (rodireich) Dec 22, 2023

Choose a reason for hiding this comment

Uh oh!

Stephane Geneix (stephane-airbyte) Dec 27, 2023

Choose a reason for hiding this comment

Uh oh!

Xiaohan Song (xiaohansong) Dec 28, 2023

Choose a reason for hiding this comment

Uh oh!

Xiaohan Song (xiaohansong) commented Dec 22, 2023

Uh oh!

Xiaohan Song (xiaohansong) commented Dec 26, 2023

Uh oh!

Rodi Reich Zilberman (rodireich) left a comment

Choose a reason for hiding this comment

Uh oh!

Vadym S (sukolenvo) commented Apr 17, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Xiaohan Song (xiaohansong) commented Dec 22, 2023 •

edited

Loading

vercel Bot commented Dec 22, 2023 •

edited

Loading

github-actions Bot commented Dec 22, 2023 •

edited

Loading

github-actions Bot commented Dec 22, 2023 •

edited by xiaohansong

Loading