Merge lp:~hingo/drizzle/ipv6-doc-fixes into lp:~drizzle-trunk/drizzle/development

[Henrik Ingo]

Update IPv6 data type docs with examples from the white paper and some cleanup.

=== modified file 'docs/columntypes.rst'
--- docs/columntypes.rst	2011-08-17 06:10:57 +0000
+++ docs/columntypes.rst	2012-03-19 09:06:19 +0000
@@ -9,7 +9,8 @@
 on these types are by default the full length of the data stored.
 The only difference between the two types is the COLLATION which is
 used. VARBINARY uses a binary collation for all index usage. VARCHAR can only
-contain valid UTF-8 characters. If you need to store ASCII values the VARBINARY type.
+contain valid UTF-8 characters. If you need to store ASCII values the VARBINARY 
+type.
 
 -------------
 TEXT and BLOB
@@ -26,7 +27,8 @@
 ---------
 
 BIGINT and INTEGER exist as Drizzle's two integer numerical types. BIGINT is
-a 64bit integer while INTEGER is a 32bit integer. Declaring a numerical types as UNSIGNED the value to be 64bit.
+a 64 bit integer while INTEGER is a 32 bit integer. Declaring a numerical types 
+as  UNSIGNED causes the value to be 64 bit.
 
 DOUBLE is the systems native double type.
 
@@ -44,7 +46,9 @@
 
 TIME
 
-TIMESTAMP can be supplied an optional parameter of (6) during creation. This causes microseconds to be recorded as well. The TIME type represents duration of an event in seconds.
+TIMESTAMP can be supplied an optional parameter of (6) during creation. This 
+causes microseconds to be recorded as well. The TIME type represents duration 
+of an event in seconds.
 
 ----
 ENUM
@@ -62,8 +66,16 @@
 increasing order as rows are inserted into the table. The actual type is a
 BIGINT.
 
+----
+IPV6
+----
+
+IPV6 is a special column type that allows you to insert and query both IPv4 and
+IPv6 addresses in their human readable presentation forms (e.g. 127.0.0.1 and 
+::1 respectively) but stores them as binary 128 bit values. For example usage,
+see:
+
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    ipv6_data_type
-
 
=== modified file 'docs/ipv6_data_type.rst'
--- docs/ipv6_data_type.rst	2011-08-21 23:08:13 +0000
+++ docs/ipv6_data_type.rst	2012-03-19 09:06:19 +0000
@@ -1,13 +1,17 @@
 IPV6 Data Type
 ==============
 
-The data type IPV6 stores Internet Protocol version(IPv) 4 & 6 addresses. 
-
-This data type is a 128-bit quantity that is generated by an algorithm designed to make it very unlikely that the same data type will be generated by anyone else in the world using the same algorithm. 
-
-IPv6 address are written in preferred form as x:x:x:x:x:x:x:x, where the 'x's are the hexadecimal values of the eight 16-bit pieces of the address separated by colons. Leading zeros in a group are allowed to be dropped, upper and lower case are equivalent. For example:
-
-	 1080:0:0:0:8:800:200C:417A  a unicast address
+The data type IPV6 stores Internet Protocol version(IPv) 4 & 6 addresses. [1]_
+
+About IPv6
+----------
+
+IPv6 address are written in preferred form as x:x:x:x:x:x:x:x, where the 'x's 
+are the hexadecimal values of the eight 16 bit pieces of the address separated 
+by colons. Leading zeros in a group are allowed to be dropped, upper and lower 
+case are equivalent. For example:
+
+         1080:0:0:0:8:800:200C:417A  a unicast address
          FF01:0:0:0:0:0:0:101        a multicast address
          0:0:0:0:0:0:0:1             the loopback address
          0:0:0:0:0:0:0:0             the unspecified addresses
@@ -19,10 +23,64 @@
          ::1                         the loopback address
          ::                          the unspecified addresses
 
-The IPV6 data type support to store IPv4 address in both formats. 
+The IPV6 data type supports storing also IPv4 address in both formats. 
+
 For example:
 
 ::192.168.1.10 or 192.168.1.10
 
-IPV6 are documented as part of Standard Track :rfc:'2373'.
+
+Example usage
+-------------
+
+Creating a database schema and changing to using the schema as default.
+
+.. code-block:: mysql
+
+        CREATE SCHEMA ipaddress;
+        use ipaddress;
+
+
+Creating a table with a IPV6 column:
+
+.. code-block:: mysql
+
+        CREATE TABLE ipaddress_table (addr IPV6);
+
+Adding data to the table:
+
+.. code-block:: mysql
+
+        INSERT INTO ipaddress_table (addr) 
+        VALUES ("fe8::b3ff:fe1a:8329");
+
+The above command adds one row to the database. IPv4 addresses can be inserted 
+to the same column as well. The IPV6 data type handles the distinction between 
+IPv4 & IPv6 addresses internally:
+
+.. code-block:: mysql
+
+        INSERT INTO ipaddress_table (address) 
+        VALUES ("192.168.100.10");
+
+Querying the table:
+
+.. code-block:: mysql
+
+        SELECT * FROM ipaddress_table;         
+
+        address                      
+        0fe8:0000:0000:0000:0000:beff:fe1a:8329
+        000:000:000:000:000:000:192.168.100.010
+
+Authors
+-------
+
+:Code: Muhammad Umair, Mark Atwood
+:Documentation: Muhammad Umair, Henrik Ingo
+
+
+.. rubric:: Footnotes
+
+.. [1] IPv6 is documented as part of the IETF Standard Track `RFC 2373 <http://www.ietf.org/rfc/rfc2373.txt>`_.