[jira] Updated: (DERBY-4525) Document the in-memory storage back end

["Kim Haase (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/DERBY-4525?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-4525:
-----------------------------

    Attachment: DERBY-4525.zip
                DERBY-4525.stat
                DERBY-4525.diff

Here's a first pass at a patch. Attaching DERBY-4525.diff, DERBY-4525.stat, and DERBY-4525.zip, with changes to 24 files (including the map files) and 5 of the 6 manuals. Most changes are relatively small. Here's a summary.

Admin Guide:

cadminappsclient.dita: Accessing the Network Server by using the network client driver

Add memory to syntax statement and explain (w. xref to cdevdvlpinmemdb.dita).

Dev Guide:

cdevdvlp17453.dita: Derby JDBC database connection URL

Add memory to subsubprotocol list

cdevdvlp27610.dita: Derby system

Mention that use of in-memory db means that no databases exist in the directory. 

cdevdvlp96597.dita: One Derby instance for each Java Virtual Machine

Revise.

Mention that if you specify the "same" in-memory db in two different instances of Derby it is not a problem because you actually get two different dbs in two different JVMs.

cdevdvlp19297.dita: Recommended practices

Fix next-to-last bullet to remove the recommendation against doing things that are actually impossible to do.

cdevdvlp40724.dita: The database directory

Mention that the directory info doesn't apply to in-memory dbs. I'm guessing the size limits still apply -- let me know if not.

cdevdvlp42173.dita: Creating, dropping, and backing up databases

You can drop an in-memory db.

cdevdvlp18166.dita: Storage and recovery

Doesn't apply to in-memory dbs, does it?

cdevdvlp846369.dita: Connecting to databases within the system

Move the verb "is" to make it clear that this info is about file-system dbs only.

cdevdvlp40350.dita: Conventions for specifying the database path

Add memory to list of non-filesystem access methods.

cdevdvlp19700.dita: Special database access

Add note on in-memory and xref.

rdevdvlp22102.dita: Database connection examples

Add example of in-memory.

cdevdvlpinmemdb.dita: Using in-memory databases

New topic. Does placement seem okay?

Ref Man:

rrefattrib24612.dita: Setting attributes for the database connection URL

Add mention of subsubprotocol

rrefattrib26867.dita: create=true attribute

Add examples of creating in-memory db.

rrefattribdrop.dita: drop=true attribute

New topic.

rrefattrib16471.dita: shutdown=true attribute

Add examples of shutting down in-memory db.

Tools Guide: 

rtoolsijcomref27997.dita: Protocol command

Add example of connecting to  in-memory db.

rtoolsijcomref22318.dita: Connect command

Add example of connecting to in-memory db. Also add example of using PROTOCOL in command

Tuning Guide: 

ctunperfinmemdb.dita: Configure Derby to use an in-memory database

New topic.

ctunperf25864.dita: The tips

Add mention of tuning for in-memory db. Also corrected title of table-function topic, here and in map file.



> Document the in-memory storage back end
> ---------------------------------------
>
>                 Key: DERBY-4525
>                 URL: https://issues.apache.org/jira/browse/DERBY-4525
>             Project: Derby
>          Issue Type: Task
>          Components: Documentation
>    Affects Versions: 10.6.0.0
>            Reporter: Kristian Waagan
>            Assignee: Kim Haase
>             Fix For: 10.6.0.0
>
>         Attachments: DERBY-4525.diff, DERBY-4525.stat, DERBY-4525.zip
>
>
> 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

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.