Open M/SQL Developer Guide

Transcription

1 Ope M/SQL Developer Guide Versio: Ope M/SQL F.6, F.7 Revisio Date: April 25, 1996 Prit History Creatio Date: July, 1992 Revisio Dates: March, 1993 September, 1995

2 Ope M/SQL Developer Guide Copyright IterSystems Corporatio 1995 All rights reserved NOTICE PROPRIETARY CONFIDENTIAL This documet cotais trade secret ad cofidetial iformatio which is the property of IterSystems Corporatio, Oe Memorial Drive, Cambridge, MA 02142, or its affiliates, ad is furished for the sole purpose of the operatio ad maiteace of the products of IterSystems Corporatio. No part of this publicatio is to be used for ay other purpose, ad this publicatio is ot to be reproduced, copied, disclosed, trasmitted, stored i a retrieval system or traslated ito ay huma or computer laguage, i ay form, by ay meas, i whole or i part, without the express prior writte coset of IterSystems Corporatio. The copyig, use ad dispositio of this documet ad the software programs described herei is prohibited except to the limited extet set forth i the stadard software licese agreemet(s) of IterSystems Corporatio coverig such programs ad related documetatio. IterSystems Corporatio makes o represetatios ad warraties cocerig such software programs other tha those set forth i such stadard software licese agreemet(s). I additio, the liability of IterSystems Corporatio for ay losses or damages relatig to or arisig out of the use of such software programs is limited i the maer set forth i such stadard software licese agreemet(s). THE FOREGOING IS A GENERAL SUMMARY OF THE RESTRICTIONS AND LIMITATIONS IMPOSED BY INTERSYSTEMS CORPORATION ON THE USE OF, AND LIABILITY ARISING FROM, ITS COMPUTER SOFTWARE. FOR COMPLETE INFORMATION REFERENCE SHOULD BE MADE TO THE STANDARD SOFTWARE LICENSE AGREEMENT(S) OF INTERSYSTEMS CORPORATION, COP- IES OF WHICH WILL BE MADE AVAILABLE UPON REQUEST. IterSystems Corporatio disclaims resposibility for errors which may appear i this documet, ad it reserves the right, i its sole discretio ad without otice, to make substitutios ad modificatios i the products ad practices described i this documet. M/SQL, M/PACT, ad M/NET are registered trademarks, ad IterSystems, Ope M, Ope M/SQL, ISM, DTM, DT-MAX, DT Widows, DSM, ad DASL are trademarks of IterSystems Corporatio. MUMPS, ow called M Techology, is a registered trademark of Massachusetts Geeral Hospital. DSM DDP, VAX, VMS, Ope VMS, ad DEC are trademarks of Digital Equipmet Corporatio. Microsoft, MS-DOS, Microsoft Access, ad, Excel are registered trademarks ad Widows, Visual Basic, ad Visual C++ are trademarks of Microsoft Corporatio. ORACLE is a registered trademark of Oracle Corporatio. For Support questios about ay IterSystems products, cotact the IterSystems Worldwide Support Ceter: U.S.: Tel: Fax: Europe: Tel: Fax: Iteret support@itersys.com

3 Preface Ope M/SQL is a itegrated eviromet for developig ad ruig database applicatios. It icludes a advaced relatioal database maagemet system, a applicatio ad report geerator, ad a procedural programmig laguage. Ope M/SQL combies two ANSI-Stadard laguages M, the oly procedural programmig laguage desiged specifically for database applicatios, ad SQL (Structured Query Laguage), the most widely used relatioal query laguage. Ope M/SQL provides two program developmet eviromets: The M eviromet, i which you ca execute system maagemet commads, ad create, modify, ad execute M routies. The relatioal eviromet, i which you defie the database i relatioal terms ad use the applicatio geerator tools to create, modify, ad execute advaced relatioal database applicatios. Ope M/SQL s relatioal eviromet is a complete RDBMS (Relatioal Database Maagemet System) it icludes a developmet eviromet for creatig advaced relatioal database applicatios, a maagemet system for maitaiig them, ad a ru-time eviromet for executig them. Ope M/SQL s relatioal eviromet has the followig compoets: Relatioal Data Dictioary eviromet where you defie tables to represet the logical structure of a relatioal database, or map the physical structure of a existig database to relatioal tables. These tables act as the foudatio o which Ope M/SQL relatioal database applicatios are built. Form Geerator a applicatio geeratio tool used to create ready-toru data screes through which ed users ca add, retrieve, edit, ad delete database iformatio. Ope M/SQL Developer Guide iii

