Informix Migration Guide

Transcription

1 Informix Migration Guide Informix Dynamic Server, Version 7.3 Informix Dynamic Server with Advanced Decision Support and Extended Parallel Options, Version 8.2 Informix Dynamic Server with Universal Data Option, Version 9.1x Informix Dynamic Server, Developer Edition, Version 7.3 Informix Dynamic Server, Workgroup Edition, Version 7.3 INFORMIX-OnLine, Version 4.1x and 5.x INFORMIX-OnLine Dynamic Server, Version 6.0 through 7.2x INFORMIX-OnLine Workgroup Server, Version 7.12 and 7.22 INFORMIX-OnLine XPS, Version 8.1x INFORMIX-SE, Version 4.1 through 7.2x February 1998 Part No

2 Published by INFORMIX Press Informix Software, Inc Bohannon Drive Menlo Park, CA Copyright by Informix Software, Inc. or its subsidiaries, provided that portions may be copyrighted by third parties, as set forth in documentation. All rights reserved. The following are worldwide trademarks of Informix Software, Inc., or its subsidiaries, registered in the United States of America as indicated by, and in numerous other countries worldwide: Answers OnLine ; INFORMIX ; Informix ; Illustra ; C-ISAM ; DataBlade ; Dynamic Server ; Gateway ; NewEra All other names or marks may be registered trademarks or trademarks of their respective owners. Documentation Team: Twila Booth, Beth Delson, Evelyn Eldridge-Diaz RESTRICTED RIGHTS/SPECIAL LICENSE RIGHTS Software and documentation acquired with US Government funds are provided with rights as follows: (1) if for civilian agency use, with Restricted Rights as defined in FAR ; (2) if for Dept. of Defense use, with rights as restricted by vendor's standard license, unless superseded by negotiated vendor license as prescribed in DFAR Any whole or partial reproduction of software or documentation marked with this legend must reproduce the legend. ii Informix Migration Guide

3 Table of Contents Table of Contents Introduction About This Manual Types of Users Assumptions About Your Locale Demonstration Databases New Features New Features in Version New Features in Version Documentation Conventions Typographical Conventions Icon Conventions Syntax Conventions Command-Line Conventions Sample-Code Conventions Additional Documentation On-Line Manuals Printed Manuals Error Message Files Documentation Notes, Release Notes, Machine Notes Compliance with Industry Standards Informix Welcomes Your Comments

4 Section I Chapter 1 Chapter 2 Migrating Data Data Migration Overview Overview of Informix Database Servers Planning for Data Migration Informix Database Server Versions Database Server Migration Paths Automatic Migration Between Database Servers Migrating to a Different Operating System Tools for Moving Data Choosing the Appropriate Migration Utility Moving Between Computers Using onunload and onload to Migrate Data Steps for Using onunload and onload Other Migration Utilities Importing Data from a Non-Informix Source Using the INFORMIX-Enterprise Gateway Products Using the High-Performance Loader Section II Migrating Versions of Database Servers Chapter 3 Migrating OnLine Dynamic Server 7.2 to AD/XP 8.2 Preparing to Migrate to Dynamic Server with AD and XP Options Changes Introduced by Dynamic Server with AD and XP Options High Degree of Parallelism What are Coservers, Cogroups, and Dbslices? Environment Variables Configuration Parameters The sqlhosts File or Registry Database Schema Logging and Non-Logging Table Types Utilities INFORMIX-Enterprise Command Center New Indexes Global Language Support iv Informix Migration Guide

5 Loading and Unloading Data Express Mode Deluxe Mode Migrating From OnLine Dynamic Server 7.2 to Dynamic Server with AD and XP Options File-System Variations Migration Procedures Configure and Check Available Space Save Copies of the Current Configuration Files Close All Transactions in OnLine Dynamic Server Go to Quiescent Mode Verify the Integrity of the Data Verify the Mode Make a Final (Level-0) Backup Unload Your Data Bring the Source Database Server Off-Line Reconfigure the Operating System Install Dynamic Server with AD and XP Options Set Environment Variables Copy Utilities Update the ONCONFIG Configuration Files Bring Dynamic Server with AD and XP Options On-Line Use onutil to Create Cogroups and Dbslices Create a Database Load Data from External Tables Run UPDATE STATISTICS and Build Indexes Verify the Integrity of the Data Make an Initial Backup Check Rejection Files Recompile ESQL/C Programs Migration Complete Reverting AD/XP 8.2 to OnLine Dynamic Server Unloading to External Tables Migrating Between OnLine XPS 8.1x and Dynamic Server with AD and XP Options Migration Procedures Migrating from Previous 8.x Versions Table of Contents v

