[DERBY-4525] Document the in-memory storage back end

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 10.6.1.0
• Fix Version/s: 10.6.1.0
• Component/s: Documentation
• Assignee: Camilla Haase
• Reporter: Kristian Waagan
• Created: 26/Jan/10 07:55
• Updated: 26/Apr/10 15:47
• Resolved: 22/Apr/10 15:08

Description

The in-memory back end isn't considered experimental anymore, we have to
write user documentation for the feature(s).
I'm not sure how it should be structured, and where the content should be added.

Just as a rough cut, here are a few possible topics (I'm not sure if all should be included or not):

• documenting the new protocol name ('memory')
• documenting the new 'drop' JDBC connection URL attribute
• describing the limitations of the feature (all your data will be lost if..., how to use it with the client driver and the data sources)
• "advanced use" (pull dbs on disk into memory, backup in-memory dbs to disk)
• tuning tips (there are some issues with extreme page cache sizes, maybe the existing content on page size is valid)
• known problems (nothing concrete here yet, but we have one inquiry about disappearing databases - the current theory is that different class loaders are used)

Some more information is available at http://wiki.apache.org/db-derby/InMemoryBackEndPrimer

Issue Links

• duplicates: DERBY-4581 databaseName attribute needs to include subsubprotocol, if there is one
• is related to: DERBY-646 In-memory backend storage support
• is related to: DERBY-4428 Add proper delete mechanism for in-memory databases