org.apache.calcite.util

Class Bug

java.lang.Object

org.apache.calcite.util.Bug

public abstract class Bug
extends Object

Holder for a list of constants describing which bugs which have not been fixed.

You can use these constants to control the flow of your code. For example, suppose that bug CALCITE-123 causes the "INSERT" statement to return an incorrect row-count, and you want to disable unit tests. You might use the constant in your code as follows:

Statement stmt = connection.createStatement();
 int rowCount = stmt.execute(
     "INSERT INTO FemaleEmps SELECT * FROM Emps WHERE gender = 'F'");
 if (Bug.CALCITE_123_FIXED) {
    assertEquals(rowCount, 5);
 }

The usage of the constant is a convenient way to identify the impact of the bug. When someone fixes the bug, they will remove the constant and all usages of it. Also, the constant helps track the propagation of the fix: as the fix is integrated into other branches, the constant will be removed from those branches.

To do

The following is a list of tasks to be completed before committing to master branch.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CALCITE_194_FIXED Whether [CALCITE-194] Array items in MongoDB adapter is fixed.
static boolean	CALCITE_319_FIXED Whether [CALCITE-319] Table aliases should follow case-sensitivity policy is fixed.
static boolean	CALCITE_461_FIXED Whether [CALCITE-461] Convert more planner rules to handle grouping sets is fixed.
static boolean	CALCITE_673_FIXED Whether [CALCITE-673] Timeout executing joins against MySQL is fixed.
static boolean	DT1684_FIXED Whether dtbug1684 "CURRENT_DATE not implemented in fennel calc" is fixed.
static boolean	DT239_FIXED
static boolean	DT785_FIXED
static boolean	FNL25_FIXED Whether issue FNL-25 is fixed.
static boolean	FNL3_FIXED Whether issue Fnl-3 is fixed.
static boolean	FRG187_FIXED Whether issue FRG-187: FarragoAutoVmOperatorTest.testOverlapsOperator fails is fixed.
static boolean	FRG189_FIXED Whether issue FRG-189: FarragoAutoVmOperatorTest.testSelect fails is fixed.
static boolean	FRG254_FIXED Whether issue FRG-254: environment-dependent failure for SqlOperatorTest.testPrefixPlusOperator is fixed.
static boolean	FRG282_FIXED Whether issue FRG-282: Support precision in TIME and TIMESTAMP data types is fixed.
static boolean	FRG296_FIXED Whether issue FRG-296: SUBSTRING(string FROM regexp FOR regexp) is fixed.
static boolean	FRG327_FIXED Whether issue FRG-327: AssertionError while translating IN list that contains null is fixed.
static boolean	FRG375_FIXED Whether issue FRG-375: The expression VALUES ('cd' SIMILAR TO '[a-e^c]d') returns TRUE.
static boolean	FRG377_FIXED Whether issue FRG-377: Regular character set identifiers defined in SQL:2008 spec like :ALPHA:, * :UPPER:, :LOWER:, ...
static boolean	FRG73_FIXED Whether issue FRG-73: miscellaneous bugs with nested comments is fixed.
static boolean	FRG78_FIXED Whether issue FRG-78: collation clause should be on expression instead of identifier is fixed.
static boolean	TODO_FIXED Use this to flag temporary code.

Constructor Summary

Constructors

Constructor and Description
Bug()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> T	remark(T remark) Use this method to flag temporary code.
static boolean	upgrade(String remark) Use this method to flag code that should be re-visited after upgrading a component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DT239_FIXED

public static final boolean DT239_FIXED

See Also:

Constant Field Values

DT785_FIXED

public static final boolean DT785_FIXED

See Also:

Constant Field Values

FNL3_FIXED

public static final boolean FNL3_FIXED

Whether issue Fnl-3 is fixed.

See Also:

Constant Field Values

FRG327_FIXED

public static final boolean FRG327_FIXED