6 Chapter 4 Migrating the 7.2 Database Server to Version 9.1x Preparing to Migrate to Universal Server or Informix Dynamic Server with Universal Data Option Changes Introduced by Universal Server Environment Variables Configuration Parameters New Database Storage Spaces New Options Syntax in the Sqlhosts File or Registry Global Language Support Migrating from OnLine Dynamic Server 7.2x to Universal Server or Dynamic Server with UD Option Migration Procedures Check Available Space Save Copies of the Current Configuration Files Close All Transactions Initiate a Fast Recovery Verify the Integrity of the Data Verify the Mode Make a Final Backup Bring the Source Database Server Off-Line Reconfigure the UNIX Operating System Install the Target Database Server Verify That Environment Variables Are Set Correctly Update the ONCONFIG Configuration Files Add a Communications Support Module (Optional) Update the ON-Archive Configuration Files Bring The Target Database Server On-Line Verify the Integrity of the Data Make an Initial Target Database Server Backup Migration Complete Install and Configure Datablade Modules Reverting Universal Server or Dynamic Server with UD Option to OnLine Dynamic Server Determine Whether Reversion Is Possible Save Copies of the Configuration Files Verify the Integrity of the Data Back Up Your Source Database Server Remove Universal Server or Dynamic Server with UD Option Features Run the Reversion Utility Modify Configuration Parameters Reset Environment Variables Remove Communications Support Module Settings Install and Start the Target Database Server vi Informix Migration Guide

7 Verify the Integrity of the Data Back Up the Target Database Server Return the Target Database Server to On-Line Mode Upgrading Universal Server 9.10 to Dynamic Server with UD Option Chapter 5 Migrating the Database Server 6.0 or Later to 7.3 Changes Introduced in Database Server Version 6.0 to Version Environment Variables Introduced in Version Configuration Parameters Introduced in Version Features Introduced in Version Environment Variable Changes in Version 7.2x Configuration Parameter Changes in Version 7.2x Environment Variable Changes in Version 7.10.UD Configuration Parameter Changes in Version 7.10.UD Changes to Blobspace Requirements in Version 7.10.UD Environment Variable Changes in Version Configuration Parameter Changes in Version ON-Archive Changes in Version Environment Variable Changes in Version Preparing to Migrate Between Versions Install the Latest Maintenance Release for the Current Version Check Available Space and System Requirements Save Copies of the Current Configuration Files Shut Down the Database Server Verify the Integrity of the Data Back Up Your Database Server Files Preparation Complete Upgrading to Informix Dynamic Server, Version Save an Output File of SQL Statements for Access Paths Bring the Source Database Server Off-Line Reconfigure the Operating System Install the Target Database Server Install INFORMIX-Enterprise Command Center Customize the Database Server Environment Update the ONCONFIG Configuration Parameters Configure the Database Server to Use Enterprise Replication Installing and Configuring SNMP Bring the Target Database Server On-Line Run UPDATE STATISTICS Verify the Integrity of the Data Table of Contents vii

8 Check Space Requirements for BYTE and TEXT Data Make an Initial Backup Verify the Access Path of Your SQL Statements Migration Complete Changing Database Server Definitions Migrating to a GLS Locale Reverting to OnLine Dynamic Server Reversion Steps Remove Unsupported SQL Features Remove Fragmented Tables (Version 6.0 Only) Save System Catalog Information Stop Enterprise or Workgroup Replication (Version 7.22 or Later) Uninstall the Database Server and Informix Enterprise Command Center Modify In-Place ALTER TABLE (Version 7.24 and Later) Close All Transactions and Bring the Database into Quiescent Mode Verify the Integrity of the Data Back Up Your Database Server Run the Reversion Utility Remove GLS Features Modify Configuration Parameters Reset Environment Variables Modify the sqlhosts File Reinstall the Earlier Version of the Database Server Bring the Database Server On-Line Rename ON-Archive Files (Version 6.0 Only) Restore System Catalog Information (Version 6.0 Only) Verify the Integrity of the Data Back Up the Database Server Files Return the Database Server to On-Line Mode Reversion is Now Complete Reverting from Version 7.10.UDI, 7.12, and 7.14 to 7.10.UCx Verify the Integrity of the Data Back Up the Database Server Reversion is Now Complete viii Informix Migration Guide

