Refactor orm into odm 'Object Data Mapper'

Author: MatteoGuadrini

README.md

@@ -637,15 +637,15 @@ print(type(resp))      # <class 'Neo4jResponse'>
 
 ```
 
-### ORM (Object-relational mapping)
-For each type of NOSQL database there is an _ORM (Object-relational mapping)_ module that contains classes and functions relating to the mapping of 
+### ODM (Object-Data Mapping)
+For each type of NOSQL database there is an _ODM (Object-relational mapping)_ module that contains classes and functions relating to the mapping of 
 objects and/or operations concerning the specific database _CRUD operation_.
 
-In the `nosqlapi.common.orm` module there are also classes that represent the data types of databases.
+In the `nosqlapi.common.odm` module there are also classes that represent the data types of databases.
 
 ```pycon
->>> import nosqlapi.common.orm
->>> [t for t in dir(nosqlapi.common.orm) if not t.startswith('__')]
+>>> import nosqlapi.common.odm
+>>> [t for t in dir(nosqlapi.common.odm) if not t.startswith('__')]
 ['Array', 'Ascii', 'Blob', 'Boolean', 'Counter', 'Date', 'Dc', 'Decimal', 'Double', 'Duration', 'Float', 'Inet', 'Int', 
 'List', 'Map', 'Null', 'SmallInt', 'Text', 'Time', 'Timestamp', 'Uuid', 'Varchar']
 ```

__info__.py

@@ -22,7 +22,7 @@
 
 """Information variable used by modules on this package."""
 
-__version__ = '1.0.0'
+__version__ = '1.0.1'
 __author__ = 'Matteo Guadrini'
 __email__ = '[email protected]'
 __homepage__ = 'https://github.com/MatteoGuadrini/nosqlapi'

docs/source/build.rst

@@ -19,7 +19,7 @@ Let's prepare the steps:
 
 * Create a package (directory with an ``__init__.py`` file) named **pycouch**.
 * write ``core.py``, with core classes and functions.
-* write ``utils.py``, with utility classes and function, like ORM objects.
+* write ``utils.py``, with utility classes and function, like ODM objects.
 
 Core
 ----
@@ -648,7 +648,7 @@ Utils
 -----
 
 The **utils** classes and functions they map objects that represent data on the CouchDB server.
-These types of objects are called *ORMs*.
+These types of objects are called *ODMs*.
 
 Create a ``utils.py`` module.
 
@@ -678,7 +678,7 @@ We will call it ``connect()``.
                     database=None, ca_cert=None, ca_bundle=None)
         return conn.connect()
 
-ORM classes
+ODM classes
 ***********
 
 Now let's define a ``DesignDocument`` class, which will represent a design document in the CouchDB server.
@@ -719,7 +719,7 @@ Now let's define a ``PermissionDocument`` class, which will represent a permissi
             self['members'] = {"names": [], "roles": []} if not members else members
 
 .. note::
-    Now that we have defined some classes that represent documents, we can adapt our methods of the Session class around these ORM types.
+    Now that we have defined some classes that represent documents, we can adapt our methods of the Session class around these ODM types.
 
 If you want to see more examples, clone the official repository of ``nosqlapi`` and find in the *tests* folder all the examples for each type of database.
 

docs/source/nosqlapi_column.rst

@@ -3,7 +3,7 @@
 nosqlapi column
 ===============
 
-In this package we find abstract classes and ORM classes concerning the **column** database types.
+In this package we find abstract classes and ODM classes concerning the **column** database types.
 
 client module
 -------------
@@ -48,17 +48,17 @@ This is an example of a library for connecting to a `cassandra <https://cassandr
     sess = conn.connect()                   # Session object
     ...
 
-orm module
+odm module
 ----------
 
-The **orm** module contains the specific object for *column* databases.
+The **odm** module contains the specific object for *column* databases.
 
