Postgres Source: add timezone awareness and handle BC dates #13166

VitaliiMaltsev · 2022-05-25T09:53:34Z

What

Cant handle any BC dates (Ex. '199-10-10 BC" would be missed BC attribute and returned as an AD date)
As part of the [EPIC] Expand date-time schema declarations to describe timezone awareness we would like to add to the Source Postgres additional information to the JSON schema about timestamp which is timezone aware/unaware.

There are next date-related types that should be covered:

timestamp with/without timezone
date
time with/without timezone

How

When converting an object from resultset metadata to LocalDate class, we can use the method getEra()
Created new JsonSchemaType final variable to cover all of the Postgres date-time types:

🚨 User Impact 🚨

user impact is possible at the normalization stage, since normalization cannot yet handle new parameters in the json schema

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

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.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub by running the /publish command described here
After the connector is published, connector added to connector index as described here
Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Updating a connector

Community member or Airbyter

Grant edit access to maintainers (instructions)
Secrets in the connector's spec are annotated with airbyte_secret
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.
Code reviews completed
Documentation updated
- Connector's README.md
- Connector's bootstrap.md. See description and examples
- Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
PR name follows PR naming conventions

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.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub and connector version bumped by running the /publish command described here

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:testScaffoldTemplates then checking in your changes
Documentation which references the generator is updated as needed

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

VitaliiMaltsev · 2022-05-25T13:30:15Z

/test connector=connectors/source-postgres

🕑 connectors/source-postgres https://github.com/airbytehq/airbyte/actions/runs/2384744434
✅ connectors/source-postgres https://github.com/airbytehq/airbyte/actions/runs/2384744434
No Python unittests run

VitaliiMaltsev · 2022-05-25T15:05:28Z

/test connector=connectors/source-postgres-strict-encrypt

🕑 connectors/source-postgres-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2385335102
✅ connectors/source-postgres-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2385335102
No Python unittests run

alexandr-shegeda

LGTM

alexandertsukanov · 2022-05-27T08:52:44Z

...postgres/src/main/java/io/airbyte/integrations/source/postgres/PostgresSourceOperations.java

+    } else if (columnTypeName.equalsIgnoreCase("time")) {
+      putTime(json, columnName, resultSet, colIndex);
+    } else if (columnTypeName.equalsIgnoreCase("timetz")) {
+      putTimeWithTimezone(json, columnName, resultSet, colIndex);
+    } else if (columnTypeName.equalsIgnoreCase("timestamptz")) {
+      putTimestampWithTimezone(json, columnName, resultSet, colIndex);


Is it possible we will have more else if statements here, in the future?
I suggest refactoring this block to smth like:

return switch (typeName) { case "real", "double", "float" -> Double.parseDouble(varCharValue); case "varchar" -> varCharValue; case "boolean" -> Boolean.parseBoolean(varCharValue); case "integer" -> Integer.parseInt(varCharValue); default -> null; };

__
Summary: 🛠️ This code needs a fix

Is it possible we will have more else if statements here, in the future? I suggest refactoring this block to smth like:

return switch (typeName) { case "real", "double", "float" -> Double.parseDouble(varCharValue); case "varchar" -> varCharValue; case "boolean" -> Boolean.parseBoolean(varCharValue); case "integer" -> Integer.parseInt(varCharValue); default -> null; };

__ Summary: 🛠️ This code needs a fix

replaced with switch

alexandertsukanov · 2022-05-27T08:55:34Z

airbyte-db/lib/src/main/java/io/airbyte/db/jdbc/AbstractJdbcCompatibleSourceOperations.java

+    return isBCE(date) ? value.substring(1) + " BC" : value;
+  }
+
+  private static boolean isBCE(LocalDate date) {


why static ?

it is util method and we can reuse it without initialising of the new instance AbstractJdbcCompatibleSourceOperations

@VitaliiMaltsev in such case, should it be public?

__
Summary: ❓ I have a question

@VitaliiMaltsev in such case, should it be public?

__ Summary: ❓ I have a question

made it public

alexandertsukanov · 2022-05-27T09:01:45Z

...a/io/airbyte/integrations/source/postgres/PostgresStrictEncryptJdbcSourceAcceptanceTest.java

-import io.airbyte.protocol.models.ConnectorSpecification;
+import io.airbyte.integrations.source.relationaldb.models.DbState;
+import io.airbyte.integrations.source.relationaldb.models.DbStreamState;
+import io.airbyte.protocol.models.*;


Please, don't use wildcard imports.

__
Summary: 🛠️ This code needs a fix | Tags: Brittle

Please, don't use wildcard imports.

__ Summary: 🛠️ This code needs a fix | Tags: Brittle

removed star import

alexandertsukanov · 2022-05-27T09:04:06Z

...postgres/src/main/java/io/airbyte/integrations/source/postgres/PostgresSourceOperations.java

+      } else if (typeName.equalsIgnoreCase("timestamptz")) {
+        return JDBCType.TIMESTAMP_WITH_TIMEZONE;
+      } else if (typeName.equalsIgnoreCase("timetz")) {
+        return JDBCType.TIME_WITH_TIMEZONE;
      }