9 Chapter 6 Migrating Pre-6.0 to Informix Dynamic Server 7.3 Preparing to Migrate Between Versions Changes Introduced in Version Changes to Database Utilities Planning for Migration Operating-System Configuration Issues Estimating the Size and Number of Shared-Memory Segments Configuring Semaphore Parameters Configuring the Number of Open-File Descriptors Operating-System Updates Disk-Use Issues Accommodating System Catalog Indexes Accommodating the sysmaster Database Locating Temporary Files and Tables Accommodating Data Distributions Accommodating User-Table Indexes Accommodating the Conversion of User-Table Indexes Managing Secure-Auditing Log Files Database Server Configuration Issues Changing Environment Variables Revising Configuration Parameter Values Increasing Logical-Log Space Planning for Additional Shared-Memory Usage Saving Pre-Existing sysmaster Databases Configuring Secondary Database Servers for Data Replication Managing Backups Making Performance Comparisons Migration from OnLine 4.1 or 5.0 to the Database Server 6.0 or Later Install the Latest Maintenance Release for the Current Version Capture Configuration and Chunk-Layout Information Close All Transactions and Make a Final Level-0 Backup Bring OnLine 4.1 or 5.0 Off-Line Install and Configure the Target Database Server Reconfigure the UNIX Operating System Bring the Target Database Server On-Line Convert User-Table Indexes Verify the Integrity of the Data Make an Initial Backup Under The Target Database Server Add Rowids to Fragmented Tables Table of Contents ix

10 Migration Complete Global Language Support Reverting to OnLine Save Configuration Files Remove All Users from the Database Server Verify the Integrity of the Data Back Up the Database Server Files Remove Features Introduced by Later Versions of the Database Server Execute the Reversion Utility Prepare the TBCONFIG Configuration File Reset Environment Variables Bring Up the Desired Version of The Database Server Verify the Integrity of the Data Back Up OnLine 5.0 Server Data Return OnLine 5.0 to On-Line Mode Chapter 7 Migrating Workgroup Edition and OnLine Workgroup Server Using Different Server and Client Configurations Workgroup Edition 7.3 and IECC, Version OnLine Workgroup Server 7.22 through 7.24 and IECC OnLine Workgroup Server 7.12 and IECC OnLine Workgroup Server 7.22 and IECC OnLine Workgroup Server 7.12 and IECC Preparing to Migrate Between Versions Check Available Space and System Requirements Save a Copy of the Current Configuration Files Place the Database Server in Quiescent Mode Verify the Integrity of the Data Back Up Your Database Server Preparation Complete Upgrading the Database Server to Version Save an Output File of SQL Statements For Access Paths Bring the Source Database Server Off-Line Reconfigure the Operating System Install the Database Server and Administration Tools Install the Target Database Server Install INFORMIX-Enterprise Command Center Customize the Database Server Environment Update the ONCONFIG Configuration Parameters Configure the Database Server to Use Enterprise Replication x Informix Migration Guide

11 Installing and Configuring SNMP Bring the Target Database Server On-Line Run UPDATE STATISTICS Verify the Integrity of the Data Make a Complete Backup of the Target Database Server Verify the Access Path of Your SQL Statements Migration Complete Changing Database Server Definitions Migrating to a GLS Locale Reverting the Database Server and IECC Remove Unsupported SQL Features Uninstall Enterprise or Workgroup Replication (Version 7.3) Run the Reversion Utility Uninstall the Database Server and Informix Enterprise Command Center Remove GLS Features (only If Reverting to 7.12) Modify Configuration Parameters Reset Environment Variables Reinstall the Earlier Version of the Database Server Bring the Database Server On-Line Verify the Integrity of the Data Back Up the OnLine Workgroup Server Data Reversion Complete Chapter 8 Migrating SE Importing and Exporting Data Migrating Between Different Versions of SE Preparing to Migrate from a Pre-6.0 SE to SE 7.2x Preparing to Migrate from a Post-6.0 SE to SE 7.2x Reverting to an Earlier Version of SE Converting C-ISAM Files to SE Migrating from C-ISAM to Dynamic Server or Its Editions Table of Contents xi

12 Chapter 9 Moving Between Database Servers Choosing a Migration Method Moving Data from SE to Informix Dynamic Server or Its Editions. 9-6 Using the dbexport and dbimport Utilities Using the UNLOAD Statement Adapting Your Programs for Informix Dynamic Server or Dynamic Server, Workgroup and Developer Editions Moving Data from Informix Dynamic Server or Dynamic Server, Workgroup and Developer Editions to SE Eliminating Features That SE Does Not Support Using the dbexport and dbimport Utilities Using the UNLOAD Statement Adapting Your Programs for SE Moving Data from Informix Dynamic Server to Dynamic Server, Workgroup and Developer Editions Moving Data in the Same Environment Moving Data Between Different Environments Save a Copy of the Current Configuration Files Verify the Integrity of the Data Back Up the Source Database Server Export the Source Database Server Shut Down the Database Server Install and Configure Dynamic Server, Workgroup and Developer Editions Verify Port Numbers and Services File Customize the Database Server Environment Bring Dynamic Server, Workgroup and Developer Editions On-Line Import the Databases to the Target Database Server Verify the Integrity of the Data Back Up the Target Database Server Run UPDATE STATISTICS Migration Complete Adapting Your Programs for Dynamic Server, Workgroup and Developer Editions Using the dbexport and dbimport Utilities Using the UNLOAD Statement Moving Data from Dynamic Server, Workgroup and Developer Editions to Informix Dynamic Server Moving Data in the Same Environment Moving Data Between Different Environments Save a Copy of the Current Configuration Files xii Informix Migration Guide

