[Zodb-checkins] CVS: StandaloneZODB/Doc - storage.tex:1.5

[Fred L. Drake, Jr.]

Update of /cvs-repository/StandaloneZODB/Doc
In directory cvs.zope.org:/tmp/cvs-serv6571

Modified Files:
	storage.tex 
Log Message:
Filled in a lot of missing methods, but some do not yet have descriptions.

=== StandaloneZODB/Doc/storage.tex 1.4 => 1.5 ===
 \end{methoddesc}
 
+\begin{methoddesc}{restore}{oid, serial, data, version, transaction}
+  A lot like \method{store()} but without all the consistency checks.
+  This should only be used when we \emph{know} the data is good, hence
+  the method name.  While the signature looks like \method{store()},
+  there are some differences:
+
+  \begin{itemize}
+        \item \var{serial} is the serial number of this revision, not
+          of the previous revision.  It is used instead of
+          \code{self._serial}, which is ignored.
+
+        \item Nothing is returned.
+
+        \item \var{data} can be \code{None}, which indicates a George
+          Bailey object (one who's creation has been transactionally
+          undone).
+  \end{itemize}
+\end{methoddesc}
+
+\begin{methoddesc}{tpc_vote}{transaction}
+\end{methoddesc}
+
 \begin{methoddesc}{tpc_finish}{transaction, func}
   Finish the transaction, making any transaction changes
   permanent.  Changes must be made permanent at this point.
@@ -154,6 +176,116 @@
   If the storage doesn't support undo, then the old version data may
   be discarded.  If undo is supported, then this operation must be
   undoable and old transaction data may not be discarded. 
+\end{methoddesc}
+
+\begin{methoddesc}{close}{}
+  Finalize the storage, releasing any external resources.  The storage
+  should not be used after this method is called.
+\end{methoddesc}
+
+\begin{methoddesc}{lastSerial}{oid}
+  Returns the serial number for the last committed transaction for the
+  object identified by \var{oid}.  If there is no serial number for
+  \var{oid} --- which can only occur if it represents a new object ---
+  returns \code{None}.
+  \note{This is not defined for \class{ZODB.BaseStorage}.}
+\end{methoddesc}
+
+\begin{methoddesc}{lastTransaction}{}
+  Return transaction ID for last committed transaction.
+  \note{This is not defined for \class{ZODB.BaseStorage}.}
+\end{methoddesc}
+
+\begin{methoddesc}{getSize}{}
+\end{methoddesc}
+
+\begin{methoddesc}{getSerial}{oid}
+  Return the serial number of the most recent version of the object
+  identified by \var{oid}.
+\end{methoddesc}
+
+\begin{methoddesc}{load}{oid, version}
+\end{methoddesc}
+
+\begin{methoddesc}{loadSerial}{oid, serial}
+  Load a historical version of the object identified by \var{oid}
+  having serial number \var{serial}.
+\end{methoddesc}
+
+\begin{methoddesc}{modifiedInVersion}{oid}
+\end{methoddesc}
+
+\begin{methoddesc}{isReadOnly}{}
+  Returns true if the storage is read-only, otherwise returns false.
+\end{methoddesc}
+
+\begin{methoddesc}{supportsTransactionalUndo}{}
+  Returns true if the storage implementation supports transactional
+  undo, or false if it does not.
+  \note{This is not defined for \class{ZODB.BaseStorage}.}
+\end{methoddesc}
+
+\begin{methoddesc}{supportsUndo}{}
+  Returns true if the storage implementation supports undo, or false
+  if it does not.
+\end{methoddesc}
+
+\begin{methoddesc}{supportsVersions}{}
+  Returns true if the storage implementation supports versions, or
+  false if it does not.
+\end{methoddesc}
+
+\begin{methoddesc}{transactionalUndo}{transaction_id, transaction}
+  Undo a transaction specified by \var{transaction_id}.  This may need
+  to do conflict resolution.
+  \note{This is not defined for \class{ZODB.BaseStorage}.}
+\end{methoddesc}
+
+\begin{methoddesc}{undo}{transaction_id}
+\end{methoddesc}
+
+\begin{methoddesc}{undoLog}{first, last\optional{, filter}}
+\end{methoddesc}
+
+\begin{methoddesc}{versionEmpty}{version}
+  Return true if there are no transactions for the specified version.
+\end{methoddesc}
+
+\begin{methoddesc}{versions}{\optional{max}}
+  Return a sequence of the versions stored in the storage.  If
+  \var{max} is given, the implementation may choose not to return more
+  than \var{max} version names.
+\end{methoddesc}
+
+\begin{methoddesc}{history}{oid\optional{, version\optional{,
+                            size\optional{, filter}}}}
+\end{methoddesc}
+
+\begin{methoddesc}{pack}{t, referencesf}
+  Remove transactions from the database that are no longer needed to
+  maintain the current state of the database contents.  Undo will not
+  be restore objects to states from before the most recent call to
+  \method{pack()}.
+\end{methoddesc}
+
+\begin{methoddesc}{copyTransactionsFrom}{other\optional{, verbose}}
+  Copy transactions from another storage, given by \var{other}.  This
+  is typically used when converting a database from one storage
+  implementation to another.  This will use \method{restore()} if
+  available, but will use \method{store()} if \method{restore()} is
+  not available.  When \method{store()} is needed, this may fail with
+  \exception{ConflictError} or \exception{VersionLockError}.
+\end{methoddesc}
+
+\begin{methoddesc}{iterator}{\optional{start\optional{, stop}}}
+  Return a iterable object which produces all the transactions from a
+  range.  If \var{start} is given and not \code{None}, transactions
+  which occurred before the identified transaction are ignored.  If
+  \var{stop} is given and not \code{None}, transactions which occurred
+  after the identified transaction are ignored; the specific
+  transaction identified by \var{stop} will be included in the series
+  of transactions produced by the iterator.
+  \note{This is not defined for \class{ZODB.BaseStorage}.}
 \end{methoddesc}