Looks like, the comment above is related to this block of code as well.

Looks like, the comment above is related to this block of code as well.

replaced with switch

alexandertsukanov · 2022-05-27T09:10:44Z

.../src/test/java/io/airbyte/integrations/source/postgres/PostgresJdbcSourceAcceptanceTest.java

-import io.airbyte.protocol.models.ConnectorSpecification;
+import io.airbyte.integrations.source.relationaldb.models.DbState;
+import io.airbyte.integrations.source.relationaldb.models.DbStreamState;
+import io.airbyte.protocol.models.*;


Please, don't use wildcard imports.

__
Summary: 🛠️ This code needs a fix

Please, don't use wildcard imports.

__ Summary: 🛠️ This code needs a fix

removed star import

alexandertsukanov

Finished iteration of review. Left some comments

__
Tags: Reusable

…zones-and-eras

VitaliiMaltsev · 2022-05-31T12:11:21Z

/test connector=connectors/source-postgres

🕑 connectors/source-postgres https://github.com/airbytehq/airbyte/actions/runs/2414870642

VitaliiMaltsev · 2022-05-31T15:45:03Z

/publish connector=connectors/source-postgres

🕑 connectors/source-postgres https://github.com/airbytehq/airbyte/actions/runs/2416144342
❌ Failed to publish connectors/source-postgres
❌ Couldn't auto-bump version for connectors/source-postgres

VitaliiMaltsev · 2022-05-31T17:16:39Z

/test connector=connectors/source-postgres

🕑 connectors/source-postgres https://github.com/airbytehq/airbyte/actions/runs/2416615910
✅ connectors/source-postgres https://github.com/airbytehq/airbyte/actions/runs/2416615910
No Python unittests run

Build Passed

Test summary info:

All Passed

grishick · 2022-06-01T01:11:21Z

/publish connector=connectors/source-postgres run-tests=false

🕑 connectors/source-postgres https://github.com/airbytehq/airbyte/actions/runs/2418683236
🚀 Successfully published connectors/source-postgres
🚀 Auto-bumped version for connectors/source-postgres
✅ connectors/source-postgres https://github.com/airbytehq/airbyte/actions/runs/2418683236

VitaliiMaltsev · 2022-06-01T07:27:08Z

/publish connector=connectors/source-postgres-strict-encrypt run-tests=false

🕑 connectors/source-postgres-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2419945137
🚀 Successfully published connectors/source-postgres-strict-encrypt
❌ Couldn't auto-bump version for connectors/source-postgres-strict-encrypt

grishick · 2022-06-01T15:49:14Z

