[ZODB-Dev] basic operational documents?

[Mike C. Fletcher]

I've also put my structural overview online at:
http://members.rogers.com/mcfletch/chandler/ZODB4_Structural_Overview.html

This is a short document describing the components within ZODB4, their 
roles and operational modes.  It tries to introduce every module in the 
ZODB, Transaction and Persistence packages based on a very recent CVS 
snapshot of ZODB4.  The goal is to get someone who understands the 
concepts of ZODB4, but has never worked with the code, to the point 
where they know where everything is (which modules/classes are 
responsible for what) and how the objects are supposed to interact (what 
other objects they to carry out their responsibilities).  The 
operational mode is assuming that the reader will have the source-code 
open as they read through the structural overview.

You (David) may have already seen this posted to the Chandler list, so 
you may be looking for something different/extra.  Most of the documents 
in Chris' list are user-targetted (good for concepts, don't really cover 
the implementation).  I'd suggest this one as well:

http://www.python.org/workshops/2000-01/proceedings/papers/fulton/zodb3.html

Which gives a lot of detail about what's going on (though not where in 
the system it goes on most of the time).

BTW, Chris, if anyone at Zope wants to, they can feel free to 
copy/extend/change my document for Zope-corp use.

Enjoy,
Mike





Chris McDonough wrote:

>Hi David,
>
>Probably the best architectural overview of ZODB is from the output of a
>UML tool at http://www.zope.org/Documentation/Developer/Models/ZODB . 
>It is a bit hard to track in this form, but it does provide a few gems
>if you poke around a bit.  This document reflects ZODB3, not ZODB4 and
>is not completely up-to-date (it was written in 1999).  That said, the
>underpinnings of the architecture haven't changed that much.  The ZODB
>wiki at http://www.zope.org//Wikis/ZODB/FrontPage is the place to go for
>the most up-to-date development information.  
>
>A few sources of introductory narrative documentation about using ZODB
>exist at:
>
>http://www.zope.org/Documentation/Articles/ZODB1
>http://www.zope.org/Documentation/Articles/ZODB2
>http://www.zope.org/Members/michel/HowTos/ZODB-How-To
>http://www.zope.org/Members/mcdonc/HowTos/transaction
>http://www.zope.org/Documentation/Books/ZDG/current/Persistence.stx
>http://www.zope.org/Documentation/Books/ZopeBook/current/ZEO.stx
>
>HTH,
>
>- C
>
>
>On Thu, 2002-11-21 at 20:26, David McCusker wrote:
>  
>
>>Hi, I'm trying to learn all about ZODB for use inside the Chandler
>>project at http://www.osafoundation.org/, where I'll be focusing on
>>the storage issues in the project.
>>
>>I've started reading the source code to ZODB4, and I would very
>>much appreciate pointers to documentation on how it is supposed to
>>operate, which I'm sure exist and probably right in front of me if
>>I would only open my eyes and look in the right place.
>>
>>What's the best canonical online documentation I can find on ZODB?
>>
>>I'd most appreciate a range of materials from high level overview
>>to detailed explanations.  The former is good for high level
>>architecture, and the latter is useful for reading the source code
>>in detail.
>>
>>I assume if I read docs in the right order I'll make faster progress
>>than blundering around at random.
>>
>>If my request is stupid, please be sure to let me know, since the
>>explanation will also probably educate me.
>>
>>David McCusker
>>
>>
>>_______________________________________________
>>For more information about ZODB, see the ZODB Wiki:
>>http://www.zope.org/Wikis/ZODB/
>>
>>ZODB-Dev mailing list  -  ZODB-Dev@zope.org
>>http://lists.zope.org/mailman/listinfo/zodb-dev
>>    
>>
>
>
>
>_______________________________________________
>For more information about ZODB, see the ZODB Wiki:
>http://www.zope.org/Wikis/ZODB/
>
>ZODB-Dev mailing list  -  ZODB-Dev@zope.org
>http://lists.zope.org/mailman/listinfo/zodb-dev
>
>  
>

-- 
_______________________________________
  Mike C. Fletcher
  Designer, VR Plumber, Coder
  http://members.rogers.com/mcfletch/