4 Preface Meu Geerator a applicatio geeratio tool used to create pop-up meus ad meu bars which uite the various compoets of a applicatio i a logical ad visually sophisticated maer ad structure a applicatio by defiig how it is orgaized ad how it is preseted to ed users. M/PACT (Report Geerator) a report-writig tool used to create ad ru sophisticated ed-user data reportig applicatios that iteract with the Ope M/SQL Relatioal Data Dictioary. Query Geerator eviromet i which you ca create ad ru database queries o a ad-hoc basis. Relatioal Server a optioal compoet of Ope M/SQL that allows o-m applicatios to access ad modify your Ope M/SQL relatioal database. The Ope M/SQL Developer Guide describes all aspects of Ope M/SQL program developmet that are idepedet of cosideratios specific to hardware platform, operatig system, ad host M system. This documet provides a overview of the Ope M/SQL program developmet eviromet (icludig both the M eviromet ad the relatioal eviromet) ad presets various strategies for developig applicatios. More specifically, it cotais iformatio o the followig topics: Developmet of macro source routies Use of the Full Scree Editor Use of routie maagemet utilities Use of the Ope M/SQL developer utilities Overview of Ope M/SQL s implemetatio of SQL Various methods for usig SQL to query a Ope M/SQL relatioal database Audiece This documet is iteded for use by programmers who are usig IterSystems Ope M/SQL Developer product to create Ope M/SQL relatioal database applicatios. The term applicatio programmer i this documet refers to the programmers who create Ope M/SQL relatioal database applicatios. The term user i this documet refers to the ed user of a Ope M/SQL relatioal database applicatio. This documet assumes that you have programmig experiece. I specific, it assumes familiarity with programmig i the M laguage ad the SQL laguage. iv Ope M/SQL Developer Guide

5 Preface Orgaizatio of this Guide This maual is divided ito four sectios. Sectio I, Gettig Started, cotais the followig two chapters: Chapter 1, Itroductio to Ope M/SQL, itroduces IterSystems Ope M/SQL ad discusses its uses i a 4GL applicatio geerator eviromet. Chapter 1 begis with a discussio of applicatio developmet strategies, the goes o to discuss the compoets of Ope M/SQL ad their various applicatios. Chapter 2, The Ope M/SQL Relatioal Database, describes relatioal cocepts ad their implemetatio i SQL as well as the database cocept ad its implemetatio i Ope M/SQL. Sectio II, Program Developmet, cotais the followig five chapters: Chapter 3, Ope M/SQL Program Developmet, outlies the rage of facilities available for program developmet i Ope M/SQL. Chapter 4, Full Scree Editor, describes the Ope M/SQL Full Scree Editor used i editig macro source routies, itermediate code routies, ad iclude files. Chapter 5, Developig Macro Source Routies, describes how to create routies at the macro source level, icludig descriptios of all the macro costructs permitted by Ope M/SQL at this level. Chapter 6, Routie Hadlig ad Maiteace, presets a overview of the Ope M/SQL routie eviromet ad describes routie hadlig ad maiteace. Chapter 7, Ope M/SQL Routie Maagemet Utilities, describes the built-i utilities that IterSystems supplies to assist i examiig ad maipulatig routies ad iclude files. Sectio III, SQL Laguage Implemetatio, cotais the followig three chapters: Chapter 8, Embedded SQL, describes the two ways of usig SQL i a Ope M/SQL program: cursor-based ad o-cursor-based. Chapter 9, Ope M/SQL Implemetatio of SQL, describes extesios to ANSI-Stadard SQL that IterSystems has icorporated ito Ope M/SQL. Chapter 10, Query Geeratio ad Processig, describes the Query Geerator ad the Query Editor the two facilities provided by Ope M/SQL for the geeratio ad processig of ad hoc SQL queries. Ope M/SQL Developer Guide v

6 Preface Sectio IV, Applicatio Programmig, cotais the followig chapter: Chapter 11, Programmer Iterface to Applicatios, presets a overview of the M variables ad globals that iteract with forms ad reports. It also discusses the uses of iserted M code i a applicatio, the covetios for callig forms, reports, queries, ad meus ad emulatig forms, ad the cotets of applicatios. Chapter 12, Ope M/SQL Developer Utilities, describes the built-i utilities that IterSystems supplies to assist i examiig ad maipulatig routies ad iclude files. This guide cotais the followig appedices: Appedix A, SQL Error Messages, which lists ad describes all message codes (successful completio messages ad error messages) that ca be retured to the SQLCODE variable. Appedix B, Ope M/SQL Reserved Words, which lists all Ope M/SQL reserved words. Appedix C, Ope M/SQL Supported Termial Types, which lists all termial types curretly supported by Ope M/SQL. Appedix D, Keyboard Actios for the Full Scree Editor, which shows the keyboard mappig for usig the Full Scree Editor o keyboards associated with the termial types supported by Ope M/SQL/ A glossary defies the termiology used i this guide. vi Ope M/SQL Developer Guide

