Sophie: pyrite-0.9.3-4mdk i586

pyrite-0.9.3-4mdk.i586.rpm

<HTML
><HEAD
><TITLE
>Class: BaseStore</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.42"><LINK
REL="HOME"
TITLE="Pyrite Programmers Guide"
HREF="book1.html"><LINK
REL="UP"
TITLE="Stores"
HREF="c643.html"><LINK
REL="PREVIOUS"
TITLE="Stores"
HREF="c643.html"><LINK
REL="NEXT"
TITLE="Handheld Application Support"
HREF="c777.html"></HEAD
><BODY
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Pyrite Programmers Guide</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="c643.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 3. Stores</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="c777.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="REF-STORES-BASESTORE"
>Class: BaseStore</A
></H1
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="REF-STORES-BASESTORE-METHODS"
>Methods</A
></H2
><P
></P
><DL
><DT
><TT
CLASS="FUNCTION"
>open</TT
> (<TT
CLASS="PARAMETER"
><I
>name</I
></TT
>,
	    <TT
CLASS="PARAMETER"
><I
>mode</I
></TT
>='rws',
	    <TT
CLASS="PARAMETER"
><I
>dbclass</I
></TT
>=<TT
CLASS="CLASSNAME"
>Pyrite.Database</TT
>,
	    <TT
CLASS="PARAMETER"
><I
>**</I
></TT
>)</DT
><DD
><P
>Open an existing database.  The <TT
CLASS="PARAMETER"
><I
>mode</I
></TT
> is
	      a string which can include the characters <TT
CLASS="LITERAL"
>r</TT
>
	      for reading, <TT
CLASS="LITERAL"
>w</TT
> for writing, <TT
CLASS="LITERAL"
>s</TT
> for
	      access to records marked "secret", and/or <TT
CLASS="LITERAL"
>x</TT
>
	      for exclusive access.</P
><DIV
CLASS="IMPORTANT"
><BLOCKQUOTE
CLASS="IMPORTANT"
><P
><B
>Important: </B
>Not all stores support all combinations of
		modes.</P
></BLOCKQUOTE
></DIV
><P
>The <TT
CLASS="PARAMETER"
><I
>dbclass</I
></TT
> parameter specifies a
	      subclass of <TT
CLASS="CLASSNAME"
>Pyrite.Database</TT
> (or a class
	      exhibiting the same interface) to use for this
	      database.</P
></DD
><DT
><TT
CLASS="FUNCTION"
>create</TT
> (<TT
CLASS="PARAMETER"
><I
>name</I
></TT
>,
	    <TT
CLASS="PARAMETER"
><I
>creator</I
></TT
>, <TT
CLASS="PARAMETER"
><I
>type</I
></TT
>,
	    <TT
CLASS="PARAMETER"
><I
>flags</I
></TT
>=0, <TT
CLASS="PARAMETER"
><I
>version</I
></TT
>=1,
	    <TT
CLASS="PARAMETER"
><I
>dbclass</I
></TT
>=<TT
CLASS="CLASSNAME"
>Pyrite.Database</TT
>,
	    <TT
CLASS="PARAMETER"
><I
>**</I
></TT
>)</DT
><DD
><P
>Create a new database, with the specified header
	      information.  The resulting database is opened and
	      returned as an object of class
	      <TT
CLASS="PARAMETER"
><I
>dbclass</I
></TT
>.</P
></DD
><DT
><TT
CLASS="FUNCTION"
>delete</TT
> (<TT
CLASS="PARAMETER"
><I
>name</I
></TT
>, <TT
CLASS="PARAMETER"
><I
>**</I
></TT
>)</DT
><DD
><P
>Delete a database.</P
></DD
><DT
><TT
CLASS="FUNCTION"
>info</TT
> (<TT
CLASS="PARAMETER"
><I
>name</I
></TT
>, <TT
CLASS="PARAMETER"
><I
>**</I
></TT
>)</DT
><DD
><P
>Return a database's header, as a dictionary.</P
></DD
><DT
><TT
CLASS="FUNCTION"
>list</TT
> (<TT
CLASS="PARAMETER"
><I
>**</I
></TT
>)</DT
><DD
><P
>Return a list of the names of all databases in the
	      store.</P
></DD
><DT
><TT
CLASS="FUNCTION"
>listinfo</TT
> (<TT
CLASS="PARAMETER"
><I
>name</I
></TT
>=None,
	    <TT
CLASS="PARAMETER"
><I
>creator</I
></TT
>=None, <TT
CLASS="PARAMETER"
><I
>type</I
></TT
>=None,
	    <TT
CLASS="PARAMETER"
><I
>**</I
></TT
>)</DT
><DD
><P
>Return a list of the headers of databases in the
	      store.  By default, all available databases are listed;
	      however, if one or more of <TT
CLASS="PARAMETER"
><I
>name</I
></TT
>,
	      <TT
CLASS="PARAMETER"
><I
>creator</I
></TT
>, or <TT
CLASS="PARAMETER"
><I
>type</I
></TT
> are supplied,
	      only databases matching the supplied values are
	      listed.</P
><DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>Tip: </B
>The <TT
CLASS="PARAMETER"
><I
>name</I
></TT
> parameter might seem kind of
		useless given the existence of the <TT
CLASS="FUNCTION"
>info</TT
>
		method, but it can actually be quite useful as part of
		a one-step test to see if a particular database both
		exists and matches a particular application.
	      </P
></BLOCKQUOTE
></DIV
></DD
><DT
><TT
CLASS="FUNCTION"
>copy</TT
> (<TT
CLASS="PARAMETER"
><I
>store</I
></TT
>, <TT
CLASS="PARAMETER"
><I
>name</I
></TT
>)</DT
><DD
><P
>Copy the named database from this store to another
	      one..</P
></DD
><DT
><TT
CLASS="FUNCTION"
>install</TT
> (<TT
CLASS="PARAMETER"
><I
>store</I
></TT
>, <TT
CLASS="PARAMETER"
><I
>name</I
></TT
>)</DT
><DD
><P
>Copy the named database from another store to this
	      one.</P
><DIV
CLASS="IMPORTANT"
><BLOCKQUOTE
CLASS="IMPORTANT"
><P
><B
>Important: </B
>The reason for the existence of both
		<TT
CLASS="FUNCTION"
>copy</TT
> and <TT
CLASS="FUNCTION"
>install</TT
> is because
		certain stores (<TT
CLASS="LITERAL"
>DLP</TT
>, for example) require
		different behavior depending on whether they are the
		source or target of a database copy.  Whenever
		possible, your code should use <TT
CLASS="FUNCTION"
>install</TT
>
		instead of <TT
CLASS="FUNCTION"
>copy</TT
> when working with stores of
		unknown type.</P
></BLOCKQUOTE
></DIV
></DD
></DL
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="c643.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="book1.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="c777.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Stores</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="c643.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Handheld Application Support</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>