Documentation for partitioned dbs

[davisp]

Overview

This is documentation for the new partitioned databases feature. It covers the new APIs as well as provides a guide on actually using the feature.

Testing recommendations

Um?

Related Pull Requests

Main feature PR: apache/couchdb#1789

Checklist

• Documentation is written and is accurate;
• make check passes with no errors
• Update rebar.config.script with the commit hash once this PR is rebased and merged

[flimzy]

A few suggestions, mostly minor grammatical improvements.

[flimzy]

Suggested change

	returned view result will only contain rows related to the specified
	returned view result will only contain rows stored on the specified partition.

Is this accurate? If so, it seems more precise.

[davisp]

Re-reading today I went with "only contain rows with the specified partition name". "stored on" seems not quite right and I agree that "related to" seems a bit of a weak association there.

[lbboe]

Addressed in 347a6ce.

[davisp]

I'm not on my normal laptop or else I'd clean this up further. Notes to self so I don't forget:

1. Apply the last remaining diff but reword to be "stored in" vs "stored on"
2. Add note about system dbs not being partition-able
3. Squerge commits

Thanks for the review @flimzy! I, apparently, do not know how to comma!

[wohali]

@davisp also note to you, I promise to give this a more thorough read-over on Monday.

[wohali]

@davisp make check is failing:

/home/travis/build/apache/couchdb-documentation/src/partitioned-dbs/index.rst
  line 30 : too many empty lines
  line 50 : too many empty lines
  line 56 : too many empty lines
  line 95 : too many empty lines
  line 112 : too many empty lines
  line 127 : too many empty lines
  line 175 : too many empty lines
/home/travis/build/apache/couchdb-documentation/src/api/partitioned-dbs.rst
  line 69 : too many empty lines
  line 122 : too many empty lines
  line 123 : too many empty lines
  line 161 : too many empty lines

[wohali]

HI @davisp,

This looks great. I mostly have nitpicky comments. left in the actual line-by-line review.

My big concern is that you mention nothing about partitioned DBs + Mango in this. Is there even support for Mango yet? What does that look like? If there's no support yet, put a note:: in about that. If there is support, it should be documented along with this PR, or should be in a PR to follow shortly thereafter.

Great work, and super glad to see this feature land both here and in apache/couchdb.

[davisp]

Hah, good catch! I was all like "Sure I did!" and then I thought harder and was like "oh.... maybe not". I'll make sure and add mango docs. Its very much already supported I just blanked on it.

[wohali]

Thanks, that'd be swell, especially since your first example is all JS and I thought we were trying to push Mango more with 2.x.

[wohali]

@davisp this really needs to land before we can release 2.4. Poke

[davisp]

What's the current timeline for 2.4? I'll make time for this, just need to know how far out I reasonably have for trying to find a slot.

[wohali]

I'd like to cut the first 2.4 RC after I return from my trip to Germany, and have time to recover from travel, so that'd be in 4 weeks' time, end of June. Given the early July holidays in US/CAN, I'd expect we'd release 2.4 around mid-July.

Does that help?

[davisp]

Yep. Plenty of time. Just making sure I shouldn't be shuffling my schedule for today/tomorrow and can add it in next week is all.

[wohali]

Looks good to me! Thanks for helping out, @lbboe !

+1, @kocolosk will you merge this?