SQL/MX Connectivity Service Administrative Command Reference Abstract This manual describes the ODBC administrative commands running in the HP NonStop™ SQL/MX Connectivity Service (MXCS) environment and accessed through the SQL/MX conversational interface (MXCI). These commands support manipulation of the logical objects that define the user-visible attributes of the SQL/MX connectivity service (MXCS). Product Version MXCS ACL 1.1 APB Supported Release Version Updates (RVUs) This manual supports J06.
Document History Part Number Product Version Published 526350-001 MXCS ACL 1.0 April 2004 526350-002 MXCS ACL 1.1 ABA August 2004 526350-003 MXCS ACL 1.1 ABO March 2005 526350-004 MXCS ACL 1.1 APB February 2013 526350-005 MXCS ACL 1.
Legal Notices Copyright 2013 Hewlett-Packard Development Company L.P. Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. The information contained herein is subject to change without notice.
SQL/MX Connectivity Service Administrative Command Reference Index Figures What’s New in This Manual Manual Information v New and Changed Information v About This Manual vii Audience vii Related Documentation vii Notation Conventions x 1. MXCS Architecture Overview Features and Functionality 1-1 Architecture Overview 1-2 User Interface With MXCI 1-4 General Features 1-4 Software Installation 1-5 Starting, Leaving, and Ending MXCI 1-5 Complex System Configuration 1-5 Error Message Overview 1-7 2.
3. Object Service Commands Contents Command Size Limit 2-8 Single Quotes for Attribute Values 2-8 Double Quotes for Object Names 2-8 Empty Quoted Strings 2-8 Command Caveats 2-9 Output Report Syntax and Conventions 2-9 Security 2-10 Example MXCS Configuration 2-10 Related Commands 2-11 MXCI Mode Command 2-12 Session Variables 2-12 MXCI Comment 2-12 3.
6. Object EVAR Commands Contents Examples—ADD DS 5-7 ALTER DS 5-8 Considerations—ALTER DS 5-12 Examples—ALTER DS 5-12 DELETE DS 5-14 Considerations—DELETE DS 5-14 Example—DELETE DS 5-15 INFO DS 5-16 Considerations—INFO DS 5-17 Examples—INFO DS 5-17 START DS 5-20 Considerations—START DS 5-20 Example—START DS 5-20 STOP DS 5-21 Considerations—STOP DS 5-22 Examples—STOP DS 5-22 6.
A. Example Commands and Objects Contents DELETE USER 7-4 Considerations—DELETE USER 7-4 Example—DELETE USER 7-4 INFO USER 7-5 Considerations—INFO USER 7-5 A. Example Commands and Objects Index Figures Figure 1-1. Figure 1-2. Figure 2-1.
What’s New in This Manual Manual Information SQL/MX Connectivity Service Administrative Command Reference Abstract This manual describes the ODBC administrative commands running in the HP NonStop™ SQL/MX Connectivity Service (MXCS) environment and accessed through the SQL/MX conversational interface (MXCI). These commands support manipulation of the logical objects that define the user-visible attributes of the SQL/MX connectivity service (MXCS). Product Version MXCS ACL 1.
What’s New in This Manual New and Changed Information SQL/MX Connectivity Service Administrative Command Reference—526350-005 vi
About This Manual This manual describes the administrative commands available to administer ODBC in an SQL/MX connectivity service (MXCS) running on a single HP NonStop system. These commands are implemented internally as the SQL/MX administrative command library (MACL), are linked into the SQL/MX command interface (MXCI), and support manipulation of logical objects defining the user-visible attributes of the ODBC facility of SQL/MX Connectivity Service (MXCS).
Related Documentation About This Manual Programming Manuals SQL/MX Programming Manual for C and COBOL Describes how to embed SQL/MX statements in ANSI C and COBOL programs. SQL/MX Programming Manual for Java Describes how to embed SQL/MX statements in Java programs according to the SQLJ standard. Specialized Guides SQL/MX Installation and Management Guide Describes how to plan for, install, create, and manage an SQL/MX database. Explains how to use installation and management commands and utilities.
About This Manual Related Documentation The NSM/web and Visual Query Planner help systems are accessible from their respective applications. You can download the Reference, Messages, and Glossary online help from the $SYSTEM.ZMXHELP subvolume or from the HP NonStop Technical Library (NTL). For more information about downloading online help, see the SQL/MX Installation and Management Guide.
Notation Conventions About This Manual This figure shows the manuals in the SQL/MX library: Programming Manuals Introductory Guides SQL/MX Comparison Guide for SQL/MP Users SQL/MX Programming Manual for C and COBOL SQL/MX Quick Start SQL/MX Programming Manual for Java Reference Manuals SQL/MX Reference Manual SQL/MX Messages Manual SQL/MX Connectivity Service Administrative Command Reference SQL/MX Glossary DataLoader/MX Reference Manual Specialized Guides SQL/MX Installation and Management G
About This Manual General Syntax Notation This requirement is described under Backup DAM Volumes and Physical Disk Drives on page 3-2. General Syntax Notation This list summarizes the notation conventions for syntax presentation in this manual. UPPERCASE LETTERS. Uppercase letters indicate NSK keywords and reserved words. Type these items exactly as shown. Items not enclosed in brackets are required. For example: MAXATTACH lowercase italic letters.
Notation for Messages About This Manual … Ellipsis. An ellipsis immediately following a pair of brackets or braces indicates that you can repeat the enclosed sequence of syntax items any number of times. For example: M address [ , new-value ]… [ - ] {0|1|2|3|4|5|6|7|8|9}… An ellipsis immediately following a single syntax item indicates that you can repeat that syntax item any number of times. For example: "s-char…" Punctuation.
About This Manual Notation for Messages Nonitalic text. Nonitalic letters, numbers, and punctuation indicate text that is displayed or returned exactly as shown. For example: Backup Up. lowercase italic letters. Lowercase italic letters indicate variable items whose values are displayed or returned. For example: p-register process-name [ ] Brackets. Brackets enclose items that are sometimes, but not always, displayed.
About This Manual Change Bar Notation Change Bar Notation Change bars are used to indicate substantive differences between this manual and its preceding version. Change bars are vertical rules placed in the right margin of changed portions of text, figures, tables, examples, and so on. Change bars highlight new or revised information. For example: The message types specified in the REPORT clause are different in the COBOL85 environment and the Common Run-Time Environment (CRE).
1 MXCS Architecture Overview The NonStop SQL/MX connectivity service (MXCS) includes support for remote connections to the SQL/MX database, such as ODBC and JDBC. An associated MXCS configuration database allows creation of site-specific information to customize the ODBC facility to a specific use or application. This guide describes the commands for administrating the ODBC facility and the MXCS configuration database.
MXCS Architecture Overview Architecture Overview Configures a new installation of MXCS or modifies an existing installation Accesses objects only on the system where MXCI is running Provides database security so that all users can view objects, but only specified users can modify them Displays attributes and states of the objects within the ODBC MXCS configuration Displays and manages the ODBC MXCS configuration as five separate object types: Service (the MXOAS command starts
Architecture Overview MXCS Architecture Overview administrative command, set MXCI to the MXCS mode as described in MXCI Mode Command on page 2-12. Figure 1-1. MXCS Architecture User Command Command Response MXDB MXCS MXCI Command Manager MXCI Error Strings MACL Error Strings SQL/MX Commands Report Writer Commands MXCS Administrative Command Library Configuration Client Library MXCS Client Configuration Server Association Server SQL/MX Engine MXCS MXCS Server MXCS Server Server VST002.
MXCS Architecture Overview User Interface With MXCI User Interface With MXCI The MXCI interface with MXCS administrative commands is similar to its interface for the report writer or SQL command handlers. The basic features are: MXCS commands terminate with a semicolon (;), with command input occurring only after the semicolon is entered. Enclose embedded semicolons in single or double quotation marks.
MXCS Architecture Overview Software Installation Error messages describe the problem and, where possible, suggest a recovery action. Software Installation MXCS administrative commands are installed as part of MXCI. No special installation process is needed to install software for these commands. Starting, Leaving, and Ending MXCI The MXCI command has many options. One of them enables you to specify the name of a command file. For start-up information, see MXCI Mode Command on page 2-12.
Complex System Configuration MXCS Architecture Overview Service A. Service A monitors the three MXCS servers it has started in addition to the DS and EVARs they use. Each server uses only a few attributes of one DS (like timeout, trace, and statistics flags) and has all EVARs that belong to that DS defined in its environment. Figure 1-2.
MXCS Architecture Overview Error Message Overview All MXCS objects can be viewed or manipulated with MACL commands supported by MXCI. Through MACL and the configuration client library, MXCI establishes and terminates connections to the process that makes up the logical service and, in some cases, connections directly to the MXCS configuration database. Although Figure 1-2 shows one system, an Expand network can connect to other systems.
MXCS Architecture Overview Error Message Overview A multiple error message for one error event looks like: CS>start ds catalog_ds; -- START DS \ODBC.$ASM.CATALOG_DS Failed *** ERROR[15380] DS not found, \ODBC.$ASM.CATALOG_DS. *** ERROR[15309] SUBSYSTEM: DS not found, library call CFGStartDS failed. *** ERROR[15202] LOWLAYER 1: Data source does not exist. These examples show actual error reports.
MXCS Architecture Overview Error Message Overview Some error messages also suggest recovery action, as shown in this example of error 15215: *** ERROR[15215] SUBSYSTEM: SERVICE name used cannot supply this info, library call CFGGetStatusService failed. +++SUGG: SERVICE name was probably * and should be a specific SERVICE name.
MXCS Architecture Overview Error Message Overview SQL/MX Connectivity Service Administrative Command Reference—526350-005 1-10
2 MXCS Commands and Objects This section describes: MXCS Administrative Command Names on page 2-1 MXCS Object Types on page 2-2 Valid Command and Object Type Pairs on page 2-3 Command Rules and General Syntax on page 2-3 Output Report Syntax and Conventions on page 2-9 Security on page 2-10 Example MXCS Configuration on page 2-10 Related Commands on page 2-11 MXCS Administrative Command Names Commands that support administration of SQL/MX connectivity service (MXCS) are: ADD Creates an
MXCS Commands and Objects MXCS Object Types MXCS Object Types MXCS objects that support the command-line interface for SQL/MX connectivity service are: DS (data source) A named collection of connection attributes for the servers. A DS has a single definition on a particular system and can be seen by all services on the system. (A particular DS can be different between different systems.) The DS instance must be in the started state on any service that is using it (allowing connections).
Valid Command and Object Type Pairs MXCS Commands and Objects Figure 2-1. MXCS Object Relations DS Instance Service Server EVAR VST003.vsd Valid Command and Object Type Pairs All MXCS administrative commands do not support all objects types.
Fields or Tokens in Commands MXCS Commands and Objects Fields or Tokens in Commands All fields or tokens in a command belong to one of these types: Keyword Single word without quotation marks, uppercase or lowercase (not case-sensitive), alphanumeric characters (A through Z or a through z, plus 0 through 9). Called key value when used as a value of an attribute. Number Single word, numeric characters (0 through 9) with sign (+ or -); no spaces and no commas.
MXCS Commands and Objects General MXCS Administrative Command Syntax General MXCS Administrative Command Syntax COMMAND obj-type [obj-name][, attribute]...; COMMAND is listed in Valid Command and Object Type Pairs on page 2-3. obj-type is one of the objects listed in Valid Command and Object Type Pairs on page 2-3. obj-name is a string that defines the object to be acted upon (with its syntax described in Object Name Components on page 2-5).
MXCS Commands and Objects Object Name Components General syntax is: For service: [[\system-name.]$service-name] For DS: [[[\system-name.]$service-name.]ds-name] For EVAR: [[[[\system-name.]$service-name.]ds-name.]evar-name] For server: [[[\system-name.]$service-name.]$server-name] For user: [[\system-name.]groupname.membername] See individual commands for specific syntax formats.
DS Name and EVAR Name MXCS Commands and Objects groupname is the group login name and must be given if membername is used. This component is an SQL identifier data type but is always set to uppercase after the command processes it (see Fields or Tokens in Commands on page 2-4). membername is the NonStop OS user login with no aliases permitted. This component is an SQL identifier data type but is always set to uppercase after the command processes it (see Fields or Tokens in Commands on page 2-4).
MXCS Commands and Objects Command Size Limit But the period is required in this command because the DS name is defaulted: INFO DS $AR2. This last example uses the DS named in the previous command but specifies a different service (it assumes a previous command acted on a DS). The example shows how to get state information on one specific DS from each service. When an intermediate component is specified by a default, you must specify its terminating period.
MXCS Commands and Objects Command Caveats Command Caveats Use care when specifying a backslash (\) and dollar sign ($) in commands when input is not from the command-line or an OBEY command file. These characters have special meaning to the OSS shell. Output Report Syntax and Conventions All output report lines contain a maximum of 79 characters, with longer lines automatically folded. Because a DS name can be up to 128 characters, a long DS name is the most likely cause of output report format problems.
MXCS Commands and Objects Security Security MACL has two classes of commands: Informational commands, which return data. Any user can issue these commands: INFO VERSION Sensitive commands, which change states and values, and add or delete objects. Only a user with operator permissions can issue these commands: ADD ALTER DELETE START STOP Users issuing sensitive commands are validated against the list of user objects defined in the MXCS configuration database.
Related Commands MXCS Commands and Objects NonStop TCP/IP address (-TCP = driver process name), the initial port number (-PN 15000), the trace detail level (-E 0), and the port range (-PR 250): MXOAS /name $AS, nowait, term $zhome/ -TCP $ZTC0 -PN 15000 -E 0 -PR 250 When SQL/MX is initialized, the TDM_Default_DataSource is created with these defaults: MaxServer: 5 IdleServer: 1 InitServer: 1 IdleTimeout: SYSTEM_DEFAULT ConnTimeout: SYSTEM_DEFAULT StartAutomatic: OFF
MXCI Mode Command MXCS Commands and Objects MXCI Mode Command The MXCI MODE command directs all subsequent commands to the MXCS command library. To enter the MXCS mode, enter: >>mode mxcs; CS> To indicate the session is in MXCS mode, the prompt changes to CS>.The prompt for continuation lines is the normal +> for all modes. The mode prompt of CS persists until the mode is reset. Use CS as the prompt for connection services commands.
3 Object Service Commands This section describes the MXCS administrative commands you use for the service object (see Valid Command and Object Type Pairs on page 2-3): INFO SERVICE on page 3-2 START SERVICE on page 3-4 STOP SERVICE on page 3-5 VERSION SERVICE on page 3-7 The service object represents one running MXCS ODBC instance on a single CPU. One system can have several service objects running simultaneously on the same or different CPUs.
Object Service Commands INFO SERVICE INFO SERVICE This command displays the name and attributes of the service object, including state information, DS summary, and user connection information. The name of the service is always the name of the ODBC association server process (defined by the RUN MXOAS command). Command syntax is: INFO SERVICE [obj-name][, DETAIL]; obj-name [[\system-name.
Output Report States—INFO SERVICE Object Service Commands Output Report States—INFO SERVICE The INFO SERVICE report contains state values with these definitions: STARTING Service is initializing (starting). AVL Service is available. STOPPING Service is going to STOP state, but some DS not yet stopped. STOPPED Service is running but not accepting users.
Object Service Commands START SERVICE START SERVICE This command starts: The target service (after the TACL command RUN MXOAS has initiated the process) All DSs that auto-start The initial servers associated with a started DS After service starts, clients can begin connecting to the servers. Command syntax is: START SERVICE [obj-name]; obj-name [[\system-name.
Object Service Commands STOP SERVICE STOP SERVICE This command, which executes the controlled shutdown of the service: Puts the service object in the stopping state but does not terminate the association server process Stops all DSs and therefore all servers on the target service Actual termination of the server occurs at different times, depending on the stopmode attribute you specify. Command syntax is: STOP SERVICE [obj-name] [,AFTER stop-mode], REASON text; obj-name [[\system-name.
Object Service Commands Considerations—STOP SERVICE REASON text is a nonempty SQL string literal of up to 70 characters, which indicates why the service is being shut down. It is written to the EMS log by the service if the command is accepted. Strings of more than 70 characters are truncated with a warning. Single quotes are required. Considerations—STOP SERVICE STOP SERVICE is a sensitive command. The asterisk (*) wild card is not supported.
Object Service Commands VERSION SERVICE VERSION SERVICE This command returns version information for these components: The MXCS association server The Client library The MACL This information helps when reporting problems. Command syntax is: VERSION SERVICE [obj-name]; obj-name [[\system-name.]$service-name | *] system-name is the name of the current system of up to 16 CPUs with the same Expand address and where the target MXCS process is running.
Object Service Commands Example—VERSION SERVICE This example does not connect to a service or display an MXCS VPROC: CS>version service *; -- VERSION SERVICE \ODBC.
4 Object Server Commands This object is the server to which the remote client connects to access a database and is usually called the MXCS server. This object type does not include association servers or configuration servers, so the INFO SERVER and STOP SERVER commands cannot administer these servers. The association server starts new servers as needed, so only the INFO SERVER and STOP SERVER commands are available to manage a server object.
Object Server Commands INFO SERVER INFO SERVER This command displays attributes (state, connection, and configuration) of MXCS servers. You cannot change these attributes directly. Command syntax is: INFO SERVER [obj-name][, DETAIL][, DS ds-name]; obj-name [[[\system-name.]$service-name.]$server-name | *] system-name is the name of the current system of up to 16 CPUs with the same Expand address and where the target MXCS process is running. system-name and service-name identify one service instance.
Considerations—INFO SERVER Object Server Commands Considerations—INFO SERVER INFO SERVER is a nonsensitive command. The asterisk (*) wild card is supported All displays are grouped by DS. Display attributes cannot be changed with administrative commands.
Example—INFO SERVER Object Server Commands Detailed report for a server connected to a PC application (Microsoft Access): CS>info server $AS.$Z0483, detail; -- INFO SERVER \ODBC.$AS.$Z0483 Report, DETAIL DS Name: TDM_Default_DataSource PName State SPid TCP/IP PN Port $Z0483 CON 0,404 $ZTC0 21009 Cl User ID..............swdev1.user1 Cl Proc ID.......................836 Last State Chg Remote System Name Jan 22 12:55 TXNUSER1-P1 Cl App Name................
Object Server Commands STOP SERVER STOP SERVER This command puts the server in the stopping state. The actual termination occurs at different times, depending on the stop-mode attribute you specify. Check on progress by using the INFO SERVER command. Command syntax is: STOP SERVER [obj-name] [,AFTER stop-mode]; obj-name [[[\system-name.]$service-name.]$server-name] system-name is the name of the current system of up to 16 CPUs with the same Expand address and where the target MXCS process is running.
Object Server Commands Example—STOP SERVER Stopping a DS stops all servers it owns on the specified SERVICE. Stopping a service stops all servers it owns. Client connections can change rapidly. Issue INFO SERVER DETAIL before issuing STOP server to verify that the server is connected to the appropriate client. If the target server does not exist, STOP SERVER returns an error. If no client is connected to the target server, it terminates immediately.
5 Object DS Commands This object is a server-side data source (DS) that represents a named collection of use, connection, and database attributes. Clients specify the desired DS at connection time to establish the run-time environment. The DS is a permanent object that is recorded in the MXCS administrative database. The DS is owned by each service that is using it. The same DS has the same configured values in each service using it, but it can have different states, trace states, and server counts.
Object DS Commands ADD DS ADD DS This command adds one DS to the MXCS configuration on the system.
Object DS Commands ADD DS existing DS. The existing DS and the new one must have different names. Two DSs with the same name generate an error. Using this parameter can be the first step in renaming a DS, followed by stopping and deleting the old DS. MaxServer count is the upper limit on the servers that can be operational for this service on this DS. The default value is 1. A value of 0 gives the system default, which is a value determined by the system at run time.
Object DS Commands ADD DS ConnTimeout timeout-val is a keyword or the number of minutes a client-server connection can remain idle before the server terminates the connection and becomes available. The default value is SYSTEM_DEFAULT, which is defined by MXCS (ten minutes currently). Other valid values are NO_TIMEOUT and from the integer one to a large number.
Object DS Commands ADD DS Nonexistent CPU numbers are not reported. Because a CPU can be down now and up later, nonexistent CPU numbers return an EMS warning only when you attempt to use them. Only new servers are affected, not currently running servers. The CpuList values come from either the command-line or from the source DS, but not a combination of the two. If you specify one of these CPUs on the command-line, you must specify them all. cpu-val ALL | ‘nbr0 [nbr1] ...
Object DS Commands Considerations—ADD DS Statistics are written to the collector specified when the service is started. The default value is OFF when the attribute is not used. SQLPrepareStat [OFF] is a flag to turn ON, for this DS, the statistics gathering of SQLPrepare statistics at the time a PREPARE statement is received. Use this flag without the OFF option to turn the individual flag ON. This flag can follow the AllStat flag to reset only this flag.
Object DS Commands Examples—ADD DS Examples—ADD DS This example creates the DS Mixed Case DSN in all services, even though the service $AS is specifically addressed: CS>add ds $AS."Mixed Case DSN", MaxServer 30, IdleServer 5, InitServer 10, IdleTimeout SYSTEM_DEFAULT, ConnTimeout 60, AllStat; -- ADD DS \ODBC.$AS.Mixed Case DSN Successful Use this command to clone a DS and change one parameter: CS>add ds $AS."Son of Mixed Case DSN", COPY "Mixed Case DSN", MaxServer 50; -- ADD DS \ODBC.$AS.
Object DS Commands ALTER DS ALTER DS This command is similar to the ADD DS command, except ALTER DS modifies the attributes of an existing DS in the MXCS configuration on one system.
Object DS Commands ALTER DS IdleServer count is the lower limit on the available idle servers that are operational for this service on this DS. Valid values are 0 through MaxServer count, with 0 as the default. This count represents idle servers that are waiting for user connections. At DS startup, once the InitServer count is satisfied, additional servers are started until the IdleServer count is reached.
Object DS Commands ALTER DS InitPri [priority-val] is the initial system priority used to start a new server on this DS. The valid values are 1 to 199 and SYSTEM_DEFAULT | number, which is the association server process priority. priority-val SYSTEM_DEFAULT | number Trace [OFF] is a flag for activating the server trace facility in all servers using this DS and started by this service.
Object DS Commands ALTER DS SQLExecuteStat [OFF] is a flag to turn ON, for this DS, the statistics gathering of SQLExecute statistics at the time an EXECUTE statement is received for servers started by this service. Use this flag without the OFF option to turn the individual flag ON. This flag can follow the AllStat flag to reset just this one flag. Statistics are written to the collector specified when the service is started.
Object DS Commands Considerations—ALTER DS running servers using this DS and started by any service are affected by changing any flag. ConnInfoStat [OFF] is a flag to turn ON, for this DS, the statistics gathering of session statistics at the time a session is established. Use this flag without the OFF option to turn the individual flag ON. This flag can follow the AllStat flag to reset only this flag. Statistics are written to the collector specified when the service is started.
Object DS Commands Examples—ALTER DS preserve its lowercase characters. If quotes are not used, the DS name automatically changes to uppercase TDM_Default_DataSource when the command executes. CS>alter ds *."TDM_Default_DataSource", Trace off, maxserver 6, initpri 52, cpulist '1', allstat; -- ALTER DS \ODBC.*.TDM_Default_DataSource Begun -- ALTER DS \ODBC.*.TDM_Default_DataSource Successful for basic settings -- ALTER DS \ODBC.*.TDM_Default_DataSource Successful for CpuList -- ALTER DS \ODBC.*.
Object DS Commands DELETE DS DELETE DS This command removes one DS from the MXCS configuration on the target system. The DS must be in the stopped state in all services on the system, or an error is generated and the DS is not deleted. Command syntax is: DELETE DS [obj-name]; obj-name [[[\system-name.][$service-name | *].]ds-name] system-name is the name of the current system of up to 16 CPUs with the same Expand address and where the target MXCS process is running.
Object DS Commands Example—DELETE DS Example—DELETE DS This example removes the DS Test2 from the system: CS>delete ds $AS."Test2"; -- DELETE DS \ODBC.$AS.
Object DS Commands INFO DS INFO DS This command displays attributes of one or all defined DSs on this system. Command syntax is:. INFO DS [obj-name][, DETAIL][, ACTIVE]; obj-name [[[\system-name.][$service-name | *].]ds-name | *] system-name is the name of the current system of up to 16 CPUs with the same Expand address and where the target MXCS process is running. system-name and service-name identify one service instance.
Considerations—INFO DS Object DS Commands The output report contains a column of state values with these definitions: STARTING Data source initializing (starting first server) STARTED Data source started STOPPING Data source stopping (all servers not down) STOPPED Data source stopped Considerations—INFO DS INFO DS is a nonsensitive command. The asterisk (*) wild card is valid for $service-name and ds-name, but no state information is displayed when $service-name is an asterisk (*).
Examples—INFO DS Object DS Commands Name: \ODBC.$AS.Mixed Case DSN CpuList: 3,4,5,12,13,14,15 InitPri........................150 ConnectedServers.................1 LastStateChg..........Oct 18 11:43 IdleServer.......................5 MaxServer.......................20 InitServer......................10 Trace..........................OFF ConnInfoStat....................ON SessionInfoStat.................ON SQLStmtStat.....................ON -- Cmd Processed 2 objects, 0 failed. CurrentState...............
Object DS Commands Examples—INFO DS StartAutomatic Automatic DS start when its associated server process starts Trace Activates server trace facility in all servers started by and using this DS SQLPrepareStat SQL prepare statistics gathered when a PREPARE statement is received ConnInfoStat Connection information statistics gathered when a connection is established SQLExecuteSta SQL execute statistics gathered when an EXECUTE statement is received SessionInfoStat Session information statistics g
Object DS Commands START DS START DS This command starts one DS on one service or on all services if the asterisk (*) wild card is specified. New clients can then use this DS. If the DS is already started, START DS returns a success message. Command syntax is:. START DS [obj-name]; obj-name [[[\system-name.][$service-name | *].]ds-name] system-name is the name of the current system of up to 16 CPUs with the same Expand address and where the target MXCS process is running.
Object DS Commands STOP DS STOP DS This command stops one DS on all services or all DSs on one service. The actual termination occurs at different times, depending on the stop-mode attribute you specify. The DS goes to the stopped state only after all servers are stopped. Note. Use INFO DS to determine when a DS is in the STOPPED state. Command syntax is: STOP DS [obj-name], REASON text, [AFTER stop-mode]; obj-name [[[\system-name.][$service-name | *].
Object DS Commands Considerations—STOP DS DISCONNECT terminates the server but not until the remote client terminates the connection. The client connected to a server is not notified that a termination is requested and continues working until it disconnects normally. It could take hours or days for the client to disconnect normally. This is the default mode. REASON text is a nonempty SQL string literal of up to 70 characters, which indicates why the DS is being shut down.
6 Object EVAR Commands This section describes the MXCS administrative commands to use for the object EVAR (see Valid Command and Object Type Pairs on page 2-3): EVAR Types on page 6-1 EVAR Order on page 6-2 ADD EVAR on page 6-3 ALTER EVAR on page 6-6 DELETE EVAR on page 6-9 INFO EVAR on page 6-11 EVAR Types The EVAR object defines NonStop OS or SQL environment variables and provides commands to manage them.
Object EVAR Commands EVAR Order EVAR Order Use the INFO EVAR command to determine the order in which the environment variables are applied when used. EVARS appear in the order of their creation or addition, with the latest EVAR added for a specific type at the end of the list. If the order of the EVARs is important, individually delete one or more of the existing target EVARS by using the DELETE EVAR command.
Object EVAR Commands ADD EVAR ADD EVAR This command adds one EVAR to the DS definition specified. Command syntax is: ADD EVAR [obj-name][, TYPE type-name][, PREFIX string], VALUE string; or ADD EVAR [obj-name], TYPE RMP, LIMIT number[, ACTION key-val]; obj-name [[[[\system-name.][$service-name | *].]ds-name.]evar-name] system-name is the name of the current system of up to 16 CPUs with the same Expand address and where the target MXCS process is running.
Object EVAR Commands Considerations—ADD EVAR PREFIX string is the portion of the object definition that appears before the name. It is an SQL string literal and so requires single quotes. The default value is determined by the type. See EVAR Types on page 6-1. For consistency, this value is displayed in uppercase letters, even though it is a quoted literal. VALUE string is the portion of the object definition that appears after the name. It is an SQL string literal, and so requires single quotes.
Object EVAR Commands Example—ADD EVAR required. Use of the specific service $AS is not significant here; the asterisk (*) wild card is less ambiguous. CS>add evar $AS."TDM_Default_DataSource".=GROUP, type define, value 'CLASS MAP, FILE $DATA3.PERSNL.GROUP'; -- ADD EVAR \ODBC.*.TDM_Default_DataSource.=GROUP Successful This example adds an EVAR type rmp and displays it. The EVAR is named "ESTIMATED COST" in uppercase and enclosed in double quotes to protect the space character.
Object EVAR Commands ALTER EVAR ALTER EVAR This command modifies one existing EVAR in the DS definition specified. Command syntax is:. ALTER EVAR [obj-name][, TYPE type-name][, PREFIX string], VALUE string; or ALTER EVAR [obj-name], TYPE RMP, LIMIT number[, ACTION key-val]; obj-name [[[[\system-name.][$service-name | *].]ds-name.]evar-name] system-name is the name of the current system of up to 16 CPUs with the same Expand address and where the target MXCS process is running.
Object EVAR Commands Considerations—ALTER EVAR PREFIX string is the portion of the object definition that appears before the name. It is an SQL string literal, and so requires single quotes. The default value is determined by the type. See EVAR Types on page 6-1. For consistency, this value is stored in uppercase letters, even though it is a quoted literal. VALUE string is the portion of the object definition that appears after the name. It is an SQL string literal, and so requires single quotes.
Object EVAR Commands Example—ALTER EVAR Omitting all parameters causes an error. All SERVICEs can detect this changed EVAR as soon as it is updated on the disk, but connected servers do not detect it until the current connection is closed. You need not stop the DS to execute ALTER EVAR. Example—ALTER EVAR This example modifies an EVAR of type define, with the name GROUP in the DS TDM_Default_DataSource. You can use the equal (=) sign in the name, but it is not required. CS>alter evar *.
Object EVAR Commands DELETE EVAR DELETE EVAR This command removes the named EVAR from the specified DS definition. Command syntax is: DELETE EVAR [obj-name][, TYPE type-name]; obj-name [[[[\system-name.][$service-name | *].]ds-name.]evar-name | *] system-name is the name of the current system of up to 16 CPUs with the same Expand address and where the target MXCS process is running. system-name and service-name identify one service instance.
Object EVAR Commands Considerations—DELETE EVAR Considerations—DELETE EVAR DELETE EVAR is a sensitive command. The asterisk (*) wild card is supported for evar-name. DELETE EVAR deletes the first EVAR it finds with a name match and then scans for additional matches and displays warnings if found. All SERVICEs remove this deleted EVAR as soon as it is removed from the database, but connected servers do not remove it until the current connection is closed.
Object EVAR Commands INFO EVAR INFO EVAR This command displays the named EVAR from the DS definition specified. Command syntax is: INFO EVAR [obj-name][, TYPE type-name]; obj-name [[[[\system-name.][$service-name | *].]ds-name.]evar-name | *] system-name is the name of the current system of up to 16 CPUs with the same Expand address and where the target MXCS process is running. system-name and service-name identify one service instance.
Object EVAR Commands Considerations—INFO EVAR Considerations—INFO EVAR INFO EVAR is not a sensitive command. The asterisk (*) wild card is supported for evar-name. INFO EVAR displays every EVAR with a name match. If more than one match is found, no warning is generated. INFO EVAR displays the EVARs in the order that they are applied. When an EVAR does not fit on a 79-character line, it is folded at the most reasonable blank space (if possible), with subsequent lines indented four spaces.
Object EVAR Commands Example—INFO EVAR CONTROL QUERY DEFAULT HIST_NO_STATS_UEC '99' CONTROL TABLE * TIMEOUT '3000' CONTROL TABLE PERSNL.JOB MDAM 'OFF' Sets: SET CATALOG TANDEM_SYSTEM_NSK SET SCHEMA PUBLIC_ACCESS_SCHEMA This example uses a compound name. It assumes the same DS as the last example and uses the default type: CS>info evar "PERSNL.JOB MDAM"; -- INFO EVAR \ODBC.*.TDM_Default_DataSource.PERSNL.JOB MDAM Report CONTROL TABLE PERSNL.
Object EVAR Commands Example—INFO EVAR SQL/MX Connectivity Service Administrative Command Reference—526350-005 6-14
7 Object User Commands This section describes the MACL commands that are available to an MXCS administrator for the user object (see Valid Command and Object Type Pairs on page 2-3): ADD USER on page 7-2 ALTER USER on page 7-3 DELETE USER on page 7-4 INFO USER on page 7-5 Only the NonStop OS super ID user SUPER.SUPER, or its alias, is registered in the MXCS configuration database with the grant permission in addition to the operator permission.
Object User Commands ADD USER ADD USER This command adds one user name and permissions to the MXCS configuration database access list. Command syntax is: ADD USER [obj-name][, PERM perm-val]; obj-name [[\system-name.]groupname.membername] system-name is the name of a group of up to 16 CPUs with the same Expand address. system name and service-name identify one instance. groupname is the NonStop OS group logon name. membername is the NonStop OS user logon name with no aliases permitted.
Object User Commands ALTER USER ALTER USER This command changes one user’s permission in the MXCS configuration database access list. Command syntax is: ALTER USER [obj-name][, PERM perm-val]; obj-name [[\system-name.]groupname.membername] system-name is the name of a group of up to 16 CPUs with the same Expand address. system name and service-name identify one instance. groupname is the NonStop OS group logon name. membername is the NonStop OS user logon name with no aliases permitted.
Object User Commands DELETE USER DELETE USER This command deletes one user name and permissions from the MXCS configuration database access list. Command syntax is: DELETE USER [obj-name]; obj-name [[\system-name.]groupname.membername] system-name is the name of a group of up to 16 CPUs with the same Expand address. system name and service-name identify one instance. groupname is the NonStop OS group logon name. membername is the NonStop OS user logon name with no aliases permitted.
INFO USER Object User Commands INFO USER This command displays user names and permissions to the MXCS configuration database access list. It allows display of permissions for one user, all users in one group, or all users with permissions defined. Command syntax is: INFO USER [obj-name]; obj-name [[\system-name.][groupname | *].[membername | *]] system-name is the name of a group of up to 16 CPUs with the same Expand address. system name and service-name identify one instance.
Object User Commands Considerations—INFO USER SQL/MX Connectivity Service Administrative Command Reference—526350-005 7-6
A Example Commands and Objects The appendix provides examples to: Start an MXCS ODBC service named $AS Create and start a DS named TEST_DSN Review the resulting MXCS configuration Stop and delete the DS Stop the service Delete the service Because example object names are not case-sensitive, they appear in lowercase. However, they appear in uppercase in reports. To protect the case of a DS name, enclose it in double quotes (“). Service names are automatically translated to uppercase.
Example Commands and Objects This example starts MXCI and verifies that the service started properly: mxci Hewlett-Packard NonStop(TM) SQL/MX Conversational Interface 2.0 (c) Copyright 2003 Hewlett-Packard Development Company, LP. >>mode mxcs; CS>info service $as; -- INFO SERVICE \ODBC.
Example Commands and Objects SessionInfoStat...................OFF SQLStmtStat.......................OFF SQLExecDirectStat..................ON SQLFetchStat.......................ON CS>info evar *, type all; -- INFO EVAR \ODBC.$AS.TEST_DSN.* Report Resource Management Policies: ESTIMATED COST Limit: 500 Action: STOP Defines: ADD DEFINE =EMP, CLASS MAP, FILE $DATA01.PERSNL.EMPLOYEE Controls: CONTROL QUERY DEFAULT TIMEOUT 'RESET' CONTROL QUERY DEFAULT SCRATCH_DISKS '$data01, $data02, \ODBC.
Example Commands and Objects $Z3503 AVL $Z3504 AVL $Z3505 AVL -- Cmd processed 4 0,388 $ZTC0 21007 1,381 $ZTC0 21008 0,414 $ZTC0 21009 objects, 0 failed. Mar 26 14:07 Mar 26 14:07 Mar 26 14:07 CS>info server *, detail, ds Test_DSN; -- INFO SERVER \ODBC.$AS.* Report, DETAIL DS Name: TEST_DSN PName State SPid TCP/IP PN Port $Z3503 AVL 0,388 $ZTC0 21007 Cl User ID.................Not Avail Cl Proc ID.................Not Avail Last State Chg Remote System Name Mar 26 14:07 Cl App Name................
Index A D ADD command object DS 5-2 object EVAR 6-3 ALTER command object DS 5-8 object EVAR 6-6 Architecture, MXCS 1-2/1-3, 1-5/1-7 Asterisk (*) wild card, using 1-4 Attribute command syntax 2-5 single quotes in 2-8 DELETE command object DS 5-13 object EVAR 6-9 Dollar sign, caveat 2-9 DS instance, definition 2-2 DS name case and quotation marks 2-7 object syntax 2-6 DS, definition 2-2 B Backslash, caveat 2-9 C Calls, MXCS 1-2 Case sensitivity, syntax 2-5 Caveats JDBC/MX, ODBC/MX 1-1 using 1-1, 1-7, 2-1
L Index L Leaving MXCS mode 1-4 M Messages, error 1-7/1-9 Mode command 2-12 MXCI comment syntax 2-12 mode command 2-11 MXCS architecture 1-2/1-3 display prompt 1-4 feature and functions 1-1 MXCI interface 1-4 starting MXCS 2-12 MXCS exit mode 1-4 O Object DS, ADD command 5-2 DS, ALTER command 5-8 DS, DELETE command 5-13 DS, INFO command 5-14 DS, START command 5-18 DS, STOP command 5-19 EVAR, ADD command 6-3 EVAR, ALTER command 6-6 EVAR, DELETE command 6-9 EVAR, INFO command 6-11 SERVER, INFO command 4-2
T Index System name, object syntax 2-6 T Terminal prompt, MSCS 1-4 Terminate MXCS mode 1-4 Terminating character, command-line 2-3 U User name, object syntax 2-7 V VERSION command command syntax 3-7 object SERVICE 3-7 W Wild card, asterisk (*) only 1-4 Special Characters $server name, object syntax 2-6 $service name, object syntax 2-6 SQL/MX Connectivity Service Administrative Command Reference—526350-005 Index-3
