-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add outline for remaining docs sections #13
- Loading branch information
1 parent
35f65bb
commit c519588
Showing
6 changed files
with
209 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
------------ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
------------ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |