I think high level concepts of how data is stored should be in user facing documentation. Storage format affects schema design. But low level specifics should be kept to contributor documentation.
> On Jun 15, 2016, at 12:20 PM, Jonathan Ellis <jbel...@gmail.com> wrote: > > I agree that it should be documented but I don't think it should be in user > level docs. Let's keep it in the wiki for contributors. >> On Jun 15, 2016 7:04 PM, "Jonathan Haddad" <j...@jonhaddad.com> wrote: >> >> Definitely required reading for anyone getting into it, plus Aaron's post. >> I think ideally one day something like this should live in the docs: >> >> https://www.postgresql.org/docs/9.0/static/storage-page-layout.html >> >> Definitely not suggesting everyone drop what they're doing and document the >> 3.0 format but ultimately I think there should be specs for any wire >> protocol or on disk format. For wire protocols network diagrams can easily >> be generated via the nwdiag plugin. >> >> On Wed, Jun 15, 2016 at 9:55 AM Michael Kjellman < >> mkjell...@internalcircle.com> wrote: >> >>> This was forwarded to me yesterday... a helpful first step >>> https://github.com/apache/cassandra/blob/cassandra-3.0.0/guide_8099.md >>> >>>> On Jun 15, 2016, at 9:54 AM, Jonathan Haddad <j...@jonhaddad.com> >> wrote: >>>> >>>> Maybe some brave soul will document the 3.0 on disk format as part of >>>> https://issues.apache.org/jira/browse/CASSANDRA-8700. >>>> >>>> On Wed, Jun 15, 2016 at 7:02 AM Christopher Bradford < >>> bradfor...@gmail.com> >>>> wrote: >>>> >>>>> Consider taking a look at Aaron Morton's dive into the C* 3.0 storage >>>>> engine. >> http://thelastpickle.com/blog/2016/03/04/introductiont-to-the-apache-cassandra-3-storage-engine.html >>>>> >>>>> On Wed, Jun 15, 2016 at 9:38 AM Jim Witschey < >> jim.witsc...@datastax.com >>>> >>>>> wrote: >>>>> >>>>>>> http://wiki.apache.org/cassandra/ArchitectureSSTable >>>>>> >>>>>> Be aware that this page hasn't been updated since 2013, so it doesn't >>>>>> reflect any changes to the SSTable format since then, including the >>>>>> new storage engine introduced in 3.0 (see CASSANDRA-8099). >>>>>> >>>>>> That said, I believe the linked Apache wiki page is the best >>>>>> documentation for the format. Unfortunately, if you want a better or >>>>>> more current understanding, you'll have to read the code and read >> some >>>>>> SSTables. >>
