Skip to content

Commit

Permalink
Add outline for remaining docs sections #13
Browse files Browse the repository at this point in the history
  • Loading branch information
numberoverzero committed Jul 10, 2016
1 parent 35f65bb commit c519588
Show file tree
Hide file tree
Showing 6 changed files with 209 additions and 11 deletions.
45 changes: 44 additions & 1 deletion docs/user/atomic.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Atomic Operations
=================
^^^^^^^^^^^^^^^^^

TODO copied from another draft

Expand Down Expand Up @@ -34,3 +34,46 @@ Then the following two calls are equivalent:
These are simple atomic conditions - the condition is built by iterating the set of columns that were loaded from
DynamoDB through ``Engine.load``, ``Engine.query``, ``Engine.scan``, or saved to DynamoDB through ``Engine.save`` or
``Engine.delete``.

Quick Example
=============

Network Failures
================

increment an integer and get a 500 - read again and it's incremented. was that us, or someone else?

Consistent vs Atomic
====================

'latest version at time of call' vs 'unchanged since last load'

Usage
=====

atomic=True
engine config

Scenarios
=========

New Instance
------------

atomic save on an instance before it's been saved or loaded from dynamo

Loaded
------

loaded from dynamo, not changed

Scenario C: Loaded

loaded from dynamo, modified by another writer

Partial Query
-------------

query doesn't load all columns
atomic condition only on loaded
(other writer can modify not loaded column)
79 changes: 77 additions & 2 deletions docs/user/conditions.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,79 @@
Conditions
==========
^^^^^^^^^^

TODO
Quick Examples
==============

Save if not Finalized
---------------------

model with a finalized field, save if finalized is False, catch and throw illegal state

Filter by Time Range
--------------------

scan tweets created between two dates

Atomic Delete
-------------

atomic=True

Available Conditions
====================

Comparisons
-----------

``between``
-----------

``in_``
-------

``is_``
-------

``is_not``
----------

``begins_with``
---------------

``contains``
------------

Bitwise Operators
-----------------

Conditional Save
================

Conditional Delete
==================

Query, Scan
===========

Key Conditions
--------------

========
Hash Key
========

=========
Range Key
=========

Filter Condition
----------------

Atomic Conditions
=================

By Hand
-------

Save, Delete
------------
4 changes: 2 additions & 2 deletions docs/user/custom_types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -426,8 +426,8 @@ and ``_dump`` above, so that the dynamo_* functions only handle non-null data.
You SHOULD NOT map None to a value other than None and vice versa, as bloop leverages in multiple areas the convention
that None represents omission; from the tracking system to the base model's load/dump methods.

Recursive Load and Dump
-----------------------
Recursive Load, Dump
--------------------

Because ``bind`` can return any two functions, you MUST NOT rely on a type having ``_load``, ``_dump``,
``dynamo_load``, or ``dynamo_dump`` methods. If you need to load or dump a value through a different type, you MUST
Expand Down
53 changes: 51 additions & 2 deletions docs/user/debugging.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,53 @@
Debugging
=========
^^^^^^^^^

TODO
Logging
=======

Wire
----

Config
------

Models
------

Sample Calls
============

Load
----

Save
----

Delete
------

Query
-----

Scan
----

Exceptions
==========

BloopException
--------------

AbstractModelException
----------------------

ConstraintViolation
-------------------

NotModified
-----------

TableMismatch
-------------

UnboundModel
------------
4 changes: 2 additions & 2 deletions docs/user/declarative_modeling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,5 +81,5 @@ Models as Views
Table Validation
----------------

Overlapping Attribute Types
---------------------------
Overlapping Attributes
----------------------
35 changes: 33 additions & 2 deletions docs/user/modifying_objects.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,35 @@
Modifying Objects
=================
^^^^^^^^^^^^^^^^^

TODO
Save
====

Quick Example
-------------

New Objects
-----------

Partial Updates
---------------

Maps and Paths
--------------

Link to map issue; diff-based updates not possible with paths

Delete
======

Quick Example
-------------

Conditions
==========

link to conditions page

Atomic
======

link to atomic page

0 comments on commit c519588

Please sign in to comment.