[Modeling-cvs] ProjectModeling/Modeling/doc/HomePage features.tex,NONE,1.1 main.tex,1.27,1.28

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/modeling/ProjectModeling/Modeling/doc/HomePage
In directory sc8-pr-cvs1:/tmp/cvs-serv15960/doc/HomePage

Modified Files:
	main.tex 
Added Files:
	features.tex 
Log Message:
main splitted in main+features

--- NEW FILE: features.tex ---
\documentclass{article}

\title{Modeling\\
Object-Relational Bridge for python
}

% Increment the release number whenever significant changes are made.
% The author and/or editor can define 'significant' however they like.
%\release{0.9-pre-15}

% At minimum, give your name and an email address.  You can include a
% snail-mail address if you like.
\author{S\'ebastien Bigaret}
%\email{sbi...@us...}
%\date{Sep 13, 2003}
%\date{\today}

\begin{document}
\input{www/menu-inline-begin}

\maketitle

% Copyright statement should go here, if needed.
% ...

% The abstract should be a paragraph or two long, and describe the
% scope of the document.
%\begin{abstract}
%\end{abstract}

\chapter{Features}

The framework allows you to transparently create, retrieve, update or delete
python objects from a database without having to write a single line of
SQL. It achieves this by offering you a container, the
\verb+EditingContext+ (see the \begin{rawhtml}<a
href="UserGuide/index.html">User's Guide</a>\end{rawhtml}) that is
responsible for your objects.

Additionally the framework offers:

\begin{itemize}

\item A comprehensive model description language (XML) to specify how the object 
      model is to map to a relational model,

\item Functional tools to help you designing your model (in the form of
      either a Zope poduct, or a collection of standalone utility scripts),  
      that can also validate your models against the
      most common errors made when designing a model.

\item Generation of database schemas (including: primary keys, foreign keys,
      referential constraints), generation of python code templates ready to
      be used.

\item Support for transparent mapping of (class) inheritance in relational
      databases.

\item A simple and powerful object-oriented query langage.

\item Once you get one or more objects, using that query langage, you do not
      need to explicitly fetch the objects in relations to the ones you
      already fetched. Rather, you simply use normal python getters to
      traverse relationships, and the related objects are automatically
      fetched, when needed and when appropriate. It helps you keep the memory
      footprint of your applications reasonable, while keeping you away from
      the SQL world.

\item Automatic checking for referential-integrity constraints, plus the
      framework provides a unified place where to put your own validation
      logic (objects' invariants, ...) so that they are integrated in the
      checked constraints.

\item Automatically encloses all modifications made to a graph/set of objects
      in a transactional scheme, so that the changes are all saved, or none
      are saved.

\item Support for nested graphs/sets of objects.

\item Works with python 2.1 and 2.2.
\end{itemize}

\paragraph*{Supported RDBMS}

\begin{description}
\item[\begin{rawhtml}<a href="http://www.mysql.com/">MySQL</a>\end{rawhtml}]
tested with v3.23.52 and v4.0.13

Supported python adaptor: 
  \begin{rawhtml}
    <a href="http://sourceforge.net/projects/mysql-python">MySQL</a>
  \end{rawhtml}

\item[\begin{rawhtml}<a href="http://www.oracle.com/">Oracle</a>\end{rawhtml}]
tested with Oracle 8i (linux/8.1.7.0.1) and Oracle 9i (9.2.0.1.0/linux)

Supported python adaptor: 
  \begin{rawhtml}
    <a href="http://www.zope.org/Members/matt/dco2">DCOracle2</a>
  \end{rawhtml}

\item[\begin{rawhtml}<a href="http://www.postgresql.org/">Postgresql</a>\end{rawhtml}] versions 7.2 and 7.3 (see \begin{rawhtml}
<a href="http://modeling.sourceforge.net/UserGuide/env-vars-postgresql.html">Postgresql specificities</a>\end{rawhtml} in the User's Guide if you're using v7.3).

Supported python adaptors:
  \begin{rawhtml}
    <a href="http://initd.org/software/initd/psycopg">psycopg</a>
  \end{rawhtml} or
  \begin{rawhtml}
    <a href="http://www.druid.net/pygresql/">PyGreSQL</a>(pgdb)
  \end{rawhtml} or 
  \begin{rawhtml}
    <a href="http://pypgsql.sourceforge.net">PyPgSQL</a>
  \end{rawhtml}

\item[\begin{rawhtml}<a href="http://www.sqlite.org/">SQLite</a>\end{rawhtml}] tested with v2.8.3

Supported python adaptor: 
  \begin{rawhtml}
    <a href="http://pysqlite.sourceforge.net/">PySQLite</a>
  \end{rawhtml}
\end{description}

%The framework is currently in an alpha stage. There are several reasons for
%this, but the main ones are:
%\begin{itemize}
%\item it has not been used extensively tested 
%\item it has not been optimized at well (except for some particular points),
%\item there are still important points on the TODO list that needs to be done
%\end{itemize}

\input{www/menu-inline-end}
\end{document}

Index: main.tex
===================================================================
RCS file: /cvsroot/modeling/ProjectModeling/Modeling/doc/HomePage/main.tex,v
retrieving revision 1.27
retrieving revision 1.28
diff -C2 -d -r1.27 -r1.28
*** main.tex	13 Sep 2003 14:54:02 -0000	1.27
--- main.tex	16 Nov 2003 16:24:59 -0000	1.28
***************
*** 42,150 ****

! See also: the \begin{rawhtml}<a href="#disclaimer">disclaimer</a>\end{rawhtml}
! 
! \chapter{Features}
! 
! The framework allows you to transparently create, retrieve, update or delete
! python objects from a database without having to write a single line of
! SQL. It achieves this by offering you a container, the
! \verb+EditingContext+ (see the \begin{rawhtml}<a
! href="UserGuide/index.html">User's Guide</a>\end{rawhtml}) that is
! responsible for your objects.
! 
! Additionally the framework offers:
! 
! \begin{itemize}
! 
! \item A comprehensive model description language (XML) to specify how the object 
!       model is to map to a relational model,
! 
! \item Functional tools to help you designing your model (in the form of
!       either a Zope poduct, or a collection of standalone utility scripts),  
!       that can also validate your models against the
!       most common errors made when designing a model.
! 
! \item Generation of database schemas (including: primary keys, foreign keys,
!       referential constraints), generation of python code templates ready to
!       be used.
! 
! \item Support for transparent mapping of (class) inheritance in relational
!       databases.
! 
! \item A simple and powerful object-oriented query langage.
! 
! \item Once you get one or more objects, using that query langage, you do not
!       need to explicitly fetch the objects in relations to the ones you
!       already fetched. Rather, you simply use normal python getters to
!       traverse relationships, and the related objects are automatically
!       fetched, when needed and when appropriate. It helps you keep the memory
!       footprint of your applications reasonable, while keeping you away from
!       the SQL world.
! 
! \item Automatic checking for referential-integrity constraints, plus the
!       framework provides a unified place where to put your own validation
!       logic (objects' invariants, ...) so that they are integrated in the
!       checked constraints.
! 
! \item Automatically encloses all modifications made to a graph/set of objects
!       in a transactional scheme, so that the changes are all saved, or none
!       are saved.
! 
! \item Support for nested graphs/sets of objects.
! 
! 
! \item Works with python 2.1 and 2.2.
! \end{itemize}
! 
! \paragraph*{Supported RDBMS}
! 
! \begin{description}
! \item[\begin{rawhtml}<a href="http://www.mysql.com/">MySQL</a>\end{rawhtml}]
! tested with v3.23.52 and v4.0.13
! 
! Supported python adaptor: 
!   \begin{rawhtml}
!     <a href="http://sourceforge.net/projects/mysql-python">MySQL</a>
!   \end{rawhtml}
! 
! \item[\begin{rawhtml}<a href="http://www.oracle.com/">Oracle</a>\end{rawhtml}]
! tested with Oracle 8i (linux/8.1.7.0.1) and Oracle 9i (9.2.0.1.0/linux)
! 
! Supported python adaptor: 
!   \begin{rawhtml}
!     <a href="http://www.zope.org/Members/matt/dco2">DCOracle2</a>
!   \end{rawhtml}
! 
! 
! \item[\begin{rawhtml}<a href="http://www.postgresql.org/">Postgresql</a>\end{rawhtml}] versions 7.2 and 7.3 (see \begin{rawhtml}
! <a href="http://modeling.sourceforge.net/UserGuide/env-vars-postgresql.html">Postgresql specificities</a>\end{rawhtml} in the User's Guide if you're using v7.3).
! 
! 
! Supported python adaptors:
!   \begin{rawhtml}
!     <a href="http://initd.org/software/initd/psycopg">psycopg</a>
!   \end{rawhtml} or
!   \begin{rawhtml}
!     <a href="http://www.druid.net/pygresql/">PyGreSQL</a>(pgdb)
!   \end{rawhtml} or 
!   \begin{rawhtml}
!     <a href="http://pypgsql.sourceforge.net">PyPgSQL</a>
!   \end{rawhtml}
! 
! \item[\begin{rawhtml}<a href="http://www.sqlite.org/">SQLite</a>\end{rawhtml}] tested with v2.8.3

- Supported python adaptor: 
-   \begin{rawhtml}
-     <a href="http://pysqlite.sourceforge.net/">PySQLite</a>
-   \end{rawhtml}
- \end{description}

- %The framework is currently in an alpha stage. There are several reasons for
- %this, but the main ones are:
- %\begin{itemize}
- %\item it has not been used extensively tested 
- %\item it has not been optimized at well (except for some particular points),
- %\item there are still important points on the TODO list that needs to be done
- %\end{itemize}

  \begin{rawhtml}<hr noshade><a name="disclaimer">\end{rawhtml}
--- 42,49 ----

! See also: \begin{rawhtml}<a href="features.html">the list of the main
! features</a>.\end{rawhtml}

  \begin{rawhtml}<hr noshade><a name="disclaimer">\end{rawhtml}