13 Verify the Integrity of the Data Back Up the Source Database Server Export the Source Database Server Shut Down the Source Database Server Install the Target Database Server Verify Port Numbers and Services File Customize the Database Server Environment Bring the Target Database Server On-Line Import the Databases into the Target Database Server Verify the Integrity of the Data Back Up the Target Database Server Run UPDATE STATISTICS Migration Complete Adapting Your Programs for Informix Dynamic Server Using the dbexport and dbimport Utilities Using the UNLOAD Statement Moving Informix Dynamic Server Data Between Environments Procedure for Moving Data Between Environments Using the Migration Utilities Adapting Your Programs for the UNIX or Windows NT Environment Migration Complete Moving Dynamic Server, Workgroup and Developer Editions Data Between Environments Procedure for Moving Data Between Environments Using the Migration Utilities Adapting Your Programs for the UNIX or Windows NT Environment Migration Complete Chapter 10 Changing Locales Understanding Informix Language Support Global Language Support (GLS) Native Language Support (NLS) Asian Language Support (ALS) Language Support in Informix Database Servers Universal Server and Universal Data Option INFORMIX-OnLine XPS and Advanced Decision Support and Extended Parallel Options Informix Dynamic Server and INFORMIX-OnLine Dynamic Server Table of Contents xiii

14 INFORMIX-SE Informix Dynamic Server, Workgroup and Developer Editions and INFORMIX-OnLine Workgroup Server Converting to GLS Language Support Determining Existing Locale Support Converting from NLS to GLS Language Support Converting from ALS to GLS Language Support Reverting from GLS Language Support Reverting from GLS to NLS Language Support Reverting from GLS to ALS Language Support Section III Chapter 11 Reference Utilities for Data Migration Setting Environment Variables The dbexport Utility Using the -c Option Using the -ss Option Destination Options The Contents of the Schema File Exporting Simple Large Objects The dbimport Utility Using the -c Option Canceling dbimport Database-Logging Mode Input-File Location Options Create Options Using the -l Options Changing the Database Name Importing Simple Large Objects Using dbimport to Change the Locale of a Database The dbload Utility Using the dbload Utility Choosing Between dbload and LOAD Creating a dbload Command File Writing a dbload Command File for Complex Data Types xiv Informix Migration Guide

15 The dbschema Utility Creating the Schema for a Database Obtaining the Role Schema Displaying the Distribution Information for Tables Using DB-Access with Dbschema Output The onload Utility Specify Source Parameters Create Options Constraints That Affect onload and onunload Constraints That Affect onload Logging While Using onload Moving Simple Large Objects to a Blobspace Ownership and Privileges Exclusive Locking During Load Operation The onmode Utility Preparing to Use the -b Option Reverting to OnLine Version Reverting to OnLine Dynamic Server Version Reverting to Version The onunload Utility Syntax Specify Destination Parameters Constraints That Affect onunload Unloading a Database or Table Logging Mode Locking During Unload Operation The LOAD Statement The UNLOAD Statement onpload: The High-Performance Loader Utility Appendix A Database Server Environment Variables Index Table of Contents xv

16

17 Introduction Introduction About This Manual Types of Users Assumptions About Your Locale Demonstration Databases New Features New Features in Version New Features in Version Documentation Conventions Typographical Conventions Icon Conventions Comment Icons Feature, Product, and Platform Icons Compliance Icons Syntax Conventions Elements That Can Appear on the Path How to Read a Syntax Diagram Command-Line Conventions How to Read a Command-Line Diagram Sample-Code Conventions Additional Documentation On-Line Manuals Printed Manuals Error Message Files Documentation Notes, Release Notes, Machine Notes Compliance with Industry Standards Informix Welcomes Your Comments

18 2 Informix Migration Guide

