How to use

family

method

in

org.apache.calcite.sql.type.OperandTypes

 public SqlFunction build()
 {
  return new SqlFunction(
    name,
    kind,
    Preconditions.checkNotNull(returnTypeInference, "returnTypeInference"),
    null,
    OperandTypes.family(
      Preconditions.checkNotNull(operandTypes, "operandTypes"),
      i -> i + 1 > requiredOperands
    ),
    functionCategory
  );
 }
}

 QuantileSqlAggFunction()
 {
  super(
    NAME,
    null,
    SqlKind.OTHER_FUNCTION,
    ReturnTypes.explicit(SqlTypeName.DOUBLE),
    null,
    OperandTypes.or(
      OperandTypes.and(
        OperandTypes.sequence(SIGNATURE1, OperandTypes.ANY, OperandTypes.LITERAL),
        OperandTypes.family(SqlTypeFamily.ANY, SqlTypeFamily.NUMERIC)
      ),
      OperandTypes.and(
        OperandTypes.sequence(SIGNATURE2, OperandTypes.ANY, OperandTypes.LITERAL, OperandTypes.LITERAL),
        OperandTypes.family(SqlTypeFamily.ANY, SqlTypeFamily.NUMERIC, SqlTypeFamily.EXACT_NUMERIC)
      )
    ),
    SqlFunctionCategory.NUMERIC,
    false,
    false
  );
 }
}

private static CalciteUDFInfo getUDFInfo(String hiveUdfName,
  ImmutableList<RelDataType> calciteArgTypes, RelDataType calciteRetType) {
 CalciteUDFInfo udfInfo = new CalciteUDFInfo();
 udfInfo.udfName = hiveUdfName;
 udfInfo.returnTypeInference = ReturnTypes.explicit(calciteRetType);
 udfInfo.operandTypeInference = InferTypes.explicit(calciteArgTypes);
 ImmutableList.Builder<SqlTypeFamily> typeFamilyBuilder = new ImmutableList.Builder<SqlTypeFamily>();
 for (RelDataType at : calciteArgTypes) {
  typeFamilyBuilder.add(Util.first(at.getSqlTypeName().getFamily(), SqlTypeFamily.ANY));
 }
 udfInfo.operandTypeChecker = OperandTypes.family(typeFamilyBuilder.build());
 return udfInfo;
}

SqlAggFunction createCustomAggFunction(String funcName, RelDataType returnType, Class<?> customAggFuncClz) {
  RelDataTypeFactory typeFactory = getCluster().getTypeFactory();
  SqlIdentifier sqlIdentifier = new SqlIdentifier(funcName, new SqlParserPos(1, 1));
  AggregateFunction aggFunction = AggregateFunctionImpl.create(customAggFuncClz);
  List<RelDataType> argTypes = new ArrayList<RelDataType>();
  List<SqlTypeFamily> typeFamilies = new ArrayList<SqlTypeFamily>();
  for (FunctionParameter o : aggFunction.getParameters()) {
    final RelDataType type = o.getType(typeFactory);
    argTypes.add(type);
    typeFamilies.add(Util.first(type.getSqlTypeName().getFamily(), SqlTypeFamily.ANY));
  }
  return new SqlUserDefinedAggFunction(sqlIdentifier, ReturnTypes.explicit(returnType),
      InferTypes.explicit(argTypes), OperandTypes.family(typeFamilies), aggFunction, false, false,
      typeFactory);
}

