skeema / skeema / 6254842008

92%

push

github

diff/push: new option lax-comments for suppressing comment-only diffs

This commit adds the ability to ignore discrepancies in COMMENT clauses when
using `skeema diff` or `skeema push`. This behavior is controlled by new
option lax-comments, which isn't enabled by default. When enabled, comment-
only differences are suppressed as follows:

* Column-level COMMENT clause differences are ignored if there are no other
  differences in the column definition.

* Index-level COMMENT clause differences are ignored if there are no other
  changes to the index definition, or if there is only a change in visibility
  (INVISIBLE / IGNORED).

* Table-level COMMENT clause differences are ignored if there are no other
  ALTER clauses being generated for the table.

* Routine-level COMMENT clause differences are ignored if there are no other
  changes in the routine definition.

This option is intended for use in situations where some environments have
slightly different COMMENT clauses, caused by historical schema drift /
technical debt.

This option does not affect creation of new tables, columns, indexes, or
routines. Any COMMENT clauses present for a new object will still be used
as-is per the definition in the .sql file.

74 of 74 new or added lines in 5 files covered. (100.0%)

9464 of 10147 relevant lines covered (93.27%)

1.11 hits per line