Merge lp:~ahayzen/htd/htd32_docs_update into lp:htd

[Andrew Hayzen]

* Update of docs

[Andrew Hayzen (ahayzen)]

review: Approve

=== modified file 'docs/apichanges.rst'
--- docs/apichanges.rst	2013-03-01 03:31:03 +0000
+++ docs/apichanges.rst	2013-06-25 22:11:32 +0000
@@ -4,8 +4,46 @@
 
 .. sectionauthor:: Andrew Hayzen
 
+
+----------
+Attributes
+----------
+
+ * Addition of rename method so attributes can easily be renamed
+
+
+------------
+File Formats
+------------
+
+ * Addition of FIXED_WIDTH_FOLDER file type
+
 ----------
 Connection
 ----------
 
- * Addition of relation property that lists the relationships in a connection
\ No newline at end of file
+ * Addition of relation property that lists the relationships in a connection
+ * Addition of support for __contains__, for example check if a table exists in a database
+ 
+ ::
+    
+    >>> "customer" in connection
+    True
+ 
+------
+Cursor
+------
+
+ * Addition of copy method so a table can be copied
+ * Addition of convert method to convert tables between different file formats
+ * Addition of lock_to_thread and unlock_from_thread methods
+ * Update method now has start and stop parameters
+ 
+ 
+------
+Record
+------
+
+ * Addition of concurrency control to records
+ * Addition of version property for concurrency control
+ * Addition of clear_version method for concurrency control
\ No newline at end of file

=== modified file 'docs/cursorobject.rst'
--- docs/cursorobject.rst	2013-04-10 20:36:13 +0000
+++ docs/cursorobject.rst	2013-06-25 22:11:32 +0000
@@ -121,7 +121,7 @@
         
     .. method:: __getitem__(key)
 
-        Retrieve the data of a specific record in the table, where key is the identifier of the record. This will return a dictionary array with the data for the record sorted in their repective attributes. Furthermore this method supports slicing.
+        Retrieve the data of a specific record in the table, where key is the identifier of the record. This will return a dictionary array with the data for the record sorted in their respective attributes. Furthermore this method supports slicing.
         
         An example of how to use this method is shown below, assuming the 'standard table' has been created using the example code at the top of this page and has been run directly before.
         
@@ -418,6 +418,18 @@
             >>> cursor.location
             '/tmp/table.htd'
             
+    .. method:: lock_to_thread([thread=None])
+    
+        Lock the table to the thread, so that no other threads/processes can make changes. This is useful for performing tasks that need to be done in a specific order or for performance benefits.
+        
+        An example of locking the table to a the current thread is shown below.
+        
+        ::
+        
+            >>> cursor.lock_to_thread()
+            
+        .. warning:: The unlock_from_thread method must be called after the transactions have been completed. 
+            
     .. method:: rename(location [, replace=False])
     
         Rename the table to the new `location` given, with the option to replace any existing files.
@@ -455,6 +467,16 @@
         
         .. note:: This function will return a generator of the values for a specific attribute of all the records in the table within the limits.
         
+    .. method:: unlock_from_thread([thread=None])
+    
+        Unlock the table from a thread.
+        
+        An example of unlocking the table from the current thread is shown below.
+        
+        ::
+        
+            >>> cursor.unlock_from_thread()
+        
     .. method:: update([start=0, [stop=False, [where=None, [args={}]]]])
     
         The update method allows you to easily update multiple records with new data, the *where* parameter works in the same way as in the delete and select methods. The *start* and *end* is the index range to retrieve.

=== modified file 'docs/htdobject.rst'
--- docs/htdobject.rst	2013-04-20 15:08:15 +0000
+++ docs/htdobject.rst	2013-06-25 22:11:32 +0000
@@ -444,12 +444,27 @@
                 
         The data stored in the table is all of the same width (with one extra byte at the end of each section of data to signify the end of the data and to detect a NULL value). Therefore the performance of this format is much faster because the position of each record can be calulated quickly. However because the data is stored in fixed width format it can take up far more space than the VARIABLE_WIDTH_FILE.
     