7 Preface Other Refereces Depedig o the cofiguratio of your system, you may also wish to refer to the followig guides: The Ope M/SQL Database Admiistrator s Guide, which describes how to cofigure, maage, ad maitai a Ope M/SQL eviromet, icludig both the applicatio developmet eviromet ad the applicatio ru-time eviromet. For sites that use the Ope M/SQL Relatioal Server to make Ope M/SQL data available to exteral applicatios, this guide also describes how to cofigure, maage, ad maitai the Relatioal Server. The Ope M/SQL User Iterface Programmig Guide, which describes how to use the applicatio geeratio tools withi Ope M/SQL Developer to create a user iterface for your relatioal database. These applicatio geeratio tools iclude the Form Geerator used to create ready-to-ru data screes through which ed users ca add, retrieve, edit, ad delete database iformatio; the Meu Geerator used to create pop-up meus ad meu bars which uite the various compoets of a applicatio i a logical ad visually sophisticated maer ad structure a applicatio by defiig how it is orgaized ad how it is preseted to users; ad the Applicatio Help Facility used to create ad deploy a cotext-sesitive o-lie help system for your Ope M/SQL relatioal database applicatio. The Ope M/SQL Data Dictioary Guide, which describes how to defie tables to represet the logical structure of a relatioal database, or how to map the physical structure of a existig database to relatioal tables. These tables act as the foudatio o which Ope M/SQL relatioal database applicatios are built. The Ope M/SQL Relatioal Cliet User Guide, which describes how to access a Ope M/SQL relatioal database (retrieve ad modify data) from various third-party applicatio developmet tools. The Ope M/SQL Server Programmig Guide, which describes how to access a Ope M/SQL relatioal database from applicatios created usig the C or C++ programmig laguage. The M/PACT Guide, which describes how to create ad ru sophisticated ed-user data reportig applicatios that iteract with the Ope M/SQL Relatioal Data Dictioary. A tutorial etitled Ope M/SQL: A Getle Itroductio, which uses a project maagemet demostratio applicatio to show how to develop ad use a Ope M/SQL applicatio. The Ope M/SQL M Programmig Guide, which describes ISM (IterSystems origial implemetatio of the M programmig laguage), icludig global database cocepts, the developmet of itermediate code routies, ad the use of ISM utilities. Ope M/SQL Developer Guide vii

8 Preface The appropriate system guide for your Ope M system platform, which describes the system-specific elemets of usig Ope M o your particular computer ad operatig system. viii Ope M/SQL Developer Guide

9 Preface Typographic Covetios Used i this Guide This guide observes the followig typographic covetios: Covetio Descriptio Body text appears i Times Roma type. Computer geerated iformatio appears i Courier type. Computer geerated required fields appear i Courier Bold type. User iput appears i Courier Bold Italic type. Keystrokes appear i uppercase ad eclosed withi agle brackets. Simultaeous keystrokes appear hypheated, i uppercase, ad eclosed withi agle brackets. Commad sytax appears ideted i Courier type with variable iformatio i Courier Italic type ad eclosed withi agle brackets. Examples of user-typed commads appear ideted i Courier Bold Italic type. Procedure titles appear i bold Helvetica type ad are desigated by a uderlied sidehead prefix. Note, Cautio, Warig, ad Hit statemets appear i Helvetica type with a appropriate sidehead. Titles of other guides ad other chapters withi this guide appear i Times Italic type. Example Ope M/SQL offers a variety of strategies for developig a applicatio. Likig/Sytax Checkig...DONE Update New M Database Defaults? Yes <RETURN> <CTRL-Z> > do setaid^%msql( <UserName> ) > do setaid^%msql( Zeus ) Procedure Note To access the System Cofiguratio widow: Turig DBMS security OFF is a useful way to guaratee access to curret applicatios by users who will eed them while you are i the process of implemetig a privilege system. Ope M/SQL User Iterface Programmig Guide Ope M/SQL Developer Guide ix

10 Preface x Ope M/SQL Developer Guide

11 Table of Cotets Preface Audiece iv Orgaizatio of this Guide v Other Refereces vii Typographic Covetios Used i this Guide ix Part I Gettig Started 1 Itroductio to Ope M/SQL What Is Ope M/SQL? What Is Ope M/SQL Developer? Applicatio Developmet Strategies Automated Program Geeratio Procedural Programmig i ANSI M Mixed Eviromets Overview of the System Eviromet Hardware ad Operatig System Eviromets Memory Eviromet Global Database ANSI-Stadard M Laguage Processor ANSI-Stadard SQL Laguage Processor Relatioal Data Dictioary Program Developmet Eviromet The Form Geerator ad M/PACT Meu Geerator Query Optimizer M/NET Networkig Ope M/SQL Developer Guide xi

12 Table of Cotets DT Network Ope M/SQL Rus o Top of Ay M Implemetatio Itegratio of Two ANSI Stadards Embedded SQL Iserted Code for Data Dictioary, Forms, ad Reports Accessig the Global Database SQL - Relatioal Database Access M Global Refereces Ope M/SQL Program Structure Macro Source Routies Itermediate Code Routies Object Code Routies Ope M/SQL Routie Utilities ad Editors Distributed Data Processig The Ope M/SQL Relatioal Database Ope M/SQL Implemets Relatios as Tables Ope M/SQL Tables Follow The First Normal Form Ope M/SQL Supports Two Types of Tables Ope M/SQL Implemets Schemas as M Directories Ope M/SQL Database Structure for No-ISM Implemetatios of M. 2-4 The Ope M/SQL Relatioal Data Dictioary Accessig Data i a Ope M/SQL Relatioal Database Usig SQL to Query the Database Cartesia Product Project Restrict Jois IterSystems Extesios to the Relatioal Model Oe-Way Outer Jois Implicit Jois Multi-Lie Fields Part II Program Developmet 3 Ope M/SQL Program Developmet Programmig Methods The Full Scree Editor Itermediate Code Routies Routie Lie Editor xii Ope M/SQL Developer Guide