-.. automodule:: nosqlapi.columndb.orm
+.. automodule:: nosqlapi.columndb.odm
     :members:
     :special-members:
     :show-inheritance:
 
-orm example
+odm example
 ***********
 
 These objects represent the respective *column* in databases.
@@ -68,7 +68,7 @@ These objects represent the respective *column* in databases.
     import nosqlapi
     import mycolumndb
 
-    keyspace = nosqlapi.columndb.orm.Keyspace('new_db')     # in short -> nosqlapi.columndb.Keyspace('new_db')
+    keyspace = nosqlapi.columndb.odm.Keyspace('new_db')     # in short -> nosqlapi.columndb.Keyspace('new_db')
     # Make columns
     id = nosqlapi.columndb.Column('id', of_type=int)
     id.auto_increment = True                                # increment automatically

docs/source/nosqlapi_common.rst

@@ -3,8 +3,8 @@
 nosqlapi common
 ===============
 
-In this package you will find the modules that contain common interfaces and `ORMs <https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping>`_
-(Object-relational mapping), shared by all four types of NOSQL database.
+In this package you will find the modules that contain common interfaces and `ODMs <https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping>`_
+(Object-Data Mapping), shared by all four types of NOSQL database.
 
 core module
 -----------
@@ -77,21 +77,21 @@ The exceptions stated in this form are used in certain circumstances. See the `t
     raise nosqlapi.UnknownError('in short')
 
 
-orm module
+odm module
 ----------
 
-In the **orm** module, we find generic classes represent real objects present in various NOSQL databases.
+In the **odm** module, we find generic classes represent real objects present in various NOSQL databases.
 
 .. note::
     These objects are not mandatory for the implementation of their own NOSQL module.
     Rather they serve to help the end user have some consistency in python.
 
-.. automodule:: nosqlapi.common.orm
+.. automodule:: nosqlapi.common.odm
     :members:
     :special-members:
     :show-inheritance:
 
-orm example
+odm example
 ***********
 
 The classes within the module are python representations of real objects in the database.
@@ -100,7 +100,7 @@ The classes within the module are python representations of real objects in the
 
     import nosqlapi
 
-    null = nosqlapi.common.orm.Null()     # compare with null object into database
+    null = nosqlapi.common.odm.Null()     # compare with null object into database
     null = nosqlapi.Null()                # in short
     map_ = nosqlapi.Map()                 # like dict
     inet = nosqlapi.Inet('192.168.1.1')   # ipv4/ipv6 addresses

docs/source/nosqlapi_doc.rst

@@ -3,7 +3,7 @@
 nosqlapi document
 =================
 
-In this package we find abstract classes and ORM classes concerning the **document** database types.
+In this package we find abstract classes and ODM classes concerning the **document** database types.
 
 client module
 -------------
@@ -49,17 +49,17 @@ This is an example of a library for connecting to a `mongodb <https://www.mongod
     sess = conn.connect()                   # Session object
     ...
 
-orm module
+odm module
 ----------
 
-The **orm** module contains the specific object for *document* databases.
+The **odm** module contains the specific object for *document* databases.
 
-.. automodule:: nosqlapi.docdb.orm
+.. automodule:: nosqlapi.docdb.odm
     :members:
     :special-members:
     :show-inheritance:
 
-orm example
+odm example
 ***********
 
 These objects represent the respective *document* in databases.
@@ -70,7 +70,7 @@ These objects represent the respective *document* in databases.
     import mydocdb
 
     # Create database
-    db = nosqlapi.docdb.orm.Database('test')
+    db = nosqlapi.docdb.odm.Database('test')
     # Create documents
     doc1 = nosqlapi.docdb.Document(oid=1)
     doc2 = nosqlapi.docdb.Document(oid=2)

docs/source/nosqlapi_graph.rst

@@ -3,7 +3,7 @@
 nosqlapi graph
 ==============
 
