1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.sdo-das-relational-construct" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SDO_DAS_Relational::__construct</refname>
<refpurpose>
Creates an instance of a Relational Data Access Service
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>SDO_DAS_Relational</type>
<methodname>SDO_DAS_Relational::__construct</methodname>
<methodparam>
<type>array</type>
<parameter>database_metadata</parameter>
</methodparam>
<methodparam choice="opt">
<type>string</type>
<parameter>application_root_type</parameter>
</methodparam>
<methodparam choice="opt">
<type>array</type>
<parameter>SDO_containment_references_metadata</parameter>
</methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Constructs an instance of a Relational Data Access Service
from the passed metadata.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>database_metadata</term>
<listitem>
<para>
An array containing one or more table definitions,
each of which is an associative array containing the keys
<varname>name</varname>,
<varname>columns</varname>,
<varname>PK</varname>, and optionally,
<varname>FK</varname>.
For a full discussion of the metadata, see the
<link linkend='sdo.das.rel.metadata'>metadata</link>
section in the general information about the Relational DAS.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>application_root_type</term>
<listitem>
<para>
The root of each data graph is an object of a special root type and
the application data objects come below that.
Of the various application types in the SDO model,
one has to be the the application type immediately
below the root of the data graph.
If there is only one table in the database metadata,
so the application root type can be inferred, this argument can be omitted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>SDO_containment_references_metadata</term>
<listitem>
<para>
An array containing one or more definitions of a containment relation,
each of which is an associative array containing the keys
<varname>parent</varname>
and
<varname>child</varname>.
The containment relations describe how the types in the model
are connected to form a tree.
The type specified as the application root type must be present
as one of the parent types in the containment references.
If the application only needs to work with one table at a time,
and there are no containment relations in the model,
this argument can be omitted.
For a full discussion of the metadata, see the
<link linkend='sdo.das.rel.metadata'>metadata</link>
section in the general information about the Relational DAS.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an SDO_DAS_Relational object on success.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<function>SDO_DAS_Relational::__construct</function>
throws a SDO_DAS_Relational_Exception if
any problems are found in the metadata.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
For a full discussion of the metadata, see the
<link linkend='sdo.das.rel.metadata'>metadata</link>
section in the general information about the Relational DAS.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
