CHAR data type documentation fails to describe the maximum allowed length

• Key: DERBY-4025
• Type: Bug
• Status: Closed
• Resolution: Fixed
• Priority: Major
• Assignee: Kim Haase
• Reporter: Kristian Waagan
• Component/s: Documentation
• Affects Version/s: 10.5.1.1
• Fix Version/s: 10.5.1.1

Description

The section on CHAR fails to document the maximum allowed length.
In addition to not specifying the correct maximum length, the section can be interpreted as specifying Integer.MAX_VALUE as the maximum length of a CHAR column.

See http://db.apache.org/derby/docs/dev/ref/ref-single.html#rrefsqlj13733

Comments

[Kim Haase]

Attaching DERBY-4025.diff and rrefsqlj13733.html, which add the limit of 254 characters to the syntax information and remove the misleading statement near the end. Hope this does the job.

[Kristian Waagan]

The changes look good to me.
One question:
Do you consider the example to belong under "Implementation-defined aspects", or can that heading/section be removed now that the misleading statement has been removed.

[Kim Haase]

Thanks, Kristian. I was wondering about that heading myself -- I think it may make sense to just call it "Example" instead, unless it really does show implementation-specific behavior. However, that seems unlikely. I'll file a revised patch.

[Kim Haase]

Attaching a revised patch, DERBY-4025-2.diff and an updated rrefsqlj13733.html. Made the suggested fix and added another example.

[Kristian Waagan]

I think the revised patch looks better.
+1 to commit

Thanks, Kim!

[Kim Haase]

Thanks, Kristian!

Committed patch DERBY-4025-2.diff to documentation trunk at revision 737068.

[Kristian Waagan]

Thank you, Kim!
I confirmed the change in all three variants of the reference manual.

Closing the issue.