13 Table of Cotets Routie Maagemet Utilities Developer Utilities Programmer Iterface to Applicatios Full Scree Editor Overview of the Full Scree Editor Full Scree Editor Features Routie Types for Editig Ivokig the Full Scree Editor Loadig Existig Routies Creatig New Routies Prevetig Overwrites Full Scree Editor Scree Display Navigatig the Full Scree Editor Meu System Primary Meu Buffers Meu Widows Meu Mark Meu Other Meu Editig Operatios Movig the Cursor Isertig Text DeletigText Cuttig ad Pastig Text Editig Multiple Copies of a Routie Displayig Multiple Buffers Settig a Mark i Your Curret Buffer Searchig For Text Strigs ReplacigText Strigs Usig Cotrol Key Commads for Quicker Editig Gettig Help Exitig the Full Scree Editor Automatic Sytax Checkig Automatic Date ad Time Stamps Developig Macro Source Routies Creatig Macro Source Routies Compilig Macro Source Routies Macro Source Routies ad Iclude Files Macro Source Routies Are Portable Across M Implemetatios Ope M/SQL Developer Guide xiii

14 Table of Cotets The Ope M/SQL Macro Preprocessor Macro Preprocessor Commads Macro Preprocessor Fuctios Macro Refereces Summary of Macro Preprocessor Commads #defie ad #udef Nested Expasio #ifdef, #ifudef, #if, #else, #elseif, ad #edif #iclude Idicatig Commet Lies Summary of Macro Preprocessor Fuctios &sql(...) ##vedor Routie Hadlig ad Maiteace Routie Eviromet Writig Routies Covertig Itermediate Code to Macro Source Code Routie Names, Extesios, ad Versio Numbers Routie Names Must Be Uique Case Sesitivity Routie Extesios Versio Numbers Usig Wildcard Symbols to Specify Routies Wildcards for Routie Names Wildcards for Extesios Wildcards for Versio Numbers Referecig Routies i Other Directories Restrictios o Usig Remote Directory Sytax Routie Sets Creatig a Routie Set Usig a Routie Set Compilig Routies Backig Up Routies How Backups are Shuffled ad Reumbered The Full Scree Editor Geerates Backups Whe You Save Restorig a Backup Versio to the Curret Versio Deletig Routies %urdel %urpurge Routie Copyig ad Compilig Sychroizatio xiv Ope M/SQL Developer Guide

15 Table of Cotets 7 Ope M/SQL Routie Maagemet Utilities Summary of Routie Maagemet Utilities Accessig the Routie Maagemet Utilities Callig the Routie Utilities Directly from M Accessig the Routie Utilities from withi Ope M/SQL %urprit Selectig a Output Device %urload Routie Iput Optios Compile Macro Source Routies %urdir %urchage %urcomp %urcopy %urfid %urfad %urdel %urverma %urpurge %urset The Global ^mtemp Parameters of %urset Part III SQL Laguage Implemetatio 8 Embedded SQL Preprocessor Sytax Delimits Embedded SQL Ope M/SQL Supports Two Kids of Embedded SQL No-Cursor-Based SQL Cursor-Based SQL Referecig Macros i Embedded SQL Iteral ad Exteral Values Multi-Lie Values Reserved Tag ad Variable Names Portability Detailed Example Ope M/SQL Developer Guide xv

16 Table of Cotets 9 Ope M/SQL Implemetatio of SQL Summary of Extesios Added Keywords ad Symbols Jois Oe-Way Outer Jois Implicit Jois Aggregate Extesios Aggregates as Query Colums %FOREACH %AFTERHAVING DISTINCT BY Duplicate Rows Embedded SQL Usig the INTO Clause You May Use INTO i Cursor Declaratio Usig INTO with Arrays SELECT INTO Usig Arrays INSERT ad UPDATE INTO Usig Arrays VALUES Extesio for INSERT ad UPDATE Queries Multi-Lie Fields Usig Multi-Lie Fields i SELECT Queries Usig Multi-Lie Fields i INSERT ad UPDATE Queries Iteral ad Exteral Values %INTERNAL ad %EXTERNAL Fuctios M Operators Patter Match Operator Ca Test Variables Extesios to SQL Operators [NOT] IN Operator Cocateatio Operator %STARTSWITH LIKE Predicate Special Patter Matchig Characters Specifyig a Host Variable as the Search Patter ESCAPE Qualifier Error Hadlig Collatio Sequece EXACT ALPHAUP UPPER Plus, Mius, ad Space xvi Ope M/SQL Developer Guide