19 Read this introduction for an overview of the information provided in this manual and for an understanding of the documentation conventions used. About This Manual This manual describes the procedures that you use when you move data from one location to another, as well as instructions for when you migrate between Informix database servers, change locales, or migrate across platforms. Migration includes upgrading or reverting to a previous database server version, which often involves changing sqlhosts file or registry connectivity information, host environment variables, configuration parameters and other server specific features. This manual describes migrating with the following Informix database servers: Informix Dynamic Server Informix Dynamic Server with Advanced Decision Support and Extended Parallel Options Informix Dynamic Server with Universal Data Option Informix Dynamic Server, Developer Edition Informix Dynamic Server, Workgroup Edition INFORMIX-OnLine Dynamic Server INFORMIX-OnLine Workgroup Server INFORMIX-OnLine XPS INFORMIX-SE INFORMIX-Universal Server This manual also describes how to use the data migration utilities. Introduction 3

20 Types of Users Types of Users This manual is for the following users: Database users Database administrators Database server administrators Database-application programmers Backup operators Performance engineers This manual assumes that you have the following background: A working knowledge of your computer, your operating system, and the utilities provided by your operating system Some experience working with relational databases or exposure to database concepts Some experience with computer programming If you have limited experience with relational databases, SQL, or your operating system, refer to the Getting Started manual for your database server for a list of supplementary titles. This manual assumes that you are using one of the following database servers: Informix Dynamic Server, Version 7.3 Informix Dynamic Server with Advanced Decision Support and Extended Parallel Options, Version 8.2 Informix Dynamic Server with Universal Data Option, Version 9.1x Informix Dynamic Server, Developer Edition, Version 7.3 Informix Dynamic Server, Workgroup Edition, Version 7.3 INFORMIX-SE, Version Informix Migration Guide

21 Assumptions About Your Locale Assumptions About Your Locale Informix products can support many languages, cultures, and code sets. All culture-specific information is brought together in a single environment, called a Global Language Support (GLS) locale. This manual assumes that you are using the default locale, en_us This locale supports U.S. English format conventions for dates, times, and currency. In addition, this locale supports the ISO code set, which includes the ASCII code set plus many 8-bit characters such as é, è, and ñ. If you plan to use nondefault characters in your data or your SQL identifiers, or if you want to conform to the nondefault collation rules of character data, you need to specify the appropriate nondefault locale. For instructions on how to specify a nondefault locale, additional syntax, and other considerations related to GLS locales, see the Informix Guide to GLS Functionality. Demonstration Databases The DB-Access utility, which is provided with your Informix database server products, includes a demonstration database called stores7 that contains information about a fictitious wholesale sporting-goods distributor. You can use SQL scripts provided with DB-Access to derive a second database, called sales_demo. This database illustrates a dimensional schema for datawarehousing applications. Sample command files are also included for creating and populating these databases. Many examples in Informix manuals are based on the stores7 demonstration database. The stores7 database is described in detail and its contents are listed in the Informix Guide to SQL: Reference. The scripts that you use to install the demonstration databases reside in the $INFORMIXDIR/bin directory on UNIX platforms and the %INFORMIXDIR%\bin directory on Windows NT platforms. For a complete explanation of how to create and populate the stores7 demonstration database, refer to the DB-Access User Manual. For an explanation of how to create and populate the sales_demo database, refer to the Informix Guide to Database Design and Implementation. Introduction 5

22 New Features New Features The following sections describe new database server features relevant to this manual. For a comprehensive list of new features, see the release notes for your database server. New Features in Version 7.3 This manual includes information about the following new features: Enhanced oncheck options, including index consistency checking without locks Built-in server functions An administrative interface, Informix Enterprise Command Center (IECC) Informix Storage Manager (ISM), a backup and recovery utility Optimizer directives 6 Informix Migration Guide New Features in Version 8.2 This manual describes the following new features that were implemented in Version 8.2 of Informix Dynamic Server with Advanced Decision Support and Extended Parallel Options: Enhanced parallel database operations and load balancing across multiple computers Enhanced fragmentation of table data on multiple computers Enhanced indexes to support data-warehousing applications Global Language Support (GLS) New onutil commands for managing storage spaces A new graphical interface, Informix Enterprise Command Center (IECC), for performance monitoring and administration Informix Storage Manager (ISM), a native storage manager for backup media This manual also discusses the following features, which were introduced in Version 8.1 of INFORMIX-OnLine XPS:

23 Documentation Conventions Parallel database operations across multiple computers Fragmentation of table data across multiple computers Nonlogging tables External tables for high-performance loading and unloading Coserver groups (cogroups) for centralized administration of coservers Dbslices for centralized administration of storage spaces The xctl and onutil utilities Documentation Conventions This section describes the conventions that this manual uses. These conventions make it easier to gather information from this and other Informix manuals. The following conventions are covered: Typographical conventions Icon conventions Syntax conventions Command-line conventions Sample-code conventions Introduction 7

