From d954f49e8058b77e66c366f5b1340e242ed0cc62 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov The 12.1.1
table
table
specifier specifies the table name that should
- be used to store objects of a class in a relational database. For
- example:
#pragma db object table("people") @@ -9169,7 +9169,7 @@ class person12.1.2
pointer
The
@@ -9219,7 +9219,7 @@ class personpointer
specifier specifies the object pointer type - for a persistent class. The object pointer type is used to return, + for the persistent class. The object pointer type is used to return, pass, and cache dynamically allocated instances of a persistent class. For example:12.1.3
-abstract
The
abstract
specifier specifies that a persistent class +The
@@ -9803,14 +9803,14 @@ class employerabstract
specifier specifies that the persistent class is abstract. An instance of an abstract class cannot be stored in the database and is normally used as a base for other persistent classes. For example:12.2.1
object
The
object
specifier specifies a persistent class - that should be associated with a view. For more information + that should be associated with the view. For more information on object associations refer to Section 9.1, "Object Views".12.2.2
table
The
@@ -9827,7 +9827,7 @@ class employertable
specifier specifies a database table - that should be associated with a view. For more information + that should be associated with the view. For more information on table associations refer to Section 9.2, "Table Views".12.2.4
pointer
The
pointer
specifier specifies the view pointer type - for a view class. Similar to objects, the view pointer type is used + for the view class. Similar to objects, the view pointer type is used to return dynamically allocated instances of a view class. The semantics of thepointer
specifier for a view are the same as those of thepointer
specifier for an object @@ -10321,7 +10321,7 @@ typedef std::vector<std::string> names;12.3.9
index_type
The
index_type
specifier specifies the native - database type that should be used for an ordered container's + database type that should be used for the ordered container's index column. The semantics ofindex_type
are similar to those of thetype
specifier (Section 12.3.1, "type
"). The native @@ -10335,7 +10335,7 @@ typedef std::vector<std::string> names;12.3.10
key_type
The
key_type
specifier specifies the native - database type that should be used for a map container's + database type that should be used for the map container's key column. The semantics ofkey_type
are similar to those of thetype
specifier (Section 12.3.1, "type
"). For @@ -10349,7 +10349,7 @@ typedef std::map<unsigned short, float> age_weight_map;12.3.11
value_type
The
value_type
specifier specifies the native - database type that should be used for a container's + database type that should be used for the container's value column. The semantics ofvalue_type
are similar to those of thetype
specifier (Section 12.3.1, "type
"). For @@ -10368,7 +10368,7 @@ typedef std::vector<std::string> names;12.3.12
value_null
/value_not_null
The
value_null
andvalue_not_null
specifiers - specify that a container type's element value can or cannot be + specify that the container type's element value can or cannot beNULL
, respectively. The semantics ofvalue_null
andvalue_not_null
are similar to those of thenull
andnot_null
specifiers @@ -10396,7 +10396,7 @@ typedef std::vector<shared_ptr<account> > accounts;12.3.13
id_options
The
id_options
specifier specifies additional - column definition options that should be used for a container's + column definition options that should be used for the container's id column. For example:@@ -10413,7 +10413,7 @@ typedef std::vector<std::string> nicknames;12.3.14
index_options
The
index_options
specifier specifies additional - column definition options that should be used for a container's + column definition options that should be used for the container's index column. For example:@@ -10430,7 +10430,7 @@ typedef std::vector<std::string> nicknames;12.3.15
key_options
The
key_options
specifier specifies additional - column definition options that should be used for a container's + column definition options that should be used for the container's key column. For example:@@ -10447,7 +10447,7 @@ typedef std::map<std::string, std::string> properties;12.3.16
value_options
The
value_options
specifier specifies additional - column definition options that should be used for a container's + column definition options that should be used for the container's value column. For example:@@ -10464,7 +10464,7 @@ typedef std::set<std::string> nicknames;12.3.17
id_column
The
id_column
specifier specifies the column - name that should be used to store the object id in a + name that should be used to store the object id in the container's table. For example:@@ -10478,7 +10478,7 @@ typedef std::vector<std::string> names;12.3.18
index_column
The
index_column
specifier specifies the column - name that should be used to store the element index in an + name that should be used to store the element index in the ordered container's table. For example:@@ -10492,7 +10492,7 @@ typedef std::vector<std::string> names;12.3.19
key_column
The
key_column
specifier specifies the column - name that should be used to store the key in a map + name that should be used to store the key in the map container's table. For example:@@ -10506,7 +10506,7 @@ typedef std::map<unsigned short, float> age_weight_map;12.3.20
value_column
The
value_column
specifier specifies the column - name that should be used to store the element value in a + name that should be used to store the element value in the container's table. For example:@@ -10724,7 +10724,7 @@ typedef std::map<unsigned short, float> age_weight_map;12.4.1
-id
The
id
specifier specifies that a data member contains +The
@@ -10780,7 +10780,7 @@ class personid
specifier specifies that the data member contains the object id. In a relational database, an identifier member is mapped to a primary key. For example:12.4.3
type
The
+ that should be used for the data member. For example:type
specifier specifies the native database type - that should be used for a data member. For example:#pragma db object @@ -10800,7 +10800,7 @@ class person12.4.4
id_type
The
@@ -10833,7 +10833,7 @@ class persontype
specifier specifies the native database type - that should be used for a data member when it is part of an + that should be used for the data member when it is part of an object identifier. This specifier only makes sense when applied to a member of a composite value type that is used for both id and non-id members. For example:12.4.5
null
/not_null
The
null
andnot_null
specifiers specify that - a data member can or cannot beNULL
, respectively. + the data member can or cannot beNULL
, respectively. By default, data members of basic value types for which database mapping is provided by the ODB compiler do not allowNULL
values while data members of object pointers allowNULL
@@ -10888,7 +10888,7 @@ class account12.4.6
default
The
+ that should be used for the data member. For example:default
specifier specifies the database default value - that should be used for a data member. For example:#pragma db object @@ -10996,7 +10996,7 @@ class person12.4.7
options
The
options
specifier specifies additional column - definition options that should be used for a data member. For + definition options that should be used for the data member. For example:@@ -11054,7 +11054,7 @@ class person12.4.8
column
(object, composite value)The
column
specifier specifies the column name - that should be used to store a data member of a persistent class + that should be used to store the data member of a persistent class or composite value type in a relational database. For example:@@ -11081,14 +11081,14 @@ class personThe
column
specifier can be used to specify the associated object data member, the potentially qualified column name, or the column - expression for a data member of a view class. For more information, + expression for the data member of a view class. For more information, refer to Section 9.1, "Object Views" and Section 9.2, "Table Views".12.4.10
transient
The
+ not to store the data member in the database. For example:transient
specifier instructs the ODB compiler - not to store a data member in the database. For example:#pragma db object @@ -11109,7 +11109,7 @@ class person12.4.11
-readonly
The
readonly
specifier specifies that a data member of +The
readonly
specifier specifies that the data member of an object or composite value type is read-only. Changes to a read-only data member are ignored when updating the database state of an object (Section 3.9, "Updating Persistent Objects") @@ -11202,7 +11202,7 @@ class person12.4.12
-inverse
The
inverse
specifier specifies that a data member of +The
inverse
specifier specifies that the data member of an object pointer or a container of object pointers type is an inverse side of a bidirectional object relationship. The single required argument to this specifier is the corresponding data @@ -11313,7 +11313,7 @@ class person12.4.16
-unordered
The
unordered
specifier specifies that a member of +The
unordered
specifier specifies that the member of an ordered container type should be stored unordered in the database. The database table for such a member will not contain the index column and the order in which elements are retrieved from the database may @@ -11337,7 +11337,7 @@ class person12.4.17
table
The
+ be used to store the contents of the container member. For example:table
specifier specifies the table name that should - be used to store the contents of a container member. For example:#pragma db object @@ -11386,7 +11386,7 @@ class personThe
@@ -11406,7 +11406,7 @@ class personindex_type
specifier specifies the native database type that should be used for an ordered container's - index column of a data member. The semantics ofindex_type
+ index column of the data member. The semantics ofindex_type
are similar to those of thetype
specifier (Section 12.4.3, "type
"). The native database type is expected to be an integer type. For example:The
@@ -11426,7 +11426,7 @@ class personkey_type
specifier specifies the native database type that should be used for a map container's - key column of a data member. The semantics ofkey_type
+ key column of the data member. The semantics ofkey_type
are similar to those of thetype
specifier (Section 12.4.3, "type
"). For example:The
@@ -11450,7 +11450,7 @@ class personvalue_type
specifier specifies the native database type that should be used for a container's - value column of a data member. The semantics ofvalue_type
+ value column of the data member. The semantics ofvalue_type
are similar to those of thetype
specifier (Section 12.4.3, "type
"). For example:12.4.21
value_null
/value_not_null
The
value_null
andvalue_not_null
specifiers - specify that a container's element value for a data member can or + specify that a container's element value for the data member can or cannot beNULL
, respectively. The semantics ofvalue_null
andvalue_not_null
are similar to those of thenull
andnot_null
specifiers @@ -11484,7 +11484,7 @@ class accountThe
+ id column of the data member. For example:id_options
specifier specifies additional column definition options that should be used for a container's - id column of a data member. For example:#pragma db object @@ -11508,7 +11508,7 @@ class personThe
+ index column of the data member. For example:index_options
specifier specifies additional column definition options that should be used for a container's - index column of a data member. For example:#pragma db object @@ -11529,7 +11529,7 @@ class personThe
+ key column of the data member. For example:key_options
specifier specifies additional column definition options that should be used for a container's - key column of a data member. For example:#pragma db object @@ -11550,7 +11550,7 @@ class personThe
+ value column of the data member. For example:value_options
specifier specifies additional column definition options that should be used for a container's - value column of a data member. For example:#pragma db object @@ -11571,7 +11571,7 @@ class personThe
id_column
specifier specifies the column name that should be used to store the object id in a - container's table for a data member. The semantics of + container's table for the data member. The semantics ofid_column
are similar to those of thecolumn
specifier (Section 12.4.8, "column
"). @@ -11595,7 +11595,7 @@ class personThe
index_column
specifier specifies the column name that should be used to store the element index in an - ordered container's table for a data member. The semantics of + ordered container's table for the data member. The semantics ofindex_column
are similar to those of thecolumn
specifier (Section 12.4.8, "column
"). @@ -11619,7 +11619,7 @@ class personThe
key_column
specifier specifies the column name that should be used to store the key in a map - container's table for a data member. The semantics of + container's table for the data member. The semantics ofkey_column
are similar to those of thecolumn
specifier (Section 12.4.8, "column
"). @@ -11643,7 +11643,7 @@ class personThe
value_column
specifier specifies the column name that should be used to store the element value in a - container's table for a data member. The semantics of + container's table for the data member. The semantics ofvalue_column
are similar to those of thecolumn
specifier (Section 12.4.8, "column
"). @@ -11726,7 +11726,7 @@ namespace test12.5.1
pointer
The
pointer
specifier specifies the default pointer - type for persistent classes and views inside a namespace. For + type for persistent classes and views inside the namespace. For example:@@ -11783,7 +11783,7 @@ namespace accountingThe
+ the namespace. For example:table
specifier specifies a table prefix that should be added to table names of persistent classes inside - a namespace. For example:#pragma db namespace table("acc_") @@ -11844,14 +11844,14 @@ class employer12.5.3
schema
The
schema
specifier specifies a database schema - that should be used for persistent classes inside a namespace. + that should be used for persistent classes inside the namespace. For more information on specifying a database schema refer to Section 12.1.8, "schema
".12.5.4
session
The
session
specifier specifies whether to enable - session support for persistent classes inside a namespace. For + session support for persistent classes inside the namespace. For example:-- cgit v1.1