This is an automated email from the ASF dual-hosted git repository.
agrove pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion-comet.git
The following commit(s) were added to refs/heads/main by this push:
new ae914c8 Add compatibility guide (#316)
ae914c8 is described below
commit ae914c8f6ebaa8ff4804746ed75089afe7ca6c6c
Author: Andy Grove <[email protected]>
AuthorDate: Wed Apr 24 12:07:52 2024 -0600
Add compatibility guide (#316)
---
docs/source/compatibility.md | 40 ++++++++++++++++++++++++++++++++++++++++
docs/source/index.rst | 1 +
2 files changed, 41 insertions(+)
diff --git a/docs/source/compatibility.md b/docs/source/compatibility.md
new file mode 100644
index 0000000..6e69f84
--- /dev/null
+++ b/docs/source/compatibility.md
@@ -0,0 +1,40 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Compatibility Guide
+
+Comet aims to provide consistent results with the version of Apache Spark that
is being used.
+
+This guide offers information about areas of functionality where there are
known differences.
+
+## ANSI mode
+
+Comet currently ignores ANSI mode in most cases, and therefore can produce
different results than Spark. By default,
+Comet will fall back to Spark if ANSI mode is enabled. To enable Comet to
accelerate queries when ANSI mode is enabled,
+specify `spark.comet.ansi.enabled=true` in the Spark configuration. Comet's
ANSI support is experimental and should not
+be used in production.
+
+There is an [epic](https://github.com/apache/datafusion-comet/issues/313)
where we are tracking the work to fully implement ANSI support.
+
+## Cast
+
+Comet currently delegates to Apache DataFusion for most cast operations, and
this means that the behavior is not
+guaranteed to be consistent with Spark.
+
+There is an [epic](https://github.com/apache/datafusion-comet/issues/286)
where we are tracking the work to implement Spark-compatible cast expressions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 2cff77f..c8f2735 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -43,6 +43,7 @@ GitHub repository at
https://github.com/apache/datafusion-comet.
:maxdepth: 1
:caption: Project Links
+ compatibility
Github and Issue Tracker <https://github.com/apache/datafusion-comet>
.. _toc.asf-links:
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
