View Source

This page includes some notes on Sample Databases included in 2.0.

h1. Document Naming Conventions

h3. Use Human Readable Key Names, spaces change to "_"

{color:grey}
*document key*: new_belgium
{color}

h3. Use "-" as separator in key parts for cross operating system filename compatibility

{color:grey}
*document key*: new_belgium-fat_tire
{color}

h3. Normalize names to ASCII-7, make lowercase and remove punctuation

{color:grey}
*document key*: "borsodi_sorgyar"
*json key*: \{ "brewery_name": "Borsodi Sörgyár" \}
{color}

h3. Use "type" in Document as json key for use in Views (Secondary Index/Query)

{color:grey}
*document key*: new_belgium
*value*: \{ "type": "brewery", ... \}

*document key*: new_belgium-fat_tire
*value*: \{ "type": "beer", ... \}
{color}

h1. Complex Models

When modeling, use the Document Naming conventions wherever possible, if you run into a situation where unique name-keys cannot be generated from the data, then other key paradigms can be used.