17 Table of Cotets Field Collatio Sequece Collatio Sequece ad ORDER BY Collatio Sequece ad Comparisos %ALPHAUP, %UPPER, ad %EXACT Chagig the Default Collatio Sequece %NOCHECK SQL Trasactio Processig Privilege Operators GRANT REVOKE %CHECKPRIV Keyword SQLCODE Values Usig Subqueries Usig a Subquery i a WHERE Clause Usig a Subquery i a FROM clause Ope M/SQL Subquery Extesios Query-Based Views CREATE VIEW ALTER VIEW DROP VIEW Restrictios o Defiig Query-Based Views You May Name Query-Based Views i FROM Clause Query Geeratio ad Processig Facilities for Creatig SQL Queries Accessig the Query Geeratio Facilities Usig the Query Geerator Example Query Defiitio Meu Bar Usig the Iteractive Query Editor Query Types Creatig a Query i the Iteractive Query Editor Editig Commads Query Editor Horizotal Optios Meu Ruig Queries Privileges Required to Ru Queries Ruig a Query From its Defiitio Eviromet Usig the Ru Existig Queries Utility Ruig a Query from M Code Selectig a Output Device Ope M/SQL Developer Guide xvii

18 Table of Cotets ASCII-Delimited Output for Queries Cotets of a ASCII-Delimited File Queries Support Dual Output Formats Copyig Queries List Queries Report Detailed Query Listig Report Part IV Applicatio Programmig 11 Programmer Iterface to Applicatios Ope M/SQL Variables List of Ope M/SQL Percet (%) Variables Etry Poits to the %msql Routie Ope M/SQL Globals Object Defiitio Globals Ope M/SQL Percet (%) Globals Isertig Code ito Ope M/SQL Applicatios Iserted Code Ca Referece Fields Iserted Code Ca Referece Variables ad Globals Ope M/SQL Performs Sytax Checkig o Iserted M Code Triggers Override Queries for Lookups Computed Fields Iteral/Exteral Coversio Code Additioal Validatio Code Required-Maybe Fields Map Subscripts ad Pieces NEXT Subroutie Coditioal Map Callig Ope M/SQL Objects from M Programs Callig Forms Callig Reports Callig Queries Callig Old-Style Meus Callig Meu Objects Emulatig Form Behavior from M Programs Displayig Help Text i a Help Text Box Writig Message Text Readig Fields Cleaig Up Widows xviii Ope M/SQL Developer Guide

19 Table of Cotets Establishig Authorizatio ID from Programmer Mode Itermixig Ope M/SQL Objects with User-Defied M Routies pushvars^%msqlutl popvars^%msqlutl $$msqlvars^%msqlutl Cotets of Applicatios Routie Names Cotets of Base Table Routies Cotets of Form Routies Cotets of Meu Object Routies Cotets of Old-Style Meu Routies Cotets of Report Routies Cotets of Query Routies Ope M/SQL Developer Utilities Accessig the Developer Utilities Meu Usig the Object Compile Driver Utility Settig Compilatio Optio Defaults Defiig the Cotets of a Compilatio Cofiguratio Compilig the Cofiguratio Viewig the Results of the Last Compilatio Compilig a Compilatio Cofiguratio from M Program Code Checkig the Itegrity of Ope M/SQL Objects Checks o Base Tables Checks o Views Checks o Forms Checks o Reports Checks o Meu Objects Checks o Triggers Ruig the Itegrity Checker Utility Error Fixig Mode Searchig for Strigs i Ope M/SQL Objects Ivokig Macro Source Routie Utilities Queryig Objects by Routie Prefix Natioal Laguage Reports Ope M/SQL Developer Guide xix

20 Table of Cotets Appedices A B C D SQL Error Messages Successful Completio Messages A-2 Error Messages A-3 Ope M/SQL Reserved Words Ope M/SQL Supported Termial Types Ope M/SQL for DSM C-3 Ope M/SQL for DTM C-3 Ope M/SQL for MSM Eviromet C-3 Full Scree Editor Keyboard Actios Altos D-1 ANSI D-4 CIT D-7 Dasher D-11 IBM 3151 ASCII Display Statio D-13 IBM PC D-17 QUME D-20 Su D-23 Televideo D-26 DEC VT D-29 DEC VT D-32 DEC VT D-35 WYSE-60 (Native Mode) D-39 Glossary of Terms Idex xx Ope M/SQL Developer Guide

21 PART Gettig Started I Chapter 1 Itroductio to Ope M/SQL Chapter 2 The Ope M/SQL Relatioal Database

22

23 CHAPTER Itroductio to Ope M/SQL 1 This chapter itroduces IterSystems Ope M/SQL ad discusses its uses i a 4GL applicatio geerator eviromet. Specifically, it covers the followig topics: What Is Ope M/SQL? What Is Ope M/SQL Developer? Applicatio Developmet Strategies Overview of the System Eviromet Itegratio of Two ANSI Stadards Accessig the Global Database Ope M/SQL Program Structure Ope M/SQL Developer Guide 1-1

