You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@calcite.apache.org by jh...@apache.org on 2017/11/03 03:32:31 UTC
[1/2] calcite git commit: [CALCITE-1867] Allow user-defined grouped
window functions (Timo Walther) [Forced Update!]
Repository: calcite
Updated Branches:
refs/heads/master 2f0eecb3c -> 16f1fcf25 (forced update)
[CALCITE-1867] Allow user-defined grouped window functions (Timo Walther)
Rename SqlGroupFunction to SqlGroupedWindowFunction.
Close apache/calcite#549
Project: http://git-wip-us.apache.org/repos/asf/calcite/repo
Commit: http://git-wip-us.apache.org/repos/asf/calcite/commit/f596f92a
Tree: http://git-wip-us.apache.org/repos/asf/calcite/tree/f596f92a
Diff: http://git-wip-us.apache.org/repos/asf/calcite/diff/f596f92a
Branch: refs/heads/master
Commit: f596f92ac081956d92a68576b3ebd2a95e44f865
Parents: 61f1258
Author: twalthr <tw...@apache.org>
Authored: Tue Oct 17 11:30:10 2017 +0200
Committer: Julian Hyde <jh...@apache.org>
Committed: Thu Nov 2 16:53:43 2017 -0700
----------------------------------------------------------------------
.../calcite/sql/SqlGroupedWindowFunction.java | 122 +++++++++++++++++++
.../calcite/sql/fun/SqlGroupFunction.java | 99 ---------------
.../calcite/sql/fun/SqlStdOperatorTable.java | 43 +++----
3 files changed, 144 insertions(+), 120 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/calcite/blob/f596f92a/core/src/main/java/org/apache/calcite/sql/SqlGroupedWindowFunction.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/calcite/sql/SqlGroupedWindowFunction.java b/core/src/main/java/org/apache/calcite/sql/SqlGroupedWindowFunction.java
new file mode 100644
index 0000000..ef982fa
--- /dev/null
+++ b/core/src/main/java/org/apache/calcite/sql/SqlGroupedWindowFunction.java
@@ -0,0 +1,122 @@
+/*
+ * 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.
+ */
+package org.apache.calcite.sql;
+
+import org.apache.calcite.sql.type.ReturnTypes;
+import org.apache.calcite.sql.type.SqlOperandTypeChecker;
+import org.apache.calcite.sql.validate.SqlMonotonicity;
+
+import com.google.common.collect.ImmutableList;
+
+import java.util.List;
+
+/**
+ * SQL function that computes keys by which rows can be partitioned and
+ * aggregated.
+ *
+ * <p>Grouped window functions always occur in the GROUP BY clause. They often
+ * have auxiliary functions that access information about the group. For
+ * example, {@code HOP} is a group function, and its auxiliary functions are
+ * {@code HOP_START} and {@code HOP_END}. Here they are used in a streaming
+ * query:
+ *
+ * <blockquote><pre>
+ * SELECT STREAM HOP_START(rowtime, INTERVAL '1' HOUR),
+ * HOP_END(rowtime, INTERVAL '1' HOUR),
+ * MIN(unitPrice)
+ * FROM Orders
+ * GROUP BY HOP(rowtime, INTERVAL '1' HOUR), productId
+ * </pre></blockquote>
+ */
+public class SqlGroupedWindowFunction extends SqlFunction {
+ /** The grouped function, if this an auxiliary function; null otherwise. */
+ public final SqlGroupedWindowFunction groupFunction;
+
+ /** Creates a SqlGroupedWindowFunction.
+ *
+ * @param name Function name
+ * @param kind Kind
+ * @param groupFunction Group function, if this is an auxiliary;
+ * null, if this is a group function
+ * @param operandTypeChecker Operand type checker
+ */
+ public SqlGroupedWindowFunction(String name, SqlKind kind,
+ SqlGroupedWindowFunction groupFunction,
+ SqlOperandTypeChecker operandTypeChecker) {
+ super(name, kind, ReturnTypes.ARG0, null,
+ operandTypeChecker, SqlFunctionCategory.SYSTEM);
+ this.groupFunction = groupFunction;
+ if (groupFunction != null) {
+ assert groupFunction.groupFunction == null;
+ }
+ }
+
+ /** Creates a SqlGroupedWindowFunction.
+ *
+ * @param kind Kind; also determines function name
+ * @param groupFunction Group function, if this is an auxiliary;
+ * null, if this is a group function
+ * @param operandTypeChecker Operand type checker
+ */
+ public SqlGroupedWindowFunction(SqlKind kind,
+ SqlGroupedWindowFunction groupFunction,
+ SqlOperandTypeChecker operandTypeChecker) {
+ this(kind.name(), kind, groupFunction, operandTypeChecker);
+ }
+
+ /** Creates an auxiliary function from this grouped window function.
+ *
+ * @param kind Kind; also determines function name
+ */
+ public SqlGroupedWindowFunction auxiliary(SqlKind kind) {
+ return auxiliary(kind.name(), kind);
+ }
+
+ /** Creates an auxiliary function from this grouped window function.
+ *
+ * @param name Function name
+ * @param kind Kind
+ */
+ public SqlGroupedWindowFunction auxiliary(String name, SqlKind kind) {
+ return new SqlGroupedWindowFunction(name, kind, this, getOperandTypeChecker());
+ }
+
+ /** Returns a list of this grouped window function's auxiliary functions. */
+ public List<SqlGroupedWindowFunction> getAuxiliaryFunctions() {
+ return ImmutableList.of();
+ }
+
+ @Override public boolean isGroup() {
+ // Auxiliary functions are not group functions
+ return groupFunction == null;
+ }
+
+ @Override public boolean isGroupAuxiliary() {
+ return groupFunction != null;
+ }
+
+ @Override public SqlMonotonicity getMonotonicity(SqlOperatorBinding call) {
+ // Monotonic iff its first argument is, but not strict.
+ //
+ // Note: This strategy happens to works for all current group functions
+ // (HOP, TUMBLE, SESSION). When there are exceptions to this rule, we'll
+ // make the method abstract.
+ return call.getOperandMonotonicity(0).unstrict();
+ }
+}
+
+// End SqlGroupedWindowFunction.java
http://git-wip-us.apache.org/repos/asf/calcite/blob/f596f92a/core/src/main/java/org/apache/calcite/sql/fun/SqlGroupFunction.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/calcite/sql/fun/SqlGroupFunction.java b/core/src/main/java/org/apache/calcite/sql/fun/SqlGroupFunction.java
deleted file mode 100644
index d44267a..0000000
--- a/core/src/main/java/org/apache/calcite/sql/fun/SqlGroupFunction.java
+++ /dev/null
@@ -1,99 +0,0 @@
-/*
- * 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.
- */
-package org.apache.calcite.sql.fun;
-
-import org.apache.calcite.sql.SqlFunction;
-import org.apache.calcite.sql.SqlFunctionCategory;
-import org.apache.calcite.sql.SqlKind;
-import org.apache.calcite.sql.SqlOperatorBinding;
-import org.apache.calcite.sql.type.ReturnTypes;
-import org.apache.calcite.sql.type.SqlOperandTypeChecker;
-import org.apache.calcite.sql.validate.SqlMonotonicity;
-
-import com.google.common.collect.ImmutableList;
-
-import java.util.List;
-
-/**
- * SQL function that computes keys by which rows can be partitioned and
- * aggregated.
- *
- * <p>Grouped window functions always occur in the GROUP BY clause. They often
- * have auxiliary functions that access information about the group. For
- * example, {@code HOP} is a group function, and its auxiliary functions are
- * {@code HOP_START} and {@code HOP_END}. Here they are used in a streaming
- * query:
- *
- * <blockquote><pre>
- * SELECT STREAM HOP_START(rowtime, INTERVAL '1' HOUR),
- * HOP_END(rowtime, INTERVAL '1' HOUR),
- * MIN(unitPrice)
- * FROM Orders
- * GROUP BY HOP(rowtime, INTERVAL '1' HOUR), productId
- * </pre></blockquote>
- */
-class SqlGroupFunction extends SqlFunction {
- /** The grouped function, if this an auxiliary function; null otherwise. */
- final SqlGroupFunction groupFunction;
-
- /** Creates a SqlGroupFunction.
- *
- * @param kind Kind; also determines function name
- * @param groupFunction Group function, if this is an auxiliary;
- * null, if this is a group function
- * @param operandTypeChecker Operand type checker
- */
- SqlGroupFunction(SqlKind kind, SqlGroupFunction groupFunction,
- SqlOperandTypeChecker operandTypeChecker) {
- super(kind.name(), kind, ReturnTypes.ARG0, null,
- operandTypeChecker, SqlFunctionCategory.SYSTEM);
- this.groupFunction = groupFunction;
- if (groupFunction != null) {
- assert groupFunction.groupFunction == null;
- }
- }
-
- /** Creates an auxiliary function from this grouped window function. */
- SqlGroupFunction auxiliary(SqlKind kind) {
- return new SqlGroupFunction(kind, this, getOperandTypeChecker());
- }
-
- /** Returns a list of this grouped window function's auxiliary functions. */
- List<SqlGroupFunction> getAuxiliaryFunctions() {
- return ImmutableList.of();
- }
-
- @Override public boolean isGroup() {
- // Auxiliary functions are not group functions
- return groupFunction == null;
- }
-
- @Override public boolean isGroupAuxiliary() {
- return groupFunction != null;
- }
-
- @Override public SqlMonotonicity getMonotonicity(SqlOperatorBinding call) {
- // Monotonic iff its first argument is, but not strict.
- //
- // Note: This strategy happens to works for all current group functions
- // (HOP, TUMBLE, SESSION). When there are exceptions to this rule, we'll
- // make the method abstract.
- return call.getOperandMonotonicity(0).unstrict();
- }
-}
-
-// End SqlGroupFunction.java
http://git-wip-us.apache.org/repos/asf/calcite/blob/f596f92a/core/src/main/java/org/apache/calcite/sql/fun/SqlStdOperatorTable.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/calcite/sql/fun/SqlStdOperatorTable.java b/core/src/main/java/org/apache/calcite/sql/fun/SqlStdOperatorTable.java
index c8adf5e..9b5273a 100644
--- a/core/src/main/java/org/apache/calcite/sql/fun/SqlStdOperatorTable.java
+++ b/core/src/main/java/org/apache/calcite/sql/fun/SqlStdOperatorTable.java
@@ -27,6 +27,7 @@ import org.apache.calcite.sql.SqlCall;
import org.apache.calcite.sql.SqlFilterOperator;
import org.apache.calcite.sql.SqlFunction;
import org.apache.calcite.sql.SqlFunctionCategory;
+import org.apache.calcite.sql.SqlGroupedWindowFunction;
import org.apache.calcite.sql.SqlInternalOperator;
import org.apache.calcite.sql.SqlKind;
import org.apache.calcite.sql.SqlLateralOperator;
@@ -2006,63 +2007,63 @@ public class SqlStdOperatorTable extends ReflectiveSqlOperatorTable {
};
/** The {@code TUMBLE} group function. */
- public static final SqlGroupFunction TUMBLE =
- new SqlGroupFunction(SqlKind.TUMBLE, null,
+ public static final SqlGroupedWindowFunction TUMBLE =
+ new SqlGroupedWindowFunction(SqlKind.TUMBLE, null,
OperandTypes.or(OperandTypes.DATETIME_INTERVAL,
OperandTypes.DATETIME_INTERVAL_TIME)) {
- @Override List<SqlGroupFunction> getAuxiliaryFunctions() {
+ @Override public List<SqlGroupedWindowFunction> getAuxiliaryFunctions() {
return ImmutableList.of(TUMBLE_START, TUMBLE_END);
}
};
/** The {@code TUMBLE_START} auxiliary function of
* the {@code TUMBLE} group function. */
- public static final SqlGroupFunction TUMBLE_START =
+ public static final SqlGroupedWindowFunction TUMBLE_START =
TUMBLE.auxiliary(SqlKind.TUMBLE_START);
/** The {@code TUMBLE_END} auxiliary function of
* the {@code TUMBLE} group function. */
- public static final SqlGroupFunction TUMBLE_END =
+ public static final SqlGroupedWindowFunction TUMBLE_END =
TUMBLE.auxiliary(SqlKind.TUMBLE_END);
/** The {@code HOP} group function. */
- public static final SqlGroupFunction HOP =
- new SqlGroupFunction(SqlKind.HOP, null,
+ public static final SqlGroupedWindowFunction HOP =
+ new SqlGroupedWindowFunction(SqlKind.HOP, null,
OperandTypes.or(OperandTypes.DATETIME_INTERVAL_INTERVAL,
OperandTypes.DATETIME_INTERVAL_INTERVAL_TIME)) {
- @Override List<SqlGroupFunction> getAuxiliaryFunctions() {
+ @Override public List<SqlGroupedWindowFunction> getAuxiliaryFunctions() {
return ImmutableList.of(HOP_START, HOP_END);
}
};
/** The {@code HOP_START} auxiliary function of
* the {@code HOP} group function. */
- public static final SqlGroupFunction HOP_START =
+ public static final SqlGroupedWindowFunction HOP_START =
HOP.auxiliary(SqlKind.HOP_START);
/** The {@code HOP_END} auxiliary function of
* the {@code HOP} group function. */
- public static final SqlGroupFunction HOP_END =
+ public static final SqlGroupedWindowFunction HOP_END =
HOP.auxiliary(SqlKind.HOP_END);
/** The {@code SESSION} group function. */
- public static final SqlGroupFunction SESSION =
- new SqlGroupFunction(SqlKind.SESSION, null,
+ public static final SqlGroupedWindowFunction SESSION =
+ new SqlGroupedWindowFunction(SqlKind.SESSION, null,
OperandTypes.or(OperandTypes.DATETIME_INTERVAL,
OperandTypes.DATETIME_INTERVAL_TIME)) {
- @Override List<SqlGroupFunction> getAuxiliaryFunctions() {
+ @Override public List<SqlGroupedWindowFunction> getAuxiliaryFunctions() {
return ImmutableList.of(SESSION_START, SESSION_END);
}
};
/** The {@code SESSION_START} auxiliary function of
* the {@code SESSION} group function. */
- public static final SqlGroupFunction SESSION_START =
+ public static final SqlGroupedWindowFunction SESSION_START =
SESSION.auxiliary(SqlKind.SESSION_START);
/** The {@code SESSION_END} auxiliary function of
* the {@code SESSION} group function. */
- public static final SqlGroupFunction SESSION_END =
+ public static final SqlGroupedWindowFunction SESSION_END =
SESSION.auxiliary(SqlKind.SESSION_END);
/** {@code |} operator to create alternate patterns
@@ -2178,7 +2179,7 @@ public class SqlStdOperatorTable extends ReflectiveSqlOperatorTable {
/** Returns the group function for which a given kind is an auxiliary
* function, or null if it is not an auxiliary function. */
- public static SqlGroupFunction auxiliaryToGroup(SqlKind kind) {
+ public static SqlGroupedWindowFunction auxiliaryToGroup(SqlKind kind) {
switch (kind) {
case TUMBLE_START:
case TUMBLE_END:
@@ -2201,9 +2202,9 @@ public class SqlStdOperatorTable extends ReflectiveSqlOperatorTable {
* to {@code TUMBLE(rowtime, INTERVAL '1' HOUR))}. */
public static SqlCall convertAuxiliaryToGroupCall(SqlCall call) {
final SqlOperator op = call.getOperator();
- if (op instanceof SqlGroupFunction
+ if (op instanceof SqlGroupedWindowFunction
&& op.isGroupAuxiliary()) {
- return copy(call, ((SqlGroupFunction) op).groupFunction);
+ return copy(call, ((SqlGroupedWindowFunction) op).groupFunction);
}
return null;
}
@@ -2216,12 +2217,12 @@ public class SqlStdOperatorTable extends ReflectiveSqlOperatorTable {
public static List<Pair<SqlNode, AuxiliaryConverter>> convertGroupToAuxiliaryCalls(
SqlCall call) {
final SqlOperator op = call.getOperator();
- if (op instanceof SqlGroupFunction
+ if (op instanceof SqlGroupedWindowFunction
&& op.isGroup()) {
ImmutableList.Builder<Pair<SqlNode, AuxiliaryConverter>> builder =
ImmutableList.builder();
- for (final SqlGroupFunction f
- : ((SqlGroupFunction) op).getAuxiliaryFunctions()) {
+ for (final SqlGroupedWindowFunction f
+ : ((SqlGroupedWindowFunction) op).getAuxiliaryFunctions()) {
builder.add(
Pair.<SqlNode, AuxiliaryConverter>of(copy(call, f),
new AuxiliaryConverter.Impl(f)));
[2/2] calcite git commit: [CALCITE-2021] Document the interfaces that
you can use to extend Calcite
Posted by jh...@apache.org.
[CALCITE-2021] Document the interfaces that you can use to extend Calcite
Document the APIs that people can use to extend Calcite. Examples
include user-defined functions (UDFs), adapters (aka schema
factories), planner rules and metadata.
The tutorial currently tries to cover how to use those extensions, but
there are many incomplete sections. We should remove those sections and a one or
two paragraph description of each extension point in the adapters page. Later we
can add to the tutorial.
Include grouped window functions, per [CALCITE-1867].
Project: http://git-wip-us.apache.org/repos/asf/calcite/repo
Commit: http://git-wip-us.apache.org/repos/asf/calcite/commit/16f1fcf2
Tree: http://git-wip-us.apache.org/repos/asf/calcite/tree/16f1fcf2
Diff: http://git-wip-us.apache.org/repos/asf/calcite/diff/16f1fcf2
Branch: refs/heads/master
Commit: 16f1fcf25617fca22c6bf097161602df17884f06
Parents: f596f92
Author: Julian Hyde <jh...@apache.org>
Authored: Mon Oct 23 18:24:28 2017 -0700
Committer: Julian Hyde <jh...@apache.org>
Committed: Thu Nov 2 16:54:38 2017 -0700
----------------------------------------------------------------------
site/_docs/adapter.md | 407 +++++++++++++++++++++++++++++++++++++++++++-
site/_docs/tutorial.md | 41 +----
2 files changed, 406 insertions(+), 42 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/calcite/blob/16f1fcf2/site/_docs/adapter.md
----------------------------------------------------------------------
diff --git a/site/_docs/adapter.md b/site/_docs/adapter.md
index 2a4695b..1c2a312 100644
--- a/site/_docs/adapter.md
+++ b/site/_docs/adapter.md
@@ -92,15 +92,15 @@ as implemented by Avatica's
| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#LEX">lex</a> | Lexical policy. Values are ORACLE (default), MYSQL, MYSQL_ANSI, SQL_SERVER, JAVA.
| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#MATERIALIZATIONS_ENABLED">materializationsEnabled</a> | Whether Calcite should use materializations. Default false.
| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#MODEL">model</a> | URI of the JSON model file.
-| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#PARSER_FACTORY">parserFactory</a> | Parser factory. The name of a class that implements <a href="{{ site.apiRoot }}/org/apache/calcite/sql/parser/SqlParserImplFactory.html">SqlParserImplFactory</a> and has a public default constructor or an `INSTANCE` constant.
+| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#PARSER_FACTORY">parserFactory</a> | Parser factory. The name of a class that implements [<tt>interface SqlParserImplFactory</tt>]({{ site.apiRoot }}/org/apache/calcite/sql/parser/SqlParserImplFactory.html) and has a public default constructor or an `INSTANCE` constant.
| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#QUOTING">quoting</a> | How identifiers are quoted. Values are DOUBLE_QUOTE, BACK_QUOTE, BRACKET. If not specified, value from `lex` is used.
| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#QUOTED_CASING">quotedCasing</a> | How identifiers are stored if they are quoted. Values are UNCHANGED, TO_UPPER, TO_LOWER. If not specified, value from `lex` is used.
| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#SCHEMA">schema</a> | Name of initial schema.
-| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#SCHEMA_FACTORY">schemaFactory</a> | Schema factory. The name of a class that implements <a href="{{ site.apiRoot }}/org/apache/calcite/schema/SchemaFactory.html">SchemaFactory</a> and has a public default constructor or an `INSTANCE` constant. Ignored if `model` is specified.
+| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#SCHEMA_FACTORY">schemaFactory</a> | Schema factory. The name of a class that implements [<tt>interface SchemaFactory</tt>]({{ site.apiRoot }}/org/apache/calcite/schema/SchemaFactory.html) and has a public default constructor or an `INSTANCE` constant. Ignored if `model` is specified.
| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#SCHEMA_TYPE">schemaType</a> | Schema type. Value must be "MAP" (the default), "JDBC", or "CUSTOM" (implicit if `schemaFactory` is specified). Ignored if `model` is specified.
| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#SPARK">spark</a> | Specifies whether Spark should be used as the engine for processing that cannot be pushed to the source system. If false (the default), Calcite generates code that implements the Enumerable interface.
| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#TIME_ZONE">timeZone</a> | Time zone, for example "gmt-3". Default is the JVM's time zone.
-| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#TYPE_SYSTEM">typeSystem</a> | Type system. The name of a class that implements <a href="{{ site.apiRoot }}/org/apache/calcite/rel/type/RelDataTypeSystem.html">RelDataTypeSystem</a> and has a public default constructor or an `INSTANCE` constant.
+| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#TYPE_SYSTEM">typeSystem</a> | Type system. The name of a class that implements [<tt>interface RelDataTypeSystem</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/type/RelDataTypeSystem.html) and has a public default constructor or an `INSTANCE` constant.
| <a href="{{ site.apiRoot }}/org/apache/calcite/config/CalciteConnectionProperty.html#UNQUOTED_CASING">unquotedCasing</a> | How identifiers are stored if they are not quoted. Values are UNCHANGED, TO_UPPER, TO_LOWER. If not specified, value from `lex` is used.
To make a connection to a single schema based on a built-in schema type, you don't need to specify
@@ -136,3 +136,404 @@ makes a connection to the Cassandra adapter, equivalent to writing the following
{% endhighlight %}
Note how each key in the `operand` section appears with a `schema.` prefix in the connect string.
+
+## Extensibility
+
+There are many other APIs that allow you to extend Calcite's capabilities.
+
+In this section, we briefly describe those APIs, to give you an idea what is
+possible. To fully use these APIs you will need to read other documentation
+such as the javadoc for the interfaces, and possibly seek out the tests that
+we have written for them.
+
+### Functions and operators
+
+There are several ways to add operators or functions to Calcite.
+We'll describe the simplest (and least powerful) first.
+
+*User-defined functions* are the simplest (but least powerful).
+They are straightforward to write (you just write a Java class and register it
+in your schema) but do not offer much flexibility in the number and type of
+arguments, resolving overloaded functions, or deriving the return type.
+
+It you want that flexibility, you probably need to write you a
+*user-defined operator*
+(see [<tt>interface SqlOperator</tt>]({{ site.apiRoot }}/org/apache/calcite/sql/SqlOperator.html)).
+
+If your operator does not adhere to standard SQL function syntax,
+"`f(arg1, arg2, ...)`", then you need to
+[extend the parser](#extending-the-parser).
+
+There are many good examples in the tests:
+[<tt>class UdfTest</tt>]({{ site.sourceRoot }}/core/src/test/java/org/apache/calcite/test/UdfTest.java)
+tests user-defined functions and user-defined aggregate functions.
+
+### Aggregate functions
+
+*User-defined aggregate functions* are similar to user-defined functions,
+but each function has several corresponding Java methods, one for each
+stage in the life-cycle of an aggregate:
+
+* `init` creates an accumulator;
+* `add` adds one row's value to an accumulator;
+* `merge` combines two accumulators into one;
+* `result` finalizes an accumulator and converts it to a result.
+
+For example, the methods (in pseudo-code) for `SUM(int)` are as follows:
+
+{% highlight java %}
+struct Accumulator {
+ final int sum;
+}
+Accumulator init() {
+ return new Accumulator(0);
+}
+Accumulator add(Accumulator a, int x) {
+ return new Accumulator(a.sum + x);
+}
+Accumulator merge(Accumulator a, Accumulator a2) {
+ return new Accumulator(a.sum + a2.sum);
+}
+int result(Accumulator a) {
+ return new Accumulator(a.sum + x);
+}
+{% endhighlight %}
+
+Here is the sequence of calls to compute the sum of two rows with column values 4 and 7:
+
+{% highlight java %}
+a = init() # a = {0}
+a = add(a, 4) # a = {4}
+a = add(a, 7) # a = {11}
+return result(a) # returns 11
+{% endhighlight %}
+
+### Window functions
+
+A window function is similar to an aggregate function but it is applied to a set
+of rows gathered by an `OVER` clause rather than by a `GROUP BY` clause.
+Every aggregate function can be used as a window function, but there are some
+key differences. The rows seen by a window function may be ordered, and
+window functions that rely upon order (`RANK`, for example) cannot be used as
+aggregate functions.
+
+Another difference is that windows are *non-disjoint*: a particular row can
+appear in more than one window. For example, 10:37 appears in both the
+9:00-10:00 hour and also the 9:15-9:45 hour.
+
+Window functions are computed incrementally: when the clock ticks from
+10:14 to 10:15, two rows might enter the window and three rows leave.
+For this, window functions have have an extra life-cycle operation:
+
+* `remove` removes a value from an accumulator.
+
+It pseudo-code for `SUM(int)` would be:
+
+{% highlight java %}
+Accumulator remove(Accumulator a, int x) {
+ return new Accumulator(a.sum - x);
+}
+{% endhighlight %}
+
+Here is the sequence of calls to compute the moving sum,
+over the previous 2 rows, of 4 rows with values 4, 7, 2 and 3:
+
+{% highlight java %}
+a = init() # a = {0}
+a = add(a, 4) # a = {4}
+emit result(a) # emits 4
+a = add(a, 7) # a = {11}
+emit result(a) # emits 11
+a = remove(a, 4) # a = {7}
+a = add(a, 2) # a = {9}
+emit result(a) # emits 9
+a = remove(a, 7) # a = {2}
+a = add(a, 3) # a = {5}
+emit result(a) # emits 5
+{% endhighlight %}
+
+### Grouped window functions
+
+Grouped window functions are functions that operate the `GROUP BY` clause
+to gather together records into sets. The built-in grouped window functions
+are `HOP`, `TUMBLE` and `SESSION`.
+You can define additional functions by implementing
+[<tt>interface SqlGroupedWindowFunction</tt>]({{ site.apiRoot }}/org/apache/calcite/sql/fun/SqlGroupedWindowFunction.html).
+
+### Table functions and table macros
+
+*User-defined table functions*
+are defined in a similar way to regular "scalar" user-defined functions,
+but are used in the `FROM` clause of a query. The following query uses a table
+function called `Ramp`:
+
+{% highlight sql %}
+SELECT * FROM TABLE(Ramp(3, 4))
+{% endhighlight %}
+
+*User-defined table macros* use the same SQL syntax as table functions,
+but are defined differently. Rather than generating data, they generate an
+relational expression.
+Table macros are invoked during query preparation and the relational expression
+they produce can then be optimized.
+(Calcite's implementation of views uses table macros.)
+
+[<tt>class TableFunctionTest</tt>]({{ site.sourceRoot }}/core/src/test/java/org/apache/calcite/test/TableFunctionTest.java)
+tests table functions and contains several useful examples.
+
+### Extending the parser
+
+Suppose you need to extend Calcite's SQL grammar in a way that will be
+compatible with future changes to the grammar. Making a copy of the grammar file
+`Parser.jj` in your project would be foolish, because the grammar is edited
+quite frequently.
+
+Fortunately, `Parser.jj` is actually an
+[Apache FreeMarker](http://freemarker.apache.org/)
+template that contains variables that can be substituted.
+The parser in `calcite-core` instantiates the template with default values of
+the variables, typically empty, but you can override.
+If your project would like a different parser, you can provide your
+own `config.fmpp` and `parserImpls.ftl` files and therefore generate an
+extended parser.
+
+The `calcite-server` module, which was created in
+[[CALCITE-707](https://issues.apache.org/jira/browse/CALCITE-707)] and
+adds DDL statements such as `CREATE TABLE`, is an example that you could follow.
+Also see
+[<tt>class ExtensionSqlParserTest</tt>]({{ site.sourceRoot }}/core/src/test/java/org/apache/calcite/sql/parser/parserextensiontesting/ExtensionSqlParserTest.java).
+
+### Customizing SQL dialect accepted and generated
+
+To customize what SQL extensions the parser should accept, implement
+[<tt>interface SqlConformance</tt>]({{ site.apiRoot }}/org/apache/calcite/sql/validate/SqlConformance.html)
+or use one of the built-in values in
+[<tt>enum SqlConformanceEnum</tt>]({{ site.apiRoot }}/org/apache/calcite/sql/validate/SqlConformanceEnum.html).
+
+To control how SQL is generated for an external database (usually via the JDBC
+adapter), use
+[<tt>class SqlDialect</tt>]({{ site.apiRoot }}/org/apache/calcite/sql/SqlDialect.html).
+The dialect also describes the engine's capabilities, such as whether it
+supports `OFFSET` and `FETCH` clauses.
+
+### Defining a custom schema
+
+To define a custom schema, you need to implement
+[<tt>interface SchemaFactory</tt>]({{ site.apiRoot }}/org/apache/calcite/schema/SchemaFactory.html).
+
+During query preparation, Calcite will call this interface to find out
+what tables and sub-schemas your schema contains. When a table in your schema
+is referenced in a query, Calcite will ask your schema to create an instance of
+[<tt>interface Table</tt>]({{ site.apiRoot }}/org/apache/calcite/schema/Table.html).
+
+That table will be wrapped in a
+[<tt>TableScan</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/TableScan.html)
+and will undergo the query optimization process.
+
+### Reflective schema
+
+A reflective schema
+([<tt>class ReflectiveSchema</tt>]({{ site.apiRoot }}/org/apache/calcite/adapter/java/ReflectiveSchema.html))
+is a way of wrapping a Java object so that it appears
+as a schema. Its collection-valued fields will appear as tables.
+
+It is not a schema factory but an actual schema; you have to create the object
+and wrap it in the schema by calling APIs.
+
+See
+[<tt>class ReflectiveSchemaTest</tt>]({{ site.sourceRoot }}/core/src/test/java/org/apache/calcite/test/ReflectiveSchemaTest.java).
+
+### Defining a custom table
+
+To define a custom table, you need to implement
+[<tt>interface TableFactory</tt>]({{ site.apiRoot }}/org/apache/calcite/schema/TableFactory.html).
+Whereas a schema factory a set of named tables, a table factory produces a
+single table when bound to a schema with a particular name (and optionally a
+set of extra operands).
+
+### Modifying data
+
+If your table is to support DML operations (INSERT, UPDATE, DELETE, MERGE),
+your implementation of `interface Table` must implement
+[<tt>interface ModifiableTable</tt>]({{ site.apiRoot }}/org/apache/calcite/schema/ModifiableTable.html).
+
+### Streaming
+
+If your table is to support streaming queries,
+your implementation of `interface Table` must implement
+[<tt>interface StreamableTable</tt>]({{ site.apiRoot }}/org/apache/calcite/schema/StreamableTable.html).
+
+See
+[<tt>class StreamTest</tt>]({{ site.sourceRoot }}/core/src/test/java/org/apache/calcite/test/StreamTest.java)
+for examples.
+
+### Pushing operations down to your table
+
+If you wish to push processing down to your custom table's source system,
+consider implementing either
+[<tt>interface FilterableTable</tt>]({{ site.apiRoot }}/org/apache/calcite/schema/FilterableTable.html)
+or
+[<tt>interface ProjectableFilterableTable</tt>]({{ site.apiRoot }}/org/apache/calcite/schema/ProjectableFilterableTable.html).
+
+If you want more control, you should write a [planner rule](#planner-rule).
+This will allow you to push down expressions, to make a cost-based decision
+about whether to push down processing, and push down more complex operations
+such as join, aggregation, and sort.
+
+### Type system
+
+You can customize some aspects of the type system by implementing
+[<tt>interface RelDataTypeSystem</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/type/RelDataTypeSystem.html).
+
+### Relational operators
+
+All relational operators implement
+[<tt>interface RelNode</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/RelNode.html)
+and most extend
+[<tt>class AbstractRelNode</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/AbstractRelNode.html).
+The core operators (used by
+[<tt>SqlToRelConverter</tt>]({{ site.apiRoot }}/org/apache/calcite/sql2rel/SqlToRelConverter.html)
+and covering conventional relational algebra) are
+[<tt>TableScan</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/TableScan.html),
+[<tt>TableModify</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/TableModify.html),
+[<tt>Values</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/Values.html),
+[<tt>Project</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/Project.html),
+[<tt>Filter</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/Filter.html),
+[<tt>Aggregate</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/Aggregate.html),
+[<tt>Join</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/Join.html),
+[<tt>Sort</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/Sort.html),
+[<tt>Union</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/Union.html),
+[<tt>Intersect</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/Intersect.html),
+[<tt>Minus</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/Minus.html),
+[<tt>Window</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/Window.html) and
+[<tt>Match</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/Match.html).
+
+Each of these has a "pure" logical sub-class,
+[<tt>LogicalProject</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/logical/LogicalProject.html)
+and so forth. Any given adapter will have counterparts for the operations that
+its engine can implement efficiently; for example, the Cassandra adapter has
+[<tt>CassandraProject</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/cassandra/CassandraProject.html)
+but there is no `CassandraJoin`.
+
+You can define your own sub-class of `RelNode` to add a new operator, or
+an implementation of an existing operator in a particular engine.
+
+To make an operator useful and powerful, you will need
+[planner rules](#planner-rule) to combine it with existing operators.
+(And also provide metadata, see [below](#statistics-and-cost)).
+This being algebra, the effects are combinatorial: you write a few
+rules, but they combine to handle an exponential number of query patterns.
+
+If possible, make your operator a sub-class of an existing
+operator; then you may be able to re-use or adapt its rules.
+Even better, if your operator is a logical operation that you can rewrite
+(again, via a planner rule) in terms of existing operators, you should do that.
+You will be able to re-use the rules, metadata and implementations of those
+operators with no extra work.
+
+### Planner rule
+
+A planner rule
+([<tt>class RelOptRule</tt>]({{ site.apiRoot }}/org/apache/calcite/plan/RelOptRule.html))
+transforms a relational expression into an equivalent relational expression.
+
+A planner engine has many planner rules registered and fires them
+to transform the input query into something more efficient. Planner rules are
+therefore central to the optimization process, but surprisingly each planner
+rule does not concern itself with cost. The planner engine is responsible for
+firing rules in a sequence that produces an optimal plan, but each individual
+rules only concerns itself with correctness.
+
+Calcite has two built-in planner engines:
+[<tt>class VolcanoPlanner</tt>]({{ site.apiRoot }}/org/apache/calcite/plan/volcano/VolcanoPlanner.html)
+uses dynamic programming and is good for exhaustive search, whereas
+[<tt>class HepPlanner</tt>]({{ site.apiRoot }}/org/apache/calcite/plan/hep/HepPlanner.html)
+fires a sequence of rules in a more fixed order.
+
+### Calling conventions
+
+A calling convention is a protocol used by a particular data engine.
+For example, the Cassandra engine has a collection of relational operators,
+`CassandraProject`, `CassandraFilter` and so forth, and these operators can be
+connected to each other without the data having to be converted from one format
+to another.
+
+If data needs to be converted from one calling convention to another, Calcite
+uses a special sub-class of relational expression called a converter
+(see [<tt>class Converter</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/convert/Converter.html)).
+But of course converting data has a runtime cost.
+
+When planning a query that uses multiple engines, Calcite "colors" regions of
+the relational expression tree according to their calling convention. The
+planner pushes operations into data sources by firing rules. If the engine does
+not support a particular operation, the rule will not fire. Sometimes an
+operation can occur in more than one place, and ultimately the best plan is
+chosen according to cost.
+
+A calling convention is a class that implements
+[<tt>interface Convention</tt>]({{ site.apiRoot }}/org/apache/calcite/plan/Convention.html),
+an auxiliary interface (for instance
+[<tt>interface CassandraRel</tt>]({{ site.apiRoot }}/org/apache/calcite/adapter/cassandra/CassandraRel.html)),
+and a set of sub-classes of
+[<tt>class RelNode</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/RelNode.html)
+that implement that interface for the core relational operators
+([<tt>Project</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/Project.html),
+[<tt>Filter</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/Filter.html),
+[<tt>Aggregate</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/core/Aggregate.html),
+and so forth).
+
+### Built-in SQL implementation
+
+How does Calcite implement SQL, if an adapter does not implement all of the core
+relational operators?
+
+The answer is a particular built-in calling convention,
+[<tt>EnumerableConvention</tt>]({{ site.apiRoot }}/org/apache/calcite/adapter/EnumerableConvention.html).
+Relational expressions of enumerable convention are implemented as "built-ins":
+Calcite generates Java code, compiles it, and executes inside its own JVM.
+Enumerable convention is less efficient than, say, a distributed engine
+running over column-oriented data files, but it can implement all core
+relational operators and all built-in SQL functions and operators. If a data
+source cannot an implement a relational operator, enumerable convention is
+a fall-back.
+
+### Statistics and cost
+
+Calcite has a metadata system that allow you to define cost functions and
+statistics about relational operators, collectively referred to as *metadata*.
+Each kind of metadata has an interface with (usually) one method.
+For example, selectivity is defined by
+[<tt>interface RelMdSelectivity</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdSelectivity.html)
+and the method
+[<tt>getSelectivity(RelNode rel, RexNode predicate)</tt>]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMetadataQuery.html#getSelectivity-org.apache.calcite.rel.RelNode-org.apache.calcite.rex.RexNode-).
+
+There are many built-in kinds of metadata, including
+[collation]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdCollation.html),
+[column origins]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdColumnOrigins.html),
+[column uniqueness]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdColumnUniqueness.html),
+[distinct row count]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdDistinctRowCount.html),
+[distribution]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdDistribution.html),
+[explain visibility]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdExplainVisibility.html),
+[expression lineage]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdExpressionLineage.html),
+[max row count]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdMaxRowCount.html),
+[node types]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdNodeTypes.html),
+[parallelism]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdParallelism.html),
+[percentage original rows]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdPercentageOriginalRows.html),
+[population size]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdPopulationSize.html),
+[predicates]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdPredicates.html),
+[row count]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdRowCount.html),
+[selectivity]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdSelectivity.html),
+[size]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdSize.html),
+[table references]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdTableReferences.html),
+[unique keys]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdUniqueKeys.html), and
+[selectivity]({{ site.apiRoot }}/org/apache/calcite/rel/metadata/RelMdSelectivity.html);
+you can also define your own.
+
+You can then supply a *metadata provider* that computes that kind of metadata
+for particular sub-classes of `RelNode`. Metadata providers can handle built-in
+and extended metadata types, and built-in and extended `RelNode` types.
+While preparing a query Calcite combines all of the applicable metadata
+providers and maintains a cache so that a given piece of metadata (for example
+the selectivity of the condition `x > 10` in a particular `Filter` operator)
+is computed only once.
+
http://git-wip-us.apache.org/repos/asf/calcite/blob/16f1fcf2/site/_docs/tutorial.md
----------------------------------------------------------------------
diff --git a/site/_docs/tutorial.md b/site/_docs/tutorial.md
index c907cef..2a6e91e 100644
--- a/site/_docs/tutorial.md
+++ b/site/_docs/tutorial.md
@@ -718,43 +718,6 @@ initial implementations.
## Further topics
-### Defining a custom schema
+There are many other ways to extend Calcite not yet described in this tutorial.
+The [adapter specification](adapter.html) describes the APIs involved.
-(To be written.)
-
-### Modifying data
-
-How to enable DML operations (INSERT, UPDATE and DELETE) on your schema.
-
-(To be written.)
-
-### Calling conventions
-
-(To be written.)
-
-### Statistics and cost
-
-(To be written.)
-
-### Defining and using user-defined functions
-
-(To be written.)
-
-### Defining tables in a schema
-
-(To be written.)
-
-### Defining custom tables
-
-(To be written.)
-
-### Built-in SQL implementation
-
-How does Calcite implement SQL, if an adapter does not implement all of the core
-relational operators?
-
-(To be written.)
-
-### Table functions
-
-(To be written.)