-In this package we find abstract classes and ORM classes concerning the **graph** database types.
+In this package we find abstract classes and ODM classes concerning the **graph** database types.
 
 client module
 -------------
@@ -48,17 +48,17 @@ This is an example of a library for connecting to a `neo4j <https://neo4j.com/>`
     sess = conn.connect()                   # Session object
     ...
 
-orm module
+odm module
 ----------
 
-The **orm** module contains the specific object for *graph* databases.
+The **odm** module contains the specific object for *graph* databases.
 
-.. automodule:: nosqlapi.graphdb.orm
+.. automodule:: nosqlapi.graphdb.odm
     :members:
     :special-members:
     :show-inheritance:
 
-orm example
+odm example
 ***********
 
 These objects represent the respective *graph* in databases.
@@ -69,7 +69,7 @@ These objects represent the respective *graph* in databases.
     import mygraphdb
 
     # Create database
-    db = nosqlapi.graphdb.orm.Database('test')
+    db = nosqlapi.graphdb.odm.Database('test')
     # Create nodes
     node1 = nosqlapi.graphdb.Node(var='n1', labels=[nosqlapi.graphdb.Label('Person')],
                                   properties=nosqlapi.graphdb.Property({'name': 'Matteo', 'age': 35}))

docs/source/nosqlapi_kv.rst

@@ -3,7 +3,7 @@
 nosqlapi key-value
 ==================
 
-In this package we find abstract classes and ORM classes concerning the **Key-Value** database types.
+In this package we find abstract classes and ODM classes concerning the **Key-Value** database types.
 
 client module
 -------------
@@ -49,17 +49,17 @@ This is an example of a library for connecting to a `redis <https://redis.io/>`_
     sess = conn.connect()                   # Session object
     ...
 
-orm module
+odm module
 ----------
 
-The **orm** module contains the specific object for *key-value* databases.
+The **odm** module contains the specific object for *key-value* databases.
 
-.. automodule:: nosqlapi.kvdb.orm
+.. automodule:: nosqlapi.kvdb.odm
     :members:
     :special-members:
     :show-inheritance:
 
-orm example
+odm example
 ***********
 
 These objects represent the respective *key-value* in databases.
@@ -68,7 +68,7 @@ These objects represent the respective *key-value* in databases.
 
     import nosqlapi
 
-    transaction = nosqlapi.kvdb.orm.Transaction()       # in short -> nosqlapi.kvdb.Transaction()
+    transaction = nosqlapi.kvdb.odm.Transaction()       # in short -> nosqlapi.kvdb.Transaction()
     # Add commands
     transaction.add('ACL LIST')
     transaction.add('ACL DELUSER test')

nosqlapi/columndb/__init__.py

@@ -23,4 +23,4 @@
 """Package column NOSQL database."""
 
 from nosqlapi.columndb.client import ColumnConnection, ColumnSelector, ColumnSession, ColumnResponse, ColumnBatch
-from nosqlapi.columndb.orm import Keyspace, Table, Column, Index, column
+from nosqlapi.columndb.odm import Keyspace, Table, Column, Index, column

nosqlapi/columndb/orm.py renamed to nosqlapi/columndb/odm.py

@@ -3,7 +3,7 @@
 # vim: se ts=4 et syn=python:
 
 # created by: matteo.guadrini
-# orm -- nosqlapi
+# odm -- nosqlapi
 #
 #     Copyright (C) 2022 Matteo Guadrini <[email protected]>
 #
@@ -20,14 +20,14 @@
 #     You should have received a copy of the GNU General Public License
 #     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""ORM module for column NOSQL database."""
+"""ODM module for column NOSQL database."""
 
 # region Imports
 from collections import namedtuple
 from functools import wraps
 
 from nosqlapi.common import Counter
-from nosqlapi.kvdb.orm import Keyspace as Ks
+from nosqlapi.kvdb.odm import Keyspace as Ks
 
 # endregion