codernity avatar codernity committed 8ffd5f7

Documentation updates

Comments (0)

Files changed (5)

 .. |CodernityDB-PyClient-link| replace:: CodernityDB-PyClient_
 .. |cdb_repo| replace:: https://bitbucket.org/codernity/codernitydb
 .. |CodernityDB-demos| replace:: `CodernityDB Demos`_
+.. |bitbucket_link| replace:: `CodernityDB @ Bitbucket`_
 
-.. _CodernityDB Demos: http://bitbucket.org/Codernity/codernitydb-demos
+.. _CodernityDB @ Bitbucket: http://bitbucket.org/codernity/codernitydb
+.. _CodernityDB Demos: http://bitbucket.org/codernity/codernitydb-demos
 .. _CodernityDB-HTTP: http://labs.codernity.com/codernitydb-http
 .. _CodernityDB-PyClient: http://labs.codernity.com/codernitydb-pyclient
 """
 How it's build
 --------------
 
-CodernityDB is build from 3 important parts
+CodernityDB is build from 3 important parts. Please read also :ref:`database_operations_description` to understand how CodernityDB works.
 
 
 Database
 
 .. _database_operations_description:
 
-Database operations
--------------------
+Database operations flow
+------------------------
 
-
-During insert into database, incomming data are passed to
+During insert into database, incomming data is passed to
 ``make_key_value`` functions in *all* indexes in order of adding or
 changing them in database.
-On query operations function ``make_key`` is called in order to get
+On query operations function ``make_key`` is called to get
 valid key for the given index.
+So having more indexes affects write speed, but does not affect read speed at all.
 
 .. note::
 
 Can I add index to existing DB ?
     Yes you can, but you will need to reindex that index to have in it data that were in database already before you add that index. (see :ref:`database_indexes` for details)
 
+Why Python 3 is not supported ?
+    Python 3 introduced many incompatible changes. In case of CodernityDB having working version for 2.x and 3.x series in the same codebase without ugly hacks (big monkey-patching etc) is almost impossible. If you're interested Python 3 version of CodernityDB contact us. Porting CodernityDB to Python 3.x is not hard. Python 3.x support in fact was never needed. That's why there is no support for it (yet?).
+
 I want to contribute, what can I do?
-    Just fork and create pull request on bitbucket.
+    Just fork and create pull request |bitbucket_link|.
 
 I found a bug, where can I report it?
-    Please report it on Bitbucket bugtracker in our repo|cdb_repo|.
+    Please report it on Bitbucket bugtracker in our repo |bitbucket_link|.
 
 I want to have a bit customized CodernityDB
-    No problem, just contact us to get more details about that.
+    No problem, just contact us to get more details about that.
 CodernityDB pure python, NoSQL, fast database
 =============================================
 
-CodernityDB is opensource, pure python (no 3rd party dependency), fast (really fast check :ref:`speed` if you don't believe in words), multiplatform, schema-less, NoSQL_ database. It has optional support for HTTP server version (|CodernityDB-HTTP-link|), and also Python client library (|CodernityDB-PyClient-link|) that aims to be 100% compatible with embeded version.
+CodernityDB is opensource, pure Python (no 3rd party dependency), fast (really fast check :ref:`speed` if you don't believe in words), multiplatform, schema-less, NoSQL_ database. It has optional support for HTTP server version (|CodernityDB-HTTP-link|), and also Python client library (|CodernityDB-PyClient-link|) that aims to be 100% compatible with embeded version.
 
 .. image:: CodernityDB.png
     :align: center
 Key features
 ~~~~~~~~~~~~
 
-* Native python database
+* Native Python database
 * Multiple indexes
 * Fast (more than 50 000 insert operations per second see :ref:`speed` for details)
 * Embeded mode (default) and :ref:`Server<server>`, with client library that aims to be 100% compatible with embeded one.
 Install
 ~~~~~~~
 
-.. Because CodernityDB is pure Python you need to perform standard installation for Python applications ::
-..
-..     pip install CodernityDB
-..
-.. or using easy_install::
-..
-..     easy_install CodernityDB
-..
-.. or from sourcess::
-..
-..     hg clone ssh://hg@bitbucket.org/codernity/codernitydb
-..     python setup.py install
+Because CodernityDB is pure Python you need to perform standard installation for Python applications::
 
-CodernityDB is pure Python. So you just need to::
+   pip install CodernityDB
 
-     hg clone ssh://hg@bitbucket.org/codernity/codernitydb
-     python setup.py install
+or using easy_install::
 
-In near future we will publish packages on PyPi.
+   easy_install CodernityDB
+
+or from sources::
+
+   hg clone ssh://hg@bitbucket.org/codernity/codernitydb
+   cd codernitydb
+   python setup.py install
 
 
 Contribute & Bugs & Requests
     :maxdepth: 2
 
     design
+    database_indexes
 
     how_its_tested
     speed
-    database_indexes
+
     server
     deployment
 
 
 .. note::
 
-    Please note that Operatig system and/or python will optimize disk
+    Please note that Operatig system and/or Python will optimize disk
     read calls, in "same ``_id`` get" test there were much less system calls to
     ``read`` function than 100 000.
 
      - 1836.0719955
 
 
-CodernityDB slow downs on when there is a lot of records in database, but as you can see it performs pretty stable. And remember, Kyoto Cabinet is C++ database while CodernityDB is pure python.
+CodernityDB slow downs on when there is a lot of records in database, but as you can see it performs pretty stable. And remember, Kyoto Cabinet is C++ database while CodernityDB is pure Python.
 
 
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.