-    To use the FIXED_WIDTH file type, see the example below.
+        To use the FIXED_WIDTH_FILE file type, see the example below.
+        
+        ::
+            
+            >>> htd.FileTypes.FIXED_WIDTH_FILE
+            <class 'htd._workers.file_fix.FIXED_WIDTH_FILE'>
+        
+    .. attribute:: FIXED_WIDTH_FOLDER
     
-    ::
-        
-        >>> htd.FileTypes.FIXED_WIDTH_FILE
-        <class 'htd._workers.file_fix.FIXED_WIDTH_FILE'>
+        This file type is used for large and high performance tables.
+        
+        The data is stored in a fixed width format, with no data being deleted - just overwritten.
+        
+        .. note:: This is a prototype data format which will be expanded upon in future releases 
+        
+        To use the FIXED_WIDTH_FOLDER file type, see the example below.
+        
+        ::
+            
+            >>> htd.FileTypes.FIXED_WIDTH_FOLDER
+            <class 'htd._workers.file_fix.FIXED_WIDTH_FOLDER'>
     
     .. attribute:: VARIABLE_WIDTH_FILE
         
@@ -459,12 +474,12 @@
         
         .. note:: This is the default file type that will be used in HTD, this can be changed in the :class:`Register`.
     
-    To use the VARIABLE_WIDTH file type, see the example below.
-    
-    ::
+        To use the VARIABLE_WIDTH file type, see the example below.
         
-        >>> htd.FileTypes.VARIABLE_WIDTH_FILE
-        <class 'htd._workers.file_fix.VARIABLE_WIDTH_FILE'>
+        ::
+            
+            >>> htd.FileTypes.VARIABLE_WIDTH_FILE
+            <class 'htd._workers.file_fix.VARIABLE_WIDTH_FILE'>
         
     .. note:: htd.FileTypes is the initialised class and therefore doesn't need to be initialised.
 
@@ -565,7 +580,7 @@
     
     .. note:: The directory must already exist and the file must not already exist.
 
-    The second parameter is *identifer*, this is the identifer(s) which will be used in the table. If a single identifer is sent then this will be set as the primary key, if a list is sent then they will be set as the composite key. 
+    The second parameter is *identifier*, this is the identifier(s) which will be used in the table. If a single identifier is sent then this will be set as the primary key, if a list is sent then they will be set as the composite key. 
     
     The identifiers must be a list of the names of the attributes, these must then exist in the *attributes* parameter.
     

=== modified file 'setup.py'
--- setup.py	2013-05-12 19:04:42 +0000
+++ setup.py	2013-06-25 22:11:32 +0000
@@ -42,15 +42,18 @@
                    "Operating System :: Microsoft :: Windows"],
       packages=['htd32', 'htd32/_base', 'htd32/_objects', 'htd32/_workers',
                 'htd32/_workers/file_fix', 'htd32/_workers/file_var',
+                'htd32/_workers/folder_fix',
                 'htd32/_workers/header', 'htd32/_workers/index',
-                'htd32/_workers/search'],
+                'htd32/_workers/search', 'htd32/_workers/tree'],
       package_dir={'htd32': 'htd32',
                    'htd32/_base': 'htd32/_base',
                    'htd32/_objects': 'htd32/_objects',
                    'htd32/_workers': 'htd32/_workers',
                    'htd32/_workers/file_fix': 'htd32/_workers/file_fix',
                    'htd32/_workers/file_var': 'htd32/_workers/file_var',
+                   'htd32/_workers/folder_fix': 'htd32/_workers/folder_fix',
                    'htd32/_workers/header': 'htd32/_workers/header',
                    'htd32/_workers/index': 'htd32/_workers/index',
-                   'htd32/_workers/search': 'htd32/_workers/search'}
+                   'htd32/_workers/search': 'htd32/_workers/search',
+                   'htd32/_workers/tree': 'htd32/_workers/tree'}
       )