diff options
| author | James Moger <james.moger@gmail.com> | 2011-08-04 14:10:59 -0400 |
|---|---|---|
| committer | James Moger <james.moger@gmail.com> | 2011-08-04 14:10:59 -0400 |
| commit | 3d1e36c31e2a8354e03cdfe12565503190c2e957 (patch) | |
| tree | c81ed9b643c7f787f983e6199d352cf11b26a32f /docs | |
| parent | d32c1f4d1eccbe0b9dd7c557d52879c8ec01069a (diff) | |
| download | iciql-3d1e36c31e2a8354e03cdfe12565503190c2e957.tar.gz iciql-3d1e36c31e2a8354e03cdfe12565503190c2e957.zip | |
Overhauling annotations.
* @IQSchema(name="public") -> @IQSchema("public")
* @IQDatabase(version=2) -> @IQVersion(2)
* @IQTable(version=2) -> @IQVersion(2)
* @IQIndex annotation simplified to be used for one index definition and
expanded to specify index name
* added @IQIndexes annotation to specify multiple IQIndex annotations
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/01_model_classes.mkd | 8 | ||||
| -rw-r--r-- | docs/02_table_versioning.mkd | 4 | ||||
| -rw-r--r-- | docs/05_releases.mkd | 21 |
3 files changed, 23 insertions, 10 deletions
diff --git a/docs/01_model_classes.mkd b/docs/01_model_classes.mkd index 3ca7630..a0db6a1 100644 --- a/docs/01_model_classes.mkd +++ b/docs/01_model_classes.mkd @@ -64,8 +64,7 @@ Please consult the `com.iciql.ModelUtils` class for details. 2. the model class must have a default public constructor
### Configuration Limitations
-1. index names can not be specified
-2. triggers, views, and other advanced database features are unimplemented
+Triggers, views, and other advanced database features are unimplemented.
## Annotation Configuration
The recommended approach to setup a model class is to annotate the class and field declarations.
@@ -89,7 +88,10 @@ import com.iciql.Iciql.IQIndex; import com.iciql.Iciql.IQTable;
@IQTable
-@IQIndex(standard = {"productName", "category"})
+@IQIndexes({
+ @IQIndex({"productName", "category"}),
+ @IQIndex(name="nameindex", value="productName")
+})
public class Product {
@IQColumn(primaryKey = true)
diff --git a/docs/02_table_versioning.mkd b/docs/02_table_versioning.mkd index 0c778cb..4650f74 100644 --- a/docs/02_table_versioning.mkd +++ b/docs/02_table_versioning.mkd @@ -3,9 +3,9 @@ Iciql supports an optional, simple versioning mechanism. There are two parts to the mechanism.
1. You must supply an implementation of `com.iciql.DbUpgrader` to your `com.iciql.Db` instance.
-2. One or more of your table model classes must set the *version* field of the `com.iciql.IQTable` annotation<br>
+2. One or more of your table model classes must specify the `IQVersion(version)` annotation<br>
AND/OR<br/>
-Your `com.iciql.DbUpgrader` implementation must set the *version* field of the `com.iciql.IQDatabase` annotation
+Your `com.iciql.DbUpgrader` implementation must specify the `IQVersion(version)` annotation
### How does it work?
If you choose to use versioning, iciql will maintain a table within your database named *_iq_versions* which is defined as:
diff --git a/docs/05_releases.mkd b/docs/05_releases.mkd index f63a171..db29860 100644 --- a/docs/05_releases.mkd +++ b/docs/05_releases.mkd @@ -3,6 +3,21 @@ ### Current Release
**%VERSION%** ([zip](http://code.google.com/p/iciql/downloads/detail?name=%ZIP%)|[jar](http://code.google.com/p/iciql/downloads/detail?name=%JAR%)) *released %BUILDDATE%*
+- api change release (API v2)
+- annotations overhaul to reduce verbosity
+ - @IQSchema(name="public") -> @IQSchema("public")
+ - @IQDatabase(version=2) -> @IQVersion(2)
+ - @IQTable(version=2) -> @IQVersion(2)
+ - @IQIndex annotation simplified to be used for one index definition and expanded to specify index name
+ - added @IQIndexes annotation to specify multiple IQIndex annotations<br/>
+%BEGINCODE%
+@IQIndexes({ @IQIndex("name"), @IQIndex(name="myindexname" value={"name", "nickname"}) })
+%ENDCODE%
+
+### Older Releases
+
+**0.5.0** ([zip](http://code.google.com/p/iciql/downloads/detail?name=iciql-0.5.0.zip)|[jar](http://code.google.com/p/iciql/downloads/detail?name=iciql-0.5.0.jar)) *released 2011-08-03*
+
- initial release (API v1)
*API changes compared to JaQu from H2 1.3.157 sources*
@@ -32,8 +47,4 @@ - QueryConditon.bigger => QueryCondition.exceeds
- QueryConditon.biggerEqual => QueryCondition.atLeast
- QueryConditon.smaller => QueryCondition.lessThan
- - QueryConditon.smallEqual => QueryCondition.atMost
-
-### Older Releases
-
-none
\ No newline at end of file + - QueryConditon.smallEqual => QueryCondition.atMost
\ No newline at end of file |