24 Typographical Conventions Typographical Conventions This manual uses the following standard set of conventions to introduce new terms, illustrate screen displays, describe command syntax, and so forth. Convention KEYWORD italics boldface monospace KEYSTROKE Meaning All keywords appear in uppercase letters in a serif font. Within text, new terms and emphasized words appear in italics. Within syntax diagrams, values that you are to specify appear in italics. Identifiers (names of classes, objects, constants, events, functions, program variables, forms, labels, and reports), environment variables, database names, filenames, table names, column names, icons, menu items, command names, and other similar terms appear in boldface. Information that the product displays and information that you enter appear in a monospace typeface. Keys that you are to press appear in uppercase letters in a sans serif font. This symbol indicates the end of feature-, product-, platform-, or compliance-specific information within a table or section. This symbol indicates a menu item. For example, Choose Tools Options means choose the Options item from the Tools menu. Tip: When you are instructed to enter characters or to execute a command, immediately press RETURN after you type the indicated information on your keyboard. When you are instructed to type the text or to press other keys, you do not need to press RETURN. 8 Informix Migration Guide

25 Icon Conventions Icon Conventions Throughout the documentation, you will find text that is identified by several different types of icons. This section describes these icons. Comment Icons Comment icons identify warnings, important notes, or tips. This information is always displayed in italics. Icon Description The warning icon identifies vital instructions, cautions, or critical information. The important icon identifies significant information about the feature or operation that is being described. The tip icon identifies additional details or shortcuts for the functionality that is being described. Introduction 9

26 Icon Conventions Feature, Product, and Platform Icons Feature, product, and platform icons identify paragraphs that contain feature-specific, product-specific, or platform-specific information. Icon Description AD/XP ALS D/B E/C GLS IDS IUS NLS ODS OWS SE UD Identifies information that is specific to Informix Dynamic Server with Advanced Decision Support and Extended Parallel Options. Identifies information that is specific to an Asian Language Support (ALS) database or application. Identifies information that is valid only for DB-Access. Identifies information that is specific to the INFORMIX-ESQL/C product. Identifies information that relates to the Informix Global Language Support (GLS) feature. Identifies information that is specific to Dynamic Server and its editions. However, in some cases, the identified section applies only to Informix Dynamic Server and not to Informix Dynamic Server, Workgroup and Developer Editions. Such information is clearly identified. Identifies information that is specific to INFORMIX-Universal Server. Identifies information that is specific to a Native Language Support (NLS) database or application. Identifies information that is specific to INFORMIX-OnLine Dynamic Server. Identifies information that is specific to INFORMIX-OnLine Workgroup Server. Identifies information that is specific to INFORMIX-SE. Identifies information that is specific to Informix Dynamic Server with Universal Data Option. (1 of 2) 10 Informix Migration Guide

27 Icon Conventions Icon Description UNIX W/D WIN NT Identifies information that is specific to UNIX platforms. Identifies information that is specific to Informix Dynamic Server, Workgroup and Developer Editions. Identifies information that is specific to the Windows NT environment. XPS Identifies information that is specific to INFORMIX-OnLine XPS. (2 of 2) These icons can apply to a row in a table, one or more paragraphs, or an entire section. If an icon appears next to a section heading, the information that applies to the indicated feature, product, or platform ends at the next heading at the same or higher level. A symbol indicates the end of the feature-, product-, or platform-specific information that appears within a table or a set of paragraphs within a section. Compliance Icons Compliance icons indicate paragraphs that provide guidelines for complying with a standard. Icon Description ANSI + X/O Identifies information that is specific to an ANSI-compliant database. Identifies information that is an Informix extension to ANSI SQL-92 entry-level standard SQL. Identifies functionality that conforms to X/Open. These icons can apply to a row in a table, one or more paragraphs, or an entire section. If an icon appears next to a section heading, the compliance information ends at the next heading at the same or higher level. A symbol indicates the end of compliance information that appears in a table row or a set of paragraphs within a section. Introduction 11

28 Syntax Conventions Syntax Conventions This section describes conventions for syntax diagrams. Each diagram displays the sequences of required and optional keywords, terms, and symbols that are valid in a given statement or segment, as Figure 1 shows. Figure 1 Example of a Simple Syntax Diagram SET EXPLAIN ON OFF Each syntax diagram begins at the upper-left corner and ends at the upperright corner with a vertical terminator. Between these points, any path that does not stop or reverse direction describes a possible form of the statement. Syntax elements in a path represent terms, keywords, symbols, and segments that can appear in your statement. The path always approaches elements from the left and continues to the right, except in the case of separators in loops. For separators in loops, the path approaches counterclockwise from the right. Unless otherwise noted, at least one blank character separates syntax elements. Elements That Can Appear on the Path You might encounter one or more of the following elements on a path. Element KEYWORD Description A word in UPPERCASE letters is a keyword. You must spell the word exactly as shown; however, you can use either uppercase or lowercase letters. (., + * - / ) Punctuation and other nonalphanumeric characters are literal symbols that you must enter exactly as shown. ' ' Single quotes are literal symbols that you must enter as shown. (1 of 3) 12 Informix Migration Guide

