From d479253768d296a40b4f699e1de9b03c7146a97a Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- .../com/amazon/carbonado/lob/package-summary.html | 234 +++++++++++++++++++++ 1 file changed, 234 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/lob/package-summary.html (limited to 'apidocs/com/amazon/carbonado/lob/package-summary.html') diff --git a/apidocs/com/amazon/carbonado/lob/package-summary.html b/apidocs/com/amazon/carbonado/lob/package-summary.html new file mode 100644 index 0000000..93d2196 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-summary.html @@ -0,0 +1,234 @@ + + + + + + +com.amazon.carbonado.lob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Package com.amazon.carbonado.lob

+
+
Support for LOB property types, which are Large OBjects.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.lob Description

+
Support for LOB property types, which are Large OBjects. Properties declared + as Blob or Clob are treated differently than regular + properties. In particular: + +
    +
  • Repository typically stores LOB data external from enclosing storable +
  • LOBs are accessed in a manner similar to how files are accessed +
  • LOB data is often read/written in chunks, so consider accessing in a transaction scope +
  • LOBs cannot be annotated with PrimaryKey, Key, Index, Join, + Version, or Sequence +
  • LOBs cannot be used in a query filter +
+ +

Also, setting a LOB property does not dirty that property unless the new + LOB is unequal. Updating a LOB property typically involves operating on the + LOB itself. Setting the LOB property again is useful only when completely + replacing the data, which can be a relatively expensive operation. + +

Some repositories require that large text data be stored as a LOB. If the + text property is intended to fit entirely in memory, consider defining the + property as a String instead of a LOB. This allows the repository to decide + if it is appropriate to store it as a LOB. If explicit control over charset + encoding is required, add a TextAdapter annotation.

+
+ +
+ + + + + +
+ + +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + -- cgit v1.2.3