private static CalciteUDFInfo getUDFInfo(String hiveUdfName,
  ImmutableList<RelDataType> calciteArgTypes, RelDataType calciteRetType) {
 CalciteUDFInfo udfInfo = new CalciteUDFInfo();
 udfInfo.udfName = hiveUdfName;
 udfInfo.returnTypeInference = ReturnTypes.explicit(calciteRetType);
 udfInfo.operandTypeInference = InferTypes.explicit(calciteArgTypes);
 ImmutableList.Builder<SqlTypeFamily> typeFamilyBuilder = new ImmutableList.Builder<SqlTypeFamily>();
 for (RelDataType at : calciteArgTypes) {
  typeFamilyBuilder.add(Util.first(at.getSqlTypeName().getFamily(), SqlTypeFamily.ANY));
 }
 udfInfo.operandTypeChecker = OperandTypes.family(typeFamilyBuilder.build());
 return udfInfo;
}

 SqlTimestampDiffFunction() {
  super("TIMESTAMPDIFF", SqlKind.TIMESTAMP_DIFF,
    RETURN_TYPE_INFERENCE, null,
    OperandTypes.family(SqlTypeFamily.ANY, SqlTypeFamily.DATETIME,
      SqlTypeFamily.DATETIME),
    SqlFunctionCategory.TIMEDATE);
 }
}

 /** Creates a SqlTimestampAddFunction. */
 SqlTimestampAddFunction() {
  super("TIMESTAMPADD", SqlKind.TIMESTAMP_ADD, RETURN_TYPE_INFERENCE, null,
    OperandTypes.family(SqlTypeFamily.ANY, SqlTypeFamily.INTEGER,
      SqlTypeFamily.DATETIME),
    SqlFunctionCategory.TIMEDATE);
 }
}

 /** Creates a SqlTimestampAddFunction. */
 SqlTimestampAddFunction() {
  super("TIMESTAMPADD", SqlKind.TIMESTAMP_ADD, RETURN_TYPE_INFERENCE, null,
    OperandTypes.family(SqlTypeFamily.ANY, SqlTypeFamily.INTEGER,
      SqlTypeFamily.DATETIME),
    SqlFunctionCategory.TIMEDATE);
 }
}

 SqlTimestampDiffFunction() {
  super("TIMESTAMPDIFF", SqlKind.TIMESTAMP_DIFF,
    RETURN_TYPE_INFERENCE, null,
    OperandTypes.family(SqlTypeFamily.ANY, SqlTypeFamily.DATETIME,
      SqlTypeFamily.DATETIME),
    SqlFunctionCategory.TIMEDATE);
 }
}

/**
 * Creates a checker that passes if each operand is a member of a
 * corresponding family.
 */
public static FamilyOperandTypeChecker family(List<SqlTypeFamily> families) {
 return family(families, i -> false);
}

/**
 * Creates a checker that passes if each operand is a member of a
 * corresponding family.
 */
public static FamilyOperandTypeChecker family(List<SqlTypeFamily> families) {
 return family(families, i -> false);
}

public SqlJsonArrayAggAggFunction(String name,
  SqlJsonConstructorNullClause nullClause) {
 super(name, null, SqlKind.JSON_ARRAYAGG, ReturnTypes.VARCHAR_2000, null,
   OperandTypes.family(SqlTypeFamily.ANY), SqlFunctionCategory.SYSTEM,
   false, false, Optionality.FORBIDDEN);
 this.nullClause = Objects.requireNonNull(nullClause);
}

/** Creates a SqlJsonObjectAggAggFunction. */
public SqlJsonObjectAggAggFunction(String name,
  SqlJsonConstructorNullClause nullClause) {
 super(name, null, SqlKind.JSON_OBJECTAGG, ReturnTypes.VARCHAR_2000, null,
   OperandTypes.family(SqlTypeFamily.CHARACTER, SqlTypeFamily.ANY),
   SqlFunctionCategory.SYSTEM, false, false, Optionality.FORBIDDEN);
 this.nullClause = Objects.requireNonNull(nullClause);
}

public SqlJsonQueryFunction() {
 super("JSON_QUERY", SqlKind.OTHER_FUNCTION,
   ReturnTypes.cascade(ReturnTypes.VARCHAR_2000,
     SqlTypeTransforms.FORCE_NULLABLE),
   null,
   OperandTypes.family(SqlTypeFamily.ANY,
     SqlTypeFamily.ANY, SqlTypeFamily.ANY, SqlTypeFamily.ANY),
   SqlFunctionCategory.SYSTEM);
}

