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.

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

Improve atan and anan2 sql function for mysql #31924

Merged
merged 1 commit into from
Jun 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import org.apache.calcite.runtime.SqlFunctions;
import org.apache.calcite.schema.SchemaPlus;
import org.apache.calcite.schema.impl.ScalarFunctionImpl;
import org.apache.shardingsphere.infra.autogen.version.ShardingSphereVersion;
Expand Down Expand Up @@ -50,6 +51,8 @@ public static void registryUserDefinedFunction(final String schemaName, final Sc
schemaPlus.add("pg_catalog.intervaltonum", ScalarFunctionImpl.create(SQLFederationFunctionUtils.class, "intervalToNum"));
schemaPlus.add("pg_catalog.gs_password_notifyTime", ScalarFunctionImpl.create(SQLFederationFunctionUtils.class, "gsPasswordNotifyTime"));
schemaPlus.add("bit_count", ScalarFunctionImpl.create(MySQLBitCountFunction.class, "bitCount"));
schemaPlus.add("atan", ScalarFunctionImpl.create(SqlFunctions.class, "atan2"));
schemaPlus.add("atan2", ScalarFunctionImpl.create(SqlFunctions.class, "atan"));
Copy link
Member

Choose a reason for hiding this comment

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

Is SqlFunctions a built-in class in Caclite? Why doesn't Calcite use the functions in this class by default?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, SqlFunctions is a built-in class in Calcite that implements the execution logic for atan and atan2 functions. However, in Calcite, the atan function method signature only allows one parameter, while the atan2 function method signature allows two parameters.

MySQL handles the atan function differently depending on the number of parameters: it uses a different execution logic for one parameter (atan) versus two parameters (atan2).

When Calcite encounters a call to the atan function with two parameters, it can find the implementation based on the function name but fails during parameter matching because in Calcite, the atan function can only accept a single parameter.

To resolve this, I added an implementation for the atan2 function alongside atan. Now, at runtime, Calcite can find both implementations of these functions. It will match based on the number of parameters and invoke the appropriate method, thereby calling the atan2 function implementation when two parameters are provided.

In MySQL, the atan2 function can indeed be executed with just one parameter.

Ref: https://github.com/mysql/mysql-server/blob/trunk/sql/item_func.cc#L2906
image

Copy link
Member

Choose a reason for hiding this comment

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

That is, they are equivalent in the MySQL dialect. Thanks for clarifying that, this is a great PR.

if ("pg_catalog".equalsIgnoreCase(schemaName)) {
schemaPlus.add("pg_catalog.pg_table_is_visible", ScalarFunctionImpl.create(SQLFederationFunctionUtils.class, "pgTableIsVisible"));
schemaPlus.add("pg_catalog.pg_get_userbyid", ScalarFunctionImpl.create(SQLFederationFunctionUtils.class, "pgGetUserById"));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -333,4 +333,18 @@
INNER JOIN t_order_item t3 ON t2.product_id = t3.product_id INNER JOIN t_order t4 ON t4.order_id = t3.order_id order by t1.product_id" db-types="MySQL" scenario-types="db_tbl_sql_federation">
<assertion expected-data-source-name="read_dataset" />
</test-case>

<test-case sql="SELECT ATAN(1.0), ATAN(1), ATAN('1'), ATAN(1.0, 2.0), ATAN(1, 2), ATAN(1, 2.0), ATAN(-2, 2)" db-types="MySQL" scenario-types="db_tbl_sql_federation">
<assertion expected-data-source-name="read_dataset" />
</test-case>

<test-case sql="SELECT ATAN2(1.0), ATAN2(1), ATAN2('1'), ATAN2(1.0, 2.0), ATAN2(1, 2.0), ATAN2(-2, 2)" db-types="MySQL" scenario-types="db_tbl_sql_federation">
<assertion expected-data-source-name="read_dataset" />
</test-case>

<test-case sql="SELECT ATAN(res1.order_id), ATAN(res1.order_id, res2.item_id), ATAN2(res1.order_id), ATAN2(res1.order_id, res2.item_id)
FROM (SELECT order_id FROM t_order limit 10) res1
INNER JOIN (SELECT item_id, order_id FROM t_order_item limit 10) res2 ON res1.order_id = res2.order_id" db-types="MySQL" scenario-types="db_tbl_sql_federation">
<assertion expected-data-source-name="read_dataset" />
</test-case>
</integration-test-cases>