24 Chapter 1 Itroductio to Ope M/SQL What Is Ope M/SQL? Ope M/SQL is a itegrated eviromet cosistig of a advaced relatioal database maagemet system, applicatio geerator, ad procedural programmig laguage that offers a variety of strategies for developig ad ruig database applicatios. Ope M/SQL combies two ANSI Stadard programmig laguages, SQL ad M. SQL is the most widely used relatioal query laguage. M is a database-orieted procedural laguage that has bee used to develop ad ru performace-critical olie applicatios at thousads of sites. The merger of these two laguages provides a powerful stadards-based system that offers extremely high performace. The Ope i Ope M/SQL refers to its ope systems architecture, which allows it to ru i a vedor-idepedet host M eviromet. Specifically, you ca develop ad ru Ope M/SQL applicatios o top of the followig M implemetatios: ISM DTM DSM Microetics MSM All Ope M/SQL applicatios are completely portable betwee these M systems. This meas you ca develop a applicatio o oe M system, the port it to aother M system without makig ay modificatios. 1-2 Ope M/SQL Developer Guide

25 What Is Ope M/SQL Developer? What Is Ope M/SQL Developer? Ope M/SQL Developer is IterSystems developmet eviromet for creatig Ope M/SQL relatioal applicatios. Ope M/SQL Developer ecompasses the relatioal Data Dictioary, where you defie relatioal data structures, the Form Geerator, where you build iteractive data etry screes, ad the Meu Geerator, where you brig the various compoets together ito a coheret applicatio. It also supports various applicatios of SQL, icludig the iteractive costructio of queries ad the embeddig of SQL code withi M routies. Ope M/SQL Developer allows you to produce sophisticated reports, queries, ad forms with speed ad ease. The Ope M/SQL Data Dictioary describes the elemets of a Ope M/SQL relatioal database ad as such costitutes the structural foudatio of a Ope M/SQL applicatio. The Data Dictioary provides a advaced, widow-based approach to defiig, storig, ad retrievig data. The Ope M/SQL Form Geerator creates ready-to-ru data etry screes to add, delete, retrieve, ad edit database iformatio. The geerated forms are equipped with data validatio, full-scree display hadlig, powerful fuctio keys, ad SQL queries used iterally to retrieve ad store data. M/PACT is a Ope M/SQL add-o optio that allows you to geerate highly formatted reports from data served by the relatioal Data Dictioary. The Ope M/SQL Relatioal Server is a related product that allows o-m, third party applicatio developmet tools ad C programs o cliet systems to access your Ope M/SQL relatioal databases o a server system. Ope M/SQL Developer Guide 1-3

26 Chapter 1 Itroductio to Ope M/SQL Applicatio Developmet Strategies Ope M/SQL offers a variety of strategies for developig a applicatio: developmet ca take place at a purely automated level; programs ca be etirely had-coded; or, most commoly, applicatios ca be developed i a mixed eviromet that icludes programs created usig M, the Ope M/SQL procedural programmig laguage, as well as automatically-geerated forms, reports, ad SQL queries, ad other acillary fuctios usig the applicatio geeratio tools of Ope M/SQL. The followig discussio addresses the differet strategies for applicatios developmet i Ope M/SQL. Automated Program Geeratio Automated program geeratio takes place i five phases: 1. Map the fuctioal specificatios for the applicatio out o paper. 2. Defie the data structures i the Data Dictioary, alog with itegrity costraits, table relatioships, ad triggers. 3. Use the Form Geerator to develop data etry ad iquiry forms. 4. Use M/PACT to develop reports. 5. Use the Meu Geerator to tie the differet parts of the applicatio together. Mappig the Fuctioal Specificatios The first step i developig a applicatio is to orgaize the logical structure of the data o paper as a series of tables, just as you might desig a paper filig system. To do this, cosider the fuctioal eeds of your applicatio ad make a list of all the differet pieces of data that you eed. The object of the desig is to describe the tables that costitute the database ad how those tables will iteract with oe aother. For example, oe applicatio might have a customer table, a ivoice table, a ivoice lie item table, a parts table, etc. The customer table might the cosist of fields for customer ame, address, phoe, curret balace, etc. Defiig the Data Structure i the Data Dictioary Oce you have desiged a data structure o paper, you ext defie that data structure i the Ope M/SQL Data Dictioary, alog with ay itegrity costraits o the data. See the Ope M/SQL Data Dictioary Guide for details about how to create ad modify the uderlyig M global structure for your relatioal database. Itegrity costraits may be very simple; for example, you ca specify a rage of valid umbers that ca be etered for a field. Other costraits may be more complex; perhaps you wat to specify that a ivoice caot be etered ito the ivoice table without a correspodig customer etry i the customer table. Eve 1-4 Ope M/SQL Developer Guide

27 Applicatio Developmet Strategies more complex costraits may require the additio of complete SQL queries or procedural M code. The Data Dictioary will also cotai descriptios of the relatioships betwee tables. For example, where rows of a ivoice lie item table caot exist without a correspodig row i a ivoice table, the lie item table should be defied as a characteristic table of the ivoice table. Oe field i the ivoice table should also be defied to serve as a desigative referece to rows i the customer table. Ope M/SQL uses this iformatio to eforce itegrity costraits ad produce automatic jois i queries. You may also defie processig triggers i the Data Dictioary. Triggers are sequeces of actios defied to automatically occur, or be triggered, whe certai other evets occur. A trigger defiitio usually cosists of a SQL query or M code segmet that should be ivoked whe rows are created, modified, or deleted. For example, if a medical record for a give patiet is deleted, you may wat to establish a trigger that will automatically delete all of that patiet's lab test iformatio from various lab files. Developig Forms ad Reports Oce you have defied the data structure i the Data Dictioary, the ext step is to geerate forms that eable data etry ad iquiry usig the Form Geerator. See the Ope M/SQL User Iterface Programmig Guide for details about how to use the Form Geerator. Forms are sets of widows for eterig, retrievig, modifyig, ad displayig data. The Form Geerator creates visually sophisticated widows complete with data validatio capabilities, full scree display hadlig, ad powerful fuctio keys. The Form Geerator uses iterally stored SQL queries to retrieve ad store data. You ca geerate widows automatically ad modify them easily usig cut-ad-paste editig facilities. For more complex applicatios, you ca ehace the widows by addig SQL queries or M code to the widow defiitio. You ca add very simple lies of code, or add etire programs that perform complex calculatios or geerate their ow displays ad prompts i cooperatio with the Form Geerator. M/PACT geerates reports. Reports are defied through a series of questios o the scree; o complex procedural programmig is required. See the Ope M/SQL M/PACT Guide for iformatio about usig M/PACT. SQL queries ca be etered iteractively through the SQL Query Defiitio widow. Ope M/SQL Developer Guide 1-5

28 Chapter 1 Itroductio to Ope M/SQL Tyig the Applicatio Together with the Meu Geerator The Meu Geerator ties the differet compoets of the applicatio together. You may create pop-up meus ad meu bars that uite the various compoets of a applicatio, apply a orderly structure to the applicatio, ad offer the user easy access. For details about creatig ad usig the Meu Geerator, see the Ope M/SQL User Iterface Programmig Guide. Procedural Programmig i ANSI M It is also possible to develop applicatios etirely i M, a powerful procedural programmig laguage that affords rapid program developmet ad high performace i a database applicatio eviromet. M is a ANSI Stadard procedural programmig laguage. Other ANSI Stadard procedural programmig laguages iclude COBOL, C, FORTRAN, PL/1, BASIC, ad PASCAL. Withi M programs, data ca be accessed i the followig ways: Directly through M global refereces that view the database as a collectio of arrays; Through stadard SQL Data Maipulatio Laguage (DML) costructs: isert, update, ad delete. Cursors are fully supported. For stadard SQL sytax, refer to a commercial textbook or the ANSI X stadard, also kow as ISO 9075:1989. Through embedded SQL queries that access or edit a sigle row (provided you have also defied the data structures i the Data Dictioary); Through embedded SQL queries that access multiple rows oe row at a time usig cursors; Through embedded SQL queries usig UPDATE or DELETE statemets that operate o multiple rows. Direct global refereces ad SQL queries ca be used to access the same data. Programmig i a procedural laguage allows the creatio of complex programs that use sophisticated algorithms. However, procedurally geerated programs take loger to develop ad are more difficult to maitai tha applicatios geerated automatically i Ope M/SQL. The combied power of M, the Data Dictioary, the Form Geerator, M/PACT, ad SQL delivers a flexible, productive, ad easily maitaied eviromet for applicatio developmet. 1-6 Ope M/SQL Developer Guide

29 Applicatio Developmet Strategies Mixed Eviromets While may applicatios ca be developed etirely through automatic geeratio, ad some are so specialized that they must be etirely had coded, most applicatios fall somewhere i betwee. For this, Ope M/SQL offers the advatages of a mixed programmig strategy. It geerally makes sese to use the Form Geerator ad M/PACT to develop as much of the applicatio as possible, utilizig customizatio capabilities where ecessary. The, use M to program those portios that have to be writte procedurally. Thus, a laboratory applicatio might perform most of its data etry through geerated widows but use M for direct iput from specialized istrumets. The result is a itegrated applicatio created ad ru etirely withi Ope M/SQL. Ope M/SQL Developer Guide 1-7