public SqlJsonApiCommonSyntaxOperator() {
 super("JSON_API_COMMON_SYNTAX", SqlKind.JSON_API_COMMON_SYNTAX, 100, true,
   ReturnTypes.explicit(SqlTypeName.ANY), null,
   OperandTypes.family(SqlTypeFamily.ANY, SqlTypeFamily.STRING));
}

private SqlSingleOperandTypeChecker getChecker(RelDataType operandType) {
 switch (operandType.getSqlTypeName()) {
 case ARRAY:
  return OperandTypes.family(SqlTypeFamily.INTEGER);
 case MAP:
  return OperandTypes.family(
    operandType.getKeyType().getSqlTypeName().getFamily());
 case ANY:
 case DYNAMIC_STAR:
  return OperandTypes.or(
    OperandTypes.family(SqlTypeFamily.INTEGER),
    OperandTypes.family(SqlTypeFamily.CHARACTER));
 default:
  throw new AssertionError(operandType.getSqlTypeName());
 }
}

private SqlSingleOperandTypeChecker getChecker(RelDataType operandType) {
 switch (operandType.getSqlTypeName()) {
 case ROW:
  return OperandTypes.family(SqlTypeFamily.STRING);
 default:
  throw new AssertionError(operandType.getSqlTypeName());
 }
}

private SqlSingleOperandTypeChecker getChecker(RelDataType operandType) {
 switch (operandType.getSqlTypeName()) {
 case ROW:
  return OperandTypes.family(SqlTypeFamily.STRING);
 default:
  throw new AssertionError(operandType.getSqlTypeName());
 }
}

SqlAggFunction createCustomAggFunction(String funcName, RelDataType returnType, Class<?> customAggFuncClz) {
  RelDataTypeFactory typeFactory = getCluster().getTypeFactory();
  SqlIdentifier sqlIdentifier = new SqlIdentifier(funcName, new SqlParserPos(1, 1));
  AggregateFunction aggFunction = AggregateFunctionImpl.create(customAggFuncClz);
  List<RelDataType> argTypes = new ArrayList<RelDataType>();
  List<SqlTypeFamily> typeFamilies = new ArrayList<SqlTypeFamily>();
  for (FunctionParameter o : aggFunction.getParameters()) {
    final RelDataType type = o.getType(typeFactory);
    argTypes.add(type);
    typeFamilies.add(Util.first(type.getSqlTypeName().getFamily(), SqlTypeFamily.ANY));
  }
  return new SqlUserDefinedAggFunction(sqlIdentifier, ReturnTypes.explicit(returnType),
      InferTypes.explicit(argTypes), OperandTypes.family(typeFamilies), aggFunction, false, false,
      typeFactory);
}

private static CalciteUDFInfo getUDFInfo(String hiveUdfName,
  ImmutableList<RelDataType> calciteArgTypes, RelDataType calciteRetType) {
 CalciteUDFInfo udfInfo = new CalciteUDFInfo();
 udfInfo.udfName = hiveUdfName;
 udfInfo.returnTypeInference = ReturnTypes.explicit(calciteRetType);
 udfInfo.operandTypeInference = InferTypes.explicit(calciteArgTypes);
 ImmutableList.Builder<SqlTypeFamily> typeFamilyBuilder = new ImmutableList.Builder<SqlTypeFamily>();
 for (RelDataType at : calciteArgTypes) {
  typeFamilyBuilder.add(Util.first(at.getSqlTypeName().getFamily(), SqlTypeFamily.ANY));
 }
 udfInfo.operandTypeChecker = OperandTypes.family(typeFamilyBuilder.build());
 udfInfo.argTypes = ImmutableList.<RelDataType> copyOf(calciteArgTypes);
 udfInfo.retType = calciteRetType;
 return udfInfo;
}