MUPIP Command Summary

MUPIP Command Summary
Prev	Chapter 5. General Database Management	Next

COMMAND	OBJECTS	MAIN QUALIFIER	GT.M version*	Standalone Access#
B[ACKUP]	region-list	-BK[UPDBJNL]=DISABLE \| OFF
		-BY[TESTREAM] -NET[TIMEOUT]=seconds
		-C[OMPREHENSIVE]
		-DA[TABASE] -REPLA[CE]
		-I[NCREMENTAL]
		-[NO]J[OURNAL][=journal-options-list]
		-NETTIMEOUT
		-[NO]NEWJNLFILES[=[NO]PREVLINK],[NO]S[YNC_IO]
		-O[NLINE]
		-RECORD
		-REPLI[NSTANCE]=OFF \| ON
		-S[INCE]={DATABASE\|BYTESTREAM\|RECORD}
		-T[RANSACTION=hexa;transaction_number]
CRE[ATE]	-	-R[EGION]=region-name		Y
DO[WNGRADE]	file-name	-V[ERSION]=V5	-V7.0-000	Y
DU[MPFHEAD]	File-name or region-list	-FI[LE]	V6.3-001
		-R[EGION]	V7.0-003
EN[DIANCVT]	file-name	-OUTDB=<outdb-file>		Y
		-OV[ERRIDE]		Y