Whether issue FRG-327: AssertionError while translating IN list that contains null is fixed.

See Also:

Constant Field Values

FRG377_FIXED

public static final boolean FRG377_FIXED

Whether issue FRG-377: Regular character set identifiers defined in SQL:2008 spec like :ALPHA:, * :UPPER:, :LOWER:, ... etc. are not yet implemented in SIMILAR TO expressions. is fixed.

See Also:

Constant Field Values

DT1684_FIXED

public static final boolean DT1684_FIXED

Whether dtbug1684 "CURRENT_DATE not implemented in fennel calc" is fixed.

See Also:

Constant Field Values

FNL25_FIXED

public static final boolean FNL25_FIXED

Whether issue FNL-25 is fixed. (also filed as dtbug 153)

See Also:

Constant Field Values

FRG73_FIXED

public static final boolean FRG73_FIXED

Whether issue FRG-73: miscellaneous bugs with nested comments is fixed.

See Also:

Constant Field Values

FRG78_FIXED

public static final boolean FRG78_FIXED

Whether issue FRG-78: collation clause should be on expression instead of identifier is fixed.

See Also:

Constant Field Values

FRG187_FIXED

public static final boolean FRG187_FIXED

Whether issue FRG-187: FarragoAutoVmOperatorTest.testOverlapsOperator fails is fixed.

See Also:

Constant Field Values

FRG189_FIXED

public static final boolean FRG189_FIXED

Whether issue FRG-189: FarragoAutoVmOperatorTest.testSelect fails is fixed.

See Also:

Constant Field Values

FRG254_FIXED

public static final boolean FRG254_FIXED

Whether issue FRG-254: environment-dependent failure for SqlOperatorTest.testPrefixPlusOperator is fixed.

See Also:

Constant Field Values

FRG282_FIXED

public static final boolean FRG282_FIXED

Whether issue FRG-282: Support precision in TIME and TIMESTAMP data types is fixed.

See Also:

Constant Field Values

FRG296_FIXED

public static final boolean FRG296_FIXED

Whether issue FRG-296: SUBSTRING(string FROM regexp FOR regexp) is fixed.

See Also:

Constant Field Values

FRG375_FIXED

public static final boolean FRG375_FIXED

Whether issue FRG-375: The expression VALUES ('cd' SIMILAR TO '[a-e^c]d') returns TRUE. It should return FALSE. is fixed.

See Also:

Constant Field Values

CALCITE_194_FIXED

public static final boolean CALCITE_194_FIXED

Whether [CALCITE-194] Array items in MongoDB adapter is fixed.

See Also:

Constant Field Values

CALCITE_319_FIXED

public static final boolean CALCITE_319_FIXED

Whether [CALCITE-319] Table aliases should follow case-sensitivity policy is fixed.

See Also:

Constant Field Values

CALCITE_461_FIXED

public static final boolean CALCITE_461_FIXED

Whether [CALCITE-461] Convert more planner rules to handle grouping sets is fixed.

See Also:

Constant Field Values

CALCITE_673_FIXED

public static final boolean CALCITE_673_FIXED

Whether [CALCITE-673] Timeout executing joins against MySQL is fixed.

See Also:

Constant Field Values

TODO_FIXED

public static final boolean TODO_FIXED

Use this to flag temporary code.

See Also:

Constant Field Values

Constructor Detail

Bug

public Bug()

Method Detail

remark

public static <T> T remark(T remark)

Use this method to flag temporary code.

Example #1:

 if (Bug.remark("baz fixed") == null) {
   baz();
 }

Example #2:

 /** @see Bug#remark Remove before checking in */
 void uselessMethod() {}
 

upgrade

public static boolean upgrade(String remark)

Use this method to flag code that should be re-visited after upgrading a component.

If the intended change is that a class or member be removed, flag instead using a Deprecated annotation followed by a comment such as "to be removed before 2.0".