A UML way to describe a key/value datastore ?

Question

Hi all, I'm currently writing the documentation for a database using berkeleyDB. I'd like to draw UML diagram describing the keys and the values of the datastores. Is there a 'standard' way to describe this kind of database using UML ?

Thanks

Answer 1

Nope. Just a class diagram with two properties. One for the key, one for the value. Do keep in mind that an UML design is meant for documentation purposes only, although some UML editors are capable of generating code based upon your model.

Of course, you could also use an Activity model to show how this table interacts with others. Or a Use Case diagram which shows how the data is handled by the actors.

There are more kinds of diagrams, though. The one you need depends on what you want to tell about your project.

Answer 2

The proper MDA way to do this is to use a Class or Object diagram, use a Class or Object for each table, add a property for each database field. Define Stereotypes for PK, FK, Unique, Index and attach them to each field as appropriate. Join each Table object with associations. Depending on the tool you use you can probably attach each end of the associations to specific fields.