@evantahler FYI auto-bump has failed here (see @VitaliiMaltsev 's last attempt)

evantahler · 2022-06-01T16:01:44Z

@grishick isn't a failure expected if the version on this branch has already been bumped (your previous /publish did work)? The previous failures of the publish command seem to be test failures, as noted above

SshPasswordPostgresSourceAcceptanceTest > testDiscover() FAILED
    org.testcontainers.containers.ContainerLaunchException: Container startup failed
        at app//org.testcontainers.containers.GenericContainer.doStart(GenericContainer.java:345)
        at app//org.testcontainers.containers.GenericContainer.start(GenericContainer.java:326)
(snip...)

VitaliiMaltsev · 2022-06-01T16:12:27Z

@grishick isn't a failure expected if the version on this branch has already been bumped (your previous /publish did work)? The previous failures of the publish command seem to be test failures, as noted above
SshPasswordPostgresSourceAcceptanceTest > testDiscover() FAILED
    org.testcontainers.containers.ContainerLaunchException: Container startup failed
        at app//org.testcontainers.containers.GenericContainer.doStart(GenericContainer.java:345)
        at app//org.testcontainers.containers.GenericContainer.start(GenericContainer.java:326)
(snip...)

@evantahler auto-bump version issue is related to Postgres source strict encrypt connector, not to Postgres source

evantahler · 2022-06-01T17:30:09Z

Ah! sorry, I did not read closely enough to see that there were 2 connectors getting published here.

I'm actually not sure how this was working since #11712. My reading of the action:

      - name: Check if connector in definitions yaml
        if: github.event.inputs.auto-bump-version == 'true' && success()
        run: |
          connector="airbyte/${{ env.IMAGE_NAME }}"
          definitionpath=./airbyte-config/init/src/main/resources/seed/
          sourcecheck=$(yq e ".. | select(has(\"dockerRepository\")) | select(.dockerRepository == \"$connector\")" "$definitionpath"source_definitions.yaml)
          destcheck=$(yq e ".. | select(has(\"dockerRepository\")) | select(.dockerRepository == \"$connector\")" "$definitionpath"destination_definitions.yaml)
          if [[ (-z "$sourcecheck" && -z "$destcheck") ]]
          then exit 1
          fi

Seems to imply that if we are bumping the version, in all cases, we want to update our *definitions.yaml. But, these strict-encrypt versions aren't listed there, so this command will fail & exit 1.

Looking at some other recent PRs (#13176 (comment)) it looks like they are also failing for the same reason. Do we want to publish the connector, or is that something that cloud should do? It would be a simple fix to skip parts of the action if the connector name matches *strict-encrypt*...

I also think that we might be moving away from these secondary image and use an ENV var / setting to toggle on strict-encrypt mode in cloud. @tuliren - what's the path forward here?

grishick · 2022-06-01T18:01:22Z

Seems to imply that if we are bumping the version, in all cases, we want to update our *definitions.yaml. But, these strict-encrypt versions aren't listed there, so this command will fail & exit 1.

Hm... so this means that publishing strict-encrypt connectors with publish command is broken, but we still need to be publishing them to docker hub unless we replace these connectors entirely with some other way of enforcing encryption in the cloud. I am not aware of any work to get rid of strict encrypt connectors though.

…q#13166) * Postgres Source: add timezone awareness and handle BC dates * fixed checkstyle * add tests * updated changelog * removed star import * fixed tests * refactoring * removed star import * fixed bytea type * created final static constants * bump version * auto-bump connector version Co-authored-by: Octavia Squidington III <[email protected]>

tuliren · 2022-06-02T09:40:33Z

The publication of the strict-encrypt version succeeded. It was the version bumping that failed. This is expected, because the strict-encrypt version only exists on cloud.

The current workflow is:

Publish the normal version and the strict-encrypt version.
Ignore the version bumping failure from the strict-encrypt version.
Bump the strict-encrypt version in airbyte-cloud.

I guess we can just make the version bumping script ignore the error if a connector does not exist.

I also think that we might be moving away from these secondary image and use an ENV var / setting to toggle on strict-encrypt mode in cloud. @tuliren - what's the path forward here?

Yes, I think we can do the following:

Add a cloud environment variable that is specific to the Airbyte cloud deployment.
- Or reuse an existing one if it exists.
Pass the environment variable to the connector container.
When the connector detects such an environment variable, it updates the spec and behave just like the strict-encrypt version.

Added a comment to this related issue: #8634 (comment)

quantson · 2022-06-03T12:07:23Z

After updating our Postgres source connector to 0.4.19 following this PR merge, we're witnessing issues in one of our pipelines because date field precision is now truncated if the value of the millisecond or second is 0.

Value in PG database: 2022-07-02T16:09:00.000000Z
Value exported to BigQuery with Postgres source 0.4.18: 2022-07-02T16:09:00.000000Z
Value exported to BigQuery with Postgres source 0.4.18: 2022-07-02T16:09

I'm not sure if it's on purpose or if it's a bug, we've had to revert to 0.4.18 though

VitaliiMaltsev · 2022-06-06T10:24:35Z

After updating our Postgres source connector to 0.4.19 following this PR merge, we're witnessing issues in one of our pipelines because date field precision is now truncated if the value of the millisecond or second is 0.

Value in PG database: 2022-07-02T16:09:00.000000Z Value exported to BigQuery with Postgres source 0.4.18: 2022-07-02T16:09:00.000000Z Value exported to BigQuery with Postgres source 0.4.18: 2022-07-02T16:09

I'm not sure if it's on purpose or if it's a bug, we've had to revert to 0.4.18 though
@quantson what datatype are you using in postgres for this value? (2022-07-02T16:09:00.000000Z)

created an issue #13489
cc @grishick @tuliren

VitaliiMaltsev · 2022-06-07T13:51:37Z

@quantson please take a look #13549

Postgres Source: add timezone awareness and handle BC dates

198ad45

github-actions bot added area/connectors Connector related issues area/platform issues related to the platform area/protocol labels May 25, 2022

fixed checkstyle

d836b51

VitaliiMaltsev temporarily deployed to more-secrets May 25, 2022 10:02 Inactive

add tests

4018d8a

VitaliiMaltsev temporarily deployed to more-secrets May 25, 2022 13:26 Inactive

updated changelog

72f4ce7

github-actions bot added the area/documentation Improvements or additions to documentation label May 25, 2022

removed star import

662c4a3

VitaliiMaltsev temporarily deployed to more-secrets May 25, 2022 13:31 Inactive

fixed tests

6dbcc1d

VitaliiMaltsev temporarily deployed to more-secrets May 25, 2022 15:07 Inactive

VitaliiMaltsev requested review from yurii-bidiuk and alexandertsukanov May 26, 2022 15:07

This was linked to issues May 26, 2022

🎉 Source Postgres: Describe timezone awareness #12905

Closed

Postgres source date includes time, and cannot handle BC dates #8903

Closed

alexandr-shegeda approved these changes May 26, 2022

View reviewed changes

alexandr-shegeda marked this pull request as ready for review May 26, 2022 15:49

alexandertsukanov reviewed May 27, 2022

View reviewed changes

alexandertsukanov suggested changes May 27, 2022

View reviewed changes

refactoring

abf903f

VitaliiMaltsev temporarily deployed to more-secrets May 27, 2022 10:42 Inactive

Merge branch 'master' into vmaltsev/12905-postgres-source-handle-time…

68e1c62

…zones-and-eras

VitaliiMaltsev temporarily deployed to more-secrets May 31, 2022 10:54 Inactive

VitaliiMaltsev temporarily deployed to more-secrets June 1, 2022 01:13 Inactive

auto-bump connector version

359f0c6

octavia-squidington-iii temporarily deployed to more-secrets June 1, 2022 01:53 Inactive

VitaliiMaltsev merged commit 0a56b1d into master Jun 1, 2022

VitaliiMaltsev deleted the vmaltsev/12905-postgres-source-handle-timezones-and-eras branch June 1, 2022 07:46

yurii-bidiuk mentioned this pull request Jun 1, 2022

Source Postgres: lost milliseconds precision when a timestamp/datetime is converted to string #9157

Closed

octavia-squidington-iii mentioned this pull request Jun 2, 2022

Bump Airbyte version from 0.39.7-alpha to 0.39.8-alpha #13402

Merged

This was referenced Jun 6, 2022

Postgres Source : field precision is now truncated if the value of the millisecond or second is 0 #13489

Closed

🐛 Postgres Source: fixed truncated precision if the value of the milliseconds or seconds is 0 #13549

Merged

alafanechere mentioned this pull request Jun 8, 2022

source-postgres: TIMESTAMP_WITH_TIMEZONE column can't be used as cursor #13603

Closed

sh4sh mentioned this pull request Mar 7, 2023

🐛 Source BigQuery: preserve TIMESTAMP microseconds #20002

Closed

37 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Postgres Source: add timezone awareness and handle BC dates #13166

Postgres Source: add timezone awareness and handle BC dates #13166

VitaliiMaltsev commented May 25, 2022 •

edited

Loading

VitaliiMaltsev commented May 25, 2022 •

edited by github-actions bot

Loading

VitaliiMaltsev commented May 25, 2022 •

edited by github-actions bot

Loading

alexandr-shegeda left a comment

alexandertsukanov May 27, 2022

VitaliiMaltsev May 27, 2022

alexandertsukanov May 27, 2022 •

edited

Loading

VitaliiMaltsev May 27, 2022

alexandertsukanov May 27, 2022

VitaliiMaltsev May 27, 2022

alexandertsukanov May 27, 2022

VitaliiMaltsev May 27, 2022

alexandertsukanov May 27, 2022

VitaliiMaltsev May 27, 2022

alexandertsukanov May 27, 2022

VitaliiMaltsev May 27, 2022

alexandertsukanov left a comment

VitaliiMaltsev commented May 31, 2022 •

edited by github-actions bot

Loading

VitaliiMaltsev commented May 31, 2022 •

edited by github-actions bot

Loading

VitaliiMaltsev commented May 31, 2022 •

edited by github-actions bot

Loading

grishick commented Jun 1, 2022 •

edited by github-actions bot

Loading

VitaliiMaltsev commented Jun 1, 2022 •

edited by github-actions bot

Loading

grishick commented Jun 1, 2022

evantahler commented Jun 1, 2022 •

edited

Loading

VitaliiMaltsev commented Jun 1, 2022

evantahler commented Jun 1, 2022

grishick commented Jun 1, 2022

tuliren commented Jun 2, 2022

quantson commented Jun 3, 2022

VitaliiMaltsev commented Jun 6, 2022 •

edited

Loading

VitaliiMaltsev commented Jun 7, 2022

Postgres Source: add timezone awareness and handle BC dates #13166

Postgres Source: add timezone awareness and handle BC dates #13166

Conversation

VitaliiMaltsev commented May 25, 2022 • edited Loading

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Tests

VitaliiMaltsev commented May 25, 2022 • edited by github-actions bot Loading

VitaliiMaltsev commented May 25, 2022 • edited by github-actions bot Loading

alexandr-shegeda left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexandertsukanov May 27, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexandertsukanov left a comment

Choose a reason for hiding this comment

VitaliiMaltsev commented May 31, 2022 • edited by github-actions bot Loading

VitaliiMaltsev commented May 31, 2022 • edited by github-actions bot Loading

VitaliiMaltsev commented May 31, 2022 • edited by github-actions bot Loading

Build Passed

grishick commented Jun 1, 2022 • edited by github-actions bot Loading

VitaliiMaltsev commented Jun 1, 2022 • edited by github-actions bot Loading

grishick commented Jun 1, 2022

evantahler commented Jun 1, 2022 • edited Loading

VitaliiMaltsev commented Jun 1, 2022

evantahler commented Jun 1, 2022

grishick commented Jun 1, 2022

tuliren commented Jun 2, 2022

quantson commented Jun 3, 2022

VitaliiMaltsev commented Jun 6, 2022 • edited Loading

VitaliiMaltsev commented Jun 7, 2022

VitaliiMaltsev commented May 25, 2022 •

edited

Loading

VitaliiMaltsev commented May 25, 2022 •

edited by github-actions bot

Loading

VitaliiMaltsev commented May 25, 2022 •

edited by github-actions bot

Loading

alexandertsukanov May 27, 2022 •

edited

Loading

VitaliiMaltsev commented May 31, 2022 •

edited by github-actions bot

Loading

VitaliiMaltsev commented May 31, 2022 •

edited by github-actions bot

Loading

VitaliiMaltsev commented May 31, 2022 •

edited by github-actions bot

Loading

grishick commented Jun 1, 2022 •

edited by github-actions bot

Loading

VitaliiMaltsev commented Jun 1, 2022 •

edited by github-actions bot

Loading

evantahler commented Jun 1, 2022 •

edited

Loading

VitaliiMaltsev commented Jun 6, 2022 •

edited

Loading