Derby
  1. Derby
  2. DERBY-4691

The Reference Guide should say that SYSCOLPERMS.COLUMNS and SYSCOLUMNS.COLUMNDEFAULT are not part of Derby's public api

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 10.6.1.0
    • Fix Version/s: 10.8.1.2
    • Component/s: Documentation
    • Labels:
      None

      Description

      For most of the object types in the Derby catalogs, the Reference Guide states: "This class is not part of the public API." This disclaimer is missing for SYSCOLPERMS.COLUMNS and SYSCOLUMNS.COLUMNDEFAULT.

      1. DERBY-4691.zip
        19 kB
        Kim Haase
      2. DERBY-4691.stat
        0.4 kB
        Kim Haase
      3. DERBY-4691.diff
        26 kB
        Kim Haase

        Issue Links

          Activity

          Hide
          Kim Haase added a comment -

          Thanks very much, Knut.

          Committed patch DERBY-4691.diff to documentation trunk at revision 1058648.

          Show
          Kim Haase added a comment - Thanks very much, Knut. Committed patch DERBY-4691 .diff to documentation trunk at revision 1058648.
          Hide
          Knut Anders Hatlen added a comment -

          All the changes look like improvements to me. Thanks for doing this cleanup.

          Show
          Knut Anders Hatlen added a comment - All the changes look like improvements to me. Thanks for doing this cleanup.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-4691.diff, DERBY-4691.stat, and DERBY-4691.zip, with changes to 9 of the system table files.

          Okay, I sort of went crazy.

          Wherever there was a reference to an org.apache.derby API class, I fixed the formatting for it and also did the following:

          Lowercased nullability value, uppercased descriptions

          Put   in empty columns

          Removed periods at end of descriptions unless multiple sentences are used

          For needed line breaks in columns, used a line break, not a space, where a space didn't work in the one-page HTML (the PDF is another problem that may be insoluble)

          Added shortdesc element and index entries where these were missing

          Clarified a sentence at the end of the SYSTRIGGERS topic that made no sense to me because I thought it was referring to the SYSSTATEMENTS.ACTIONID column. (A space between the period and the column name occurs often enough that this was deceptive.)

          Corrected the description of the SYSSTATISTICS table (it was copied from SYSSCHEMAS, apparently).

          We're still not fully consistent because I touched only 9 of about 21 topics.

          Let me know if there's anything odd about any of the attachments. I'm running from home using Windows instead of my usual Unix system.

          Show
          Kim Haase added a comment - Attaching DERBY-4691 .diff, DERBY-4691 .stat, and DERBY-4691 .zip, with changes to 9 of the system table files. Okay, I sort of went crazy. Wherever there was a reference to an org.apache.derby API class, I fixed the formatting for it and also did the following: Lowercased nullability value, uppercased descriptions Put   in empty columns Removed periods at end of descriptions unless multiple sentences are used For needed line breaks in columns, used a line break, not a space, where a space didn't work in the one-page HTML (the PDF is another problem that may be insoluble) Added shortdesc element and index entries where these were missing Clarified a sentence at the end of the SYSTRIGGERS topic that made no sense to me because I thought it was referring to the SYSSTATEMENTS.ACTIONID column. (A space between the period and the column name occurs often enough that this was deceptive.) Corrected the description of the SYSSTATISTICS table (it was copied from SYSSCHEMAS, apparently). We're still not fully consistent because I touched only 9 of about 21 topics. Let me know if there's anything odd about any of the attachments. I'm running from home using Windows instead of my usual Unix system.
          Hide
          Kim Haase added a comment -

          SYSCOLUMNS.COLUMNDEFAULT is of type java.io.Serializable, which is part of the public API for Java SE.

          But SYSCOLPERMS.COLUMNS is of type org.apache.derby.iapi.services.io.FormatableBitSet, which certainly is not part of the public API.

          There's a lot of inconsistency in how these are formatted throughout this section – I could fix that too. Good job for a snowy day.

          Show
          Kim Haase added a comment - SYSCOLUMNS.COLUMNDEFAULT is of type java.io.Serializable, which is part of the public API for Java SE. But SYSCOLPERMS.COLUMNS is of type org.apache.derby.iapi.services.io.FormatableBitSet, which certainly is not part of the public API. There's a lot of inconsistency in how these are formatted throughout this section – I could fix that too. Good job for a snowy day.

            People

            • Assignee:
              Kim Haase
              Reporter:
              Rick Hillegas
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development