diff options
Diffstat (limited to 'site/trunk/site-publish/named-parameters-support.html')
| -rw-r--r-- | site/trunk/site-publish/named-parameters-support.html | 195 |
1 files changed, 195 insertions, 0 deletions
diff --git a/site/trunk/site-publish/named-parameters-support.html b/site/trunk/site-publish/named-parameters-support.html new file mode 100644 index 0000000000..5c6601450a --- /dev/null +++ b/site/trunk/site-publish/named-parameters-support.html @@ -0,0 +1,195 @@ + +<!-- + + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE- 2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + + +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<HTML> + <HEAD> + <!-- generateKeywords macro --> + <META name="description" content="Apache Tuscany"> + <META name="keywords" content="apache, apache tuscany, tuscany, service, services, fabric, soa, service oriented architecture, sca, service component architecture, das, sdo, csa, ruby, opensource"> + <!-- generateKeywords macro end --> + + <LINK type="text/css" rel="stylesheet" href="http://tuscany.apache.org/stylesheets/default.css"> + <LINK rel="SHORTCUT ICON" href="https://cwiki.apache.org/confluence/display/TUSCANY/$images/favicon.ico"> + <TITLE>Apache Tuscany : Named parameters support</TITLE> + <META http-equiv="Content-Type" content="text/html;charset=UTF-8"></HEAD> + + <BODY onload="init()"> + <!-- topNav macro --> + <TABLE valign="top" border="0" cellspacing="0" cellpadding="0" width="100%" background="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg"> + <TR> + <TD valing="top" align="left"> + <A href="https://cwiki.apache.org/confluence/pages/viewpage.action?spaceKey=TUSCANY&title=$siteroot"><IMG src="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg" height="91" width="25" border="0"></A> + </TD> + <TD> + <A href="http://tuscany.apache.org/"><IMG src="http://tuscany.apache.org/images/TuscanyLogo.jpg" border="0"></A> + </TD> + + <TD width="100%"> + + </TD> + + <!-- Adds the edit page link to the top banner--> + <TD valign="bottom"> + <DIV style="padding: 2px 10px; margin: 0px;"> + <A href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=66139"> + <IMG src="http://tuscany.apache.org/images/notep_16.gif" height="16" width="16" border="0" align="absmiddle" title="Edit Page"></A> + </DIV> + </TD> + + </TR> + </TABLE> + <!-- topNav macro end --> + + <!-- breadCrumbs macro --> + <TABLE border="0" cellpadding="2" cellspacing="0" width="100%"> + <TR class="topBar"> + <TD align="left" valign="middle" class="topBarDiv" nowrap="true" width="100%"> + <A href="home.html" title="Apache Tuscany">Apache Tuscany</A> > <A href="home.html" title="Home">Home</A> > <A href="das-overview.html" title="DAS Overview">DAS Overview</A> > <A href="das-java.html" title="DAS Java">DAS Java</A> > <A href="das-java-documentation-menu.html" title="DAS Java Documentation Menu">DAS Java Documentation Menu</A> > <A href="das-java-developer-guide.html" title="DAS Java Developer Guide">DAS Java Developer Guide</A> > <A href="rdb-das-java.html" title="RDB DAS Java">RDB DAS Java</A> > <A href="rdb-das-user-guide.html" title="RDB DAS - User Guide">RDB DAS - User Guide</A> > <A href="" title="Named parameters support">Named parameters support</A> + </TD> + + <TD align="right" valign="middle" class="topBarDiv" align="left" nowrap="true"> + <A href="http://mail-archives.apache.org/mod_mbox/tuscany-user">User List</A> | <A href="http://mail-archives.apache.org/mod_mbox/tuscany-dev">Dev List</A> | <A href="http://issues.apache.org/jira/browse/Tuscany">Issue Tracker</A> + </TD> + </TR> + </TABLE> + <!-- breadCrumbs macro end --> + + + <TABLE border="0" cellpadding="0" width="100%" bgcolor="#FFFFFF"> + <TR> + <TD align="left" valign="top"> + + <!-- pageContent macro --> + <DIV id="PageContent"> + + <DIV class="pagecontent"> + <DIV class="wiki-content"> + <H1><A name="Namedparameterssupport-Namedparameterssupport"></A>Named parameters support</H1> + +<P>JDB API requires indexed parameter setting. i.e. statement.setXXX(int, value). But in the DAS client<BR> +it may be helpful to provide named parameters setting on the command. This is particularly convenient<BR> +when the table involves many columns during insert/update. </P> + +<P>Below are config schema portion supporting this.</P> +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE><xsd:complexType name="Parameter"> + <xsd:attribute name="name" type="xsd:string"/> + <xsd:attribute name="columnType" type="xsd:string"/> + <xsd:attribute name="direction" type="xsd:string" default="IN"/> + <xsd:attribute name="index" type="xsd:int"/> +</xsd:complexType> +<xsd:complexType name="Parameters"> + <xsd:sequence> + <xsd:element maxOccurs="unbounded" minOccurs="0" name="Parameter" type="config:Parameter"/> + </xsd:sequence> +</xsd:complexType> +<xsd:complexType name="Create"> + <xsd:sequence> + <xsd:element maxOccurs="1" minOccurs="0" name="Parameters" type="config:Parameters"/> + </xsd:sequence> + <xsd:attribute name="sql" type="xsd:string"/> +</xsd:complexType> +<xsd:complexType name="Update"> + <xsd:sequence> + <xsd:element maxOccurs="1" minOccurs="0" name="Parameters" type="config:Parameters"/> + </xsd:sequence> + <xsd:attribute name="sql" type="xsd:string"/> +</xsd:complexType> +<xsd:complexType name="Delete"> + <xsd:sequence> + <xsd:element maxOccurs="1" minOccurs="0" name="Parameters" type="config:Parameters"/> + </xsd:sequence> + <xsd:attribute name="sql" type="xsd:string"/> +</xsd:complexType> +<xsd:complexType name="Command"> + <xsd:sequence> + <xsd:element maxOccurs="unbounded" minOccurs="0" name="Parameter" type="config:Parameter"/> + <xsd:element maxOccurs="unbounded" minOccurs="0" name="ResultDescriptor" type="config:ResultDescriptor"/> + </xsd:sequence> + <xsd:attribute name="name" type="xsd:string"/> + <xsd:attribute name="SQL" type="xsd:string"/> + <xsd:attribute name="kind" type="xsd:string"/> +</xsd:complexType> +</PRE> +</DIV></DIV> + +<P>User can do Command.setParameter(String name, Object value), getParameter(String name). Indexed set/getParameter() is available as before. Also <create>, <update>, <delete> from Config support named parameters.</P> + +<P>example config:</P> +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE><Config xmlns="http:///org.apache.tuscany.das.rdb/config.xsd"> +<Table tableName="CUSTOMER"> + <create sql="insert into customer values (?, ?, ?)" > + <Parameters> + <Parameter name="ID" index="1"/> + <Parameter name="LASTNAME" index="1"/> + <Parameter name="ADDRESS" index="3"/> + </Parameters> + </create> +</Table> +<Command name="createCustomer" SQL="insert into CUSTOMER values ( ?, ?, ?)" kind="Insert"> + <Parameter name="ID" index="1"/> + <Parameter name="LASTNAME" index="2"/> + <Parameter name="ADDRESS" index="3"/> +</Command> +</PRE> +</DIV></DIV> + +<P>if +ve index is specified in Parameter, it is used, else auto-increment is used. As List is an ordered collection, the sequence(index value) appearing in the cofig file will be maintained. Partially specifying indexes is not supported (i.e. give index for 2 out of 3 params and leave one without it, is not supported)<BR> +Also, if indexes are specified, the ordering in config is flexible, i.e. below is valid.</P> +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE><Command name="createCustomer" SQL="insert into CUSTOMER values ( ?, ?, ?)" kind="Insert"> + <Parameter name="LASTNAME" index="2"/> + <Parameter name="ID" index="1"/> + <Parameter name="ADDRESS" index="3"/> +</Command> +</PRE> +</DIV></DIV> + +<P><B>Note</B> Convention over config is followed, if Parameters are not defined in config, the sequence<BR> +should match the table columns <B>convention</B>,else user should specify params on command in config and specify index attributes in them <B>config</B></P> + </DIV> + </DIV> + </DIV> + <!-- pageContent macro end --> + + </TD> + </TR> + </TABLE> + + <!-- footer macro --> + <SCRIPT src="http://www.google-analytics.com/urchin.js" type="text/javascript"> + </SCRIPT> + <SCRIPT type="text/javascript"> + _uacct = "UA-1174707-5"; + urchinTracker(); + </SCRIPT> + + <A href="http://www.statcounter.com/" target="_blank"><IMG src="http://c26.statcounter.com/counter.php?sc_project=2619156&java=0&security=94bd7e7d&invisible=0" alt="website stats" border="0"></A> + + <DIV class="footer"> + Copyright � 2003-2012, The Apache Software Foundation </BR> + Apache Tuscany and the Apache Tuscany project logo are trademarks of The Apache Software Foundation. + </DIV> + <!-- footer macro end --> + + </BODY> +</HTML> |