29 Syntax Conventions Element variable ADD Clause p ADD Clause Back to ADD Clause p Table Name see SQLS VALUES Clause see SQLS Other options see OLAG ALL Description A word in italics represents a value that you must supply. A table immediately following the diagram explains the value. A reference in a box represents a subdiagram. Imagine that the subdiagram is spliced into the main diagram at this point. When a page number is not specified, the subdiagram appears on the same page. A reference in a box in the upper right hand corner of a subdiagram refers to the next higher-level diagram of which this subdiagram is a member. A reference to SQLS in this manual refers to the Informix Guide to SQL: Syntax. Imagine that the subdiagram is spliced into the main diagram at this point. A reference to SQLS in this manual refers to the Informix Guide to SQL: Syntax. Imagine that the subdiagram is spliced into the main diagram at this point. A reference to OLAG in this manual refers to the administrator s guide for your database server. Imagine that the subdiagram is spliced into the main diagram at this point. A shaded option is the default action. Syntax that is enclosed between a pair of arrows is a subdiagram. The vertical line terminates the syntax diagram. IS NOT NULL A branch below the main path indicates an optional path. (Any term on the main path is required, unless a branch can circumvent it.) (2 of 3) Introduction 13

30 Syntax Conventions Element Description NOT FOUND ERROR WARNING, variable A set of multiple branches indicates that a choice among more than two different paths is available. A loop indicates a path that you can repeat. Punctuation along the top of the loop indicates the separator symbol for list items. If no symbol appears, a blank space is the separator. statement 3, size A gate ( 3 ) on a path indicates that you can only use that path the indicated number of times, even if it is part of a larger loop. Here you can specify size no more than three times. (3 of 3) How to Read a Syntax Diagram Figure 2 shows a syntax diagram that uses many of the elements that are listed in the previous table. Figure 2 Example of a Syntax Diagram DELETE FROM table view synonym WHERE E/C Condition p. -14 CURRENT OF cursor 14 Informix Migration Guide

31 Command-Line Conventions To use this diagram to construct a statement, begin at the far left with the keywords DELETE FROM. Then follow the diagram to the right, proceeding through the options that you want. To construct a DELETE statement 1. You must type the words DELETE FROM. 2. You can delete a table, view, or synonym: Follow the diagram by typing the table name, view name, or synonym, as desired. You can type the keyword WHERE to limit the rows that are deleted. If you specify the keyword WHERE and you are using DB-Access or the SQL Editor, you must include the Condition clause to specify a condition to delete. To find the syntax for specifying a condition, go to the Condition segment on the specified page. If you are using ESQL/C, you can include either the Condition clause to delete a specific condition or the CURRENT OF cursor clause to delete a row from the table. 3. Follow the diagram to the terminator. Your DELETE statement is complete. Command-Line Conventions This section defines and illustrates the format of commands that are available in Informix products. These commands have their own conventions, which might include alternative forms of a command, required and optional parts of the command, and so forth. Each diagram displays the sequences of required and optional elements that are valid in a command. A diagram begins at the upper-left corner with a command. It ends at the upper-right corner with a vertical line. Between these points, you can trace any path that does not stop or back up. Each path describes a valid form of the command. You must supply a value for words that are in italics. Introduction 15

32 Command-Line Conventions You might encounter one or more of the following elements on a commandline path. Element command variable -flag.ext Description This required element is usually the product name or other short word that invokes the product or calls the compiler or preprocessor script for a compiled Informix product. It might appear alone or precede one or more options. You must spell a command exactly as shown and use lowercase letters. A word in italics represents a value that you must supply, such as a database, file, or program name. A table following the diagram explains the value. A flag is usually an abbreviation for a function, menu, or option name or for a compiler or preprocessor argument. You must enter a flag exactly as shown, including the preceding hyphen. A filename extension, such as.sql or.cob, might follow a variable that represents a filename. Type this extension exactly as shown, immediately after the name of the file. The extension might be optional in certain products. (.,;+*-/) Punctuation and mathematical notations are literal symbols that you must enter exactly as shown. '' Privileges p Privileges ALL Single quotes are literal symbols that you must enter as shown. A reference in a box represents a subdiagram. Imagine that the subdiagram is spliced into the main diagram at this point. When a page number is not specified, the subdiagram appears on the same page. A shaded option is the default action. Syntax within a pair of arrows indicates a subdiagram. The vertical line terminates the command. (1 of 2) 16 Informix Migration Guide

