Caché Parameter File Reference
Contents
 
   
Server:docs2
Instance:LATEST
User:UnknownUser
 
-
Go to:
Search:    

 
Contents

Preface : 
 
 
Chapter 1: 
 
  • 1.1 Filename and Location
  • 1.2 Caché Configurations
  • 1.3 Specifying a CPF File
  • 1.4 Editing the Active CPF File
  • 1.5 Configuration Security
  • 1.6 Parameter File Format
  • 1.6.1 Spaces
  • 1.6.2 Sections
  • 1.6.3 Parameters
  • 1.7 Parameter Descriptions
  • 1.8 New or Obsolete Parameters
  • 1.9 List of Sections and Parameters
  •  
    Reference A: 
     
  • CommIPAddress — (OpenVMS) IP Address for inter-cluster communication
  • JoinCluster — (OpenVMS) Join/decline cluster.
  • Reference B: 
     
  • COMn — Default settings for COM ports.
  • Reference C: 
     
  • LibPath — Sets the LD_LIBRARY_PATH environment variable. UNIX® systems only
  • MaxServerConn —  Maximum connections from ECP clients.
  • MaxServers —  Maximum number of connections to ECP servers.
  • Path —  Add to default path environment variable. (UNIX only.)
  • bbsiz —  Maximum memory per process.
  • console — Console log file.
  • errlog —  Maximum entries in the error log.
  • globals — Size of shared memory for global cache.
  • gmheap — Size of the generic memory heap.
  • history — Command line recall.
  • ijcbuff — Size of an InterJob Communication buffer.
  • ijcnum — Number of InterJob Communication devices.
  • locksiz — Maximum size of shared memory for locks.
  • memlock — Enable/disable locking shared memory or the text segment into memory.
  • netjob — Enable/disable remote job requests.
  • nlstab — Number of NLS collation tables.
  • overview — Caché platform and version summary.
  • pijdir —  Pre-Image Journal directory.
  • routines — Size of shared memory for caching routine buffers.
  • udevtabsiz —  Maximum size of the device table.
  • useresidentmem — (OpenVMS) Name of a reserved resident memory section.
  • wijdir —  Write Image Journal files directory.
  • zfheap —  Size and configuration of the $ZF heap.
  • Reference D: 
     
  • Version —  Caché parameter file version.
  • Reference E: 
     
  • Database — Define Caché databases.
  • Reference F: 
     
  • Dumpstyle — Style of core dump.
  • Reference G: 
     
  • Devices — Device types.
  • Reference H: 
     
  • DeviceSubTypes —  Device subtypes.
  • Reference I: 
     
  • ClientReconnectDuration —  How long to attempt ECP reconnection before giving up.
  • ClientReconnectInterval —  Number of seconds to wait between ECP reconnection attempts.
  • ServerTroubleDuration —  Number of seconds an ECP connection stays in troubled state.
  • Reference J: 
     
  • ECPServers —  ECP servers.
  • Reference K: 
     
  • MagTape —  Default mnemonic for WRITE commands to magnetic tape.
  • Other — Default mnemonic for WRITE commands to device types other than magnetic tape, terminal, or sequential file.
  • File —  Default mnemonic for WRITE commands to a sequential file.
  • Mnemonic_TTY —  Default mnemonic for WRITE commands to a terminal device.
  • Reference L: 
     
  • AlternateDirectory —  Alternate location of the journal file.
  • BackupsBeforePurge —  Number of backups before Caché purges finished journal files.
  • CurrentDirectory —  Primary location of the journal file.
  • DaysBeforePurge —  Number of days before Caché purges finished journal files.
  • FileSizeLimit —  Maximum size of a journal file.
  • FreezeOnError — Enable/disable suspending Caché when an error occurs in writing to the journal.
  • JournalFilePrefix — Specify a journal file name prefix.
  • JournalcspSession — Enable/disable journaling of CSP sessions.
  • Reference M: 
     
  • LicenseServers — License servers.
  • Reference N: 
     
  • MagTapes —  Magnetic tape drives.
  • Reference O: 
     
  • Global —  Map globals to namespaces.
  • Package — Map a package to a specific namespace.
  • Routine —  Map routines to namespaces.
  • Reference P: 
     
  • MapMirrors — Describes members of each mirror the instance is a member of.
  • Reference Q: 
     
  • MapShadows.Name — Displays shadow directory mappings.
  • Reference R: 
     
  • Mirrors — Describes mirrors the instance is a member of.
  • Reference S: 
     
  • AgentAddress — Not in use.
  • AsyncMemberGUID — Async member GUID
  • AsyncMemberType — Indicates async type of DR, read-only, or read-write.
  • AsyncUseSystemPurgeInterval — Indicates how mirror journal files are purged on the reporting async member.
  • JoinMirror — Determines whether the instance processes its mirror configuration at startup.
  • SystemName — Mirror member name.
  • ValidatedMember — Determines whether the instance should join the mirror in its previous role or obtain its new role from the current primary before joining the mirror.
  • VirtualAddressInterface — Local interface to primary virtual IPaddress.
  • Reference T: 
     
  • AsyncDisconnectErr —  Enable/disable a process to receive disconnect errors asynchronously.
  • AsynchError —  Enable/disable processes to receive asynchronous errors.
  • BreakMode — Programmer mode response to the BREAK command.
  • CollectResourceStats — Controls whether system resource statistics are collected or not.
  • DisconnectErr —  Enable/disable a process to receive disconnect errors.
  • EnableLongStrings — Enable/disable a large stack space for long strings.
  • FileMode —  Enable/disable writing to a non-existent file.
  • GlobalKillEnabled —  Enable/disable KILL of an unsubscripted global.
  • IEEEError — Enables or disables $DOUBLE returning INF and NAN values system-wide.
  • LineRecall — Enable/disable command line recall for READ commands.
  • LogRollback — Enable/disable logging for transaction rollbacks.
  • MVDefined — Sets MVBasic handling of undefined variables system-wide.
  • NodeNameInPid — Behavior when Caché makes a reference to the special variable $JOB.
  • NullSubscripts — Enable/disable null subscripts on global references.
  • OldZU5 — Clear global vectors when switching namespace.
  • OpenMode —  Read/write mode to use when opening sequential files.
  • PopError — When to pop error handlers off the stack.
  • RefInKind — Result of $NAME and $QUERY when an extended global reference is the argument.
  • ScientificNotation — Enables or disables lowercase "e" as scientific notation symbol system-wide.
  • SetZEOF —  Behavior when Caché encounters an unexpected end-of-file when reading a sequential file.
  • ShutDownLogErrors — Enable/disable writing of Caché system error log entries (see Caché System Error Log in the Monitoring Caché Using the Management Portal chapter of the Caché Monitoring Guide) to the console log file on shutdown.
  • StopID — Sets $ZF process deletion behavior for OpenVMS STOP/ID system-wide. On OpenVMS systems only.
  • SwitchOSdir — Enable/disable switching current working directories when changing namespaces.
  • SynchCommit —  Enable/disable synchronizing TCOMMIT with the corresponding journal write operation.
  • TelnetNUL —  Suppress/issue Telnet NUL at end-of-line for Telnet transmission. Windows only.
  • TruncateOverflow — Enable/disable the <MAXNUMBER> error on numeric overflow.
  • Undefined
  • UseNagleAlgorithm — Enable/disable the Nagle algorithm for Telnet.
  • ViewPastData — Enable $VIEW to examine data outside of Caché memory area.
  • ZaMode — ZALLOCATE (ZA) and ZDEALLOCATE (ZD) behavior.
  • ZDateNull — $ZDATE response to an invalid value.
  • Reference U: 
     
  • PatrolCollectionInterval — Number of seconds between when Caché collects data and makes it available to Patrol.
  • PatrolDisplayMode — Controls how the monitoring data is displayed in the Patrol console.
  • PatrolEnabled — Sets whether the connection to Patrol starts automatically when Caché starts.
  • PatrolTopProcesses — Number of processes to be displayed on the Patrol console.
  • SNMPEnabled —  Enable/disable automatic SNMP startup.
  • WMIEnabled — Enable/disable Windows Management Instrumentation (WMI) monitoring.
  • Reference V: 
     
  • Namespace — Define Caché namespaces.
  • Reference W: 
     
  • Shadow — Define shadow servers.
  • Reference X: 
     
  • AllowRowIDUpdate —  Enable/disable SQL row ID update.
  • Comment —  Enable/disable retaining embedded SQL statements as comments in source code.
  • DBMSSecurity — Enable/disable SQL security.
  • DDLNo201 — Suppress/return error upon CREATE of a previously existing table.
  • DDLNo30 —  Suppress/return error upon DROP of a nonexistent table.
  • DDLNo307 — Suppress/return error upon CREATE of a primary key constraint when one exists.
  • DDLNo311 — Suppress/return error upon ADD a foreign key, when a key of that name already exists.
  • DDLNo315 — Suppress/return error upon DROP of a nonexistent constraint.
  • DDLNo324 — Suppress/return error upon CREATE of a previously existing index.
  • DDLNo333 —  Suppress/return error upon DROP of a nonexistent index.
  • DefaultSchema — Default SQL schema name.
  • DelimitedIds —  Enable/disable interpreting double-quoted strings as delimited identifiers.
  • DropDelete — DROP TABLE behavior.
  • ECPSync — Ensures that the server and client cache are in sync.
  • ExtrinsicFunctions —  Enable/disable extrinsic functions in SQL statements.
  • FastDistinct — Enable/disable SQL DISTINCT optimization.
  • IdKey — Primary key constraint behavior.
  • IdTrxFrom —  The “From” list of characters for Identifier Translation.
  • IdTrxTo —  The “To” list of characters for Identifier Translation.
  • JavaClassPath —  List of additional .jar files to load when the JDBC service is started.
  • JavaHome —  Specifies the Java version to use with the JDBC Gateway.
  • JDBCGatewayAddress — Address of JDBC Gateway.
  • JDBCGatewayJVMArgs — Optional JVM arguments to use when starting the JDBC Gateway.
  • JDBCGatewayLog —  Name of the JDBC Gateway log file.
  • JDBCGatewayPort — Port number for the JDBC Gateway.
  • LockThreshold —  SQL lock threshold.
  • LockTimeout — SQL lock timeout.
  • ODBCVarcharMaxlen —  Define the MaxLen for ODBC fields of type VarChar.
  • QueryProcedures — Defines whether all class queries project as SQL Stored Procedures.
  • ReferentialChecks — Enable/disable validating the foreign key constraint.
  • SaveMAC —  Enable/disable saving the source code for cached query routines.
  • SQLOnlyCompile —  Enable/disable an SQL-only compile.
  • TCPKeepAlive — (Windows and Linux) Number of seconds between keep-alive messages.
  • TimePrecision —  Default time precision for SQL scalar time functions.
  • TODATEDefaultFormat —  Default date format for the SQL TO_DATE() function.
  • Reference Y: 
     
  • System-Defined SQL Datatypes —  Map SQL datatypes to their Caché equivalents.
  • Reference Z: 
     
  • User-Defined SQL Datatypes —  Map SQL datatypes to their Caché equivalents.
  • Reference AA: 
     
  • CallinHalt — Callin close.
  • CallinStart — Callin initialization.
  • CliSysName —  Node name for the local system.
  • DBSizesAllowed — Database block sizes allowed in the database creation screen.
  • DefaultPort — Port number for the Caché Superserver.
  • DefaultPortBindAddress — IP address for the Caché Superserver to bind to.
  • EnsembleAutoStart — Start the Ensemble productions when Caché starts.
  • ErrorPurge —  Number of days to keep error globals.
  • IPv6 —  Enable/disable IPv6 network with IPv6 addresses.
  • JobHalt — Background process (job) shutdown.
  • JobServers —  Number of job servers.
  • JobStart — Background process (job) startup.
  • MaxCacheTempSizeAtStart — Maximum size of database on restart.
  • MaxConsoleLogSize — Maximum size of the console log file.
  • ProcessHalt — Foreground shutdown.
  • ProcessStart — Foreground startup.
  • ShutdownTimeout —  Number of seconds Caché should wait for shutdown to complete.
  • SystemHalt — System shutdown.
  • SystemStart — System startup.
  • TempDirectory —  Subdirectory for temporary files.
  • TerminalPrompt —  Sets the format of the terminal prompt.
  • WebServer —  Start or don't start the Web server.
  • WebServerName —  Sets an IP address or a DNS name on the Web server.
  • WebServerPort —  Set the Web server port.
  • WebServerURLPrefix — Identify the Caché instance name so that a remote Web server can access it.
  • ZSTU — User-defined startup.
  • Reference AB: 
     
  • DNSLookup — (Windows) Enable/disable DNS lookup of the Telnet client address.
  • Port — Telnet port number.