diff --git a/README.md b/README.md index 9544410..456e4a7 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,15 @@ A simple [Object-Relation-Mapping](https://en.wikipedia.org/wiki/Object%E2%80%93 ### ORM +The idea behind the *ORM* is to map document fields to native Python object attributes, so that document values can be accessed by traversing the object property tree. + **CRUD OPERATIONS** ```python from innoldb.qldb import Document -document = Document('my-table') +# Create a document on `my_table` table. +document = Document('my_table') document.field = { 'nested_data': { 'array': ['colllection', 'of', 'things'] @@ -23,6 +26,15 @@ document.field = { document.save() ``` +```python +from innoldb.qldb import Document + +# Load a document from `my_table` table. +document = Document('my_table', id="123456") +for val in document.nested_data_array: + print(val) +``` + **Queries** ```python from innoldb.qldb import Query diff --git a/docs/build/doctrees/INTRODUCTION.doctree b/docs/build/doctrees/INTRODUCTION.doctree index 5080485..d907435 100644 Binary files a/docs/build/doctrees/INTRODUCTION.doctree and b/docs/build/doctrees/INTRODUCTION.doctree differ diff --git a/docs/build/doctrees/SETUP.doctree b/docs/build/doctrees/SETUP.doctree index 175dbe8..a08923c 100644 Binary files a/docs/build/doctrees/SETUP.doctree and b/docs/build/doctrees/SETUP.doctree differ diff --git a/docs/build/doctrees/TODOS.doctree b/docs/build/doctrees/TODOS.doctree index 3fa69c2..8f875b5 100644 Binary files a/docs/build/doctrees/TODOS.doctree and b/docs/build/doctrees/TODOS.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 475bbd4..cd7630d 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/innoldb.doctree b/docs/build/doctrees/innoldb.doctree index 492fddd..be4a625 100644 Binary files a/docs/build/doctrees/innoldb.doctree and b/docs/build/doctrees/innoldb.doctree differ diff --git a/docs/build/doctrees/innoldb.examples.doctree b/docs/build/doctrees/innoldb.examples.doctree new file mode 100644 index 0000000..f0704fb Binary files /dev/null and b/docs/build/doctrees/innoldb.examples.doctree differ diff --git a/docs/build/doctrees/innoldb.examples.example_ion.doctree b/docs/build/doctrees/innoldb.examples.example_ion.doctree new file mode 100644 index 0000000..0c638e8 Binary files /dev/null and b/docs/build/doctrees/innoldb.examples.example_ion.doctree differ diff --git a/docs/build/doctrees/innoldb.static.doctree b/docs/build/doctrees/innoldb.static.doctree index b49a72c..d223356 100644 Binary files a/docs/build/doctrees/innoldb.static.doctree and b/docs/build/doctrees/innoldb.static.doctree differ diff --git a/docs/build/html/CLI.html b/docs/build/html/CLI.html index 65fb72c..c055110 100644 --- a/docs/build/html/CLI.html +++ b/docs/build/html/CLI.html @@ -182,7 +182,7 @@
  • - Makpar Innovation Lab + makpar-innolab
  • @@ -293,7 +293,14 @@
  • - Modules + innoldb + + +
  • +
  • + + + Todos
  • diff --git a/docs/build/html/CONFIGURATION.html b/docs/build/html/CONFIGURATION.html index 65a72d0..a69b0db 100644 --- a/docs/build/html/CONFIGURATION.html +++ b/docs/build/html/CONFIGURATION.html @@ -182,7 +182,7 @@
  • - Makpar Innovation Lab + makpar-innolab
  • @@ -266,7 +266,14 @@
  • - Modules + innoldb + + +
  • +
  • + + + Todos
  • diff --git a/docs/build/html/INTRODUCTION.html b/docs/build/html/INTRODUCTION.html index 7b701ae..8ee4417 100644 --- a/docs/build/html/INTRODUCTION.html +++ b/docs/build/html/INTRODUCTION.html @@ -47,7 +47,7 @@ - Makpar Innovation Lab — innoldb v1.0.10 documentation + makpar-innolab — innoldb v1.0.10 documentation @@ -94,7 +94,7 @@
    Innovation Lab - Makpar Innovation Lab + makpar-innolab
    @@ -183,17 +183,25 @@ - + - Makpar Innovation Lab + makpar-innolab