33 Command-Line Conventions Element -f OFF ON, variable Description A branch below the main path indicates an optional path. (Any term on the main path is required, unless a branch can circumvent it.) A loop indicates a path that you can repeat. Punctuation along the top of the loop indicates the separator symbol for list items. 3, A gate ( 3 ) on a path indicates that you can only use that path the indicated number of times, even if it is part size of a larger loop. Here you can specify size no more than three times within this statement segment. (2 of 2) How to Read a Command-Line Diagram Figure 3 shows a command-line diagram that uses some of the elements that are listed in the previous table. Figure 3 Example of a Command-Line Diagram setenv INFORMIXC compiler pathname To construct a command correctly, start at the top left with the command. Then follow the diagram to the right, including the elements that you want. The elements in the diagram are case sensitive. Figure 3 diagrams the following steps: 1. Type the word setenv. 2. Type the word INFORMIXC. 3. Supply either a compiler name or pathname. After you choose compiler or pathname, you come to the terminator. Your command is complete. 4. Press RETURN to execute the command. Introduction 17

34 Sample-Code Conventions Sample-Code Conventions Examples of SQL code occur throughout this manual. Except where noted, the code is not specific to any single Informix application development tool. If only SQL statements are listed in the example, they are not delimited by semicolons. For instance, you might see the code in the following example: CONNECT TO stores7. DELETE FROM customer WHERE customer_num = 121. COMMIT WORK DISCONNECT CURRENT To use this SQL code for a specific product, you must apply the syntax rules for that product. For example, if you are using the Query-language option of DB-Access, you must delimit multiple statements with semicolons. If you are using an SQL application programming interface (API), you must use EXEC SQL at the start of each statement and a semicolon (or other appropriate delimiter) at the end of the statement. Tip: Ellipsis points in a code example indicate that more code would be added in a full application, but it is not necessary to show it to describe the concept being discussed. For detailed directions on using SQL statements for a particular application development tool or SQL API, see the manual for your product. 18 Informix Migration Guide

35 Additional Documentation Additional Documentation For additional information, you might want to refer to the following types of documentation: On-line manuals Printed manuals Error message files Documentation notes, release notes, and machine notes Related reading On-Line Manuals An Answers OnLine CD that contains Informix manuals in electronic format is provided with your Informix products. You can install the documentation or access it directly from the CD. For information about how to install, read, and print on-line manuals, see the installation insert that accompanies Answers OnLine. Printed Manuals To order printed manuals, call or send to Please provide the following information when you place your order: The documentation that you need The quantity that you need Your name, address, and telephone number Introduction 19

36 Error Message Files Error Message Files Informix software products provide ASCII files that contain all of the Informix error messages and their corrective actions. For a detailed description of these error messages, refer to Informix Error Messages in Answers OnLine. UNIX To read the error messages in UNIX, you can use the following commands. Command finderr rofferr Description Displays error messages on line Formats error messages for printing WIN NT To read error messages and corrective actions in Windows NT, use the Informix Find Error utility. To display this utility, choose Start Programs Informix from the Task Bar. Documentation Notes, Release Notes, Machine Notes In addition to printed documentation, the following sections describe the online files that supplement the information in this manual. Please examine these files before you begin using your database server. They contain vital information about application and performance issues. 20 Informix Migration Guide

37 Documentation Notes, Release Notes, Machine Notes UNIX On UNIX platforms, the following on-line files appear in the $INFORMIXDIR/release/en_us/0333 directory. On-Line File MIGRATEDOC_x.y SERVERS_x.y IDS_x.y, ONLINE_x.y, or SE_x.y Purpose The documentation-notes file for your version of this manual describes features that are not covered in the manual or that have been modified since publication. Replace x.y in the filename with the version number of your database server to derive the name of the documentation-notes file for this manual. The release-notes file describes feature differences from earlier versions of Informix products and how these differences might affect current products. This file also contains information about any known problems and their workarounds. Replace x.y in the filename with the version number of your database server to derive the name of the release-notes file. The machine-notes file describes any special actions that are required to configure and use Informix products on your computer. Machine notes are named for the product described. Replace x.y in the filename with the version number of your database server to derive the name of the machine-notes file. WIN NT The following items appear in the Informix folder. To display this folder, choose Start Programs Informix from the Task Bar. Item Documentation Notes Release Notes Description This item includes additions or corrections to manuals, along with information about features that may not be covered in the manuals or that have been modified since publication. This item describes feature differences from earlier versions of Informix products and how these differences might affect current products. This file also contains information about any known problems and their workarounds. Machine notes do not apply to Windows NT platforms. Introduction 21