openedge data management: sql reference
TRANSCRIPT
OPENEDGE®
10PROGRESS
®
OpenEdge® Data Management:SQL Reference
© 2009 Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.
These materials and all Progress® software products are copyrighted and all rights are reserved by Progress Software Corporation. Theinformation in these materials is subject to change without notice, and Progress Software Corporation assumes no responsibility for anyerrors that may appear therein. The references in these materials to specific platforms supported are subject to change.
Actional, Apama, Apama (and Design), Artix, Business Empowerment, DataDirect (and design), DataDirect Connect, DataDirectConnect64, DataDirect Technologies, DataDirect XML Converters, DataDirect XQuery, DataXtend, Dynamic Routing Architecture,EdgeXtend, Empowerment Center, Fathom, IntelliStream, IONA, IONA (and design), Making Software Work Together, Mindreef,ObjectStore, OpenEdge, Orbix, PeerDirect, POSSENET, Powered by Progress, PowerTier, Progress, Progress DataXtend, ProgressDynamics, Progress Business Empowerment, Progress Empowerment Center, Progress Empowerment Program, Progress OpenEdge,Progress Profiles, Progress Results, Progress Software Developers Network, Progress Sonic, ProVision, PS Select, SequeLink, Shadow,SOAPscope, SOAPStation, Sonic, Sonic ESB, SonicMQ, Sonic Orchestration Server, SonicSynergy, SpeedScript, Stylus Studio,Technical Empowerment, WebSpeed, Xcalia (and design), and Your Software, Our Technology–Experience the Connection areregistered trademarks of Progress Software Corporation or one of its affiliates or subsidiaries in the U.S. and/or other countries.AccelEvent, Apama Dashboard Studio, Apama Event Manager, Apama Event Modeler, Apama Event Store, Apama Risk Firewall,AppsAlive, AppServer, ASPen, ASP-in-a-Box, BusinessEdge, Business Making Progress, Cache-Forward, DataDirect Spy, DataDirectSupportLink, Fuse, Fuse Mediation Router, Fuse Message Broker, Fuse Services Framework, Future Proof, GVAC, High PerformanceIntegration, ObjectStore Inspector, ObjectStore Performance Expert, OpenAccess, Orbacus, Pantero, POSSE, ProDataSet, Progress ESPEvent Manager, Progress ESP Event Modeler, Progress Event Engine, Progress RFID, Progress Software Business Making Progress,PSE Pro, SectorAlliance, SeeThinkAct, Shadow z/Services, Shadow z/Direct, Shadow z/Events, Shadow z/Presentation, Shadow Studio,SmartBrowser, SmartComponent, SmartDataBrowser, SmartDataObjects, SmartDataView, SmartDialog, SmartFolder, SmartFrame,SmartObjects, SmartPanel, SmartQuery, SmartViewer, SmartWindow, Sonic Business Integration Suite, Sonic Process Manager, SonicCollaboration Server, Sonic Continuous Availability Architecture, Sonic Database Service, Sonic Workbench, Sonic XML Server,StormGlass, The Brains Behind BAM, WebClient, Who Makes Progress, and Your World. Your SOA. are trademarks or service marksof Progress Software Corporation or one of its affiliates or subsidiaries in the U.S. and other countries. Java and all Java-based marksare trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. Any other trademarks containedherein are the property of their respective owners.
For the latest documentation updates see OpenEdge Product Documentation on PSDN (http://communities.progress.com/pcom/docs/DOC-16074).
December 2009
Last updated with new content: Release 10.2B Product Code: 4496; R10.2B
Third party acknowledgements — See the “Third party acknowledgements” section on page Preface–6.
Contents
OpenEdge SQL Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
OpenEdge SQL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
OpenEdge SQL Reserved Words . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
OpenEdge SQL Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
OpenEdge SQL System Limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
OpenEdge SQL System Catalog Tables . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Data Type Compatibility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
OpenEdge SQL Language Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
OpenEdge SQL Elements and Statements in Backus Naur Form . . . . . 215
Compliance with Industry Standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Syntax for ABL Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Java Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
JDBC Conformance Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
OpenEdge SQL and ODBC Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Contents
Conte
SQLGetInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .289
ODBC Scalar Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .309
Embedded SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .319
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index–1
nts–2
Contents
Tables
Table 1: OpenEdge SQL reserved words . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Table 2: OpenEdge SQL error codes and messages . . . . . . . . . . . . . . . . . . . . 144Table 3: OpenEdge SQL system limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Table 4: System tables and descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Table 5: SYSTABLES core system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Table 6: SYSCOLUMNS core system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Table 7: SYSINDEXES core system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Table 8: SYSCALCTABLE system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Table 9: SYSNCHARSTAT system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Table 10: SYSCOLAUTH system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Table 11: SYSCOLSTAT system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Table 12: SYSCOLUMNS_FULL system table . . . . . . . . . . . . . . . . . . . . . . . . . . 169Table 13: SYSDATATYPES system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Table 14: SYSDATESTAT system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Table 15: SYSDBAUTH system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172Table 16: SYSFLOATSTAT system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172Table 17: SYSIDXSTAT system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172Table 18: SYSINTSTAT system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Table 19: SYSNUMSTAT system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Table 20: SYSPROCBIN system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Table 21: SYSPROCCOLUMNS system table . . . . . . . . . . . . . . . . . . . . . . . . . . 174Table 22: SYSPROCEDURES system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Table 23: SYSPROCTEXT system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Table 24: SYSREALSTAT system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Table 25: SYSSEQAUTH system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Table 26: SYSSEQUENCES system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177Table 27: SYSSYNONYMS system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177Table 28: SYSTABAUTH system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Table 29: SYSTABLES_FULL system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Table 30: SYSTBLSTAT system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Table 31: SYSTIMESTAT system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Table 32: SYSTINYINTSTAT system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Table 33: SYSTRIGCOLS system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Table 34: SYSTRIGGER system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Table 35: SYSTSSTAT system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182Table 36: SYSTSTZSTAT system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182Table 37: SYSNVARCHARSTAT system table . . . . . . . . . . . . . . . . . . . . . . . . . . 183Table 38: SYSVIEWS system table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183Table 39: SYS_CHKCOL_USAGE system table . . . . . . . . . . . . . . . . . . . . . . . . . 183Table 40: SYS_CHK_CONSTRS system table . . . . . . . . . . . . . . . . . . . . . . . . . . 184Table 41: SYS_KEYCOL_USAGE system table . . . . . . . . . . . . . . . . . . . . . . . . . 184Table 42: SYS_REF_CONSTRS system table . . . . . . . . . . . . . . . . . . . . . . . . . . 185Table 43: SYS_TBL_CONSTRS system table . . . . . . . . . . . . . . . . . . . . . . . . . . 185Table 44: ABL and corresponding OpenEdge SQL data types . . . . . . . . . . . . . . 187Table 45: OpenEdge SQL Number Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Table 46: Date formats and descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192Table 47: Time formats and descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194Table 48: Specification formats for binary values . . . . . . . . . . . . . . . . . . . . . . . . 199Table 49: Relational operators and resulting predicates . . . . . . . . . . . . . . . . . . . 208Table 50: Compatibility of SQL-92 scalar functions . . . . . . . . . . . . . . . . . . . . . . . 231Table 51: Compliance of SQL-92 DDL and DML statements . . . . . . . . . . . . . . . 235Table 52: ABL table attributes used in OpenEdge SQL statements . . . . . . . . . . 237Table 53: ABL column attributes used in OpenEdge SQL statements . . . . . . . . 239Table 54: ABL index attributes used in OpenEdge SQL statements . . . . . . . . . . 240Table 55: Argument values for DhSQLException.getDiagnostics . . . . . . . . . . . . 247
Contents–3
Contents
Conte
Table 56: Allowable values for fieldType in getParam . . . . . . . . . . . . . . . . . . . . . 254Table 57: Allowable values for fieldType in getValue . . . . . . . . . . . . . . . . . . . . . . 255Table 58: Allowable values for fieldType in registerOutParam . . . . . . . . . . . . . . . 258Table 59: Mapping between Java and JDBC data types . . . . . . . . . . . . . . . . . . . 269Table 60: Mapping between JDBC and Java data types . . . . . . . . . . . . . . . . . . . 270Table 61: Mapping between SQL-92 and Java data types . . . . . . . . . . . . . . . . . . 270Table 62: JDBC data type conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271Table 64: OpenEdge SQL and ODBC data types . . . . . . . . . . . . . . . . . . . . . . . . . 287Table 65: Information the ODBC driver returns to SQLGetInfo . . . . . . . . . . . . . . . 289Table 66: Scalar string functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310Table 67: Scalar numeric functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312Table 68: Date and time functions supported by ODBC . . . . . . . . . . . . . . . . . . . . 313Table 69: Scalar system functions supported by ODBC . . . . . . . . . . . . . . . . . . . . 315Table 70: Compliance of SQL DDL and DML statements . . . . . . . . . . . . . . . . . . . 348
nts–4
Contents
Figures
Figure 1: ROUND digit positions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Contents–5
Contents
Conte
nts–6Preface
This Preface contains the following sections:
• Purpose
• Audience
• Organization
• Typographical conventions
• Examples of syntax diagrams (SQL)
• Third party acknowledgements
Preface
Purpose
OpenEdge Data Management: SQL Reference provides specific information on the OpenEdge® SQL language. The reference contains information on SQL statements, functions, reserved words, error messages, data type compatibility, and the language’s compliance with industry standards. The book also provides reference information on the ODBC and JDBC drivers.
For the latest documentation updates see the OpenEdge Product Documentation Overview page on PSDN: http://communities.progress.com/pcom/docs/DOC-16074.
Audience
The audience of this book is composed of two groups:
• Database administrators will use the book to:
– Create and maintain databases
– Create, modify, and revoke user privileges
– Tune database performance
– Perform installation and setup of servers and clients
• Application developers will use the book to:
– Manage database connections and set up data sources
– Create database queries
– Tune database queries
– Develop application business logic
Organization
Part I, SQL Reference
OpenEdge SQL Statements
Describes the purpose and syntax of each OpenEdge SQL statement. A sample is provided for each statement.
OpenEdge SQL Functions
Describes the purpose and syntax of each OpenEdge SQL function. A sample is provided for each function.
Preface–2
Preface
OpenEdge SQL Reserved Words
Provides a list of words that have special syntactic meaning to OpenEdge SQL and cannot be used as identifiers for constants, variables, cursors, types, tables, records, subprograms or packages.
OpenEdge SQL Error Messages
Provides a list of error messages generated by the various components of OpenEdge SQL.
OpenEdge SQL System Limits
Provides a list of the maximum sizes for various attributes of the OpenEdge SQL database environment, and for elements of SQL queries addressed to this environment.
OpenEdge SQL System Catalog Tables
Provides a set of system tables for storing information about tables, columns, indexes, constraints, and privileges. This chapter describes those system catalog tables.
Data Type Compatibility
Addresses compatibility issues when using OpenEdge SQL and earlier versions of the database.
OpenEdge SQL Language Elements
Describes Standard SQL language elements that are common to OpenEdge SQL.
OpenEdge SQL Elements and Statements in Backus Naur Form
Presents OpenEdge SQL elements and statements in Backus Naur Form.
Compliance with Industry Standards
Addresses compatibility issues when using OpenEdge SQL and earlier versions of its database.
Syntax for ABL Attributes
Lists and describes SQL keywords to use with statements that allow you to define ABL attributes for tables and columns.
Part II, JDBC Reference
Java Class Reference
Provides information on OpenEdge SQL Java classes and methods.
JDBC Conformance Notes
Provides information on mapping between JDBC and other data types and return values for database metadata.
Preface–3
Preface
Part III, ODBC Reference
OpenEdge SQL and ODBC Data Types
Shows how the OpenEdge data types are mapped to the standard ODBC data types.
SQLGetInfo
Describes return values to SQL GetInfo from the ODBC driver.
ODBC Scalar Functions
Lists scalar functions that ODBC supports and are available to use in SQL statements.
Part IV, ESQL Reference
Embedded SQL
Provides reference information for an ESQL interface.
Typographical conventions
This manual uses the following typographical conventions:
Convention Description
Bold Bold typeface indicates commands or characters the user types, provides emphasis, or the names of user interface elements.
Italic Italic typeface indicates the title of a document, or signifies new terms.
SMALL, BOLD CAPITAL LETTERS
Small, bold capital letters indicate OpenEdge key functions and generic keyboard keys; for example, GET and CTRL.
KEY1+KEY2 A plus sign between key names indicates a simultaneous key sequence: you press and hold down the first key while pressing the second key. For example, CTRL+X.
KEY1 KEY2 A space between key names indicates a sequential key sequence: you press and release the first key, then press another key. For example, ESCAPE H.
Syntax:
Fixed width A fixed-width font is used in syntax statements, code examples, system output, and filenames.
Fixed-width italics Fixed-width italics indicate variables in syntax statements.
Fixed-width bold Fixed-width bold indicates variables with special emphasis.
UPPERCASE fixed width
Uppercase words are ABL keywords. Although these are always shown in uppercase, you can type them in either uppercase or lowercase in a procedure.
Preface–4
Preface
Examples of syntax diagrams (SQL)
In this example, GRANT, RESOURCE, DBA, and TO are keywords. You must specify RESOURCE, DBA, or both, and at least one user_name. Optionally you can specify additional user_name items; each subsequent user_name must be preceded by a comma:
This excerpt from an ODBC application invokes a stored procedure using the ODBC syntax { call procedure_name ( param ) }, where braces and parentheses are part of the language:
In this example, you must specify a table_name, view_name, or synonym, but you can choose only one. In all SQL syntax, if you specify the optional owner_name qualifier, there must not be a space between the period separator and table_name, view_name, or synonym:
This icon (three arrows) introduces a multi-step procedure.
This icon (one arrow) introduces a single-step procedure.
lowercase Lowercase words are source language elements that are not SQL keywords.
[ ] Large brackets indicate the items within them are optional.
{ } Large braces indicate the items within them are required. They are used to simplify complex syntax diagrams.
| A vertical bar indicates a choice.
... Ellipses indicate repetition: you can choose one or more of the preceding items.
Convention Description
Syntax
GRANT { RESOURCE, DBA } TO user_name [, user_name ] ... ;
Syntax
proc1( param, "{ call proc2 (param) }", param);
Syntax
CREATE [ PUBLIC ] SYNONYM synonymFOR [ owner_name.]{table_name |view_name |synonym } ;
Preface–5
Preface
In this example, you must specify table_name or view_name:
In this example, you must include one expression (expr) or column position (posn), and optionally you can specify the sort order as ascending (ASC) or descending (DESC). You can specify additional expressions or column positions for sorting within a sorted result set. The SQL engine orders the rows on the basis of the first expr or posn. If the values are the same, the second expr or posn is used in the ordering:
Long syntax descriptions split across lines
Some syntax descriptions are too long to fit on one line. When syntax descriptions are split across multiple lines, groups of optional and groups of required items are kept together in the required order.
In this example, CREATE VIEW is followed by several optional items:
Third party acknowledgements
OpenEdge includes AdventNet - Agent Toolkit licensed from AdventNet, Inc. http://www.adventnet.com. All rights to such copyright material rest with AdventNet.
OpenEdge includes ANTLR (Another Tool for Language Recognition) software Copyright © 2003-2006, Terence Parr All rights reserved. Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. Software distributed on an “AS IS” basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License agreement that accompanies the product.
OpenEdge includes software developed by the Apache Software Foundation (http://www.apache.org/). Copyright © 1999 The Apache Software Foundation. All rights reserved (Xerces C++ Parser (XML) and Xerces2 Java Parser (XML)); Copyright © 1999-2002
Syntax
DELETE FROM [ owner_name.]{table_name |view_name }[ WHERE search_condition ] ;
Syntax
ORDER BY { expr | posn } [ ASC | DESC ][ , [ { expr | posn } [ ASC | DESC ] ] ... ]
Syntax
CREATE VIEW [ owner_name.]view_name[ ( column_name [, column_name ] ... ) ]AS [ ( ] query_expression [ ) ] [ WITH CHECK OPTION ] ;
Preface–6
Preface
The Apache Software Foundation. All rights reserved (Xerces Parser (XML); and Copyright © 2000-2003 The Apache Software Foundation. All rights reserved (Ant). The names “Apache,” “Xerces,” “ANT,” and “Apache Software Foundation” must not be used to endorse or promote products derived from this software without prior written permission. Products derived from this software may not be called “Apache”, nor may “Apache” appear in their name, without prior written permission of the Apache Software Foundation. For written permission, please contact [email protected]. Software distributed on an “AS IS” basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License agreement that accompanies the product.
OpenEdge includes Concurrent Java software Copyright 1994-2000 Sun Microsystems, Inc. All Rights Reserved. -Neither the name of or trademarks of Sun may be used to endorse or promote products including or derived from the Java Software technology without specific prior written permission; and Redistributions of source or binary code must contain the above copyright notice, this notice and the following disclaimers: This software is provided "AS IS," without a warranty of any kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN MICROSYSTEMS, INC. AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN MICROSYSTEMS, INC. OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE SOFTWARE, EVEN IF SUN MICROSYSTEMS, INC. HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
OpenEdge includes DataDirect software Copyright © 1991-2007 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved. (DataDirect Connect for JDBC Type 4 driver); Copyright © 1993-2009 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved. (DataDirect Connect for JDBC); Copyright © 1988-2007 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved. (DataDirect Connect for ODBC); and Copyright © 1988-2007 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved. (DataDirect Connect64 for ODBC).
OpenEdge includes DataDirect Connect for ODBC and DataDirect Connect64 for ODBC software, which include ICU software 1.8 and later - Copyright © 1995-2003 International Business Machines Corporation and others All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, provided that the above copyright notice(s) and this permission notice appear in all copies of the Software and that both the above copyright notice(s) and this permission notice appear in supporting documentation.
OpenEdge includes DataDirect Connect for ODBC and DataDirect Connect64 for ODBC software, which include software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http:/www.openssl.org/). Copyright © 1998-2006 The OpenSSL Project. All rights reserved. And Copyright © 1995-1998 Eric Young ([email protected]). All rights reserved.
Preface–7
Preface
OpenEdge includes DataDirect products for the Microsoft SQL Server database which contain a licensed implementation of the Microsoft TDS Protocol.
OpenEdge includes software authored by David M. Gay. Copyright © 1991, 2000, 2001 by Lucent Technologies (dtoa.c); Copyright © 1991, 1996 by Lucent Technologies (g_fmt.c); and Copyright © 1991 by Lucent Technologies (rnd_prod.s). Permission to use, copy, modify, and distribute this software for any purpose without fee is hereby granted, provided that this entire notice is included in all copies of any software which is or includes a copy or modification of this software and in all copies of the supporting documentation for such software. THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED WARRANTY. IN PARTICULAR, NEITHER THE AUTHOR NOR LUCENT MAKES ANY REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE.
OpenEdge includes software authored by David M. Gay. Copyright © 1998-2001 by Lucent Technologies All Rights Reserved (decstrtod.c; strtodg.c); Copyright © 1998, 2000 by Lucent Technologies All Rights Reserved (decstrtof.c; strtord.c); Copyright © 1998 by Lucent Technologies All Rights Reserved (dmisc.c; gdtoa.h; gethex.c; gmisc.c; sum.c); Copyright © 1998, 1999 by Lucent Technologies All Rights Reserved (gdtoa.c; misc.c; smisc.c; ulp.c); Copyright © 1998-2000 by Lucent Technologies All Rights Reserved (gdtoaimp.h); Copyright © 2000 by Lucent Technologies All Rights Reserved (hd_init.c). Full copies of these licenses can be found in the installation directory, in the c:/OpenEdge/licenses folder. Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that the copyright notice and this permission notice and warranty disclaimer appear in supporting documentation, and that the name of Lucent or any of its entities not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. LUCENT DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL LUCENT OR ANY OF ITS ENTITIES BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
OpenEdge includes http package software developed by the World Wide Web Consortium. Copyright © 1994-2002 World Wide Web Consortium, (Massachusetts Institute of Technology, European Research Consortium for Informatics and Mathematics, Keio University). All rights reserved. This work is distributed under the W3C® Software License [http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231] in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
OpenEdge includes ICU software 1.8 and later - Copyright © 1995-2003 International Business Machines Corporation and others All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, provided that the above copyright notice(s) and this permission notice appear in all copies of the Software and that both the above copyright notice(s) and this permission notice appear in supporting documentation.
Preface–8
Preface
OpenEdge includes Imaging Technology copyrighted by Snowbound Software 1993-2003. www.snowbound.com.
OpenEdge includes Infragistics NetAdvantage for .NET v2009 Vol 2 Copyright © 1996-2009 Infragistics, Inc. All rights reserved.
OpenEdge includes JSTL software Copyright 1994-2006 Sun Microsystems, Inc. All Rights Reserved. Software distributed on an “AS IS” basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License agreement that accompanies the product.
OpenEdge includes OpenSSL software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/). Copyright © 1998-2007 The OpenSSL Project. All rights reserved. This product includes cryptographic software written by Eric Young ([email protected]). This product includes software written by Tim Hudson ([email protected]). Copyright © 1995-1998 Eric Young ([email protected]) All rights reserved. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact [email protected]. Products derived from this software may not be called "OpenSSL" nor may "OpenSSL" appear in their names without prior written permission of the OpenSSL Project. Software distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License agreement that accompanies the product.
OpenEdge includes Quartz Enterprise Job Scheduler software Copyright © 2001-2003 James House. All rights reserved. Software distributed on an “AS IS” basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License agreement that accompanies the product. This product uses and includes within its distribution, software developed by the Apache Software Foundation (http://www.apache.org/).
OpenEdge includes code licensed from RSA Security, Inc. Some portions licensed from IBM are available at http://oss.software.ibm.com/icu4j/.
OpenEdge includes the RSA Data Security, Inc. MD5 Message-Digest Algorithm. Copyright ©1991-2, RSA Data Security, Inc. Created 1991. All rights reserved.
OpenEdge includes Sonic software, which includes software developed by Apache Software Foundation (http://www.apache.org/). Copyright © 1999-2000 The Apache Software Foundation. All rights reserved. The names “Ant”, “Axis”, “Xalan,” “FOP,” “The Jakarta Project”, “Tomcat”, “Xerces” and/or “Apache Software Foundation” must not be used to endorse or promote products derived from the Product without prior written permission. Any product derived from the Product may not be called “Apache”, nor may “Apache” appear in their name, without prior written permission. For written permission, please contact [email protected].
OpenEdge includes Sonic software, which includes software Copyright © 1999 CERN - European Organization for Nuclear Research. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. CERN makes no representations about the suitability of this software for any purpose. It is provided "as is" without expressed or implied warranty.
Preface–9
Preface
OpenEdge includes Sonic software, which includes software developed by ExoLab Project (http://www.exolab.org/). Copyright © 2000 Intalio Inc. All rights reserved. The names “Castor” and/or “ExoLab” must not be used to endorse or promote products derived from the Products without prior written permission. For written permission, please contact [email protected]. Exolab, Castor and Intalio are trademarks of Intalio Inc.
OpenEdge includes Sonic software, which includes software developed by IBM. Copyright © 1995-2003 International Business Machines Corporation and others. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, provided that the above copyright notice(s) and this permission notice appear in all copies of the Software and that both the above copyright notice(s) and this permission notice appear in supporting documentation. Software distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License agreement that accompanies the product. Except as contained in this notice, the name of a copyright holder shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization of the copyright holder.
OpenEdge includes Sonic software, which includes the JMX Technology from Sun Microsystems, Inc. Use and Distribution is subject to the Sun Community Source License available at http://sun.com/software/communitysource.
OpenEdge includes Sonic software, which includes software developed by the ModelObjects Group (http://www.modelobjects.com). Copyright © 2000-2001 ModelObjects Group. All rights reserved. The name “ModelObjects” must not be used to endorse or promote products derived from this software without prior written permission. Products derived from this software may not be called “ModelObjects”, nor may “ModelObjects” appear in their name, without prior written permission. For written permission, please contact [email protected].
OpenEdge includes Sonic software, which includes code licensed from Mort Bay Consulting Pty. Ltd. The Jetty Package is Copyright © 1998 Mort Bay Consulting Pty. Ltd. (Australia) and others.
OpenEdge includes Sonic software, which includes files that are subject to the Netscape Public License Version 1.1 (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.mozilla.org/NPL/. Software distributed under the License is distributed on an “AS IS” basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. The Original Code is Mozilla Communicator client code, released March 31, 1998. The Initial Developer of the Original Code is Netscape Communications Corporation. Portions created by Netscape are Copyright 1998-1999 Netscape Communications Corporation. All Rights Reserved.
OpenEdge includes Sonic software, which includes software developed by the University Corporation for Advanced Internet Development http://www.ucaid.edu Internet2 Project. Copyright © 2002 University Corporation for Advanced Internet Development, Inc. All rights reserved. Neither the name of OpenSAML nor the names of its contributors, nor Internet2, nor the University Corporation for Advanced Internet Development, Inc., nor UCAID may be used to endorse or promote products derived from this software and products derived from this software may not be called OpenSAML, Internet2, UCAID, or the University Corporation for
Preface–10
Preface
Advanced Internet Development, nor may OpenSAML appear in their name without prior written permission of the University Corporation for Advanced Internet Development. For written permission, please contact [email protected].
OpenEdge includes the UnixWare platform of Perl Runtime authored by Kiem-Phong Vo and David Korn. Copyright © 1991, 1996 by AT&T Labs. Permission to use, copy, modify, and distribute this software for any purpose without fee is hereby granted, provided that this entire notice is included in all copies of any software which is or includes a copy or modification of this software and in all copies of the supporting documentation for such software. THIS SOFTWARE IS BEING PROVIDED “AS IS”, WITHOUT ANY EXPRESS OR IMPLIED WARRANTY. IN PARTICULAR, NEITHER THE AUTHORS NOR AT&T LABS MAKE ANY REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE.
OpenEdge includes Vermont Views Terminal Handling Package software developed by Vermont Creative Software. Copyright © 1988-1991 by Vermont Creative Software.
OpenEdge includes XML Tools, which includes versions 8.9 of the Saxon XSLT and XQuery Processor from Saxonica Limited (http://www.saxonica.com/) which are available from SourceForge (http://sourceforge.net/projects/saxon/). The Original Code of Saxon comprises all those components which are not explicitly attributed to other parties. The Initial Developer of the Original Code is Michael Kay. Until February 2001 Michael Kay was an employee of International Computers Limited (now part of Fujitsu Limited), and original code developed during that time was released under this license by permission from International Computers Limited. From February 2001 until February 2004 Michael Kay was an employee of Software AG, and code developed during that time was released under this license by permission from Software AG, acting as a "Contributor". Subsequent code has been developed by Saxonica Limited, of which Michael Kay is a Director, again acting as a "Contributor". A small number of modules, or enhancements to modules, have been developed by other individuals (either written especially for Saxon, or incorporated into Saxon having initially been released as part of another open source product). Such contributions are acknowledged individually in comments attached to the relevant code modules. All Rights Reserved. The contents of the Saxon files are subject to the Mozilla Public License Version 1.0 (the "License"); you may not use these files except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ and a copy of the license can also be found in the installation directory, in the c:/OpenEdge/licenses folder. Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.
OpenEdge includes XML Tools, which includes Xs3P v1.1.3. The contents of this file are subject to the DSTC Public License (DPL) Version 1.1 (the "License"); you may not use this file except in compliance with the License. A copy of the license can be found in the installation directory, in the c:/OpenEdge/licenses folder. Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. The Original Code is xs3p. The Initial Developer of the Original Code is DSTC. Portions created by DSTC are Copyright © 2001, 2002 DSTC Pty Ltd. All rights reserved.
OpenEdge includes YAJL software Copyright 2007, Lloyd Hilaiel. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form
Preface–11
Preface
must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of Lloyd Hilaiel nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Preface–12
Part I
SQL Reference
OpenEdge SQL Statements
OpenEdge SQL Functions
OpenEdge SQL Reserved Words
OpenEdge SQL Error Messages
OpenEdge SQL System Limits
OpenEdge SQL System Catalog Tables
Data Type Compatibility
OpenEdge SQL Language Elements
OpenEdge SQL Elements and Statements in Backus Naur Form
Compliance with Industry Standards
Syntax for ABL Attributes
OpenEdge SQL Statements
This section provides detailed information on OpenEdge® SQL statements. A description for each statement provides the following information:
• A definition of the statement
• The syntax of the statement’s proper usage
• A code sample that shows how the statement works
• Any associated notes
• Authorization required in order to run the statement
• Related statements
ALTER DATABASE SET PRO_ENABLE_LARGE_KEYS 'Y'
This statement is used to enable large index database keys of up to 2,000 bytes.
Syntax
Notes • You must have SQL DBA privileges to enable large keys.
• As of OpenEdge Release 10.1B, large index keys are supported for databases with 4,000 and 8,000 byte block sizes and are enabled by default.
• In Releases 10.1B and later, large index key sizes are enabled by default. However, in Releases 10.1A and earlier, this statement must be used to enable large keys.
ALTER DATABASE SET PRO_ENABLE_LARGE_KEYS 'Y'
ALTER DATABASE SET PRO_ENABLE_64BIT_SEQUENCES 'Y'
• If large keys are already enabled, an error message indicating such will be returned when you use the statement.
ALTER DATABASE SET PRO_ENABLE_64BIT_SEQUENCES 'Y'
This statement is used to enable large index keys in a database.
Syntax
Notes • You must have SQL DBA privileges to enable 64-bit sequences.
• As of OpenEdge Release 10.1B, OpenEdge databases support sequences with 64-bit maximums for positive and negative numbers.
• In releases 10.1B and later, this feature is enabled by default. However, in Releases 10.1A and earlier, this specific ALTER DATABASE statement must be used to enable 64-bit sequences.
• If 64-bit sequences are already enabled, an error message indicating such will be returned when you use the statement.
ALTER SEQUENCE
The ALTER SEQUENCE statement can be used to change the current value of an existing sequence. The sequence can be in the current schema or a schema can be specified.
Syntax
schema_name
Specifies the schema name that contains the sequence. If this is not specified, OpenEdge SQL drops the sequence, if present, from the current schema.
sequence_name
Specifies the sequence to be dropped.
INCREMENT BY
Specifies the interval between sequence numbers. The value can be a positive or negative integer (INTEGER data type for 32-bit sequences, BIGINT datatype for 64-bit sequences), but cannot be 0. The value range for a 32-bit sequence is from -2,147,483,648 to 2,147,483,647. The value range for a 64-bit sequence is from -9223372036854775808 to 9223372036854775807. If value is positive, the sequence ascends. If it is negative, the sequence descends. The default value is 1.
ALTER DATABASE SET PRO_ENABLE_64BIT_SEQUENCES 'Y'
ALTER SEQUENCE [schema_name.]sequence_name SET{ START WITH value | INCREMENT BY value |MAXVALUE value | NOMAXVALUE |
MINVALUE value |NOMINVALUE | CYCLE | NOCYCLE | CURRVAL value };
2
ALTER SEQUENCE
START WITH
Specifies the first sequence number generated. In an ascending sequence, the value must be greater than or equal to the MINVALUE. In a descending sequence, the value must be greater than or equal to the MAXVALUE. For ascending sequences, the default value is MINVALUE. For descending sequences, the default value is MAXVALUE.
MAXVALUE
Specifies the maximum value for the sequence to generate. For both 32-bit and 64-bit descending sequences, the default value is -1. For a 32-bit ascending sequence, the default value is 2,147,483,647. For a 64-bit ascending sequence, the default value is 9223372036854775807.
NOMAXVALUE
Specifies -1 as the MAXVALUE for 32-bit descending sequences and 2,147,483,647 as the MAXVALUE for 32-bit ascending sequences. Specifies -1 as the MAXVALUE for 64-bit descending sequences and 9223372036854775807 as the MAXVALUE for 64-bit ascending sequences.
MINVALUE
Specifies the minimum value the sequence can generate. For an ascending sequence, the default value is 0. For a descending sequence, the default value is -2,147,483,648 for 32-bit sequences and -9223372036854775808 for 64-bit sequences.
NOMINVALUE
Specifies 0 as the MINVALUE for ascending sequences. The MINVALUE for descending sequences is -2,147,483,648 for 32-bit sequences and -9223372036854775808 for 64-bit sequences.
CYCLE
Indicates that the sequence will continue to generate values after reaching the value assigned to MAXVALUE (if sequence ascends) or MINVALUE (if sequence descends).
NOCYCLE
Indicates that the sequence cannot generate more values after reaching the value assigned to MAXVALUE (if sequence ascends) or MINVALUE (if sequence descends). The SQL sequence generator uses NOCYCLE as the default if CYCLE is not specified.
CURRVAL
Returns the current value of the sequence.
Notes • It is possible to set only one attribute of a sequence at a time.
• Attributes START WITH, INCREMENT BY, MAXVALUE, MINVALUE and CURRVAL can take either an INTEGER or BIGINT argument, depending on whether the sequence is a 32-bit or 64-bit sequence. The following example modifies a sequence by specifying a maximum value:
ALTER SEQUENCE pub.customerSET MAXVALUE 9000000000;
3
ALTER TABLE
ALTER TABLE
The ALTER TABLE statement can be used to:
• Change the name of a table
• Change the name of a column within a table
• Add a column to a table
• Set (ABL) Advanced Business Language table, column and index attributes
Syntax
The following syntax is used to define an LOB column in ALTER TABLE ADD COLUMN statement:
ALTER TABLE [ owner_name.]table_name {ADD column-definition |SET progress_table_attribute value|SET { ENCRYPT WITH cipher
| DECRYPT| ENCRYPT REKEY ]
|BUFFER_POOL { PRIMARY | ALTERNATE }} |ALTER [ COLUMN ]column_name { SET DEFAULT value
| DROP DEFAULT | SET [NOT] NULL| SET progress_column_attribute value}| SET ENCRYPT WITH cipher | SET DECRYPT | SET ENCRYPT REKEY | SET BUFFER_POOL { PRIMARY | ALTERNATE } }
|DROP COLUMN column_name { CASCADE | RESTRICT }|ADD [CONSTRAINT constraint_name ] { primary_key_definition
|foreign_key_definition|uniqueness_constraint|check_constraint} [ AREA area_name ]
|DROP CONSTRAINT constraint_name [ CASCADE | RESTRICT]|ALTER INDEX index_name { SET progress_index_attribute value
|SET ENCRYPT WITH cipher |SET DECRYPT |SET ENCRYPT REKEY |SET BUFFER_POOL { PRIMARY | ALTERNATE }}
|RENAME {table_name TO new_table_name |COLUMN column_name TO new_column_name |INDEX index_name TO new_index_name }
};
4
ALTER TABLE
Notes • See the “Syntax for ABL Attributes” section on page 237 for a list of ABL table, column and index attributes.
• The ALTER TABLE ALTER INDEX statement can use two index attributes, PRO_DESCRIPTION and PRO_ACTIVE. The PRO_DESCRIPTION attribute enables the index definition to accept free-form text in the same manner as ABL. The PRO_ACTIVE attribute takes only n as an argument, thereby changing the index’s status from active to inactive. Changing an index’s status to inactive is an action that must be performed offline. For a description of the PRO_DESCRIPTION and PRO_ACTIVE attributes, see the “Syntax for ABL Attributes” section on page 237.
• Table columns defined by OpenEdge SQL have default format values identical to those created by the Data Dictionary.
• For details on using the ALTER TABLE ADD COLUMN statement to designate objects for buffer pool assignments, including an alternate buffer pool, see OpenEdge Data Management: Database Administration.
• For details on using the ALTER TABLE statement to enable transparent data encryption, see OpenEdge Getting Started: Core Business Services.
Examples In the following example, the ALTER TABLE statement is used to change the name of a table from customer to Customers:
In this example, the ALTER TABLE statement is used to change the name of a column within a table and the column named Address changes to Street:
In this example, table customer adds the column Region:
In this example, table customer changes an existing 32-bit INTEGER column into a 64-bit BIGINT column:
Syntax
{ LVARCHAR | CLOB | LVARBINARY | BLOB } [ ( length ) ][ AREA areaname ] [ ENCRYPT WITH cipher ][ BUFFER_POOL { PRIMARY | ALTERNATE } ]
ALTER TABLE customer RENAME TO Customers;
ALTER TABLE customer RENAME Address TO Street;
ALTER TABLE customer ADD COLUMN Region;
ALTER TABLE OrderLine ALTER COLUMN Qty SET PRO_DATA_TYPE BIGINT;
5
ALTER USER
Once the above statement is executed, the column will appear as a BIGINT column both internally and to applications.
A statement such as this executed against a column that is not 32-bit will result in an error.
In this example, ALTER TABLE adds an ABL description to a table and changes the ABL default data access index of the table:
In this example, ALTER TABLE RENAME INDEX is used to change an index named CustNum to CustomerNumberIndex:
The ALTER TABLE statement enables you to change the names of tables or columns or to add columns while your database is online servicing other requests. Other changes performed by ALTER TABLE must occur offline.
Authorization
Must have the DBA privilege, ownership of the table, or all the specified privileges on the table.
Related statements
ADD TABLE, DROP TABLE
ALTER USER
Changes the password for the specified user.
Syntax
Example In this example, the ALTER USER statement Jasper changes the Jasper account password from normandy to brittany:
Notes • Used in conjunction with CREATE USER and DROP USER, the ALTER USER statement provides a way to change a user password.
• The old_password specification must match the current password for username.
ALTER TABLE pub.customer SET PRO_DESCRIPTION 'Sports 2000 Customers';ALTER TABLE pub.customer SET PRO_DEFAULT_INDEX CustNumIdx;
ALTER TABLE Customers RENAME INDEX CustNum to CustomerNumberIndex;
ALTER USER 'username', 'old_password', 'new_password' ;
ALTER USER 'Jasper', 'normandy', 'brittany' ;
6
AUDIT INSERT
Authorization
User specified in username.
Related statements
CREATE USER, DROP USER
AUDIT INSERT
Writes application audit events to an audit-enabled database.
For more information about auditing, see OpenEdge Getting Started: Core Business Services. For more information about enabling a database for auditing, see OpenEdge Data Management: Database Administration.
Syntax
event_id
Positive integer value corresponding to an audit event record. The event_id must be a value greater than 32000.
event_context
Free-form character value that qualifies the event_id. May include non-ASCII characters.
event_detail
Free-form character value that supplies detailed information about the audit event. May include non-ASCII characters.
Notes • Before inserting the specified application audit event into the database, the OpenEdge SQL engine determines the following:
– The connected user has been granted the audit insert privilege.
– The event id is valid and active.
If both of these conditions are true, the engine writes the application audit event to the database. If one or both are not true, the engine does not write the event.
• AUDIT INSERT always returns a success status. This prevents users from determining whether or not they have privileges to log application audit events.
AUDIT INSERT ( event_id,[ event_context | NULL ][ event_detail | NULL ]);
7
AUDIT SET
AUDIT SET
Allows grouping of audit data by the client on a per-connection basis.
For more information about auditing, see OpenEdge Getting Started: Core Business Services. For more information about enabling a database for auditing, see OpenEdge Data Management: Database Administration.
Syntax
EVENT_GROUP
Indicates that subsequent audit records written by the database engine during the current connection will be marked as part of an event group.
APPLICATION_CONTEXT
Indicates that subsequent audit records written by the database engine during the current connection will be saved with application context information.
string
Free-form character value which is a unique string identifier for the group/application context event.
NULL
Clears an event group or application context string.
string
Free-form character value which provides additional application detail that describes the group/application context.
NULL
Clears an event group or application context string.
Examples
In this example, an application context is set:
In this example, the application context is cleared:
Note AUDIT SET always returns a success status. This prevents users from determining whether or not they have audit privileges.
AUDIT SET { EVENT_GROUP | APPLICATION_CONTEXT } { string | NULL }, { string | NULL };
AUDIT SET APPLICATION_CONTEXT 'app.name.checking' '06/02/2005 Deposits';
AUDIT SET APPLICATION_CONTEXT NULL NULL;
8
CALL
Authorization
Must have AUDIT_ADMIN, AUDIT_ARCHIVE, or AUDIT_INSERT privileges.
CALL
Invokes a stored procedure.
Syntax
proc_name
The name of the procedure to invoke.
parameter
Literal or variable value to pass to the procedure.
Example This example shows an excerpt from an ODBC application that calls a stored procedure (order_parts) using the ODBC syntax {call procedure_name (param)}:
Authorization
Must have DBA or EXECUTE privileges.
Related statements
CREATE PROCEDURE, DROP PROCEDURE
Column constraints
Specifies a constraint for a column that restricts the values that the column can store. INSERT, UPDATE, or DELETE statements that violate the constraint fail. The database returns a constraint violation error with an SQLCODE of -20116.
Column constraints are similar to table constraints, but their definitions are associated with a single column rather than the entire table.
CALL proc_name ( [ parameter ] [ , ... ] );
SQLUINTEGER Part_num;SQLINTEGER Part_numInd = 0;// Bind the parameter. SQLBindParameter (hstmt, 1, SQL_PARAM_INPUT, SQL_C_SLONG, SQL_INTEGER, 0, 0, &Part_num, 0, Part_numInd);// Place the department number in Part_num.Part_num = 318;// Execute the statement.SQLExecDirect(hstmt, "{call order_parts(?)}", SQL_NTS);
9
Column constraints
Syntax
CONSTRAINT constraint_name
Allows you to assign a name for the column constraint. This option facilitates making changes to the column definition. If you do not specify a constraint_name, the database assigns a name. These names can be long and unwieldy, and you must query system tables to retrieve the name.
NOT NULL
Restricts values in the column to values that are not null.
NOT NULL PRIMARY KEY
Defines the column as the primary key for the table. There can be at most one primary key for a table. A column with the NOT NULL PRIMARY KEY constraint should not contain null or duplicate values.
Other tables can name primary keys as foreign keys in their REFERENCES clauses. If they do, SQL restricts operations on the table containing the primary key in the following ways:
• DROP TABLE statements that delete the table fail
• DELETE and UPDATE statements that modify values in the column that match a foreign key's value also fail
NOT NULL UNIQUE
Defines the column as a unique key that cannot contain null or duplicate values. Columns with NOT NULL UNIQUE constraints defined for them are also called candidate keys.
Other tables can name unique keys in their REFERENCES clauses. If they do, SQL restricts operations on the table containing the unique key.
REFERENCES table_name [ ( column_name ) ]Defines the column as a foreign key and specifies a matching primary or unique key in another table. The REFERENCES clause names the matching primary or unique key.
A foreign key and its matching primary or unique key specify a referential constraint. A value stored in the foreign key must either be null or be equal to some value in the matching unique or primary key.
You can omit the column_name argument if the table specified in the REFERENCES clause has a primary key and you want the primary key to be the matching key for the constraint.
CHECK ( search_condition )
Specifies a column-level check constraint. SQL restricts the form of the search condition. The search condition must not:
CONSTRAINT constraint_name
NOT NULL [ PRIMARY KEY | UNIQUE ] | REFERENCES [ owner_name.]table_name [ ( column_name ) ] | CHECK ( search_condition )
10
Column constraints
• Refer to any column other than the one with which it is defined
• Contain aggregate functions, subqueries, or parameter references
Examples The following example shows the creation of a primary key column on the supplier table:
The following example creates a NOT NULL UNIQUE constraint to define the column ss_no as a unique key for the employee table:
The following example defines order_item.orditem_order_no as a foreign key that references the primary key orders.order_no:
The second CREATE TABLE statement in the previous example could have omitted the column name order_no in the REFERENCES clause, since it refers to the primary key of table orders.
The following example creates a check constraint:
If a column is defined with a UNIQUE column constraints, no error results if more than one row has a NULL value for the column.
CREATE TABLE supplier ( supp_no INTEGER CONSTRAINT supp_key_con NOT NULL PRIMARY KEY, name CHAR (30), status SMALLINT, city CHAR (20) ) ;
CREATE TABLE employee ( empno INTEGER NOT NULL PRIMARY KEY, ss_no INTEGER NOT NULL UNIQUE, ename CHAR (19), sal NUMERIC (10, 2), deptno INTEGER NOT NULL) ;
CREATE TABLE orders ( order_no INTEGER NOT NULL PRIMARY KEY, order_date DATE) ; CREATE TABLE order_item ( orditem_order_no INTEGER REFERENCES orders ( order_no ), orditem_quantity INTEGER) ;
CREATE TABLE supplier ( supp_no INTEGER NOT NULL, name CHAR (30), status SMALLINT, city CHAR (20) CHECK (supplier.city <> 'BadApple')) ;
11
COMMIT
COMMIT
Commits a transaction explicitly after executing one or more SQL statements. Committing a transaction makes permanent any changes made by the SQL statements.
Syntax
Notes • The SQL statements executed prior to executing the COMMIT statement are executed as one atomic transaction that is recoverable and durable. The transaction is serializable if you specify this isolation level.
• On a system failure and/or the execution of the ROLLBACK, the transaction is rolled back to its initial state. Any changes made by the transaction are undone, restoring the database to its initial state. In the event of a system failure, the transaction will be rolled back during crash recovery when the database is restarted.
• A COMMIT operation makes any database modifications made by that transaction permanent.
• Once a COMMIT operation is executed, the database modifications cannot be rolled back.
• Once a COMMIT operation is executed, the transaction modifications are guaranteed durable regardless of any transient system failures.
• The atomicity applies only to the database modification and not to any direct I/O performed to devices such as the terminal, printer, and OS files by the application code.
• A COMMIT operation releases all locks implicitly or explicitly acquired by the transaction.
Related Statement
ROLLBACK
CONNECT AS CATALOG
Establishes a connection to an auxiliary read-only database.
Syntax
database_path
Full path to database directory and database name. This must be contained within quotes.
catalog_name
Catalog name to be used as an alias for the database in schema, table and column references. This must be in the form of an SQL identifier.
COMMIT [ WORK ] ;
CONNECT ’database_path’ AS CATALOG catalog_name;
12
CREATE INDEX
Example In this example, the database named customer in directory ’/usr/databases’ is connected as a catalog named mydb1:
Notes • Used to provide read-only access to multiple databases on a single client connection to an SQL server.
• Once connected, the catalog name for an auxiliary database may be used in SQL statements to qualify schema, table, and column access.
• The catalog name is visible, and usable, only in the client-server session in which it is defined.
• The catalog name of the primary database is the name of the primary database. The database name is the name by which the database is started (for example, by the proserve command) omitting all file system path information.
• Several client-server sessions may each connect to the same auxiliary database within an entire OpenEdge SQL Server process. Each such client-server session may use the same or different name when connecting to the same auxiliary database.
• If you are connected to a primary database that is unencrypted and it was started using the -t startup parameter, you will be unable to simultaneously connect to an encrypted auxiliary database. An attempt to do so will result in an error.
Authorization
Any user allowed to execute this statement. However, authorization for access to the auxiliary database is governed by the same rules that govern access to the primary database. That is, the username and password of the current user must be authorized using access control information in the auxiliary database.
SQL Compliance
Progress Software Corporation specific extension.
Related statements
DISCONNECT CATALOG, SET CATALOG
CREATE INDEX
Creates an index on the specified table using the specified columns of the table. An index improves the performance of SQL operations whose predicates are based on the indexed column. However, an index slows performance of INSERT, DELETE, and UPDATE operations.
CONNECT ’usr/databases/customer’ AS CATALOG mydb1;
13
CREATE INDEX
Syntax
UNIQUE
Does not allow the table to contain any rows with duplicate column values for the set of columns specified for that index.
index_name
Must be unique for the given table.
table_name
The name of the table on which the index is being built.
column_name [ , ... ]The columns on which searches and retrievals will be ordered. These columns are called the index key. When more than one column is specified in the CREATE INDEX statement, a concatenated index is created.
ASC | DESCAllows the index to be ordered as either ascending (ASC) or descending (DESC) on each column of the concatenated index. The default is ASC.
AREA area_name
The name of the storage area where the index and its entries are stored.
ENCRYPT WITH cypher
Allows the index to be encrypted by designating an appropriate cypher.
BUFFER_POOL { PRIMARY | ALTERNATE }Allows the index to be assigned to a primary or alternate buffer pool.
PRO_DESCRIPTION value
Allows you to enter an ABL description. value is an arbitrary character string.
PRO_ACTIVE {’N’|’n’}Indicates that the index will be created as an inactive index. Inactive indexes can be created while the database is online.
Examples This example illustrates how to create a unique index on a table:
CREATE [ UNIQUE ] INDEX index_nameON table_name
( { column_name [ ASC | DESC ] } [, ... ] )[ AREA area_name ][ ENCRYPT WITH cipher ][ BUFFER_POOL { PRIMARY | ALTERNATE } ][ PRO_DESCRIPTION value | PRO_ACTIVE {'N'|'n'} ];
14
CREATE PROCEDURE
This example shows how to create an inactive word index with the description field specified:
Notes • The first index you create on a table should be the most fundamental key of the table. This index (the first one created on a table) cannot be dropped except by dropping the table.
• An index slows performance of INSERT, DELETE, and UPDATE operations.
• Use PROUTIL to activate inactive indexes.
• Use CREATE INDEX without the PRO_ACTIVE {’N’|’n’} attribute to create active indexes. Active indexes can only be created against an online database if the following conditions are met:
– You run CREATE INDEX immediately after creating a table.
– The index is created on the newly created table.
– Both the CREATE TABLE and CREATE INDEX are performed within the same transaction (that is, no commit is performed after CREATE TABLE is run).
Authorization
Must have DBA privilege or INDEX privilege on the table.
Related statements
ALTER TABLE, CREATE TABLE, DROP INDEX
CREATE PROCEDURE
Creates a stored procedure. Stored procedures contain a Java code snippet that is processed into a Java class definition and stored in the database in text and compiled form. SQL applications invoke stored procedures through the SQL CALL statement or the procedure-calling mechanisms of ODBC and JDBC.
CREATE UNIQUE INDEX custindex ON customer (cust_num);
CREATE PRO_WORD INDEX CommentsWordIdxon pub.customerPRO_DESCRIPTION ’Word index on comments field’PRO_ACTIVE ’n’;
15
CREATE PROCEDURE
Syntax
parameter_decl
This is the syntax for parameter_decl:
owner_name
Specifies the owner of the procedure. If the name is different from the user name of the user executing the statement, then the user must have DBA privileges.
procname
Names the stored procedure. DROP PROCEDURE statements specify the procedure name defined here. SQL also uses procname in the name of the Java class that it creates from the Java snippet.
IN | OUT | INOUTSpecifies whether following parameter declaration is input, output, or both.
Calling applications pass values for input parameters in the CALL statement or CALL escape sequence.
Stored procedures assign values to output parameters as part of their processing.
INOUT parameters have both a value passed in and receive a new value during procedure processing.
parameter_name data_type
Names a parameter and associates an SQL data type with it. The data type must be one supported by OpenEdge.
RESULT ( column_name data_type [ , ... ] )Specifies columns in the result set the procedure returns. If the CREATE PROCEDURE statement includes this clause, the Java snippet must explicitly insert rows into the result set using the Java class SQLResultSet.
Note that the column_name argument is not used in the body of the stored procedure. Instead, methods of the Java classes refer to columns in the result set by ordinal number, not by name. The IMPORT keyword must be uppercase and on a separate line. The body is
CREATE PROCEDURE [ owner_name.]procname ( [ parameter_decl [ , ... ] ] ) [ RESULT ( column_name data_type [ , ... ] ) ] [ IMPORT java_import_clause ] BEGIN java_snippet END
Syntax
{ IN | OUT | INOUT } parameter_name data_type
16
CREATE SEQUENCE
a sequence of Java statements between the BEGIN and END keywords. The Java statements become a method in a class that SQL creates and submits to the Java compiler. The BEGIN and END keywords must be uppercase and on separate lines.
The following example illustrates the use of the CREATE PROCEDURE statement:
Example
Note See OpenEdge Data Management: SQL Development for more information on using the CREATE statement and stored procedures.
Authorization
Must have DBA privilege, RESOURCE privilege, or ownership of procedure.
Related statements
CALL, DROP PROCEDURE
CREATE SEQUENCE
A sequence is an object for creating an incremental number series. Sequences can generate sequential values within any integer range with either positive or negative increments. The database holds the sequence definition and keeps track of the next available value.
Syntax
CREATE PROCEDURE get_sal ()IMPORTimport java.math.*;BEGINStringBuffer ename = new StringBuffer (20) ;BigDecimal esal = new BigDecimal (2) ;SQLCursor empcursor = new SQLCursor ("SELECT name, sal FROM emp " ) ;empcursor.open () ;empcursor.fetch ();while (empcursor.found ()){ename = (StringBuffer) empcursor.getValue (1, CHAR);esal = (BigDecimal) empcursor.getValue (2, NUMERIC);// do something with the values here}empcursor.close () ;END
CREATE SEQUENCE [schema_name.]sequence_name[INCREMENT BY value],[START WITH value],[MAXVALUE value | NOMAXVALUE],[MINVALUE value | NOMINVALUE],[CYCLE | NOCYCLE]
17
CREATE SEQUENCE
schema_name
Specifies the schema to contain the sequence. If schema_name is not specified, the sequence generator creates the sequence in the current schema. OpenEdge supports only the PUBLIC (PUB) schema.
sequence_name
Specifies the name of the sequence to be created.
INCREMENT BY
Specifies the interval between sequence numbers. The value can be a positive or negative integer (INTEGER data type for 32-bit sequences, BIGINT datatype for 64-bit sequences), but cannot be 0. The value range for a 32-bit sequence is from -2,147,483,648 to 2,147,483,647. The value range for a 64-bit sequence is from -9223372036854775808 to 9223372036854775807. If value is positive, the sequence ascends. If it is negative, the sequence descends. The default value is 1.
START WITH
Specifies the first sequence number generated. In an ascending sequence, the value must be greater than or equal to the MINVALUE. In a descending sequence, the value must be greater than or equal to the MAXVALUE. For ascending sequences, the default value is MINVALUE. For descending sequences, the default value is MAXVALUE.
MAXVALUE
Specifies the maximum value for the sequence to generate. For both 32-bit and 64-bit descending sequences, the default value is -1. For a 32-bit ascending sequence, the default value is 2,147,483,647. For a 64-bit ascending sequence, the default value is 9223372036854775807.
NOMAXVALUE
Specifies -1 as the MAXVALUE for 32-bit descending sequences and 2,147,483,647 as the MAXVALUE for 32-bit ascending sequences. Specifies -1 as the MAXVALUE for 64-bit descending sequences and 9223372036854775807 as the MAXVALUE for 64-bit ascending sequences.
MINVALUE
Specifies the minimum value the sequence can generate. For an ascending sequence, the default value is 0. For a descending sequence, the default value is -2,147,483,648 for 32-bit sequences and -9223372036854775808 for 64-bit sequences.
NOMINVALUE
Specifies 0 as the MINVALUE for ascending sequences. The MINVALUE for descending sequences is -2,147,483,648 for 32-bit sequences and -9223372036854775808 for 64-bit sequences.
CYCLE
Indicates that the sequence will continue to generate values after reaching the value assigned to MAXVALUE (if sequence ascends) or MINVALUE (if sequence descends).
18
CREATE SYNONYM
NOCYCLE
Indicates that the sequence cannot generate more values after reaching the value assigned to MAXVALUE (if sequence ascends) or MINVALUE (if sequence descends). The SQL sequence generator uses NOCYCLE as the default if CYCLE is not specified.
Example In the following example, a sequence is used to generate unique customer numbers when a new customer is inserted into the table pub.customer:
CREATE SYNONYM
Creates a synonym for the specified table, view, or synonym. A synonym is an alias that SQL statements can use instead of the name specified when the table, view, or synonym was created.
Syntax
PUBLIC
Specifies that the synonym is public: all users can refer to the name without qualifying it. By default, the synonym is private: other users must qualify the synonym by preceding it with the user name of the user who created it.
Users must have the DBA privilege to create public synonyms.
SYNONYM synonym
Name for the synonym.
FOR [ owner_name.] { table_name | view_name | synonym }Table, view, or synonym for which SQL creates the new synonym.
Example The following example demonstrates the use of the CREATE SYNONYM statement:
Authorization
Must have DBA privilege or RESOURCE privilege.
CREATE SEQUENCE pub.customer_sequence
START WITH 100,
INCREMENT BY 1,
NOCYCLE;
CREATE [ PUBLIC ] SYNONYM synonym FOR [ owner_name.] {table_name | view_name | synonym } ;
CREATE SYNONYM customer FOR smith.customer ;CREATE PUBLIC SYNONYM public_suppliers FOR smith.suppliers ;
19
CREATE TABLE
RELATED STATEMENT
DROP SYNONYM
CREATE TABLE
Creates a table definition. A table definition consists of a set of named column definitions for data values that will be stored in rows of the table. SQL provides two forms of the CREATE TABLE statement.
The first syntax form explicitly specifies column definitions. The second syntax form, with the AS query_expression clause, implicitly defines the columns using the columns in a query expression.
Syntax
owner_name
Specifies the owner of the table. If the name is different from the user name of the user executing the statement, then the user must have DBA privileges.
table_name
Names the table you are defining.
column_definition
This is the syntax for column_definition:
CREATE TABLE [ owner_name.]table_name ( { column_definition | table_constraint }, ...) [ AREA area_name ]
[ ENCRYPT WITH cipher ] [ BUFFER_POOL { PRIMARY | ALTERNATE } ] [ progress_table_attribute_keyword value ]
;
CREATE TABLE [ owner_name.]table_name [ (column_name [ NOT NULL] , ... ) ] [ AREA area_name ]
[ ENCRYPT WITH cipher ] [BUFFER_POOL { PRIMARY | ALTERNATE } ]
AS query_expression ;
Syntax
column_name data_type
[ COLLATE case_insensitive | case_sensitive ] [ DEFAULT { literal | NULL | SYSDATE | SYSTIME | SYSTIMESTAMP } ] [ column_constraint [ column_constraint , ... ] ][ progress_column_attribute_keyword value[progress_column_attribute_keyword value ] ...]
20
CREATE TABLE
column_name data_type
Names a column and associates a data type with it. The column names specified must be different from other column names in the table definition. The data_type must be supported by OpenEdge. For more information on supported datatypes, see the “OpenEdge SQL Language Elements” section on page 189.
When a table contains more than one column, a comma separator is required after each column_definition except for the final column_definition.
COLLATE
Indicates the column’s case sensitivity. Note the default is case_sensitive.
case_insensitive
Indicates the column will be case insensitive. The word case_insensitive itself cannot be used as a valid input. The value for the case_insensitive clause here can only be _I, I, or the default database collation with the suffix _I (for example: COLLATE_I, COLLATE I, or COLLATE BASIC_I).
case_sensitive
Indicates the column will be case sensitive. The word case_sensitive itself cannot be used as a valid input. The value for the case_sensitive clause here can only be _S, S, or the default database collation with the suffix _S (for example: COLLATE_S, COLLATE S, or COLLATE BASIC_S).
DEFAULT
Specifies an explicit default value for a column. The column takes on the value if an INSERT statement does not include a value for the column. If a column definition omits the DEFAULT clause, the default value is NULL.
The DEFAULT clause accepts the arguments shown in the following table:
column_constraint
Specifies a constraint that will be applied while inserting or updating a value in the associated column.
literal An integer, numeric, or string constant.
NULL A null value.
SYSDATE The current date. Valid only for columns defined with DATE data types. SYSDATE is equivalent to the Progress default keyword TODAY.
SYSTIME The current time. A TIME value.
SYSTIMESTAMP The current date and time. A TIMESTAMP value.
21
CREATE TABLE
progress_column_attribute_keyword value
ABL column attribute keyword and value. See the “Syntax for ABL Attributes” section on page 237 for a list of column attribute keywords.
This is the syntax used to define an LOB column:
table_constraint
Specifies a constraint that will be applied while inserting or updating a row in the table.
AREA area_name
Specifies the name of the storage area where data stored in the table is to be stored. The storage area name must be specified within double quotes.
If the specified area does not exist, the database returns an error. If you do not specify an area, the default area is used.
ENCRYPT WITH cypher
Allows the table to be encrypted by designating an appropriate cypher.
BUFFER_POOL { PRIMARY | ALTERNATE }Allows the table to be assigned to a primary or alternate buffer pool.
progress_table_attribute_keyword value
ABL table attribute keyword and value. See the “Syntax for ABL Attributes” section on page 237 for a list of table attribute keywords.
AS query_expression
Specifies a query expression to use for the data types and data values of the table’s columns. The types and lengths of the columns of the query expression result become the types and lengths of the respective columns in the table created. The rows in the resultant set of the query expression are inserted into the table after creating the table. In this form of the CREATE TABLE statement, column names are optional. If omitted, the names of the table’s columns are taken from the column names of the query expression.
Examples In the following CREATE TABLE supplier_item example, the user issuing the CREATE TABLE statement must have REFERENCES privilege on the itemno column of the table john.item:
Syntax
{ LVARCHAR | CLOB | LVARBINARY | BLOB } [ ( length ) ][ AREA areaname ] [ ENCRYPT WITH cipher ][ BUFFER_POOL { PRIMARY | ALTERNATE } ]
22
CREATE TABLE
The table will be created in the current owner schema.
The following CREATE TABLE statement explicitly specifies a table owner, gus:
The following example shows the AS query_expression form of CREATE TABLE to create and load a table with a subset of the data in the customer table:
The following example includes a NOT NULL column constraint and DEFAULT clauses for column definitions:
The following example shows how to create a table with two columns, both of which have ABL descriptions and column labels specified:
The table itself has a description specified, and will be created as hidden.
Note Table columns defined in OpenEdge SQL have default format values identical to those created by the Data Dictionary. Thus, columns created by SQL will have the same default format as columns created by ABL tools.
CREATE TABLE supplier_item ( supp_no INTEGER NOT NULL PRIMARY KEY, item_no INTEGER NOT NULL REFERENCES john.item (itemno), qty INTEGER) ;
CREATE TABLE account ( account integer, balance numeric (12,2), info char (84)) ;
CREATE TABLE dealer (name, street, city, state) AS SELECT name, street, city, state FROM customer WHERE state IN ('CA','NY', 'TX') ;
CREATE TABLE emp ( empno integer NOT NULL, deptno integer DEFAULT 10, join_date date DEFAULT NULL) ;
CREATE TABLE emp (empno INTEGER NOT NULL UNIQUE
PRO_DESCRIPTION ’A unique number for each employee’PRO_COL_LABEL ’Employee No.’
deptno INTEGER DEFAULT 21 NOT NULLPRO_DESCRIPTION ’The department number of the employee’PRO_COL_LABEL ’Dept. No.’
)PRO_HIDDEN ’Y’ PRO_DESCRIPTION ’All Employees’;
23
CREATE TRIGGER
Authorization
Must have DBA privilege, RESOURCE privilege or SELECT privilege.
Related statements
DROP TABLE
CREATE TRIGGER
Creates a trigger for the specified table. A trigger is a special type of automatically executed stored procedure that helps ensure referential integrity for a database.
Triggers contain Java source code that can use SQL Java classes to carry out database operations. Triggers are automatically activated when an INSERT, UPDATE, or DELETE statement changes the trigger’s target table. The Java source code details what actions the trigger takes when it is activated.
Syntax
owner_name
Specifies the owner of the trigger. If the name is different from the user name of the user executing the statement, then the user must have DBA privileges.
trigname
Names the trigger. DROP TRIGGER statements specify the trigger name defined here. SQL also uses trigname in the name of the Java class that it creates from the Java snippet.
BEFORE | AFTERDenotes the trigger action time. The trigger action time specifies whether the triggered action, implemented by java_snippet, executes BEFORE or AFTER the invoking INSERT, UPDATE, or DELETE statement.
INSERT |DELETE |UPDATE [ OF column_name [ , ...] ]Denotes the trigger event. The trigger event is the statement that activates the trigger.
If UPDATE is the triggering statement, this clause can include an optional column list. Only updates to any of the specified columns will activate the trigger. If UPDATE is the triggering
CREATE TRIGGER [ owner_name.]trigname { BEFORE | AFTER } { INSERT | DELETE | UPDATE [ OF column_name [ , ... ] ] } ON table_name
[ REFERENCING { OLDROW [ ,NEWROW ] | NEWROW [ ,OLDROW ] } ] [ FOR EACH { ROW | STATEMENT } ] [ IMPORT java_import_clause ] BEGIN java_snippet END
24
CREATE TRIGGER
statement and does not include the optional column list, then any UPDATE on the table will activate the trigger.
ON table_name
Identifies the name of the table where the trigger is defined. A triggering statement that specifies table_name causes the trigger to execute. table_name cannot be the name of a view.
REFERENCING OLDROW [ , NEWROW ] | NEWROW [ , OLDROW ] Provides a mechanism for SQL to pass row values as input parameters to the stored procedure implemented by java_snippet. The code in java_snippet uses the getValue method of the NEWROW and OLDROW objects to retrieve values of columns in rows affected by the trigger event and store them in procedure variables. This clause is allowed only if the trigger specifies the FOR EACH ROW clause.
The meaning of the OLDROW and NEWROW arguments of the REFERENCING clause depends on whether the trigger event is INSERT, UPDATE, or DELETE. For example:
• INSERT...REFERENCING NEWROW means the triggered action can access values of columns of each row inserted. SQL passes the column values specified by the INSERT statement.
• INSERT...REFERENCING OLDROW is meaningless, since there are no existing values for a row being inserted. INSERT...REFERENCING OLDROW generates a syntax error.
• UPDATE...REFERENCING OLDROW means the triggered action can access the values of columns, before they are changed, of each row updated. SQL passes the column values of the row as it exists in the database before the update operation.
• DELETE...REFERENCING OLDROW means the triggered action can access values of columns of each row deleted. SQL passes the column values of the row as it exists in the database before the delete operation.
• DELETE...REFERENCING NEWROW is meaningless, since there are no new existing values to pass for a row being deleted. DELETE...REFERENCING OLDROW generates a syntax error.
• UPDATE is the only triggering statement that allows both NEWROW and OLDROW in the REFERENCING clause.
• UPDATE...REFERENCING NEWROW means the triggered action can access the values of columns, after they are changed, of each row updated. SQL passes the column values specified by the UPDATE statement.
• The trigger action time (BEFORE or AFTER) does not affect the meaning of the REFERENCING clause. For instance, BEFORE UPDATE...REFERENCING NEWROW still means the values of columns after they are updated will be available to the triggered action.
• The REFERENCING clause generates an error if the trigger does not include the FOR EACH ROW clause.
FOR EACH { ROW | STATEMENT }Controls the execution frequency of the triggered action implemented by java_snippet.
25
CREATE TRIGGER
FOR EACH ROW means the triggered action executes once for each row being updated by the triggering statement. CREATE TRIGGER must include the FOR EACH ROW clause if it also includes a REFERENCING clause.
FOR EACH STATEMENT means the triggered action executes only once for the whole triggering statement. FOR EACH STATEMENT is the default.
IMPORT java_import_clause
Specifies standard Java classes to import. The IMPORT keyword must be uppercase and on a separate line.
BEGIN
java_snippet
END
Denotes the body of the trigger or the triggered action. The body contains the Java source code that implements the actions to be completed when a triggering statement specifies the target table. The Java statements become a method in a class that SQL creates and submits to the Java compiler.
The BEGIN and END keywords must be uppercase and on separate lines.
Notes • Triggers can take action on their own table so that they invoke themselves. SQL limits such recursion to five levels.
• You can you have multiple triggers on the same table. Multiple UPDATE triggers on the same table must specify different columns. SQL executes all triggers applicable to a given combination of table, trigger event, and action time.
• The actions carried out by a trigger can fire another trigger. When this happens, the other trigger’s actions execute before the rest of the first trigger finishes executing.
• If a constraint and trigger are both invoked by a particular SQL statement, SQL checks constraints first, so any data modification that violates a constraint does not also fire a trigger.
• To modify an existing trigger, you must delete it and issue another CREATE TRIGGER statement. You can query the systrigger system table for information about the trigger before you delete it.
• The code in java_snippet uses the getValue method of the NEWROW and OLDROW objects. The getValue method is valid on OLDROW before or after an update or delete and NEWROW before or after an update or insert; the setValue method is only valid on NEWROW before an insert or update.
Example The following code segment illustrates how to use the CREATE TRIGGER statement:
26
CREATE USER
The following code segment illustrates how to set values for a new row in the CREATE TRIGGER statement:
For more information on creating and using triggers, see OpenEdge Data Management: SQL Development.
Authorization
Must have the DBA privilege or RESOURCE privilege.
Related statements
DROP TRIGGER
CREATE USER
Creates the specified user.
Syntax
Example In this example an account with DBA privileges creates the ‘username’ ‘Jasper’ with password ‘spaniel’:
CREATE TRIGGER TRG_TEST04 BEFORE INSERT ON tst_trg_01REFERENCING NEWROWFOR EACH ROW
IMPORT import java.sql.*;
BEGIN
//Inserting Into tst_trg_03
Integer new_value=newInteger(0); new_value=(Integer)NEWROW.getValue (1,INTEGER); SQLIStatement insert_tst3=new SQLIStatement ("INSERT INTO tst_trg_03 values (?)"); insert_tst3.setParam (1,new_value); insert_tst3.execute();END
CREATE TRIGGER trg1403BEFORE INSERT ON tbl1401REFERENCING NEWROWFOR EACH ROWIMPORTimport java.sql.* ;BEGININTEGER n2 = new INTEGER(12345);NEWROW.setValue(2, n2);END
CREATE USER 'username', 'password' ;
27
CREATE VIEW
Notes • You are strongly advised to NOT create a user named PUB. A user named PUB is inherently the owner of all tables created in the ABL and all schema tables, since these are all in the PUB schema. As the owner, a user PUB has full access to those tables, including the ability to read and write data, and the ability to drop the application table. Therefore, the existence of a user PUB creates a very serious security risk for the database. For these reasons, please do NOT create a user named PUB.
• Used in conjunction with BEGIN-END DECLARE SECTION and DROP USER statement, the CREATE USER statement provides a way to manage user records through SQL.
• The user name and password must be enclosed in quotes.
• Before issuing the CREATE USER statement, there are no users defined in the user table and any user can log into the database.
• After issuing the CREATE USER statement, only users defined in the user table can log into the database.
Authorization
Must have DBA privileges.
Related statements
BEGIN-END DECLARE SECTION, DROP USER
CREATE VIEW
Creates a view with the specified name on existing tables or views.
Syntax
owner_name
Owner of the created view.
( column_name, column_name,... )Specifies column names for the view. These names provide an alias for the columns selected by the query specification. If the column names are not specified, then the view is created with the same column names as the tables or views on which it is based.
CREATE USER 'Jasper', 'spaniel' ;
CREATE VIEW [ owner_name.]view_name [ ( column_name, column_name,... ) ] AS [ ( ] query_expression [ ) ] [ WITH CHECK OPTION ] ;
28
CREATE VIEW
WITH CHECK OPTION
Checks that the updated or inserted row satisfies the view definition. The row must be selectable using the view. The WITH CHECK OPTION clause is only allowed on an updatable view.
Notes • A view is deletable if deleting rows from that view is allowed. For a view to be deletable, the view definition must satisfy the following conditions:
– The first FROM clause contains only one table reference or one view reference.
– There are no aggregate functions, DISTINCT clause, GROUP BY clause, or HAVING clause in the view definition.
– If the first FROM clause contains a view reference, then the view referred to is deletable.
• A view is updatable if updating rows from that view is allowed. For a view to be updatable, the view has to satisfy the following conditions:
– The view is deletable (it satisfies all the previously specified conditions for deletability).
– All the select expressions in the first SELECT clause of the view definition are simple column references.
– If the first FROM clause contains a view reference, then the view referred to is updatable.
• A view is insertable if inserting rows into that view is allowed. For a view to be insertable, the view has to satisfy the following conditions:
– The view is updatable (it satisfies all the previously specified conditions for update ability).
– If the first FROM clause contains a table reference, then all NOT NULL columns of the table are selected in the first SELECT clause of the view definition.
– If the first FROM clause contains a view reference, then the view referred to is insertable.
Example The following examples illustrate CREATE VIEW statements defined by query expressions:
CREATE VIEW ne_customers AS SELECT name, address, city, state FROM customer WHERE state IN ( 'NH', 'MA', 'ME', 'RI', 'CT', 'VT' ) WITH CHECK OPTION ;
CREATE VIEW OrderCount (custnum, numorders) AS SELECT CustNum, COUNT(*) FROM Order GROUP BY CustNum;
29
DELETE
Authorization
Must have DBA privilege, RESOURCE privilege, or SELECT privilege.
Related statements
DROP VIEW
DELETE
Deletes zero, one, or more rows from the specified table that satisfy the search condition specified in the WHERE clause. If the optional WHERE clause is not specified, then the DELETE statement deletes all rows of the specified table.
Syntax
Example The following example illustrates the DELETE statement:
Note If the table has primary or candidate keys and there are references from other tables to the rows to be deleted, the statement is rejected.
Authorization
Must have DBA privilege, ownership of the table, or DELETE permission of the table.
Related statements
WHERE clause
DISCONNECT CATALOG
Removes a connection to an auxiliary read-only database.
Syntax
catalog_name
Catalog name to be used as an alias for the database in schema, table and column references. This must be in the form of an SQL identifier.
Example In this example, the auxiliary database connection identified by the catalog named mydb1 is removed:
DELETE FROM [ owner_name.] { table_name | view_name } [ WHERE search_condition ] ;
DELETE FROM Customer WHERE Name = 'Surf and Sport';
DISCONNECT CATALOG catalog_name;
30
DROP INDEX
Note Used to remove auxiliary connections established by executing the CONNECT AS CATALOG statement.
Authorization
Any user is allowed to execute this statement.
SQL Compliance
Progress Software Corporation specific extension
Related statements
CONNECT AS CATALOG, SET CATALOG
DROP INDEX
Deletes an index on the specified table.
Syntax
index_owner_name
Specifies the name of the index owner. If index_owner_name is specified and is different from the name of the user executing the statement, then the user must have DBA privileges.
table_name
Verifies the index_name to correspond to the table.
Example The following example illustrates the DROP INDEX statement:
You cannot drop the first index created on a table, except by dropping the table.
Authorization
Must have DBA privilege or ownership of the index.
Related statements
CREATE INDEX
DISCONNECT CATALOG mydb1;
DROP INDEX [ index_owner_name.]index_name ON [ table_owner_name.]table_name ;
DROP INDEX custindex ON customer;
31
DROP PROCEDURE
DROP PROCEDURE
Deletes a stored procedure.
Syntax
owner_name
Specifies the owner of the procedure.
procedure_name
Name of the stored procedure to delete.
Example The following example illustrates the DROP PROCEDURE statement:
Authorization
Must have DBA privilege or owner of a stored procedure.
Related statement
CALL, CREATE PROCEDURE
DROP SEQUENCE
The DROP SEQUENCE statement removes a sequence from a schema. The sequence can be in a user’s schema or another schema may be specified. You must have DBA privileges to remove a sequence in a schema other than your own.
Syntax
schema_name
Specifies the schema name that contains the sequence. If this is not specified, OpenEdge SQL drops the sequence, if present, from the current schema.
sequence_name
Specifies the sequence to be dropped.
Example The following is an example of the DROP SEQUENCE statement:
DROP PROCEDURE [ owner_name.]procedure_name ;
DROP PROCEDURE new_sal ;
DROP SEQUENCE [ schema_name. ] sequence_name
DROP SEQUENCE pub.customer;
32
DROP SYNONYM
DROP SYNONYM
Drops the specified synonym.
Syntax
PUBLIC
Specifies that the synonym was created with the PUBLIC argument.
SYNONYM synonym
Name for the synonym.
Example The following is an example of the DROP SYNONYM statement:
Notes • If DROP SYNONYM specifies PUBLIC and the synonym was not a public synonym, SQL generates the “base table not found” error.
• If DROP SYNONYM does not specify PUBLIC and the synonym was created with the PUBLIC argument, SQL generates the “base table not found” error.
Authorization
Must have DBA privilege or ownership of the synonym (for DROP SYNONYM).
Related statement
CREATE SYNONYM
DROP TABLE
Deletes the specified table.
Syntax
owner_name
Specifies the owner of the table.
table_name
Names the table to drop.
Example The following is an example of the DROP TABLE statement:
DROP [ PUBLIC ] SYNONYM synonym ;
DROP SYNONYM customer ;DROP PUBLIC SYNONYM public_suppliers ;
DROP TABLE [ owner_name.]table_name ;
33
DROP TRIGGER
Notes • If owner_name is specified and is different from the name of the user executing the statement, then the user must have DBA privileges.
• When a table is dropped, the indexes on the table and the privileges associated with the table are dropped automatically.
• Views dependent on the dropped table are not automatically dropped, but become invalid.
• If the table is part of another table's referential constraint (if the table is named in another table’s REFERENCES clause), the DROP TABLE statement fails. You must DROP the referring table first.
Authorization
Must have DBA privilege or ownership of the table.
Related statement
CREATE TABLE
DROP TRIGGER
Deletes a trigger.
Syntax
owner_name
Specifies the owner of the trigger.
trigger_name
Names the trigger to drop.
Example The following is an example of the DROP TRIGGRER statement:
Authorization
Must have DBA privilege or ownership of the trigger.
Related statement
CREATE TRIGGER
DROP TABLE customer ;
DROP TRIGGER [ owner_name.]trigger_name ;
DROP TRIGGER sal_check ;
34
DROP USER
DROP USER
Deletes the specified user.
Syntax
'username'
Specifies the user name to delete. The username must be enclosed in quotes.
Example In this example, an account with DBA privileges drops the username ‘Jasper’:
Authorization
Must have DBA privileges.
Related statements
BEGIN-END DECLARE SECTION, CREATE USER
DROP VIEW
Deletes the view from the database.
Syntax
owner_name
Specifies the owner of the view.
view_name
Names the view to drop.
Example The following is an example of the DROP VIEW statement:
Notes • If owner_name is specified and is different from the name of the user executing the statement, then the user must have DBA privileges.
• When a view is dropped, other views that are dependent on this view are not dropped. The dependent views become invalid.
DROP USER 'username' ;
DROP USER 'Jasper' ;
DROP VIEW [ owner_name.]view_name ;
DROP VIEW newcustomers ;
35
GRANT
Authorization
Must have DBA privilege or ownership of the view.
Related statement
CREATE VIEW
GRANT
Grants various privileges to the specified users of the database. There are two forms of the GRANT statement:
• Grant database-wide privileges, such as system administration (DBA), general creation (RESOURCE), audit administration (AUDIT_ADMIN), audit archive (AUDIT_ARCHIVE), or audit insert (AUDIT_INSERT).
• Grant various privileges on specific tables and views. Privilege definitions are stored in the system tables SYSDBAUTH, SYSTABAUTH, and SYSCOLAUTH for the database, tables, and columns, respectively.
Note: You must use separate commands to grant DBA or RESOURCE privileges with any of the AUDIT privileges. Using the same command to grant a user with DBA or RESOURCE privileges and any of the AUDIT privileges results in an error.
Syntax
Examples In this example, audit administration and audit archive privileges are granted to bsmith:
Because these privileges are granted to bsmith WITH GRANT OPTION, bsmith may now grant these two privileges to other users.
This is the syntax to grant privileges on specific tables and views:
This is the syntax for the privilege variable:
GRANT { RESOURCE, DBA, AUDIT_ADMIN, AUDIT_ARCHIVE, AUDIT_INSERT } TO username [ , username ] , ... [ WITH GRANT OPTION ];
GRANT AUDIT_ADMIN, AUDIT_ARCHIVE TO bsmith WITH GRANT OPTION;
Syntax
GRANT { privilege [, privilege ] , ... | ALL [ PRIVILEGES] } ON table_name
TO { username [, username ] , ... | PUBLIC } [ WITH GRANT OPTION ] ;
36
GRANT
Use the following syntax to assign sequence privileges:
SELECT
Allows specified user to read data from the sequence.
UPDATE
Allows specified user to modify data for the sequence.
In this example, the sequence generator grants user slsadmin the ability to modify the customer number sequence:
The following syntax is a variation on the GRANT statement that enables the user to execute stored Java procedures:
RESOURCE
Allows the specified users to issue CREATE statements.
DBA
Allows the specified users to create, access, modify, or delete any database object, and to grant other users any privileges.
TO username [ , username ] , ...Grants the specified privileges on the table or view to the specified list of users.
Syntax
{ SELECT | INSERT | DELETE | INDEX | UPDATE [ ( column , column , ... ) ]| REFERENCES [ ( column , column , ... ) ] }
Syntax
GRANT [SELECT | UPDATE]ON SEQUENCE schema.sequence
TO user_name [,user_name]...
GRANT UPDATE
ON SEQUENCE pub.customer_sequence
TO slsadmin;
Syntax
GRANT EXECUTE ON StoredJavaProcedureName () TO { username [, username ] , ... | PUBLIC } [ WITH GRANT OPTION ] ;
37
GRANT
SELECT
Allows the specified users to read data from the table or view.
INSERT
Allows the specified users to add new rows to the table or view.
DELETE
Allows the specified users to delete rows from the table or view.
INDEX
Allows the specified users to create an index on the table or view.
UPDATE [ ( column , column , ... ) ] Allows the specified users to modify existing rows in the table or view. If followed by a column list, the users can modify values only in the columns named.
REFERENCES [ ( column , column , ... ) ] Allows the specified users to refer to the table from other tables’ constraint definitions. If followed by a column list, constraint definitions can refer only to the columns named.
For more detail on constraint definitions, see the Column constraints and Table constraints entries of this section.
ALL
Grants all privileges for the table or view.
TO PUBLIC
Grants the specified privileges on the table or view to any user with access to the system.
WITH GRANT OPTION
Allows the specified users to grant their privileges or a subset of their privileges to other users.
The following example illustrates the GRANT statement:
If the username specified in a RESOURCE or DBA GRANT operation does not already exist, the GRANT statement creates a row in the SYSDBAUTH system table for the new username. This row is not deleted by a subsequent REVOKE operation.
Authorization
Must have the DBA privilege, ownership of the table, or all the specified privileges on the table (granted with the WITH GRANT OPTION clause). Must have the DBA privilege or AUDIT_ADMIN WITH GRANT privilege to grant auditing privileges.
GRANT DELETE ON cust_view TO dbuser1 ;GRANT SELECT ON newcustomers TO dbuser2 ;
38
INSERT
Related statement
REVOKE
INSERT
Inserts new rows into the specified table or view that will contain either the explicitly specified values or the values returned by the query expression.
Syntax
Examples The following provides examples of the INSERT statement:
Notes • If the optional list of column names is specified, then only the values for those columns are required. The rest of the columns of the inserted row will contain NULL values, provided that the table definition allows NULL values and there is no DEFAULT clause for the columns. If a DEFAULT clause is specified for a column and the column name is not present in the optional column list, then the column is given the default value.
• If the optional list is not specified, then the column values must be either explicitly specified or returned by the query expression. The order of the values should be the same as the order in which the columns are declared in the declaration of the table or view.
• The VALUES (...) form for specifying the column values inserts one row into the table. The query expression form inserts all the rows from the query results.
• A SELECT statement utilizing a NOLOCK hint can be used within an INSERT statement. For example:
For more information using the NOLOCK hint in a SELECT statement, see “SELECT” section on page 45.
• can be used if If the table contains a foreign key and there is no corresponding primary key that matches the values of the foreign key in the record being inserted, then the insert operation is rejected.
INSERT INTO [ owner_name.]{table_name|view_name } [ ( column_name [, column_name ] , ... ) ] { VALUES ( value [, value ] , ... ) | query_expression } ;
INSERT INTO customer (cust_no, name, street, city, state) VALUES (1001, 'RALPH', '#10 Columbia Street', 'New York', 'NY') ; INSERT INTO neworders (order_no, product, qty) SELECT order_no, product, qty FROM orders WHERE order_date = SYSDATE ;
INSERT INTO PUB.CUSTOMER SELECT * FROM PUB.ARCHIVE_CUST WHERE ... WITH (NOLOCK);
39
LOCK TABLE
Authorization
Must have DBA privilege, ownership of the table, INSERT privilege on the table, or SELECT privilege on all the tables or views referred to in the query_expression, if a query_expression is specified.
Related statements
REVOKE
LOCK TABLE
Explicitly locks one or more specified tables for shared or exclusive access.
Syntax
table_name
The table in the database that you want to lock explicitly. You can specify one table or a comma-separated list of tables.
SHARE MODE
Allows all transactions to read the tables. Prohibits all other transactions from modifying the tables. After you acquire an explicit lock on a table in SHARE MODE, any SELECT statements in your transaction can read rows and do not implicitly acquire individual record locks. Any INSERT, UPDATE, and DELETE statements do acquire record locks.
EXCLUSIVE MODE
Allows the current transaction to read and modify the tables, and prohibits any other transactions from reading or modifying the tables. After you acquire an explicit lock on a table in EXCLUSIVE MODE, you can SELECT, INSERT, UPDATE, and DELETE rows, and your transaction does not implicitly acquire individual record locks for these operations.
Examples Unless another transaction holds an EXCLUSIVE lock on the teratab and megatab tables, the SHARE MODE example explicitly locks the tables. The shared lock allows all transactions to read the tables. Only the current transaction can modify the tables, as shown in the following example:
Unless another transaction holds a lock on the teratab table, the EXCLUSIVE MODE example locks the teratab table for exclusive use by the current transaction. No other transactions can read or modify the teratab table, as shown in the following example:
LOCK TABLE table_name [ , table_name ] , ... IN { SHARE | EXCLUSIVE } MODE ;
LOCK TABLE teratab, megatab IN SHARE MODE ;
LOCK TABLE teratab IN EXCLUSIVE MODE ;
40
LOCK TABLE
Without a table lock, the first SELECT statement in the following example could exceed the limits of the record lock table, while the LOCK TABLE statement prevents the subsequent SELECT statement from consuming the record lock table:
Notes • The LOCK TABLE statement might encounter a locking conflict with another transaction.
• The SHARE MODE option detects a locking conflict if another transaction:
– Locked the table in EXCLUSIVE MODE and has not issued a COMMIT or ROLLBACK
– Inserted, updated, or deleted rows in the table and has not issued a COMMIT or ROLLBACK
• The EXCLUSIVE MODE option detects a locking conflict if another transaction:
– Locked the table in SHARE MODE or EXCLUSIVE MODE and has not issued a COMMIT or ROLLBACK
– Read from, inserted, updated, or deleted rows and has not issued a COMMIT or ROLLBACK
• When there is a locking conflict, the transaction is suspended and the database returns an error. You might configure the time at which the transaction is suspended. The default is five seconds.
• You can use explicit table locking to improve the performance of a single transaction, at the cost of decreasing the concurrency of the system and potentially blocking other transactions. It is more efficient to lock a table explicitly if you know that the transaction will be updating a substantial part of a table. You gain efficiency by decreasing the overhead of the implicit locking mechanism, and by decreasing any potential wait time for acquiring individual record locks on the table.
• You can use explicit table locking to minimize potential deadlocks in situations where a transaction is modifying a substantial part of a table. Before making a choice between explicit or implicit locking, compare the benefits of table locking with the disadvantages of losing concurrency.
• The database releases explicit and implicit locks only when the transaction ends with a COMMIT or ROLLBACK operation.
Authorization
Must have DBA privilege or SELECT privilege on the table.
-- Without a table lock, this SELECT statement creates an-- entry in the record lock table for every row in teratab. SELECT COUNT (*) FROM teratab ; -- The LOCK TABLE IN SHARE MODE operation preserves the-- record lock table resource. LOCK TABLE teratab IN SHARE MODE ;SELECT COUNT (*) FROM teratab ;
41
REVOKE
Related statements
COMMIT, ROLLBACK, SET TRANSACTION ISOLATION LEVEL
REVOKE
Revokes various privileges from the specified users of the database. There are two forms of the REVOKE statement:
• Revoke database-wide privileges, either system administration (DBA), general creation (RESOURCE), audit administration (AUDIT_ADMIN), audit archive (AUDIT_ARCHIVE), or audit insert (AUDIT_INSERT)
• Revoke various privileges on specific tables and views
Syntax
RESOURCE
Revokes from the specified users the privilege to issue CREATE statements.
DBA
Revokes from the specified users the privilege to create, access, modify, or delete any database object, and revokes the privilege to grant other users any privileges.
AUDIT_ADMIN
Revokes from the specified users the privilege to administrate and maintain a database auditing system.
AUDIT_ARCHIVE
Revokes from the specified users the privilege to read and delete audit records.
AUDIT_INSERT
Revokes from the specified users the privilege to insert application audit records.
FROM username [ , username ] , ...Revokes the specified privileges on the table or view from the specified list of users.
RESTRICT | CASCADEPrompts SQL to check to see if the privilege being revoked was passed on to other users. This is possible only if the original privilege included the WITH GRANT OPTION clause. If so, the REVOKE statement fails and generates an error. If the privilege was not passed on, the REVOKE statement succeeds.
REVOKE { RESOURCE , DBA, AUDIT_ADMIN, AUDIT_ARCHIVE, AUDIT_INSERT} FROM { username [ , username ] , ... }[ RESTRICT | CASCADE ][ GRANTED BY ANY_USER ];
42
REVOKE
If the REVOKE statement specifies CASCADE, revoking the access privileges from a user also revokes the privileges from all users who received the privilege from that user.
If the REVOKE statement specifies neither RESTRICT nor CASCADE, the behavior is the same as for CASCADE.
Note CASCADE is not supported for AUDIT_ADMIN, AUDIT_ARCHIVE, and AUDIT_INSERT privileges. The only user who can revoke an audit privilege is the user who granted it.
GRANTED BY ANY_USER
A DBA can use this phrase to revoke all access privileges to a table for a specified user, even if the user was the creator of the table. This phrase is only available to those users with DBA privileges.
Example In this example, the audit administration privilege is revoked from bsmith:
This is the syntax to revoke privileges on specific tables and views:
GRANT OPTION FOR
Revokes the GRANT option for the privilege from the specified users. The actual privilege itself is not revoked. If specified with RESTRICT, and the privilege is passed on to other users, the REVOKE statement fails and generates an error. Otherwise, GRANT OPTION FOR implicitly revokes any privilege the user might have given to other users.
privilege
This is the syntax for the privilege item:
privilege [ , privilege ] , ... | ALL [ PRIVILEGES ] List of privileges to be revoked. See the description in the GRANT statement. Revoking RESOURCE and DBA privileges can only be done by the administrator or a user with DBA privileges.
REVOKE AUDIT_ADMIN FROM bsmith RESTRICT;
Syntax
REVOKE [ GRANT OPTION FOR ] { privilege [, privilege ] , ... | ALL [ PRIVILEGES ] } ON table_name
FROM { username [ , username ] , ... | PUBLIC } [ RESTRICT | CASCADE ] ;
Syntax
{ SELECT | INSERT | DELETE | INDEX | UPDATE [ ( column , column , ... ) ] | REFERENCES [ ( column , column , ... ) ] } ;
43
ROLLBACK
If more than one user grants access to the same table to a user, then all the grantors must perform a revoke for the user to lose access to the table.
Using the keyword ALL revokes all the privileges granted on the table or view.
FROM PUBLIC
Revokes the specified privileges on the table or view from any user with access to the system.
RESTRICT | CASCADEPrompts SQL to check to see if the privilege being revoked was passed on to other users. This is possible only if the original privilege included the WITH GRANT OPTION clause. If so, the REVOKE statement fails and generates an error. If the privilege was not passed on, the REVOKE statement succeeds.
If the REVOKE statement specifies CASCADE, revoking the access privileges from a user also revokes the privileges from all users who received the privilege from that user.
If the REVOKE statement specifies neither RESTRICT nor CASCADE, the behavior is the same as for CASCADE.
Example In this example, REVOKE is used on INSERT and DELETE privileges:
If the username specified in a GRANT DBA or GRANT RESOURCE operation does not already exist, the GRANT statement creates a row in the SYSDBAUTH system table for the new username. This row is not deleted by a subsequent REVOKE operation.
Authorization
Must have the DBA privilege or ownership of the table (to revoke privileges on a table). To revoke audit privileges, the user must have the DBA privilege or AUDIT ADMINISTRATION WITH GRANT privilege and be the user who granted the audit privilege.
Related statement
GRANT
ROLLBACK
Ends the current transaction and undoes any database changes performed during the transaction.
Syntax
Notes • Under certain circumstances, SQL marks a transaction for abort but does not actually roll it back immediately. Without an explicit ROLLBACK, any subsequent updates do not take
REVOKE INSERT ON customer FROM dbuser1 ;REVOKE DELETE ON cust_view FROM dbuser2 ;
ROLLBACK [ WORK ] ;
44
SELECT
effect. A COMMIT statement causes SQL to recognize the transaction as marked for abort and instead implicitly rolls back the transaction.
• SQL marks a transaction for abort in the event of a hardware or software system failure. This transaction is rolled back during recovery.
Authorization
None
Related statements
COMMIT
SELECT
Selects the specified column values from one or more rows contained in the tables or views specified in the query expression. The selection of rows is restricted by the WHERE clause. The temporary table derived through the clauses of a select statement is called a result table.
Syntax
column_list
See the “COLUMN_LIST clause” section on page 46.
TOP search_condition
See the “TOP clause” section on page 49.
FROM table_list
See the “FROM clause” section on page 50.
WHERE search_condition
See the “WHERE clause” section on page 52.
SELECT [ ALL | DISTINCT ] [ TOP n ] { *
| { table_name | alias.} * [ , { table_name.| alias.} * ] ... | expr [ [ AS ] [ ’ ] column_title [ ’ ] ]
[, expr [ [ AS ] [ ’ ] column_title [ ’ ] ] ] ... }FROM table_ref [, table_ref ] ... [ { NO REORDER } ] [ WITH ( NOLOCK ) ] [ WHERE search_condition ] [ GROUP BY [ table.]column_name [, [ table.]column_name ] ... [ HAVING search_condition ] ;[ORDER BY ordering_condition ][WITH locking_hints ][FOR UPDATE update_condition ]
;
45
SELECT
GROUP BY grouping_condition
See the “GROUP BY clause” section on page 52.
HAVING search_condition
See the “HAVING clause” section on page 54.
ORDER BY ordering_condition
See the “ORDER BY clause” section on page 54.
WITH locking_hints
See the “WITH clause” section on page 55.
FOR UPDATE update_condition
See the “FOR UPDATE clause” section on page 56.
Authorization
Must have DBA privilege or SELECT permission on all the tables or views referred to in the query_expression.
Related statements
INSERT, DELETE
COLUMN_LIST clause
Specifies which columns to retrieve by the SELECT statement.
Syntax
[ ALL | DISTINCT ] Indicates whether a result table omits duplicate rows. ALL is the default and specifies that the result table includes all rows. DISTINCT specifies that a table omits duplicate rows.
* | { table_name. | alias. } * Specifies that the result table includes all columns from all tables named in the FROM clause.
[ ALL | DISTINCT ] { * | { table_name | alias.}* [ , { table_name.| alias.} * ] ... | expr [ [ AS ] [ ' ] column_title [ ' ] ] [, expr [ [ AS ] [ ' ] column_alias [ ' ] ] ] ... | [ table| alias.]column_name , ... ] }
46
SELECT
* expr [ [ AS ] [ ' ] column_alias [ ' ] ]Specifies a list of expressions, called a select list, whose results will form columns of the result table. Typically, the expression is a column name from a table named in the FROM clause. The expression can also be any supported mathematical expression, scalar function, or aggregate function that returns a value.
The optional column_alias argument specifies a new heading for the associated column in the result table. You can also use the column_title in an ORDER BY clause. Enclose the new title in single or double quotation marks if it contains spaces or other special characters, including hyphens.
Note: A table alias cannot be used to qualify a column alias. A column alias can only be used without a qualifier because it is not a part of any table definition.
[ table | alias.]column_name , ... ] Specifies a list columns from a particular table or alias.
Examples Both these statements return all the columns in the customer table to the select list:
The table_name.* syntax is useful when the select list refers to columns in multiple tables and you want to specify all the columns in one of those tables. For example:
The following example illustrates using the column_alias option to change the name of the column:
SELECT * FROM Customer;
SELECT Customer.* FROM Customer;
SELECT Customer.CustNum, Customer.Name, Invoice.* FROM Customer, Invoice ;
47
SELECT
You must qualify a column name if it occurs in more than one table specified in the FROM clause, as shown:
When there is a conflict between a SELECT list alias and an actual database column, OpenEdge SQL interprets the reference as the database column. Note the following example:
-- Illustrate optional 'column_title' syntaxSELECT FirstName AS 'First Name', LastName AS 'Last Name', state AS 'New England State' FROM Employee WHERE state = 'NH' OR state = 'ME' OR state = 'MA'OR state = 'VT' OR state = 'CT' OR state = 'RI'; First Name Last Name New England State ---------------- ---------------- ------------------ Justine Smith MAAndy Davis MAMarcy Adams MALarry Dawsen MAJohn Burton NHMark Hall NHStacey Smith MAScott Abbott MAMeredith White NHHeather White NH
SELECT Customer.CustNum FROM Customer;
-- Table name qualifier required-- Customer table has city and state columns-- Billto table has city and state columns SELECT Customer.CustNum, Customer.City AS 'Customer City', Customer.State AS 'Customer State', Billto.City AS 'Bill City', Billto.State AS 'Bill State'FROM Customer, Billto WHERE Customer.City = 'Clinton'; CustNum Customer City Customer State Bill City Bill State -------- ---------------- ---------------- -------------------------------
1272 Clinton MS Montgomery AL 1272 Clinton MS Atlanta GA 1421 Clinton SC Montgomery AL 1421 Clinton SC Atlanta GA 1489 Clinton OK Montgomery AL 1489 Clinton OK Atlanta GA
SELECT substring (state, 1, 2) state, sum (balance)FROM pub.customerGROUP BY state;
48
SELECT
In the above query, state is ambiguous because it can refer to either database column pub.customer.state or the result of the substring scalar function in the SELECT list. The ANSI standard requires that state refers unambiguously to the database column, therefore, the query groups the result by the database column. The same principle holds true for ambiguous references that appear in WHERE, ON, and HAVING clauses.
TOP clause
Limits the rows returned by an OpenEdge SQL query at the statement level.
Syntax
When the TOP clause is specified, the OpenEdge SQL server returns the maximum number of rows specified in the clause. The maximum number allowed for the TOP clause is 2,147,483,647.
Example In the following example, the SELECT statement returns the names of the five customers with the highest account balance:
The TOP clause is only allowed in a top-level SELECT statement. Therefore, the TOP clause cannot be used in the following instances:
• As part of a subquery
• When derived tables are used in the query
• Within the CREATE TABLE, CREATE VIEW, UPDATE, and INSERT statements
• In queries used with set operators such as UNION, INTERSECT, and MINUS
In instances when the server performs aggregation on the result set (i.e., through an aggregate function such as SUM or MAX, a GROUP BY clause, or the DISTINCT keyword) the TOP clause should be interpreted as being applied last. When there is no aggregation in the SELECT statement and the result set is also sorted, then SQL will optimize sorting in order to increase query performance.
SELECT TOP is the functional equivalent of the Oracle ROWNUM functionality. Note that SELECT TOP is defined simply in terms of a limit on the result set size, and the optimizer determines how to use this limit for best data access. Thus, SELECT TOP does not have all the "procedural rules" used to define the meaning of the Oracle ROWNUM phrase.
TOP n
SELECT TOP 5 FROM pub.customer ORDER BY balance DESC;
49
SELECT
FROM clause
Specifies one or more table references. Each table reference resolves to one table (either a table stored in the database or a virtual table resulting from processing the table reference) whose rows the query expression uses to create the result table.
Syntax
table_ref
There are three forms of table references:
• A direct reference to a table, view, or synonym
• A derived table specified by a query expression in the FROM clause
• A joined table that combines rows and columns from multiple tables
If there are multiple table references, SQL joins the tables to form an intermediate result table that is used as the basis for evaluating all other clauses in the query expression. That intermediate result table is the Cartesian product of rows in the tables in the FROM clause, formed by concatenating every row of every table with all other rows in all tables, as shown in the following syntax:
FROM table_name [ AS ] [ alias [ ( column_alias [ ... ] ) ] ]Explicitly names a table. The name can be a table name, a view name, or a synonym.
alias
A name used to qualify column names in other parts of the query expression. Aliases are also called correlation names.
If you specify an alias, you must use it, and not the table name, to qualify column names that refer to the table. Query expressions that join a table with itself must use aliases to distinguish between references to column names.
Similar to table aliases, the column_alias provides an alternative name to use in column references elsewhere in the query expression. If you specify column aliases, you must specify them for all the columns in table_name. Also, if you specify column aliases in the FROM clause, you must use them, and not the column names, in references to the columns.
FROM ( query_expression ) [ AS ] [ alias [ ( column_alias [ ... ] ) ] ]Specifies a derived table through a query expression. With derived tables, you must specify an alias to identify the derived table.
FROM table_ref [, table_ref ] ... [ { NO REORDER } ]
Syntax
table_name [ AS ] [ alias [ ( column_alias [ ... ] ) ] ] | ( query_expression ) [ AS ] alias [ (column_alias [ ... ] ) ] | [ ( ] joined_table [ ) ]
50
SELECT
Derived tables can also specify column aliases. Column aliases provide alternative names to use in column references elsewhere in the query expression. If you specify column aliases, you must specify them for all the columns in the result table of the query expression. Also, if you specify column aliases in the FROM clause, you must use them, and not the column names, in references to the columns.
FROM [ ( ] joined_table [ ) ]Combines data from two table references by specifying a join condition, as shown in the following syntax:
The syntax currently allowed in the FROM clause supports only a subset of possible join conditions:
• CROSS JOIN specifies a Cartesian product of rows in the two tables. Every row in one table is joined to every row in the other table.
• INNER JOIN specifies an inner join using the supplied search condition.
• LEFT OUTER JOIN specifies a left outer join using the supplied search condition.
• LEFT JOIN specifies the same conditions as an inner join.
You can also specify these and other join conditions in the WHERE clause of a query expression.
{ NO REORDER }Disables join order optimization for the FROM clause. Use NO REORDER when you choose to override the join order chosen by the optimizer. The braces are part of the syntax for this optional clause.
[ WITH ( NOLOCK ) ]Allows a dirty read to occur in the event records are locked by another user.
Example For customers with orders, retrieve their names and order info, as shown in the following example:
Syntax
{ table_ref CROSS JOIN table_ref | table_ref [ INNER | LEFT [ OUTER ] ] JOIN table_ref ON search_condition
}
SELECT Customer.CustNum,Customer.Name, Order.OrderNum,Order.OrderDate FROM Customer, Order WHERE Customer.CustNum = Order.CustNum;
51
SELECT
WHERE clause
Specifies a search condition that applies conditions to restrict the number of rows in the result table. If the query expression does not specify a WHERE clause, the result table includes all the rows of the specified table reference in the FROM clause.
Syntax
search_condition
Applied to each row of the result table set of the FROM clause. Only rows that satisfy the conditions become part of the result table. If the result of the search_condition is NULL for a row, the row is not selected. Search conditions can specify different conditions for joining two or more tables.
Example For customers with orders, retrieve their names and order info:
GROUP BY clause
Specifies grouping of rows in the result table. The results may be grouped by column, alias or expression.
Grouping by column
The result set of a query may be ordered by one or more columns specified in the GROUP BY clause.
Syntax
Notes • For the first column specified in the GROUP BY clause, SQL arranges rows of the result table into groups whose rows all have the same values for the specified column.
• If you specify a second GROUP BY column, SQL groups rows in each main group by values of the second column.
• SQL groups rows for values in additional GROUP BY columns in a similar fashion.
• All columns named in the GROUP BY clause must also be in the select list of the query expression. Conversely, columns in the select list must also be in the GROUP BY clause or be part of an aggregate function.
Example This example retrieves name and order info for customers with orders:
WHERE search_condition
SELECT Name, City, State FROM Customer WHERE State = 'NM' ;
GROUP BY [ table_name.]column_name ...
52
SELECT
Grouping by alias
The GROUP BY clause orders the result set according to an alias specified in the SELECT statement.
Syntax
Note In this instance, the alias may be used as a simple column reference to a database table, or an actual expression composed of arithmetic expressions, character operators, date operators, or scalar functions. The alias is essentially an alternate name.
Example In the following example, the GROUP BY clause refers to the “CityState” phrase of the SELECT statement:
Grouping by expression
The GROUP BY clause orders the result set according to an expression used in the SELECT statement.
Syntax
Note The GROUP BY clause can contain any scalar expression which produces a value that is used as a grouping key. An individual column, when it is part of a larger expression in a GROUP BY list, cannot by itself be referenced in the SELECT list. Only the entire expression, which is the grouping key, can be used in the statement’s SELECT list. Note that a GROUP BY expression cannot contain an aggregate expression such as SUM.
The GROUP BY clause does not support set differencing operations such as MINUS and INTERSECT.
Example In the following example, the GROUP BY clause refers to the concatenation expression used in the SELECT statement:
SELECT DeptCode, LastName FROM Employee GROUP BY DeptCode;
GROUP BY [ alias ] ...
SELECT CONCAT (State, City) AS "CityState",COUNT (city)
FROM Pub.CustomerGROUP BY "CityState";
GROUP BY [ expression ] ...
SELECT CONCAT (State, City),COUNT (city)
FROM Pub.CustomerGROUP BY CONCAT (State, City);
53
SELECT
HAVING clause
Allows you to set conditions on the groups returned by the GROUP BY clause. If the HAVING clause is used without the GROUP BY clause, the implicit group against which the search condition is evaluated is all the rows returned by the WHERE clause.
Syntax
Note A condition of the HAVING clause can compare one aggregate function value with another aggregate function value or a constant.
Example The HAVING clause in the following example compares the value of an aggregate function(COUNT (*)) to a constant (10):
The query returns the customer number and number of orders for all customers who had more than 10 orders before March 31.
ORDER BY clause
Allows ordering of the rows selected by the SELECT statement. Unless an ORDER BY clause is specified, the rows of the result set might be returned in an unpredictable order as determined by the access paths chosen and other decisions made by the query optimizer. The decisions made will be affected by the statistics generated from table and index data examined by the UPDATE STATISTICS command.
Syntax
expr
Expression of one or more columns of the tables specified in the FROM clause of the SELECT statement.
posn
Integer column position of the columns selected by the SELECT statement.
ASC | DESC Indicates whether to order by ascending order (ASC) or descending order. The default is ASC.
The following examples demonstrates the ORDER BY clause in the SELECT statement:
HAVING search_condition
SELECT CustNum, COUNT(*) FROM Order WHERE OrderDate < TO_DATE ('3/31/2004') GROUP BY CustNum HAVING COUNT (*) > 10 ;
ORDER BY { expr | posn } [ ASC | DESC ] [ , { expr | posn } [ ASC | DESC ] , ... ]
54
SELECT
Example
Notes • The ORDER BY clause, if specified, should follow all other clauses of the SELECT statement.
• The selected rows are ordered on the basis of the first expr or posn. If the values are the same, then the second expr or posn is used in the ordering.
• A query expression can be followed by an optional ORDER BY clause. If the query expression contains set operators, then the ORDER BY clause can specify only the positions.
WITH clause
Enables table-level locking when a finer control of the types of locks acquired on an object is required. These locking hints override the current transaction isolation level for the session.
The locking hint clause, such as for READPAST, can only be specified in the main SELECT statement, but not in the subquery SELECT statement in the “search condition” of the WHERE clause.
Syntax
search_condition
The READPAST locking hint skips locked rows. This option causes a transaction to skip rows locked by other transactions that would ordinarily appear in the result set, rather than block the transaction waiting for the other transactions to release their locks on these rows. The READPAST lock hint applies only to transactions operating at READ COMMITTED isolation and will read only past row-level locks. Applies only to the SELECT statement.
The NOLOCK locking hint ensures records are not locked during the execution of a SELECT statement when the transaction isolation level is set to READ COMMITTED. When NOLOCK is invoked, a dirty read is possible. This locking hint only works with the SELECT statement.
WAIT timeout
Override the default lock-wait time out. The timeout value is in seconds and can be 0 or any positive number.
NOWAIT
Causes the SELECT statement to skip (read past) the row immediately if a lock cannot be acquired on a row in the selection set because of the lock held by some other transaction.
-- Produce a list of customers sorted by name.SELECT Name, Address, City, State, PostalCode FROM Customer ORDER BY Name ;
-- Produce a merged list of customers and suppliers.SELECT Name, Address, State, PostalCode FROM Customer UNION SELECT Name, Address, State, PostalCode FROM Supplier ORDER BY 1;
[ WITH ( READPAST NOLOCK [ WAIT timeout | NOWAIT ] ) ]
55
SET CATALOG
The default behavior is for the transaction to wait until it obtains the required lock or until it times out waiting for the lock.
The following example demonstrates the WITH clause in the SELECT statement:
Example
FOR UPDATE clause
Specifies update intention on the rows selected by the SELECT statement.
Syntax
OF [ table.]column_name , ... Specifies the table’s column name to be updated.
NOWAIT
Causes the SELECT statement to return immediately with an error if a lock cannot be acquired on a row in the selection set because of the lock held by some other transaction. The default behavior is for the transaction to wait until it obtains the required lock or until it times out waiting for the lock.
Note If you specify FOR UPDATE, the database acquires exclusive locks on all the rows satisfying the SELECT statement. The database does not acquire row level locks if there is an exclusive lock on the table. See the LOCK TABLE statement for information on table locking.
SET CATALOG
Changes the default catalog name to be used for schema, table, and column references. The default catalog name is initially the name of the primary database.
Syntax
catalog_name
Catalog name to be used as an alias for the database in schema, table and column references. This must be in the form of an SQL identifier of up to 32 bytes in length.
Example In this example, the auxiliary database connection identified by the catalog named mydb1 is specified as the default catalog:
SELECT * FROM Customer WHERE “CustNum” < 100 ORDER BY “CustNum” FORUPDATEWITH (READPAST WAIT 1);
FOR UPDATE [ OF [ table.]column_name , ... ] [ NOWAIT ]
SET CATALOG catalog_name;
SET CATALOG mydb1;
56
SET PRO_CONNECT LOG
Notes • The SET CATALOG statement is used to specify the default database catalog name to be used for schema, table, and column references.
• The primary database connection is automatically given a catalog name which is the name of the primary database. For example, if the primary database is at /usr/progress/sports2000, then the catalog name for the primary database is sports2000.
• The SET CATALOG statement may be used to set the default catalog to an auxiliary database catalog or to the primary database catalog.
• The specified catalog must identify a current catalog name.
• If an auxiliary database catalog is set as the default catalog, disconnecting from the auxiliary catalog will not change the name of the default catalog. Thus setting the default catalog to an auxiliary database may cause failures of statements when the default catalog is not set to an active catalog. In other words, shutting down an auxiliary database identified as the default catalog will cause any query using a three-part specification to fail. The failure produces an error indicating that the catalog is not connected.
Authorization
Any user is allowed to execute this statement.
SQL Compliance
Progress Software Corporation specific extension.
Related statements
CONNECT AS CATALOG, DISCONNECT CATALOG
SET PRO_CONNECT LOG
Controls logging for the current SQL Server connection.
Syntax
ON
Indicates that logging is turned on.
OFF
Indicates that logging is turned off.
STATEMENT
Indicates that statement tracing information is written to the log file.
SET PRO_CONNECT LOG [ ON | OFF ] [ WITH ( { STATEMENT, QUERY_PLAN } ) ];
57
SET PRO_CONNECT QUERY_TIMEOUT
QUERY_PLAN
Indicates that query plan information is written to the log file.
Notes • When logging is set ON, the current SQL connection begins logging to a file named as SQL_server_<server-id>_<ddmmmyyyy>_<hhmmss>.log.
For example: SQL_server_1_05MAY2005_112609.log
• The server-id corresponds to the server ID shown in database_name.lg.
• Logging files are located in the server’s work directory. The work directory corresponds to the value of the WRKDIR environment variable on UNIX systems and the applicable registry settings in Windows systems.
• The maximum size of each logging file is 500 MB. When SQL_server_<server-id>_<ddmmmyyyy>_<hhmmss>.log reaches 500 MB, the server logs a message indicating the file was closed due to reaching the maximum size. After this message is written, all logging stops, logging is set to the OFF state, and SQL_server_<server-id>_<ddmmmyyyy>_<hhmmss>.log automatically closes.
• When logging commences to a new file, the file contents begin with information about the SQL Server environment, including:
– Environment variable settings
– Parameter values passed to the server at startup
– Logging control values (such as size limits)
– The SQL Server process ID
• Each section of information written to the log file begins with the string DDMMMYYYY HH:MM:SS <user-id>:
For example, 19AUG2005 12:00:00 1:
SET PRO_CONNECT QUERY_TIMEOUT
Defines the maximum number of seconds during which a query should execute for the current SQL Server connection.
Syntax
n
Indicates the maximum number of seconds during which a query should execute before it is automatically cancelled by the SQL server.
Notes • The number of seconds specified is the maximum time allowed for the execution of the following protocol messages:
• Query statement prepare
SET PRO_CONNECT QUERY_TIMEOUT n ;
58
SET PRO_SERVER QUERY_TIMEOUT
• Query statement execution
• Query fetch
• The value specified by n applies to all subsequent protocol messages of these types until the timeout value is cleared. This may be accomplished simply by specifying a value of 0 on subsequent execution of the statement.
Example This example sets the query timeout to 30 seconds:
SET PRO_SERVER QUERY_TIMEOUT
Defines the maximum number of seconds during which a query should execute for the current SQL Server connection.
Syntax
n
Indicates the maximum number of seconds during which a query should execute before it is automatically cancelled by the SQL server. Setting an n value of 0 disables a previously set query timeout.
Notes • Execution of this command is restriced to DBAs. Any value set with this command is in effect for the duration that the database is up and running.
• Should a query timeout value be set for an individual connection via the command SET PRO_CONNECT QUERY_TIMEOUT the lower of the timeout values for the connection and the server takes precedence.
This example sets the query timeout to 30 seconds:
Statement stmt = connection.createStatement();
String MySetQueryTimeout;String MyClearQueryTimeout;
MySetTimeout = “SET PRO_CONNECT QUERY_TIMEOUT 30”;MyClearTimeout = “SET PRO_CONNECT QUERY_TIMEOUT 0”;
// Set SQL Server timeout for query execute and fetchstmt.executeUpdate( MySetQueryTimeout );
// Add code here to perform queries
// Clear SQL Server timeout for query execute and fetchstmt.executeUpdate( MyClearQueryTimeout );
SET PRO_SERVER QUERY_TIMEOUT n ;
59
SET PRO_SERVER LOG
SET PRO_SERVER LOG
Controls logging for all connections to all OpenEdge SQL Servers.
Syntax
ON
Indicates that logging is turned on.
OFF
Indicates that logging is turned off.
STATEMENT
Indicates that statement tracing information is written to each log file.
QUERY_PLAN
Indicates that query plan information is written to the log file.
Notes • When logging is set ON, each SQL Server begins logging to a file named as SQL_server_<server-id>_<ddmmmyyyy>_<hhmmss>.log
For example: SQL_server_1_05MAY2005_112609.log
• The server-id corresponds to the server ID shown in database_name.lg.
• Logging files are located in the server’s work directory. The work directory corresponds to the value of the WRKDIR environment variable on UNIX systems and the applicable registry settings in Windows systems.
• The maximum size of each logging file is 500 MB. When SQL_server_<server-id>_<ddmmmyyyy>_<hhmmss>.log reaches 500 MB, the server logs a message indicating the file was closed due to reaching the maximum size. After this message is written, all logging stops, logging is set to the OFF state, and SQL_server_<server-id>_<ddmmmyyyy>_<hhmmss>.log automatically closes.
Statement stmt = connection.createStatement();
String MySetQueryTimeout;String MyClearQueryTimeout;
MySetTimeout = “SET PRO_SERVER QUERY_TIMEOUT 30”;MyClearTimeout = “SET PRO_SERVER QUERY_TIMEOUT 0”;
// Set SQL Server timeout for query execute and fetchstmt.executeUpdate( MySetQueryTimeout );
// Add code here to perform queries
// Clear SQL Server timeout for query execute and fetchstmt.executeUpdate( MyClearQueryTimeout );
SET PRO_SERVER LOG [ ON | OFF ] [ WITH ( { STATEMENT, QUERY_PLAN } ) ];
60
SET SCHEMA
• When logging commences to a new file, the file contents begin with information about the SQL Server environment, including:
– Environment variable settings
– Parameter values passed to the server at startup
– Logging control values (such as size limits)
– The SQL Server process ID.
• Each section of information written to the log file begins with the stringDDMMMYYYY HH:MM:SS <user-id>:
For example, 19AUG2005 12:00:00 1:
SET SCHEMA
Sets the default owner, also known as schema, for unqualified table references.
Syntax
'string_literal'
Specifies the name for the default owner as a string literal, enclosed in single or double quotes.
?
Indicates a parameter marker to contain the default owner. The actual replacement value for the owner name is supplied in a subsequent SQL operation.
USER
Directs the database to set the default owner back to the username that established the session.
Example This example sets the default schema name to White:
Subsequent SQL statements with unqualified table references will use the owner name White. The SELECT statement in this example returns all rows in the ‘White.customer’ table. The username establishing the original session is still the current user.
Notes • For authorization purposes, invoking SET SCHEMA does not change the username associated with the current session.
SET SCHEMA { 'string_literal' | ? | USER }
SET SCHEMA 'White' ;COMMIT ; SELECT * from customer ;
61
SET TRANSACTION ISOLATION LEVEL
• You can set the default schema name to the username associated with the session by using a SET SCHEMA USER statement.
Authorization
None
SET TRANSACTION ISOLATION LEVEL
Explicitly sets the isolation level for a transaction. Isolation levels specify the degree to which one transaction can modify data or database objects in use by another concurrent transaction.
Syntax
isolation_level_name
The following is the syntax for isolation_level_name:
READ UNCOMMITTED
Also known as a dirty read. When this isolation level is used, a transaction can read uncommitted data that later might be rolled back. The standard requires that a transaction that uses this isolation level can only fetch data but cannot update, delete, or insert data.
READ COMMITTED
Dirty reads are not possible with this isolation level. However, if the same row is repeatedly read during the same transaction, its contents can be changed or the entire row can be deleted by other transactions.
REPEATABLE READ
This isolation level guarantees that a transaction can read the same row many times and it will remain intact. However, if a query with the same search criteria (the same WHERE clause) is executed more than once, each execution can return different sets of rows. This can happen because other transactions are allowed to insert new rows that satisfy the search criteria or update some rows in such a way that they now satisfy the search criteria.
SERIALIZABLE
This isolation level guarantees that none of the above happens. Transactions that use this level will be completely isolated from other transactions.
Notes • See the LOCK TABLE for information on record locking schemes used by each isolation level.
SET TRANSACTION ISOLATION LEVEL isolation_level_name ;
Syntax
READ UNCOMMITTED | READ COMMITTED | REPEATABLE READ | SERIALIZABLE
62
SHOW CATALOGS
• For more information on transactions, see OpenEdge Data Management: SQL Development.
Authorization
None
Related statements
COMMIT, LOCK TABLE, ROLLBACK
SHOW CATALOGS
Returns a list of available catalog information with catalog name, catalog type (primary or auxiliary), and catalog status (default or not default).
Syntax
ALL
Return all attributes.
PRO_NAME
List of catalog names.
PRO_TYPE
List of catalog types (primary or auxiliary).
PRO_STATUS
List of catalog statuses (default or notdefault)
Example In this example, the names of the currently available catalogs are returned.
Notes • This statement is useful for obtaining the catalog names of databases currently connected for the user, for identifying the catalog name of the primary database (automatically connected) and the current default catalog.
• The primary database connection is automatically given a catalog name which is the name of the primary database. For example, if the database is at /usr/progress/sports2000, then the catalog name for the primary database is sports2000.
• Three columns of information are returned by the SHOW CATALOG statement. These are the catalog name, catalog type (primary or auxiliary) and status (default or notdefault).
SHOW CATALOGS [ ALL | { PRO_NAME | PRO_TYPE | PRO_STATUS }[ , PRO_NAME | PRO_TYPE | PRO_STATUS } ;
SHOW CATALOGS PRO_NAME;
63
SHOW ENCRYPT ON
Authorization
Any user is allowed to execute this statement.
SQL Compliance
Progress Software Corporation specific extension.
Related statements
CONNECT AS CATALOG, DISCONNECT CATALOG, SET CATALOG
SHOW ENCRYPT ON
The SHOW ENCRYPT statement provides encryption policy information on the primary database. It can be used only by security administrators or DBAs.
Syntax
When run, the statement returns a result set with eight columns:
• Database object type (AREA, TABLE, INDEX, LOB)
• Database object name
• Object’s table name (blank for area)
• Database object name (blank for area)
• Database object identification
• Object policy state (CURRENT or PREVIOUS)
• Object policy cipher name
• Object policy version number
Notes • Only active policies are returned by the statement.
• The only option which shows Type I area encryption information is the SQL statement SHOW ENCRYPTION ON ALL. Other options on SHOW ENCRYPT show encryption information only for Type II area database objects.
Authorization
Security Administrator or DBA.
SHOW ENCRYPT ON { ALL | [ TABLE | INDEX | LOB ]| TABLE tablename [ WITH INDEX| WITH LOB]| TABLE tablename ON INDEX indexname } ;
64
Table constraints
SQL Compliance
Progress Software Corporation specific extension.
Related statements
ALTER TABLE, CREATE INDEX, CREATE TABLE
Table constraints
Specifies a constraint for a table that restricts the values that the table can store. INSERT, UPDATE, or DELETE statements that violate the constraint fail. SQL returns a constraint violation error.
Table constraints have syntax and behavior similar to column constraints. Note the following differences:
• The definitions of the table constraints are separated from the column definitions by commas.
• Table constraint definitions can include more than one column, and SQL evaluates the constraint based on the combination of values stored in all the columns.
Syntax
CONSTRAINT constraint_name
Allows you to assign a name that you choose to the table constraint. While this specification is optional, this facilitates making changes to the table definition, since the name you specify is in your source CREATE TABLE statement. If you do not specify a constraint_name, the database assigns a name. These names can be long and unwieldy, and you must query system tables to determine the name.
PRIMARY KEY ( column [ , ... ] )Defines the column list as the primary key for the table. There can be at most one primary key for a table.
All the columns that make up a table level primary key must be defined as NOT NULL, or the CREATE TABLE statement fails. The combination of values in the columns that make up the primary key must be unique for each row in the table.
Other tables can name primary keys in their REFERENCES clauses. If they do, SQL restricts operations on the table containing the primary key in the following ways:
• DROP TABLE statements that delete the table fail
CONSTRAINT constraint_name
PRIMARY KEY ( column [ , ... ] ) | UNIQUE ( column [ , ... ] ) | FOREIGN KEY ( column [, ... ] ) REFERENCES [ owner_name.]table_name [ ( column [ , ... ] ) ] | CHECK ( search_condition )
65
Table constraints
• DELETE and UPDATE statements that modify values in the combination of columns that match a foreign key’s value also fail
UNIQUE ( column [ , ... ] )Defines the column list as a unique, or candidate, key for the table. Unique key table-level constraints have the same rules as primary key table-level constraints, except that you can specify more than one UNIQUE table-level constraint in a table definition.
FOREIGN KEY ( column [, ... ] ) REFERENCES [ owner_name.]table_name [ ( column [ , ... ] ) ]
Defines the first column list as a foreign key and, in the REFERENCES clause, specifies a matching primary or unique key in another table.
A foreign key and its matching primary or unique key specify a referential constraint. The combination of values stored in the columns that make up a foreign key must either:
• Have at least one of the column values be null.
• Be equal to some corresponding combination of values in the matching unique or primary key.
You can omit the column list in the REFERENCES clause if the table specified in the REFERENCES clause has a primary key and you want the primary key to be the matching key for the constraint.
CHECK (search_condition)
Specifies a table level check constraint. The syntax for table level and column level check constraints is identical. Table level check constraints must be separated by commas from surrounding column definitions.
SQL restricts the form of the search condition. The search condition must not:
• Refer to any column other than columns that precede it in the table definition
• Contain aggregate functions, subqueries, or parameter references
Examples In the following example, which shows creation of a table level primary key, note that its definition is separated from the column definitions by a comma:
The following example shows how to create a table with two UNIQUE table level constraints:
CREATE TABLE SupplierItem ( SuppNum INTEGER NOT NULL, ItemNum INTEGER NOT NULL, Quantity INTEGER NOT NULL DEFAULT 0, PRIMARY KEY (SuppNum, ItemNum)) ;
66
Table constraints
The following example defines the combination of columns student_courses.teacher and student_courses.course_title as a foreign key that references the primary key of the courses table:
Note that this REFERENCES clause does not specify column names because the foreign key refers to the primary key of the courses table.
SQL evaluates the referential constraint to see if it satisfies the following search condition:
Note: INSERT, UPDATE, or DELETE statements that cause the search condition to be false violate the constraint, fail, and generate an error.
In the following example, which creates a table with two column level check constraints and one table level check constraint, each constraint is defined with a name:
CREATE TABLE OrderItem ( OrderNum INTEGER NOT NULL, ItemNum INTEGER NOT NULL, Quantity INTEGER NOT NULL, Price INTEGER NOT NULL, UNIQUE (OrderNum, ItemNum), UNIQUE (Quantity, Price));
CREATE TABLE Courses ( Instructor CHAR (20) NOT NULL, CourseTitle CHAR (30) NOT NULL, PRIMARY KEY (Instructor, CourseTitle));
CREATE TABLE StudentCourses ( StudentID INTEGER, Instructor CHAR (20), CourseTitle CHAR (30), FOREIGN KEY (Instructor, CourseTitle) REFERENCES Courses);
(StudentCourses.Ieacher IS NULL OR StudentCourses.CourseTitle IS NULL) OR EXISTS (SELECT * FROM StudentCourses WHERE (StudentCourses.Instructor = Courses.Instructor AND StudentCourses.CourseTitle = Courses.CourseTitle) )
CREATE TABLE supplier ( SuppNum INTEGER NOT NULL, Name CHAR (30), Status SMALLINT CONSTRAINT StatusCheckCon CHECK (Supplier.Status BETWEEN 1 AND 100 ), City CHAR (20) CONSTRAINT CityCheckCon CHECK (Supplier.City IN ('New York', 'Boston', 'Chicago')), CONSTRAINT SuppTabCheckCon CHECK (Supplier.City <> 'Chicago' OR Supplier.Status = 20)) ;
67
UPDATE
UPDATE
Updates the rows and columns of the specified table with the given values for rows that satisfy the search_condition.
Syntax
assignment:
This is the syntax for assignment:
Notes • If you specify the optional WHERE clause, only rows that satisfy the search_condition are updated. If you do not specify a WHERE clause, all rows of the table are updated.
• If the expressions in the SET clause are dependent on the columns of the target table, the expressions are evaluated for each row of the table.
• If a query expression is specified on the right-hand side of an assignment, the number of expressions in the first SELECT clause of the query expression must be the same as the number of columns listed on the left-hand side of the assignment.
• If a query expression is specified on the right-hand side of an assignment, the query expression must return one row.
• If a table has check constraints and if the columns to be updated are part of a check expression, then the check expression is evaluated. If the result of the evaluation is FALSE, the UPDATE statement fails.
• If a table has primary or candidate keys and if the columns to be updated are part of the primary or candidate key, SQL checks to determine if there is a corresponding row in the referencing table. If there is a corresponding row the UPDATE operation fails.
• Column names in the SET clause do not need a table_name qualifier. Since an UPDATE statement affects a single table, columns in the SET clause are implicitly qualified to the table_name identified in the UPDATE clause.
The following is an example of an UPDATE statement:
UPDATE table_name
SET assignment [, assignment ] , ... [ WHERE search_condition ] ;
Syntax
column = { expr | NULL } | ( column [, column ] , ... ) = ( expr [, expr ] ) | ( column [, column ] , ... ) = ( query_expression )
68
UPDATE STATISTICS
Examples
Authorization
Must have DBA privilege or UPDATE privileges on all the specified columns of the target table, and SELECT privilege on all the other tables referred to in the statement.
Related statements
SELECT, OPEN, FETCH
UPDATE STATISTICS
Queries data tables and updates the following statistics:
• Table cardinality
• Index statistics
• Column data distribution for columns that are index components
• Column data distribution for columns that are not index components
Syntax
Examples The following example shows default commands for table cardinality and data distribution for index component columns:
UPDATE Orderline SET Qty = 186 Where Ordernum = 22; Update Orderline SET (Itemnum) = (Select Itemnum FROM Item WHERE Itemname = 'Tennis balls') WHERE Ordernum = 20;
UPDATE Orderline SET (Qty) = (200 * 30) WHERE OrderNum = 19; UPDATE OrderLine SET (ItemNum, Price) = (SELECT ItemNum, Price * 3 FROM Item WHERE ItemName = 'gloves') WHERE OrderNum = 21 ;
UPDATE ( [ TABLE | INDEX | [ ALL ] COLUMN ] STATISTICS [ AND ]) ... [ FOR table_name ] ;
69
UPDATE STATISTICS
The following example shows commands for table cardinality only:
The following example shows commands for new index statistics:
The following example shows commands for updating column statistics for index columns only:
The following example shows commands for updating statistics for all columns:
The following example shows commands to obtain table cardinality and new index statistics and column statistics for all columns:
Notes • All statistics are obtained online. Obtaining statistics does not require an exclusive lock on the schema or any table locks. Rows written to statistics tables will be exclusively locked, as in every transaction performing updates. Therefore, statistics can be obtained while normal database operations continue.
• Specifying TABLE STATISTICS obtains table cardinality only. Table cardinalities are stored in the SYSTABLSTAT system catalog table.
• Specifying INDEX STATISTICS obtains statistics on the number of unique values in each index. Index statistics are stored in the SYSIDXSTAT system catalog table.
• Specifying COLUMN STATISTICS (without ALL) obtains statistics on the data distribution of values for each column that is an index key component.
• Specifying ALL COLUMN STATISTICS obtains statistics on the data distribution of values for all columns.
• The STATISTICS phrase can be repeated so that up to three statistics can be requested by a single UPDATE STATISTICS statement.
UPDATE STATISTICS FOR Customer;
UPDATE TABLE STATISTICS FOR Customer;
UPDATE INDEX STATISTICS FOR Customer;
UPDATE COLUMN STATISTICS FOR Customer;
UPDATE ALL COLUMN STATISTICS FOR Customer;
UPDATE TABLE STATISTICS AND INDEX STATISTICS AND ALL COLUMN STATISTICS FOR Customer;
70
UPDATE STATISTICS
• By default, for the simple statement UPDATE STATISTICS, where the type of statistics is not specified, SQL will obtain table and index column statistics. This is equivalent to the statement UPDATE TABLE STATISTICS AND COLUMN STATISTICS.
• A table containing LONG data types can get table, index, and/or column statistics. The columns that are LONG data types cannot get statistics.
• Obtaining table statistics runs in time proportional to the table’s primary index.
• Obtaining column statistics runs in time proportional to the table’s primary index, plus an additional amount proportional to the number of columns in the table.
• Obtaining index statistics runs in time proportional to the total size for all indexes for the table.
• Table statistics are often the most useful statistic, as they influence join order substantially.
• Index statistics are important when a table has five or more indexes. This is especially true if some of the indexes are similar to one another.
• Column statistics are the most useful when applications use range predicates, such as BETWEEN and the operators <, <=, > and >=.
Authorization
Must have DBA privilege, SELECT privilege, or ownership of table.
71
UPDATE STATISTICS
72
OpenEdge SQL Functions
This section provides detailed information on each SQL function. A description for each function provides the following information:
• A definition of the function
• The syntax of the function’s proper usage
• A code sample that shows how the function works
• Any associated notes
About OpenEdge SQL functions
A function is an SQL expression that returns a value based on arguments supplied. OpenEdge® SQL supports five aggregate functions and 90 scalar functions.
Aggregate functions
Aggregate functions calculate a single value for a collection of rows in a result table. If the function is in a statement with a GROUP BY clause, it returns a value for each group in the result table. Aggregate functions are also called set or statistical functions. Aggregate functions cannot be nested. The aggregate functions are:
• AVG
• COUNT
• MAX
• MIN
• SUM
ABS
Scalar functions
Scalar functions calculate a value based on another single value. Scalar functions are also called value functions and can be nested.
ABS
Computes the absolute value of expression.
Syntax
Example This example illustrates the ABS function:
Notes • The argument to the function must be of type TINYINT, SMALLINT, INTEGER, NUMERIC, REAL, or FLOAT.
• The result is of type NUMERIC.
• If the argument expression evaluates to NULL, the result is NULL.
Compatibility
ODBC compatible
ACOS
Returns the arccosine of expression.
Syntax
Example In this example, which illustrates two ways to use the ACOS function, the first SELECT statement returns the arcosine in radians, and the second returns the arcosine in degrees:
ABS ( expression )
SELECT ABS (MONTHS_BETWEEN (SYSDATE, order_date)) FROM ordersWHERE ABS (MONTHS_BETWEEN (SYSDATE, order_date)) > 3 ;
ACOS ( expression )
74
ADD_MONTHS
Notes • ACOS takes the ratio (expression) of two sides of a right triangle and returns the corresponding angle. The ratio is the length of the side adjacent to the angle divided by the length of the hypotenuse.
• The result is expressed in radians and is in the range -Pi/2 to Pi/2 radians. To convert degrees to radians, multiply degrees by Pi/180. To convert radians to degrees, multiply radians by 180/Pi.
• The expression must be in the range -1 to 1.
• The expression must evaluate to an approximate numeric data type.
Compatibility
ODBC compatible
ADD_MONTHS
Adds to the date value specified by the date_expression, the given number of months specified by integer_expression, and returns the resultant date value.
Syntax
Example This example illustrates the ADD_MONTHS function:
Notes • The first argument must be of DATE type.
• The second argument to the function must be of NUMERIC type.
• The result is of type DATE.
select acos (.5) 'Arccosine in radians' from syscalctable;
ARCCOSINE IN RADIANS--------------------1.047197551196598 1 record selected select acos (.5) * (180/ pi()) 'Arccosine in degrees' from syscalctable; ARCCOSINE IN DEGREES-------------------- 59.9999999999999931 record selected
ADD_MONTHS ( date_expression , integer_expression )
SELECT * FROM customerWHERE ADD_MONTHS (start_date, 6) > SYSDATE ;
75
ASCII
• If any of the arguments evaluates to NULL, the result is NULL.
Compatibility
Progress extension
ASCII
Returns the ASCII value of the first character of the given character expression.
Syntax
Example The following example shows how to use the ASCII function:
Notes • The argument to the function must be of type CHARACTER.
• The result is of type INTEGER.
• If the argument char_expression evaluates to NULL, the result is NULL.
• The ASCII function is character-set dependent and supports multi-byte characters. The function returns the character encoding integer value of the first character of char_expression in the current character set. If char_expression is a literal string, the result is determined by the character set of the SQL client. If char_expression is a column in the database, the character set of the database determines the result.
Compatibility
ODBC compatible
ASIN
Returns the arcsine of expression.
Syntax
Example In the following example, which shows how to use the ASIN function, the first SELECT statement returns the arcsine in degrees, and the second returns the arcsine in radians:
ASCII ( char_expression )
SELECT ASCII ( PostalCode ) FROM Customer;
ASIN ( expression )
76
ATAN
ASIN takes the ratio (expression) of two sides of a right triangle and returns the corresponding angle. The ratio is the length of the side opposite the angle divided by the length of the hypotenuse.
The result is expressed in radians and is in the range -pi/2 to pi/2 radians. To convert degrees to radians, multiply degrees by pi/180. To convert radians to degrees, multiply radians by 180/pi.
Notes • The expression must be in the range -1 to 1.
• The expression must evaluate to an approximate numeric data type.
Compatibility
ODBC compatible
ATAN
Returns the arctangent of expression.
Syntax
Example The following example illustrates two ways to use the ATAN function:
SELECT ASIN (1) * (180/ pi()) 'Arcsine in degrees' FROM SYSPROGRESS.SYSCALCTABLE; ARCSINE IN DEGREES------------------- 90.000000000000000 1 record selected SELECT ASIN (1) 'Arcsine in radians' FROM SYSPROGRESS.SYSCALCTABLE; ARCSINE IN RADIANS------------------ 1.570796326794897 1 record selected
ATAN ( expression )
77
ATAN2
ATAN takes the ratio (expression) of two sides of a right triangle and returns the corresponding angle. The ratio is the length of the side opposite the angle divided by the length of the side adjacent to the angle.
The result is expressed in radians and is in the range -Pi/2 to Pi/2 radians. To convert degrees to radians, multiply degrees by Pi/180. To convert radians to degrees, multiply radians by 180/Pi.
Notes • The expression must be in the range -1 to 1.
• The expression must evaluate to an approximate numeric data type.
Compatibility
ODBC compatible
ATAN2
Returns the arctangent of the x and y coordinates specified by expression1 and expression2.
Syntax
Example The following example illustrates two ways to use the ATAN2 function:
select atan (1) * (180/ pi()) 'Arctangent in degrees' from syscalctable; ARCTANGENT IN DEGREES----------------------- 45.000000000000000 1 record selected select atan (1) 'Arctangent in radians' from syscalctable; ARCTANGENT IN RADIANS----------------------- 0.785398163397448 1 record selected
ATAN2 ( expression1 , expression2 )
78
AVG
Notes • ATAN2 takes the ratio of two sides of a right triangle and returns the corresponding angle. The ratio is the length of the side opposite the angle divided by the length of the side adjacent to the angle.
• expression1 and expression2 specify the x and y coordinates of the end of the hypotenuse opposite the angle.
• The result is expressed in radians and is in the range -pi/2 to pi/2 radians. To convert degrees to radians, multiply degrees by pi/180. To convert radians to degrees, multiply radians by 180/pi.
• Both expression1 and expression2 must evaluate to approximate numeric data types.
Compatibility
ODBC compatible
AVG
Computes the average of a collection of values. The keyword DISTINCT specifies that the duplicate values are to be eliminated before computing the average.
Syntax
Example This example illustrates the AVG function:
Notes • NULL values are eliminated before the average value is computed. If all the values are NULL, the result is NULL.
select atan2 (1,1) * (180/ pi()) 'Arctangent in degrees' from syscalctable; ARCTANGENT IN DEGREES----------------------- 45.000000000000000 1 record selected select atan2 (1,1) 'Arctangent in radians' from syscalctable; ARCTANGENT IN RADIANS----------------------- 0.785398163397448 1 record selected
AVG ( { [ ALL ] expression } | { DISTINCT column_ref } )
SELECT AVG (salary) FROM employee WHERE deptno = 20 ;
79
CASE
• The argument to the function must be of type SMALLINT, INTEGER, NUMERIC, REAL, or FLOAT.
• The result is of type NUMERIC.
CASE
Specifies a series of search conditions and associated result expressions. The general form is called a searched case expression. SQL returns the value specified by the first result expression whose associated search condition evaluates as true. If none of the search conditions evaluates as true, the CASE expression returns a NULL value, or the value of some other default expression if the CASE expression includes the ELSE clause.
CASE also supports syntax for a shorthand notation, called a simple case expression, for evaluating whether one expression is equal to a series of other expressions.
Syntax
searched_case_expr
simple_case_expr
CASE
Specifies a searched case expression. It must be followed by one or more WHEN-THEN clauses, each specifying a search condition and corresponding expression.
WHEN search_condition THEN { result_expr | NULL } Specifies a search condition and corresponding expression. SQL evaluates search_condition. If search_condition evaluates as true, CASE returns the value specified by result_expr, or NULL, if the clause specifies THEN NULL.
If search_condition evaluates as false, SQL evaluates the next WHEN-THEN clause, if any, or the ELSE clause, if it is specified.
searched_case_expr | simple_case_expr
Syntax
CASE
WHEN search_condition THEN { result_expr | NULL } [ ... ] [ ELSE expr | NULL ]END
Syntax
CASE primary_expr
WHEN expr THEN { result_expr | NULL } [ ... ] [ ELSE expr | NULL ]
80
CASE
CASE primary_expr
Specifies a simple case expression. In a simple case expression, one or more WHEN-THEN clauses specify two expressions.
WHEN expr THEN { result_expr | NULL } Prompts SQL to evaluate expr and compare it with primary_expr specified in the CASE clause. If they are equal, CASE returns the value specified by result_expr (or NULL, if the clause specifies THEN NULL).
If expr is not equal to primary_expr, SQL evaluates the next WHEN-THEN clause, if any, or the ELSE clause, if it is specified.
ELSE { expr | NULL }Specifies an optional expression whose value SQL returns if none of the conditions specified in WHEN-THEN clauses are satisfied. If the CASE expression omits the ELSE clause, it is the same as specifying ELSE NULL.
Examples A simple case expression can always be expressed as a searched case expression. This example illustrates a simple case expression:
The simple case expression in the preceding CASE example is equivalent to the following searched case expression:
The following example shows a searched case expression that assigns a label denoting suppliers as 'In Mass' if the state column value is 'MA':
CASE primary_expr WHEN expr1 THEN result_expr1 WHEN expr2 THEN result_expr2 ELSE expr3END
CASE WHEN primary_expr = expr1 THEN result_expr1 WHEN primary_expr = expr2 THEN result_expr2 ELSE expr3END
81
CAST
The following example shows the equivalent simple case expression:
Notes • This function is not allowed in a GROUP BY clause.
• Arguments to this function cannot be query expressions.
Compatibility
SQL compatible
CAST
Converts an expression to another data type. The first argument is the expression to be converted. The second argument is the target data type.
The length option for the data_type argument specifies the length for conversions to CHAR and VARCHAR data types. If omitted, the default is 1 byte.
SELECT name, city, CASE WHEN state = 'MA' THEN 'In Mass' ELSE 'Not in Mass' ENDFROM supplier; Name City searched_case(State,MA,In Mass,) ---------------- ---------------- -------------------------------- GolfWorld Suppl Boston In MassPool Swimming S Valkeala Not in MassNordic Ski Whol Hingham In MassChampion Soccer Harrow Not in MassABC Sports Supp Boston In MassSeasonal Sports Bedford In MassTennis Supplies Boston In MassBoating Supplie Jacksonville Not in MassAerobic Supplie Newport Beach Not in MassSports Unlimite Irving Not in Mass
SELECT name, city, CASE state WHEN 'MA' THEN 'In Mass' ELSE 'Not in Mass' END FROM supplier; Name City simple_case(State,MA,In Mass,) ---------------- ---------------- ------------------------------ GolfWorld Suppl Boston In Mass Pool Swimming S Valkeala Not in Mass Nordic Ski Whol Hingham In Mass Champion Soccer Harrow Not in Mass ABC Sports Supp Boston In Mass Seasonal Sports Bedford In Mass Tennis Supplies Boston In Mass Boating Supplie Jacksonville Not in Mass Aerobic Supplie Newport Beach Not in Mass Sports Unlimite Irving Not in Mass
82
CEILING
If the expression evaluates to NULL, the result of the function is null. Specifying NULL with the CAST function is useful for set operations, such as UNION, that require two tables to have the same structure. CAST NULL allows you to specify a column of the correct data type, so a table with a similar structure to another, but with fewer columns, can be in a union operation with the other table.
The CAST function provides a data-type-conversion mechanism compatible with the SQL standard.
Use the CONVERT function, enclosed in the ODBC escape clause { fn }, to specify ODBC-compliant syntax for data type conversion. See “CONVERT (ODBC compatible)” section on page 86 for more information.
Syntax
Example The following SQL example uses CAST to convert an integer field from a catalog table to a CHARACTER data type:
Compatibility
SQL compatible
CEILING
Returns the smallest integer greater than or equal to expression.
Syntax
Example This example illustrates the CEILING function:
Note The expression must evaluate to a numeric data type.
Compatibility
ODBC compatible
CAST ( { expression | NULL } AS data_type [ ( length )] )
SELECT CAST(fld AS CHAR(25)), fld FROM sysprogress.syscalctable; CONVERT(CHARACTER(25),FLD) FLD-------------------------- --- 100 100 1 record selected
CEILING ( expression )
SELECT CEILING (32.5) 'Ceiling' FROM SYSPROGRESS.SYSCALCTABLE;
83
CHAR
CHAR
Returns a character string with the first character having an ASCII value equal to the argument expression. CHAR is identical to CHR but provides ODBC-compatible syntax.
Syntax
Example This example illustrates the CHAR function:
Notes • The argument to the function must be of type INTEGER, TINYINT, or SMALLINT.
• The result is of type CHARACTER.
• If the argument integer_expression evaluates to NULL, the result is NULL.
• The CHAR and CHR functions are character-set dependent and support single-byte and multi-byte characters. If integer_expression is a valid character encoding integer value in the current SQL server character set, the function returns the correct character. If it is not a valid character, the function returns a NULL value.
Compatibility
ODBC compatible
CHR
Returns a character string with the first character having an ASCII value equal to the argument expression.
Syntax
Example This example illustrates the CHR function and the SUBSTR (substring) function:
Notes • The argument to the function must be of type INTEGER, TINYINT, or SMALLINT.
• The result is of type CHARACTER.
• If the argument integer_expression evaluates to NULL, the result is NULL.
CHAR ( integer_expression )
SELECT *FROM customerWHERE SUBSTR (zip, 1, 1) = CHAR (53) ;
CHR ( integer_expression )
SELECT *FROM customerWHERE SUBSTR (zip, 1, 1) = CHR (53) ;
84
COALESCE
• The CHR and CHAR functions are character-set dependent, and support multi-byte characters. If integer_expression is a valid character encoding integer value in the current SQL server character set, the function returns the correct character. If it is not a valid character the function returns a NULL value.
Compatibility
Progress extension
COALESCE
Specifies a series of expressions and returns the first expression whose value is not NULL. If all the expressions evaluate as null, COALESCE returns a NULL value.
Syntax
The COALESCE syntax is shorthand notation for a common case that can also be represented in a CASE expression. The following two formulations are equivalent:
Example This example illustrates the COALESCE function:
Notes • This function is not allowed in a GROUP BY clause.
• Arguments to this function cannot be query expressions.
Compatibility
SQL compatible
CONCAT
Returns a concatenated character string formed by concatenating two arguments.
COALESCE ( expression1, expression2 [... ] )
COALESCE ( expression1 , expression2 , expression3 )
CASE WHEN expression1 IS NOT NULL THEN expression1 WHEN expression2 IS NOT NULL THEN expression2 ELSE expression3 END
SELECT COALESCE (end_date, start_date) from job_hist;
85
CONVERT (ODBC compatible)
Syntax
Example This example illustrates the CONCAT function:
Notes • Both of the arguments must be of type CHARACTER or VARCHAR.
• The result is of type VARCHAR.
• If any of the argument expressions evaluate to NULL, the result is NULL.
• The two char_expression expressions and the result of the CONCAT function can contain multi-byte characters.
Compatibility
ODBC compatible
CONVERT (ODBC compatible)
Converts an expression to another data type. The first argument is the expression to be converted. The second argument is the target data type.
If the expression evaluates to NULL, the result of the function is NULL.
The ODBC CONVERT function provides ODBC-compliant syntax for data type conversions. You must enclose the function with the ODBC escape clause { fn } to use ODBC-compliant syntax.
Syntax
Note Braces are part of the actual syntax. The following data types are used:
Compatibility
ODBC compatible
CONCAT ( char_expression , char_expression )
SELECT last_name, empno, salary FROM customer WHERE project = CONCAT('US',proj_nam);
{ fn CONVERT ( expression , data_type ) }
SQL_BINARY | SQL_BIT | SQL_CHAR | SQL_DATE | SQL_DECIMAL | SQL_DOUBLE | SQL_FLOAT | SQL_INTEGER | SQL_REAL | SQL_SMALLINT | SQL_TIME | SQL_TIMESTAMP | SQL_TINYINT | SQL_VARBINARY | SQL_VARCHAR
86
CONVERT (Progress extension)
CONVERT (Progress extension)
Converts an expression to another data type. The first argument is the target data type. The second argument is the expression to be converted to that type.
The length option for the data_type argument specifies the length for conversions to CHAR and VARCHAR data types. If omitted, the default is 30 bytes.
If the expression evaluates to NULL, the result of the function is NULL.
The CONVERT function syntax is similar to, but not compatible with, the ODBC CONVERT function. Enclose the function in the ODBC escape clause { fn } to specify ODBC-compliant syntax. See the ODBC compatible CONVERT function for more information.
Syntax
Example The following SQL example uses the CONVERT function to convert an INTEGER field from a system table to a character string:
Note When data_type is CHARACTER( length ) or VARCHAR( length ), the length specification represents the number of characters. The converted result can contain multi-byte characters.
Compatibility
Progress extension
COS
Returns the cosine of expression.
Syntax
Example This example illustrates the COS function:
CONVERT ( 'data_type [ ( length ) ]', expression )
SELECT CONVERT('CHAR', fld), fld FROM sysprogress.syscalctable; CONVERT(CHAR,FLD) FLD----------------- --- 100 100 1 record selected SELECT CONVERT('CHAR(35)', fld), fld FROM sysprogress.syscalctable; CONVERT(CHAR(35),FLD) FLD--------------------- --- 100 100 1 record selected
COS ( expression )
87
COUNT
Notes • COS takes an angle expression and returns the ratio of two sides of a right triangle. The ratio is the length of the side adjacent to the angle divided by the length of the hypotenuse.
• The expression specifies an angle in radians.
• The expression must evaluate to an approximate numeric data type.
• To convert degrees to radians, multiply degrees by Pi/180. To convert radians to degrees, multiply radians by 180/Pi.
Compatibility
ODBC compatible
COUNT
Computes either the number of rows in a group of rows or the number of non-NULL values in a group of values.
Syntax
Example This example illustrates the COUNT function:
Notes • The keyword DISTINCT specifies that the duplicate values are to be eliminated before computing the count.
• If the argument to COUNT function is ‘*’, then the function computes the count of the number of rows in a group.
• If the argument to COUNT function is not ‘*’, then NULL values are eliminated before the number of rows is computed.
• The argument column_ref or expression can be of any type.
• The result of the function is of BIGINT data type. The result is never NULL.
select cos(45 * pi()/180) 'Cosine of 45 degrees' from sysprogress.syscalctable; COSINE OF 45 DEG---------------- 0.707106781186548 1 record selected
COUNT ( { [ ALL ] expression } | { DISTINCT column_ref } | * )
SELECT COUNT (*) FROM orders WHERE order_date = SYSDATE ;
88
CURDATE
CURDATE
Returns the current date as a DATE value. This function takes no arguments.
Syntax
Example The following example shows how to use the CURDATE function:
Note SQL statements can refer to CURDATE anywhere they can refer to a DATE expression.
Compatibility
ODBC compatible
CURTIME
Returns the current time as a TIME value. This function takes no arguments.
Syntax
Example This example illustrates how to use the CURTIME function to INSERT the current time into the create_time column of the objects table:
Note SQL statements can refer to CURTIME anywhere they can refer to a TIME expression.
Compatibility
ODBC compatible
CURRVAL
CURRVAL returns the current value of a sequence, and uses the following syntax to reference the current value of a sequence.
Syntax
CURDATE ( )
INSERT INTO objects (object_owner, object_id, create_date) VALUES (USER, 1001, CURDATE()) ;
CURTIME ( )
INSERT INTO objects (object_owner, object_id, create_time) VALUES (USER, 1001, CURTIME()) ;
schema.sequence.CURRVAL
89
DATABASE
schema
Specifies the schema that contains the sequence. To refer to the current value of a sequence in the schema of another user, you must have SELECT object privilege on the sequence.
sequence
Specifies the name of the sequence whose current value you want.
Use CURRVAL in:
• The SELECT list of a SELECT statement not contained in a subquery or view
• The SELECT list of a subquery in an INSERT statement
• The VALUES clause of an INSERT statement
• The SET clause of an UPDATE statement
CURRVAL cannot be used in:
• A query of a view
• A SELECT statement with a GROUP BY clause that references a sequence
• A SELECT statement with an ORDER BY clause that references a sequence
• A SELECT statement that is combined with another SELECT statement with the UNION, INTERSECT, or MINUS set operator
• The WHERE clause of a SELECT or UPDATE statement
• The DEFAULT value of a column in a CREATE TABLE or ALTER TABLE statement
• The condition of a CHECK constraint
Example In the following example, the OpenEdge SQL sequence generator returns the current value of the customer sequence:
DATABASE
Returns the name of the database corresponding to the current connection name. This function takes no arguments, and the trailing parentheses are optional.
Syntax
Example The following example shows how to use the DATABASE function:
SELECT customer_sequence.CURRVAL FROM pub.customer;
DATABASE [ ( ) ]
90
DAYNAME
Compatibility
ODBC compatible
DAYNAME
Returns a character string containing the name of the day (for example, Sunday through Saturday) for the day portion of date_expression. The argument date_expression can be the name of a column, the result of another scalar function, or a date or timestamp literal.
Syntax
Example This example illustrates the DAYNAME function:
Compatibility
ODBC compatible
DAYOFMONTH
Returns the day of the month in the argument as a short integer value in the range of 1–31. The argument date_expression can be the name of a column, the result of another scalar function, or a date or timestamp literal.
Syntax
Example This example illustrates the DAYOFMONTH function:
select database() from t2; DATABASE--------steel 1 record selected
DAYNAME ( date_expression )
SELECT * FROM orders WHERE order_no = 342 and DAYNAME(order_date)= 'SATURDAY'; ORDER_NO ORDER_DATE REFERENCE CUST_NO-------- ----------- ---------- --------342 08/10 tdfg/101 10001 1 record selected
DAYOFMONTH ( date_expression )
91
DAYOFWEEK
Notes • The date_expression argument must be of type DATE.
• If date_expression is supplied as a date literal, it can be any of the valid date_literal formats where the day specification (DD) precedes the month specification (MM).
• The result is of type SHORT.
• If the argument expression evaluates to NULL, the result is NULL.
Compatibility
ODBC compatible
DAYOFWEEK
Returns the day of the week in the argument as a short integer value in the range of 1–7.
The argument date_expression can be the name of a column, the result of another scalar function, or a date or timestamp literal.
Syntax
Example The following example shows how to use the DAYOFWEEK function:
Notes • The argument to the function must be of type DATE.
• If date_expression is supplied as a date literal, it can be any of the valid date_literal formats where the day specification (DD) precedes the month specification (MM).
• The result is of type SHORT.
• If the argument expression evaluates to NULL, the result is NULL.
Compatibility
ODBC compatible
SELECT *FROM ordersWHERE DAYOFMONTH (order_date) = 14 ;
DAYOFWEEK ( date_expression )
SELECT *FROM ordersWHERE DAYOFWEEK (order_date) = 2 ;
92
DAYOFYEAR
DAYOFYEAR
Returns the day of the year in the argument as a short integer value in the range of 1–366. The argument date_expression can be the name of a column, the result of another scalar function, or a date or timestamp literal.
Syntax
Example This example illustrates the DAYOFYEAR function:
Notes • The argument to the function must be of type DATE.
• The result is of type SHORT.
• If the argument expression evaluates to NULL, the result is NULL.
Compatibility
ODBC compatible
DB_NAME
Returns the name of the database corresponding to the current connection name.
Syntax
Example This example illustrates the DB_NAME function:
Compatibility
Progress extension
DAYOFYEAR ( date_expression )
SELECT *FROM ordersWHERE DAYOFYEAR (order_date) = 300 ;
DB_NAME ( )
SELECT DB_NAME() FROM T2; DB_NAME ------- demo 1 record selected
93
DECODE
DECODE
Compares the value of the first argument expression with each search_expression and, if a match is found, returns the corresponding match_expression. If no match is found, then the function returns the default_expression. If a default_expression is not specified and no match is found, then the function returns a NULL value.
Syntax
Example This example illustrates one way to use the DECODE function:
Notes • Use a simple case expression when SQL-compatible syntax is a requirement.
• The first argument expression can be of any type. The types of all search_expressions must be compatible with the type of the first argument.
• The match_expressions can be of any type. The types of all match_expressions must be compatible with the type of the first match_expression.
• The type of the default_expression must be compatible with the type of the first match_expression.
• The type of the result is the same as that of the first match_expression.
• If the first argument expression is NULL, then the value of the default_expression is returned, if it is specified. Otherwise NULL is returned.
Compatibility
Progress extension
DEGREES
Returns the number of degrees in an angle specified in radians by expression.
Syntax
DECODE ( expression, search_expression, match_expression
[ , search_expression, match_expression ...][ , default_expression ] )
SELECT ename, DECODE (deptno, 10, 'ACCOUNTS', 20, 'RESEARCH', 30, 'SALES', 40, 'SUPPORT', 'NOT ASSIGNED' ) FROM employee ;
DEGREES ( expression )
94
EXP
Example This example illustrates the DEGREES function:
Notes • The expression specifies an angle in radians.
• The expression must evaluate to a numeric data type.
Compatibility
ODBC compatible
EXP
Returns the exponential value of expression (e raised to the power of expression).
Syntax
Example This example illustrates the EXP function:
Note expression must evaluate to an approximate numeric data type.
Compatibility
ODBC compatible
FLOOR
Returns the largest integer less than or equal to expression.
Syntax
Example This example illustrates the FLOOR function:
Note expression must evaluate to a numeric data type.
SELECT DEGREES(3.14159265359) 'Degrees in pi Radians' FROM SYSPROGRESS.SYSCALCTABLE;
EXP ( expression )
SELECT EXP( 4 ) 'e to the 4th power' from sysprogress.syscalctable;
FLOOR ( expression )
SELECT FLOOR (32.5) 'Floor' from sysprogress.syscalctable ;
95
GREATEST
Compatibility
ODBC compatible
GREATEST
Returns the greatest value among the values of the given expressions.
Syntax
Example This example illustrates the GREATEST function:
Notes • The first argument to the function can be of any type. However, the types of the subsequent arguments must be compatible with that of the first argument.
• The type of the result is the same as that of the first argument.
• If any of the argument expressions evaluate to NULL, the result is NULL.
• When the data type of an expression is either CHARACTER(length) or VARCHAR(length), the expression can contain multi-byte characters. The sort weight for each character is determined by the collation table in the database.
Compatibility
Progress extension
HOUR
Returns the hour in the argument as a short integer value in the range of 0–23.
Syntax
Example This example illustrates the HOUR function:
Notes • The argument to the function must be of type TIME.
GREATEST ( expression , expression ... )
SELECT cust_no, last_name, GREATEST (ADD_MONTHS (start_date, 10), SYSDATE) FROM customer ;
HOUR ( time_expression )
SELECT *FROM arrivalsWHERE HOUR (in_time) < 12 ;
96
IFNULL
• The argument must be specified in the format hh:mi:ss.
• The result is of type SHORT.
• If the argument expression evaluates to NULL, the result is NULL.
Compatibility
ODBC compatible
IFNULL
Returns value if expr is NULL. If expr is not NULL, IFNULL returns expr.
Syntax
Example In this example, which illustrates the IFNULL function, the SELECT statement returns three rows with a NULL value in column C1, and two non-NULL values:
Note The data type of value must be compatible with the data type of expr.
Compatibility
ODBC compatible
INITCAP
Returns the result of the argument character expression after converting the first character to uppercase and the subsequent characters to lowercase.
Syntax
Example The following example shows how to use the INITCAP function:
IFNULL( expr, value)
SELECT C1, IFNULL(C1, 9999) FROM TEMP ORDER BY C1; C1 IFNULL(C1,9999)-- ---------------- 9999 9999 99991 13 3
INITCAP ( char_expression )
SELECT INITCAP (last_name) FROM customer ;
97
INSERT
Notes • The char_expression must be of type CHARACTER.
• The result is of type CHARACTER.
• If the argument expression evaluates to NULL, the result is NULL.
• A char_expression and the result can contain multi-byte characters. The uppercase conversion for the first character and the lowercase conversion for the rest of the characters is based on the case table in the convmap file. The default case table is BASIC.
Compatibility
Progress extension
INSERT
Returns a character string where length number of characters have been deleted from string_exp1 beginning at start_pos, and string_exp2 has been inserted into string_exp1, beginning at start_pos.
Syntax
Example This example illustrates the INSERT function:
The two letters ‘o’ and ‘l’ are deleted from the name ‘Goldman’ in the last_name column, and the letters ‘xx’ are inserted into the last_name column, beginning at the fourth character, overlaying the letters ‘d’ and ‘m’.
Notes • The string_exp can be type fixed-length or variable-length CHARACTER.
• The start_pos and length can be of data type INTEGER, SMALLINT, or TINYINT.
• The result string is of the type string_exp1.
• If any of the argument expressions evaluate to NULL, the result is NULL.
• If start_pos is negative or zero, the result string evaluates to NULL.
• If length is negative, the result evaluates to NULL.
INSERT( string_exp1 , start_pos , length , string_exp2 )
SELECT INSERT(last_name,2,4,'xx') FROM customer WHERE last_name = 'Goldman'; INSERT LAST_NAME,2,4,XX)------------------------Gxxan 1 record selected
98
INSTR
• string_exp1 and string_exp2 and the result can contain multi-byte characters. This is determined by the character set of the SQL server. The length argument specifies a number of characters.
Compatibility
ODBC compatible
INSTR
Searches character string char_expression1 for the character string char_expression2. The search begins at start_pos of char_expression1. If occurrence is specified, then INSTR searches for the nth occurrence, where n is the value of the fourth argument.
The position (with respect to the start of char_expression1) is returned if a search is successful. Zero is returned if no match can be found.
Syntax
Example This example illustrates the INSTR function:
Notes • The first and second arguments must be CHARACTER data type.
• The third and fourth arguments, if specified, must be SMALLINT or TINYINT data type.
• The value for start position in a character string is the ordinal number of the character in the string. The very first character in a string is at position 1, the second character is at position 2, the nth character is at position n.
• If you do not specify start_pos, a default value of 1 is assumed.
• If you do not specify occurrence, a default value of 1 is assumed.
• The result is INTEGER data type.
• If any of the argument expressions evaluate to NULL, the result is NULL.
• A char_expression and the result can contain multi-byte characters.
Compatibility
Progress extension
INSTR ( char_expression1 , char_expression2
[ , start_pos [ , occurrence ] ] )
SELECT cust_no, last_name FROM customer WHERE INSTR (LOWER (addr), 'heritage') > 0 ;
99
LAST_DAY
LAST_DAY
Returns the date corresponding to the last day of the month containing the argument date.
Syntax
Example This example illustrates the LAST_DAY function:
Notes • The argument to the function must be of type DATE.
• The result is of type DATE.
• If the argument expression evaluates to NULL, the result is NULL.
Compatibility
Progress extension
LCASE
Returns the result of the argument character expression after converting all the characters to lowercase. LCASE is the same as LOWER but provides ODBC-compatible syntax.
Syntax
Example This example illustrates the LCASE function:
Notes • The argument to the function must be of type CHARACTER.
• The result is of type CHARACTER.
• If the argument expression evaluates to NULL, the result is NULL.
• A char_expression and the result can contain multi-byte characters. The lowercase conversion is determined by the case table in the convmap file. The default case table is BASIC.
LAST_DAY ( date_expression )
SELECT * FROM orders WHERE LAST_DAY (order_date) + 1 = '08/01/2003' ;
LCASE ( char_expression )
SELECT * FROM customer WHERE LCASE (last_name) = 'smith' ;
100
LEAST
Compatibility
ODBC compatible
LEAST
Returns the lowest value among the values of the given expressions.
Syntax
Example This example illustrates the LEAST function:
Notes • The first argument to the function can be of any type. However, the types of the subsequent arguments must be compatible with that of the first argument.
• The type of the result is the same as that of the first argument.
• If any of the argument expressions evaluate to NULL, the result is NULL.
• When the data type of an expression is either CHARACTER(length) or VARCHAR(length), the expression can contain multi-byte characters. The sort weight for each character is determined by the collation table in the database.
Compatibility
Progress extension
LEFT
Returns the leftmost count of characters of string_exp.
Syntax
Example The following example shows how to use the LEFT function:
LEAST ( expression , expression, ... )
SELECT cust_no, last_name, LEAST (ADD_MONTHS (start_date, 10), SYSDATE) FROM customer ;
LEFT ( string_exp , count )
SELECT LEFT(last_name,4) FROM customer WHERE last_name = 'Goldman'; LEFT(LAST_NAME),4)------------------Gold 1 record selected
101
LENGTH
Notes • string_exp can be fixed-length or variable-length CHARACTER data types.
• count can be INTEGER, SMALLINT, or TINYINT data types.
• If any of the arguments of the expression evaluate to NULL, the result is NULL.
• If the count is negative, the result evaluates to NULL.
• The string_exp and the result can contain multi-byte characters. The function returns the number of characters.
Compatibility
ODBC compatible
LENGTH
Returns the string length of the value of the given character expression.
Syntax
Example This example illustrates the LENGTH function:
Notes • The argument to the function must be of type CHARACTER or VARCHAR.
• The result is of type INTEGER.
• If the argument expression evaluates to NULL, the result is NULL.
• char_expression can contain multi-byte characters. The function returns a number of characters.
Compatibility
ODBC compatible
LOCATE
Returns the location of the first occurrence of char_expr1 in char_expr2. If the function includes the optional integer argument start_pos, LOCATE begins searching char_expr2 at that position. If the function omits the start_pos argument, LOCATE begins its search at the beginning of char_expr2.
LENGTH ( char_expression )
SELECT last_name 'LONG LAST_NAME' FROM customer WHERE LENGTH (last_name) > 5 ;
102
LOG10
LOCATE denotes the first character position of a character expression as 1. If the search fails, LOCATE returns 0. If either character expression is NULL, LOCATE returns a NULL value.
Syntax
Example In the following example, which uses two string literals as character expressions, LOCATE returns a value of 6:
Note char_expr1 and char_expr2 can contain multi-byte characters. The start_pos argument specifies the position of a starting character, not a byte position. The search is case sensitive. Character comparisons use the collation table in the database.
Compatibility
ODBC compatible
LOG10
Returns the base 10 logarithm of expression.
Syntax
Example This example illustrates the LOG10 function:
Note The expression must evaluate to an approximate numeric data type.
Compatibility
ODBC compatible
LOWER
Returns the result of the argument char_expression after converting all the characters to lowercase.
LOCATE( char_expr1 , char_expr2 , [ start_pos ] )
SELECT LOCATE('this', 'test this test', 1) FROM TEST; LOCATE(THIS,------------ 61 record selected
LOG10 ( expression )
SELECT LOG10 (100) 'Log base 10 of 100' FROM SYSPROGRESS.SYSCALCTABLE;
103
LPAD
Syntax
Example This example illustrates the LOWER function:
Notes • The argument to the function must be of type CHARACTER.
• The result is of type CHARACTER.
• If the argument expression evaluates to NULL, the result is NULL.
Compatibility
SQL compatible
LPAD
Pads the character string corresponding to the first argument on the left with the character string corresponding to the third argument. After the padding, the length of the result is length.
Syntax
Example This example illustrates two ways to use the LPAD function:
Notes • The first argument to the function must be of type CHARACTER. The second argument to the function must be of type INTEGER. The third argument, if specified, must be of type CHARACTER. If the third argument is not specified, the default value is a string of length 1 containing one blank.
• If L1 is the length of the first argument and L2 is the value of the second argument:
– If L1 is less than L2, the number of characters padded is equal to L2 minus L1.
– If L1 is equal to L2, no characters are padded and the result string is the same as the first argument.
– If L1 is greater than L2, the result string is equal to the first argument truncated to the first L2 characters.
• The result is of type CHARACTER.
LOWER ( char_expression )
SELECT * FROM customer WHERE LOWER (last_name) = 'smith' ;
LPAD ( char_expression , length [ , pad_expression ] )
SELECT LPAD (last_name, 30) FROM customer ; SELECT LPAD (last_name, 30, '.') FROM customer ;
104
LTRIM
• If the argument expression evaluates to NULL, the result is NULL.
• The char_expression and pad_expression can contain multi-byte characters. The length specifies a number of characters.
Compatibility
Progress extension
LTRIM
Removes all the leading characters in char_expression that are present in char_set and returns the resulting string. The first character in the result is guaranteed not to be in char_set. If you do not specify the char_set argument, leading blanks are removed.
Syntax
Example This example illustrates the LTRIM function:
Notes • The first argument to the function must be of type CHARACTER.
• The second argument to the function must be of type CHARACTER.
• The result is of type CHARACTER.
• If the argument expression evaluates to NULL, the result is NULL.
• The char_expression, the character set specified by char_set, and the result can contain multi-byte characters.
Compatibility
ODBC compatible
MAX
Returns the maximum value in a group of values.
Syntax
Example This example illustrates the MAX function:
LTRIM ( char_expression [ , char_set ] )
SELECT last_name, LTRIM (addr, ' ') FROM customer ;
COUNT ( { [ ALL ] expression } | { DISTINCT column_ref } | * )
105
MIN
Notes • Specifying DISTINCT has no effect on the result.
• The argument column_ref or expression can be of any type.
• The result of the function is of the same data type as that of the argument.
• The result is NULL if the result set is empty or contains only NULL values.
MIN
Returns the minimum value in a group of values.
Syntax
Example This example illustrates the MIN function:
Notes • Specifying DISTINCT has no effect on the result.
• The argument column_ref or expression can be of any type.
• The result of the function is of the same data type as that of the argument.
• The result is NULL if the result set is empty or contains only NULL values.
MINUTE
Returns the minute value in the argument as a short integer in the range of 0–59.
Syntax
Example This example illustrates the MINUTE function:
SELECT order_date, product, MAX (qty) FROM orders GROUP BY order_date, product ;
MIN ( { [ ALL ] expression } | { DISTINCT column_ref } )
SELECT MIN (salary) FROM employee WHERE deptno = 20 ;
MINUTE ( time_expression )
SELECT * FROM arrivals WHERE MINUTE (in_time) > 10 ;
106
MOD
Notes • The argument to the function must be of type TIME.
• The argument must be specified in the format HH:MI:SS.
• The result is of type SHORT.
• If the argument expression evaluates to NULL, the result is NULL.
Compatibility
ODBC compatible
MOD
Returns the remainder of expression1 divided by expression2.
Syntax
Example This example illustrates the MOD function:
Notes • Both expression1 and expression2 must evaluate to exact numeric data types.
• If expression2 evaluates to zero, MOD returns zero.
Compatibility
ODBC compatible
MONTH
Returns the month in the year specified by the argument as a short integer value in the range of 1–12.
Syntax
Example This example illustrates the MONTH function:
Notes • The argument to the function must be of type DATE.
MOD ( expression1 , expression2 )
SELECT MOD (11, 4) 'Modulus' FROM MYMATH;
MONTH ( date_expression )
SELECT * FROM orders WHERE MONTH (order_date) = 6 ;
107
MONTHNAME
• If date_expression is supplied as a time literal, it can be any of the valid date_literal formats where the day specification (DD) precedes the month specification (MM).
• The result is of type SHORT.
• If the argument expression evaluates to NULL, the result is NULL.
Compatibility
ODBC compatible
MONTHNAME
Returns a character string containing the name of the month (for example, January through December) for the month portion of date_expression. The argument date_expression can be the name of a column, the result of another scalar function, or a date or timestamp literal.
Syntax
Example In this example, which illustrates the MONTHNAME function, the query returns all rows where the name of the month in the order_date column is equal to ‘June’:
Compatibility
ODBC compatible
MONTHS_BETWEEN
Computes the number of months between two date values corresponding to the first and second arguments.
Syntax
Example This example illustrates the MONTHS_BETWEEN function:
MONTHNAME ( date_expression )
SELECT *FROM ordersWHERE order_no =346 and MONTHNAME(order_date)='JUNE'; ORDER_NO ORDER_DATE REFERENCE CUST_NO------- --------- -------- -------346 06/01/2003 87/rd 10002 1 record selected
MONTHS_BETWEEN ( date_expression, date_expression )
108
NEXT_DAY
Notes • The first and second arguments to the function must be of type DATE.
• The result is of type INTEGER.
• The result is negative if the date corresponding to the second argument is greater than that corresponding to the first argument.
• If any of the argument expressions evaluates to NULL, the result is NULL.
Compatibility
Progress extension
NEXT_DAY
Returns the minimum date that is greater than the date corresponding to the first argument where the day of the week is the same as that specified by the second argument.
Syntax
Example This example illustrates the NEXT_DAY function:
Notes • The first argument to the function must be of type DATE.
• The second argument to the function must be of type CHARACTER. The result of the second argument must be a valid day of the week (‘SUNDAY’, ‘MONDAY’ etc.).
• The result is of type DATE.
• If any of the argument expressions evaluate to NULL, the result is NULL.
Compatibility
Progress extension
NEXTVAL
NEXTVAL returns a sequence’s next value. References to NEXTVAL increment the sequence value by the defined increment and return the new value.
Use the following syntax to reference the next value of a sequence:
SELECT MONTHS_BETWEEN (SYSDATE, order_date) FROM ordersWHERE order_no = 1002 ;
NEXT_DAY ( date_expression, day_of_week )
SELECT NEXT_DAY (order_date, 'MONDAY') FROM orders ;
109
NOW
Syntax
schema
Specifies the schema that contains the sequence. To refer to the next value of a sequence in the schema of another user, you must have SELECT object privilege on the sequence.
sequence
Specifies the name of the sequence whose next value you want.A statement referencing NEXTVAL for a noncycling sequence returns an error after reaching the maximum value.
Use NEXTVAL in the:
• SELECT list of a SELECT statement not contained in a subquery or view
• SELECT list of a subquery in an INSERT statement
• VALUES clause of an INSERT statement
• SET clause of an UPDATE statement
NEXTVAL cannot be used in:
• A query of a view
• A SELECT statement with a GROUP BY clause that references a sequence
• A SELECT statement with an ORDER BY clause that references a sequence
• A SELECT statement that is combined with another SELECT statement with the UNION, INTERSECT, or MINUS set operator
• The WHERE clause of a SELECT or UPDATE statement
• The DEFAULT value of a column in a CREATE TABLE or ALTER TABLE statement
• The condition of a CHECK constraint
Example In the following example, the sequence generator increments the customer sequence and uses its value for a new customer inserted into the table pub.customer:
NOW
Returns the current date and time as a TIMESTAMP value. This function takes no arguments.
Syntax
schema.sequence.NEXTVAL
INSERT INTO pub.customer VALUES (customer_sequence.NEXTVAL,’USA’,’BackCountry Equipment’,’Sugar Hill Road’,’12A’,’Franconia’,’NH’,’03242’,’Dan Egan’,’603-762-2121’,’Kirsten Ulmner’, 10000.00, 500.00,’net 10’, 0,’contact monthly’);
NOW ( )
110
NULLIF
Compatibility
ODBC compatible
NULLIF
Returns a NULL value for expression1 if it is equal to expression2. It is useful for converting values to NULL from applications that use some other representation for missing or unknown data. The NULLIF scalar function is a type of conditional expression.
Syntax
Example This example uses the NULLIF scalar function to insert a NULL value into an address column if the host-language variable contains a single space character:
Notes • This function is not allowed in a GROUP BY clause.
• Arguments to this function cannot be query expressions.
• The NULLIF expression is shorthand notation for a common case that can also be represented in a CASE expression, as shown:
Compatibility
SQL compatible
NVL
Returns the value of the first expression if the first expression value is not NULL. If the first expression value is NULL, the value of the second expression is returned.
Syntax
Example This example illustrates the NVL function:
NULLIF ( expression1, expression2 )
INSERT INTO employee (add1) VALUES (NULLIF (:address1, ' '));
CASE WHEN expression1 = expression2 THEN NULL ELSE expression1 END
NVL ( expression , expression )
SELECT salary + NVL (comm, 0) 'TOTAL SALARY' FROM employee ;
111
PI
Notes • The NVL function is not ODBC compatible. Use the IFNULL function when ODBC-compatible syntax is required.
• The first argument to the function can be of any type.
• The type of the second argument must be compatible with that of the first argument.
• The type of the result is the same as the first argument.
Compatibility
Progress extension
PI
Returns the constant value of PI as a floating-point value.
Syntax
Example This example illustrates the PI function:
Compatibility
ODBC compatible
POWER
Returns expression1 raised to the power of expression2.
Syntax
Example This example illustrates the POWER function, raising ‘3’ to the second power:
Notes • expression1 must evaluate to a numeric data type.
• expression2 must evaluate to an exact numeric data type.
PI ( )
SELECT PI () FROM SYSPROGRESS.SYSCALCTABLE;
POWER ( expression1 , expression2 )
SELECT POWER ( 3 , 2) '3 raised to the 2nd power' FROM SYSPROGRESS.SYSCALCTABLE;
112
PREFIX
PREFIX
Returns the substring of a character string, starting from the position specified by start_pos and ending before the specified character.
Syntax
char_expression
Evaluates to a character string, typically a character-string literal or column name. If the expression evaluates to NULL, PREFIX returns NULL.
start_pos
Evaluates to an integer value. PREFIX searches the string specified in the first argument starting at that position. A value of 1 indicates the first character of the string.
char_expression
Evaluates to a single character. PREFIX returns the substring that ends before that character. If PREFIX does not find the character, it returns the substring beginning at start_pos, to the end of the string. If the expression evaluates to more than one character, PREFIX ignores all but the first character.
Example The following example shows one way to use the PREFIX function:
PREFIX ( char_expression , start_pos , char_expression )
create table prefix_table ( colstring varchar(20), colchar char(1) ); insert into prefix_table values ('string.with.dots', '.'); insert into prefix_table values ('string-with-dashes', '-'); select colstring, colchar, prefix(colstring, 1, '.') from prefix_table;
COLSTRING COLCHAR prefix(COLSTRING,1,.) --------------------- --------------------- ---------------------- string.with.dots . string string-with-dashes - string-with-dashes select colstring, colchar, prefix(colstring, 1, colchar) from prefix_table; COLSTRING COLCHAR prefix(COLSTRING,1,COLCHAR) --------------------- --------------------- ---------------------------- string.with.dots . string string-with-dashes - string select colstring, colchar, prefix(colstring, 1, 'X') from prefix_table; COLSTRING COLCHAR prefix(COLSTRING,1,X) --------------------- --------------------- ---------------------- string.with.dots . string.with.dots string-with-dashes - string-with-dashes
113
PRO_ARR_DESCAPE function
Note Each char_expression and the result can contain multi-byte characters. The start_pos argument specifies the character position, not a byte position. Character comparisons are case sensitive and are determined by sort weights in the collation table in the database.
Compatibility
Progress extension
PRO_ARR_DESCAPE function
Removes escape characters from a single element of a character array. PRO_ARR_DESCAPE scans the char_element looking for the separator character ( ; ) or an escape character ( ~ ). The function removes an escape character when it finds any of these constructs:
• Escape character followed by a separator character ( ~; )
• Escape character followed by another escape character ( ~~ )
• Escape character followed by a NULL terminator ( ~\0 )
Syntax
char_element
The character representation of an array element, without any leading or trailing separators. Must be data type NVARCHAR, VARCHAR, or CHAR.
Examples The following example returns the string 'aa;aa':
The following example returns the string 'aa~aa'. There is no change, since another special character does not follow the escape character:
This example returns the string 'aa~;aa':
Note char_element should not be the name of an array column, since the column contains true separators that would be destroyed by this function.
PRO_ARR_DESCAPE( 'char_element' ) ;
PRO_ARR_DESCAPE('aa~;aa') ;
PRO_ARR_DESCAPE('aa~aa') ;
PRO_ARR_DESCAPE('aa~;aa') ;
114
PRO_ARR_ESCAPE function
PRO_ARR_ESCAPE function
Adds required escape characters to a single element of a character array.
PRO_ARR_ESCAPE scans the char_element looking for the separator character ( ; ) or an escape character ( ~ ). The function inserts an additional escape character when it finds any of these constructs:
• Escape character followed by a separator character ( ~; )
• Escape character followed by another escape character ( ~~ )
• Escape character followed by a NULL terminator ( ~\0 )
Syntax
char_element
The character representation of an array element, without any leading or trailing separators. Must be data type NVARCHAR, or VARCHAR, or CHAR.
Examples The following example returns the string 'aa~;aa':
The following example returns the string 'aa~aa'. There is no change, since another special character does not follow the escape character:
This example returns the string 'aa~~;aa':
Notes • char_element must be data type NVARCHAR, VARCHAR, or CHAR.
• char_element must not be the name of an array column, since the column contains true separators that would be destroyed by this function.
PRO_ELEMENT function
Extracts one or more elements from an array column and returns the NVARCHAR or VARCHAR string between the specified positions, including any internal separator characters and any internal escape characters.
PRO_ARR_ESCAPE( 'char_element' ) ;
PRO_ARR_ESCAPE('aa;aa') ;
PRO_ARR_ESCAPE('aa~aa') ;
PRO_ARR_ESCAPE(’aa~;aa’) ;
115
QUARTER
Syntax
array_style_expression
A string of data type VARCHAR or CHAR, with a semicolon ( ; ) separating each element of the array.
start_position
The position in the string marking the beginning of the element PRO_ELEMENT is to extract.
end_position
The position in the string marking the end of the element to be extracted.
Examples The following example returns the string 'bb':
The next example returns the string 'aa;bb':
This example returns the string 'aa~;aa':
Notes • The array_style_expression must be data type NVARCHAR, VARCHAR, or CHAR.
• The returned string does not include the leading separator of the first element, or the trailing separator ( ; ) of the last element.
• Even if you are extracting only one element, the escape characters are included in the result.
• You must invoke PRO_ARR_DESCAPE to remove any escape characters.
QUARTER
Returns the quarter in the year specified by the argument as a short integer value in the range of 1–4.
Syntax
Example In this example, which illustrates the QUARTER function, the query requests all rows in the orders table where the order_date is in the third quarter of the year:
PRO_ELEMENT ( 'array_style_expression', start_position, end_position ) ;
PRO_ELEMENT('aa;bb;cc', 2, 2) ;
PRO_ELEMENT('aa;bb;cc', 1, 2) ;
PRO_ELEMENT('aa~;aa;bb;cc', 1, 1) ;
QUARTER ( date_expression )
116
RADIANS
Notes • The argument to the function must be of type DATE.
• If date_expression is supplied as a date literal, it can be any of the valid date_literal formats where the day specification (DD) precedes the month specification (MM).
• The result is of type SHORT.
• If the argument expression evaluates to NULL, the result is NULL.
Compatibility
ODBC compatible
RADIANS
Returns the number of radians in an angle specified in degrees by expression.
Syntax
Example This example illustrates the RADIANS function:
Notes • expression specifies an angle in degrees.
• expression must evaluate to a numeric data type.
Compatibility
ODBC compatible
RAND
Returns a randomly generated number, using expression as an optional seed value.
Syntax
Example This example illustrates the RAND function, supplying an optional seed value of ‘3’:
SELECT *FROM ordersWHERE QUARTER (order_date) = 3 ;
RADIANS ( expression )
SELECT RADIANS(180) 'Radians in 180 degrees' FROM SYSPROGRESS.SYSCALCTABLE;
RAND ( [ expression ] )
117
REPEAT
Note expression must be an INT (32-bit) data type.
Compatibility
ODBC compatible
REPEAT
Returns a character string composed of string_exp repeated count times.
Syntax
Example The following example shows how to use the REPEAT function:
Notes • The string_exp can be of the type fixed-length or variable-length CHARACTER.
• The count can be of type INTEGER, SMALLINT, or TINYINT.
• If any of the arguments of the expression evaluates to a NULL, the result is NULL.
• If the count is negative or zero, the result evaluates to NULL.
• string_exp and the result can contain multi-byte characters.
Compatibility
ODBC compatible
REPLACE
Replaces all occurrences of string_exp2 in string_exp1 with string_exp3.
Syntax
SELECT RAND(3) 'Random number using 3 as seed value' FROM MYMATH;
REPEAT ( string_exp , count )
SELECT REPEAT(fld1,3) FROM test100WHERE fld1 = 'Afghanistan'; REPEAT(FLD1,3) -----------------AfghanistanAfghanistanAfghanistan 1 record selected
REPLACE ( string_exp1 , string_exp2 , string_exp3 )
118
RIGHT
Example This example illustrates the REPLACE function, replacing the letters ‘mi’ in the last_name ‘Smith’ with the letters ‘moo’:
Notes • string_exp can be fixed-length or variable-length CHARACTER data types.
• If any of the arguments of the expression evaluates to NULL, the result is NULL.
• If the replacement string is not found in the search string, it returns the original string.
• Each occurrence of string_exp and the result can contain multi-byte characters. Character comparisons are case sensitive and are determined by sort weights in the collation table in the database.
Compatibility
ODBC compatible
RIGHT
Returns the rightmost count of characters of string_exp.
Syntax
Example This example illustrates the RIGHT function, selecting the rightmost six letters from the string ‘Afghanistan’:
Notes • The string_exp can be fixed-length or variable-length CHARACTER data types.
• The count can be INTEGER, SMALLINT, or TINYINT data types.
• If any of the arguments of the expression evaluate to NULL, the result is NULL.
• If count is negative, the result evaluates to NULL.
SELECT REPLACE ( last_name,'mi','moo' ) FROM customer WHERE last_name = 'Smith'; REPLACE(LAST_NAME,MI,MOO)-------------------------Smooth 1 record selected
RIGHT ( string_exp , count )
SELECT RIGHT(fld1,6) FROM test100 WHERE fld1 = 'Afghanistan'; RIGHT(FLD1,6) ---------------nistan 1 record selected
119
ROUND
• string_exp and the result can contain multi-byte characters. count represents the number of characters.
Compatibility
ODBC compatible
ROUND
Returns the rounded value of a numeric expression.
Syntax
Example This example illustrates four calls to the ROUND function:
In each case the num_expression is 2953861.8320. In the first call the rounding_factor is 2, in the second call the rounding_factor is -2, in the third call the rounding_factor is 0, and in the fourth call no rounding_factor is specified.
Notes • num_expression must be numeric or must be convertible to numeric.
• num_expression must be one of these supported data types:
– INTEGER
– TINYINT
– SMALLINT
– NUMBER
– FLOAT
– DOUBLE PRECISION
• If the data type of num_expression is not a supported type, ROUND returns an error message.
• The num_expression is rounded to the next higher digit when:
ROUND ( num_expression [, rounding_factor ] ) ;
-- rounding_factor 2 returns 2953861.83ROUND ( 2953861.8320, 2 ) -- rounding_factor -2 returns 2953900.00ROUND ( 2953861.8320, -2 ) -- rounding_factor 0 returns 2953862.00ROUND ( 2953861.8320, 0 ) -- No rounding_factor argument also returns 2953862.00ROUND ( 2953861.8320 )
120
ROWID
– The digit before a negative rounding_factor is 5 or greater
– The digit after a positive rounding_factor is 5 or greater
• The num_expression is rounded to the next lower digit when:
– The digit before a negative rounding_factor is 4 or less
– The digit after a positive rounding_factor is 4 or less
• rounding_factor is an integer between –32 and +32 inclusive, and indicates the digit position to which you want to round num_expression. Figure 1 illustrates how the digit positions are numbered. In the figure, the num_expression is 2953861.8320.
Figure 1: ROUND digit positions
• If you do not specify a rounding_factor, the function rounds num_expression to digit 0 (the ones place).
• To round to the right of the decimal point, specify a positive rounding_factor.
• To round to the left of the decimal, specify a negative rounding_factor.
Compatibility
Progress extension
ROWID
Returns the row identifier of the current row in a table. This function takes no arguments. The ROWID of a row is determined when the row is inserted into the table. Once assigned, the ROWID remains the same for the row until the row is deleted. At any given time, each row in a table is uniquely identified by its ROWID. Using its ROWID is the most efficient way of selecting the row.
Syntax
Example This example illustrates the ROWID function, returning all columns from the row in the customers table where the ROWID = ‘10’:
2953861 .8320
Position -2
Position 0
Position 2
ROWID
121
RPAD
Note The ROWID function returns a string of up to 19 characters in length.
Compatibility
Progress extension
RPAD
Pads the character string corresponding to the first argument on the right with the character string corresponding to the third argument. After the padding, the length of the result is equal to the value of the second argument length.
Syntax
Example This example illustrates two ways to use the RPAD function:
Notes • The first argument to the function must be of type CHARACTER. The second argument to the function must be of type INTEGER. The third argument, if specified, must be of type CHARACTER. If the third argument is not specified, the default value is a string of length 1 containing one blank.
• If L1 is the length of the first argument and L2 is the value of the second argument:
– If L1 is less than L2, the number of characters padded is equal to L2 minus L1.
– If L1 is equal to L2, no characters are padded and the result string is the same as the first argument.
– If L1 is greater than L2, the result string is equal to the first argument truncated to the first L2 characters.
• The result is of type CHARACTER.
• If the argument expression evaluates to NULL, the result is NULL.
• char_expression and pad_expression can contain multi-byte characters. length represents the number of characters in the result.
SELECT * FROM customers WHERE ROWID = '10';
RPAD ( char_expression, length [ , pad_expression ] )
SELECT RPAD (last_name, 30) FROM customer ; SELECT RPAD (last_name, 30, '.') FROM customer ;
122
RTRIM
Compatibility
Progress extension
RTRIM
Removes all the trailing characters in char_expression that are present in char_set and returns the resultant string. The last character in the result is guaranteed not to be in char_set. If you do not specify a char_set, trailing blanks are removed.
Syntax
Example This example illustrates the RTRIM function:
Notes • The first argument to the function must be of type CHARACTER.
• The second argument to the function must be of type CHARACTER.
• The result is of type CHARACTER.
• If the argument expression evaluates to NULL, the result is NULL.
• The char_expression, the character set specified by char_set, and the result can contain multi-byte characters. Character comparisons are case sensitive and are determined by the collation table in the database.
Compatibility
ODBC compatible
SECOND
Returns the seconds in the argument as a short integer value in the range of 0–59.
Syntax
Example This example illustrates the SECOND function, requesting all columns from rows in the arrivals table where the in_time column is less than or equal to ‘40’:
RTRIM ( char_expression [ , char_set ] )
SELECT RPAD ( RTRIM (addr, ' '), 30, '.') FROM customer ;
SECOND ( time_expression )
SELECT * FROM arrivals WHERE SECOND (in_time) <= 40 ;
123
SIGN
Notes • The argument to the function must be of type TIME.
• The argument must be specified in the format HH:MI:SS.
• The result is of type SHORT.
• If the argument expression evaluates to NULL, the result is NULL.
Compatibility
ODBC compatible
SIGN
Returns 1 if expression is positive, -1 if expression is negative, or zero if expression is zero.
Syntax
Example This example illustrates the SIGN function:
Note expression must evaluate to a NUMERIC data type.
Compatibility
ODBC compatible
SIN
Returns the sine of expression.
Syntax
Example This example illustrates the SIN trigonometric function:
SIGN ( expression )
SELECT SIGN(-14) 'Sign' FROM MYMATH;
SIN ( expression )
select sin(45 * pi()/180) 'Sine of 45 degrees' from MYMATH; SINE OF 45 DEGREES------------------ 0.707106781186547 1 record selected
124
SQRT
Notes • SIN takes an angle (expression) and returns the ratio of two sides of a right triangle. The ratio is the length of the side opposite the angle divided by the length of the hypotenuse.
• expression specifies an angle in radians.
• expression must evaluate to an approximate numeric data type.
• To convert degrees to radians, multiply degrees by Pi/180. To convert radians to degrees, multiply radians by 180/Pi.
Compatibility
ODBC compatible
SQRT
Returns the square root of expression.
Syntax
Example This example illustrates the SQRT function, requesting the square root of the value ‘28’:
Notes • The value of expression must be positive.
• expression must evaluate to an approximate numeric data type.
Compatibility
ODBC compatible
SUBSTR
Returns the substring of the character string corresponding to the first argument starting at start_pos and length characters long. If the third argument length is not specified, the substring starting at start_pos up to the end of char_expression is returned.
Syntax
Example This example illustrates the SUBSTR function:
SQRT ( expression )
SELECT SQRT(28) 'square root of 28' FROM MYMATH;
SUBSTR ( char_expression, start_pos [ , length ] )
125
SUBSTR
Notes • The first argument must be of type CHARACTER. It can be any meaningful character value (for example, a literal expression, database column, or parameter).
• The second argument must be of type INTEGER. It indicates the starting position from which the substring result is extracted.
• The third argument, if specified, must be of type INTEGER. It indicates the number of characters the substring function will extract.
• The values for specifying position in the character string start from 1. The first character in a string is at position 1, the second character is at position 2, and so on.
• The result is of type CHARACTER.
• If any of the argument expressions evaluate to NULL, the result is NULL.
• char_expression and the result can contain multi-byte characters.
• If the value of start_pos is:
– Smaller than 0, the function returns a “Bad argument” error
– Bigger than the actual length of the string value, the function returns an empty zero length substring
• If the value of length is:
– Smaller than 0, the function returns a “Bad argument” error.
– Bigger than the actual length of the substring (from start_pos to the end of the literal), the function returns the substring from start_pos to the end of the literal.
– Bigger than the actual length of the substring (from start_pos up to the end of the column’s row data), the function returns the substring from the start_pos to the end of the column’s row data. The function returns this, even when the substring result exceeds the column’s SQL width.
– Bigger than 0 and the column’s row data exceeds the column’s SQL width, the function returns the substring.
• If length is not specified, the function returns the substring from start_pos to the end of the literal.
Note The function returns the end of the column’s row data if the length of the substring is not bigger than the column’s SQL width. Otherwise, the function returns the substring truncated to the column’s SQL width.
Compatibility
Progress extension
SELECT last_name, '(', SUBSTR (phone, 1, 3) , ')', SUBSTR (phone, 4, 3), '-', SUBSTR (phone, 7, 4) FROM customer ;
126
SUBSTRING (ODBC compatible)
SUBSTRING (ODBC compatible)
Returns the substring of the character string corresponding to the first argument starting at start_pos and length characters long. If the third argument length is not specified, the substring starting at start_pos up to the end of char_expression is returned.
Syntax
Example This example illustrates the SUBSTRING function:
Notes • The first argument must be of type CHARACTER. It can be any meaningful character value (for example, a literal expression, database column, or parameter).
• The second argument must be of type INTEGER. It indicates the starting position from which the substring result is extracted.
• The third argument, if specified, must be of type INTEGER. It indicates the number of characters the substring function will extract.
• The values for specifying position in the character string start from 1. The first character in a string is at position 1, the second character is at position 2, and so on.
• The result is of type CHARACTER.
• If any of the argument expressions evaluate to NULL, the result is NULL.
• char_expression and the result can contain multi-byte characters.
• If the value of start_pos is:
– Smaller than 0, the function returns a “Bad argument” error
– Bigger than the actual length of the string value, the function returns an empty zero length substring
• If the value of length is:
– Smaller than 0, the function returns a “Bad argument” error.
– Bigger than the actual length of the substring (from start_pos to the end of the literal), the function returns the substring from start_pos to the end of the literal.
– Bigger than the actual length of the substring (from start_pos up to the end of the column’s row data), the function returns the substring from the start_pos to the end of the column’s row data. The function returns this, even when the substring result exceeds the column’s SQL width.
SUBSTRING ( char_expression, start_pos [ , length ] )
SELECT last_name, '(', SUBSTRING (phone, 1, 3) , ')', SUBSTRING (phone, 4, 3), '-', SUBSTRING (phone, 7, 4) FROM customer ;
127
SUFFIX
– Bigger than 0 and the column’s row data exceeds the column’s SQL width, the function returns the substring.
• If length is not specified, the function returns the substring from start_pos to the end of the literal.
• The function returns the end of the column’s row data if the length of the substring is not bigger than the column’s SQL width. Otherwise, the function returns the substring truncated to the column’s SQL width.
Compatibility
ODBC compatible
SUFFIX
Returns the substring of a character string starting after the position specified by start_pos and the second char_expression, to the end of the string.
Syntax
char_expression
Evaluates to a character string, typically a character-string literal or column name. If the expression evaluates to NULL, SUFFIX returns NULL.
start_pos
Evaluates to an integer value. SUFFIX searches the string specified in the first argument starting at that position. A value of 1 indicates the first character of the string.
char_expression
Evaluates to a single character. SUFFIX returns the substring that begins with that character. If SUFFIX does not find the character after start_pos, it returns NULL. If the expression evaluates to more than one character, SUFFIX ignores all but the first character.
Example This example illustrates two ways to use the SUFFIX function:
SUFFIX (char_expression , start_pos , char_expression )
128
SUM
Note Each char_expression and the result can contain multi-byte characters. The start_pos argument specifies the character position, not a byte position. Character comparisons are case sensitive and are determined by sort weights in the collation table in the database.
Compatibility
Progress extension
SUM
Returns the sum of the values in a group. The keyword DISTINCT specifies that the duplicate values are to be eliminated before computing the sum.
Syntax
Example This example illustrates the SUM function:
Notes • The argument column_ref or expression can be of any type.
• The result of the function is of the same data type as that of the argument except that the result is of type INTEGER when the argument is of type SMALLINT or TINYINT.
• The result can have a NULL value.
SELECT C1, C2, SUFFIX(C1, 6, '.') FROM T1;C1 C2 SUFFIX(C1,6,.-- -- ------------- test.pref . pref.test s 2 records selected SELECT C1, C2, SUFFIX(C1, 1, C2) FROM T1; C1 C2 SUFFIX(C1,1,C-- -- ------------- test.pref . pref pref.test s t 2 records selected
SUM ( { [ALL] expression } | { DISTINCT column_ref } )
SELECT SUM (amount) FROM orders WHERE order_date = SYSDATE ;
129
SYSDATE
SYSDATE
Returns the current date as a DATE value. This function takes no arguments, and the trailing parentheses are optional.
Syntax
Example This example illustrates the SYSDATE function, inserting a new row into the objects table, setting the create_date column to the value of the current date:
Compatibility
Progress extension
SYSTIME
Returns the current time as a TIME value to the nearest second. This function takes no arguments, and the trailing parentheses are optional. SQL statements can refer to SYSTIME anywhere they can refer to a TIME expression.
Syntax
Example This example illustrates the SYSTIME function, inserting a new row into the objects table, setting the create_time column to the value of the current time:
Compatibility
Progress extension
SYSTIMESTAMP
Returns the current date and time as a TIMESTAMP value. This function takes no arguments, and the trailing parentheses are optional.
Syntax
SYSDATE [ ( ) ]
INSERT INTO objects (object_owner, object_id, create_date) VALUES (USER, 1001, SYSDATE) ;
SYSTIME [ ( ) ]
INSERT INTO objects (object_owner, object_id, create_time) VALUES (USER, 1001, SYSTIME) ;
SYSTIMESTAMP [ ( ) ]
130
TAN
Example This example illustrates different formats for SYSDATE, SYSTIME, and SYSTIMESTAMP:
Compatibility
Progress extension
TAN
Returns the tangent of expression.
Syntax
Example The following example shows how to use the TAN function:
Notes • TAN takes an angle (expression) and returns the ratio of two sides of a right triangle. The ratio is the length of the side opposite the angle divided by the length of the side adjacent to the angle.
• expression specifies an angle in radians.
SELECT SYSDATE FROM test; SYSDATE-------09/13/2003 1 record selected SELECT SYSTIME FROM test; SYSTIME-------14:44:07:000 1 record selected SELECT SYSTIMESTAMP FROM test; SYSTIMESTAMP------------2003-09-13 14:44:15:000 1 record selected
TAN ( expression )
select tan(45 * pi()/180) 'Tangent of 45 degrees' from MYMATH; TANGENT OF 45 DEGREES--------------------- 1.000000000000000 1 record selected
131
TO_CHAR
• expression must evaluate to an approximate numeric data type.
• To convert degrees to radians, multiply degrees by Pi/180. To convert radians to degrees, multiply radians by 180/Pi.
Compatibility
ODBC compatible
TO_CHAR
Converts the given expression to character form and returns the result. The primary use for TO_CHAR is to format the output of date-time expressions through the format_string argument.
Syntax
expression
Converts to character form. It must evaluate to a value of the date or time data type to use the format_string.
format_string
Specifies the format of the output. SQL ignores the format string if the expression argument does not evaluate to a date or time.
Notes • The first argument to the function can be of any type.
• The second argument, if specified, must be of type CHARACTER.
• The result is of type CHARACTER.
• The format argument can be used only when the type of the first argument is DATE.
• If any of the argument expressions evaluates to NULL, the result is NULL.
Compatibility
Progress extension
TO_DATE
Converts the given date literal to a date value.
Syntax
Example This example illustrates the TO_DATE function, returning all columns from rows in the orders table where the order_date column is earlier or equal to the date ‘12/31/2003’:
TO_CHAR ( expresion [ , format_string ] )
TO_DATE ( date_literal )
132
TO_NUMBER
Notes • The result is of type DATE.
• Supply the date literal in any valid format.
Compatibility
Progress extension
TO_NUMBER
Converts the given character expression to a number value.
Syntax
Example This example illustrates the TO_NUMBER function and the SUBSTR function:
Notes • The argument to the function must be of type CHARACTER.
• The result is of type NUMERIC.
• If any of the argument expressions evaluates to NULL, the result is NULL.
Compatibility
Progress extension
TO_TIME
Converts the given time literal to a time value.
Syntax
Example The following example shows how to use the TO_DATE and the TO_TIME functions:
SELECT * FROM orders WHERE order_date <= TO_DATE ('12/31/2003') ;
TO_NUMBER ( char_expression )
SELECT *FROM customerWHERE TO_NUMBER (SUBSTR (phone, 1, 3)) = 603 ;
TO_TIME ( time_literal )
133
TO_TIMESTAMP
Notes • The result is of type TIME.
• Supply the time literal in any valid format.
Compatibility
Progress extension
TO_TIMESTAMP
Converts the given timestamp literal to a timestamp value.
Syntax
Example The following example shows how to use the TO_TIMESTAMP function:
Notes • The result is of type TIME.
• Supply the timestamp literal in any valid format.
Compatibility
Progress Extension
TRANSLATE
Translates each character in char_expression that is in from_set to the corresponding character in to_set. The translated character string is returned as the result.
Syntax
Example This example substitutes underscores for spaces in customer names:
SELECT * FROM orders WHERE order_date < TO_DATE ('05/15/2003') AND order_time < TO_TIME ('12:00:00') ;
TO_TIMESTAMP ( timestamp_lit )
SELECT * FROM DTEST WHERE C3 = TO_TIMESTAMP('4/18/03 10:41:19')
TRANSLATE ( char_expression , from_set , to_set )
134
UCASE
Notes • char_expression, from_set, and to_set can be any character expression.
• For each character in char_expression, TRANSLATE checks for the same character in from_set.
• If it is in from_set, TRANSLATE translates it to the corresponding character in to_set (if the character is the nth character in from_set, the nth character in to_set).
• If the character is not in from_set TRANSLATE does not change it.
• If from_set is longer than to_set, TRANSLATE does not change trailing characters in from_set that do not have a corresponding character in to_set.
• If either from_set or to_set is NULL, TRANSLATE does nothing.
Compatibility
Progress extension
UCASE
Returns the result of the argument character expression after converting all the characters to uppercase. UCASE is identical to UPPER, but provides ODBC-compatible syntax.
Syntax
Example This example illustrates the UCASE function, returning columns from rows in the customer table where the last_name column, after being converted to uppercase, is equal to ‘SMITH’:
Notes • The argument to the function must be of type CHARACTER.
SELECT TRANSLATE (customer_name, ' ', '_') "TRANSLATE Example" from customers; TRANSLATE EXAMPLE ----------------- Sports_Cars_Inc.__________________________________ Mighty_Bulldozer_Inc._____________________________ Ship_Shapers_Inc._________________________________ Tower_Construction_Inc.___________________________ Chemical_Construction_Inc.________________________ Aerospace_Enterprises_Inc.________________________ Medical_Enterprises_Inc.__________________________ Rail_Builders_Inc.________________________________ Luxury_Cars_Inc.__________________________________ Office_Furniture_Inc._____________________________ 10 records selected
UCASE ( char_expression )
SELECT * FROM customer WHERE UCASE (last_name) = 'SMITH' ;
135
UPPER
• The result is of type CHARACTER.
• If the argument expression evaluates to NULL, the result is NULL.
• A char_expression and the result can contain multi-byte characters. The uppercase conversion is determined by the case table in the convmap file. The default case table is BASIC.
Compatibility
ODBC compatible
UPPER
Returns the result of the argument character expression after converting all the characters to uppercase.
Syntax
Example This example illustrates the UPPER function, returning columns from rows in the customer table where the last_name column, after being converted to uppercase, is equal to ‘SMITH’:
Notes • The argument to the function must be of type CHARACTER.
• The result is of type CHARACTER.
• If the argument expression evaluates to NULL, the result is NULL.
• A char_expression and the result can contain multi-byte characters. The uppercase conversion is determined by the case table in the convmap file. The default case table is BASIC.
Compatibility
SQL compatible
USER
Returns a character-string identifier for the user of the current transaction, as determined by the host operating system. This function takes no arguments, and the trailing parentheses are optional.
UPPER ( char_expression )
SELECT * FROM customer WHERE UPPER (last_name) = 'SMITH' ;
136
WEEK
Syntax
Note SQL statements can refer to USER anywhere they can refer to a character string expression.
Compatibility
ODBC compatible
WEEK
Returns the week of the year as a short integer value in the range of 1–53.
Syntax
Example The query returns all columns from rows in the orders table where the order_date is in the fifth week of the year. This example illustrates the WEEK function:
Notes • The argument to the function must be of type DATE.
• If date_expression is supplied as a date literal, it can be any of the valid date_literal formats where the day specification (DD) precedes the month specification (MM).
• The result is of type SHORT.
• If the argument expression evaluates to NULL, the result is NULL.
Compatibility
ODBC compatible
YEAR
Returns the year as a short integer value in the range of 0–9999.
Syntax
Example The query returns all columns in rows in the orders table where the year in the order_date column is equal to ‘2003’. This example illustrates the YEAR function:
USER [ ( ) ]
WEEK ( time_expression )
SELECT *FROM ordersWHERE WEEK (order_date) = 5 ;
YEAR ( date_expression )
137
YEAR
Notes • The argument to the function must be of type DATE.
• If date_expression is supplied as a date literal, it can be any of the valid date_literal formats where the day specification (DD) precedes the month specification (MM).
• The result is of type SHORT.
• If the argument expression evaluates to NULL, the result is NULL.
Compatibility
ODBC compatible
SELECT *FROM ordersWHERE YEAR (order_date) = 2003;
138
OpenEdge SQL Reserved Words
This section provides a list of words that have special syntactic meaning to SQL and cannot be used as identifiers for constants, variables, cursors, types, tables, records, subprograms, or packages.
OpenEdge SQL reserved words
Reserved words are keywords. You can use keywords as identifiers in SQL statements only if you delimit them with double quotation marks. If you use keywords without delimiting them, the statement generates one of the following errors:
Table 1 provides a list of OpenEdge SQL reserved words.
error(-20003): Syntax errorerror(-20049): Keyword used for a name
Table 1: OpenEdge SQL reserved words (1 of 4)
ABS ACOS ADD ADD_MONTHS
AFTER ALL ALTER AND
ANY ANY_USER APPLICATION_CONTEXT
AREA
ARRAY AS ASC ASCII
ASIN ATAN ATAN2 AUDIT
AUDIT_ADMIN AUDIT_ARCHIVE AUDIT_INSERT AUDIT_READ
AVG BEFORE BETWEEN BIGINT
OpenEdge SQL reserved words
BINARY BIT BLOB BY
CALL CASCADE CASE CAST
CEILING CHAR CHARACTER CHARACTER_LENGTH
CHARTOROWID CHAR_LENGTH CHECK CHR
CLOB CLOSE CLUSTERED COALESCE
COLGROUP COLLATE COLUMN COMMIT
COMPRESS CONCAT CONNECT CONSTRAINT
CONTAINS CONVERT COS COUNT
CREATE CROSS CURDATE CURRENT
CURRENT_USER CURRVAL CURSOR CURTIME
CYCLE DATABASE DATAPAGES DATE
DAYNAME DAYOFMONTH DAYOFWEEK DAYOFYEAR
DBA DB_NAME DEC DECIMAL
DECLARE DECODE DEFAULT DEFINITION
DEGREES DELETE DESC DIFFERENCE
DISCONNECT DISTINCT DOUBLE DROP
EACH ELSE END ESCAPE
EVENT_GROUP EXCLUSIVE EXECUTE EXISTS
EXP EXTENT FETCH FILE
FLOAT FLOOR FOR FOREIGN
FROM FULL GRANT GREATEST
HASH HAVING HOUR IDENTIFIED
IFNULL IN INDEX INDEXPAGES
INDICATOR INITCAP INNER INOUT
INSERT INSTR INT INTEGER
INTERSECT INTO IS ISOLATION
JOIN KEY LAST_DAY LCASE
LEAST LEFT LENGTH LEVEL
LIKE LINK LOCATE LOCK
LOG LOG10 LONG LOWER
LPAD LTRIM LVARBINARY LVARCHAR
MAX MAXVALUE METADATA_ONLY MIN
MINUS MINUTE MINVALUE MOD
Table 1: OpenEdge SQL reserved words (2 of 4)
140
OpenEdge SQL reserved words
MODE MODIFY MONTH MONTHNAME
MONTHS_BETWEEN NATIONAL NATURAL NCHAR
NEWROW NEXTVAL NEXT_DAY NOCOMPRESS
NOCYCLE NOEXECUTE NOLOCK NOMAXVALUE
NOMINVALUE NOT NOW NOWAIT
NULL NULLIF NULLVALUE NUMBER
NUMERIC NVL OBJECT_ID ODBCINFO
ODBC_CONVERT OF OFF OLDROW
ON OPEN OPTION OR
OUT OUTER PCTFREE PI
POWER PRECISION PREFIX PRIMARY
PRIVILEGES PROCEDURE PRODEFAULT PRO_ACTIVE
PRO_ARRAY_ELEMENT PRO_ARR_DESCAPE PRO_ARR_ESCAPE PRO_ASSIGN
PRO_CAN_CREATE PRO_CAN_DELETE PRO_CAN_DUMP PRO_CAN_LOAD
PRO_CAN_READ PRO_CAN_WRITE PRO_CASE_SENSITIVE
PRO_CLIENT_FIELD_TRIGGER
PRO_CLIENT_FILE_TRIGGER
PRO_COL_LABEL PRO_CONNECT PRO_CRC
PRO_CREATE PRO_DATA_TYPE PRO_DEFAULT_INDEX PRO_DELETE
PRO_DESCRIPTION PRO_DUMP_NAME PRO_ELEMENT PRO_ENABLE_64BIT_SEQUENCES
PRO_ENABLE_LARGE_KEYS
PRO_FIND PRO_FORMAT PRO_FROZEN
PRO_HELP PRO_HIDDEN PRO_LABEL PRO_LOB_SIZE_TEXT
PRO_NAME PRO_ODBC PRO_ORDER PRO_OVERRIDEABLE
PRO_PROCNAME PRO_REPL_CREATE PRO_REPL_DELETE PRO_REPL_WRITE
PRO_SA_COL_LABEL PRO_SA_FORMAT PRO_SA_HELP PRO_SA_INITIAL
PRO_SA_LABEL PRO_SA_VALMSG PRO_SERVER PRO_SQL_WIDTH
PRO_STATUS PRO_TYPE PRO_UNIFIED_SCHEMA
PRO_VALEXP
PRO_VALMSG PRO_VIEW_AS PRO_WORD PRO_WRITE
PUBLIC QUARTER QUERY_TIMEOUT RADIANS
RAND RANGE READPAST REAL
RECID REFERENCES REFERENCING RENAME
REPEAT REPLACE RESOURCE RESTRICT
RESULT RETURN REVOKE RIGHT
Table 1: OpenEdge SQL reserved words (3 of 4)
141
OpenEdge SQL reserved words
ROLLBACK ROUND ROW ROWID
ROWIDTOCHAR ROWNUM RPAD RTRIM
SCHEMA SEARCHED_CASE SECOND SELECT
SEQUENCE SEQUENCE_CURRENT SEQUENCE_NEXT SET
SHARE SHOW SIGN SIMPLE_CASE
SIN SIZE SMALLINT SOME
SOUNDEX SPACE SQL_BIGINT SQL_BINARY
SQL_BIT SQL_CHAR SQL_DATE SQL_DECIMAL
SQL_DOUBLE SQL_FLOAT SQL_INTEGER SQL_LONGVARBINARY
SQL_LONGVARCHAR SQL_NUMERIC SQL_REAL SQL_SMALLINT
SQL_TIME SQL_TIMESTAMP SQL_TINYINT SQL_TSI_DAY
SQL_TSI_FRAC_SECOND
SQL_TSI_HOUR SQL_TSI_MINUTE SQL_TSI_MONTH
SQL_TSI_QUARTER SQL_TSI_SECOND SQL_TSI_WEEK SQL_TSI_YEAR
SQL_VARBINARY SQL_VARCHAR SQRT STATEMENT
STATISTICS STORAGE_ATTRIBUTES
STORAGE_MANAGER STORE_IN_SQLENG
SUBSTR SUBSTRING SUFFIX SUM
SUSER_NAME SYNONYM SYSDATE SYSTIME
SYSTIMESTAMP SYSTIMESTAMP_TZ SYSTIMESTAMP_UTC TABLE
TAN THEN TIME TIMESTAMP
TIMESTAMPADD TIMESTAMPDIFF TINYINT TO
TOP TO_CHAR TO_DATE TO_NUMBER
TO_TIME TO_TIMESTAMP TO_TIMESTAMP_TZ TRANSACTION
TRANSLATE TRIGGER TYPE UCASE
UID UNION UNIQUE UPDATE
UPPER USER USER_ID USER_NAME
USING VALUES VARARRAY VARBINARY
VARCHAR VARYING VIEW WAIT
WEEK WHEN WHERE WITH
WORK YEAR ZONE
Table 1: OpenEdge SQL reserved words (4 of 4)
142
OpenEdge SQL Error Messages
This section provides information on error messages generated by the various components of OpenEdge® SQL. Error message information includes:
• Error code
• SQLSTATE value
• Class condition
• Subclass message
Overview
In addition to the OpenEdge-specific error codes, error conditions have an associated SQLSTATE value. SQLSTATE is a five-character status parameter whose value indicates the condition status returned by the most recent SQL statement. The first two characters of the SQLSTATE value specify the class code and the last three characters specify the subclass code:
• Class codes of a–h and 0–4 are reserved by the SQL standard. For those class codes only, subclass codes of a–h and 0–4 are also reserved by the standard.
• Subclasses S and T and class IM are reserved by the ODBC standard.
• Class codes of i–z and 5–9 are specific to database implementations such as OpenEdge SQL. All subclass codes in those classes are implementation defined except as noted for ODBC.
Error codes, SQLSTATE values, and messages
Error codes, SQLSTATE values, and messages
Table 2 is a list of OpenEdge SQL error messages, ordered by error code number. The table shows the corresponding SQLSTATE value for each message.
Table 2: OpenEdge SQL error codes and messages (1 of 16)
Error code
SQLSTATE value Class condition Subclass message
00000 00000 Successful completion ***status okay.
100L 02000 No data **sql not found.
10002 22503 Data exception Tuple not found for the Specified TID.
10012 N0N12 Flag ETPL_SCAN_EOP.
10013 22914 Data Exception No more records to be fetched.
10100 2150b Cardinality violation Too many fields exist.
10101 70701 OpenEdge/SQL MM error No more records exist.
10102 2350i Integrity constraint Duplicate primary/index key value.
10104 M0M06 OpenEdge/SQL rss error Specified index method is not supported.
10107 N0N07 Flag EIX_SCAN_EOP flag is set.
10108 50903 OpenEdge/SQL rds error Duplicate record specified.
10301 M0901 OpenEdge/SQL rss error Table is locked and LCK_NOWAIT.
10400 22501 Data exception Invalid file size for alter log statement.
10920 22521 Data exception Already existing value specified.
11100 50901 OpenEdge/SQL rds error Invalid transaction id.
11102 50903 OpenEdge/SQL rds error TDS area specified is not found.
11103 50504 OpenEdge/SQL rds error TDS not found for binding.
11104 50505 OpenEdge/SQL rds error Transaction aborted.
11105 50506 OpenEdge/SQL rds error Transaction error.
11109 50510 OpenEdge/SQL rds error Invalid transaction handle.
11111 50912 OpenEdge/SQL rds error Invalid isolation level.
144
Error codes, SQLSTATE values, and messages
11300 M0M00 OpenEdge/SQL rss error Specified INFO type is not supported.
11301 M0M01 OpenEdge/SQL rss error Specified index type is not supported.
16001 22701 Data exception MM– No data block.
16002 70702 OpenEdge SQLMM error MM– Bad swap block.
16003 70703 OpenEdge SQLMM error MM– No cache block.
16004 22704 Data exception MM– Invalid row number.
16005 70705 OpenEdge SQL MM error MM– Invalid cache block.
16006 70706 OpenEdge SQL MM error MM– Bad swap file.
16007 70707 OpenEdge SQL MM error MM– Row too big.
16008 70708 OpenEdge SQL MM error MM– Array initialized.
16009 70709 OpenEdge SQL MM error MM– Invalid chunk number.
16010 70710 OpenEdge SQL MM error MM– Cannot create table.
16011 70711 OpenEdge SQL MM error MM– Cannot alter table.
16012 70712 OpenEdge SQL MM error MM– Cannot drop table.
16020 70713 OpenEdge SQL MM error MM– TPL ctor error.
16021 70714 OpenEdge SQL MM error MM– Insertion error.
16022 70715 OpenEdge SQL MM error MM– Deletion error.
16023 70716 OpenEdge SQL MM error MM– Updation error.
16024 70717 OpenEdge SQL MM error MM– Fetching error.
16025 70718 OpenEdge SQL MM error MM– Sorting error.
16026 70719 OpenEdge SQL MM error MM– Printing error.
16027 70720 OpenEdge SQL MM error MM– TPLSCAN ctor error.
16028 70721 OpenEdge SQL MM error MM– Scan fetching error.
16030 70722 OpenEdge SQL MM error MM– Can’t create index.
16031 70723 OpenEdge SQL MM error MM– Can’t drop index.
16032 70724 OpenEdge SQL MM error MM– IXSCAN ctor error.
16033 70725 OpenEdge SQL MM error MM– IX ctor error.
Table 2: OpenEdge SQL error codes and messages (2 of 16)
Error code
SQLSTATE value Class condition Subclass message
145
Error codes, SQLSTATE values, and messages
16034 70726 OpenEdge SQL MM error MM– IX deletion error.
16035 70727 OpenEdge SQL MM error MM– IX appending error.
16036 70728 OpenEdge SQL MM error MM– IX insertion error.
16037 70729 OpenEdge SQL MM error MM– IX scan fetching error.
16040 70730 OpenEdge SQL MM error MM– Begin transaction.
16041 70731 OpenEdge SQL MM error MM– Commit transaction.
16042 40000 Transaction rollback ***MM– Rollback transaction.
16043 70732 OpenEdge SQL MM error MM– Mark point.
16044 70733 OpenEdge SQL MM error MM– Rollback savepoint.
16045 70734 OpenEdge SQL MM error MM– Set & Get isolation.
16050 70735 OpenEdge SQL MM error MM– TID to char.
16051 70736 OpenEdge SQL MM error MM– Char to TID.
16054 70737 OpenEdge SQL MM error MM– Bad value list size to indirect sort.
20000 50501 OpenEdge SQL rds error SQL internal error.
20001 50502 OpenEdge SQL rds error Memory allocation failure.
20002 50503 OpenEdge SQL rds error Open database failed.
20003 2a504 Syntax error Syntax error.
20004 28505 Invalid auth specs User not found.
20005 22506 Data exception Table/View/Synonym not found.
20006 22507 Data exception Column not found/specified.
20007 22508 Data exception No columns in table.
20008 22509 Data exception Inconsistent types.
20009 22510 Data exception Column ambiguously specified.
20010 22511 Data exception Duplicate column specification.
20011 22512 Data exception Invalid length.
20012 22513 Data exception Invalid precision.
20013 22514 Data exception Invalid scale.
Table 2: OpenEdge SQL error codes and messages (3 of 16)
Error code
SQLSTATE value Class condition Subclass message
146
Error codes, SQLSTATE values, and messages
20014 22515 Data exception Missing input parameters.
20015 22516 Data exception Subquery returns multiple rows.
20016 22517 Data exception Null value supplied for a mandatory (not null) column.
20017 22518 Data exception Too many values specified.
20018 22519 Data exception Too few values specified.
20019 50520 OpenEdge SQL rds error Cannot modify table referred to in subquery.
20020 42521 Access rule violation Bad column specification for group by clause.
20021 42522 Access rule violation Non-group-by expression in having clause.
20022 42523 Access rule violation Non-group-by expression in select clause.
20023 42524 Access rule violation Aggregate function not allowed here.
20024 0a000 Feature not supported Sorry, operation not yet implemented.
20025 42526 Access rule violation Aggregate functions nested.
20026 50527 OpenEdge SQL rds error Too many table references.
20027 42528 Access rule violation Bad field specification in order by clause.
20028 50529 OpenEdge SQL rds error An index with the same name already exists.
20029 50530 OpenEdge SQL rds error Index referenced not found.
20030 22531 Data exception Table space with same name already exists.
20031 50532 OpenEdge SQL rds error Cluster with same name already exists.
20032 50533 OpenEdge SQL rds error No cluster with this name.
20033 22534 Data exception Table space not found.
20034 50535 OpenEdge SQL rds error Bad free <specification_name> specification.
Table 2: OpenEdge SQL error codes and messages (4 of 16)
Error code
SQLSTATE value Class condition Subclass message
147
Error codes, SQLSTATE values, and messages
20035 50536 OpenEdge SQL rds error At least column spec or null clause should be specified.
20036 07537 Dynamic sql error Not prepared.
20037 24538 Invalid cursor state Executing select statement.
20038 24539 Invalid cursor state Cursor not closed.
20039 24540 Invalid cursor state Open for nonselect statement.
20040 24541 Invalid cursor state Cursor not opened.
20041 22542 Data exception Table/View/Synonym already exists.
20042 2a543 Syntax error Distinct specified more than once in query.
20043 50544 OpenEdge SQL rds error Tuple size too high.
20044 50545 OpenEdge SQL rds error Array size too high.
20045 08546 Connection exception File does not exist or not accessible.
20046 50547 OpenEdge SQL rds error Field value not null for some tuples.
20047 42548 Access rule violation Granting to self not allowed.
20048 42549 Access rule violation Revoking for self not allowed.
20049 22550 Data exception Keyword used for a name.
20050 21551 Cardinality violation Too many fields specified.
20051 21552 Cardinality violation Too many indexes on this table.
20052 22553 Data exception Overflow error.
20053 08554 Connection exception Database not opened.
20054 08555 Connection exception Database not specified or improperly specified.
20055 08556 Connection exception Database not specified or database not started.
20056 28557 Invalid auth specs No DBA access rights.
20057 28558 Invalid auth specs No RESOURCE privileges.
20058 40559 Transaction rollback Executing SQL statement for an aborted transaction.
Table 2: OpenEdge SQL error codes and messages (5 of 16)
Error code
SQLSTATE value Class condition Subclass message
148
Error codes, SQLSTATE values, and messages
20059 22560 Data exception No files in the table space.
20060 22561 Data exception Table not empty.
20061 22562 Data exception Input parameter size too high.
20062 42563 Syntax error Full pathname not specified.
20063 50564 OpenEdge SQL rds error Duplicate file specification.
20064 08565 Connection exception Invalid attach type.
20065 26000 Invalid SQL statement name Invalid statement type.
20066 33567 Invalid SQL descriptor name
Invalid sqlda.
20067 08568 Connection exception More than one database cannot be attached locally.
20068 42569 Syntax error Bad arguments.
20069 33570 Invalid SQL descriptor name
SQLDA size not enough.
20070 33571 Invalid SQL descriptor name
SQLDA buffer length too high.
20071 42572 Access rule violation Specified operation not allowed on the view.
20072 50573 OpenEdge SQL rds error Server is not allocated.
20073 2a574 Access rule violation View query specification for view too long.
20074 2a575 Access rule violation View column list must be specified as expressions are given.
20075 21576 Cardinality violation Number of columns in column list is less than in select list.
20076 21577 Cardinality violation Number of columns in column list is more than in select list.
20077 42578 Access rule violation Check option specified for noninsertable view.
20078 42579 Access rule violation Given SQL statement is not allowed on the view.
20079 50580 OpenEdge SQL rds error More tables cannot be created.
20080 44581 Check option violation View check option violation.
Table 2: OpenEdge SQL error codes and messages (6 of 16)
Error code
SQLSTATE value Class condition Subclass message
149
Error codes, SQLSTATE values, and messages
20081 22582 Data exception Number of expressions projected on either side of set-op do not match.
20082 42583 Access rule violation Column names not allowed in order by clause for this statement.
20083 42584 Access rule violation Outerjoin specified on a complex predicate.
20084 42585 Access rule violation Outerjoin specified on a sub-query.
20085 42586 Access rule violation Invalid Outerjoin specification.
20086 42587 Access rule violation Duplicate table constraint specification.
20087 21588 Cardinality violation Column count mismatch.
20088 28589 Invalid auth specs Invalid user name.
20089 22590 Data exception System date retrieval failed.
20090 42591 Access rule violation Table column list must be specified as expressions are given.
20091 2a592 Access rule violation Query statement too long.
20092 2d593 Invalid transaction termination
No tuples selected by the subquery for update.
20093 22594 Data exception Synonym already exists.
20094 hz595 Remote database access Database link with same name already exists.
20095 hz596 Remote database access Database link not found.
20096 08597 Connection exception Connect String not specified/incorrect.
20097 hz598 Remote database access Specified operation not allowed on a remote table.
20098 22599 Data exception More than one row selected by the query.
20099 24000 Invalid cursor state Cursor not positioned on a valid row.
20100 4250a Access rule violation Subquery not allowed here.
20101 2350b Integrity constraint No references for the table.
Table 2: OpenEdge SQL error codes and messages (7 of 16)
Error code
SQLSTATE value Class condition Subclass message
150
Error codes, SQLSTATE values, and messages
20102 2350c Integrity constraint Primary/Candidate key column defined null.
20103 2350d Integrity constraint No matching key defined for the referenced table.
20104 2350e Integrity constraint Keys in reference constraint incompatible.
20105 5050f OpenEdge SQL rds error Not allowed in read only isolation level.
20106 2150g Cardinality violation Invalid ROWID.
20107 hz50h Remote database access Remote database not started.
20108 0850i Connection exception Remote Network Server not started.
20109 hz50j Remote database access Remote database name not valid.
20110 0850k Connection exception TCP/IP Remote HostName is unknown.
20114 33002 Invalid SQL descriptor name
Fetched Value NULL & indicator var not defined.
20115 5050l OpenEdge SQL rds error References to the table/record present.
20116 2350m Integrity constraint Constraint violation.
20117 2350n Integrity constraint Table definition not complete.
20118 4250o Access rule violation Duplicate constraint name.
20119 2350p Integrity constraint Constraint name not found.
20120 22000 Data exception **Use of reserved word.
20121 5050q OpenEdge SQL rds error Permission denied.
20122 5050r OpenEdge SQL rds error Procedure not found.
20123 5050s OpenEdge SQL rds error Invalid arguments to procedure.
20124 5050t OpenEdge SQL rds error Query conditionally terminated.
20125 0750u Dynamic sql-error Number of open cursors exceeds limit.
20126 34000 Invalid cursor name ***Invalid cursor name.
20127 07001 Dynamic sql-error Bad parameter specification for the statement.
Table 2: OpenEdge SQL error codes and messages (8 of 16)
Error code
SQLSTATE value Class condition Subclass message
151
Error codes, SQLSTATE values, and messages
20128 2250x Data Exception Numeric value out of range.
20129 2250y Data Exception Data truncated.
20132 5050u OpenEdge SQL rds error Revoke failed because of restrict.
20134 5050v OpenEdge SQL rds error Invalid long data type column references.
20135 5050x OpenEdge SQL rds error Contains operator is not supported in this context.
20135 m0m01 OpenEdge SQL diagnostics error
Diagnostics statement failed.
20136 5050z OpenEdge SQL rds error Contains operator is not supported for this datatype.
20137 50514 OpenEdge SQL rds error Index is not defined or does not support CONTAINS.
20138 50513 OpenEdge SQL rds error Index on long fields requires that it can push down only CONTAINS.
20140 50512 OpenEdge SQL rds error Procedure already exists.
20141 85001 OpenEdge SQL Stored procedure Compilation
Error in stored procedure compilation.
20142 86001 OpenEdge SQL Stored procedure Execution
Error in Stored Procedure Execution.
20143 86002 OpenEdge SQL Stored procedure Execution
Too many recursions in call procedure.
20144 86003 OpenEdge SQL Stored procedure Execution
Null value fetched.
20145 86004 OpenEdge SQL Stored procedure Execution
Invalid field reference.
20146 86005 OpenEdge SQL Triggers Trigger with this name already exists.
20147 86006 OpenEdge SQL Triggers Trigger with this name does not exist.
20148 86007 OpenEdge SQL Triggers Trigger Execution Failed.
20152 22001 Data exception Character string is too long.
20170 22P0 Data exception An invalid reference to a sequence was used.
Table 2: OpenEdge SQL error codes and messages (9 of 16)
Error code
SQLSTATE value Class condition Subclass message
152
Error codes, SQLSTATE values, and messages
20172 22565 Data exception Sequence already exists in current schema.
20173 0ALLV Feature not supported LIKE predicate for long data type uses unsupported feature.
20174 86010 OpenEdge SQL Triggers Invalid colnum number specified for Trigger OLDROW/NEWROW getValue/setValue method.
20175 86011 OpenEdge SQL Triggers Incompatible data type specified for Trigger OLDROW/NEWROW getValue/setValue method.
20176 85001 OpenEdge SQL Stored proc/Trigger
IO error while compiling stored procedure/trigger.
20178 OaC01 Feature not supported Cannot rename table/column with check constraint.
20180 22915 Data exception Long data exceeds column width.
20181 22916 Data exception Long data exceeds maximum size of data that can be selected.
20211 22800 Data exception Remote procedure call error.
20212 08801 Connection exception SQL client bind to daemon failed.
20213 08802 Connection exception SQL client bind to SQL server failed.
20214 08803 Connection exception SQL NETWORK service entry is not available.
20215 08804 Connection exception Invalid TCP/IP hostname.
20216 hz805 Remote database access Invalid remote database name.
20217 08806 Connection exception Network error on server.
20218 08807 Connection exception Invalid protocol.
20219 2e000 Invalid connection name ***Invalid connection name.
20220 08809 Connection exception Duplicate connection name.
20221 08810 Connection exception No active connection.
20222 08811 Connection exception No environment defined database.
20223 08812 Connection exception Multiple local connections.
20224 08813 Connection exception Invalid protocol in connect_string.
Table 2: OpenEdge SQL error codes and messages (10 of 16)
Error code
SQLSTATE value Class condition Subclass message
153
Error codes, SQLSTATE values, and messages
20225 08814 Connection exception Exceeding permissible number of connections.
20226 80815 OpenEdge SQL snw error Bad database handle.
20227 08816 Connection exception Invalid host name in connect string.
20228 28817 Invalid auth specs Access denied (Authorization failed).
20229 22818 Data exception Invalid date value.
20230 22819 Data exception Invalid date string.
20231 22820 Data exception Invalid number strings.
20232 22821 Data exception Invalid number string.
20233 22822 Data exception Invalid time value.
20234 22523 Data exception Invalid time string.
20235 22007 Data exception Invalid time stamp string.
20236 22012 Data exception Division by zero attempted.
20238 22615 Data exception Error in format type.
20239 2c000 Invalid character set name Invalid character set name specified.
20240 5050y OpenEdge SQL rds error Invalid collation name specified.
20241 08815 Connection exception Service in use.
20300 90901 DBS error Column group column does not exist.
20301 90902 DBS error Column group column already specified.
20302 90903 DBS error Column group name already specified.
20303 90904 DBS error Column groups have not covered all columns.
20304 90905 DBS error Column groups are not implemented in Progress storage.
23000 22563 OpenEdge SQL Data exception
Table create returned invalid table id.
Table 2: OpenEdge SQL error codes and messages (11 of 16)
Error code
SQLSTATE value Class condition Subclass message
154
Error codes, SQLSTATE values, and messages
23001 22564 OpenEdge SQL Data exception
Index create returned invalid index id.
25128 j0j28 OpenEdge SQL odbc trans layer
Query terminated as max row limit exceeded for a remote table.
25131 j0j29 OpenEdge SQL odbc trans layer
Unable to read column info from remote table.
30001 5050w OpenEdge SQL rds error Query aborted on user request.
30002 k0k02 OpenEdge SQL network interface
Invalid network handle.
30003 k0k03 OpenEdge SQL network interface
Invalid sqlnetwork INTERFACE.
30004 k0k04 OpenEdge SQL network interface
Invalid sqlnetwork INTERFACE procedure.
30005 k0k05 OpenEdge SQL network interface
INTERFACE is already attached.
30006 k0k06 OpenEdge SQL network interface
INTERFACE entry not found.
30007 k0k07 OpenEdge SQL network interface
INTERFACE is already registered.
30008 k0k08 OpenEdge SQL network interface
Mismatch in pkt header size and total argument size.
30009 k0k09 OpenEdge SQL network interface
Invalid server id.
30010 k0k10 OpenEdge SQL network interface
Reply does not match the request.
30011 k0k02 OpenEdge SQL network interface
Memory allocation failure.
30031 k0k11 OpenEdge SQL network interface
Error in transmission of packet.
30032 k0k12 OpenEdge SQL network interface
Error in reception of packet.
30033 k0k13 OpenEdge SQL network interface
No packet received.
30034 k0k14 OpenEdge SQL network interface
Connection reset.
30051 k0k15 OpenEdge SQL network interface
Network handle is inprocess handle.
Table 2: OpenEdge SQL error codes and messages (12 of 16)
Error code
SQLSTATE value Class condition Subclass message
155
Error codes, SQLSTATE values, and messages
30061 k0k16 OpenEdge SQL network interface
Could not connect to sql network daemon.
30062 k0k17 OpenEdge SQL network interface
Error in number of arguments.
30063 k0k18 OpenEdge SQL network interface
Requested INTERFACE not registered.
30064 k0k19 OpenEdge SQL network interface
Invalid INTERFACE procedure id.
30065 k0k20 OpenEdge SQL network interface
Requested server executable not found.
30066 k0k21 OpenEdge SQL network interface
Invalid configuration information.
30067 k0k22 OpenEdge SQL network interface
INTERFACE not supported.
30091 k0k23 OpenEdge SQL network interface
Invalid service name.
30092 k0k24 OpenEdge SQL network interface
Invalid host.
30093 k0k25 OpenEdge SQL network interface
Error in tcp/ip accept call.
30094 k0k26 OpenEdge SQL network interface
Error in tcp/ip connect call.
30095 k0k27 OpenEdge SQL network interface
Error in tcp/ip bind call.
30096 k0k28 OpenEdge SQL network interface
Error in creating socket.
30097 k0k29 OpenEdge SQL network interface
Error in setting socket option.
30101 k0k30 OpenEdge SQL network interface
Interrupt occurred.
40001 L0L01 OpenEdge SQL env error Error in reading configuration.
210001 08P00 Connection exception Failure to acquire share schema lock during connect.
210002 08004 Connection exception Failure in finding DLC environment variable.
Table 2: OpenEdge SQL error codes and messages (13 of 16)
Error code
SQLSTATE value Class condition Subclass message
156
Error codes, SQLSTATE values, and messages
210003 08004 Connection exception DLC environment variable exceeds maximum size <max_size> -> <DLC path>.
210004 08004 Connection exception Error opening convmap.cp file <filename> <path>.
210005 P1000 Unavailable resource Failure getting lock table on table <table_name>.
210011 08004 Internal error Fatal error identifying database log in SQL.
210012 22P00 Data exception Column <column_name> in table <table_name> has value exceeding its max length or precision.
210013 08004 Connection exception Unable to complete server connection. <function_name>; reason <summary_of_reason>.
210014 22P01 Data exception Column values too big to make key. Table <table_name>; index <index_name>.
210015 P1000 Unavailable resource Failure getting record lock on a record table <table_name>.
210016 P1001 Unavailable resource Lock table is full.
210017 P1002 Unavailable resource Failure to acquire exclusive schema lock for DDL operation.
210018 0AP01 Unsupported feature Update of word indexes not yet supported. Table <table_name>, index <index_name>.
210019 0A000 Unsupported feature Scan of word indexes not yet supported. Table <table_name>, index <index_name>.
210020 0AP03 Unsupported feature The first index created for a table may not be dropped.
210021 85001 Progress/SQL stored procedure compilation
Location of the Java compiler was not specified.
210044 86008 OpenEdge stored procedure execution
Need to recompile stored procedures (run scriptSQLConvertSPTP - refer to release notes).
210045 86009 OpenEdge SQL triggers Need to recompile triggers (run script SQLConvertSPTP - refer to release notes).
Table 2: OpenEdge SQL error codes and messages (14 of 16)
Error code
SQLSTATE value Class condition Subclass message
157
Error codes, SQLSTATE values, and messages
210047 22P00 OpenEdge SQL Update Statistics
Table %s.%s at Rowid %s has column %s whose value exceeding its max length or precision.
210048 70101 Data exception Cache overflowed.
210049 22566 Data exception Unable to read sequence record.
210050 22564 Data exception The sequence was unable to cycle to another value.
210051 22563 Data exception Sequence not found.
210052 22P00 Data exception Maximum number of sequences already defined.
210054 2250z Data exception A sequence value was referenced outside of the defined range of values.
210055 42807 Access rule violation Operation not allowed on the read-only database.
210056 42700 Syntax error Syntax error at or about %s.
210057 85001 OpenEdge SQL Stored proc/Trigger
OpenEdge/SQL Java Native Interface(JNI) version not supported.
210058 85001 OpenEdge SQL Stored proc/Trigger
Error from Java compiler. Compiler messages follow.
210059 22P00 OpenEdge SQL statistics Database statistics (%s) updated for all tables.
210060 22P00 OpenEdge SQL statistics Database statistics (%s) updated for table %s.
210061 22P00 OpenEdge SQL statistics Database statistics (%s) updated by direct user SQL statement (%s).
210062 70101 OpenEdge SQL statement mgr
mgr removed a prepared, never executed statement from statement cache. %s statements currently in use (%s cache).
211013 3F001 Bad schema reference SQL cannot alter or drop a table or index created by ABL or SQL 89.
211014 3F002 Bad schema reference Incorrect view owner name on CREATE VIEW—cannot be PUB or _FOREIGN.
Table 2: OpenEdge SQL error codes and messages (15 of 16)
Error code
SQLSTATE value Class condition Subclass message
158
Error codes, SQLSTATE values, and messages
211015 3F003 Bad schema reference Database object (table, view, index, trigger, procedure, or synonym) owned by “sysprogress” cannot be created, dropped, or altered.
211016 3F004 Bad schema reference Database schema table cannot be created, dropped, or altered.
211017 3F004 Bad schema reference Attempt to insert, update, or delete a row in a schema table.
211018 0A000 Array reference error Array reference/update incorrect.
218001 P8P18 OpenEdge I18N NLS error Failure to create a NLS character set conversion handler.
219901 P0000 Internal error Internal error <error_num1> <error_meaning> in SQL from subsystem <subsystem_name> function <function_name> called from <calling_function> on <object_2> for <object_1>. Save log for Progress technical support.
219902 P0001 Internal error Failure reading schema during DDL operation.
219903 P0002 Internal error Inconsistent metadata - contact Progress technical support.
219951 40P00 Transaction rollback Fatal error <error_num> <error_meaning> in SQL from subsystem <subsystem_name> function <function_name> called from <calling_function> on <object_2> for <object_1>. Save log for Progress technical support.
Table 2: OpenEdge SQL error codes and messages (16 of 16)
Error code
SQLSTATE value Class condition Subclass message
159
Error codes, SQLSTATE values, and messages
160
OpenEdge SQL System Limits
This section provides a list of the maximum sizes for various attributes of the OpenEdge® SQL database environment, and for elements of SQL queries addressed to this environment.
OpenEdge SQL system limits
Table 3 provides a list of the maximum sizes for various attributes of the OpenEdge SQL database environment, and for elements of SQL queries addressed to this environment.
Table 3: OpenEdge SQL system limits (1 of 2)
Attribute Name Value
Maximum number of open cursors OPEN_CURSORS 50
Maximum number of procedure arguments in an SQL CALL statement
TPE_MAX_PROC_ARGS 50
Maximum length of an SQL statement
TPE_MAX_SQLSTMTLEN 131000
Maximum length of a column in a table
TPE_MAX_FLDLEN 31983
Maximum length of default value specification
TPE_MAX_DFLT_LEN 250
Maximum length of a connect string TPE_MAX_CONNLEN 100
Maximum length for a table name TPE_MAX_IDLEN 32
Maximum length for an area name TPE_MAX_AREA_NAME 32
OpenEdge SQL system limits
Maximum length for a username in a connect string
TPE_UNAME_LEN 32
Maximum length of an error message TPE_MAX_ERRLEN 256
Maximum number of columns in a table
TPE_MAX_FIELDS 5000
Maximum number of bytes that can be inserted in a large key entry
MAX_KEY_DATA_SIZE 1980
Maximum number of bytes that can be inserted in a small key entry
SMALL_KEY_DATA_SIZE 193
Maximum length of a CHECK constraint clause
SQL_MAXCHKCL_SZ 240
Maximum number of nesting levels in an SQL statement
SQL_MAXLEVELS 25
Maximum number of table references in an SQL statement: other platforms
SQL_MAXTBLREF 250
Maximum size of input parameters for an SQL statement
SQL_MAXIPARAMS_SZ 512
Maximum number of outer references in an SQL statement
SQL_MAX_OUTER_REF 25
Maximum nesting level for view references
MAX_VIEW_LEVEL 25
Maximum number of check constraints in a table
SQL_MAXCHKCNSTRS 1000 total constraints per table
Maximum number of foreign constraints in a table
SQL_MAXFRNCNSTRS 1000 total constraints per table
Maximum LOB length SQL_MAXLOB 1 GB
Table 3: OpenEdge SQL system limits (2 of 2)
Attribute Name Value
162
OpenEdge SQL System Catalog Tables
OpenEdge® SQL maintains a set of system tables for storing information about tables, columns, indexes, constraints, and privileges. This section describes those system catalog tables.
Overview of system catalog tables
OpenEdge SQL maintains a set of system tables for storing information about tables, columns, indexes, constraints, and privileges.
All users have read access to the system catalog tables. SQL Data Definition Language (DDL) statements and GRANT and REVOKE statements modify system catalog tables. The system tables are modified in response to these statements, as the database evolves and changes.
The owner of the system tables is sysprogress. If you connect to a OpenEdge SQL environment with a username other than sysprogress, you must use the owner qualifier when you reference a system table in a SQL query. Alternatively, you can issue a SET SCHEMA sysprogress statement to set the default username for unqualified table names to sysprogress.
Core tables store information on the tables, columns, and indexes that make up the database. The remaining tables contain detailed information on database objects and statistical information.
Table 4 lists the system catalog tables in the same order that they are presented in following sections.
Overview of system catalog tables
Table 4: System tables and descriptions (1 of 2)
System table Summary description
SYSTABLES Core system table; one row for each TABLE in the database
SYSCOLUMNS Core system table; one row for each COLUMN of each table in the database
SYSINDEXES Core system table. One row for each component of each INDEX in the database
SYSCALCTABLE A single row with a single column set to the value 100
SYSNCHARSTAT One row for each CHARACTER column in the database
SYSCOLAUTH One row for each column for each user holding privileges on the column
SYSCOLSTAT Provides statistical information on data distribution
SYSCOLUMNS_FULL Superset of information in core system table SYSCOLUMNS
SYSDATATYPES Information on supported data types
SYSDATESTAT One set of rows for each DATE column in the database
SYSDBAUTH One row for each user with database-wide privileges
SYSFLOATSTAT One set of rows for each FLOAT column in the database
SYSIDXSTAT Information on indexes in the database
SYSINTSTAT One set of rows for each INTEGER column in the database
SYSNUMSTAT One set of rows for each NUMERIC column in the database
SYSPROCBIN One row for each compiled Java stored procedure or trigger in the database
SYSPROCCOLUMNS One row for each column in the result set of a stored procedure
SYSPROCEDURES One row for each stored procedure in the database
SYSPROCTEXT One row for each Java source code for a stored procedure or trigger in the database
SYSREALSTAT One set of rows for each REAL column in the database
SYSSEQAUTH One row for each unique user/sequence combination, holding sequence privileges on a sequence of the database
SYSSEQUENCES View of OpenEdge schema table_sequence
SYSSMINTSTAT One set of rows for each SMALLINT column in the database
SYSSYNONYMS One row for each SYNONYM in the database
SYSTABAUTH One row for each unique user/table combination holding table privileges on a table in the database
164
SYSTABLES
SYSTABLES
Contains one row for each table in the database.
Table 5 provides details of the SYSTABLES table.
SYSTABLES_FULL Superset of information in core system table SYSTABLES
SYSTBLSTAT Contains statistics for user tables in the database
SYSTIMESTAT One set of rows for each TIME column in the database
SYSTINYINTSTAT One set of rows for each TINYINT column in the database
SYSTRIGCOLS One row for each column specified in each trigger in the database
SYSTRIGGER One row for each trigger in the database
SYSTSSTAT One set of rows for each TIMESTAMP column in the database
SYSTSTZSTAT One set of rows for each TIMESTAMP WITH TIME ZONE column in the database
SYSNVARCHARSTAT One set of rows for each VARCHAR column in the database
SYSVIEWS One row for each VIEW in the database
SYS_CHKCOL_USAGE One row for each CHECK CONSTRAINT defined on a column in the database
SYS_CHK_CONSTRS One row for each CHECK CONSTRAINT defined on a user table in the database
SYS_KEYCOL_USAGE One row for each column in the database defined with a PRIMARY KEY or FOREIGN KEY
SYS_REF_CONSTRS One row for each table in the database defined with a REFERENTIAL INTEGRITY CONSTRAINT
SYS_TBL_CONSTRS One row for each CONSTRAINT defined on a table in the database
Table 4: System tables and descriptions (2 of 2)
System table Summary description
Table 5: SYSTABLES core system table (1 of 2)
Column name Column data type Column size
creator VARCHAR 32
has_ccnstrs VARCHAR 1
has_fcnstrs VARCHAR 1
165
SYSCOLUMNS
SYSCOLUMNS
Contains one row for each column of every table in the database.
Table 6 provides details of the SYSCOLUMNS table.
has_pcnstrs VARCHAR 1
has_ucnstrs VARCHAR 1
id INTEGER 4
owner VARCHAR 32
rssid INTEGER 4
segid INTEGER 4
tbl VARCHAR 32
tbl_status VARCHAR 1
tbltype VARCHAR 1
Table 5: SYSTABLES core system table (2 of 2)
Column name Column data type Column size
Table 6: SYSCOLUMNS core system table
Column name Column data type Column size
charset VARCHAR 32
col VARCHAR 32
collation VARCHAR 32
coltype VARCHAR 10
dflt_value VARCHAR 250
id INTEGER 4
nullflag VARCHAR 1
owner VARCHAR 32
scale INTEGER 4
tbl VARCHAR 32
width INTEGER 4
166
SYSINDEXES
SYSINDEXES
Contains one row for each component of an index in the database. For an index with n components, there will be n rows in this table.
Table 7 provides details of the SYSINDEXES table.
SYSCALCTABLE
Contains exactly one row with a single column with a value of 100.
Table 8 provides details of the SYSCALCTABLE table.
Table 7: SYSINDEXES core system table
Column name Column data type Column size
abbreviate BIT 1
active BIT 1
creator VARCHAR 32
colname VARCHAR 32
desc VARCHAR 144
id INTEGER 4
idxcompress VARCHAR 1
idxmethod VARCHAR 2
idxname VARCHAR 32
idxorder CHARACTER 1
idxowner VARCHAR 32
idxsegid INTEGER 4
idxseq INTEGER 4
ixcol_user_misc VARCHAR 20
rssid INTEGER 4
tbl VARCHAR 32
tblowner VARCHAR 32
167
SYSNCHARSTAT
SYSNCHARSTAT
Contains a set of rows for each column in the database with data type CHAR. Used by the optimizer, each row contains a sample of values in the column.
Table 9 provides details of the SYSNCHARSTAT table.
SYSCOLAUTH
Contains one row for the update privileges held by users on individual columns of tables in the database.
Table 10 provides details of the SYSCOLAUTH table.
Table 8: SYSCALCTABLE system table
Column name Column data type Column size
fld INTEGER 4
Table 9: SYSNCHARSTAT system table
Column name Column data type Column size
colid INTEGER 4
tblid INTEGER 4
property INTEGER 4
attribute INTEGER 4
value VARCHAR 2000
Table 10: SYSCOLAUTH system table (1 of 2)
Column name Column data type Column size
col VARCHAR 32
grantee VARCHAR 32
grantor VARCHAR 32
ref VARCHAR 1
sel VARCHAR 1
tbl VARCHAR 32
168
SYSCOLSTAT
SYSCOLSTAT
Provides statistical information on data distribution for columns in tables.
Table 11 provides details of the SYSCOLSTAT table.
SYSCOLUMNS_FULL
A superset of information in the SYSCOLUMNS core system table.
Table 12 provides details of the SYSCOLUMNS_FULL table.
tblowner VARCHAR 32
upd VARCHAR 1
Table 10: SYSCOLAUTH system table (2 of 2)
Column name Column data type Column size
Table 11: SYSCOLSTAT system table
Column name Column data type Column size
colid INTEGER 4
tblid INTEGER 4
property INTEGER 4
attribute INTEGER 4
value INTEGER 4
val_ts TIMESTAMP 8
Table 12: SYSCOLUMNS_FULL system table (1 of 2)
Column name Column data type Column size
array_extent INTEGER 4
charset VARCHAR 32
col VARCHAR 32
collation VARCHAR 32
coltype VARCHAR 20
col_label VARCHAR 60
col_label_sa VARCHAR 12
169
SYSDATATYPES
SYSDATATYPES
Contains information on each data type supported by the database.
Table 13 provides details of the SYSDATATYPES table.
col_subtype INTEGER 4
description VARCHAR 144
dflt_value VARCHAR 250
dflt_value_sa VARCHAR 12
display_order INTEGER 4
field_rpos INTEGER 4
format VARCHAR 60
format_sa VARCHAR 12
help VARCHAR 126
help_sa VARCHAR 12
id VARCHAR 4
label VARCHAR 60
label_sa VARCHAR 12
nullflag CHARACTER 2
owner VARCHAR 32
scale INTEGER 4
tbl VARCHAR 32
user_misc VARCHAR 20
valexp VARCHAR 144
valmsg VARCHAR 144
valmsg_sa VARCHAR 12
view_as VARCHAR 100
width INTEGER 4
Table 12: SYSCOLUMNS_FULL system table (2 of 2)
Column name Column data type Column size
170
SYSDATESTAT
SYSDATESTAT
Contains a set of rows for each column of data type DATE. Used by the optimizer, each row contains a sample of values in the column.
Table 14 provides details of the SYSDATESTAT table.
SYSDBAUTH
Contains the database-wide privileges held by users.
Table 13: SYSDATATYPES system table
Column name Column data type Column size
autoincr SMALLINT 2
casesensitive SMALLINT 2
createparams VARCHAR 32
datatype SMALLINT 2
dhtypename VARCHAR 32
literalprefix VARCHAR 1
literalsuffix VARCHAR 1
localtypename VARCHAR 1
nullable SMALLINT 2
odbcmoney SMALLINT 2
searchable SMALLINT 2
typeprecision INTEGER 4
unsignedattr SMALLINT 2
Table 14: SYSDATESTAT system table
Column name Column data type Column size
colid INTEGER 4
tblid INTEGER 4
value DATE 4
property INTEGER 4
attribute INTEGER 4
171
SYSFLOATSTAT
Table 15 provides details of the SYSDBAUTH table.
SYSFLOATSTAT
Contains one row for each column of data type FLOAT. Used by the optimizer, each row contains a sampling of values in the column.
Table 16 provides details of the SYSFLOATSTAT table.
SYSIDXSTAT
Contains statistics for indexes in the database.
Table 17 provides details of the SYSIDXSTAT table.
Table 15: SYSDBAUTH system table
Column name Column data type Column size
dba_acc VARCHAR 1
grantee VARCHAR 32
res_acc VARCHAR 1
Table 16: SYSFLOATSTAT system table
Column name Column data type Column size
colid INTEGER 4
tblid INTEGER 4
value FLOAT 4
property INTEGER 4
attribute INTEGER 4
Table 17: SYSIDXSTAT system table (1 of 2)
Column name Column data type Column size
idxid INTEGER 4
property INTEGER 4
attribute INTEGER 4
value INTEGER 4
172
SYSINTSTAT
SYSINTSTAT
Contains one row for each column of data type INTEGER. Used by the optimizer, each row contains a sampling of values in the column.
Table 18 provides details of the SYSINTSTAT table.
SYSNUMSTAT
Contains one row for each column of data type NUMERIC. Used by the optimizer, each row contains a sampling of values in the column.
Table 19 provides details of the SYSNUMSTAT table.
val_ts TIMESTAMP 8
tblid INTEGER 4
Table 17: SYSIDXSTAT system table (2 of 2)
Column name Column data type Column size
Table 18: SYSINTSTAT system table
Column name Column data type Column size
colid INTEGER 4
tblid INTEGER 4
value INTEGER 4
property INTEGER 4
attribute INTEGER 4
Table 19: SYSNUMSTAT system table
Column name Column data type Column size
colid INTEGER 4
tblid INTEGER 4
value NUMERIC 32
property INTEGER 4
attribute INTEGER 4
173
SYSPROCBIN
SYSPROCBIN
Contains one or more rows for each stored procedure and trigger in the database. Each row contains compiled Java bytecode for its procedure or trigger.
Table 20 provides details of the SYSPROCBIN table.
SYSPROCCOLUMNS
Contains one row for each column in the result set of a stored procedure.
Table 21 provides details of the SYSPROCCOLUMNS table.
Table 20: SYSPROCBIN system table
Column name Column data type Column size
id INTEGER 4
proc_bin VARBINARY 2000
proc_type CHARACTER 2
rssid INTEGER 4
seq INTEGER 4
Table 21: SYSPROCCOLUMNS system table
Column name Column data type Column size
argtype VARCHAR 32
col VARCHAR 32
datatype VARCHAR 32
dflt_value VARCHAR 250
id INTEGER 4
nullflag CHAR 1
proc_id INTEGER 4
rssid INTEGER 4
scale INTEGER 4
width INTEGER 4
174
SYSPROCEDURES
SYSPROCEDURES
Contains one row for each stored procedure in the database.
Table 22 provides details of the SYSPROCEDURES table.
SYSPROCTEXT
Contains one or more rows for each stored procedure and trigger in the database. The row contains the Java source code for a procedure or trigger.
Table 23 provides details of the SYSPROCTEXT table.
SYSREALSTAT
Contains one row for each column of data type REAL. Used by the optimizer, each row contains a sampling of values in the column.
Table 22: SYSPROCEDURES system table
Column name Column data type Column size
creator VARCHAR 32
has_resultset CHARACTER 1
has_return_val CHARACTER 1
owner VARCHAR 32
proc_id INTEGER 4
proc_name VARCHAR 32
proc_type VARCHAR 32
rssid INTEGER 4
Table 23: SYSPROCTEXT system table
Column name Column data type Column size
id INTEGER 4
proc_text VARCHAR 2000
proc_type CHARACTER 2
rssid INTEGER 4
seq INTEGER 4
175
SYSSEQAUTH
Table 24 provides details of the SYSREALSTAT table.
SYSSEQAUTH
Contains information about sequence privileges for database users.
Table 25 provides details of the SYSSEQAUTH table.
SYSSEQUENCES
A view of the OpenEdge schema table_sequences.
Table 26 provides details of the SYSSEQUENCES table.
Table 24: SYSREALSTAT system table
Column name Column data type Column size
colid INTEGER 4
tblid INTEGER 4
value REAL 4
property INTEGER 4
attribute INTEGER 4
Table 25: SYSSEQAUTH system table
Column name Column data type Column size
grantee VARCHAR 32
grantor VARCHAR 32
ref VARCHAR 1
sel VARCHAR 1
seq-owner VARCHAR 32
seq-name VARCHAR 32
upd VARCHAR 1
176
SYSSYNONYMS
SYSSYNONYMS
Contains one row for each synonym in the database.
Table 27 provides details of the SYSSYNONYMS table.
SYSTABAUTH
Contains information about table privileges for each user in the database.
Table 26: SYSSEQUENCES system table
Column name Column data type Column size
seq-name VARCHAR 32
seq-num INTEGER 4
seq-init INTEGER 4
seq-incr INTEGER 4
seq-min INTEGER 4
seq-max INTEGER 4
cycle-ok BIT 1
seq-misc VARCHAR 208
db-recod INTEGER 4
user-misc VARCHAR 20
seq-owner VARCHAR 32
Table 27: SYSSYNONYMS system table
Column name Column data type Column size
ispublic SMALLINT 2
screator VARCHAR 32
sname VARCHAR 32
sowner VARCHAR 32
sremdb VARCHAR 32
stbl VARCHAR 32
stblowner VARCHAR 32
177
SYSTABLES_FULL
Table 28 provides details of the SYSTABAUTH table.
SYSTABLES_FULL
A superset of information in the SYSTABLES core system table.
Table 29 provides details of the SYSTABLES_FULL table.
Table 28: SYSTABAUTH system table
Column name Column data type Column size
alt VARCHAR 1
del VARCHAR 1
exe CHAR 1
grantee VARCHAR 32
grantor VARCHAR 32
ins VARCHAR 1
ndx VARCHAR 1
ref VARCHAR 1
sel VARCHAR 1
tbl VARCHAR 32
tblowner VARCHAR 32
upd VARCHAR 1
Table 29: SYSTABLES_FULL system table (1 of 2)
Column name Column data type Column size
can_dump VARCHAR 126
can_load VARCHAR 126
creator VARCHAR 32
description VARCHAR 144
dump_name VARCHAR 16
file_label VARCHAR 60
file_label_sa VARCHAR 12
frozen BIT 1
178
SYSTBLSTAT
SYSTBLSTAT
Contains statistics for tables.
Table 30 provides details of the SYSTBLSTAT table.
has_ccnstrs VARCHAR 1
has_fcnstrs VARCHAR 1
has_pcnstrs VARCHAR 1
has_ucnstrs VARCHAR 1
hidden BIT 1
id INTEGER 4
last_change INTEGER 4
owner VARCHAR 32
prime_index INTEGER 4
rssid INTEGER 4
segid INTEGER 4
tbl VARCHAR 32
tbltype VARCHAR 1
tbl_status VARCHAR 1
user_misc VARCHAR 20
valexp VARCHAR 144
valmsg VARCHAR 144
valmsg_sa VARCHAR 12
Table 29: SYSTABLES_FULL system table (2 of 2)
Column name Column data type Column size
Table 30: SYSTBLSTAT system table (1 of 2)
Column name Column data type Column size
property INTEGER 4
attribute INTEGER 4
value INTEGER 4
179
SYSTIMESTAT
SYSTIMESTAT
Contains one row for each column of data type TIME. Used by the optimizer, each row contains a sampling of values in the column.
Table 31 provides details of the SYSTIMESTAT table.
SYSTINYINTSTAT
Contains one row for each column of data type TINYINT. Used by the optimizer, each row contains a sampling of values in the column.
Table 32 provides details of the SYSTINYINTSTAT table.
val-ts TIMESTAMP 8
tblid INTEGER 4
Table 30: SYSTBLSTAT system table (2 of 2)
Column name Column data type Column size
Table 31: SYSTIMESTAT system table
Column name Column data type Column size
colid INTEGER 4
tblid INTEGER 4
value TIME 4
property INTEGER 4
attribute INTEGER 4
Table 32: SYSTINYINTSTAT system table
Column name Column data type Column size
colid INTEGER 4
tblid INTEGER 4
value TINYINT 1
property INTEGER 4
attribute INTEGER 4
180
SYSTRIGCOLS
SYSTRIGCOLS
Contains one row for each column specified in each UPDATE trigger in the database.
Table 33 provides details of the SYSTRIGCOLS table.
SYSTRIGGER
Contains one row for each trigger in the database.
Table 34 provides details of the SYSTRIGGER table.
Table 33: SYSTRIGCOLS system table
Column name Column data type Column size
colid INTEGER 4
owner VARCHAR 32
triggername VARCHAR 32
Table 34: SYSTRIGGER system table
Column name Column data type Column size
fire_4gl BIT 1
owner VARCHAR 32
refers_to_new CHAR 1
refers_to_old CHAR 1
rssid INTEGER 4
statement_or_row CHAR 1
tbl VARCHAR 32
tblowner VARCHAR 32
triggerid INTEGER 4
triggername VARCHAR 32
trigger_event VARCHAR 1
trigger_time VARCHAR 1
181
SYSTSSTAT
SYSTSSTAT
Contains one row for each column of data type TIMESTAMP. Used by the optimizer, each row contains a sampling of values in the column.
Table 35 provides details of the SYSTSSTAT table.
SYSTSTZSTAT
Contains one row for each column of data type TIMESTAMP WITH TIME ZONE. Used by the optimizer, each row contains a sampling of values in the column.
Table 36 provides details of the SYSTSTZSTAT table.
SYSNVARCHARSTAT
Contains one row for each column of data type VARCHAR. Used by the optimizer, each row contains a sampling of values in the column.
Table 37 provides details of the SYSNVARCHARSTAT table.
Table 35: SYSTSSTAT system table
Column name Column data type Column size
colid INTEGER 4
tblid INTEGER 4
value TIMESTAMP 8
property INTEGER 4
attribute INTEGER 4
Table 36: SYSTSTZSTAT system table
Column name Column data type Column size
colid INTEGER 4
tblid INTEGER 4
value TIMESTAMP WITH TIME ZONE
12
property INTEGER 4
attribute INTEGER 4
182
SYSVIEWS
SYSVIEWS
Contains one row for each VIEW in the database.
Table 38 provides details of the SYSVIEWS table.
SYS_CHKCOL_USAGE
Contains one row for each column on which a check constraint is specified.
Table 39 provides details of the SYS_CHKCOL_USAGE table.
Table 37: SYSNVARCHARSTAT system table
Column name Column data type Column size
colid INTEGER 4
tblid INTEGER 4
value VARCHAR 2000
property INTEGER 4
attribute INTEGER 4
Table 38: SYSVIEWS system table
Column name Column data type Column size
creator VARCHAR 32
owner VARCHAR 32
seq INTEGER 4
viewname VARCHAR 32
viewtext VARCHAR 2000
Table 39: SYS_CHKCOL_USAGE system table
Column name Column data type Column size
cnstrname VARCHAR 32
colname VARCHAR 32
owner VARCHAR 32
tblname VARCHAR 32
183
SYS_CHK_CONSTRS
SYS_CHK_CONSTRS
Contains one row for each CHECK CONSTRAINT specified on a user table. The chkclause column contains the content of the CHECK clause.
Table 40 provides details of the SYS_CHK_CONSTRS table.
SYS_KEYCOL_USAGE
Contains one row for each column on which a PRIMARY KEY or FOREIGN KEY is specified.
Table 41 provides details of the SYS_KEYCOL_USAGE table.
SYS_REF_CONSTRS
Contains one row for each REFERENTIAL INTEGRITY CONSTRAINT specified on a user table.
Table 42 provides details of the SYS_REF_CONSTRS table.
Table 40: SYS_CHK_CONSTRS system table
Column name Column data type Column size
chkclause VARCHAR 2000
chkseq INTEGER 4
cnstrname VARCHAR 32
owner VARCHAR 32
tblname VARCHAR 32
Table 41: SYS_KEYCOL_USAGE system table
Column name Column data type Column size
cnstrname VARCHAR 32
colname VARCHAR 32
colposition INTEGER 4
owner VARCHAR 32
tblname VARCHAR 32
184
SYS_TBL_CONSTRS
SYS_TBL_CONSTRS
Contains one row for each table constraint in the database.
Table 43 provides details of the SYS_TBL_CONSTRS table.
Table 42: SYS_REF_CONSTRS system table
Column name Column data type Column size
cnstrname VARCHAR 32
deleterule VARCHAR 1
owner VARCHAR 32
refcnstrname VARCHAR 32
refowner VARCHAR 32
reftblname VARCHAR 32
tblname VARCHAR 32
Table 43: SYS_TBL_CONSTRS system table
Column name Column data type Column size
cnstrname VARCHAR 32
cnstrtype VARCHAR 1
idxname VARCHAR 32
owner VARCHAR 32
tblname VARCHAR 32
185
SYS_TBL_CONSTRS
186
Data Type Compatibility
This section addresses compatibility issues when using the OpenEdge® SQL environment and earlier versions of the Progress® database. Specifically, it discusses mapping between Advanced Business Language (ABL) supported data types and the corresponding OpenEdge SQL data types.
Supported ABL data types and corresponding OpenEdge SQL data types
OpenEdge SQL supports many data types that do not correspond to ABL data types. Table 44 lists the ABL data types that do correspond to OpenEdge SQL data types.
Table 44: ABL and corresponding OpenEdge SQL data types
ABL data type OpenEdge SQL data type
ARRAY VARARRAY
BLOB BLOB
CHARACTER VARCHAR
CLOB CLOB
DATE DATE
DATETIME TIMESTAMP
DATETIME-TZ TIMESTAMP WITH TIME ZONE
DECIMAL DECIMAL or NUMERIC
INTEGER INTEGER
INT64 BIGINT
Supported ABL data types and corresponding OpenEdge SQL data types
Notes • All other SQL types are not compatible with ABL. In particular, OpenEdge SQL CHARACTER data is not compatible with the ABL. Use OpenEdge SQL type VARCHAR to map ABL CHARACTER data.
• Data columns created using OpenEdge SQL that have a data type not supported by ABL are not accessible through ABL applications and utilities.
• For more information about OpenEdge SQL data types, see the “OpenEdge SQL Language Elements” section on page 189.
LOGICAL BIT
RAW VARBINARY
RECID RECID
Table 44: ABL and corresponding OpenEdge SQL data types
ABL data type OpenEdge SQL data type
188
OpenEdge SQL Language Elements
This section describes Standard SQL language elements that are common to OpenEdge® SQL. The language elements described in this section include:
• OpenEdge SQL identifiers
• Number formats
• Date-time formats
• Date formats
• Time formats
• Data types
• Literals
• Relational operators
OpenEdge SQL identifiers
Identifiers are user-specified names for elements such as tables, views, and columns. The maximum length for SQL identifiers is 32 characters.
The two types of SQL identifiers are:
• Conventional identifiers
• Delimited identifiers enclosed in double quotation marks
OpenEdge SQL identifiers
Conventional identifiers
Conventional SQL identifiers must:
• Begin with an uppercase or lowercase letter
• Contain only letters (A–Z), digits (0–9), or the underscore character ( _ )
• Not be reserved words, such as CREATE or DROP
• Use ASCII characters only
SQL does not distinguish between uppercase and lowercase letters in SQL identifiers. It converts all names specified as conventional identifiers to uppercase, but statements can refer to the names in mixed case.
Example The following example illustrates the use of identifiers in a simple query statement where CustNum, Order, and OrderDate are the user-specified names of columns:
Delimited identifiers
Delimited identifiers are strings of no more than 32 ASCII characters enclosed in quotation marks ( " " ). Delimited identifiers allow you to create identifiers that are identical to keywords or that use special characters (such as #, &, or *) or a space.
Enclosing a name in quotation marks preserves the case of the name and allows it to be a reserved word or to contain special characters. Special characters are any characters other than letters, digits, or the underscore character. Subsequent references to a delimited identifier must also use quotation marks. To include a quotation mark character in a delimited identifier, precede it with another quotation mark.
The following code example uses a delimited identifier to create a table named "Dealer Table", where the space character is part of the name:
SELECT CustNum, COUNT(*) FROM Order WHERE OrderDate < TO_DATE ('3/31/2004') GROUP BY CustNum HAVING COUNT (*) > 10 ;
CREATE TABLE "Dealer Table" (name, address, city, state) AS SELECT name, address, city, state FROM customer WHERE state IN ('CA','NY', 'TX') ;
190
Number formats
Number formats
Numeric data has cultural characteristics that international applications must address. For example, numeric separators (decimal and thousands separators) and currency symbols differ across locales and regions. Therefore, OpenEdge applications provide the capability to store, manage and display data in formats that meet the needs of the international market. Table 45 defines the number formats that are supported by OpenEdge SQL.
Date-time formats
The TO_CHAR function supports the date-format and the time-format strings to control the output of date and time values. The format strings consist of keywords that SQL interprets and replaces with formatted values.
Syntax
expression
Converts to character form. It must evaluate to a value of the date or time data type to use the format_string.
Table 45: OpenEdge SQL Number Formats
Format Example Definition
$ $999 Returns a value with a leading dollar sign.
, 9,999 Returns a comma in the specified position (not a thousands separator).
. 99.99 Returns a decimal in the specified position (not a fractional indicator).
0 09999990
Displays and positions a leading or trailing zero.
9 9999 Sets the number of significant digits to be displayed. Displays the leading space if positive, leading minus if negative. Leading zeros are blank except for a zero value returning a zero for the integer part of the number.
D 99D9 Returns NLS_NUMERIC_CHARACTER in the specified position. The default D character is (.).
G 9G99 Returns NLS_NUMERIC_CHARACTER in the specified position. The default G character is (,).
L L999 Return the local currency symbol NLS_CURRENCY in the specified position.
TO_CHAR ( expresion [ , format_string ] )
191
Date formats
format_string
Specifies the format of the output. SQL ignores the format string if the expression argument does not evaluate to a date or time.
Supply the format strings, enclosed in single quotation marks, as the second argument to the function. The format strings are case sensitive. For instance, SQL replaces DAY with all uppercase letters, but follows the case of Day.
The following example illustrates the difference between how a date value displays with and without the TO_CHAR function:
Example
Date formats
A date-format string can contain any of the following format keywords along with other characters. The format keywords in the format string are replaced by corresponding values to get the result. The other characters are displayed as literals. Table 46 lists the date formats and their corresponding descriptions.
SELECT C1 FROM T2;C1 -- 09/29/1952 1 record selected SELECT TO_CHAR(C1, 'Day, Month ddth'), TO_CHAR(C2, 'HH12 a.m.') FROM T2; TO_CHAR(C1,DAY, MONTH DDTH) TO_CHAR(C2,HH12 A.M.)--------------------------- --------------------- Monday , September 29th 02 p.m. 1 record selected
Table 46: Date formats and descriptions (1 of 2)
Date format Description
CC The century as a two-digit number.
YYYY The year as a four-digit number.
YYY The last three digits of the year.
YY The last two digits of the year.
Y The last digit of the year.
Y,YYY The year as a four-digit number with a comma after the first digit.
Q The quarter of the year as a one-digit number (with values 1, 2, 3, or 4).
MM The month value as a two-digit number (in the range 01-12).
192
Date formats
Example The following example illustrates the use of the DAY, MONTH, DD, and TH format strings:
MONTH The name of the month as a string of nine characters ('JANUARY' to 'DECEMBER').
MON The first three characters of the name of the month (in the range'JAN' to 'DEC').
WW The week of the year as a two-digit number (in the range 01-53).
W The week of the month as a one-digit number (in the range 1-5).
DDD The day of the year as a three-digit number (in the range 001-366).
DD The day of the month as a two-digit number (in the range 01-31).
D The day of the week as a one-digit number (in the range 1-7, 1 for Sunday and 7 for Saturday).
DAY The day of the week as a character string of nine characters (in the range 'SUNDAY' to 'SATURDAY').
DY The day of the week as a character string of three characters (in the range 'SUN' to 'SAT').
J The Julian day (number of days since DEC 31, 1899) as an eight-digit number.
TH When added to a format keyword that results in a number, this format keyword ('TH') is replaced by the string 'ST', 'ND', 'RD', or 'TH' depending on the last digit of the number.
Table 46: Date formats and descriptions (2 of 2)
Date format Description
SELECT C1 FROM T2; C1--09/29/1952 1 record selected SELECT TO_CHAR (C1, 'Day, Month ddth'), TO_CHAR (C2, 'HH12 a.m.') FROM T2; TO_CHAR (C1,DAY, MONTH DDTH) TO_CHAR (C2,HH12 A.M.)---------------------------- ----------------------Monday, September 29th 02 p.m. 1 record selected
193
Time formats
Time formats
A time format string can contain any of the following format keywords along with other characters. The format keywords in the format string are replaced by corresponding values to get the result. The other characters are displayed as literals.
Table 47 lists the time formats and their corresponding descriptions.
Example The following example illustrates the TO_CHAR function, and the Day, Month, dd, and HH12 format strings:
Table 47: Time formats and descriptions
Time format Description
AM
PMThe string AM or PM depending on whether time corresponds to morning or afternoon
A.M.
P.M.The string A.M. or P.M. depending on whether time corresponds to morning or afternoon
HH12 The hour value as a two-digit number (in the range 00 to 11)
HH
HH24The hour value as a two-digit number (in the range 00 to 23)
MI The minute value as a two-digit number (in the range 00 to 59)
SS The seconds value as a two-digit number (in the range 00 to 59)
SSSSS The seconds from midnight as a five-digit number (in the range 00000 to 86399)
MLS The milliseconds value as a three-digit number (in the range 000 to 999)
SELECT C1 FROM T2; C1--09/29/1952 1 record selected SELECT TO_CHAR (C1, 'Day, Month ddth'), TO_CHAR (C2, 'HH12 a.m.') FROM T2; TO_CHAR (C1,DAY, MONTH DDTH) TO_CHAR (C2,HH12 A.M.)---------------------------- ----------------------Monday , September 29th 02 p.m.1 record selected
194
Data types
Data types
CREATE TABLE statements specify the data type for each column in the table they define. This section describes the data types SQL supports for table columns. All the data types can store null values. A null value indicates that the value is not known and is distinct from all non-null values.
Syntax
Example The following example illustrates the use of data types in a CREATE TABLE statement:
The OpenEdge SQL data types are:
• CHARACTER
• EXACT NUMERIC
• APPROXIMATE NUMERIC
• DATE-TIME
• BIT STRING
• ARRAY
Each data type is described in the following sections.
Character data types
Character data strings consist of a sequence of character from a defined character set, such as ASCII. A character string may have a fixed or varying length.
This is the syntax for character data types:
char_data_type | exact_numeric_data_type | approx_numeric_data_type | date_time_data_type | bit_string_data_type | array_data_type | vararray_data_type
CREATE TABLE CUSTOMERS (CUST_NUM INTEGER NOT NULL, COMPANY VARCHAR (20) NOT NULL, CUST_REP INTEGER,CREDIT_LIMIT INTEGER, PRIMARY KEY (CUST_NUM));
Syntax
{ CHARACTER | CHAR } [ ( length ) ] | { CHARACTER VARYING | CHAR VARYING | VARCHAR | LVARCHAR } [ ( length ) ]
195
Data types
CHARACTER [ ( length ) ]CHARACTER (alias CHAR) corresponds to a null-terminated character string with the length specified. Values are padded with blanks to the specified length. The default length is 1. The maximum length is 2,000 characters.
The OpenEdge SQL representation is a variable-length string. The host language representation is equivalent to a C language character string.
{ CHARACTER VARYING | CHAR VARYING | VARCHAR | LVARCHAR } [ ( length ) ]CHARACTER VARYING, CHAR VARYING, and VARCHAR corresponds to a variable-length character string with the maximum length specified. The default length is 1 character. The maximum length is 31,995 characters. LVARCHAR has a maximum length of 1,073,741,823. A CLOB is an object of data type LVARCHAR.
Notes • For data types CHARACTER( length ) and VARCHAR( length ) the value of length specifies the number of characters.
• The maximum length can be as large as 31,995. The sum of all the column lengths of a table row must not exceed 31,960.
• Due to index size limitations, only the narrower VARCHAR columns can be indexed.
Maximum length for VARCHAR
The maximum length of the VARCHAR data type depends on:
• The number of columns in a table — More columns in a table further limits the length of VARCHAR data.
• When a table was created — Tables created earlier can support longer VARCHAR data than tables created later.
National Language Support (NLS)
The VARCHAR data type has NLS. The choice of character set affects the available character count or maximum length of the data column. The limits established above assume a single–byte character set. Using a multiple–byte character set lowers the maximum character count proportionally. For example, if all the characters in a character set take 3 bytes per character, the practical maximum is 10,660 (31,982 divided by 3). If, however, you are using a variable–width character set, you will be able to hold between 10,660 and 31,982 characters, depending on the actual mix of characters you use.
Concatenation operator
Use the concatenation operator (||) to join two text strings together.
The following example provides an example of a concatenation operator used in a query:
Example
SELECT firstname || ' ' || lastname from Employee;
196
Data types
Exact numeric data types
Exact numeric data types are used to represent the exact value of a number. This is the syntax for exact numeric data types:
Syntax
TINYINT
Corresponds to an integer value in the range –128 to +127 inclusive.
SMALLINT
Corresponds to an integer value in the range of –32768 to 32767 inclusive.
INTEGER
Corresponds to an integer value in the range of –2147483648 to 2147483647 inclusive.
BIGINT
Corresponds to an integer value in the range of -9223372036854775808 to 9223372036854775807 inclusive.
NUMERIC | NUMBER [ ( precision [ , scale ] ) ]Corresponds to a number with the given precision (maximum number of digits) and scale (the number of digits to the right of the decimal point). By default, NUMERIC columns have a precision of 32 and a scale of 0. If NUMERIC columns omit the scale, the default scale is 0.
The range of values for a NUMERIC type column is -n to +n where n is the largest number that can be represented with the specified precision and scale. If a value exceeds the precision of a NUMERIC column, SQL generates an overflow error. If a value exceeds the scale of a NUMERIC column, SQL rounds the value.
NUMERIC type columns cannot specify a negative scale or specify a scale larger than the precision.
DECIMAL [ ( precision , scale ) ]Equivalent to type NUMERIC.
Approximate numeric data types
Approximate numeric data types are used to define data with a wide range of values and whose precision does not have to be exact. This is the syntax for an approximate data type:
Syntax
TINYINT | SMALLINT | INTEGER | BIGINT | NUMERIC | NUMBER [ ( precision [ , scale ] ) ] | DECIMAL [ ( precision , scale ) ]
{ REAL | DOUBLE PRECISION | FLOAT [ ( precision ) ] }
197
Data types
REAL
Corresponds to a single precision floating-point number equivalent to the C language float type.
DOUBLE PRECISION
Corresponds to a double precision floating-point number equivalent to the C language double type.
FLOAT [ ( precision ) ] Corresponds to a double precision floating-point number of the given precision, in bytes. By default, FLOAT columns have a precision of 8. The REAL data type is same as a FLOAT(4), and double-precision is the same as a FLOAT(8).
Date-time data types
Date-time data types are used to define points in time. This is the syntax for the date-time data types:
DATE
Stores a date value as three parts: year, month, and day. The ranges for the parts are:
• Year: 1 to 9999
• Month: 1 to 12
• Day: Lower limit is 1; the upper limit depends on the month and the year
TIME
Stores a time value as four parts: hours, minutes, seconds, and milliseconds. The ranges for the parts are:
• Hours: 0 to 23
• Minutes: 0 to 59
• Seconds: 0 to 59
• Milliseconds: 0 to 999
TIMESTAMP
Combines the parts of DATE and TIME
TIMESTAMP WITH TIME ZONE
Combines the elements of TIMESTAMP with a time zone offset
Syntax
DATE | TIME | TIMESTAMP |TIMESTAMP WITH TIME ZONE
198
Data types
Bit string data types
Bit string data types are used to define bit strings, which are sequences of bits having the value of either 0 or 1. This is the syntax for a bit string data type:
BIT
Corresponds to a single bit value of 0 or 1.
SQL statements can assign and compare values in BIT columns to and from columns of types CHAR, VARCHAR, BINARY, VARBINARY, TINYINT, SMALLINT, and INTEGER. However, in assignments from BINARY and VARBINARY, the value of the first four bits must be 0001 or 0000.
No arithmetic operations are allowed on BIT columns.
BINARY [ ( length ) ]Corresponds to a bit field of the specified length of bytes. The default length is 1 byte. The maximum length is 2000 bytes.
When inserting literals into binary data types, INSERT statements must use a special format to store values in BINARY columns. They can specify the binary values as a bit string, hexadecimal string, or character string. INSERT statements must enclose binary values in single-quote marks, preceded by b for a bit string and x for a hexadecimal string. Table 48 lists the specification formats for binary values.
SQL interprets a character string as the character representation of a hexadecimal string.
If the data inserted into a BINARY column is less than the length specified, SQL pads it with zeros.
BINARY data can be assigned and compared to and from columns of type BIT, CHAR, and VARBINARY. Arithmetic operations are not allowed.
VARBINARY ( length )
Corresponds to a variable-length bit field of the specified length in bytes. The default length is 1 byte. The maximum length is 31,995 bytes. The default length is 1. Due to index limitations, only the narrower VARBINARY columns can be indexed.
Syntax
BIT | BINARY | VARBINARY | LVARBINARY [ ( length ) ]
Table 48: Specification formats for binary values
Specification Format Example
Bit string b ' ' b '1010110100010000'
Hexadecimal string x ' ' x 'ad10'
Character string ' ' 'ad10'
199
Data types
LVARBINARY ( length )
Corresponds to an arbitrarily long byte array with the maximum length defined by the amount of available disk storage up to 1,073,741,823. A BLOB is an object of data type LVARBINARY.
Maximum length for VARBINARY
The maximum length of the VARBINARY data type depends on:
• The number of columns in a table — More columns in a table further limits the length of VARBINARY data.
• When a table was created — Tables created earlier can support longer VARBINARY data than tables created later.
LVARBINARY limitations
Current limitations for LVARBINARY support are as follows:
• LVARBINARY data type will only be accessible from the SQL Engine. LVARBINARY data columns added to tables created by the ABL (Advanced Business Language) are not visible to the ABL.
• LVARBINARY data columns cannot be part of an index.
• LVARBINARY data columns cannot be used for variables or as parameters in stored procedures.
• Comparison operations are not supported on LVARBINARY columns. Comparison operations between LVARBINARY columns are not supported. Comparison operations between LVARBINARY columns and columns of other data types are not supported.
• Conversion, aggregate, and scalar functions are disallowed on this data type.
• LVARBINARY does not have National Language Support (NLS).
Language support for LVARBINARY
This data type has normal column functionality except for the following exceptions:
• A column of data type LVARBINARY is not a valid column name in a CREATE INDEX statement.
• When issuing a CREATE TABLE statement, a valid data type for the column definitions is LVARBINARY. However, LVARBINARY does not allow the column constraints of PRIMARY KEY, FOREIGN KEY, UNIQUE, REFERENCES, and CHECK.
• When creating a table with a column of data type LVARBINARY, place the table in a new AREA.
• The VALUES option on the INSERT statement is not valid for the LVARBINARY data type.
• In a SELECT statement, a WHERE, GROUP BY, HAVING, or ORDER BY clause cannot use a column of data type LVARBINARY.
200
Data types
• There is no support for an UPDATE of an LVARBINARY column on a table that contains a column of data type LVARBINARY. Obtain the functionality of an UPDATE on an LVARBINARY column by using the DELETE and INSERT statements for the record.
Utility support for LVARBINARY
Use BINARY DUMP/LOAD to dump and load data that contains the LVARBINARY data type. SQLDUMP and SQLLOAD do not support tables with LVARBINARY column data.
Array data types
The ARRAY data type is a composite data value that consists of zero or more elements of a specified data type (known as the element type). VARARRAY data type allows the size of an individual element value to exceed its declared size as long as the total size of the array is smaller than the array’s SQL width.
The VARARRAY type is most compatible with the ABL array data definitions. For best compatibility with the ABL, use the VARARRAY type. The ARRAY type is less ABL compatible and more SQL standard compliant.
This is the syntax for the array data type:
data_type
The data type of the array. This is also known as the element type.
Supported data types are: BINARY, BIT, CHAR, VARCHAR, DATE, DECIMAL, DOUBLE PRECISION, FLOAT, INTEGER, NUMERIC, REAL, SMALLINT, TIME, TIMESTAMP,
TIMESTAMP_TZ, TINYINT, and VARBINARY.
[int]
An unsigned integer, indicating the array’s maximum element size.
Example In this example, table TBL is created. TBL has two columns: column C1 is an array of up to 3 elements, all of them type int and column C2 is a variable-sized array of up to 4 elements, all of them type varchar:
The size of any element in C2 can be up to 20 characters (5*4) with a total size of 20 characters.
Notes • OpenEdge SQL limits an array’s size. The array’s size must be an integer between 1 and 9999.
• Array columns and element references cannot be indexed because:
– You cannot define a UNIQUE key with columns of type ARRAY.
Syntax
data_type ARRAY[int] | VARARRAY[int]
CREATE TABLE TBL (C1 int ARRAY[3], C2 varchar(5) VARARRAY[4]);
201
Data types
– You cannot define a PRIMARY key with columns of type ARRAY.
– You cannot define a FOREIGN key with columns of type ARRAY.
• Array columns and element references cannot be used in GROUP BY clauses.
ARRAY element reference
An element reference allows you to access a specific element of an array. It operates on two arguments: the first must evaluate to an array and the second must evaluate to an integer. The integer refers to the ordinal position of the element in the array (the first element in the array is element number one, the second is element number two, and so on).
It is possible to select the array as a whole value, rather than selecting individual array elements. When the array as a whole is selected, SQL returns a VARCHAR datatype value. That value comprises all the elements, converted to character form, with elements separated from each other by a “;” delimiter.
Example In this example, the fourth element of the array column named array_column is returned:
Default value for ARRAY columns
When creating array columns, you can specify a default value.
Example Since no value is specified for array column C2 when inserting values, the default value is used. The result returned from this example would be 10;10;10:
Note The default value is applicable only at the column level. This means that if fewer values are specified when executing an insert statement, the default will not be used to fill up the rest of the array elements. Instead, NULL is used.
Assignment
When an array is assigned to an array target, the assignment is done one element at a time. Two arrays are assignable if their element’s data types are mutually assignable. This means:
• When an array is taken from SQL data to be assigned to an array target, the number of elements in the source array equals the maximum number of elements in the target array. The value of each element of the source is assigned to the corresponding element of the target.
• If the maximum number of elements in the target array is less than the number of elements in the source array, then an error is returned.
SELECT array_column[4] FROM TBL;
CREATE TABLE tbl (C1 int, C2 int ARRAY[3] default ’10’);INSERT INTO tbl (C1) VALUES (1);SELECT C2 FROM tble WHERE C1 = 1;
202
Literals
• If the maximum number of elements in the target array is greater than the number of elements in the source array, the assignment of each of the source element values to the target elements occurs and the rest of the target elements will be assigned values of NULL.
Example
Comparison
OpenEdge SQL provides two scalar comparison operators: = and <>. Two arrays are comparable if their element data types are mutually comparable. During comparison, the elements are compared pair-wise in element order. Two arrays are equal if:
• They both have the same number of elements
• Each pair of elements is equal
Two arrays are not equal if:
• They do not have the same number or elements
• At least one pair of elements is not equal
Literals
A literal, also called a constant, is a type of expression that specifies a constant value. Generally, you can specify a literal wherever SQL syntax allows an expression. Some SQL constructs allow literals but disallow other forms of expressions.
There are three types of literals:
• NUMERIC
• CHARACTER-STRING
• DATE-TIME
The following sections discuss each type of literal.
Numeric literals
A numeric literal is a string of digits that SQL interprets as a decimal number. SQL allows the string to be in a variety of formats, including scientific notation.
This is the syntax for numeric literals:
CREATE TABLE TBL (C1 int, C2 int ARRAY[3]);INSERT into TBL values (1, ’111;222;333’);UPDATE TBL SET C2 = ’777;888;999’;
203
Literals
Example The numeric strings in the following example are all valid:
Character-string literals
A character-string literal is a string of characters enclosed in single quotation marks ( ' '). To include a single quotation mark in a character-string literal, precede it with an additional single quotation mark.
The INSERT statements in the following example show embedding quotation marks in character-string literals:
A character string literal can contain multi-byte characters in the character set used by the SQL client. Only single-byte ASCII-encoded quote marks are valid in the syntax.
Date-time literals
SQL supports special formats for literals to be used in conjunction with date-time data types. Basic predicates and the VALUES clause of INSERT statements can specify date literals directly for comparison and insertion into tables. In other cases, you need to convert date literals to the appropriate date-time data type with the CAST, CONVERT, or TO_DATE scalar functions.
Enclose date-time literals in single quotation marks ( ' ' ).
Notes • All text (names of days, months, ordinal number endings) in all date-format literals must be in the English language. The default date format is American. You can explicitly request another date format by using a format string.
Syntax
[ + | - ] { [ 0-9 ] [ 0-9 ] ... }[ . [ 0-9 ] [ 0-9 ] ... ]
[ { E | e } [ + | - ][ 0-9 ] { [ 0-9 ] } ]
123123.456-123.45612.34E-04
insert into quote values('unquoted literal');insert into quote values('''single-quoted literal''');insert into quote values('"double-quoted literal"');insert into quote values('O''Hare');select * from quote; c1--unquoted literal 'single-quoted literal' "double-quoted literal" O’Hare 4 records selected
204
Literals
• Time literals are in the English language only.
Date literals
A date literal specifies a day, month, and year using any of the following formats, enclosed in single quotation marks ( ' ' ). This is the syntax for date literals:
{ d 'yyyy-mm-dd' }
A date literal enclosed in an escape clause is compatible with ODBC. Precede the literal string with an open brace ( { ) and a lowercase d. End the literal with a close brace )}). If you use the ODBC escape clause, you must specify the date using the format yyyy-mm-dd.
Note Date literals must be enclosed in single quotations, such as the case with column values in an INSERT statement.
Examples The following example illustrates how to use the date literal format with an INSERT statement:
The INSERT and SELECT statements in the following example show some of the supported formats for date literals:
Time literals
Time literals specify an hour, minute, second, and millisecond, using the following format, enclosed in single quotation marks (' ' ). This is the syntax for time literals:
Syntax
{ d ’yyyy-mm-dd’ }
INSERT INTO dtest VALUES ( { d '2004-05-07' } )
CREATE TABLE T2 (C1 DATE, C2 TIME);INSERT INTO T2 (C1) VALUES('5/7/56');INSERT INTO T2 (C1) VALUES('7/MAY/1956');INSERT INTO T2 (C1) VALUES('1956/05/07');INSERT INTO T2 (C1) VALUES({d '1956-05-07'});INSERT INTO T2 (C1) VALUES('29-SEP-1952'); SELECT C1 FROM T2; --------------c11956-05-071956-05-071956-05-071956-05-071952-09-29
Syntax
{ hh:mi:ss[:mls ] }
205
Literals
{ t 'hh:mi:ss' }
A time literal enclosed in an escape clause is compatible with ODBC. Precede the literal string with an open brace ( { ) and a lowercase t. End the literal with a close brace ( } ).
Note If you use the ODBC escape clause, you must specify the time using the format hh:mi:ss.
hh
Specifies the hour value as a two-digit number in the range 00 to 23.
mi
Specifies the minute value as a two-digit number in the range 00 to 59.
ss
Specifies the seconds value as a two-digit number in the range 00 to 59.
mls
Specifies the milliseconds value as a three-digit number in the range 000 to 999.
Examples The following example illustrates how to use the time literal format with an INSERT statement:
The INSERT statements in the following example show some of the formats SQL will and will not accept for time literals:
The SELECT statement in the following example illustrates which INSERT statements successfully inserted a row:
INSERT INTO ttest VALUES ( { t '23:22:12' } ) ;
INSERT INTO T2 (C2) VALUES('3');error(-20234): Invalid time string INSERT INTO T2 (C2) VALUES('8:30');error(-20234): Invalid time string INSERT INTO T2 (C2) VALUES('8:30:1');INSERT INTO T2 (C2) VALUES('8:30:');error(-20234): Invalid time string INSERT INTO T2 (C2) VALUES('8:30:00');INSERT INTO T2 (C2) VALUES('8:30:1:1');INSERT INTO T2 (C2) VALUES({t'8:30:1:1'});
SELECT C2 FROM T2;c2 c2--08:30:0108:30:0008:30:0108:30:01
206
Relational operators
Timestamp literals
Timestamp literals specify a date and a time separated by a space, enclosed in single quotation marks ( ' ' ). This is the syntax for timestamp literals:
{ ts 'yyyy-mm-dd hh:mi:ss' }
A timestamp literal enclosed in an escape clause is compatible with ODBC. Precede the literal string with an open brace ( { ) and a lowercase ts. End the literal with a close brace ( } ). Note that braces are part of the syntax. If you use the ODBC escape clause, you must specify the timestamp using the format yyyy-mm-dd hh:mi:ss.
date_literal
A date.
time_literal
A time literal.
Examples The following example illustrates how to INSERT a timestamp literal into a column:
The following example illustrates a timestamp literal with the ODBC escape clause:
Relational operators
Relational operators specify how SQL compares expressions in basic and quantified predicates. This is the syntax for relational operators:
Syntax
Table 49 lists the relational operators and the resulting predicates for each operator.
Syntax
{ ts 'yyyy-mm-dd hh:mi:ss' }
INSERT INTO DTEST VALUES ( { ts '1956-05-07 10:41:37'} ) ;
SELECT * FROM DTEST WHERE C1 = {ts '1985-08-10 05:41:37'} ;
= | <> | != | ^= | < | <= | > | >=
207
Relational operators
Basic Predicate
A basic predicate compares two values using a relational operator. If a basic predicate specifies a query expression, then the query expression must return a single value. Basic predicates often specify an inner join.
If the value of any expression is null or the query_expression does not return any value, then the result of the predicate is set to false. This is the syntax for a basic predicate:
Quantified Predicate
The quantified predicate compares a value with a collection of values using a relational operator. A quantified predicate has the same form as a basic predicate with the query_expression being preceded by the ALL, ANY, or SOME keyword. The result table returned by query_expression can contain only a single column.
When you specify ALL, the predicate evaluates to true if the query_expression returns no values or the specified relationship is true for all the values returned.
When you specify SOME or ANY, the predicate evaluates to true if the specified relationship is true for at least one value returned by the query_expression. There is no difference between the SOME and ANY keywords. The predicate evaluates to false if the query_expression returns no values or if the specified relationship is false for all the values returned. This is the syntax for a quantified predicate:
Table 49: Relational operators and resulting predicates
Relational operator Predicate for this relational operator
= True if the two expressions are equal.
<> | != | ^= True if the two expressions are not equal. The operators != and ^= are equivalent to <>.
< True if the first expression is less than the second expression.
<= True if the first expression is less than or equal to the second expression.
> True if the first expression is greater than the second expression.
>= True if the first expression is greater than or equal to the second expression.
Syntax
expression relop { expression | ( query_expression ) }
Syntax
expression relop { ALL | ANY | SOME } ( query_expression )
208
Relational operators
Example
BETWEEN Predicate
The BETWEEN predicate can be used to determine if a value is within a specified value range or not. The first expression specifies the lower bound of the range and the second expression specifies the upper bound of the range.
The predicate evaluates to true if the value is greater than or equal to the lower bound of the range and less than or equal to the upper bound of the range. This is the syntax for a BETWEEN predicate.
Example
NULL Predicate
The NULL predicate can be used for testing null values of database table columns. This is the syntax for a NULL predicate
Example
LIKE Predicate
The LIKE predicate searches for strings that have a certain pattern. The pattern is specified after the LIKE keyword in a string constant. The pattern can be specified by a string in which the underscore ( _ ) and percent sign ( % ) characters have special semantics.
Use the ESCAPE clause to disable the special semantics given to the characters ( _ ) and( % ). The escape character specified must precede the special characters in order to disable their special semantics. This is the syntax for a LIKE predicate:
Notes • The column_name specified in the LIKE predicate can be a column, a string constant, or an arbitrary character expression (such as SUBSTRING or LTRIM).
10 < ANY ( SELECT COUNT(*) FROM order_tbl GROUP BY custid ; )
Syntax
expression [ NOT ] BETWEEN expression AND expression
salary BETWEEN 20000.00 AND 100000.00
Syntax
column_name IS [ NOT ] NULL
contact_name IS NOT NULL
Syntax
column_name [ NOT ] LIKE string_constant [ ESCAPE escape_character ]
209
Relational operators
• The string_constant may be a string constant or a scalar function call.
• The escape_character must be a one character string constant.
• A percent sign ( % ) in the pattern matches zero or more characters of the column string.
• An underscore symbol ( _ ) in the pattern matches any single character of the column string.
• The LIKE predicate is multi-byte enabled. The string_constant and the escape_character may contain multi-byte characters, and the escape_character can be a multi-byte character. A percent sign ( % ) or an underscore ( _ ) in the string_constant can represent a multi-byte character. However, the percent sign or underscore itself must be the single-byte ASCII encoding.
Example This example illustrates three ways to use the LIKE predicate:
In the first LIKE clause, for all strings with the substring ’Computer’ the predicate evaluates to true. In the second LIKE clause, for all strings which are exactly three characters long the predicate evaluates to true. In the third LIKE clause the backslash character ( \ ) is specified as the escape character, which means that the special interpretation given to the underscore character ( _ ) is disabled. The pattern evaluates to TRUE if the item_name column has embedded underscore characters.
EXISTS Predicate
The EXISTS predicate can be used to check for the existence of specific rows. The query_expression returns rows rather than values. The predicate evaluates to true if the number of rows returned by the query_expression is nonzero. This is the syntax for an EXISTS predicate:
Example In this example, the predicate evaluates to true if the specified customer has any orders:
IN Predicate
The IN predicate can be used to compare a value with a set of values. If an IN predicate specifies a query expression, then the result table it returns can contain only a single column. This is the syntax for an IN predicate:
cust_name LIKE ’%Computer%’ cust_name LIKE ’___’ item_name LIKE ’%\_%’ ESCAPE ’\’
Syntax
EXISTS (query_expression)
EXISTS (SELECT * FROM order_tbl WHERE order_tbl.custid = ’888’ ;)
210
Relational operators
Example
OUTER JOIN Predicate
An outer join predicate specifies two tables and returns a result table that contains all the rows from one of the tables, even if there is no matching row in the other table.
Numeric arithmetic expressions
Numeric arithmetic expressions compute a value using addition, subtraction, multiplication, and division operations on numeric literals and expressions that evaluate to any numeric data type.
+ | -Unary operators.
numeric_literal
Number value.
numeric_expr
Evaluates to a numeric data type:
+ | - | * | /
Operators for addition, subtraction, multiplication, and division. SQL evaluates numeric arithmetic expressions in the following order:
• Unary plus or minus
• Expressions in parentheses
• Multiplication and division, from left to right
Syntax
expression [ NOT ] IN { (query_expression) | (constant , constant [ , ... ] ) }
address.state IN (‘MA’, ‘NH’)
Syntax
[ table_name.]column = [ table_name.]column (+) | [ table_name.]column (+) = [ table_name.]column
Syntax
[ + | - ] { numeric_literal | numeric_expr }[ { + | - | * | / } numeric_arith_expr ]
211
Relational operators
• Addition and subtraction, from left to right
Date arithmetic expressions
Date arithmetic expressions compute the difference between date-time expressions in terms of days or milliseconds. SQL supports these forms of date arithmetic:
• Addition and subtraction of integers to and from date-time expressions
• Subtraction of one date-time expression from another
date_time_expr
Returns a value of type DATE or TIME or TIMESTAMP. A single date-time expression cannot mix data types, however. All elements of the expression must be the same data type.
Date-time expressions can contain date-time literals, but they must be converted to DATE or TIME using the CAST, CONVERT, or TO_DATE functions.
int_expr
Returns an integer value. SQL interprets the integer differently depending on the data type of the date-time expression:
• For DATE expressions, integers represent days
• For TIME expressions, integers represent milliseconds
• For TIMESTAMP expressions, integers represent milliseconds
Examples The following example manipulates DATE values using date arithmetic. SQL interprets integers as days and returns date differences in units of days:
The following example manipulates TIME values using date arithmetic. SQL interprets integers as milliseconds and returns time differences in milliseconds:
Syntax
date_time_expr { + | - } int_expr | date_time_expr - date_time_expr
SELECT C1, C2, C1-C2 FROM DTESTc1 c2 c1-c2---------------------------------------1956-05-07 1952-09-29 1316 select sysdate, sysdate - 3 , sysdate - cast ('9/29/52' as date)from dtest; sysdate sysdate-3 sysdate-convert(date,9/29/52)----------------------------------------------------------1995-03-24 1995-03-21 15516
212
Relational operators
select systime, systime - 3000, systime - cast ('15:28:01' as time) from dtest; systime systime-3000 systime-convert(time,15:28:01)----------------------------------------------------------15:28:09 15:28:06 8000
213
Relational operators
214
OpenEdge SQL Elements and Statements in Backus Naur Form
This section presents OpenEdge® SQL language elements and statements in Backus Naur Form (BNF). Information on BNF elements and statements include:
• Data types syntax in BNF
• Expressions syntax in BNF
• Literals syntax in BNF
• Query Expressions syntax in BNF
• Search conditions syntax in BNF
• Statements, DDL and DML syntax in BNF
Data types syntax in BNF
Data Type
Syntax
data_type ::=char_data_type
| exact_numeric_data_type | approx_numeric_data_type | date_time_data_type | bit_string_data_type
OpenEdge SQL Elements and Statements in Backus Naur Form
Character data type
Exact numeric data type
Approximate numeric data type
Date-time data type
Bit string data type
Syntax
char_data_type ::=
{ CHARACTER | CHAR } [ ( length ) ] | { CHARACTER VARYING | CHAR VARYING | CLOB | VARCHAR } [ (length) ]
Syntax
exact_numeric_data_type ::=TINYINT | SMALLINT | INTEGER | NUMERIC | NUMBER [ ( precision [ , scale ] ) ] | DECIMAL [ ( precision , scale ) ]
Syntax
approx_numeric_data_type ::= { REAL | DOUBLE PRECISION | FLOAT [ ( precision ) ] }
Syntax
date_time_data_type ::
DATE | TIME | TIMESTAMP | TIMESTAMP WITH TIME ZONE
Syntax
bit_string_data_type ::=
BIT | BINARY [ ( length ) ] | BLOB [ ( length ) ] |VARBINARY [( length ) ] | LONG VARBINARY [( length ) ]
216
OpenEdge SQL Elements and Statements in Backus Naur Form
Expressions syntax in BNF
Expression (expr)
Syntax
Numeric arithmetic expression
Date arithmetic expression
Conditional expression
Case expression
A type of conditional expression.
expr ::=
[ { table_name.| alias.}] column_name | character_literal | numeric_literal | date-time_literal | aggregate_function | scalar_function | numeric_arith_expr | date_arith_expr | conditional_expr | (expr)
Syntax
numeric_arith_expr ::=
[ + | - ] { numeric_literal | numeric_expr } [ { + | - | * | / } numeric_arith_expr ]
Syntax
date_arith_expr ::=
date_time_expr { + | - } int_expr | date_time_expr - date_time_expr
Syntax
ase_expr ::=
searched_case_expr | simple_case_expr
217
OpenEdge SQL Elements and Statements in Backus Naur Form
Searched case expression
Simple case expression
Literals syntax in BNF
Date literal
Syntax
Time literal
Syntax
searched_case_expr ::=CASE
WHEN search_condition THEN { result_expr | NULL } [ , ... ][ ELSE expr | NULL ]END
Syntax
simple_case_expr ::=CASE primary_expr
WHEN expr THEN { result_expr | NULL } [ , ... ][ ELSE expr | NULL ]END
date-literal ::={ d ’yyyy-mm-dd’ }
| mm-dd-yyyy | mm/dd/yyyy | mm-dd-yy | mm/dd/yy | yyyy-mm-dd | yyyy/mm/dd | dd-mon-yyyy | dd/mon/yyyy | dd-mon-yy | dd/mon/yy
Syntax
time_literal ::=
{ t ’hh:mi:ss’ } | hh:mi:ss[:mls ]
218
OpenEdge SQL Elements and Statements in Backus Naur Form
Timestamp literal
Timestamp with time zone literal
Query Expressions syntax in BNF
Query expression
Syntax
Set operator
Query specification
Syntax
Syntax
timestamp_literal ::=
{ t 'yyyy-mm-dd hh:mi:ss' } |'date_literal time_literal'
Syntax
timestamp_with_time_zone_literal ::=
{ t 'yyyy-mm-dd hh:mi:ss - hh:mi:ss' }| 'date_literal time_literal'
query_expression ::=query_specification | query_expression set_operator query_expression | ( query_expression )
Syntax
set_operator ::=
{ UNION [ ALL ] | INTERSECT | MINUS }
query_specification ::=SELECT [ ALL | DISTINCT ] { * | { table_name.| alias.}* [, { table_name.| alias.}* ] ,... | expr [ [ AS ] [ ']column_title[' ] ] [, expr [ [ AS ] [ ']column_title[' ] ] ] ,... }FROM table_ref [, table_ref ] ...[ WHERE search_condition ][ GROUP BY [ table.]column_name [, [ table.]column_name ] ,...[ HAVING search_condition ][WITH locking_hints ];
219
OpenEdge SQL Elements and Statements in Backus Naur Form
Table reference
Joined table
From clause inner join
Where clause inner join
From clause outer join
Where clause outer join
Syntax
table_ref ::=
table_name [ AS ] [ alias [ (column_alias [, ... ] ) ] ] | (query_expression) [ AS ] alias [ (column_alias [ ,... ] ) ] | [ ( ] joined_table [ ) ]
Syntax
joined_table ::=
{ table_ref CROSS JOIN table_ref |table_ref [ INNER | LEFT [ OUTER ] ] JOIN table_ref ON search_condition
}
Syntax
from_clause_inner_join ::=
{ FROM table_ref CROSS JOIN table_ref | FROM table_ref [ INNER ] JOIN table_ref ON search_condition
}
Syntax
where_clause_inner_join ::=FROM table_ref, table_ref WHERE search_condition
Syntax
from_clause_outer_join ::=FROM table_ref LEFT OUTER JOIN table_ref ON search_condition
Syntax
where_clause_outer_join ::=
WHERE [ table_name.]column (+) = [ table_name.]column | WHERE [ table_name.]column = [ table_name.]column (+)
220
OpenEdge SQL Elements and Statements in Backus Naur Form
Search conditions syntax in BNF
Search condition
Syntax
Predicate
Relational operator
Basic predicate
Quantified predicate
Between predicate
search_condition ::=
[ NOT ] predicate [ { AND | OR } { predicate | ( search_condition ) } ]
Syntax
predicate ::=basic_predicate
| quantified_predicate | between_predicate | null_predicate | like_predicate | exists_predicate | in_predicate | outer_join_predicate
Syntax
relop ::=
= | <> | != | ^= | < | <= | > | >=
Syntax
basic_predicate ::=
expr relop { expr | ( query_expression ) }
Syntax
quantified_predicate ::=
expr relop { ALL | ANY | SOME } ( query_expression )
Syntax
between_predicate ::=
expr [ NOT ] BETWEEN expr AND expr
221
OpenEdge SQL Elements and Statements in Backus Naur Form
Null predicate
Like predicate
Exists predicate
In predicate
Outer join predicate
Statements, DDL and DML syntax in BNF
This section lists OpenEdge SQL Data Definition Language (DDL) and Data Manipulation Language (DML) statements in Backus-Naur Form (BNF).
ALTER USER
Syntax
null_predicate ::=
column_name IS [ NOT ] NULL
Syntax
like_predicate ::=
column_name [ NOT ] LIKE string_constant [ ESCAPE escape_character ]
Syntax
exists_predicate ::=EXISTS (query_expression)
Syntax
in_predicate ::=
expr [ NOT ] IN { (query_expression) | (constant , constant [ , ... ] ) }
Syntax
outer_join_predicate ::=
[ table_name.]column = [ table_name.]column (+) | [ table_name.]column (+) = [ table_name.]column
Syntax
alter user statement ::=ALTER USER 'username', 'old_password', 'new_password' ;
222
OpenEdge SQL Elements and Statements in Backus Naur Form
CALL
COMMIT
CREATE INDEX
CREATE PROCEDURE
Parameter Declaration
Syntax
call statement ::=
CALL proc_name ( [ parameter ] [ , ...] ) ;
Syntax
commit statement ::=
COMMIT [ WORK ] ;
Syntax
create index statement ::=
CREATE [ UNIQUE ] INDEX index_name ON table_name
( { column_name [ ASC | DESC ] } [, ... ] ) [ AREA area_name ] ;
Syntax
create procedure statement ::=
CREATE PROCEDURE [ owner_name.]procname ( [ parameter_decl [ , ...... ] ] )
[ RESULT ( column_name data_type [ , ... ] ) ] [ IMPORT java_import_clause ] BEGIN java_snippet END
Syntax
parameter_decl ::=
{ IN | OUT | INOUT } parameter_name data_type
223
OpenEdge SQL Elements and Statements in Backus Naur Form
CREATE SYNONYM
CREATE TABLE
Column Definition
Column Constraint
Syntax
create synonym statement ::=
CREATE [ PUBLIC ] SYNONYM synonym FOR [ owner_name.] {table_name |view_name |synonym } ;
Syntax
create table statement ::=
CREATE TABLE [ owner_name.]table_name ( { column_definition | table_constraint }, ... ) [ AREA area_name ] ;
create table statement ::=
CREATE TABLE [ owner_name.]table_name [ (column_name [ NULL | NOT NULL] , ...) ] [ AREA area_name ] AS query_expression ;
Syntax
column_definition ::=column_name data_type
[ DEFAULT { literal | NULL | SYSDATE } ] [ column_constraint [ column_constraint ... ] ]
Syntax
column_constraint ::=
[ CONSTRAINT constraint_name ] NOT NULL [ PRIMARY KEY | UNIQUE ] | REFERENCES [ owner_name.]table_name [ ( column_name ) ] | CHECK ( search_condition )
224
OpenEdge SQL Elements and Statements in Backus Naur Form
Table Constraint
CREATE TRIGGER
CREATE USER
CREATE VIEW
Syntax
table_constraint ::=
[ CONSTRAINT constraint_name ] PRIMARY KEY ( column [, ... ] ) | UNIQUE ( column [, ...... ] ) | FOREIGN KEY ( column [, ... ] ) REFERENCES [ owner_name.]table_name [ ( column [, ... ] ) ] | CHECK ( search_condition )
Syntax
create trigger statement ::=
CREATE TRIGGER [ owner_name.]trigname { BEFORE | AFTER } { INSERT | DELETE | UPDATE [ OF column_name [ , ... ] }
ON table_name
[ REFERENCING { OLDROW [, NEWROW ] | NEWROW [, OLDROW ] } ] [ FOR EACH { ROW | STATEMENT } ] [ IMPORT java_import_clause ] BEGIN java_snippet END
Syntax
create user statement ::=CREATE USER 'username', 'password' ;
Syntax
create view statement ::=
CREATE VIEW [ owner_name.]view_name [ ( column_name, column_name,... ) ] AS [ ( ] query_expression [ ) ] [ WITH CHECK OPTION ] ;
225
OpenEdge SQL Elements and Statements in Backus Naur Form
DELETE
DROP INDEX
DROP PROCEDURE
DROP SYNONYM
DROP TABLE
DROP TRIGGER
DROP USER
Syntax
delete statement ::=
DELETE FROM [ owner_name.] {table_name |view_name } [ WHERE search_condition ] ;
Syntax
drop index statement ::=
DROP INDEX [ index_owner_name.]index_name [ ON [ table_owner_name.]table_name ]
Syntax
drop procedure statement ::=
DROP PROCEDURE [ owner_name.]procedure_name ;
Syntax
drop synonym statement ::=
DROP [ PUBLIC ] SYNONYM synonym ;
Syntax
drop table statement ::=
DROP TABLE [ owner_name.]table_name ;
Syntax
drop trigger statement ::=
DROP TRIGGER [ owner_name.]trigger_name ;
Syntax
drop user statement ::=DROP USER ’username’ ;
226
OpenEdge SQL Elements and Statements in Backus Naur Form
DROP VIEW
GRANT RESOURCE, DBA
GRANT PRIVILEGE
PRIVILEGE
INSERT
LOCK TABLE
Syntax
drop view statement ::=
DROP VIEW [ owner_name.]view_name ;
Syntax
grant resource, dba statement ::=
GRANT { RESOURCE, DBA } TO user_name [ , user_name ] , ... ;
Syntax
grant privilege statement ::=
GRANT { privilege [, privilege ], ... | ALL [ PRIVILEGES] } ON table_name
TO { user_name [, user_name ] , ... | PUBLIC } [WITH GRANT OPTION] ;
Syntax
privilege ::=
{ SELECT | INSERT | DELETE | INDEX |UPDATE [ ( column , column , ... ) ] | REFERENCES [ ( column , column , ... ) ] }
Syntax
insert statement ::=
INSERT INTO [ owner_name.] {table_name |view_name } [ ( column_name [, column_name ] , ... ) ] { VALUES ( value [, value ] ,... ) | query_expression } ;
Syntax
lock table statement ::=
LOCK TABLE table_name [ , table_name ] , ... IN { SHARE | EXCLUSIVE } MODE ;
227
OpenEdge SQL Elements and Statements in Backus Naur Form
REVOKE RESOURCE, DBA
REVOKE PRIVILEGE
PRIVILEGE Syntax
ROLLBACK
SELECT
SET SCHEMA
Syntax
revoke resource, dba statement ::=
REVOKE { RESOURCE | DBA } FROM { user_name [ , user_name ] ,... } ;
Syntax
revoke privilege statement ::=
REVOKE [ GRANT OPTION FOR ] { privilege [, privilege , ] , ... | ALL [ PRIVILEGES ] } ON table_name
FROM { user_name [ , user_name ] , ... | PUBLIC } [ RESTRICT | CASCADE ] ;
Syntax
privilege ::=
{ SELECT | INSERT | DELETE | INDEX |UPDATE [ ( column , column , ... ) ] | REFERENCES [ ( column , column , ... ) ] }
Syntax
rollback statement ::=
ROLLBACK [ WORK ] ;
Syntax
select statement ::=query_expression
ORDER BY { expr | posn } [ ASC | DESC ] [ , { expr | posn } [ ASC | DESC ] , ... ] FOR UPDATE [ OF [ table.]column_name , ... ] ;
Syntax
set schema statement ::=SET SCHEMA { 'string_literal' | ? | USER }
228
OpenEdge SQL Elements and Statements in Backus Naur Form
UPDATE
Assignment clause
UPDATE STATISTICS
Syntax
update statement ::=UPDATE table_name
SET assignment [,assignment ], ... [ WHERE search_condition ] ;
Syntax
assignment ::=
column = { expr | NULL } | ( column [, column ], ... ) = ( expr [, expr ], ... ) | ( column [, column ], ... ) = ( query_expression )
Syntax
update statistics statement ::=
UPDATE ( [ table_name | index_name | [ ALL ] column_name ] STATISTICS [ AND ]) ... [ FOR table_name ] ;
229
OpenEdge SQL Elements and Statements in Backus Naur Form
230
Compliance with Industry Standards
This section identifies the level of ANSI SQL-92 compliance and ODBC SQL Grammar compliance for OpenEdge® statements, and the SQL-92 and ODBC compatibility for OpenEdge SQL scalar functions, as defined in the following sections:
• Scalar functions
• SQL-92 DDL and DML statements
Scalar functions
Table 50 lists OpenEdge SQL scalar functions. A check mark identifies the compatibility of the function as SQL-92 compatible, ODBC compatible, or a Progress® extension.
Table 50: Compatibility of SQL-92 scalar functions (1 of 5)
Scalar function SQL-92 ODBCProgressextension Notes
ABS – ✓ – –
ACOS – ✓ – –
ADD_MONTHS – – ✓ –
ASCII – ✓ – –
ASIN – ✓ – –
ATAN – ✓ – –
ATAN2 – ✓ – –
Scalar functions
CAST ✓ – – –
CEILING – ✓ – –
CHAR – ✓ – –
CHR – – ✓ –
COALESCE ✓ – – –
CONCAT – ✓ – –
CONVERT – ✓ – Requires ODBC escape clause – { fn }
CONVERT – – ✓ Not compatible with ODBC CONVERT
COS – ✓ – –
CURDATE – ✓ – –
CURTIME – ✓ – –
DATABASE – ✓ – –
DAYNAME – ✓ – –
DAYOFMONTH – ✓ – –
DAYOFWEEK – ✓ – –
DAYOFYEAR – ✓ – –
DB_NAME – – ✓ –
DECODE – – ✓ –
DEGREES – ✓ – –
EXP – ✓ – –
FLOOR – ✓ – –
GREATEST – – ✓ –
HOUR – ✓ – –
IFNULL – ✓ – –
INITCAP – – ✓ –
INSERT – ✓ – –
INSTR – – ✓ –
Table 50: Compatibility of SQL-92 scalar functions (2 of 5)
Scalar function SQL-92 ODBCProgressextension Notes
232
Scalar functions
LAST_DAY – – ✓ –
LCASE – ✓ – –
LEAST – – ✓ –
LEFT – ✓ – –
LENGTH – ✓ – –
LOCATE – ✓ – –
LOG10 – ✓ – –
LOWER ✓ – – –
LPAD – – ✓ –
LTRIM – ✓ – –
MINUTE – ✓ – –
MOD – ✓ – –
MONTH – ✓ – –
MONTHNAME – ✓ – –
MONTHS_BETWEEN – – ✓ –
NEXT_DAY – – ✓ –
NOW – ✓ – –
NULLIF ✓ – – –
NVL – – ✓ –
PI – ✓ – –
POWER – – ✓ –
PREFIX – – ✓ –
PRO_ARR_DESCAPE – – ✓ –
PRO_ARR_ESCAPE – – ✓ –
PRO_ELEMENT – – ✓ –
QUARTER – ✓ – –
RADIAN – ✓ – –
RAND – ✓ – –
Table 50: Compatibility of SQL-92 scalar functions (3 of 5)
Scalar function SQL-92 ODBCProgressextension Notes
233
Scalar functions
REPEAT – ✓ – –
REPLACE – ✓ – –
RIGHT – ✓ – –
ROUND – – ✓ –
ROWID – – ✓ –
RPAD – – ✓ –
RTRIM – ✓ – –
SECOND – ✓ – –
SIGN – ✓ – –
SIN – ✓ – –
SQRT – ✓ – –
SUBSTR – – ✓ –
SUBSTRING – ✓ – –
SUFFIX – – ✓ –
SYSDATE – – ✓ –
SYSTIME – – ✓ –
SYSTIMESTAMP – – ✓ –
TAN – ✓ – –
TO_CHAR – – ✓ –
TO_DATE – – ✓ –
TO_NUMBER – – ✓ –
TO_TIME – – ✓ –
TO_TIMESTAMP – – ✓ –
TRANSLATE – – ✓ –
UCASE – ✓ – –
UPPER ✓ – – –
USER ✓ ✓ ✓ –
Table 50: Compatibility of SQL-92 scalar functions (4 of 5)
Scalar function SQL-92 ODBCProgressextension Notes
234
SQL-92 DDL and DML statements
SQL-92 DDL and DML statements
Table 51 lists OpenEdge SQL DDL and DML Statements. A check mark identifies the compliance of each statement as SQL-92, a level of ODBC SQL Grammar, or as a Progress extension.
WEEK – ✓ – –
YEAR – ✓ – –
Table 50: Compatibility of SQL-92 scalar functions (5 of 5)
Scalar function SQL-92 ODBCProgressextension Notes
Table 51: Compliance of SQL-92 DDL and DML statements (1 of 2)
OpenEdge SQL statement SQL-92
ODBC SQL
grammarProgress extension Notes
ALTER USER – – ✓ –
CALL – Extended – Must enclose in an ODBC escape clause { fn }
COMMIT ✓ – – –
CONNECT ✓ – USING password –
CREATE INDEX – Core AREA area_name –
CREATE PROCEDURE – Core ✓ –
CREATE SYNONYM – – ✓ –
CREATE TABLE ✓ Minimum AREA AS query_expression
–
CREATE TRIGGER – Core ✓ –
CREATE USER – – ✓ –
CREATE VIEW ✓ Core – –
DELETE ✓ Extended – –
DISCONNECT ✓ – – –
DROP INDEX – Core – –
DROP PROCEDURE – Core ✓ –
DROP SYNONYM – – ✓ –
235
SQL-92 DDL and DML statements
DROP TABLE – Minimum ✓ –
DROP TRIGGER – – ✓ –
DROP USER – – ✓ –
DROP VIEW – Core ✓ –
GRANT ✓ Core INDEXRESOURCEDBA
–
INSERT ✓ Core – –
LOCK TABLE – – ✓ –
REVOKE ✓ Core INDEXRESOURCEDBA
–
ROLLBACK ✓ – – –
SELECT ✓ Extended FOR UPDATE –
SET CONNECTION ✓ – – –
SET SCHEMA ✓ – – –
SET TRANSACTION ISOLATION LEVEL
– – ✓ –
UPDATE ✓ Extended assignments of form:( column, column )= ( expr, expr )
–
UPDATE STATISTICS
– – ✓ –
Table 51: Compliance of SQL-92 DDL and DML statements (2 of 2)
OpenEdge SQL statement SQL-92
ODBC SQL
grammarProgress extension Notes
236
Syntax for ABL Attributes
The OpenEdge SQL statements CREATE TABLE and ALTER TABLE allow you to define ABL (Advanced Business Language) attributes for tables and columns. This section lists and describes the SQL keywords to use with CREATE TABLE and ALTER TABLE syntax. For examples of syntax using SQL keywords for ABL attributes, see the CREATE TABLE and ALTER TABLE entries in the “OpenEdge SQL Statements” section on page 1.
OpenEdge SQL keywords for ABL table attributes
Table 52 lists the keywords to use when setting ABL table attributes with OpenEdge SQL statements.
Table 52: ABL table attributes used in OpenEdge SQL statements (1 of 2)
Attribute keyword used in SQL statement Description Value
PRO_CAN_CREATE Equivalent to ABL CAN-CREATE
Arbitrary character string
PRO_CAN_DELETE Equivalent to ABL CAN-DELETE
Arbitrary character string
PRO_CAN_DUMP Equivalent to ABL CAN-DUMP
Arbitrary character string
PRO_CAN_LOAD Equivalent to ABL CAN-LOAD
Arbitrary character string
PRO_CAN_READ Equivalent to ABL CAN-READ
Arbitrary character string
Syntax for ABL Attributes
Table 53 lists the keywords to use when setting ABL column attributes with OpenEdge SQL statements.
PRO_CAN_WRITE Equivalent to ABL CAN-WRITE.
Arbitrary character string
PRO_DESCRIPTION Equivalent to ABL DESCRIPTION.
Arbitrary character string
PRO_DUMP_NAME Equivalent to ABL DUMP-NAME.
Arbitrary character string
PRO_FROZEN Equivalent to ABL FROZEN.
Note: OpenEdge SQL honors the value set here and does not allow modification of a frozen table using the ALTER TABLE, CREATE INDEX, CREATE PRO_WORD INDEX, DROP INDEX, or DROP TABLE commands.
However, the frozen attribute may be set to 'N' to unfreeze a frozen table. For example: ALTER TABLE Customer SET PRO_FROZEN 'N';
'Y'|'y'|'N'|'n'
PRO_HIDDEN Indicates whether the table is shown in ABL tools and reports.
'Y'|'y'|'N'|'n'
PRO_LABEL Equivalent to ABL LABEL. Arbitrary character string
PRO_VALEXP Indicates an ABL validation expression.
Arbitrary character string
PRO_VALMSG Indicates an ABL validation message.
Arbitrary character string
PRO_SA_VALMS Indicates an ABL string attributes validation message.
Arbitrary character string
PRO_SA_LABEL Indicates an ABL table label.
Arbitrary character string
PRO_DEFAULT_INDEX Determines default data-access index for a table.
Name of an index or table
Table 52: ABL table attributes used in OpenEdge SQL statements (2 of 2)
Attribute keyword used in SQL statement Description Value
238
Syntax for ABL Attributes
Table 53: ABL column attributes used in OpenEdge SQL statements(1 of 2)
Attribute keyword used in SQL statement Description Value
PRO_CAN_READ Equivalent to ABL CAN-READ
Arbitrary character string
PRO_CAN_WRITE Equivalent to ABL CAN-WRITE
Arbitrary character string
PRO_COL_LABEL Equivalent to ABL COL-LABEL
Free-form text
PRO_DESCRIPTION Equivalent to ABL DESCRIPTION
Free-form text
PRO_FORMAT Equivalent to ABL FORMAT
ABL format string
PRO_HELP Indicates a ABL help message
Free-form text
PRO_LABEL Indicates ABL label Free-form text
PRO_RPOS Indicates ABL relative record position
Positive integer
PRO_SQL_WIDTH Indicates SQL width Positive integer
PRO_VIEW_AS Equivalent to ABL VIEW-AS
Free-form text
PRO_ORDER Equivalent to ABL ORDER Integer value
PRO_VALEXP Indicates ABL validation expression
Free-form text
PRO_VALMSG Indicates ABL validation message
Free-form text
PRO_SA_LABEL Indicates ABL string attribute column label
Arbitrary character string
PRO_SA_COL_LABEL Indicates ABL string attribute column label
Arbitrary character string
PRO_SA_FORMAT Indicates ABL string attribute column label
Arbitrary character string
PRO_SA_INITIAL Indicates ABL string attribute column label
Arbitrary character string
PRO_SA_HELP Indicates ABL string attribute column label
Arbitrary character string
PRO_SA_VALMSG Indicates ABL string attribute column label
Arbitrary character string
239
Syntax for ABL Attributes
Table 54 lists the keywords to use when setting ABL index attributes with OpenEdge SQL statements.
DEFAULT
Note: DEFAULT is a common attribute of both SQL and ABL.
Indicates the default value for a column.
A literal value whose type is compatible with the type of the column
PRO_CASE_SENSITIVE Indicates case-sensitivity 'Y'|'y'|'N'|'n'PRO_LOB_SIZE_TEXT The maximum size of a
BLOB or CLOB column described as a string
Free-form text.
For example: '32M'
Table 54: ABL index attributes used in OpenEdge SQL statements
Attribute keyword used in SQL statement Description Value
PRO_ACTIVE Changes the index’s status from active to inactive. This action must be performed offline.
'n'
PRO_DESCRIPTION Equivalent to ABL DESCRIPTION.
Free-form text
Table 53: ABL column attributes used in OpenEdge SQL statements(2 of 2)
Attribute keyword used in SQL statement Description Value
240
Part II
JDBC Reference
Java Class Reference
JDBC Conformance Notes
Java Class Reference
This section provides information on OpenEdge™ SQL Java classes and methods. The following subjects are covered:
• Java classes and methods
• DhSQLException
• DhSQLResultSet
• SQLCursor
• SQLIStatement
• SQLPStatement
Java classes and methods
This section provides reference material on the OpenEdge SQL Java classes and methods. This section lists all the methods in the OpenEdge SQL Java classes and shows which classes declare them. Subsequent sections are arranged alphabetically and describe each class and its methods in more detail. Some Java methods are common to more than one class.
setParam
Sets the value of an SQL statement’s input parameter to the specified value; a literal, procedure variable, or procedure input parameter. The following Java classes declare setParam:
• SQLIStatement
• SQLPStatement
Java Class Reference
• SQLCursor
makeNULL
Sets the value of an SQL statement’s input parameter to NULL. The following Java classes declare makeNULL:
• SQLIStatement
• SQLPStatement
• SQLCursor
Sets a field of the currently active row in a procedure’s result set to NULL:
• DhSQLResultSet
execute
Executes the SQL statement. The following Java classes declare execute:
• SQLIStatement
• SQLPStatement
rowCount
Returns the number of rows deleted, inserted, or updated by the SQL statement. The following Java classes declare rowCount:
• SQLIStatement
• SQLPStatement
• SQLCursor
open
Opens the result set specified by the SELECT or CALL statement. The following Java class declares open:
• SQLCursor
close
Closes the result set specified by the SELECT or CALL statement. The following Java class declares close:
• SQLCursor
fetch
Fetches the next record in a result set. The following Java class declares fetch:
• SQLCursor
244
Java Class Reference
found
Checks whether a fetch operation returned to a record. The following Java class declares found:
• SQLCursor
wasNULL
Checks if the value in a fetched field is NULL. The following Java class declares wasNULL:
• SQLCursor
getValue
Stores the value of a fetched field in the specified procedure variable or procedure output parameter. The following Java class declares getValue:
• SQLCursor
set
Sets the field in the currently active row of a procedure’s result set a literal, procedure variable, or procedure input parameter. The following Java class declares set:
• DhSQLResultSet
insert
Inserts the currently active row into the result set of a procedure. The following Java class declares insert:
• DhSQLResultSet
getDiagnostics
Returns the specified detail of an error message. The following Java class declares getDiagnostics:
• DhSQLException
log
Writes a message to the log. The following Java classes inherit the log:
• SQLIStatement
• SQLPStatement
• SQLCursor
• DhSQLResult Set
• DhSQLException
245
Java Class Reference
err
Writes a message to the log. The following Java classes write to the log:
• SQLIStatement
• SQLPStatement
• SQLCursor
• DhSQLResult Set
• DhSQLException
DhSQLException
Extends the general java.lang. exception class to provide detail about errors in SQL statement execution. Any such errors raise an exception with an argument that is an SQLException class object. The getDiagnostics() method retrieves details of the error.
Constructors
public DhSQLException(int ecode, String errMsg)
Parameters
ecode
The error number associated with the exception condition.
errMsg
The error message associated with the exception condition.
Example In this example, the DhSQLException constructor creates an exception object called excep and then throws the excep object under all conditions:
DhSQLException.getDiagnostics
Returns the requested detail about an exception.
Format
public String getDiagnostics(int diagType)
CREATE PROCEDURE sp1_02()BEGIN // raising exception DhSQLException excep = new DhSQLException(666,new String ("Entered the tst02 procedure")); if (true) throw excep;END
246
Java Class Reference
Returns
A string containing the information specified by the diagType parameter, as shown in Table 55.
Parameters
diagType
One of the argument values listed in Table 55.
Throws
DhSQLException
Example This code fragment illustrates DhSQLException.getDiagnostics:
DhSQLResultSet
Provides the stored procedure with a result set to return to the application that called the procedure.
The Java code in a stored procedure does not explicitly create DhSQLResultSet objects. Instead, when the SQL server creates a Java class from a CREATE PROCEDURE statement that contains a Result clause, it implicitly instantiates an object of type DhSQLResultSet, and calls it SQLResultSet.
Table 55: Argument values for DhSQLException.getDiagnostics
Argument value Returns
RETURNED_SQLSTATE The SQLSTATE returned by execution of the previous SQL statement
MESSAGE_TEXT The condition indicated by RETURNED_SQLSTATE
CLASS_ORIGIN Not currently used; always returns NULL
SUBCLASS_ORIGIN Not currently used; always returns NULL
try{ SQLIStatement insert_cust = new SQLIStatement ( "INSERT INTO customer VALUES (1,2) ");}catch (DhSQLException e){ errstate = e.getDiagnostics (RETURNED_SQLSTATE) ; errmesg = e.getDiagnostics (MESSAGE_TEXT) ; . . .}
247
Java Class Reference
Procedures invoke methods of the SQLResultSet instance to populate fields and rows of the result set.
Constructors
No explicit constructor
Parameters
None
Throws
DhSQLException
DhSQLResultSet.insert
Inserts the currently active row into a procedure’s result set.
Format
public void insert()
Returns
None
Parameters
None
Throws
DhSQLException
Example This code fragment illustrates SQLResultSet.set and SQLResultSet.insert:
248
Java Class Reference
DhSQLResultSet.makeNULL
Sets a field of the currently active row in a procedure’s result set to NULL. This method is redundant with using the DhSQLResultSet.set method to set a procedure result-set field to NULL.
Format
public void makeNULL(int field)
Returns
None
Parameters
field
An integer that specifies which field of the result-set row to set to NULL. 1 denotes the first field in the row, 2 denotes the second, n denotes the nth.
Throws
DhSQLException
Example This code fragment illustrates SQLResultSet.set and SQLResultSet.makeNULL:
CREATE PROCEDURE get_sal2 ()RESULT ( empname CHAR(20), empsal NUMERIC,)BEGIN String ename = new String (20) ; BigDecimal esal = new BigDecimal () ; SQLCursor empcursor = new SQLCursor ( "SELECT name, sal FROM emp " ) ; empcursor.Open () ; do { empcursor.Fetch (); if (empcursor.found ()) { empcursor.getValue (1, ename); empcursor.getValue (2, esal); SQLResultSet.Set (1, ename); SQLResultSet.Set (2, esal); SQLResultSet.Insert (); } } while (empcursor.found ()) ; empcursor.close () ;END
249
Java Class Reference
DhSQLResultSet.set
Sets the field in the currently active row of a procedure’s result set to the specified value (a literal, procedure variable, or procedure input parameter).
Format
public void set(int field, Object val)
Returns
None
Parameters
field
An integer that specifies which field of the result-set row to set to the value specified by val. (1 denotes the first field in the row, 2 denotes the second, and so on.)
val
A literal or the name of a variable or input parameter that contains the value to be assigned to the field.
Throws
DhSQLException
Example This code fragment illustrates SQLResultSet.Set:
CREATE PROCEDURE test_makeNULL2( IN char_in CHAR(20) RESULT ( res_char CHAR(20) , res_vchar VARCHAR(30)) BEGIN SQLResultSet.set(1,char_in); SQLResultSet.makeNULL(2);END
250
Java Class Reference
SQLCursor
Allows rows of data to be retrieved from a database or another stored procedure’s result set.
Constructors
SQLCursor (String statement)
Parameters
statement
Generates a result set. Enclose the SQL statement in double quotes. The SQL statement is either a SELECT or CALL statement.
Notes • A SELECT statement queries the database and returns data that meets the criteria specified by the query expression in the SELECT statement.
• A CALL statement invokes another stored procedure that returns a result set specified by the RESULT clause of the CREATE PROCEDURE statement.
Throws
DhSQLException
Examples The following excerpt from a stored procedure instantiates an SQLCursor object called cust_cursor that retrieves data from a database table:
CREATE PROCEDURE get_sal2 ()RESULT ( empname CHAR(20), empsal NUMERIC,)BEGIN String ename = new String (20) ; BigDecimal esal = new BigDecimal () ; SQLCursor empcursor = new SQLCursor ( "SELECT name, sal FROM emp " ) ; empcursor.Open () ; do { empcursor.Fetch (); if (empcursor.found ()) { empcursor.getValue (1, ename); empcursor.getValue (2, esal); SQLResultSet.Set (1, ename); SQLResultSet.Set (2, esal); SQLResultSet.Insert (); } } while (empcursor.found ()) ; empcursor.close () ;END
251
Java Class Reference
The following excerpt from a stored procedure instantiates an SQLCursor object called cust_cursor that calls another stored procedure:
SQLCursor.close
Closes the result set specified by a SELECT or CALL statement.
Format
public void close()
Returns
None
Parameters
None
Throws
DhSQLException
Example This code fragment illustrates the getValue and close methods:
SQLCursor.fetch
Fetches the next record in a result set, if there is one.
Format
public void fetch()
SQLCursor empcursor = new SQLCursor ( "SELECT name, sal FROM emp " ) ;
t_cursor = new SQLCursor ( "CALL get_customers (?) ") ;
{ if (cust_cursor.Found ()) { cust_cursor.getValue (1, cust_number); cust_cursor.getValue (2, cust_name) ; } else break;} cust_cursor.close () ;
252
Java Class Reference
Returns
None
Parameters
None
Throws
DhSQLException
Example This code fragment illustrates the fetch method and the getValue method:
SQLCursor.found
Checks whether a fetch operation returned a record.
Format
public boolean found ()
Returns
True if the previous call to fetch() returned a record, false otherwise
Parameters
None
Throws
DhSQLException
Example This code fragment illustrates the fetch, found, and getValue methods:
for (;;){ cust_cursor.Fetch (); if (cust_cursor.Found ()) { cust_cursor.getValue (1, cust_number); cust_cursor.getValue (2, cust_name) ; } else break;}
253
Java Class Reference
SQLCursor.getParam
Retrieves the values of Java OUT and INOUT parameters.
Format
inout_var = getParam( int fieldIndex, short fieldType ) ;
Returns
OUT or INOUT variable
Parameters
inout_var
The target variable into which the value of an OUT or INOUT parameter is stored.
fieldIndex
An integer that specifies the position of the parameter in the parameter list.
fieldType
A short integer that specifies the data type of the parameter. The allowable defined values for fieldType are listed in Table 56, grouped by category of data type.
for (;;){ cust_cursor.Fetch (); if (cust_cursor.Found ()) { cust_cursor.getValue (1, cust_number); cust_cursor.getValue (2, cust_name) ; } else break;}
Table 56: Allowable values for fieldType in getParam
CharacterExact
numericApproximate
numeric Date-time Bit string
CHAR INTEGER REAL DATE BIT
CHARACTER SMALLINT FLOAT TIME BINARY
VARCHAR TINYINT DOUBLE TIMESTAMP VARBINARY
– NUMERIC – – LVARBINARY
– DECIMAL – – –
254
Java Class Reference
Throws
DhSQLException
Notes • The getParam() method returns the value of an INOUT or OUT parameter identified by the number you specify in the fieldIndex parameter. getParam() returns the value as an object of the data type you specify in the fieldType parameter. Since getParam() returns the result as an instance of class Object, you must explicitly cast your inout_var variable to the correct data type.
• If the OUT or INOUT parameter is of data type CHARACTER, then getParam returns a Java String Object. You must declare a procedure variable of type String, and explicitly cast the value returned by getParam to type String. Before calling getParam() you must call the SQLCursor.wasNULL method to test whether the returned value is NULL. If getParam() is called for a NULL value, it raises a DhSQLException.
SQLCursor.getValue
Assigns a single value from an SQL result set to a procedure variable. The single field value is the result of an SQL query or the result from another stored procedure.
Format
public Object getValue( int fieldNum, short fieldType )
Returns
Object
Parameters
fieldNum
An integer that specifies the position of the field to retrieve from the fetched record.
fieldType
A short integer that specifies the data type of the parameter. The allowable defined values for fieldType are listed in Table 57, grouped by category of data type.
Table 57: Allowable values for fieldType in getValue
CharacterExact
numericApproximate
numeric Date-time Bit string
CHAR INTEGER REAL DATE BIT
CHARACTER SMALLINT FLOAT TIME BINARY
VARCHAR TINYINT DOUBLE TIMESTAMP VARBINARY
– NUMERIC – – LVARBINARY
– DECIMAL – – –
255
Java Class Reference
Throws
DhSQLException
Notes • Before invoking getValue, you must test for the NULL condition by calling the SQLCursor.wasNULL method. If the value returned is NULL, you must explicitly set the target variable in the stored procedure to NULL.
• The getValue method returns a value from the result set identified by the number you specify in the fieldNum parameter. getValue returns the value as an object of the data type you specify in the fieldType parameter. Since getValue returns the result as an instance of class Object, you must explicitly cast your return value to the correct data type.
• If the returned value is of data type CHARACTER, then getValue returns a Java String Object. You must declare a procedure variable of type String and explicitly cast the value returned by getValue to type String.
Example This example illustrates testing for NULL and invoking the Java getValue method:
SQLCursor.makeNULL
Sets the value of an SQL statement’s input parameter to NULL. This method is common to the SQLCursor, SQLIStatement, and SQLPStatement classes. This method is redundant with using the setParam method to set an SQL statement’s input parameter to NULL.
Format
public void makeNULL(int f)
Returns
None
Integer pvar_int = new Integer(0);String pvar_str = new String();SQLCursor select_t1 = new SQLCursor ("select int_col, char_col from T1"); Select_t1.open();Select_t1.fetch(); while(select_t1.found()){ // Assign values from the current row of the SQL result set // to the procedure variables. First check whether // the values fetched are null. If null then explicitly // set the procedure variables to null. if ((select_t1.wasNULL(1)) == true) pvar_int = null; else pvar_int = (Integer)select_t1.getValue(1, INTEGER); if ((select_t1.wasNULL(2)) == true) pvar_str = null; else pvar_str = (String)select_t1.getValue(1, CHAR);}
256
Java Class Reference
Parameters
f
An integer that specifies which input parameter of the SQL statement string to set to NULL. 1 denotes the first input parameter in the statement, 2 denotes the second, n denotes the nth.
Throws
DhSQLException
Example This code fragment illustrates the makeNULL method:
SQLCursor.open
Opens the result set specified by the SELECT or CALL statement.
Format
public void open()
Returns
None
Parameters
None
Throws
DhSQLException
Example This code fragment illustrates the open method:
CREATE PROCEDURE sc_makeNULL()BEGIN SQLCursor select_btypes = new SQLCursor ( "SELECT small_fld from sfns where small_fld = ? "); select_btypes.makeNULL(1); select_btypes.open(); select_btypes.fetch(); . . . select_btypes.close();END
SQLCursor empcursor = new SQLCursor ( "SELECT name, sal FROM emp " ) ;empcursor.Open () ;
257
Java Class Reference
SQLCursor.registerOutParam
Registers OUT parameters.
Format
registerOutParam( int fieldIndex, short fieldType [ , short scale ] )
Returns
None
Parameters
fieldIndex
An integer that specifies the position of the parameter in the parameter list.
fieldType
A short integer that specifies the data type of the parameter.
The allowable defined values for fieldType are listed in Table 58, grouped by category of data type.
Throws
DhSQLException
SQLCursor.rowCount
Returns the number of rows affected (selected, inserted, updated, or deleted) by the SQL statement. This method is common to the SQLCursor, SQLIStatement, and SQLPStatement classes.
Format
public int rowCount()
Table 58: Allowable values for fieldType in registerOutParam
CharacterExact
numericApproximate
numeric Date-time Bit string
CHAR INTEGER REAL DATE BIT
CHARACTER SMALLINT FLOAT TIME BINARY
VARCHAR TINYINT DOUBLE TIMESTAMP VARBINARY
– NUMERIC – – LVARBINARY
– DECIMAL – – –
258
Java Class Reference
Returns
An integer indicating the number of rows.
Parameters
None
Throws
DhSQLException
Example This example uses the rowCount method of the SQLIStatement class by nesting the method invocation within SQLResultSet.set to store the number of rows affected (1, in this case) in the procedure’s result set:
SQLCursor.setParam
Sets the value of an SQL statement’s input parameter to the specified value (a literal, procedure variable, or procedure input parameter). This method is common to the SQLCursor, SQLIStatement, and SQLPStatement classes.
Format
public void setParam(int f, Object val)
Returns
None
Parameters
f
An integer that specifies which parameter marker in the SQL statement is to receive the value. 1 denotes the first parameter marker, 2 denotes the second, n denotes the nth.
val
A literal or the name of a variable or input parameter that contains the value to be assigned to the parameter marker.
CREATE PROCEDURE sis_rowCount()RESULT ( ins_recs INTEGER ) BEGIN SQLCursor insert_test103 = new SQLIStatement ( "INSERT INTO test103 (fld1) values (17)"); insert_test103.execute(); SQLResultSet.set(1,new Long(insert_test103.rowCount())); SQLResultSet.insert();END
259
Java Class Reference
Throws
DhSQLException
Example This code fragment illustrates the setParam method:
SQLCursor.wasNULL
Checks if the value in a fetched field is NULL.
Format
public boolean wasNULL(int field)
Returns
True if the field is NULL, false otherwise
Parameters
field
An integer that specifies which field of the fetched record is of interest. (1 denotes the first column of the result set, 2 denotes the second, and so on.) wasNULL checks whether the value in the currently fetched record of the column denoted by field is NULL.
Throws
DhSQLException
Example This code fragment illustrates the wasNULL method:
CREATE PROCEDURE sps_setParam() BEGIN// Assign local variables to be used as SQL input parameter references Integer ins_fld_ref = new Integer(1); Integer ins_small_fld = new Integer(3200); Integer ins_int_fld = new Integer(21474); Double ins_doub_fld = new Double(1.797E+30); String ins_char_fld = new String("Athula"); String ins_vchar_fld = new String("Scientist"); Float ins_real_fld = new Float(17); SQLIStatement insert_sfns1 = new SQLIStatement ("INSERT INTO sfns (fld_ref,small_fld,int_fld,doub_fld,char_fld,vchar_fld) values (?,?,?,?,?,?)" ); insert_sfns1.setParam(1,ins_fld_ref); insert_sfns1.setParam(2,ins_small_fld); insert_sfns1.setParam(3,ins_int_fld); insert_sfns1.setParam(4,ins_doub_fld); insert_sfns1.setParam(5,ins_char_fld); insert_sfns1.setParam(6,ins_vchar_fld); insert_sfns1.execute();END
260
Java Class Reference
SQLIStatement
Allows immediate (one-time) execution of SQL statements that do not generate a result set.
Constructors
SQLIStatement (String statement)
Parameters
statement
An SQL statement that does not generate a result set. Enclose the SQL statement in double quotes.
Throws
DhSQLException
Example This code fragment illustrates the SQLIStatement class:
SQLIStatement.execute
Executes the SQL statement. This method is common to the SQLIStatement and SQLPStatement classes.
CREATE PROCEDURE test_wasNULL() BEGIN int small_sp = 0; SQLCursor select_btypes = new SQLCursor ("SELECT small_fld from sfns"); select_btypes.open(); select_btypes.fetch(); if ((select_btypes.wasNULL(1)) == true) small_sp = null; else select_btypes.getValue(1,small_sp); select_btypes.close();END
CREATE PROCEDURE insert_customer (IN cust_number INTEGER,IN cust_name CHAR(20)) BEGIN SQLIStatement insert_cust = new SQLIStatement ( "INSERT INTO customer VALUES (?,?) ");END
261
Java Class Reference
Format
public void execute()
Returns
None
Parameters
None
Throws
DhSQLException
Example This code fragment illustrates the setParam and execute methods:
SQLIStatement.makeNULL
Sets the value of an SQL statement’s input parameter to NULL. This method is common to the SQLCursor, SQLIStatement, and SQLPStatement classes. This method is redundant with using the setParam method to set an SQL statement’s input parameter to NULL.
Format
public void makeNULL(int f)
Returns
None
Parameters
f
An integer that specifies which input parameter of the SQL statement string to set to NULL. 1 denotes the first input parameter in the statement, 2 denotes the second, n denotes the nth.
CREATE PROCEDURE insert_customer (IN cust_number INTEGER,IN cust_name CHAR(20)) BEGIN SQLIStatement insert_cust = new SQLIStatement ( "INSERT INTO customer VALUES (?,?) "); insert_cust.setParam (1, cust_number); insert_cust.setParam (2, cust_name); insert_cust.execute ();END
262
Java Class Reference
Throws
DhSQLException
Example This code fragment illustrates the makeNULL method:
SQLIStatement.rowCount
Returns the number of rows affected (selected, inserted, updated, or deleted) by the SQL statement. This method is common to the SQLCursor, SQLIStatement, and SQLPStatement classes.
Format
public int rowCount()
Returns
An integer indicating the number of rows
Parameters
None
Throws
DhSQLException
Example This example uses the rowCount method of the SQLIStatement class by nesting the method invocation within SQLResultSet.set to store the number of rows affected (1, in this case) in the procedure’s result set:
CREATE PROCEDURE sis_makeNULL() BEGIN SQLIStatement insert_sfns1 = new SQLIStatement ("INSERT INTO sfns (fld_ref,small_fld,int_fld,doub_fld,char_fld,vchar_fld) values (?,?,?,?,?,?)" ); insert_sfns1.setParam(1,new Integer(66)); insert_sfns1.makeNULL(2); insert_sfns1.makeNULL(3); insert_sfns1.makeNULL(4); insert_sfns1.makeNULL(5); insert_sfns1.makeNULL(6); insert_sfns1.execute();END
263
Java Class Reference
SQLIStatement.setParam
Sets the value of an SQL statement’s input parameter to the specified value (a literal, procedure variable, or procedure input parameter). This method is common to the SQLCursor, SQLIStatement, and SQLPStatement classes.
Format
public void setParam(int f, Object val)
Returns
None
Parameters
f
An integer that specifies which parameter marker in the SQL statement is to receive the value (1 denotes the first parameter marker, 2 denotes the second, and so on).
val
A literal or the name of a variable or input parameter that contains the value to be assigned to the parameter marker.
Throws
DhSQLException
Example This code fragment illustrates the setParam method:
CREATE PROCEDURE sis_rowCount()RESULT ( ins_recs INTEGER )BEGIN SQLIStatement insert_test103 = new SQLIStatement ( "INSERT INTO test103 (fld1) values (17)"); insert_test103.execute(); SQLResultSet.set(1,new Long(insert_test103.rowCount())); SQLResultSet.insert();END
264
Java Class Reference
SQLPStatement
Allows prepared (repeated) execution of SQL statements that do not generate a result set.
Constructors
SQLPStatement (String statement)
Parameters
statement
An SQL statement that does not generate a result set. Enclose the SQL statement in double quotes.
Throws
DhSQLException
Example This code fragment illustrates the SQLPStatement class:
SQLPStatement.execute
Executes the SQL statement. This method is common to the SQLIStatement and SQLPStatement classes.
CREATE PROCEDURE sps_setParam() BEGIN// Assign local variables to be used as // SQL input parameter references Integer ins_fld_ref = new Integer(1); Integer ins_small_fld = new Integer(3200); Integer ins_int_fld = new Integer(21474); Double ins_doub_fld = new Double(1.797E+30); String ins_char_fld = new String("Athula"); String ins_vchar_fld = new String("Scientist"); Float ins_real_fld = new Float(17); SQLPStatement insert_sfns1 = new SQLPStatement ("INSERT INTO sfns (fld_ref,small_fld,int_fld,doub_fld,char_fld,vchar_fld) values (?,?,?,?,?,?)" ); insert_sfns1.setParam(1,ins_fld_ref); insert_sfns1.setParam(2,ins_small_fld); insert_sfns1.setParam(3,ins_int_fld); insert_sfns1.setParam(4,ins_doub_fld); insert_sfns1.setParam(5,ins_char_fld); insert_sfns1.setParam(6,ins_vchar_fld); insert_sfns1.execute();END
SQLPStatement pstmt = new SQLPStatement ( "INSERT INTO T1 VALUES (?, ?) ") ;
265
Java Class Reference
Format
public void execute()
Returns
None
Parameters
None
Throws
DhSQLException
Example This code fragment illustrates the execute and setParam methods in the SQLPStatement class:
SQLPStatement.makeNULL
Sets the value of an SQL statement’s input parameter to NULL. This method is common to the SQLCursor, SQLIStatement, and SQLPStatement classes. This method is redundant with using the setParam method to set an SQL statement’s input parameter to NULL.
Format
public void makeNULL(int f)
Returns
None
Parameters
f
An integer that specifies which input parameter of the SQL statement string to set to NULL. (1 denotes the first input parameter in the statement, 2 denotes the second, and so on.)
Throws
DhSQLException
SQLPStatement pstmt = new SQLPStatement ( "INSERT INTO T1 VALUES (?, ?) ") ;pstmt.setParam (1, 10);pstmt.setParam (2, 10);pstmt.execute ();pstmt.setParam (1, 20);pstmt.setParam (2, 20);pstmt.execute ();
266
Java Class Reference
Example This code fragment illustrates SQLPStatement.makeNULL:
SQLPStatement.rowCount
Returns the number of rows affected (selected, inserted, updated, or deleted) by the SQL statement. This method is common to the SQLCursor, SQLIStatement, and SQLPStatement classes.
Format
public int rowCount()
Returns
An integer indicating the number of rows
Parameters
None
Throws
DhSQLException
Example This example uses the rowCount method of the SQLPStatement class by nesting the method invocation within SQLResultSet.set to store the number of rows affected (1, in this case) in the procedure’s result set:
CREATE PROCEDURE sps_makeNULL()
BEGIN SQLPStatement insert_sfns1 = new SQLPStatement ("INSERT INTO sfns (fld_ref,small_fld,int_fld,doub_fld,char_fld,vchar_fld) values (?,?,?,?,?,?)" ); insert_sfns1.setParam(1,new Integer(666)); insert_sfns1.makeNULL(2); insert_sfns1.makeNULL(3); insert_sfns1.makeNULL(4); insert_sfns1.makeNULL(5); insert_sfns1.makeNULL(6); insert_sfns1.execute();END
CREATE PROCEDURE sis_rowCount()RESULT ( ins_recs INTEGER )
BEGIN SQLPStatement insert_test103 = new SQLPStatement ( "INSERT INTO test103 (fld1) values (17)"); insert_test103.execute(); SQLResultSet.set(1,new Long(insert_test103.rowCount())); SQLResultSet.insert();END
267
Java Class Reference
SQLPStatement.setParam
Sets the value of an SQL statement’s input parameter to the specified value (a literal, procedure variable, or procedure input parameter). This method is common to the SQLCursor, SQLIStatement, and SQLPStatement classes.
Format
public void setParam(int f, Object val)
Returns
None
Parameters
f
An integer that specifies which parameter marker in the SQL statement is to receive the value (1 denotes the first parameter marker, 2 denotes the second, and so on).
val
A literal or the name of a variable or input parameter that contains the value to be assigned to the parameter marker.
Throws
DhSQLException
Example This code fragment illustrates SQLPStatement.setParam:
CREATE PROCEDURE sps_setParam()
BEGIN// Assign local variables to be used as// SQL input parameter references Integer ins_fld_ref = new Integer(1); Integer ins_small_fld = new Integer(3200); Integer ins_int_fld = new Integer(21474); Double ins_doub_fld = new Double(1.797E+30); String ins_char_fld = new String("Athula"); String ins_vchar_fld = new String("Scientist"); Float ins_real_fld = new Float(17); SQLPStatement insert_sfns1 = new SQLPStatement ("INSERT INTO sfns (fld_ref,small_fld,int_fld,doub_fld,char_fld,vchar_fld) values (?,?,?,?,?,?)" ); insert_sfns1.setParam(1,ins_fld_ref); insert_sfns1.setParam(2,ins_small_fld); insert_sfns1.setParam(3,ins_int_fld); insert_sfns1.setParam(4,ins_doub_fld); insert_sfns1.setParam(5,ins_char_fld); insert_sfns1.setParam(6,ins_vchar_fld); insert_sfns1.execute();END
268
JDBC Conformance Notes
This section details the DataDirect JDBC driver’s support for the JDBC standard. Information presented in this section includes:
• Supported data types
• Return values for DatabaseMetaData
Supported data types
The Data Direct JDBC Driver supports standard JDBC mapping of JDBC data types to corresponding Java data types.
In the JDBC methods CallableStatement.getXXX and PreparedStatement.setXXX methods, XXX is a Java type:
• For setXXX methods, the driver converts the Java data type to the JDBC data type shown in Table 59 before sending it to the database.
Table 59 provides details on data type mapping between Java and JDBC data types.
Table 59: Mapping between Java and JDBC data types (1 of 2)
Java data type JDBC data type
Boolean BIT
Byte TINYINT
byte [ ] LONGVARBINARY
byte [ ] VARBINARY
Supported data types
• For getXXX methods, the driver converts the JDBC data type returned by the database to the Java data type shown in Table 60, Table 61, and Table 62 before returning it to the getXXX method.
Table 60 details mapping between JDBC and Java data types.
Table 61 details mapping between SQL-92 and Java data types.
double DOUBLE
float REAL
Int INTEGER
java.math.BigDecimal NUMERIC, DECIMAL
java.sql.Date DATE
java.sql.Time TIME
java.sql.Timestamp TIMESTAMP
Short SMALLINT
String VARCHAR
Table 59: Mapping between Java and JDBC data types (2 of 2)
Java data type JDBC data type
Table 60: Mapping between JDBC and Java data types
JDBC data type Java data type
BIT boolean
CHAR String
DECIMAL java.math.BigDecimal
INTEGER int
NUMERIC java.math.BigDecimal
SMALLINT short
TINYINT byte
VARCHAR String
Table 61: Mapping between SQL-92 and Java data types (1 of 2)
SQL-92 data type Java data type
BINARY byte[ ]
BIT boolean
270
Supported data types
Table 62 provides information on JDBC data type conversion.
CHAR, VARCHAR String
DATE java.sql.Date
DECIMAL java.math.BigDecimal
DOUBLE PRECISION Double
FLOAT Float
INTEGER Integer
LONGVARBINARY byte[ ]
NUMERIC java.math.BigDecimal
REAL Float
SMALLINT short
TIME java.sql.Time
TIMESTAMP java.sql.Timestamp
TINYINT byte[ ]
VARBINARY byte[ ]
Table 61: Mapping between SQL-92 and Java data types (2 of 2)
SQL-92 data type Java data type
Table 62: JDBC data type conversion (1 of 2)
JDBC data type Converts to . . .
BIGINT CHAR, DOUBLE, FLOAT, INTEGER, SMALLINT, TINYINT
BINARY Does not convert to any other data type
BIT Does not convert to any other data type
CHAR BIGINT, DATE. DECIMAL, DOUBLE, FLOAT, INTEGER, NUMERIC, REAL, SMALLINT, TIME, TIMESTAMP, TINYINT, VARCHAR
DATE CHAR, TIMESTAMP, VARCHAR
DECIMAL BIGINT, CHAR, DOUBLE, FLOAT, INTEGER, NUMERIC, REAL, SMALLINT, TINYINT, VARCHAR
DOUBLE BIGINT, CHAR, DECIMAL, FLOAT, INTEGER, NUMERIC, REAL, SMALLINT, TINYINT, VARCHAR
271
Return values for DatabaseMetaData
Return values for DatabaseMetaData
Applications call methods of the DatabaseMetaData class to retrieve details about the JDBC support provided by the OpenEdge™ SQL JDBC driver.
Table 63 lists each method of the DatabaseMetaData class and shows what the JDBC driver returns when an application calls the method. For details on the format and usage of each method, see the Java Core API documentation for your platform. Many of the methods return lists of information as an object of type ResultSet. Use the normal ResultSet methods, such as getString and getInt, to retrieve the data from the result sets.
FLOAT BIGINT, CHAR, DECIMAL, FLOAT, INTEGER, NUMERIC, REAL, SMALLINT, TINYINT, VARCHAR
INTEGER BIGINT, CHAR, DECIMAL, DOUBLE, FLOAT, NUMERIC, REAL, SMALLINT, TINYINT, VARCHAR
LONGVARBINARY Does not convert to any other data type
LONGVARCHAR Does not convert to any other data type
NUMERIC BIGINT, CHAR, DECIMAL, DOUBLE, FLOAT, INTEGER, REAL, SMALLINT, TINYINT, VARCHAR
REAL BIGINT, CHAR, DECIMAL, DOUBLE, FLOAT, INTEGER, NUMERIC, SMALLINT, TINYINT, VARCHAR
SMALLINT BIGINT, CHAR, DECIMAL, DOUBLE, FLOAT, INTEGER, NUMERIC, REAL, TINYINT, VARCHAR
TIME CHAR, TIMESTAMP
TIMESTAMP CHAR, DATE, TIME, VARCHAR
TINYINT BIGINT, CHAR, DECIMAL, DOUBLE, FLOAT, INTEGER, NUMERIC, REAL, SMALLINT, VARCHAR
VARBINARY Does not convert to any other data type
VARCHAR BIGINT, CHAR, DATE, DECIMAL, DOUBLE, FLOAT, INTEGER, NUMERIC, REAL, SMALLINT, TIME, TIMESTAMP, TINYINT
Table 62: JDBC data type conversion (2 of 2)
JDBC data type Converts to . . .
272
Return values for DatabaseMetaData
Table 63: Return values for DatabaseMetaData methods (1 of 11)
Method Description Returns
allProceduresAreCallable() Can all the procedures returned by getProcedures be called by the current user?
False
allTablesAreSelectable() Can all the tables returned by getTable be SELECTed by the current user?
False
dataDefinitionCausesTransactionCommit()
Does a data definition statement within a transaction force the transaction to commit?
True
dataDefinitionIgnoredInTransactions()
Is a data definition statement within a transaction ignored?
False
doesMaxRowSizeIncludeBlobs() Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY BLOBs?
False
getBestRowIdentifier(String, String, String, int, boolean)
Gets a description of a table’s optimal set of columns that uniquely identifies a row.
(Result set)
getCatalogs() Gets the catalog names available in this database.
(Result set)
getCatalogSeparator() What is the separator between catalog and table names?
None
No catalogs
getCatalogTerm() What is the database vendor’s preferred term for catalog?
None
No catalogs
getColumnPrivileges(String, String, String, String)
Gets a description of the access rights for a table’s columns.
(Result set)
getColumns(String, String, String, String)
Gets a description of table columns available in a catalog.
(Result set)
273
Return values for DatabaseMetaData
getCrossReference(String, String, String, String, String, String)
Gets a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table (describes how one table imports another’s key). This should normally return a single foreign key/primary key pair (most tables only import a foreign key from a table once). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.
(Result set)
getDatabaseProductName() What is the name of this database product?
OPENEDGE
getDatabaseProductVersion() What is the version of this database product?
10.0A1B
getDefaultTransactionIsolation() What is the database’s default transaction isolation level? The values are defined in java.sql.Connection.
TRANSACTION_READ_COMMITTED
getDriverMajorVersion() What is the version of this JDBC driver?
1
getDriverMinorVersion() What is the minor version of this JDBC driver?
1000
getDriverName() What is the name of this JDBC driver?
OpenEdge
getDriverVersion() What is the version of this JDBC driver?
4.0.00 5805 (040318.014802)
getExportedKeys(String, String, String)
Gets a description of the foreign key columns that reference a table’s primary key columns (the foreign keys exported by a table).
(Result set)
getExtraNameCharacters() Gets all the extra characters that can be used in unquoted identifier names (those beyond a–z, A–Z, 0–9 and _).
“_”, “%”
Table 63: Return values for DatabaseMetaData methods (2 of 11)
Method Description Returns
274
Return values for DatabaseMetaData
getIdentifierQuoteString () What is the string used to quote SQL identifiers? This returns a space“ ” if identifier quoting is not supported.
“ ”
getImportedKeys(String, String, String)
Gets a description of the primary key columns that reference a table’s foreign key columns (the primary keys imported by a table).
(Result set)
getIndexInfo(String, String, String, boolean, boolean)
Gets a description of a table’s indices and statistics.
(Result set)
getMaxBinaryLiteralLength() How many hex characters can you have in an inline binary literal?
31983
getMaxCatalogNameLength() What is the maximum length of a catalog name?
None
No catalogs
getMaxCharLiteralLength() What is the maximum length for a character literal?
31983
getMaxColumnNameLength() What is the limit on column name length?
32
getMaxColumnsInGroupBy() What is the maximum number of columns in a GROUP BY clause?
499
getMaxColumnsInIndex() What is the maximum number of columns allowed in an index?
16
getMaxColumnsInOrderBy() What is the maximum number of columns in an ORDER BY clause?
0
getMaxColumnsInSelect() What is the maximum number of columns in a SELECT list?
500
getMaxColumnsInTable() What is the maximum number of columns in a table?
500
getMaxConnections() How many active connections can we have at a time to this database?
0
getMaxCursorNameLength() What is the maximum cursor name length?
18
Table 63: Return values for DatabaseMetaData methods (3 of 11)
Method Description Returns
275
Return values for DatabaseMetaData
getMaxIndexLength() What is the maximum length of an index (in bytes)?
113
getMaxProcedureNameLength() What is the maximum length of a procedure name?
32
getMaxRowSize() What is the maximum length of a single row?
31,995 bytes
getMaxSchemaNameLength() What is the maximum length allowed for a schema name?
32
getMaxStatementLength() What is the maximum length of an SQL statement?
131,000
getMaxStatements() How many active statements can we have open at one time to this database?
100
getMaxTableNameLength() What is the maximum length of a table name?
32
getMaxTablesInSelect() What is the maximum number of tables in a SELECT?
250
getMaxUserNameLength() What is the maximum length of a user name?
32
getNumericFunctions() Gets a comma-separated list of math functions.
ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, DEGREES, EXP, FLOOR, LOG10, MOD, PI, POWER, RADIANS, RAND, ROUND, SIGN,SIN, SQRT, TAN
getPrimaryKeys(String, String, String)
Gets a description of a table’s primary key columns.
(Result set)
getProcedureColumns(String, String, String, String)
Get a description of a catalog’s stored procedure parameters and result columns.
(Result set)
getProcedures(String, String, String)
Gets a description of stored procedures available in a catalog.
(Result set)
getProcedureTerm() What is the database vendor’s preferred term for procedure?
procedure
getSchemas() Gets the schema names available in this database.
(Result set)
Table 63: Return values for DatabaseMetaData methods (4 of 11)
Method Description Returns
276
Return values for DatabaseMetaData
getSchemaTerm() What is the database vendor’s preferred term for schema?
Owner
getSearchStringEscape() This is the string that can be used to escape ‘_’ or ‘%’ in the string pattern style catalog search parameters.
\
getSQLKeywords() Gets a comma-separated list of all a database’s SQL keywords that are NOT also SQL keywords.
See the OpenEdge SQL Reserved Words section for a complete list of reserved words.
getStringFunctions() Gets a comma-separated list of string functions.
ASCII, CHAR, CONCAT, DIFFERENCE,INSERT, LCASE, LEFT, LENGTH, LOCATE, LOCATE-2, LTRIM, REPEAT, REPLACE, RIGHT, RTRIM, SPACE, SUBSTRING, UCASE
getSystemFunctions() Gets a comma-separated list of system functions.
USERNAME, IFNULL, DBNAME
getTablePrivileges(String, String, String)
Gets a description of the access rights for each table available in a catalog.
(Result set)
getTables(String, String, String, String [])
Gets a description of tables available in a catalog.
(Result set)
getTableTypes() Gets the table types available in this database.
(Result set)
getTimeDateFunctions() Gets a comma-separated list of time and date functions.
CURDATE, CURTIME, DAYNAME, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, HOUR, MINUTE, SECOND, MONTHNAME, NOW, TIMESTAMPADD, TIMESTAMPDIFF
getTypeInfo() Gets a description of all the standard SQL types supported by this database.
(Result set)
getURL() What is the URL for this database?
(The URL)
getUserName() What is our user name as known to the database?
(User name)
getVersionColumns(String, String, String)
Gets a description of a table’s columns that are automatically updated when any value in a row is updated.
(Result set)
Table 63: Return values for DatabaseMetaData methods (5 of 11)
Method Description Returns
277
Return values for DatabaseMetaData
isCatalogAtStart() Does a catalog appear at the start of a qualified table name? Otherwise it appears at the end.
False
isReadOnly() Is the database in read-only mode?
False
nullPlusNonNullIsNull() Are concatenations between NULL and non-NULL values NULL? A JDBC-compliant driver always returns true.
True
nullsAreSortedAtEnd() Are NULL values sorted at the end regardless of sort order?
False
nullsAreSortedAtStart() Are NULL values sorted at the start regardless of sort order?
False
nullsAreSortedHigh() Are NULL values sorted high? True
nullsAreSortedLow() Are NULL values sorted low? False
storesLowerCaseIdentifiers() Does the database treat mixed-case, unquoted SQL identifiers as case insensitive and store them in lowercase?
False
storesLowerCaseQuotedIdentifiers() Does the database treat mixed-case, quoted SQL identifiers as case insensitive and store them in lowercase?
False
storesMixedCaseIdentifiers() Does the database treat mixed-case, unquoted SQL identifiers as case insensitive and store them in mixed case?
False
storesMixedCaseQuotedIdentifiers() Does the database treat mixed-case, quoted SQL identifiers as case insensitive and store them in mixed case?
True
storesUpperCaseIdentifiers() Does the database treat mixed-case, unquoted SQL identifiers as case insensitive and store them in uppercase?
True
Table 63: Return values for DatabaseMetaData methods (6 of 11)
Method Description Returns
278
Return values for DatabaseMetaData
storesUpperCaseQuotedIdentifiers() Does the database treat mixed-case, quoted SQL identifiers as case insensitive and store them in uppercase?
False
supportsAlterTableWithAddColumn() Is ALTER TABLE with add column supported?
False
supportsAlterTableWithDropColumn() Is ALTER TABLE with drop column supported?
False
supportsANSI92EntryLevelSQL() Is the ANSI92 entry level SQL grammar supported? All JDBC-compliant drivers must return true.
True
supportsANSI92FullSQL() Is the ANSI92 full SQL grammar supported?
False
supportsANSI92IntermediateSQL() Is the ANSI92 intermediate SQL grammar supported?
False
supportsCatalogsInDataManipulation() Can a catalog name be used in a data manipulation statement?
False
supportsCatalogsInIndexDefinitions() Can a catalog name be used in an index definition statement?
False
supportsCatalogsInPrivilegeDefinitions()
Can a catalog name be used in a privilege definition statement?
False
supportsCatalogsInProcedureCalls() Can a catalog name be used in a procedure call statement?
False
supportsCatalogsInTableDefinitions() Can a catalog name be used in a table definition statement?
False
supportsColumnAliasing() Is column aliasing supported? If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required.
True
supportsConvert() Is the CONVERT function between SQL types supported?
True
supportsConvert(int, int) Is CONVERT between the given SQL types supported?
True
Table 63: Return values for DatabaseMetaData methods (7 of 11)
Method Description Returns
279
Return values for DatabaseMetaData
supportsCoreSQLGrammar() Is the ODBC Core SQL grammar supported?
True
supportsCorrelatedSubqueries() Are correlated subqueries supported? A JDBC-compliant driver always returns true.
True
supportsDataDefinitionAndDataManipulationTransactions ()
Are both data definition and data manipulation statements within a transaction supported?
True
supportsDataManipulationTransactionsOnly()
Are only data manipulation statements within a transaction supported?
False
supportsDifferentTableCorrelationNames()
If table correlation names are supported, are they restricted to be different from the names of the tables?
True
supportsExpressionsInOrderBy() Are expressions in ORDER BY lists supported?
True
supportsExtendedSQLGrammar() Is the ODBC Extended SQL grammar supported?
True
supportsFullOuterJoins() Are full nested outer joins supported?
False
supportsGroupBy() Is some form of GROUP BY clause supported?
True
supportsGroupByBeyondSelect() Can a GROUP BY clause add columns not in the SELECT provided it specifies all the columns in the SELECT?
True
supportsGroupByUnrelated() Can a GROUP BY clause use columns not in the SELECT?
False
supportsIntegrityEnhancementFacility()
Is the SQL Integrity Enhancement Facility supported?
True
supportsLikeEscapeClause() Is the escape character in LIKE clauses supported? A JDBC-compliant driver always returns true.
True
Table 63: Return values for DatabaseMetaData methods (8 of 11)
Method Description Returns
280
Return values for DatabaseMetaData
supportsLimitedOuterJoins() Is there limited support for outer joins? (This will be true if supportFullOuterJoins is true.)
False
supportsMinimumSQLGrammar() Is the ODBC Minimum SQL grammar supported? All JDBC-compliant drivers must return true.
True
supportsMixedCaseIdentifiers() Does the database treat mixed-case, unquoted SQL identifiers as case sensitive and as a result store them in mixed case? A JDBC-compliant driver will always return false.
False
supportsMixedCaseQuotedIdentifiers() Does the database treat mixed-case, quoted SQL identifiers as case sensitive and as a result store them in mixed case? A JDBC-compliant driver will always return true.
True
supportsMultipleResultSets() Are multiple ResultSets from a single execute supported?
False
supportsMultipleTransactions() Can multiple transactions be open at once (on different connections)?
True
supportsNonNullableColumns() Can columns be defined as non-nullable? A JDBC-compliant driver always returns true.
True
supportsOpenCursorsAcrossCommit() Can cursors remain open across commits?
True
supportsOpenCursorsAcrossRollback() Can cursors remain open across rollbacks?
True
supportsOpenStatementsAcrossCommit() Can statements remain open across commits?
True
supportsOpenStatementsAcrossRollback()
Can statements remain open across rollbacks?
True
supportsOrderByUnrelated() Can an ORDER BY clause use columns not in the SELECT?
False
supportsOuterJoins() Is some form of outer join supported?
True
Table 63: Return values for DatabaseMetaData methods (9 of 11)
Method Description Returns
281
Return values for DatabaseMetaData
supportsPositionedDelete() Is positioned DELETE supported?
True
supportsPositionedUpdate() Is positioned UPDATE supported?
True
supportsSchemasInDataManipulation() Can a schema name be used in a data manipulation statement?
True
supportsSchemasInIndexDefinitions() Can a schema name be used in an index definition statement?
True
supportsSchemasInPrivilegeDefinitions()
Can a schema name be used in a privilege definition statement?
True
supportsSchemasInProcedureCalls() Can a schema name be used in a procedure call statement?
True
supportsSchemasInTableDefinitions() Can a schema name be used in a table definition statement?
True
supportsSelectForUpdate() Is SELECT for UPDATE supported?
True
supportsStoredProcedures() Are stored procedure calls using the stored procedure escape syntax supported?
True
supportsSubqueriesInComparisons() Are subqueries in comparison expressions supported? A JDBC-compliant driver always returns true.
True
supportsSubqueriesInExists() Are subqueries in EXISTS expressions supported? A JDBC-compliant driver always returns true.
True
supportsSubqueriesInIns() Are subqueries in IN statements supported? A JDBC-compliant driver always returns true.
True
supportsSubqueriesInQuantifieds() Are subqueries in quantified expressions supported? A JDBC-compliant driver always returns true.
True
Table 63: Return values for DatabaseMetaData methods (10 of 11)
Method Description Returns
282
Return values for DatabaseMetaData
Example The following example is a code segment that illustrates calling methods of DatabaseMetadata:
supportsTableCorrelationNames() Are table correlation names supported? A JDBC-compliant driver always returns true.
True
supportsTransactionIsolationLevel(int)
Does the database support the given transaction isolation level?
True (for all four transaction levels)
supportsTransactions () Are transactions supported? If not, commit is a no-op and the isolation level is TRANSACTION_NONE.
True
supportsUnion() Is SQL UNION supported? True
supportsUnionAll() Is SQL UNION ALL supported?
True
usesLocalFilePerTable() Does the database use a file for each table?
False
usesLocalFiles() Does the database store tables in a local file?
False
Table 63: Return values for DatabaseMetaData methods (11 of 11)
Method Description Returns
Connection con = DriverManager.getConnection ( url, prop);
. . .
// Get the DatabaseMetaData object and display // some information about the connection DatabaseMetaData dma = con.getMetaData ();
o.println("\nConnected to " + dma.getURL()); o.println("Driver " + dma.getDriverName()); o.println("Version " + dma.getDriverVersion());
283
Return values for DatabaseMetaData
284
Part III
ODBC Reference
OpenEdge SQL and ODBC Data Types
SQLGetInfo
ODBC Scalar Functions
OpenEdge SQL and ODBC Data Types
This section contains Table 64, which shows how the OpenEdge SQL data types are mapped to the standard ODBC data types:
Table 64: OpenEdge SQL and ODBC data types
Progress data type ODBC data type
BINARY SQL_BINARY
BIT SQL_BIT
CHAR SQL_CHAR
DATE SQL_TYPE_DATE
DECIMAL SQL_DECIMAL
DOUBLE PRECISION SQL_DOUBLE
FLOAT SQL_FLOAT
INTEGER SQL_INTEGER
REAL SQL_FLOAT
SMALLINT SQL_SMALLINT
TIME SQL_TYPE_TIME
TIMESTAMP SQL_TYPE_TIMESTAMP
TINYINT SQL_TINYINT
VARBINARY SQL_VARBINARY
LVARBINARY SQL_LONGVARBINARY
VARCHAR SQL_VARCHAR
OpenEdge SQL and ODBC Data Types
288
SQLGetInfo
This section details the information the ODBC Driver returns to SQLGetInfo.
Table 65 describes return values the ODBC driver returns to SQLGetInfo.
Table 65: Information the ODBC driver returns to SQLGetInfo (1 of 19)
Description fInfoType argument Returns
Guaranteed execute privileges on all procedures returned by SQLProcedures
SQL_ACCESSIBLE_PROCEDURES N
Guaranteed read access to all table names returned by SQLTables
SQL_ACCESSIBLE_TABLES N
Maximum number of active connections
SQL_ACTIVE_CONNECTIONS 0
Maximum number of active statements supported for an active connection
SQL_ACTIVE_STATEMENTS 100
Maximum number of active environments
SQL_ACTIVE_ENVIRONMENTS 0
Support for ALTER DOMAIN statement
SQL_ALTER_DOMAIN 0x00000000
SQLGetInfo
Support for ALTER TABLE clauses
SQL_ALTER_TABLE 0x00000000
SQL Conformance SQL_SQL_CONFORMANCE SQL_SC_SQL92_ENTRY
Support for datetime literals
SQL_DATETIME_LITERALS 0x00000000
Level of asynchronous mode support
SQL_ASYNC_MODE SQL_AM_NONE
Behavior with respect to the availability of row counts in batches
SQL_BATCH_ROW_COUNT 0x00000000
Support for batches SQL_BATCH_SUPPORT 0x00000000
Support for bookmarks
SQL_BOOKMARK_PERSISTENCE SQL_BP_UPDATE SQL_BP_SCROLL
Position of qualifier in a qualified table name
SQL_CATALOG_LOCATION SQL_CL_START
Support for catalog names
SQL_CATALOG_NAME Y
Character used to separate table, column qualifiers
SQL_CATALOG_NAME_SEPARATOR “ .”
Term for object that qualifies table names
SQL_CATALOG_TERM “database”
Statements that support qualifiers
SQL_CATALOG_USAGE SQL_CU_DML_STATEMENTS
SQL_CU_PROCEDURE_INVOCATION
Default collation sequence name for the default character set
SQL_COLLATION_SEQ “ ”
Support for column aliases
SQL_COLUMN_ALIAS Y
Result of concatenation of NULL character column with non-NULL column
SQL_CONCAT_NULL_BEHAVIOR SQL_CB_NULL = 0
Table 65: Information the ODBC driver returns to SQLGetInfo (2 of 19)
Description fInfoType argument Returns
290
SQLGetInfo
Conversion from BIGINT
SQL_CONVERT_BIGINT SQL_CVT_CHARSQL_CVT_BIGINTSQL_CVT_TINYINTSQL_CVT_SMALLINTSQL_CVT_INTEGERSQL_CVT_FLOATSQL_CVT_DOUBLE
Conversion from BINARY
SQL_CONVERT_BINARY 0x00000000
Conversion from BIT
SQL_CONVERT_BIT 0x00000000
Conversion from CHAR
SQL_CONVERT_CHAR SQL_CVT_CHAR SQL_CVT_NUMERIC SQL_CVT_DECIMAL SQL_CVT_INTEGER SQL_CVT_SMALLINT SQL_CVT_FLOAT SQL_CVT_REAL SQL_CVT_DOUBLE SQL_CVT_VARCHAR SQL_CVT_TINYINT SQL_CVT_BIGINT SQL_CVT_DATE SQL_CVT_TIME SQL_CVT_TIMESTAMP
Conversion from DATE
SQL_CONVERT_DATE SQL_CVT_CHAR SQL_CVT_VARCHAR SQL_CVT_DATE SQL_CVT_TIMESTAMP
Conversion from DECIMAL
SQL_CONVERT_DECIMAL SQL_CVT_CHAR SQL_CVT_NUMERIC SQL_CVT_DECIMAL SQL_CVT_INTEGER SQL_CVT_SMALLINT SQL_CVT_FLOAT SQL_CVT_REAL SQL_CVT_DOUBLE SQL_CVT_VARCHAR SQL_CVT_TINYINT SQL_CVT_BIGINT
Conversion from DOUBLE
SQL_CONVERT_DOUBLE SQL_CVT_CHAR SQL_CVT_NUMERIC SQL_CVT_DECIMAL SQL_CVT_INTEGER SQL_CVT_SMALLINT SQL_CVT_FLOAT SQL_CVT_REAL SQL_CVT_DOUBLE SQL_CVT_VARCHAR SQL_CVT_TINYINT SQL_CVT_BIGINT
Table 65: Information the ODBC driver returns to SQLGetInfo (3 of 19)
Description fInfoType argument Returns
291
SQLGetInfo
Conversion from FLOAT
SQL_CONVERT_FLOAT SQL_CVT_CHAR SQL_CVT_NUMERIC SQL_CVT_DECIMAL SQL_CVT_INTEGER SQL_CVT_SMALLINT SQL_CVT_FLOAT SQL_CVT_REAL SQL_CVT_DOUBLE SQL_CVT_VARCHAR SQL_CVT_TINYINT SQL_CVT_BIGINT
Support for conversion functions
SQL_CONVERT_FUNCTIONS SQL_FN_CVT_CONVERT
Conversion from INTEGER
SQL_CONVERT_INTEGER SQL_CVT_CHAR SQL_CVT_NUMERIC SQL_CVT_DECIMAL SQL_CVT_INTEGER SQL_CVT_SMALLINT SQL_CVT_FLOAT SQL_CVT_REAL SQL_CVT_DOUBLE SQL_CVT_VARCHAR SQL_CVT_TINYINT SQL_CVT_BIGINT
Conversion from INTERVAL_DAY_TIME
SQL_CONVERT_INTERVAL_DAY_TIME
0x00000000
Conversion from INTERVAL_YEAR_MONTH
SQL_CONVERT_INTERVAL_YEAR_MONTH
0x00000000
Conversion from INTERVAL_DAY_TIME
SQL_CONVERT_INTERVAL_DAY_TIME
0x00000000
Conversion from LONGVARBINARY.
SQL_CONVERT_LONGVARBINARY 0x00000000
Conversion from LONGVARCHAR
SQL_CONVERT_LONGVARCHAR 0x00000000
Conversion from NUMERIC
SQL_CONVERT_NUMERIC SQL_CVT_CHAR SQL_CVT_NUMERIC SQL_CVT_DECIMAL SQL_CVT_INTEGER SQL_CVT_SMALLINT SQL_CVT_FLOAT SQL_CVT_REAL SQL_CVT_DOUBLE SQL_CVT_VARCHAR SQL_CVT_TINYINT SQL_CVT_BIGINT
Table 65: Information the ODBC driver returns to SQLGetInfo (4 of 19)
Description fInfoType argument Returns
292
SQLGetInfo
Conversion from REAL
SQL_CONVERT_REAL SQL_CVT_CHAR SQL_CVT_NUMERIC SQL_CVT_DECIMAL SQL_CVT_INTEGER SQL_CVT_SMALLINT SQL_CVT_FLOAT SQL_CVT_REAL SQL_CVT_DOUBLE SQL_CVT_VARCHAR SQL_CVT_TINYINT SQL_CVT_BIGINT
Conversion from SMALLINT
SQL_CONVERT_SMALLINT SQL_CVT_CHAR SQL_CVT_NUMERIC SQL_CVT_DECIMAL SQL_CVT_INTEGER SQL_CVT_SMALLINT SQL_CVT_FLOAT SQL_CVT_REAL SQL_CVT_DOUBLE SQL_CVT_VARCHAR SQL_CVT_TINYINT SQL_CVT_BIGINT
Conversion from TIME
SQL_CONVERT_TIME SQL_CVT_CHAR SQL_CVT_TIME SQL_CVT_TIMESTAMP
Conversion from TIMESTAMP
SQL_CONVERT_TIMESTAMP SQL_CVT_CHAR SQL_CVT_VARCHARSQL_CVT_DATE SQL_CVT_TIME SQL_CVT_TIMESTAMP
Conversion from TINYINT
SQL_CONVERT_TINYINT SQL_CVT_CHAR SQL_CVT_NUMERIC SQL_CVT_DECIMAL SQL_CVT_INTEGER SQL_CVT_SMALLINT SQL_CVT_FLOAT SQL_CVT_REAL SQL_CVT_DOUBLE SQL_CVT_VARCHARSQL_CVT_TINYINT SQL_CVT_BIGINT
Conversion from VARBINARY
SQL_CONVERT_VARBINARY 0x00000000
Conversion from VARCHAR
SQL_CONVERT_VARCHAR SQL_CVT_CHAR SQL_CVT_NUMERIC SQL_CVT_DECIMAL SQL_CVT_INTEGER SQL_CVT_SMALLINT SQL_CVT_FLOAT SQL_CVT_REAL SQL_CVT_DOUBLE SQL_CVT_VARCHARSQL_CVT_TINYINT SQL_CVT_BIGINT SQL_CVT_DATE SQL_CVT_TIME SQL_CVT_TIMESTAMP
Table 65: Information the ODBC driver returns to SQLGetInfo (5 of 19)
Description fInfoType argument Returns
293
SQLGetInfo
Conversion from WCHAR
SQL_CONVERT_WCHAR 0x00000000
Conversion from WLONGVARCHAR
SQL_CONVERT_WLONGVARCHAR 0x00000000
Conversion from WVARCHAR
SQL_CONVERT_WVARCHAR 0x00000000
Support for table correlation names
SQL_CORRELATION_NAME SQL_CN_DIFFERENT
Support for CREATE ASSERTION statement
SQL_CREATE_ASSERTION 0x00000000
Support for CREATE CHARACTER SET statement.
SQL_CREATE_CHARACTER SET 0x00000000
Support for CREATE COLLATION statement
SQL_CREATE_COLLATION 0x00000000
Support for CREATE DOMAIN statement
SQL_CREATE_DOMAIN 0x00000000
Support for CREATE SCHEMA statement
SQL_CREATE_SCHEMA 0x00000000
Support for CREATE TABLE statement
SQL_CREATE_TABLE SQL_CT_CREATE_TABLE SQL_CT_COLUMN_CONSTRAINT SQL_CT_TABLE_CONSTRAINT
Support for CREATE TRANSLATION statement
SQL_CREATE_TRANSLATION 0x00000000
Support for CREATE VIEW statement
SQL_CREATE_VIEW SQL_CV_CREATE_VIEW SQL_CV_CHECK_OPTION
Effect of COMMIT operation on cursors and prepared statements
SQL_CURSOR_COMMIT_BEHAVIOR SQL_CB_PRESERVE
Effect of ROLLBACK operation on cursors and prepared statements
SQL_CURSOR_ROLLBACK_BEHAVIOR SQL_CB_PRESERVE
Support for cursor sensitivity
SQL_CURSOR_SENSITIVITY SQL_INSENSITIVE
Table 65: Information the ODBC driver returns to SQLGetInfo (6 of 19)
Description fInfoType argument Returns
294
SQLGetInfo
Name of the data source as specified to the ODBC Administrator
SQL_DATA_SOURCE_NAME (String containing the name)
Access limited to read-only
SQL_DATA_SOURCE_READ_ONLY N (Read-write access)
Name of the Progress SQL-92 ODBC data source on the server system
SQL_DATABASE_NAME (String containing the name)
Name of the database product supporting the data source
SQL_DBMS_NAME OPENEDGE
Version of the database product
SQL_DBMS_VER 10.1B
Default transaction isolation level
SQL_DEFAULT_TXN_ISOLATION SQL_TXN_READ_COMMITTED
Support for describing parameters via DESCRIBE INPUT statement
SQL_DESCRIBE_PARAMETER Y (Supports)
Version of the driver manager
SQL_DM_VER 03.52.1117.0000
Connection handle determined by the argument InfoType
SQL_DRIVER_HDBC 0x017E4538
Driver’s descriptor handle determined by the Driver Manager’s descriptor handle
SQL_DRIVER_HDESC 0x017E68A8
Environment handle determined by the argument InfoType
SQL_DRIVER_HENV 0x017E4090
Handle library from the load library returned to the Driver Manager when it loaded the driver DLL
SQL_DRIVER_HLIB 0x28660000
Table 65: Information the ODBC driver returns to SQLGetInfo (7 of 19)
Description fInfoType argument Returns
295
SQLGetInfo
Driver’s statement handle determined by the Driver Manager’s statement handle
SQL_DRIVER_HSTMT 0x01828050
Name of the dynamic link library file for the ODBC Driver
SQL_DRIVER_NAME Windowspgoe1022.DLL
AIX, SOLARIS, LINUXpgoe1022.SO
HPIIXpgoe1022.SL
Supported ODBC version
SQL_DRIVER_ODBC_VER 03.52
Current version of the ODBC Driver
SQL_DRIVER_VER 05.20.0039 (b0034, u0022)
Support for DROP ASSERTION statement
SQL_DROP_ASSERTION 0x00000000
Support for DROP CHARACTER SET statement
SQL_DROP_CHARACTER_SET 0x00000000
Support for DROP COLLATION statement
SQL_DROP_COLLATION 0x00000000
Support for DROP DOMAIN statement
SQL_DROP_DOMAIN 0x00000000
Support for DROP SCHEMA statement
SQL_DROP_SCHEMA 0x00000000
Support for DROP TABLE statement
SQL_DROP_TABLE SQL_DT_DROP_TABLE
Support for DROP TRANSLATION statement
SQL_DROP_TRANSLATION 0x00000000
Support for DROP VIEW statement
SQL_DROP_VIEW SQL_DV_DROP_VIEW
Supported attributes of a dynamic cursor: subset 1
SQL_DYNAMIC_CURSOR_ATTRIBUTES1
0x00000000
Supported attributes of a dynamic cursor: subset 2
SQL_DYNAMIC_CURSOR_ATTRIBUTES2
0x00000000
Table 65: Information the ODBC driver returns to SQLGetInfo (8 of 19)
Description fInfoType argument Returns
296
SQLGetInfo
Support for expressions in ORDER BY clause
SQL_EXPRESSIONS_IN_ORDERBY Y
Supported fetch direction option.
SQL_FETCH_DIRECTION SQL_FD_FETCH_NEXT SQL_FD_FETCH_FIRST SQL_FD_FETCH_LAST SQL_FD_FETCH_PRIOR SQL_FD_FETCH_ABSOLUTE SQL_FD_FETCH_RELATIVE SQL_FD_FETCH_BOOKMARK
Single-tier driver behavior
SQL_FILE_USAGE SQL_FILE_NOT_SUPPORTED
Supported attributes of a forward-only cursor: subset 1
SQL_FORWARD_ONLY_CURSOR_ATTRIBUTES1
SQL_CA1_NEXT SQL_CA1_BULK_ADD
Supported attributes of a forward-only cursor: subset 2
SQL_FORWARD_ONLY_CURSOR_ATTRIBUTES2
SQL_CA2_MAX_ROWS_SELECT SQL_CA2_MAX_ROWS_CATALOG
Supported extensions to SQLGetData
SQL_GETDATA_EXTENSIONS SQL_GD_ANY_COLUMN SQL_GD_ANY_ORDER SQL_GD_BLOCKSQL_GD_BOUND
Relationship between GROUP BY clause and columns in the select list
SQL_GROUP_BY SQL_GB_GROUP_BY_CONTAINS_SELECT
Case sensitivity of user-supplied names
SQL_IDENTIFIER_CASE SQL_IC_UPPER
Character used to enclose delimited identifiers
SQL_IDENTIFIER_QUOTE_CHAR " (Double quotation mark)
Keywords supported in the CREATE INDEX statement
SQL_INDEX_KEYWORDS SQL_IK_ASC |SQL_IK_DESC
Supported views in INFORMATION_SCHEMA
SQL_INFO_SCHEMA_VIEWS 0x00000000
Support for Integrity Enhancement Facility
SQL_INTEGRITY Y
Table 65: Information the ODBC driver returns to SQLGetInfo (9 of 19)
Description fInfoType argument Returns
297
SQLGetInfo
Supported attributes of a keyset cursor: subset 1
SQL_KEYSET_CURSOR_ATTRIBUTES1
SQL_CA1_NEXT SQL_CA1_ABSOLUTE SQL_CA1_RELATIVE SQL_CA1_BOOKMARKSQL_CA1_LOCK_NO_CHANGESQL_CA1_POS_POSITION SQL_CA1_POS_UPDATE SQL_CA1_POS_DELETE SQL_CA1_POS_REFRESH SQL_CA1_POSITIONED_UPDATE SQL_CA1_POSITIONED_DELETE SQL_CA1_SELECT_FOR_UPDATE SQL_CA1_BULK_ADD
Supported attributes of a keyset cursor: subset 2
SQL_KEYSET_CURSOR_ATTRIBUTES2
SQL_CA2_READ_ONLY_CONCURRENCY
SQL_CA2_OPT_VALUES_CONCURRENCY
SQL_CA2_SENSITIVITY_DELETIONS
SQL_CA2_SENSITIVITY_UPDATES
SQL_CA2_MAX_ROWS_SELECT
SQL_CA2_CRC_EXACT
SQL_CA2_SIMULATE_TRY_UNIQUE
Data source specific keywords
SQL_KEYWORDS See the OpenEdge SQL Reserved Words section for a list of SQL Keywords.
Support for escape clause in LIKE predicates
SQL_LIKE_ESCAPE_CLAUSE Y
Support for lock types
SQL_LOCK_TYPES SQL_LCK_NO_CHANGE
Maximum number of active concurrent statements in asynchronous mode
SQL_MAX_ASYNC_CONCURRENT_STATEMENTS
0
Maximum length in hexadecimal characters of binary literals
SQL_MAX_BINARY_LITERAL_LEN 31,983
Maximum length of a table or column qualifier
SQL_MAX_CATALOG_NAME_LEN 32
Table 65: Information the ODBC driver returns to SQLGetInfo (10 of 19)
Description fInfoType argument Returns
298
SQLGetInfo
Maximum length in characters of character string literals
SQL_MAX_CHAR_LITERAL_LEN 31,983
Maximum length of a column name
SQL_MAX_COLUMN_NAME_LEN 32
Maximum number of columns allowed in GROUP BY clause
SQL_MAX_COLUMNS_IN_GROUP_BY 5000
Maximum number of columns allowed in an index
SQL_MAX_COLUMNS_IN_INDEX 16
Maximum number of columns allowed in ORDER BY clause
SQL_MAX_COLUMNS_IN_ORDER_BY 0
Maximum number of columns allowed in a SELECT list
SQL_MAX_COLUMNS_IN_SELECT 5000
Maximum number of columns allowed in a table
SQL_MAX_COLUMNS_IN_TABLE 5000
Maximum number of active SQL statements
SQL_MAX_CONCURRENT_ACTIVITIES
100
Maximum length of a cursor name
SQL_MAX_CURSOR_NAME_LEN 18
Maximum number of active connections
SQL_MAX_DRIVER_CONNECTIONS 0
Maximum length of user-defined names
SQL_MAX_IDENTIFIER_LEN 32
Maximum number of bytes allowed in the combined fields of an index
SQL_MAX_INDEX_SIZE 115
Maximum length of a procedure name
SQL_MAX_PROCEDURE_NAME_LEN 32
Maximum length in bytes of a table row
SQL_MAX_ROW_SIZE 31995
Whether maximum row size includes LONGVARCHAR and LONGVARBINARY
SQL_MAX_ROW_SIZE_INCLUDES_LONG
N
Table 65: Information the ODBC driver returns to SQLGetInfo (11 of 19)
Description fInfoType argument Returns
299
SQLGetInfo
Maximum length of an owner name
SQL_MAX_SCHEMA_NAME_LEN 32
Maximum number of characters in an SQL statement
SQL_MAX_STATEMENT_LEN 131,000
Maximum length of a table name
SQL_MAX_TABLE_NAME_LEN 32
Maximum number of tables allowed in FROM clause
SQL_MAX_TABLES_IN_SELECT 250
Maximum length of a user name
SQL_MAX_USER_NAME_LEN 32
Maximum length of owner name
SQL_MAX_OWNER_NAME_LEN 32
Maximum length of a qualifier name
SQL_MAX_QUALIFIER_NAME_LEN 32
Support for multiple result sets
SQL_MULT_RESULT_SETS N
Support for active transactions on multiple connections
SQL_MULTIPLE_ACTIVE_TXN Y
Whether data source requires length of LONGVARCHAR and LONGVARBINARY data
SQL_NEED_LONG_DATA_LEN Y
Support for NOT NULL clause in CREATE TABLE statement
SQL_NON_NULLABLE_COLUMNS SQL_NNC_NON_NULL
Where NULL values are sorted in a list
SQL_NULL_COLLATION SQL_NC_HIGH
Table 65: Information the ODBC driver returns to SQLGetInfo (12 of 19)
Description fInfoType argument Returns
300
SQLGetInfo
Numeric functions supported
SQL_NUMERIC_FUNCTIONS SQL_FN_NUM_ABS SQL_FN_NUM_ACOS SQL_FN_NUM_ASIN SQL_FN_NUM_ATAN SQL_FN_NUM_ATAN2 SQL_FN_NUM_CEILING SQL_FN_NUM_COS SQL_FN_NUM_EXP SQL_FN_NUM_FLOOR SQL_FN_NUM_MOD SQL_FN_NUM_PI SQL_FN_NUM_POWER SQL_FN_NUM_RADIANS SQL_FN_NUM_RAND SQL_FN_NUM_ROUND SQL_FN_NUM_SIGN SQL_FN_NUM_SIN SQL_FN_NUM_SQRT SQL_FN_NUM_TAN SQL_FN_NUM_DEGREES SQL_FN_NUM_LOG10
Level of ODBC conformance
SQL_ODBC_API_CONFORMANCE SQL_OAC_LEVEL1
Level of ODBC 3.x interface conformance
SQL_ODBC_INTERFACE_CONFORMANCE
SQL_OIC_CORE
SQL Access Group (SAG) conformance
SQL_ODBC_SAG_CLI_CONFORMANCE SQL_OSCC_COMPLIANT
Level of SQL conformance
SQL_ODBC_SQL_CONFORMANCE SQL_OSC_EXTENDED
Referential integrity syntax support
SQL_ODBC_SQL_OPT_IEF Y
ODBC version supported by driver manager
SQL_ODBC_VER 03.52.0000
Types of outer joins supported
SQL_OJ_CAPABILITIES SQL_OJ_LEFT SQL_OJ_RIGHT SQL_OJ_NOT_ORDERED SQL_OJ_INNER SQL_OJ_ALL_COMPARISON_OPS
Whether columns in ORDER BY clause must also be in select list
SQL_ORDER_BY_COLUMNS_IN_SELECT
N
Support for outer joins
SQL_OUTER_JOINS Y
Name for an owner SQL_OWNER_TERM owner
Table 65: Information the ODBC driver returns to SQLGetInfo (13 of 19)
Description fInfoType argument Returns
301
SQLGetInfo
Statements in which owner can be used
SQL_OWNER_USAGE SQL_OU_DML_STATEMENTS
SQL_OU_PROCEDURE_INVOCATION
SQL_OU_TABLE_DEFINITION
SQL_OU_INDEX_DEFINITION
SQL_OU_PRIVILEGE_DEFINITION
Characteristics of row counts available in a parameterized execution
SQL_PARAM_ARRAY_ROW_COUNTS SQL_PARC_NO_BATCH
Characteristics of result sets available in a parameterized execution
SQL_PARAM_ARRAY_SELECTS SQL_PAS_NO_SELECT
Supported operations in SQLSetPos
SQL_POS_OPERATIONS SQL_POS_POSITION SQL_POS_REFRESH SQL_POS_UPDATE SQL_POS_DELETE SQL_POS_ADD
Supported positioned SQL statements
SQL_POSITIONED_STATEMENTS SQL_PS_POSITIONED_DELETE SQL_PS_POSITIONED_UPDATE SQL_PS_SELECT_FOR_UPDATE
Term for procedures
SQL_PROCEDURE_TERM procedure
SQL procedures support
SQL_PROCEDURES Y
Support for qualifiers
SQL_QUALIFIER_USAGE SQL_CU_DML_STATEMENTS
SQL_CU_PROCEDURE_INVOCATION
Case sensitivity of quoted user-supplied names
SQL_QUOTED_IDENTIFIER_CASE SQL_IC_MIXED
Separator character used between qualifier name and element
SQL_QUALIFIER_NAME_SEPARATOR “ . ”
Term used for a qualifier
SQL_QUALIFIER_TERM “database”
Table 65: Information the ODBC driver returns to SQLGetInfo (14 of 19)
Description fInfoType argument Returns
302
SQLGetInfo
Position of the qualifier in a qualified table name
SQL_QUALIFIER_LOCATION SQL_CL_START
Detect changes to any row in mixed-cursor operations
SQL_ROW_UPDATES Y
Term for entity that has owner privileges on objects
SQL_SCHEMA_TERM owner
Statements that support use of owner qualifiers
SQL_SCHEMA_USAGE SQL_OU_DML_STATEMENTS
SQL_OU_PROCEDURE_INVOCATION
SQL_OU_TABLE_DEFINITION
SQL_OU_INDEX_DEFINITION
SQL_OU_PRIVILEGE_DEFINITION
Options supported for scrollable cursors
SQL_SCROLL_OPTIONS SQL_SO_FORWARD_ONLY SQL_SO_STATIC SQL_SO_KEYSET_DRIVEN
Support for scrollable cursors
SQL_SCROLL_CONCURRENCY SQL_SCCO_READ_ONLY SQL_SCCO_OPT_VALUES
Character to permit wildcard characters in search strings
SQL_SEARCH_PATTERN_ESCAPE \ (Backslash)
Name of the system where the ODBC data source resides
SQL_SERVER_NAME (String containing the name)
Special characters allowed in user-supplied names
SQL_SPECIAL_CHARACTERS “_”, “%”
Datetime scalar functions supported
SQL_SQL92_DATETIME_FUNCTIONS 0x00000000
Behavior of DELETE statement that refers to a foreign key.
SQL_SQL92_FOREIGN_KEY_DELETE_RULE
0x00000000
Table 65: Information the ODBC driver returns to SQLGetInfo (15 of 19)
Description fInfoType argument Returns
303
SQLGetInfo
Behavior of UPDATE statement that refers to a foreign key
SQL_SQL92_FOREIGN_KEY_UPDATE_RULE
0x00000000
GRANT statement clauses supported
SQL_SQL92_GRANT SQL_SG_DELETE_TABLE SQL_SG_INSERT_TABLE SQL_SG_INSERT_COLUMN SQL_SG_REFERENCES_TABLE SQL_SG_REFERENCES_COLUMN SQL_SG_SELECT_TABLE SQL_SG_UPDATE_TABLE SQL_SG_UPDATE_COLUMN
Numeric scalar functions supported
SQL_SQL92_NUMERIC_VALUE_FUNCTIONS
SQL_SNVF_CHAR_LENGTH
SQL_SNVF_CHARACTER_LENGTH
Predicates supported
SQL_SQL92_PREDICATES SP_EXISTS SQL_SP_ISNOTNULL SQL_SP_ISNULL SQL_SP_UNIQUE SQL_SP_LIKE SQL_SP_IN SQL_SP_BETWEEN
Relational join operators supported
SQL_SQL92_RELATIONAL_JOIN_OPERATORS
0x00000000
REVOKE statement clauses supported
SQL_SQL92_REVOKE SQL_SR_GRANT_OPTION_FOR SQL_SR_CASCADESQL_SR_RESTRICTSQL_SR_DELETE_TABLE SQL_SR_INSERT_TABLE SQL_SR_INSERT_COLUMN SQL_SR_REFERENCES_TABLE SQL_SR_REFERENCES_COLUMN SQL_SR_SELECT_TABLE SQL_SR_UPDATE_TABLE SQL_SR_UPDATE_COLUMN
Row value constructor expressions supported
SQL_SQL92_ROW_VALUE_CONSTRUCTOR
0x00000000
String scalar functions supported
SQL_SQL92_STRING_FUNCTIONS SQL_SSF_CONVERT SQL_SSF_LOWER SQL_SSF_UPPER SQL_SSF_SUBSTRING SQL_SSF_TRANSLATE SQL_SSF_TRIM_LEADING SQL_SSF_TRIM_TRAILING
Value expressions supported
SQL_SQL92_VALUE_EXPRESSIONS SQL_SVE_COALESCE SQL_SVE_NULLIF
CLI standards to which the driver conforms
SQL_STANDARD_CLI_CONFORMANCE SQL_SCC_XOPEN_CLI_VERSION1
Table 65: Information the ODBC driver returns to SQLGetInfo (16 of 19)
Description fInfoType argument Returns
304
SQLGetInfo
Supported attributes of a static cursor: subset 1
SQL_STATIC_CURSOR_ATTRIBUTES1
SQL_CA1_NEXT SQL_CA1_ABSOLUTE SQL_CA1_RELATIVE SQL_CA1_BOOKMARK SQL_CA1_LOCK_NO_CHANGE SQL_CA1_POS_POSITION SQL_CA1_POS_UPDATE SQL_CA1_POS_DELETE SQL_CA1_POS_REFRESHSQL_CA1_POSITIONED_UPDATE SQL_CA1_POSITIONED_DELETE SQL_CA1_SELECT_FOR_UPDATE SQL_CA1_BULK_ADD
Supported attributes of a static cursor: subset 2
SQL_STATIC_CURSOR_ATTRIBUTES2
SQL_CA2_READ_ONLY_CONCURRENCY
SQL_CA2_OPT_VALUES_CONCURRENCY
SQL_CA2_SENSITIVITY_UPDATES
SQL_CA2_MAX_ROWS_SELECT
SQL_CA2_CRC_EXACT
SQL_CA2_SIMULATE_TRY_UNIQUE
Support for detection of changes made to a static or key-set driven cursor through SQLSetPos
SQL_STATIC_SENSITIVITY 0x00000000
String functions supported
SQL_STRING_FUNCTIONS SQL_FN_STR_CONCAT SQL_FN_STR_INSERT SQL_FN_STR_LEFT SQL_FN_STR_LTRIM SQL_FN_STR_LENGTH SQL_FN_STR_LOCATE SQL_FN_STR_LCASE SQL_FN_STR_REPEAT SQL_FN_STR_REPLACE SQL_FN_STR_RIGHT SQL_FN_STR_RTRIM SQL_FN_STR_SUBSTRING SQL_FN_STR_UCASE SQL_FN_STR_ASCII SQL_FN_STR_CHARSQL_FN_STR_DIFFERENCE SQL_FN_STR_LOCATE_2 SQL_FN_STR_SPACE SQL_FN_STR_CHAR_LENGTH SQL_FN_STR_CHARACTER_LENGTH
Table 65: Information the ODBC driver returns to SQLGetInfo (17 of 19)
Description fInfoType argument Returns
305
SQLGetInfo
Predicates that support subqueries
SQL_SUBQUERIES SQL_SQ_COMPARISON SQL_SQ_EXISTS SQL_SQ_IN SQL_SQ_QUANTIFIEDSQL_SQ_CORRELATED_SUBQUERIES
System functions supported
SQL_SYSTEM_FUNCTIONS SQL_FN_SYS_USERNAME
Term for tables SQL_TABLE_TERM “table”
Timestamp intervals supported for TIMESTAMPADD function
SQL_TIMEDATE_ADD_INTERVALS 0x00000000
Timestamp intervals supported for TIMESTAMPDIFF function
SQL_TIMEDATE_DIFF_INTERVALS 0x00000000
Date-time functions supported
SQL_TIMEDATE_FUNCTIONS SQL_FN_TD_NOW SQL_FN_CURDATE SQL_FN_TD_DAYOFMONTH SQL_FN_TD_DAYOFWEEK SQL_FN_TD_DAYOFYEAR SQL_FN_TD_MONTH SQL_FN_TD_QUARTER SQL_FN_TD_WEEK SQL_FN_TD_YEAR SQL_FN_CURTIME SQL_FN_TD_HOUR SQL_FN_TD_MINUTE SQL_FN_TD_SECOND SQL_FN_TD_TIMESTAMP_ADD SQL_FN_TD_TIMESTAMPDIFF SQL_FN_TD_DAYNAME SQL_FN_TD_MONTHNAME
Support for DML, DDL within transactions
SQL_TXN_CAPABLE SQL_TC_ALL
Options for setting transaction isolation levels
SQL_TXN_ISOLATION_OPTION SQL_TXN_READ_UNCOMMITTED SQL_TXN_SERIALIZABLE SQL_TXN_READ_COMMITTED SQL_TXN_REPEATABLE_READ
UNION support SQL_UNION SQL_U_UNION SQL_U_UNION_ALL
Table 65: Information the ODBC driver returns to SQLGetInfo (18 of 19)
Description fInfoType argument Returns
306
SQLGetInfo
Name of user connected to the data source
SQL_USER_NAME (String containing the name)
Year of publication of the X/Open specification with which the driver complies
SQL_XOPEN_CLI_YEAR 1995
Table 65: Information the ODBC driver returns to SQLGetInfo (19 of 19)
Description fInfoType argument Returns
307
SQLGetInfo
308
ODBC Scalar Functions
This section lists scalar functions that ODBC supports and are available to use in OpenEdge SQL statements, as described in the following sections:
• Scalar functions
• System functions
Scalar functions
Table 67, Table 68, and Table 69 list the scalar functions that ODBC supports. You can use these functions in SQL statements using the following syntax:
scalar-function is one of the functions listed in the following tables. For example:
String functions
Table 66 lists the string functions that ODBC supports.
The string functions listed can take the following arguments:
• string_exp can be the name of a column, a string literal, or the result of another scalar function, where the underlying data type is SQL_CHAR or SQL_VARCHAR.
Syntax
{fn scalar-function}
SELECT {fn UCASE(NAME)} FROM EMP
ODBC Scalar Functions
• start, length, and count can be the result of another scalar function or a literal numeric value, where the underlying data type is SQL_TINYINT, SQL_SMALLINT, or SQL_INTEGER.
The string functions are one-based; that is, the first character in the string is character 1.
Character string literals must be surrounded in single quotation marks.
Table 66: Scalar string functions (1 of 2)
String function Returns
ASCII(string_exp) ASCII code value of the leftmost character of string_exp as an integer.
BIT_LENGTH(string_exp)ODBC 3.0
The length in bits of the string expression.
CHAR(code) The character with the ASCII code value specified by code. code should be between 0 and 255; otherwise, the return value is data-source dependent.
CHAR_LENGTH(string_exp)ODBC 3.0
The length in characters of the string expression, if the string expression is of a character data type; otherwise, the length in bytes of the string expression (the smallest integer not less than the number of bits divided by 8). (This function is the same as the CHARACTER_LENGTH function.)
CHARACTER_LENGTH(string_exp)ODBC 3.0
The length in characters of the string expression, if the string expression is of a character data type; otherwise, the length in bytes of the string expression (the smallest integer not less than the number of bits divided by 8). (This function is the same as the CHAR_LENGTH function.)
CONCAT(string_exp1,string_exp) The string resulting from concatenating string_exp2 and string_exp1. The string is system dependent.
DIFFERENCE(string_exp2 and string_exp1)
An integer value that indicates the difference between the values returned by the SOUNDEX function for string_exp2 and string_exp1.
INSERT(string_exp1 , start, length, string_exp2)
A string where length characters have been deleted from string_exp1 beginning at start and where string_exp2 has been inserted into string_exp, beginning at start.
LCASE(string_exp) Uppercase characters in string_exp converted to lowercase.
LEFT(string_exp, count) The count of characters of string_exp.
LENGTH(string_exp) The number of characters in string_exp.
310
ODBC Scalar Functions
Numeric functions
Table 67 lists the numeric functions that ODBC supports.
The numeric functions listed can take the following arguments:
• numeric_exp can be a column name, a numeric literal, or the result of another scalar function, where the underlying data type is SQL_NUMERIC, SQL_DECIMAL, SQL_TINYINT, SQL_SMALLINT, SQL_INTEGER, SQL_FLOAT, SQL_REAL, or SQL_DOUBLE.
• float_exp can be a column name, a numeric literal, or the result of another scalar function, where the underlying data type is SQL_FLOAT.
LOCATE(string_exp1, string_exp2
[,start,]) The starting position of the first occurrence of string_exp1 within string_exp2. If start is not specified the search begins with the first character position in string_exp2. If start is specified, the search begins with the character position indicated by the value of start. The first character position in string_exp2 is indicated by the value 1. If string_exp1 is not found, 0 is returned.
LTRIM(string_exp) The characters of string_exp, with leading blanks removed.
OCTET_LENGTH(string_exp)ODBC 3.0
The length in bytes of the string expression. The result is the smallest integer not less than the number of bits divided by 8.
POSITION(character_exp IN character_exp)
The position of the first character expression in the second character expression. The result is an exact numeric with an implementation-defined precision and a scale of 0.
REPEAT(string_exp, count) A string composed of string_exp repeated count times.
REPLACE(string_exp1, string_exp2, string_exp3)
Replaces all occurrences of string_exp2 in string_exp1 with string_exp3.
RIGHT(string_exp, count) The rightmost count of characters in string_exp.
RTRIM(string_exp) The characters of string_exp with trailing blanks removed.
SPACE(count) A string consisting of count spaces.
SUBSTRING(string_exp , start, length)
A string derived from string_exp beginning at the character position start for length characters.
UCASE(string_exp) Lowercase characters in string_exp converted to uppercase.
Table 66: Scalar string functions (2 of 2)
String function Returns
311
ODBC Scalar Functions
• integer_exp can be a column name, a numeric literal, or the result of another scalar function, where the underlying data type is SQL_TINYINT, SQL_SMALLINT, or SQL_INTEGER.
Table 67: Scalar numeric functions (1 of 2)
Numeric function Returns
ABS(numeric_exp) Absolute value of numeric_exp.
ACOS(float_exp) Arccosine of float_exp as an angle in radians.
ASIN(float_exp) Arcsine of float_exp as an angle in radians.
ATAN(float_exp) Arctangent of float_exp as an angle in radians.
ATAN2(float_exp1, float_exp2) Arctangent of the x and y coordinates, specified by float_exp1 and float_exp2 as an angle in radians.
CEILING(numeric_exp) Smallest integer greater than or equal to numeric_exp.
COS(float_exp) Cosine of float_exp as an angle in radians.
COT(float_exp) Cotangent of float_exp as an angle in radians.
DEGREES(numeric_exp) Number of degrees converted from numeric_exp radians.
EXP(float_exp) Exponential value of float_exp.
FLOOR(numeric_exp) Largest integer less than or equal to numeric_exp.
LOG(float_exp) Natural log of float_exp.
LOG10(float_exp) Base 10 log of float_exp.
MOD(integer_exp1, integer_exp2) Remainder of integer_exp1 divided by integer_exp2.
PI() Constant value of pi as a floating-point number.
POWER(numeric_exp, integer_exp) Value of numeric_exp to the power of integer_exp.
RADIANS(numeric_exp) Number of radians converted from numeric_exp degrees.
RAND([ integer_exp ]) Random floating-point value using integer_exp as the optional seed value.
ROUND(numeric_exp, integer_exp) numeric_exp rounded to integer_exp places right of the decimal (left of the decimal if integer_exp is negative).
312
ODBC Scalar Functions
Date and time functions
Table 68 lists the date and time functions that ODBC supports.
The date and time functions listed can take the following arguments:
• date-exp can be a column name, a date or timestamp literal, or the result of another scalar function, where the underlying data type can be represented as SQL_CHAR, SQL_VARCHAR, SQL_DATE, or SQL_TIMESTAMP.
• time_exp can be a column name, a timestamp or timestamp literal, or the result of another scalar function, where the underlying data type can be represented as SQL_CHAR, SQL_VARCHAR, SQL_TIME, or SQL_TIMESTAMP.
• timestamp_exp can be a column name; a time, date, or timestamp literal; or the result of another scalar function, where the underlying data type can be represented as SQL_CHAR, SQL_VARCHAR, SQL_TIME, SQL_DATE, or SQL_TIMESTAMP.
SIGN(numeric_exp) Indicator of the sign of numeric_exp. If numeric_exp <0, -1 is returned. If numeric_exp = 0, 0 is returned. If numeric_exp > 0, 1 is returned.
SIN(float_exp) Sine of float_exp, where float_exp is an angle in radians.
SQRT(float_exp) Square root of float_exp.
TAN(float_exp) Tangent of float_exp, where float_exp is an angle in radians.
TRUNCATE(numeric_exp, integer_exp) numeric_exp truncated to integer_exp places right of the decimal. (If integer_exp is negative, truncation is to the left of the decimal.)
Table 68: Date and time functions supported by ODBC (1 of 3)
Function Returns
CURRENT DATE()(ODBC 3.6)
Current date.
CURRENT_TIME[(time-precision)](ODBC 3.6)
Current local time. The time-precision argument determines the seconds precision of the returned value.
CURRENT_TIMESTAMP
[(timestamp-precision)](ODBC 3.6)
Current local date and local time as a timestamp value. The timestamp-precision argument determines the seconds precision of the returned timestamp.
Table 67: Scalar numeric functions (2 of 2)
Numeric function Returns
313
ODBC Scalar Functions
CURDATE() Current date as a date value.
CURTIME() Current local time as a time value.
DAYNAME(date_exp) Character string containing a date source-specific name of the day for the day portion of date_exp.
DAYOFMONTH(date_exp) Day of the month in date_exp as an integer value (1–31).
DAYOFWEEK(date_exp) Day of the week in date_exp as an integer value (1–7).
DAYOFYEAR(date_exp) Day of the year in date_exp as an integer value (1–366).
HOUR(time_exp) Hour in time_exp as an integer value (0–23).
MINUTE(time_exp) Minute in time_exp as an integer value (0–59).
MONTH(date_exp) Month in date_exp as an integer value (1–366).
MONTHNAME(date_exp) Character string containing the data source-specific name of the month.
NOW() Current date and time as a timestamp value.
QUARTER(date_exp) Quarter in date_exp as an integer value (1–4).
SECOND(time_exp) Second in date_exp as an integer value (0–59).
TIMESTAMPADD(interval, integer_exp, time_exp)
Timestamp calculated by adding integer_exp intervals of type interval to time_exp. interval can be:
• SQL_TSI_FRAC_SECOND
• SQL_TSI_SECOND
• SQL_TSI_MINUTE
• SQL_TSI_HOUR
• SQL_TSI_DAY
• SQL_TSI_WEEK
• SQL_TSI_MONTH
• SQL_TSI_QUARTER
• SQL_TSI_YEAR
Fractional seconds are expressed in billionths of a second.
Table 68: Date and time functions supported by ODBC (2 of 3)
Function Returns
314
ODBC Scalar Functions
System functions
Table 69 lists the scalar system functions that ODBC supports.
TIMESTAMPDIFF(interval, time_exp1, time_exp2)
Integer number of intervals of type interval by which time_exp2 is greater than time_exp1. interval has the same values as TIMESTAMPADD. Fractional seconds are expressed in billionths of a second.
WEEK(date_exp) Week of the year in date_exp as an integer value (1-53).
YEAR(date_exp) Year in date_exp. The range is data source dependent.
Table 68: Date and time functions supported by ODBC (3 of 3)
Function Returns
Table 69: Scalar system functions supported by ODBC
System function Returns
DATABASE() Name of the database, corresponding to the connection handle (odbc)
IFNULL(exp, value) value, if exp is null
ROWID(extension) The row identifier of the current row in a table
USER() Authorization name of the user
315
ODBC Scalar Functions
316
Part IV
ESQL Reference
Embedded SQL
Embedded SQL
In OpenEdge Release 10, the ESQL interface is being deprecated. It is provided to help OpenEdge customers transition to the use of other interfaces. For the long term, you should use ODBC or JDBC to access SQL data. These newer interfaces offer better performance and access by many development and reporting tools, as described in the following sections:
• ESQL elements and statements
• Compliance with industry standards
ESQL elements and statements
This section provides detailed information on OpenEdge SQL statements. A description for each statement provides the following information:
• Definition of the statement
• Syntax of the statement’s proper usage
• A code sample that shows how the statement works
• Any associated notes
• Authorization required in order to use the statement
• Related statements
ESQL elements and statements
BEGIN-END DECLARE SECTION
Declares variables and types used by the precompiler. Any variables you refer to in an embedded SQL statement must be declared in a DECLARE SECTION. This section starts with a BEGIN DECLARE SECTION statement and ends with an END DECLARE SECTION statement. Each variable must be declared as a host language data type.
Syntax
host_lang_type variable_name ;
A conventional C Language variable declaration. This form of variable declaration conforms to the ANSI standard for the C Language.
Example
Notes • The C Language type int is not supported by ESQL. Type int maps to 16 or 32 bits, depending on the machine architecture. This can create rounding errors at run time, as values are passed across different machine architectures.
• Variables you declare in a BEGIN-END DECLARE SECTION can be used in C Language statements as if they are declared outside the DECLARE SECTION.
• The scope of variables follows host language scoping rules. The ESQL variables are not visible outside the file in which they are declared.
DECLARE sections are permissible only where host language declarations are permissible in the host language syntax. This restriction is due to how DECLARE SECTION blocks are translated into the main body of host language declarations.
• Avoid DECLARE sections in header files that are included by more than one source file. This can cause duplicate variables with the same name.
• The form of the variable created by ESQL for each type is specified so that it can be manipulated from host language statements. Declaring variables allows you to use the variables in both host language and embedded SQL statements.
EXEC SQL BEGIN DECLARE SECTIONhost_lang_type variable_name ; . . .EXEC SQL END DECLARE SECTION
Syntax
{ char | short | long | float | double }
EXEC SQL BEGIN DECLARE SECTION ; short InvTransNum_v ; short Qty_v ; short OrderNum_v ;EXEC SQL END DECLARE SECTION ;
320
ESQL elements and statements
Authorization
None
Related statements
Static Array Types
CLOSE
Closing a cursor changes the state of the cursor from open to closed.
Syntax
cursor_name
An identifier named earlier in a DECLARE CURSOR statement and an OPEN CURSOR statement.
Example
Notes • Only a cursor in the open state can be set to the closed state.
• When a transaction ends, any cursors in the open state are automatically set to the closed state.
• When a cursor is in the closed state, you cannot perform FETCH, DELETE, or UPDATE operations using that cursor.
• It is good practice to close cursors explicitly.
Authorization
None
Related statements
DELETE, OPEN, FETCH, positioned UPDATE, positioned DELETE
CONNECT
Establishes a connection to a database. Optionally, the CONNECT statement can also specify a name for the connection and a username and password for authentication.
EXEC SQL CLOSE cursor_name ;
EXEC SQL CLOSE dyncur ;EXEC SQL COMMIT WORK ;
321
ESQL elements and statements
Syntax
connect_string
Note Arguments to CONNECT must be either string literals enclosed in quotation marks or character-string host variables.
connect_string
Specifies to which database to connect. If the CONNECT statement specifies DEFAULT, SQL tries to connect to the environment-defined database, if any. The value of the DB_NAME environment variable specifies the default connect string.
The connect_string can be a simple database name or a complete connect_string. A complete connect string has the components shown in the following table:
connection_name
The name of the connection as either a character literal or host variable. If the CONNECT statement omits a connection name, the default is the name of the database. Connection names must be unique.
username
User name for authentication of the connection. SQL verifies the user name against a corresponding password before it connects to the database. The value of the DH_USER environment variable specifies the default user name. If DH_USER is not set, the value of the USER environment variable specifies the default user name.
CONNECT TO connect_string
[ AS connection_name ] [ USER username ] [ USING password ] ;
Syntax
{ DEFAULT | db_name | db_type:T:host_name:port_num:db_name }
Connect string Description
db_type Type of database. The only currently supported database type is progress
T T directs the SQL engine to use the TCP/IP protocol
host_name Name of the system where the database resides
port_num Port number to use for the connection
db_name Name of the database
322
ESQL elements and statements
password
Password for authentication of the connection. SQL verifies the password against a corresponding user name before it connects to the database.
The value of the DH_PASSWD environment variable determines the default password.
Notes • Arguments to CONNECT must be either string literals enclosed in quotation marks or character string host variables.
• An application can connect to more than one database at a time, with a maximum of 10 connections. However, the application can actually gain access to only one database at a time. The database name specified in the CONNECT statement becomes the active one.
• If an application executes a SQL statement before connecting to a database, an attempt is made to connect to the environment-defined database, if any. If the connection is successful, the SQL statement is executed on that database.
Examples The following example illustrates the CONNECT statement:
• The first statement shown connects to the salesdb database on the local system.
• The second statement connects to the custdb database on the local system.
• The last statement connects to the environment-defined database by default.
Authorization
None
Related statements
DISCONNECT, SET CONNECTION
DECLARE CURSOR
Associates a cursor with a static query or a prepared dynamic query statement. The query or the prepared statement can have references to host variables.
Syntax
cursor_name
A name you assign to the cursor. The name must meet the requirements for an identifier.
CONNECT TO "salesdb" AS "sales_conn";CONNECT TO "progress:T:localhost:custdb" AS "cust_conn";CONNECT TO DEFAULT;
DECLARE cursor_name CURSOR FOR
{ query_expression [ ORDER BY clause ] [ FOR UPDATE clause ]| prepared_statement_name
} ;
323
ESQL elements and statements
query_expression [ ORDER BY clause ] [FOR UPDATE clause ]A complete query expression.
prepared_statement_name
The name assigned to a prepared SQL statement in an earlier PREPARE statement.
Examples
Notes • You must declare a cursor before any OPEN, FETCH, or CLOSE statement.
• The scope of the cursor declaration is the entire source file in which it is declared. The operations on the cursor, such as OPEN, CLOSE, and FETCH statements, can occur only within the same compilation unit as the cursor declaration.
• The use of a cursor allows the execution of the positioned forms of the UPDATE and DELETE statements.
• If the DECLARE statement corresponds to a static SQL statement with parameter references:
– The DECLARE statement must be executed before each execution of an OPEN statement for the same cursor.
– The DECLARE statement and the OPEN statement that follows must occur within the same transaction within the same task.
– If the statement contains parameter references to automatic variables or function arguments, the DECLARE statement and the following OPEN statement for the same cursor must occur within the same C function.
Authorization
None
Related statements
PREPARE, OPEN, FETCH, CLOSE SELECT
EXEC SQL WHENEVER SQLERROR GOTO selerr ;EXEC SQL DECLARE stcur CURSOR FOR SELECT InvTransNum, Qty, OrderNum FROM PUB.InventoryTrans ;EXEC SQL OPEN stcur ; EXEC SQL WHENEVER NOT FOUND GOTO seldone ;
EXEC SQL WHENEVER SQLERROR GOTO selerr ;EXEC SQL PREPARE stmtid from :sel_stmt_v ;EXEC SQL DECLARE dyncur CURSOR FOR stmtid ;EXEC SQL OPEN dyncur ; EXEC SQL WHENEVER NOT FOUND GOTO seldone ;
324
ESQL elements and statements
DESCRIBE
Writes information about a prepared statement to the SQL Descriptor Area (SQLDA). You use a DESCRIBE statement in a series of steps that allows a program to accept SQL statements at run time. Dynamically generated statements are not part of a program's source code; they are generated at run time.
There are two forms of the DESCRIBE statement:
• The DESCRIBE BIND VARIABLES statement writes information about input variables in an expression to an SQLDA. These variables can be substitution variable names or parameter markers.
• The DESCRIBE SELECT LIST statement writes information about select list items in a prepared SELECT statement to an SQLDA.
Syntax
The SQLDA is a host language data structure used in dynamic SQL processing. DESCRIBE statements write information about the number, data types, and sizes of input variables or select list items to SQLDA structures. Program logic then processes that information to allocate storage. OPEN, EXECUTE, and FETCH statements read the SQLDA structures for the addresses of the allocated storage.
DESCRIBE BIND VARIABLES
Writes information about any input variables in the prepared statement to an input SQLDA structure.
Syntax
statement_name
The name of an input SQL statement to be processed using dynamic SQL steps. Typically, this is the same statement_name used in the PREPARE statement.
input_sqlda_name
The name of the SQLDA structure to which DESCRIBE will write information about input variables. Input variables represent values supplied to INSERT and UPDATE statements at run time, and to predicates in DELETE, UPDATE, and SELECT statements at run time.
To utilize the DESCRIBE BIND VARIABLES statement in your application, issue statements in the following order:
1. PREPARE
2. DESCRIBE BIND VARIABLES
3. EXECUTE or OPEN CURSOR
DESCRIBE [ BIND VARIABLES | SELECT LIST ] FOR statement_nameINTO input_sqlda_name ;
DESCRIBE BIND VARIABLES FOR statement_name INTO input_sqlda_name ;
325
ESQL elements and statements
The DESCRIBE BIND VARIABLES statement writes the number of input variables to the sqld_nvars field of the SQLDA. If the sqld_size field of the SQLDA is not equal to or greater than this number, DESCRIBE writes the value as a negative number to sqld_nvars. Design your application to check sqld_nvars for a negative number to determine if a particular SQLDA is large enough to process the current input statement.
Input variables in dynamic SQL statements are identified by parameter markers or as substitution names.
Authorization
None
Related statements
PREPARE, DECLARE CURSOR, OPEN, FETCH, CLOSE
DESCRIBE SELECT LIST
Writes information about select list items in a prepared SELECT statement to an output SQLDA structure.
Syntax
statement_name
The name of a SELECT statement to be processed using dynamic SQL steps. Typically, this is the same statement_name as in the PREPARE statement.
output_sqlda_name
The name of the SQLDA structure to which DESCRIBE will write information about select list items.
Note Select list items are column names and expressions in a SELECT statement. A FETCH statement writes the values returned by a SELECT statement to the addresses stored in an output SQLDA.
To utilize the DESCRIBE SELECT LIST statement in your application, issue statements in the following order:
1. DECLARE CURSOR
2. PREPARE
3. OPEN
4. DESCRIBE SELECT LIST
5. FETCH
DESCRIBE SELECT LIST FOR statement_name INTO output_sqlda_name ;
326
ESQL elements and statements
A DESCRIBE SELECT LIST statement writes the number of select list items to the sqld_nvars field of an output SQLDA. If the sqld_size field of the SQLDA is not equal to or greater than this number, DESCRIBE writes the value as a negative number to sqld_nvars. Design your application to check sqld_nvars for a negative number to determine if a particular output SQLDA is large enough to process the current SELECT statement.
Authorization
None
Related statements
PREPARE, DECLARE CURSOR, OPEN, FETCH, CLOSE
DISCONNECT
Terminates the connection between an application and the database to which it is connected.
Syntax
connection_name
The name of the connection as either a character literal or host variable.
CURRENT
Disconnects the current connection.
ALL
Disconnects all established connections.
DEFAULT
Disconnects the connection to the default database.
Examples This example illustrates CONNECT TO AS connection_name and DISCONNECT connection_name:
The following example illustrates CONNECT TO DEFAULT and DISCONNECT DEFAULT:
DISCONNECT { 'connection_name' | CURRENT | ALL | DEFAULT } ;
EXEC SQL CONNECT TO 'progress:T:localhost:6745:salesdb' AS 'conn_1' ;/*** C Language and embedded SQL application processing against the** database in the connect_string*/ . . .EXEC SQL DISCONNECT 'conn_1' ;
327
ESQL elements and statements
After you issue DISCONNECT ALL there is no current connection. The following example disconnects all database connections:
The following example illustrates the CONNECT, SET CONNECTION, and DISCONNECT statements in combination using these steps:
1. CONNECT TO connect_string AS connection_name, which establishes a connect_string connection to the database in the connect_string; the connection has the name 'conn_1'.
2. CONNECT TO DEFAULT, which establishes a connection to the DEFAULT database and sets this connection current.
3. DISCONNECT DEFAULT, which disconnects the connection to the DEFAULT database.
4. SET CONNECTION connection_name, which sets the 'conn_1' connection current.
5. DISCONNECT CURRENT, which disconnects the 'conn_1' connection.
EXEC SQL CONNECT TO DEFAULT ;/*** C Language and embedded SQL application processing against the** database in the connect_string*/ . . .EXEC SQL DISCONNECT DEFAULT ;
EXEC SQL DISCONNECT ALL;
328
ESQL elements and statements
Notes • When you specify DISCONNECT connection_name or DISCONNECT CURRENT and there is also an established connection to the DEFAULT database, the connection to the DEFAULT database becomes the current connection. If there is no DEFAULT database, there is no current connection after the SQL engine processes the DISCONNECT.
• The DISCONNECT DEFAULT statement terminates the connection to the DEFAULT database. If this connection is the current connection, there is no current connection after this DISCONNECT statement is executed.
Authorization
None
Related statements
CONNECT, SET CONNECTION
/*** 1. CONNECT TO 'connect_string'*/EXEC SQL CONNECT TO 'progress:T:localhost:6745:salesdb' AS 'conn_1' ;/*** 2. CONNECT TO DEFAULT. This suspends the conn_1 connection** and sets the DEFAULT connection current*/EXEC SQL CONNECT TO DEFAULT ;/*** Application processing against the DEFAULT database*/ . . ./*** 3. DISCONNECT DEFAULT*/EXEC SQL DISCONNECT DEFAULT ;/*** 4. Set the first connection, conn_1, current*/EXEC SQL SET CONNECTION conn_1 ;/*** Application processing against the database in the connect_string*/ . . ./*** 5. DISCONNECT the conn_1 connection, which is the current connection.*/EXEC SQL DISCONNECT CURRENT ;
329
ESQL elements and statements
EXEC SQL delimiter
In C Language programs, you must precede embedded SQL statements with the EXEC SQL delimiter so that the precompiler can distinguish statements from the host language statements.
Note: Constructs within a BEGIN-END DECLARE SECTION do not require the EXEC SQL delimiter.
Syntax
sql_statement
An SQL statement to be processed by the ESQL precompiler. You must terminate each SQL statement with a semicolon to mark the end of the statement.
Example
Note In general, the ESQL precompiler does not parse host language statements and therefore does not detect any syntax or semantic errors in host language statements. The exceptions to this rule are:
• Recognition of host language blocks. The precompiler recognizes host language blocks in order to determine the scope of variables and types.
• Constants defined with the #define preprocessor command. To evaluate these constants, the ESQL precompiler invokes the C language preprocessor before beginning embedded SQL processing.
Authorization
None
EXECUTE
Executes the statement specified in statement_name.
Syntax
EXEC SQL sql_statement ;
EXEC SQL WHENEVER SQLERROR GOTO selerr ;EXEC SQL PREPARE stmtid from :sel_stmt_v ;EXEC SQL DECLARE dyncur CURSOR FOR stmtid ;EXEC SQL OPEN dyncur ;EXEC SQL WHENEVER NOT FOUND GOTO seldone ;
EXECUTE statement_name
[ USING { [ SQL ] DESCRIPTOR structure_name | :host_variable [ [ INDICATOR ] :ind_variable ] , ... } ] ;
330
ESQL elements and statements
statement_name
Name of the prepared SQL statement.
structure_name
Name of an SQL descriptor area (SQLDA).
Example
Notes • A statement must be processed with a PREPARE statement before it can be processed with an EXECUTE statement.
• A prepared statement can be executed multiple times in the same transaction. Typically each call to the EXECUTE statement supplies a different set of host variables.
• If there is no DESCRIPTOR in the USING clause, the EXECUTE statement is restricted to the number of variables specified in the host variable list. The number and type of the variables must be known at compile time. The host variables must be declared in the DECLARE SECTION before they can be used in the USING clause of the EXECUTE statement.
• If there is a DESCRIPTOR in the USING clause, the program can allocate space for the input host variables at run time.
Related statements
EXECUTE IMMEDIATE, PREPARE
EXECUTE IMMEDIATE
Executes the statement specified in a statement_string or host_variable.
Syntax
statement_name
Name of the prepared SQL statement.
structure_name
Name of an SQL descriptor area (SQLDA).
Notes • The character string form of the statement is referred to as a statement string. An EXECUTE IMMEDIATE statement accepts either a statement string or a host variable as input.
/*** Process the non-SELECT input statement** PREPARE the statement** EXECUTE the prepared statement** COMMIT WORK*/
EXEC SQL PREPARE dynstmt FROM :sql_stmt_v ; EXEC SQL EXECUTE dynstmt ; EXEC SQL COMMIT WORK ;
EXECUTE IMMEDIATE { statement_string | host_variable } ;
331
ESQL elements and statements
• A statement string must not contain host variable references or parameter markers.
• A statement string must not begin with EXEC SQL delimiter and must not end with a semicolon.
• When an EXECUTE IMMEDIATE statement is executed, the SQL engine parses the statement and checks it for errors. Any error in the execution of the statement is reported in the SQLCA.
• If the same SQL statement is to be executed multiple times, it is more efficient to use PREPARE and EXECUTE statements, rather than an EXECUTE IMMEDIATE statement.
Related statement
EXECUTE
FETCH
Moves the position of the cursor to the next row of the active set and fetches the column values of the current row into the specified host variables.
Syntax
cursor_name
A name identified in an earlier DECLARE CURSOR statement and an OPEN CURSOR statement.
USING SQL DESCRIPTOR structure_name
Directs the SQL engine to FETCH data into storage addressed by an SQLDA structure.
INTO :host_var_ref [ [ INDICATOR ] :ind_var_ref ]Directs the SQL engine to FETCH data into the identified host variables, and to set values in the identified indicator variables.
FETCH cursor_name
{ USING SQL DESCRIPTOR structure_name | INTO :host_var_ref [ [ INDICATOR ] :ind_var_ref ] , ... } ;
332
ESQL elements and statements
Example
Notes • A FETCH operation requires that the cursor be open.
• The positioning of the cursor for each FETCH operation is as follows:
– The first time you execute a FETCH statement after opening the cursor, the cursor is positioned to the first row of the active set.
– Subsequent FETCH operations advance the cursor position in the active set. The next row becomes the current row.
– When the current row is deleted using a positioned DELETE statement, the cursor is positioned before the row after the deleted row in the active set.
• The cursor can only be moved forward in the active set by executing FETCH statements. To move the cursor to the beginning of the active set, you must CLOSE the cursor and OPEN it again.
• If the cursor is positioned on the last row of the active set or if the active set does not contain any rows, executing a FETCH will return the status code SQL_NOT_FOUND in the SQLDA.
• After a successful FETCH, the total row count fetched so far for this cursor is returned in sqlca.sqlerrd[2]. The count is set to zero after an OPEN cursor operation.
• You can FETCH multiple rows in one FETCH operation by using array variables in the INTO clause. The SQL_NOT_FOUND status code is returned in the SQLCA when the end of the active set is reached, even if the current FETCH statement returns one or more rows.
• If you use array variables in a FETCH statement, the array sizes are set to the number of rows fetched after the FETCH statement is executed.
Authorization
None
/*** One way to limit the number of rows returned is to** set a new value for "j" here. As supplied in the SPORTS2000 database,** the PUB.InventoryTrans table contains 75 rows.*/ j = 100; for (i = 0; i < j; i++) { EXEC SQL FETCH dyncur INTO :int_p1_v, :int_p2_v, :char_p_v ; if (i == 0) { printf (" 1st col 2nd col 3rd col"); printf (" ------- ------- --------"); } printf (" %d %d %s ", int_p1_v, int_p2_v, char_p_v) ; }
333
ESQL elements and statements
Related statements
DECLARE CURSOR, OPEN, CLOSE
GET DIAGNOSTICS
Retrieves information about the execution of the previous SQL statement from the SQL diagnostics area. The diagnostics area is a data structure that contains information about the execution status of the most recent SQL statement. Specifically, GET DIAGNOSTICS extracts information about the SQL statement as a whole from the SQL diagnostics area’s header component.
Note: The GET DIAGNOSTICS EXCEPTION number extracts detail information.
Syntax
:param
A host-language variable to receive the information returned by the GET DIAGNOSTICS statement. The host-language program must declare a param compatible with the SQL data type of the information item.
header_info_item
One of the following keywords, which returns associated information about the diagnostics area or the SQL statement:
NUMBER
The number of detail areas in the diagnostics area. Currently, NUMBER is always 1. NUMBER is type NUMERIC with a scale of 0.
MORE
A one-character string with a value of Y (all conditions are detailed in the diagnostics area) or N (all conditions are not detailed) that tells whether the diagnostics area contains information on all the conditions resulting from the statement.
COMMAND_FUNCTION
Contains the character-string code for the statement (as specified in the SQL standard), if the statements is a static SQL statement. If the statement is a dynamic statement, contains the character string EXECUTE or EXECUTE IMMEDIATE.
GET DIAGNOSTICS :param = header_info_item
[ , :param = header_info_item ] , ... ;
Syntax
NUMBER | MORE | COMMAND_FUNCTION | DYNAMIC_FUNCTION | ROW_COUNT
334
ESQL elements and statements
DYNAMIC_FUNCTION
Contains the character-string code for the statement (as specified in the SQL standard). For dynamic SQL statements only (as indicated by EXECUTE or EXECUTE IMMEDIATE in the COMMAND_FUNCTION item).
ROW_COUNT
The number of rows affected by the SQL statement.
Example The GET DIAGNOSTICS example extracts header information about the last SQL statement executed. The information is assigned to host variables that are defined in the DECLARE SECTION of an embedded SQL program, as shown in the following example:
The GET DIAGNOSTICS statement itself does not affect the contents of the diagnostics area. This means applications can issue multiple GET DIAGNOSTICS statements to retrieve different items of information about the same SQL statement.
Related statements
GET DIAGNOSTICS EXCEPTION, WHENEVER
GET DIAGNOSTICS EXCEPTION
Retrieves information about the execution of the previous SQL statement from the SQL diagnostics area. The diagnostics area is a data structure that contains information about the execution status of the most recent SQL statement. Specifically, GET DIAGNOSTICS EXCEPTION extracts information about the SQL statement as a whole from the SQL diagnostics area’s detail component.
The detail area contains information for a particular condition (an error, warning, or success condition) associated with execution of the last SQL statement. The diagnostics area can potentially contain multiple detail areas corresponding to multiple conditions generated by the SQL statement described by the header. The SQL diagnostics area currently supports only one detail area.
Note: The GET DIAGNOSTICS statement extracts header information.
Syntax
EXCEPTION number
Specifies that GET DIAGNOSTICS EXCEPTION extracts detail information. number specifies which of multiple detail areas GET DIAGNOSTICS extracts. Currently, number must be the integer 1.
GET DIAGNOSTICS :num = NUMBER, :cmdfunc = COMMAND_FUNCTION ;
GET DIAGNOSTICS EXCEPTION number :param = detail_info_item
[, :param = detail_info_item ] , ... ;
335
ESQL elements and statements
:param
Receives the information returned by the GET DIAGNOSTICS EXCEPTION statement. The host-language program must declare a param compatible with the SQL data type of the information item.
detail_info_item
One of the following keywords, which returns associated information about the particular error condition:
CONDITION_NUMBER
The sequence of this detail area in the diagnostics area. Currently, CONDITION_NUMBER is always 1.
RETURNED_SQLSTATE
The SQLSTATE value that corresponds to the condition.
CLASS_ORIGIN
The general type of error. For example, connection exception or data exception.
SUBCLASS_ORIGIN
The specific error. Usually the same as the message text.
ENVIRONMENT_NAME
Not currently supported.
CONNECTION_NAME
Not currently supported.
Syntax
CONDITION_NUMBER
| RETURNED_SQLSTATE | CLASS_ORIGIN | SUBCLASS_ORIGIN | ENVIRONMENT_NAME | CONNECTION_NAME | CONSTRAINT_CATALOG | CONSTRAINT_SCHEMA | CONSTRAINT_NAME | CATALOG_NAME | SCHEMA_NAME | TABLE_NAME | COLUMN_NAME | CURSOR_NAME | MESSAGE_TEXT | MESSAGE_LENGTH | MESSAGE_OCTET_LENGTH
336
ESQL elements and statements
CONSTRAINT_CATALOG
Not currently supported.
CONSTRAINT_SCHEMA
Not currently supported.
CONSTRAINT_NAME
Not currently supported.
CATALOG_NAME
Not currently supported.
SCHEMA_NAME
Not currently supported.
TABLE_NAME
The name of the table, if the error condition involves a table.
COLUMN_NAME
The name of the affected columns, if the error condition involves a column.
CURSOR_NAME
Not currently supported.
MESSAGE_TEXT
The associated message text for the error condition.
MESSAGE_LENGTH
The length in characters of the message in the MESSAGE_LENGTH item.
MESSAGE_OCTET_LENGTH
Not currently supported.
Example The GET DIAGNOSTICS EXCEPTION example extracts detailed information into host variables that are defined in the DECLARE SECTION of an embedded SQL program:
Note The GET DIAGNOSTICS statement itself does not affect the contents of the diagnostics area. This means applications can issue multiple GET DIAGNOSTICS statements to retrieve different items of information about the same SQL statement.
Related statements
GET DIAGNOSTICS, WHENEVER
GET DIAGNOSTICS EXCEPTION :num :sstate = RETURNED_SQLSTATE, :msgtxt = MESSAGE_TEXT ;
337
ESQL elements and statements
OPEN
Executes a prepared SQL query associated with a cursor and creates a result set composed of the rows that satisfy the query. This set of rows is called the active set.
Syntax
cursor_name
An identifier named in an earlier DECLARE CURSOR statement.
USING [ SQL ] DESCRIPTOR structure_nameDirects the SQL engine to create the result set in storage addressed by the identified SQLDA structure.
USING :host_variable [ [ INDICATOR ] :ind_variable ]Directs the SQL engine to create the result set in storage addressed by host variables.
Example
Notes • Executing an OPEN cursor statement sets the cursor to the open state.
• After the OPEN cursor statement is executed, the cursor is positioned just before the first row of the active set.
• For a single execution of an OPEN cursor statement, the active set does not change and the host variables are not re-examined.
• If you elect to retrieve a new active set and a host variable value has changed, you must CLOSE the cursor and OPEN it again.
OPEN cursor_name
[ USING { [ SQL ] DESCRIPTOR structure_name | :host_variable [ [ INDICATOR ] :ind_variable ] , ... } ] ;
/*** 5. Name WHENEVER routine to handle SQLERROR.**** 6. DECLARE cursor for the SELECT statement.** NOTE: You must set input parameter values before OPEN CURSOR.** The static query in this program does not have input parameters.**** 7. OPEN the cursor.** NOTE: For static statements, if a DECLARE CURSOR** statement contains references to automatic variables,** the OPEN CURSOR statement must be in the same C function.**** 8. Name WHENEVER routine to handle NOT FOUND condition.*/ EXEC SQL WHENEVER SQLERROR GOTO selerr ; EXEC SQL DECLARE stcur CURSOR FOR SELECT InvTransNum, Qty, OrderNum FROM PUB.InventoryTrans ; EXEC SQL OPEN stcur ; EXEC SQL WHENEVER NOT FOUND GOTO seldone ;
338
ESQL elements and statements
• Execution of a COMMIT statement or ROLLBACK statement implicitly closes the cursors that have been opened in the current transaction.
• It is good practice to CLOSE cursors explicitly.
• When a cursor is in the open state, executing an OPEN statement on that cursor results in an error.
• If a DECLARE cursor statement is associated with a static SQL statement containing parameter markers, the following requirements apply:
– You must execute the DECLARE statement before executing the OPEN statement for that cursor.
– The DECLARE cursor statement and the OPEN statement for the same cursor must occur in the same transaction.
– If the statement contains parameter markers for stack variables, the DECLARE cursor statement and the following OPEN statement for the same cursor must occur in the same C Language function.
Authorization
Must have DBA privilege of SELECT privilege on all the tables and views referenced in the SELECT statement associated with the cursor.
Related statements
DECLARE CURSOR, CLOSE, FETCH, positioned UPDATE, positioned DELETE
PREPARE
Parses and assigns a name to an ad hoc or dynamically generated SQL statement for execution. You use a PREPARE statement in a series of steps that allows a program to accept or generate SQL statements at run time.
Syntax
statement_name
A name for the dynamically generated statement. DESCRIBE, EXECUTE, and DECLARE CURSOR statements refer to this statement_name. A statement_name must be unique in a program.
statement_string
Specifies the SQL statement to be prepared for dynamic execution. You can use either the name of a C Language string variable containing the SQL statement, or you can specify the SQL statement as a quoted literal. If there is an SQL syntax error, the PREPARE statement returns an error in the SQLCA.
PREPARE statement_name FROM statement_string ;
339
ESQL elements and statements
Examples The first example is a code fragment from the DynUpd function in sample program 3DynUpd.pc, which illustrates dynamic processing of an UPDATE statement:
This example is a code fragment from the DynSel function in sample program 4DynSel.pc, which illustrates dynamic processing of a SELECT statement:
Notes • A statement string can have one or more references to input variables. These variables represent values supplied at run time to:
– INSERT and UPDATE statements
– Predicates in DELETE, UPDATE, and SELECT statements
• A program supplies an input variable to a PREPARE statement either as a substitution name or as a parameter marker. For example:
– A substitution name is a name preceded by a colon ( : ) in a statement string. This name does not refer to a C Language variable, but acts only as a placeholder for input variables.
– A parameter marker is a question mark ( ? ) in the statement string, serving as a placeholder for input variables.
Syntax
{ :host_variable | quoted_literal }
/*** Process a dynamic non-SELECT input statement** PREPARE the statement** EXECUTE the prepared statement** COMMIT WORK*/
EXEC SQL PREPARE dynstmt FROM :sql_stmt_v ;EXEC SQL EXECUTE dynstmt ;EXEC SQL COMMIT WORK ;
/*** PREPARE a the dynamic SELECT statement.** DECLARE cursor for the prepared SELECT statement.** NOTE: You must set input parameter values before OPEN CURSOR.** If your query has input parameters, you must define them in** the DECLARE SECTION.** OPEN the declared cursor.** NOTE: For static statements, if a DECLARE CURSOR** statement contains references to automatic variables,** the OPEN CURSOR statement must be in the same C function.**** Name WHENEVER routine for NOT FOUND condition.** FETCH a row and print results until no more rows.*/
EXEC SQL PREPARE stmtid from :sel_stmt_v ;EXEC SQL DECLARE dyncur CURSOR FOR stmtid ;EXEC SQL OPEN dyncur ; EXEC SQL WHENEVER NOT FOUND GOTO seldone ;
340
ESQL elements and statements
• The USING clauses of EXECUTE and OPEN statements identify host language storage. The values in this storage expand a statement string, replacing a substitution name or a parameter marker. You can design your program to execute the same prepared statement many times in a transaction, supplying different values for input variables for each execution. If you COMMIT or ROLLBACK the transaction, you must PREPARE the statement string again.
Authorization
Must have DBA privileges or authorization for the SQL statement being used.
Related statements
EXECUTE, OPEN, CLOSE, FETCH
SET CONNECTION
Switches the application from one established connection to another. This resumes the connection associated with the specified connection_name, restoring the context of that database connection to the same state it was in when suspended.
Syntax
connection_name
The name of the connection as either a character literal or host variable. If the SET CONNECTION statement omits a connection name, the default is the name of the database. Connection names must be unique.
DEFAULT
Sets the DEFAULT connection as the current connection.
Examples The first example shows how to establish a database as the current database:
The SET CONNECTION command sets the database associated with the connection named conn_1 to the status of current database. The connection named conn_1 must be associated with an established connection. Use SET CONNECTION DEFAULT to set current the database associated with the DEFAULT connection. In this example, the statement suspends the conn_1 connection, which had been current:
See also the last example for the DISCONNECT statement, which illustrates the CONNECT, SET CONNECTION, and DISCONNECT statements in combination.
SET CONNECTION { 'connection_name' | DEFAULT } ;
EXEC SQL SET CONNECTION 'conn_1' ;
EXEC SQL SET CONNECTION DEFAULT ;
341
ESQL elements and statements
Authorization
None
Related statements
CONNECT, DISCONNECT
WHENEVER
Specifies actions for three SQL run-time exceptions.
Syntax
{ NOT FOUND | SQLERROR | SQLWARNING }• The NOT FOUND exception is set when sqlca.sqlcode is set to SQL_NOT_FOUND.
• The SQLERROR exception is set when sqlca.sqlcode is set to a negative value.
• The SQLWARNING exception is set when sqlca.sqlwarn[ 0 ] is set to W after a statement is executed.
{ STOP | CONTINUE | GOTO | GO TO } host_lang_label }• The STOP exception results in the ESQL program stopping execution.
• The CONTINUE exception results in the ESQL program continuing execution. The default exception is to CONTINUE.
• GOTO | GO host_lang_label results in the ESQL program execution to branch to the statement corresponding to the host_lang_label.
Examples
Notes • You can place multiple WHENEVER statements for the same exception in a source file. Each WHENEVER statement overrides the previous WHENEVER statement specified for the same exception.
WHENEVER
{ NOT FOUND | SQLERROR | SQLWARNING } { STOP | CONTINUE | { GOTO | GO TO } host_lang_label } ;
/*** Name WHENEVER routine to handle SQLERROR condition.*/EXEC SQL WHENEVER SQLERROR GOTO mainerr ;
/*** Name WHENEVER routines to handle NOT FOUND and SQLERROR*/
EXEC SQL WHENEVER SQLERROR GOTO nodyn ;EXEC SQL WHENEVER NOT FOUND GOTO nodyn ;
342
ESQL elements and statements in Backus Naur Form (BNF)
• Correct operation of a WHENEVER statement with a GOTO host_language_label or a GO TO host_language_label is subject to the scoping rules of the C Language. The host_language_label must be within the scope of all SQL statements for which the action is active. The GO TO or GOTO action is active starting from the corresponding WHENEVER statement until another WHENEVER statement for the same exception, or until end of the file.
Authorization
None
Related statements
FETCH
ESQL elements and statements in Backus Naur Form (BNF)
BEGIN-END DECLARE SECTION
Host Language Type
CLOSE
Syntax
begin declare section ::=EXEC SQL BEGIN DECLARE SECTIONhost_lang_type variable_name ; . . .END DECLARE SECTION ::=EXEC SQL END DECLARE SECTION
Syntax
host language type ::=
{ char | short | long | float | double}
Syntax
close ::=EXEC SQL CLOSE cursor_name ;
343
ESQL elements and statements in Backus Naur Form (BNF)
CONNECT
CONNECT STRING
DECLARE CURSOR
DESCRIBE BIND VARIABLES
DESCRIBE SELECT LIST
DISCONNECT Syntax
Syntax
connect statement ::=CONNECT TO connect_string
[ AS connection_name ] [ USER user_name ] [ USING password ] ;
Syntax
connect_string ::=
{ DEFAULT | db_name | db_type:T:host_name:port_num:db_name }
Syntax
declare cursor ::=EXEC SQL DECLARE cursor_name CURSOR FOR
{ query_expr [ ORDER BY clause ] [ FOR UPDATE clause ] | prepared_statement_name } ;
Syntax
describe bind variables ::=EXEC SQL DESCRIBE BIND VARIABLES FOR statement_name INTO input_sqlda_name ;
Syntax
describe select list ::=EXEC SQL DESCRIBE SELECT LIST FOR statement_name INTO output_sqlda_name ;
disconnect statement ::=
DISCONNECT { ’connection_name’ | CURRENT | ALL | DEFAULT } ;
344
ESQL elements and statements in Backus Naur Form (BNF)
EXEC SQL
EXECUTE
EXECUTE IMMEDIATE
FETCH
GET DIAGNOSTICS
Syntax
EXEC SQL ::=EXEC SQL sql_statement ;
Syntax
EXECUTE ::=EXEC SQL EXECUTE statement_name
[ USING { [ SQL ] DESCRIPTOR structure_name | :host_variable [ [ INDICATOR ] :ind_variable ] , ... } ] ;
Syntax
EXECUTE IMMEDIATE ::=EXEC SQL EXECUTE IMMEDIATE
{ statement_string | host_variable } ;
Syntax
fetch ::=EXEC SQL FETCH cursor_name
{ USING SQL DESCRIPTOR structure_name | INTO :host_var_ref [ [ INDICATOR ] :ind_var_ref ] , ... } ;
Syntax
get diagnostics statement ::=GET DIAGNOSTICS :param = header_info_item
[ , :param = header_info_item ] ,...;
345
ESQL elements and statements in Backus Naur Form (BNF)
Header Info Item
GET DIAGNOSTICS EXCEPTION
Detail Info Item
Syntax
header_info_item ::=
{ NUMBER | MORE | COMMAND_FUNCTION | DYNAMIC_FUNCTION | ROW_COUNT }
Syntax
get diagnostics exception statement ::=GET DIAGNOSTICS EXCEPTION number :param = detail_info_item
[, :param = detail_info_item ] , ...;
Syntax
detail_info_item ::=
{ CONDITION_NUMBER | RETURNED_SQLSTATE | CLASS_ORIGIN | SUBCLASS_ORIGIN | ENVIRONMENT_NAME | CONNECTION_NAME | CONSTRAINT_CATALOG | CONSTRAINT_SCHEMA | CONSTRAINT_NAME | CATALOG_NAME | SCHEMA_NAME | TABLE_NAME | COLUMN_NAME | CURSOR_NAME | MESSAGE_TEXT | MESSAGE_LENGTH | MESSAGE_OCTET_LENGTH}
346
Compliance with industry standards
OPEN
PREPARE
SET CONNECTION
SET TRANSACTION ISOLATION LEVEL
ISOLATION LEVEL NAME
WHENEVER
Compliance with industry standards
Table 70 provides details on SQL DDL and DML compliance with industry standards. A check mark indicates compliance.
Syntax
open ::=EXEC SQL OPEN cursor_name
[ USING { [ SQL ] DESCRIPTOR structure_name | :host_variable [ [ INDICATOR ] :ind_variable ] , ... } ] ;
Syntax
prepare ::=EXEC SQL PREPARE statement_name FROM statement_string ;
Syntax
set connection statement ::=
SET CONNECTION { ’connection_name’ | DEFAULT } ;
Syntax
set transaction isolation level statement ::=SET TRANSACTION ISOLATION LEVEL isolation_level_name ;
Syntax
isolation_level_name ::=
READ UNCOMMITTED | READ COMMITTED | REPEATABLE READ | SERIALIZABLE
Syntax
whenever ::=EXEC SQL WHENEVER
{ NOT FOUND | SQLERROR | SQLWARNING } { STOP | CONTINUE | { GOTO | GO TO } host_lang_label } ;
347
Compliance with industry standards
Table 70: Compliance of SQL DDL and DML statements
SQL
ODBC SQL
grammarProgress extension Notes
BEGIN-END DECLARE SECTION
✓ – – Compliant if C language types usedEmbedded SQL only
CLOSE ✓ – – Embedded SQL onl.
DECLARE CURSOR ✓ – prepared_stmt_name Embedded SQL only
DESCRIBE ✓ – – Embedded SQL only
EXEC SQL ✓ – – Embedded SQL only
EXECUTE ✓ – – Embedded SQL only
EXECUTE IMMEDIATE
✓ – – Embedded SQL only
FETCH ✓ – USING DESCRIPTOR
Embedded SQL only
GET DIAGNOSTICS – – ✓ Embedded SQL only
OPEN ✓ – USING DESCRIPTOR
Embedded SQL only
PREPARE ✓ – – Embedded SQL only
ROLLBACK ✓ – – –
SELECT ✓ Extended FOR UPDATE –
WHENEVER ✓ – SQLWARNINGSTOP ACTION
Embedded SQL only
348
Index
A
ABS function 74
ACOS function 74
ADD_MONTHS 75
ADD_MONTHS function 75
Aggregate functions 73
ALTER DATABASE SET PRO_ENABLE_64BIT_SEQUENCES ’Y’ statement 2
ALTER DATABASE SET PRO_ENABLE_LARGE_KEYS ’Y’ statement 1
ALTER SEQUENCE statement 2
ALTER TABLE statement 4
ALTER USER statement 6
Approximate numeric data types 197
ARRAY data typesPRO_ELEMENT function 115support 188
ASCII function 76
ASIN function 76
ATAN function 77
ATAN2 function 78
AUDIT INSERT statement 7
AUDIT SET statement 8
AVG function 79
B
Backus Naur Formdata types 215DDL syntax 221DML statements 222ESQL elements and statements 343expressions 215, 217literals 218query expressions 219search conditions 221SQL elements and statements 215
Basic predicates 208query expressions in 208
BEGIN-END DECLARE SECTION 320
BETWEEN predicate 209
Bit string data types 199
C
CALL statement 9, 12
CASE function 80
CAST function 82
CHAR function 84
Character data types 195
Character-string literals 204
Index
Index
CHR function 84
ClausesCOLUMN_LIST 46FOR UPDATE 56FROM 50GROUP BY 52HAVING 54ORDER BY 54WHERE 52WITH 55
CLOSE statement 321
COALESCE function 85
Column constraints 9
COLUMN_LIST clause 46
Commit statement 12
CONCAT function 85
Concatenation operator 196
CONNECT statement 321
Conventional identifiers 190
CONVERT function (ODBC Compatible) 86
CONVERT function (Progress Extension) 87
COS function 87
COUNT function 88
CREATE INDEX statement 12, 13
CREATE PROCEDURE statement 15
CREATE SEQUENCE statement 17
CREATE SYNONYM statement 19
CREATE TABLE statement 20
CREATE TRIGGER statement 24
CREATE USER statement 27
CREATE VIEW statement 28
CURDATE function 89
CURTIME function 89
D
Data typesABL 187approximate numeric 197character 195date-time 198definition 195exact numeric 197OpenEdge SQL 187
DATABASE function 89
DatabaseMetaData 272
Date arithmetic expressions 212
Date formats 192
Date-time data types 198
Date-time formats 191
Date-time literals 204
DAYNAME function 91
DAYOFMONTH function 91
DAYOFWEEK function 92
DAYOFYEAR function 93
DB_NAME function 93
DECLARE CURSOR statement 323
DECODE function 94
DEGREES function 94
Delimited identifiers 190
DESCRIBE BIND VARIABLES statement 325
DESCRIBE SELECT LIST statement 326
DESCRIBE statement 325
DhSQLException 246
DhSQLException.getDiagnostics 246
DhSQLResultSet 247
DhSQLResultSet.insert 248
DhSQLResultSet.makeNULL 249
–2
Index
DhSQLResultSet.set 250
DISCONNECT CATALOG statement 30
DISCONNECT statement 327
DROP INDEX statement 31
DROP PROCEDURE statement 32
DROP SYNONYM Statement 32
DROP SYNONYM statement 33
DROP TABLE statement 33
DROP TRIGGER statement 34
DROP USER statement 35
DROP VIEW statement 35
E
Embedded SQL 319
Error Codesmessages 144SQLSTATE values 144
Escape clausein LIKE predicate 209
ESQLcompliance with industry standards 347statements 319
Exact numeric data types 197
EXEC SQL delimiter 330
EXECUTE IMMEDIATE statement 331
EXECUTE statement 330
EXISTS predicate 210
EXPfunction 95
Expressionsdate arithmetic 212numeric arithmetic 211
F
FETCH statement 332
FLOOR function 95
FOR UPDATE clause 56
Formatsdate 192date-time 191
number 191time 194
FROM clause 50
G
GET DIAGNOSTICS EXCEPTION statement 335
GET DIAGNOSTICS statement 334
GRANT statement 36
GREATEST function 96
GROUP BY clause 52
H
HAVING clause 54
HOUR function 96
I
Identifiersconventional 189delimited 189
IFNULL function 97
IN predicate 210query expressions in 210
Industry standards 231
INITCAP function 97
INSERT function 98
INSERT statement 39
INSTR function 99
Internationalizationspecific elements
LIKE predicate 210
J
Java Class Referenceclose 244err 246execute 244fetch 244found 245getDiagnostics 245getValue 245insert 245
Index–3
Index
Index
makeNULL 244open 244rowCount 244set 245setParam 243wasNULL 245
JDBC conformancedatatype conversion 271SQL-92 270supported data types 269
L
Language elements 189
LAST_DAY function 100
LCASE function 100
LEAST function 101
LEFT function 101
LENGTH function 102
LIKE predicate 209
Literalscharacter-string 204date-time 204numeric 203time 205timestamp 207
Literals syntax in BNF 218
LOCATE function 102
LOCK TABLE statement 40
LOG10 function 103
LOWER function 103
LPAD function 104
LTRIM function 105
M
MAX function 105
MIN function 106
MINUTE function 106
MOD function 107
MONTH 107
MONTH function 107
MONTHNAME function 108
MONTHS_BETWEEN function 108
N
NEXT_DAY function 109
NOW function 110
NULL predicate 209
NULLIF function 111
Number formats 191
Numeric arithmetic expressions 211
Numeric literals 203, 211
NVL function 111
O
ODBCdata types and OpenEdge 287date and time functions 313numeric functions 311Scalar functions 309SQLGetInfo 289string functions 309system functions 315
OPEN statement 338
OpenEdge SQL reserved words 139
OpenEdge SQL system limits 161
Operatorsrelational
in quantified predicates 208
ORDER BY clause 54
OUTER JOIN predicate 211
P
PI function 112
POWER function 112
Predicatesbasic 208BETWEEN 209EXISTS 210IN 210LIKE 209NULL 209OUTER JOIN 211quantified 208
PREFIX function 113
–4
Index
PREPARE statement 339
PRO_ARR_ESCAPE 115
PRO_ELEMENT function 115
Q
Quantified predicates 208query expressions in 208
QUARTER function 116
Query Expressionsin basic predicates 208in IN predicate 210in quantified predicates 208
Query Expressions syntax in BNF 219
R
RADIANS function 117
RAND function 117
Relational operators 207in quantified predicates 208
REPEAT function 118
REPLACE function 118
Reserved words 139
REVOKE statement 42
RIGHT function 119
ROLLBACK statement 44
ROUND function 120
ROWID function 121
RPAD function 122
RTRIM function 123
S
Search conditions syntax in BNF 221
SECOND function 123
SELECT statement 45
SET CATALOG statement 56
SET CONNECTION statement 341
SET PRO_CONNECT LOG statement 57, 58, 59
SET PRO_SERVER LOG statement 60
SET SCHEMA statement 61
SET TRANSACTION ISOLATION LEVEL Statement 62
SHOW CATALOGS statement 63
SIGN function 124
SIN function 124
SQLCursor 251
SQLCursor.close 252
SQLCursor.fetch 252
SQLCursor.found 253
SQLCursor.getParam 254
SQLCursor.getValue 255
SQLCursor.makeNULL 256
SQLCursor.open 257
SQLCursor.registerOutParam 258
SQLCursor.rowCount 258
SQLCursor.setParam 259
SQLCursor.wasNULL 260
SQLGetInfo 289
SQLIStatement 261
SQLIStatement.execute 261
SQLIStatement.makeNULL 262
SQLIStatement.rowCount 263
SQLIStatement.setParam 264
SQLPStatement 265
SQLPStatement.execute 265
SQLPStatement.makeNULL 266
SQLPStatement.rowCount 267
SQLPStatement.setParam 268
SQLSTATE values 144
SQRT function 125
SUBSTR function 125
SUBSTRING function (ODBC Compatible) 127
Index–5
Index
Index
SUFFIX function 128
SUM function 129
SYS_CHK_CONSTRS system table 184
SYS_CHKCOL_USAGE system table 183
SYS_KEYCOL_USAGE system table 184
SYS_REF_CONSTRS system table 184
SYS_TBL_CONSTRS system table 185
SYSCALCTABLE system table 167
SYSCOLAUTH system table 168
SYSCOLSTAT system table 169
SYSCOLUMNS core system table 166
SYSCOLUMNS_FULL system table 169
SYSDATATYPES system table 170
SYSDATE function 130
SYSDATESTAT system table 171
SYSDBAUTH system table 171
SYSFLOATSTAT system table 172
SYSIDXSTAT system table 172
SYSINDEXES core systemtable 167
SYSINTSTAT system table 173
SYSNCHARSTAT system table 168
SYSNUMSTAT system table 173
SYSNVARCHARSTAT system table 182
SYSPROCBIN system table 174
SYSPROCCOLUMNS system table 174
SYSPROCEDURES system table 175
SYSPROCTEXT system table 175
SYSREALSTAT system table 175
SYSSEQAUTH system table 176
SYSSEQUENCES system table 176
SYSSYNONYMS system table 177
SYSTABAUTH system table 177
SYSTABLES core system table 165
SYSTABLES_FULL system table 178
SYSTBLSTAT system table 179
System Catalog Tablesdescriptions 164overview 163
System limits 161
System tables and descriptions 164
SYSTIME function 130
SYSTIMESTAMP function 130
SYSTIMESTAT system table 180
SYSTINYINTSTAT system table 180
SYSTRIGCOLS system table 181
SYSTRIGGER system table 181
SYSTSSTAT system table 182
SYSTSTZSTAT 182
SYSTSTZSTAT system table 182
SYSVIEWS system table 183
T
TAN function 131
Time formats 194
Time literals 205
Timestamp literals 207
TO_CHAR function 132
TO_DATE function 132
TO_NUMBER function 133
TO_TIME function 133
TO_TIMESTAMP function 134
TOP clause 49
TRANSLATE function 134
U
UCASE function 135
UPDATE statement 68
UPDATE STATISTICS statement 69
UPPER function 136
USER function 136
–6
Index
W
WEEK function 137
WHENEVER statement 342
WHERE clause 52
WITH clause 55
Y
YEAR function 137
Index–7
Index
Index
–8