30 Chapter 1 Itroductio to Ope M/SQL Overview of the System Eviromet Ope M/SQL rus o a variety of platforms ad offers a varied systems eviromet. It also rus i a vedor-idepedet host M eviromet, equally supportig the ISM, DTM, DSM, ad Microetics MSM implemetatios of M. The followig discussio itroduces the various elemets of the system eviromet, icludig: Hardware ad Software Operatig System Eviromets Memory Eviromet Global Database ANSI M Processor ANSI SQL Processor Relatioal Data Dictioary Program Developmet Eviromet The Form Geerator ad M/PACT Meu Geerator Query Optimizer M/NET Networkig DT Network Ope M/SQL Rus o Top of Ay M Implemetatio Hardware ad Operatig System Eviromets Ope M/SQL rus o a variety of hardware platforms ad operatig systems, ragig from sigle-user PCs to large UNIX- ad VMS-based systems supportig may hudreds of users, icludig most major supermicro ad miicomputer systems from the leadig hardware vedors. Operatig systems iclude MS- DOS, Microsoft Widows 3.1, VMS, ad Uix. Oe of Ope M/SQL s most exceptioal features is its portability. Although the host operatig system may vary, the Ope M/SQL eviromet is cosistet across platforms. Applicatios developed o oe system ca be moved to aother easily ad usually with o modificatio. Frequetly, these applicatios ca be ported with o chages. 1-8 Ope M/SQL Developer Guide

31 Overview of the System Eviromet Memory Eviromet Global Database Each M process rus as a separate process o the host operatig system, except for MS-DOS ad Microsoft Widows systems. I additio to a private memory sectio for each M process, there are two cofigurable caches, oe for database trasactios ad oe for shared re-etrat use of applicatio programs. The global database is paged i a data pool that is shared by all of the processes, ad rutime code is shared amog processes. This strategy results i a highly optimized, memory-efficiet system. The global database is the physical structure that cotrols the storage of data. The database ca be accessed through SQL requests or M global refereces, as the programmer sees fit. A full set of utilities for database maagemet are also provided. ANSI-Stadard M Laguage Processor The M programmig laguage is widely used for database applicatios, particularly i iteractive eviromets. Although it is best kow for offerig programmers the ability to develop programs rapidly ad chage them easily, M is also recogized for providig high performace i iteractive trasactio-orieted database eviromets. M is oe of the few laguages that is defied by a ANSI Stadard, which idicates its importace to a wide audiece i the data processig commuity. Coformity to this stadard protects software ad hardware ivestmets ad facilitates a level of portability ucommo i other programmig laguages. M is accepted by ANSI-Stadard SQL as a host laguage for embedded SQL. ANSI-Stadard SQL Laguage Processor ANSI-Stadard SQL is the most widely used query laguage for relatioal database systems. Ope M/SQL permits SQL queries to be etered directly through a iteractive widow, or to be embedded i M routies. SQL ca be used ot oly to retrieve data, but also to isert, update, ad delete data. IterSystems SQL implemetatio is compatible with ANSI-Stadard SQL. IterSystems also provides umerous SQL laguage extesios to ehace the power of SQL queries. Ope M/SQL Developer Guide 1-9

32 Chapter 1 Itroductio to Ope M/SQL Relatioal Data Dictioary Ope M/SQL icludes a advaced relatioal Data Dictioary that allows you to defie the database as a group of tables. Extesive capabilities are built ito the Data Dictioary to avoid code redudacy. Data Dictioary maps defie the coectio betwee the logical ad physical storage structure of the tables. Maps ca be automatically geerated to produce default structured tables. Alteratively, advaced M programmers may wish to defie their ow maps to coform with the global structures of existig applicatios or to desig a ew database structure compliat to applicatio specificatios. Relatioships amog tables ca be described i the Data Dictioary by defiig characteristic or desigative relatioships betwee tables. Whe you defie these relatioships i the Data Dictioary, jois amog tables are implicit ad occur i queries automatically, freeig the programmer ad ed-user from the tedious ad demadig task of specifyig explicit jois i SQL statemets. The Data Dictioary ca also be used to eforce itegrity costraits that apply to database modificatios made usig SQL ad forms desiged usig the Form Geerator. Processig triggers ca be attached to evets i database update ad form executio that cause related processig to occur automatically. For example, a trigger ca specify that whe a ivoice is deleted, associated lie items of the ivoice are also deleted. The system thus provides a meas to eforce referetial itegrity ad to defie applicatio-specific processig i the dictioary, elimiatig redudat programmig efforts. A database is defied as a fuctioally-related group of tables that have bee explicitly liked i the Data Dictioary. Tables i a sigle database ca be used to create a view. Views are cosidered virtual tables because they appear to be tables to the ed user, but are ot stored as such i the database. A view ca be used as a data source i queries ad reports. Views also perform a security fuctio by restrictig users' access to specified fields i database tables. Although describig the database i the Data Dictioary is essetial to the use of SQL queries, the Form Geerator, ad M/PACT, it is ot required for M programs that access the database oly through direct global refereces. Program Developmet Eviromet A Ope M/SQL applicatio ca cosist of data structures defied etirely i the Data Dictioary, with forms for data etry ad iquiry developed usig the Form Geerator ad reports for data output developed usig M/PACT. Alteratively, you ca write programs i the ANSI M programmig laguage, which is exteded i Ope M/SQL to allow the use of macros, iclude files, ad embedded SQL (M is a ANSI-approved host laguage for SQL). Ope M/SQL also provides a full set of utilities for routie developmet ad maagemet Ope M/SQL Developer Guide