EXI[T]	-	-		N/A
EXTE[ND]	region-name	-B[LOCKS]=blocks
EXTR[ACT]	-	-FO[RMAT]=GO\|B[INARY]\|Z[WR]
		-FR[EEZE]
		-NU[LL_IV]	V6.3-000
		-LA[BEL]=text
		-[NO]L[OG]
		-S[ELECT]=global-name-list
		-O[CHSET]=character-set
		-R[EGION=region-list
FR[EEZE]	region-list	-OF[F] [-OV[ERRIDE]]
		-ON [-[NO]ONL[INE] [-[NO]A[UTORELEASE]] [-R[ECORD]]]
FT[OK]	File-name	-D[B]
		-J[NLPOOL]
		-R[ECVPOOL]
HE[LP]	command-option	-
INTE[G]	File-name or region-list	-A[DJACENCY]=integer]
		-BL[OCK]=hexa;block-number]
		-BR[IEF]
		-DMAXBLOCKSIZE=integer	V7.1-002
		-FA[ST]
		-FI[LE]		Y
		-FU[LL]
		-IMAXBLOCKSIZE=integer	V7.1-002
		-NO]K[EYRANGES
		-[NO][MAP]=integer
		-[NO]MAXK[EYSIZE]=integer
		-R[EGION]
		-[NO]ST[ATS]
		-SU[BSCRIPT]=subscript
		-TN[_RESET]		Y
		-[NO]TR[ANSACTION][=integer]
INTR[PT]	process id			N/A
J[OURNAL]	file-name	-EX[TRACT][=file-specification\|
		-stdout]	V5.5-000
		-REG[ION]	V6.2-000
		-REC[OVER] \| -RO[LLBACK]
		-SH[OW][=show-option-list]
		-[NO]V[ERIFY]
		-BA[CKWARD] \| -FO[RWARD]
		-CO[RRUPTDB]	V6.3-010
L[OAD]	file-name	-BE[GIN]=integer
		-BLOCK_DENSITY
		-E[ND]=integer
		-FI[LLFACTOR]=integer
		-FO[RMAT]=GO\|B[INARY]\|Z[WR]
		-S[TDIN]	V5.5-000
		-O[NERROR]
REO[RG]		-D[OWNGRADE]	-V7.0-000
		-ENCR[YPT]=key	V6.3-000
		-E[XCLUDE]=global-name-list
		-FILL[_FACTOR]=integer
		-FILE=file-name
		-I[NDEX_FILL_FACTOR]=integer
		-K[EEP]={pct%\|blocks}	V6.3-009
		-MIN[_LEVEL]=integer	V7.1-002
		-NOCO[ALESCE]	V6.3-009
		-NOSP[LIT]	V6.3-009
		-NOSW[AP]	V6.3-009
		-R[ESUME]
		-S[ELECT]=global-name-list
		-T[RUNCATE][=percentage]	V5.5-000
		-UP[GRADE]		Y
		-REG[ION] region-list
REP[LICATE]	file-name	-E[DITINSTANCE]
		-N[AME]	V5.5-000
		-I[NSTANCE_CREATE]
		-R[ECEIVER
		-S[OURCE]
		-UPDA[TEPROC]
RES[TORE]	file-name or file-list	-[NO]E[XTEND]		Y
RU[NDOWN]	file-name or region-name	-F[ILE]		Y
		-R[EGION]
		-RELINKCTL [dir]
		-OVERRIDE
SEM[APHORE]	sem-ids-list
SET	file-name or region-name	{-FI[LE] file-name\|-JN[LFILE] journal-file-name\|-REG[ION] region-list\|-REP[LICATION]={ON\|OFF}}
		-AC[CESS_METHOD]={BG\|MM}		Y
		-[NO]AS[YNCIO]		Y
		-DATA_[RESERVED_BYTES]=integer	V7.1-002
		-[NO]DE[FER_TIME][=seconds]
		-[NO]DEFER_ALLOCATE	V6.2-002
		-[NO]EP[OCHTAPER]	V6.2-001
		-[NO]ENCRYPTABLE	V6.3-000	Y
		-E[XTENSION_COUNT]=integer(no of blocks)
		-F[LUSH_TIME]=integer
		-FU[LLBLKWRT]={0\|1\|2}	V6.3-012	Y
		-G[LOBAL_BUFFERS]=integer		Y
		-H[ARD_SPIN_COUNT]=integer	V6.3-003
		-INDEX_[RESERVED_BYTES]=integer	V7.1-002
		-[NO]INST[_FREEZE_ON_ERROR]	V6.0-000
		-JN[LFILE] journal-file-name		Y
		-K[EY_SIZE]=bytes		Y
		-[NO]LCK_SHARES_DB_CRIT		Y
		-L[OCK_SPACE]=integer		Y
		-M[UTEX_SLOTS]=integer	V6.0-002	Y
		-N[ULL_SUBSCRIPTS]=value	V6.3-003	Y
		-PA[RTIAL_RECOV_BYPASS]		Y
		-[NO]Q[DBRUNDOWN]	V6.0-000	Y
		-[NO]REA[D_ONLY]	V6.3-003	Y
		-REC[ORD_SIZE]=bytes		Y
		-REG[ION] region-list
		-REP[LICATION]={ON\|OFF}		Y
		-RES[ERVED_BYTES]=integer
		-SLEE[P_SPIN_COUNT]=integer
		-SPIN[_SLEEP_MASK]=hexa_mask	V6.3-003
		-STAN[DALONENOT]		Y
		-[NO]STD[NULLCOLL]	V6.3-003	Y
		-[NO]STAT[S]		Y
		-STATSD[B_ALLOCATION]=integer	V7.0-001	Y
		-V[ERSION]={V5\|V6}	-V7.0-000
		-W[AIT_DISK]=integer		Y
SI[ZE]	global-name-list region-list	-H[EURISTIC]=estimation_technique	V6.0-001
		-S[ELECT]=global-name-list	V6.0-001
		-R[EGION]=region-list	V6.0-001
ST[OP]	process-id	process-id		N/A
TR[IGGER]	-	-TRIG[GERFILE]=<trigger_definitions_file>	V5.4-002
		-NOPR[OMPT]	V5.4-002
		-SELE[CT][=name-list\|*][<select-output-file>]	V5.4-002
		-UPGRADE	V5.4-002
UP[GRADE]	File-name or region-list	-F[ILE]	V7.1-000	Y
		-R[EGION]		Y

The following table summarizes the qualifiers.

Main Qualifier	MUPIP Command	Options/Qualifiers	GT.M Version*
-EDITINSTANCE	REPLICATE	-CHANGE
		-DETAIL
		-OFFSET=hexa
		-VALUE=hexa
		-SIZE=hexa
		-VALUE=hexa
		-[NO]QDBRUNDOWN	V6.3-000
-FENCES=<fence-options-list>	JOURNAL-RECOVER-ROLLBACK	ALWAYS
		NONE
		PROCESS
-OFF	FREEZE	-OVERRIDE
		-RECORD
-ON	FREEZE	-[NO]ONLINE
		-[NO]AUTORELEASE
-INSTANCE_CREATE	REPLICATE	-NAME
		-NOREPLACE
		-SUPPLEMENTARY	V5.5-000
		-[NO]QDBRUNDOWN	V6.3-000
-JOURNAL=<journal-options-list>	BACKUP SET	ALIGNSIZE=integer
		ALLOCATION=integer
		AUTOSWITCHLIMIT=integer
		BEFORE_IMAGES
		BUFFER_SIZE=integer
		DISABLE
		ENABLE
		EPOCH_INTERVAL=integer
		EXTENSION=integer
		FILENAME=file_name
		OFF
		ON
		SYNC_IO
		YIELD_LIMIT=integer
-LOOKBACK_LIMIT=lookback-option-list	-RECOVER -ROLLBACK	TIME="time"
		OPERATIONS=integer
-RECEIVER	REPLICATE	-AUTOROLLBACK	V5.5-000
		-BUFFSIZE=integer
		-CHANGELOG
		-CHECKHEALTH
		-CMPLVL=integer
		-FILTER=filter_name
		-he[lpers]=[m[,n]]
		-INITIALIZE	V6.0-000
		-CMPLVL=n
		-LISTENPORT=integer [
		-AUTOROLLBACK[=VERBOSE]]	V5.5-000
		-LOG=logfile
		-LOG_INTERVAL=integer
		-[NO]RECVBUFFSIZE[=integer]
		-NORESYNC	V5.5-000
		-RESUME=strm_num	V5.5-000
		-REUSE=instname	V5.5-000
		-RSYNC_STRM=strm_num	V5.5-000
		-[NO]SENDBUFFSIZE[=integer]
		-SHOWBACKLOG
		-SHUTDOWN
		-START
		-STATSLOG=[ON\|OFF]
		-STOPRECEIVERFILTER	V6.3-009
		-STOPSOURCEFILTER
		-TIMEOUT=seconds
		-TLSID=label	V6.1-000
		-UPDATEONLY
		-UPDOK	V5.5-000
		-UPDNOTOK	V5.5-000
		-UPDATERESYNC=/path/to/bkup-orig-inst	V5.5-000
-RECOVER	JOURNAL	-AFTER=time
		-APPLY_AFTER_IMAGE
		-BACKWARD
		-BEFORE=time
		-[NO]BROKENTRANS[=file]
		-CHAIN
		-CHECKTN
		-[NO]ER[ROR_LIMIT][=integer]
		-FENCES=fence-option-list
		-FORWARD
		-FULL
		-GLOBAL=<global_list>
		-ID=<pid_list>
		-INTERACTIVE
		-LOOKBACK_LIMIT=<lookback_limit_options>
		-[NO]LOSTTRANS[=file]
		-PARA[LLEL][=n]	V6.3-000
		-RED[IRECT]=file-pair-list
		-SINCE=time
		-VERBOSE
		-VERIFY
-EXTRACT	JOURNAL	-AFTER=time
		-BEFORE=time
		-[NO]BROKENTRANS[=file]
		-CHAIN
		-CHECKTN
		-[NO]ER[ROR_LIMIT]=integer]
		-FENCES=fence-option-list
		-FULL
		-GLOBAL=<global_list>
		-GV[PATFILE]=/path/to/pattern-file	V6.3-009
		-ID=<pid_list>
		-INTERACTIVE
		-LOOKBACK_LIMIT=<lookback_limit_options>
		-[NO]LOSTTRANS[=file]
		-REGION
		-SINCE=time
		-VERBOSE
		-VERIFY
-ROLLBACK	JOURNAL	-APPLY_AFTER_IMAGE
		-BACKWARD
		-BEFORE=time
		-[NO]BROKENTRANS[=file]
		-[NO]ER[ROR_LIMIT][=integer]
		-FENCES=fence-option-list
		-FETCHRESYNC
		-LOOKBACK_LIMIT=<lookback_limit_options>
		-[NO]LOSTTRANS[=file]
		-ONLINE	V5.5-000
		-PARA[LLEL][=n]	V6.3-000
		-RES[YNC]=hexa;journal_sequence_number
		-VERBOSE
		-VERIFY
-SHOW=<show-option-list>	JOURNAL	-ACTIVE_PROCESSES
		-ALL
		-BROKEN_TRANSACTIONS
		-HEADER
		-PROCESSES
		-STATISTICS
		-AFTER=time
		-USER=user-list
		-TRANSACTION=[KILL\|SET]
		-INTERACTIVE
		-GLOBAL=<global_list>
		-ID=<pid_list>
		-INTERACTIVE
		-PARA[LLEL][=n]	V6.3-000
-SINCE	BACKUP	-BYTESTREAM
		-COMPREHENSIVE
		-DATABASE
		-INCREMENTAL
		-RECORD
-SO[URCE]	REPLICATE	-ACTIVATE
		-BUFFSIZE=integer
		-CHANGELOG
		-CHECKHEALTH
		-CMPLVL=integer
		-CONNECTPARAMS=connection_options
		-DEACTIVATE
		-DETAIL
		-FILTER=filter_name
		-FREEZE=on\|off	V6.0-000
		-[NO]COMMENT=string
		-INSTSECONDARY=secondary_instance name
		-NOJNLFILEONLY	V6.2-001
		-JNLPOOL-LOG=log_file
		-LOG_INTERVAL=integer
		-LOSTTNCOMPLETE
		-NEEDRESTART
		-PASSIVE
		-[NO]PLAINTEXTFALLBACK	V6.1-000
		-PROPAGATEPRIMARY
		-[NO]RECVBUFFSIZE[=integer]	V7.1-002
		-RENEGOTIATE_INTERVAL=minutes
		-ROOTPRIMARY
		-SECONDARY=secondary_instance_name
		-[NO]SENDBUFFSIZE[=integer]	V7.1-002
		-SHOWBACKLOG
		-SHUTDOWN
		-START
		-STATSLOG
		-STOPSOURCEFILTER
		-TIMEOUT=seconds
		-TLSID=label	V6.1-000
		-UPDOK
		-UPDNOTOK
		-ZEROBACKLOG
-VERSION={V5\|V6}	DOWNGRADE UPGRADE	file-name	-V7.0-000

* denotes the GT.M version in which the qualifier or command was first introduced. Versions that start with a minus sign, -, denote versions where the qualifier or command was removed. This column is maintained for qualifiers and command introduced in GT.M versions starting with GT.M V5.4-002.

# Additional information about Standalone Access:

Although MUPIP EXTRACT does not require standalone access, without the -FREEZE qualifier to prevent the database to prevent updates, it does not guarantee a consistent state. Therefore, from an application standpoint, you might plan for a standalone access during a MUPIP EXTRACT operation.
Although MUPIP LOAD does not require standalone access, you should always assess the significance of performing a MUPIP LOAD operation when an application is running because it may result in an inconsistent application state for the database.
MUPIP commands that need standalone access issue a MUUSERLBK error on a crashed replication-enabled database and MUUSERECOV error in case of a non-replicated-but-journaled database.

Prev	Up	Next
Commands and Qualifiers	Home	Chapter 6. GT.M Journaling