Skip to content

Add portable Date type#37830

Open
ahmedabu98 wants to merge 2 commits intoapache:masterfrom
ahmedabu98:portable_date
Open

Add portable Date type#37830
ahmedabu98 wants to merge 2 commits intoapache:masterfrom
ahmedabu98:portable_date

Conversation

@ahmedabu98
Copy link
Contributor

There was already a Java Date logical type. This PR creates an equivalent Python logical type and adds it to the Beam model to standardize it

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a portable Date logical type to the Apache Beam model, standardizing the representation of date-only values across different SDKs. By defining a common URN and implementing the type in both Java and Python, it ensures consistent handling of dates without timezones, represented as the number of days since the epoch. This enhancement improves interoperability and simplifies schema management for date-related data.

Highlights

  • New Logical Type: Introduced a new DATE logical type in the Beam schema definition (schema.proto), specifying its URN and INT64 representation.
  • Java SDK Implementation: Implemented the Date logical type in the Java SDK, including its registration for schema translation and refinement of its argument handling.
  • Python SDK Integration: Updated the Python SDK to recognize and map datetime.date to the new DATE logical type URN, enhancing cross-language compatibility.
  • Testing: Added comprehensive unit tests in both Java and Python to validate the new DATE logical type's functionality and schema translation.
  • Iceberg Integration Test Update: Modified an Iceberg integration test to include datetime import, add a date_ field to test data, and configure an io-impl property.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • model/pipeline/src/main/proto/org/apache/beam/model/pipeline/v1/schema.proto
    • Added DATE enum value to LogicalTypes.Enum with its URN and description, specifying INT64 as its representation type.
  • sdks/java/core/src/main/java/org/apache/beam/sdk/schemas/SchemaTranslation.java
    • Imported org.apache.beam.sdk.schemas.logicaltypes.Date.
    • Registered the Date.IDENTIFIER with Date.class in the LOGICAL_TYPE_IDENTIFIER_TO_CLASS map.
  • sdks/java/core/src/main/java/org/apache/beam/sdk/schemas/logicaltypes/Date.java
    • Added imports for RunnerApi, SchemaApi, and Nullable.
    • Updated the IDENTIFIER field to dynamically retrieve the URN from SchemaApi.LogicalTypes.Enum.DATE.
    • Modified getArgumentType() to return null and removed the getArgument() method, indicating no arguments for this logical type.
  • sdks/java/core/src/test/java/org/apache/beam/sdk/schemas/SchemaTranslationTest.java
    • Imported java.time.LocalDate.
    • Added a test schema entry for Field.of("date", FieldType.logicalType(SqlTypes.DATE)).
    • Included test data for the DATE logical type using LocalDate.of(2000, 1, 3).
  • sdks/python/apache_beam/portability/common_urns.py
    • Added date = LogicalTypes.Enum.DATE to expose the new DATE URN.
  • sdks/python/apache_beam/transforms/managed_iceberg_it_test.py
    • Imported the datetime module.
    • Commented out the @unittest.skipUnless decorator for the ManagedIcebergIT class.
    • Added a date_ field to the _create_row method, populating it with a calculated datetime.date.
    • Added "io-impl": "org.apache.iceberg.gcp.gcs.GCSFileIO" to catalog_properties.
  • sdks/python/apache_beam/typehints/schemas.py
    • Updated the schema mapping documentation to include datetime.date <---> LogicalType(urn="beam:logical_type:date:v1").
    • Added a commented-out class Date which provides a Python implementation for the Date logical type, including EPOCH and conversion methods.
  • sdks/python/apache_beam/typehints/schemas_test.py
    • Imported the datetime module.
    • Added a date: datetime.date field to the ComplexSchema NamedTuple for testing purposes.
Activity
  • No specific activity (comments, reviews, progress updates) was provided in the context.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@ahmedabu98
Copy link
Contributor Author

R: @Abacn can you take a look?

@github-actions
Copy link
Contributor

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers

// - Representation type: INT64
// - A date without a timezone, represented by the number of days
// since the epoch.
DATE = 8 [(org.apache.beam.model.pipeline.v1.beam_urn) =
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider adding TIME as well?

bytes <-----> BYTES
ByteString ------> BYTES
Timestamp <-----> LogicalType(urn="beam:logical_type:micros_instant:v1")
datetime.date <---> LogicalType(urn="beam:logical_type:date:v1")
Copy link
Contributor

Choose a reason for hiding this comment

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

Most Java SDK's IO uses joda data and time, and are serialized as joda timestamp. Then JDBCDateType and JDBCTimeType were created to accomadate them.

WIth the introducation of "ture" portable data/time logical types, we need to make sure it doesn't break existing Python JdbcIO. We can run https://github.com/apache/beam/actions/workflows/beam_PostCommit_Python_Xlang_Gcp_Direct.yml against this PR to test

return Timestamp(seconds=int(value.seconds), micros=int(value.micros))


# @LogicalType._register_internal
Copy link
Contributor

Choose a reason for hiding this comment

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

(pending debugging cleanup)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants