You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "nikolamand-db (via GitHub)" <gi...@apache.org> on 2024/02/26 11:42:33 UTC

[PR] [SPARK-47147][PYTHON] Fix Pyspark collated string conversion error [spark]

nikolamand-db opened a new pull request, #45257:
URL: https://github.com/apache/spark/pull/45257

   <!--
   Thanks for sending a pull request!  Here are some tips for you:
     1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
     2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
     3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
     4. Be sure to keep the PR description updated to reflect all changes.
     5. Please write your PR title to summarize what this PR proposes.
     6. If possible, provide a concise example to reproduce the issue for a faster review.
     7. If you want to add a new configuration, please read the guideline first for naming configurations in
        'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
     8. If you want to add or modify an error type or message, please read the guideline first in
        'common/utils/src/main/resources/error/README.md'.
   -->
   
   ### What changes were proposed in this pull request?
   <!--
   Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue. 
   If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
     1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
     2. If you fix some SQL features, you can provide some references of other DBMSes.
     3. If there is design documentation, please add the link.
     4. If there is a discussion in the mailing list, please add the link.
   -->
   When running Pyspark shell in non-Spark Connect mode, query `SELECT 'abc' COLLATE 'UCS_BASIC_LCASE'` produces the following error:
   ```
   AssertionError: Undefined error message parameter for error class: CANNOT_PARSE_DATATYPE. Parameters: {'error': "Undefined error message parameter for error class: CANNOT_PARSE_DATATYPE. Parameters: {'error': 'string(UCS_BASIC_LCASE)'}"}
   ```
   Fix the error by updating `StringType` class to include collation id support. Additional changes ensure conversions work properly.
   
   ### Why are the changes needed?
   <!--
   Please clarify why the changes are needed. For instance,
     1. If you propose a new API, clarify the use case for a new API.
     2. If you fix a bug, you can clarify why it is a bug.
   -->
   
   To fix collations-related error in PySpark shell.
   
   ### Does this PR introduce _any_ user-facing change?
   <!--
   Note that it means *any* user-facing change including all aspects such as the documentation fix.
   If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
   If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
   If no, write 'No'.
   -->
   
   Yes, the described sql query no longer throws an exception.
   
   ### How was this patch tested?
   <!--
   If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
   If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
   If tests were not added, please describe why they were not added and/or why it was difficult to add.
   If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
   -->
   
   Manually tested with PySpark shell, additional assertions are added to type tests.
   
   ### Was this patch authored or co-authored using generative AI tooling?
   <!--
   If generative AI tooling has been used in the process of authoring this patch, please include the
   phrase: 'Generated-by: ' followed by the name of the tool and its version.
   If no, write 'No'.
   Please refer to the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
   -->
   
   No.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-47147][PYTHON][SQL] Fix PySpark collated string conversion error [spark]

Posted by "nikolamand-db (via GitHub)" <gi...@apache.org>.
nikolamand-db commented on code in PR #45257:
URL: https://github.com/apache/spark/pull/45257#discussion_r1504368260


##########
python/pyspark/sql/types.py:
##########
@@ -244,10 +244,39 @@ class FractionalType(NumericType):
     """Fractional data types."""
 
 
-class StringType(AtomicType, metaclass=DataTypeSingleton):
-    """String data type."""
+class StringType(AtomicType):
+    """String data type.
 
-    pass
+    Parameters
+    ----------
+    collationId : int
+        the collation id number.
+    """
+
+    collationNames = [
+        "UCS_BASIC",
+        "UCS_BASIC_LCASE",
+        "UNICODE",
+        "UNICODE_CI"
+    ]
+
+    def __init__(self, collationId: int = 0):
+        self.collationId = collationId
+
+    def collationIdToName(self, collationId: int) -> str:
+        return "(" + StringType.collationNames[collationId] + ")" if collationId != 0 else ""
+
+    def collationNameToId(collationName: str) -> int:
+        return StringType.collationNames.index(collationName) if collationName != "" else 0
+
+    def simpleString(self) -> str:
+        return "string%s" % (self.collationIdToName(self.collationId))
+
+    def jsonValue(self) -> str:
+        return "string%s" % (self.collationIdToName(self.collationId))

Review Comment:
   @HyukjinKwon Aligned this with collated string regex from Scala and added more tests to confirm parsing works as you suggested, please check the latest changes.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-47147][PYTHON][SQL] Fix PySpark collated string conversion error [spark]

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #45257:
URL: https://github.com/apache/spark/pull/45257#issuecomment-1968630099

   Merged to master.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-47147][PYTHON][SQL] Fix Pyspark collated string conversion error [spark]

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #45257:
URL: https://github.com/apache/spark/pull/45257#discussion_r1503477950


##########
python/pyspark/sql/tests/test_types.py:
##########
@@ -849,6 +849,7 @@ def test_parse_datatype_string(self):
             if k != "varchar" and k != "char":
                 self.assertEqual(t(), _parse_datatype_string(k))
         self.assertEqual(IntegerType(), _parse_datatype_string("int"))
+        self.assertEqual(StringType(0), _parse_datatype_string("string"))

Review Comment:
   Can we add other cases like `string(0)`?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-47147][PYTHON][SQL] Fix PySpark collated string conversion error [spark]

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #45257:
URL: https://github.com/apache/spark/pull/45257#issuecomment-1968628823

   Merged to master.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-47147][PYTHON][SQL] Fix PySpark collated string conversion error [spark]

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon closed pull request #45257: [SPARK-47147][PYTHON][SQL] Fix PySpark collated string conversion error
URL: https://github.com/apache/spark/pull/45257


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-47147][PYTHON][SQL] Fix Pyspark collated string conversion error [spark]

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #45257:
URL: https://github.com/apache/spark/pull/45257#discussion_r1503477046


##########
python/pyspark/sql/types.py:
##########
@@ -244,10 +244,39 @@ class FractionalType(NumericType):
     """Fractional data types."""
 
 
-class StringType(AtomicType, metaclass=DataTypeSingleton):
-    """String data type."""
+class StringType(AtomicType):
+    """String data type.
 
-    pass
+    Parameters
+    ----------
+    collationId : int
+        the collation id number.
+    """
+
+    collationNames = [
+        "UCS_BASIC",
+        "UCS_BASIC_LCASE",
+        "UNICODE",
+        "UNICODE_CI"
+    ]
+
+    def __init__(self, collationId: int = 0):
+        self.collationId = collationId
+
+    def collationIdToName(self, collationId: int) -> str:
+        return "(" + StringType.collationNames[collationId] + ")" if collationId != 0 else ""
+
+    def collationNameToId(collationName: str) -> int:
+        return StringType.collationNames.index(collationName) if collationName != "" else 0
+
+    def simpleString(self) -> str:
+        return "string%s" % (self.collationIdToName(self.collationId))
+
+    def jsonValue(self) -> str:
+        return "string%s" % (self.collationIdToName(self.collationId))

Review Comment:
   Is this matched with `DataType.COLLATED_STRING_TYPE` in Scala? It has to be same and able to parse via `DataType.parseDataType`



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-47147][PYTHON][SQL] Fix Pyspark collated string conversion error [spark]

Posted by "dbatomic (via GitHub)" <gi...@apache.org>.
dbatomic commented on code in PR #45257:
URL: https://github.com/apache/spark/pull/45257#discussion_r1502493288


##########
sql/api/src/main/scala/org/apache/spark/sql/types/DataType.scala:
##########
@@ -174,7 +174,7 @@ object DataType {
       YearMonthIntervalType(MONTH),
       YearMonthIntervalType(YEAR, MONTH),
       TimestampNTZType,
-      VariantType)
+      VariantType) ++ (0 until 4).map(StringType(_)))

Review Comment:
   Let's avoid adding all the StringTypes here. In future there will be 1k+ different collations so we shouldn't encode all of them here.
   
   In another PR by @stefankandic there is a change that maybe solves the problem that you are having:
   https://github.com/apache/spark/pull/45105/files#diff-187f7ebcd92378b3fd460a19c6c130d65c5be7861ee2beb08e2a43e769308742



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-47147][PYTHON][SQL] Fix Pyspark collated string conversion error [spark]

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #45257:
URL: https://github.com/apache/spark/pull/45257#discussion_r1503477653


##########
python/pyspark/sql/types.py:
##########
@@ -244,10 +244,39 @@ class FractionalType(NumericType):
     """Fractional data types."""
 
 
-class StringType(AtomicType, metaclass=DataTypeSingleton):
-    """String data type."""
+class StringType(AtomicType):
+    """String data type.
 
-    pass
+    Parameters
+    ----------
+    collationId : int
+        the collation id number.
+    """
+
+    collationNames = [
+        "UCS_BASIC",
+        "UCS_BASIC_LCASE",
+        "UNICODE",
+        "UNICODE_CI"
+    ]
+
+    def __init__(self, collationId: int = 0):
+        self.collationId = collationId
+
+    def collationIdToName(self, collationId: int) -> str:
+        return "(" + StringType.collationNames[collationId] + ")" if collationId != 0 else ""
+
+    def collationNameToId(collationName: str) -> int:
+        return StringType.collationNames.index(collationName) if collationName != "" else 0
+
+    def simpleString(self) -> str:
+        return "string%s" % (self.collationIdToName(self.collationId))

Review Comment:
   To confirm, is this able to parse this string via our SQL parser?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org