[OAK-1852] DocumentStore API: improve documentation of keys

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.0.9, 1.1.0
• Fix Version/s: 1.2
• Component/s: doc, mongomk
• Assignee: Thomas Mueller
• Reporter: Julian Reschke
• Created: 22/May/14 12:37
• Updated: 08/Oct/19 15:21
• Resolved: 14/Jan/15 08:40

Description

I think it would be good to enhance the documentation on what syntactical constraints there are on keys.

For instance:

• what character range is allowed? what about control characters?

• is leading or trailing whitespace allowed?

• are there any assumptions about Unicode normalization on lookup?

• are keys opaque strings? for instance, does the "/" character have any special role? will all keys have the "n:" prefix?

• what length needs to be supported? (MySQL has a limit on 767/4 characters because of UTF8-to-octet mapping)

Issue Links

• blocks: OAK-1913 RDB: MariaDB (MySQL) support
• is related to: OAK-7046 DocumentStore API: clarify key length