Derby
  1. Derby
  2. DERBY-5307

Document the behavior of the derby.language.sequence.preallocator property.

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 10.8.2.2, 10.9.1.0
    • Fix Version/s: 10.8.2.2, 10.9.1.0
    • Component/s: Documentation
    • Labels:
      None
    • Urgency:
      Normal

      Description

      The work on DERBY-4437 introduced a new property: derby.language.sequence.preallocator. The user documentation should describe this property. I think the following should be sufficient:

      o Add a section on this property parallel to the sections for other properties in the Reference Guide.

      o Point the CREATE TABLE and CREATE SEQUENCE topics to the new section.

      1. derby-5307-01-aa-newProperty.diff
        7 kB
        Rick Hillegas
      2. derby-5307-01-aa-newProperty.tar
        100 kB
        Rick Hillegas
      3. derby-5307-01-ab-newProperty.diff
        7 kB
        Rick Hillegas
      4. derby-5307-01-ab-newProperty.tar
        100 kB
        Rick Hillegas

        Issue Links

          Activity

          Rick Hillegas created issue -
          Rick Hillegas made changes -
          Field Original Value New Value
          Link This issue is part of DERBY-4437 [ DERBY-4437 ]
          Rick Hillegas made changes -
          Assignee Rick Hillegas [ rhillegas ]
          Hide
          Rick Hillegas added a comment -

          Attaching derby-5307-01-aa-newProperty.diff. This patch documents the new derby.language.sequence.preallocator property and points the CREATE TABLE and CREATE SEQUENCE documentation at it. Also attaching a tarball of generated html output: derby-5307-01-aa-newProperty.tar.

          Touches the following files:

          --------

          M src/ref/refderby.ditamap
          M src/ref/crefproper22250.dita
          A src/ref/rrefproperpreallocator.dita

          New topic for the new property.

          --------

          M src/ref/rrefsqlj37836.dita
          M src/ref/rrefsqljcreatesequence.dita

          Points the "generated-column-spec" and "CREATE SEQUENCE" topics at the new property.

          Show
          Rick Hillegas added a comment - Attaching derby-5307-01-aa-newProperty.diff. This patch documents the new derby.language.sequence.preallocator property and points the CREATE TABLE and CREATE SEQUENCE documentation at it. Also attaching a tarball of generated html output: derby-5307-01-aa-newProperty.tar. Touches the following files: -------- M src/ref/refderby.ditamap M src/ref/crefproper22250.dita A src/ref/rrefproperpreallocator.dita New topic for the new property. -------- M src/ref/rrefsqlj37836.dita M src/ref/rrefsqljcreatesequence.dita Points the "generated-column-spec" and "CREATE SEQUENCE" topics at the new property.
          Rick Hillegas made changes -
          Attachment derby-5307-01-aa-newProperty.diff [ 12484679 ]
          Attachment derby-5307-01-aa-newProperty.tar [ 12484680 ]
          Rick Hillegas made changes -
          Issue & fix info [Patch Available]
          Hide
          Knut Anders Hatlen added a comment -

          The patch looks good to me. Two small comments:

          • The table in the "Derby properties" topic says that the property has scope "S, D", which I read as system-wide or database-wide. In the topic for the new property, it says the scope is system-wide only.
          • Perhaps the "Concurrency" sections added to generated-column-spec and CREATE SEQUENCE statement should be called "Performance" instead, since preallocating a range also reduces the overhead significantly in the single-threaded case. And maybe: "Derby preallocates ranges of upcoming values for sequences and identity columns in order to reduce the overhead of generating the values, and thereby boost the performance and concurrency of these operations. The length of these ranges can be ..." ?
          Show
          Knut Anders Hatlen added a comment - The patch looks good to me. Two small comments: The table in the "Derby properties" topic says that the property has scope "S, D", which I read as system-wide or database-wide. In the topic for the new property, it says the scope is system-wide only. Perhaps the "Concurrency" sections added to generated-column-spec and CREATE SEQUENCE statement should be called "Performance" instead, since preallocating a range also reduces the overhead significantly in the single-threaded case. And maybe: "Derby preallocates ranges of upcoming values for sequences and identity columns in order to reduce the overhead of generating the values, and thereby boost the performance and concurrency of these operations. The length of these ranges can be ..." ?
          Hide
          Rick Hillegas added a comment -

          Thanks for the quick review, Knut. I have incorporated your suggestions in a second rev of the patch: derby-5307-01-ab-newProperty.diff and derby-5307-01-ab-newProperty.tar.

          Show
          Rick Hillegas added a comment - Thanks for the quick review, Knut. I have incorporated your suggestions in a second rev of the patch: derby-5307-01-ab-newProperty.diff and derby-5307-01-ab-newProperty.tar.
          Rick Hillegas made changes -
          Attachment derby-5307-01-ab-newProperty.diff [ 12484779 ]
          Attachment derby-5307-01-ab-newProperty.tar [ 12484780 ]
          Hide
          Rick Hillegas added a comment -

          Committed derby-5307-01-ab-newProperty.diff at subversion revision 1141568.

          Show
          Rick Hillegas added a comment - Committed derby-5307-01-ab-newProperty.diff at subversion revision 1141568.
          Hide
          Rick Hillegas added a comment -

          Ported 1141568 from trunk docs to 10.8 docs at subversion revision 1141651.

          Show
          Rick Hillegas added a comment - Ported 1141568 from trunk docs to 10.8 docs at subversion revision 1141651.
          Rick Hillegas made changes -
          Status Open [ 1 ] Resolved [ 5 ]
          Issue & fix info [Patch Available]
          Fix Version/s 10.8.1.5 [ 12316676 ]
          Fix Version/s 10.9.0.0 [ 12316344 ]
          Resolution Fixed [ 1 ]
          Rick Hillegas made changes -
          Status Resolved [ 5 ] Closed [ 6 ]
          Myrna van Lunteren made changes -
          Affects Version/s 10.8.2.0 [ 12317955 ]
          Affects Version/s 10.8.1.6 [ 12316676 ]
          Fix Version/s 10.8.2.0 [ 12317955 ]
          Fix Version/s 10.8.1.6 [ 12316676 ]
          Hide
          Kim Haase added a comment -

          Note: these documentation changes were backed out in one of the DERBY-5448 patches, because the property has been removed from Derby 10.8.2.

          Show
          Kim Haase added a comment - Note: these documentation changes were backed out in one of the DERBY-5448 patches, because the property has been removed from Derby 10.8.2.
          Hide
          Kim Haase added a comment -

          The changes were backed out of the 10.8.2 branch, not the trunk.

          Show
          Kim Haase added a comment - The changes were backed out of the 10.8.2 branch, not the trunk.
          Hide
          Rick Hillegas added a comment -

          And just to make the situation more confusing, the property is still supported for sequences. It just doesn't affect identity columns in the 10.8 branch. People who use 10.8.2 can still adjust the behavior of sequences by turning this knob...but they won't know about the knob unless they follow the conversation on the Derby lists.

          Show
          Rick Hillegas added a comment - And just to make the situation more confusing, the property is still supported for sequences. It just doesn't affect identity columns in the 10.8 branch. People who use 10.8.2 can still adjust the behavior of sequences by turning this knob...but they won't know about the knob unless they follow the conversation on the Derby lists.
          Myrna van Lunteren made changes -
          Affects Version/s 10.8.2.2 [ 12317968 ]
          Affects Version/s 10.8.2.0 [ 12317955 ]
          Fix Version/s 10.8.2.2 [ 12317968 ]
          Fix Version/s 10.8.2.0 [ 12317955 ]
          Rick Hillegas made changes -
          Link This issue is related to DERBY-5687 [ DERBY-5687 ]
          Hide
          Rick Hillegas added a comment -

          These changes were further adjusted by the work on DERBY-5687. The documentation no longer talks about identity columns.

          Show
          Rick Hillegas added a comment - These changes were further adjusted by the work on DERBY-5687 . The documentation no longer talks about identity columns.
          Gavin made changes -
          Workflow jira [ 12618549 ] Default workflow, editable Closed status [ 12801149 ]
          Transition Time In Source Status Execution Times Last Executer Last Execution Date
          Open Open Resolved Resolved
          1d 2h 21m 1 Rick Hillegas 30/Jun/11 19:31
          Resolved Resolved Closed Closed
          9s 1 Rick Hillegas 30/Jun/11 19:32

            People

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

              Dates

              • Created:
                Updated:
                Resolved:

                Development