This page provides detailed information about each supported object type, including all available features and actions.
π¦ Save Files (SAVF)
Save files are special file objects used to store saved objects and libraries.
IBM i SQL Services Used
Type Schema Name Purpose Table Function QSYS2SAVE_FILE_INFORetrieve save file metadata and save command Table Function QSYS2SAVE_FILE_OBJECTSList objects, members, and spooled files in save file
Features
π Display save file contents (objects, members, spooled files, IFS directories)
β¬οΈ Download save file to local system
β¬οΈ Upload save file(s) from local system
ποΈ Clear save file contents
πΎ Save objects/libraries to save file
π Restore objects/libraries from save file
Available Actions
Action Description Download Download the save file to your local system as a binary file Upload Upload one or more save files from your local system to IBM i Save Save objects, libraries or IFS paths into the save file using SAVOBJ/SAVLIB/SAV Restore Restore objects, libraries or IFS paths from the save file using RSTOBJ/RSTLIB/RST Clear Clear all contents from the save file
Tip
When Bob Cozziβs CL Prompter and Formatter for IBM i is installed, Save and Restore prompt the CL command (SAV/SAVLIB/SAVOBJ, RST/RSTLIB/RSTOBJ) with the save file already filled in, instead of asking for each parameter one by one. On restore, the library the objects were saved from is proposed as default, and a library save can be restored either as a whole library (RSTLIB) or as single objects (RSTOBJ).
π¨ Data Queues (DTAQ)
Data queues are objects used for inter-process communication, allowing programs to send and receive messages asynchronously.
IBM i SQL Services Used
Type Schema Name Purpose Table Function QSYS2DATA_QUEUE_INFORetrieve data queue attributes and configuration Table Function QSYS2DATA_QUEUE_ENTRIESList all messages in the data queue Procedure QSYS2CLEAR_DATA_QUEUEClear all messages from the queue Procedure QSYS2SEND_DATA_QUEUESend message to data queue Procedure QSYS2SEND_DATA_QUEUE_UTF8Send UTF-8 message to data queue
Features
π Display data queue information and attributes
π View messages in the queue
β‘οΈ Send new messages to the queue
ποΈ Clear all messages from the queue
π Support for keyed and non-keyed data queues
Available Actions
Action Description Send Message Send a new message to the data queue Clear Queue Remove all messages from the data queue
Queue type (keyed/non-keyed)
Maximum message length
Current number of messages
Maximum number of messages
Sequence (FIFO/LIFO/Keyed)
Force to auxiliary storage setting
All messages with their content and keys (if keyed)
π Data Areas (DTAARA)
Data areas are objects that store data that can be accessed by multiple programs.
IBM i SQL Services Used
Type Schema Name Purpose Table Function QSYS2DATA_AREA_INFORetrieve data area type, length, and current value
Features
π Display data area information and current value
π View data area attributes (type, length, decimal positions)
βοΈ Change data area content
π’ Support for different data area types (*CHAR, *DEC, *LGL)
Available Actions
Action Description Change Value Modify the content of the data area using CHGDTAARA
Data area type (*CHAR, *DEC, *LGL)
Length and decimal positions (for *DEC)
Current value
Text description
π¨οΈ Output Queues (OUTQ)
Output queues manage spooled files and printer output.
IBM i SQL Services Used
Type Schema Name Purpose Table Function QSYS2OUTPUT_QUEUE_INFORetrieve output queue status and configuration Table Function QSYS2OUTPUT_QUEUE_ENTRIESList all spooled files in the queue Procedure SYSTOOLSDELETE_OLD_SPOOLED_FILESDelete spooled files older than specified days Function SYSTOOLSGENERATE_PDFGenerate PDF from spooled file
Features
π Display output queue information and statistics
π List all spooled files in a queue with details
βΈοΈ Hold/Release output queues
ποΈ Clear output queue
βΆοΈ Start/Stop printer writers
π Generate PDF from spooled files
ποΈ Delete individual or old spooled files
π¨ Dynamic UI based on queue and writer status
Available Actions
Action Description Hold Queue Hold the output queue (HLDOUTQ) Release Queue Release the output queue (RLSOUTQ) Clear Queue Clear all spooled files from the queue (CLROUTQ) Manage Writer Start or stop printer writers associated with the queue Delete Old Spools Delete spooled files older than a specified number of days
Per Spooled File Actions:
Action Description Open Open the spooled file content in a read-only editor Download Generate a PDF from the spooled file and download it Delete Delete the individual spooled file
Queue status (held/released)
Number of spooled files
Writer status
List of all spooled files with:
File name and number
Job name, user, and number
Status (ready, held, printing, etc.)
Pages and copies
Creation date and time
π Job Queues (JOBQ)
Job queues manage batch jobs waiting to be processed.
IBM i SQL Services Used
Type Schema Name Purpose Table Function QSYS2JOB_QUEUE_INFORetrieve job queue status and statistics Table Function QSYS2JOB_INFOList all jobs in the queue with details
Features
π Display job queue information and statistics
π List all jobs in a queue with their details
βΈοΈ Hold/Release/Clear job queues
βΈοΈ Hold/Release/End/Debug individual jobs
π Open the WRKJOB view for any job in the queue
π¨ Dynamic UI based on queue and job status
Available Actions
Action Description Hold Queue Hold the job queue (HLDJOBQ) Release Queue Release the job queue (RLSJOBQ) Clear Queue Clear all jobs from the queue (CLRJOBQ)
Per Job Actions:
Action Description Availability Details Open the Work with Job (WRKJOB) view for the job All jobs Hold Hold the job (HLDJOB) Jobs not held Release Release the job (RLSJOB) Held jobs End End the job (ENDJOB) All jobs Debug Start a service entry point to debug the job All jobs
Queue status (held/released)
Number of jobs
Subsystem information
List of all jobs with:
Job name, user, and number
Job status
Job type
Priority
Submission date and time
πΎ User Spaces (USRSPC)
User spaces provide temporary or permanent storage for data that can be accessed by multiple programs.
IBM i SQL Services Used
Type Schema Name Purpose Table Function QSYS2USER_SPACE_INFORetrieve user space attributes and configuration Table Function QSYS2USER_SPACERead user space content Procedure QSYS2CHANGE_USER_SPACEModify user space data at specific position
Features
π Display user space information and attributes
π View user space content (hexadecimal and text representation)
βοΈ Change user space data at specific positions
π Support for different user space sizes
π Automatic space extension capabilities
Available Actions
Action Description Change Data Modify data at a specific position in the user space
Current size and initial size
Auto-extend setting
Space value (initial fill character)
Content displayed in both hexadecimal and text format
Offset positions for easy reference
π User Indexes (USRIDX)
User indexes provide fast keyed access to data stored in user-defined entries, similar to a hash table or dictionary.
IBM i SQL Services Used
Type Schema Name Purpose Table Function QSYS2USER_INDEX_INFORetrieve user index attributes and configuration Table Function QSYS2USER_INDEX_ENTRIESList all entries with keys and values Procedure QSYS2ADD_USER_INDEX_ENTRYAdd new entry to user index Table Function QSYS2REMOVE_USER_INDEX_ENTRYRemove entries from user index
Features
π Display user index information and attributes
π View all entries with their keys and values
β Add new entries to the user index
ποΈ Remove entries from the user index
π Support for variable-length entries
π View entry statistics and index configuration
Available Actions
Action Description Add Entry Add a new key-value entry to the user index Remove Entry Remove an entry from the user index by key
Entry length attributes
Key length
Immediate update setting
Optimization setting
Number of entries
List of all entries with keys and values
π Message Files (MSGF)
Message files contain predefined messages used by IBM i applications.
IBM i SQL Services Used
Type Schema Name Purpose Table Function QSYS2MESSAGE_FILE_DATARetrieve all message definitions from message file
Features
π Display all messages in the message file
π View message details (ID, text, severity, reply type)
π First and second level message text
βοΈ Reply type and valid reply values
β Add, change and remove message descriptions
π Fast table component for performance with many messages
Available Actions
Action Description Add Message Description Prompt ADDMSGD to add a new message to the message file
Per Message Actions:
Action Description Change Prompt CHGMSGD for the selected message Delete Remove the selected message (RMVMSGD) after confirmation
Message ID
Message severity
First level text
Second level text (help text)
Reply type
Valid reply values
Default reply value
π¬ Message Queues (MSGQ)
Message queues store messages sent by programs, system functions, or users, providing communication between jobs.
IBM i SQL Services Used
Type Schema Name Purpose Table Function QSYS2MESSAGE_QUEUE_INFORetrieve all messages in the queue with details Procedure QSYS2SEND_MESSAGESend message to message queue
Features
π Display message queue contents with detailed information
π View message text (first and second level)
π
Show message metadata (severity, timestamp, sender job/user)
ποΈ Clear all messages from the queue
π¨ Send message to the queue
β©οΈ Reply to inquiry messages
π Fast table component for performance with many messages
Available Actions
Action Description Send Message Send a new message to the message queue Clear Queue Remove all messages from the queue
Per Message Actions:
Action Description Reply Reply to an inquiry message (SNDRPY); shown only for messages awaiting a reply
Message ID and type
Message severity
Message text (first and second level)
Sender information (job, user, program)
Timestamp
Reply status (for inquiry messages)
π Binding Directories (BNDDIR)
Binding directories contain lists of service programs and modules used during program binding.
IBM i SQL Services Used
Type Schema Name Purpose Table Function QSYS2BINDING_DIRECTORY_INFORetrieve all entries in binding directory Table Function QSYS2PROGRAM_EXPORT_IMPORT_INFORetrieve exported symbols from service programs
Features
π Display binding directory entries
π View bound objects (library, type, activation)
π
Creation date and time information
β Add new entries to binding directory
ποΈ Delete entries from binding directory
π View exported symbols from service programs
Available Actions
Action Description Add Entry Add a new service program or module to the binding directory (ADDBNDDIRE)
Per Entry Actions:
Action Description Remove Remove the entry from the binding directory (RMVBNDDIRE)
Object name and library
Object type (*SRVPGM or *MODULE)
Activation group
Creation timestamp
For service programs: list of exported procedures
π§ Programs (PGM) and Service Programs (SRVPGM)
Programs and service programs are executable objects.
IBM i SQL Services Used
Type Schema Name Purpose Table Function QSYS2PROGRAM_INFORetrieve comprehensive program information Table Function QSYS2BOUND_MODULE_INFOList all bound modules Table Function QSYS2BOUND_SRVPGM_INFOList all bound service programs Table Function QSYS2PROGRAM_EXPORT_IMPORT_INFORetrieve exported procedures (for *SRVPGM) Table Function temporary library PGMREFSList referenced objects, wrapping the DSPPGMREF command (see References )
Features
π Display comprehensive program information
π View program attributes and properties
π List bound modules
π¦ List bound service programs
π View exported symbols (for service programs)
π Debug data availability information
π
Creation and compilation information
π List referenced objects (DSPPGMREF)
π¨ Multi-tab interface: Detail, Bounds, Exports and References
Program type and attributes
Activation group
Optimization level
Debug data availability
Creation and compilation timestamps
Source file information
List of bound modules
List of bound service programs
Exported procedures (for *SRVPGM)
Program size and statistics
Referenced objects
π§© Modules (MODULE)
Modules are compiled ILE objects that contain executable code and can be bound into programs or service programs.
Features
π Display comprehensive module information
π View module attributes (creation date, source file, compiler options)
π Detailed size information (code size, data size, debug data)
π§ List all procedures defined in the module
π View imported and exported symbols
π¦ Display referenced system objects
Β©οΈ Show copyright information
π List referenced objects (DSPPGMREF)
π¨ Multi-tab interface for organized information display
IBM i Services Used
Type Schema Name Purpose Command QSYSDSPMODRetrieve module details (output to a temporary outfile) Table Function temporary library PGMREFSList referenced objects, wrapping the DSPPGMREF command (see References )
Module attributes and compiler options
Source file and member information
Creation and compilation timestamps
Size breakdown (code, data, debug)
List of procedures with export status
Imported and exported symbols
Referenced system objects
Copyright information
Referenced objects
βοΈ Commands (CMD)
Command objects define IBM i CL commands.
IBM i SQL Services Used
Type Schema Name Purpose Table Function QSYS2COMMAND_INFORetrieve command definition and attributes
Features
π Display command definition
π View all command parameters
π Parameter keywords and values
π Parameter descriptions
π’ CCSID information
Command processing program
Validity checker program
Mode (production/debug)
Threadsafe indicator
Maximum positional parameters
Prompt override program
List of all parameters with:
Keyword
Type and length
Minimum/maximum values
Default value
Required/optional status
Prompt text
π Job Descriptions (JOBD)
Job descriptions define the runtime environment for batch jobs.
IBM i SQL Services Used
Type Schema Name Purpose Table Function QSYS2JOB_DESCRIPTION_INFORetrieve job description attributes and configuration
Features
π Display job description attributes
π View job queue, output queue, and message queue
π€ User profile and initial library list
βοΈ Job attributes and system values
π§ Routing data and request data
βοΈ Change job description parameters
Available Actions
Action Description Change Prompt CHGJOBD for the job description
Job queue and priority
Output queue and priority
Message queue
User profile
Initial library list
Job date and job switches
Routing data
Request data
Accounting code
Message logging level
Inquiry message reply
π Journal Receivers (JRNRCV)
Journal receivers store journal entries for auditing, recovery, and replication purposes.
IBM i SQL Services Used
Type Schema Name Purpose View QSYS2JOURNAL_RECEIVER_INFORetrieve journal receiver attributes and configuration
Features
π Display journal receiver information and attributes
π View receiver status and statistics
π’ View sequence number ranges (first/last)
π
View attachment and detachment timestamps
π View linked receivers (previous/next in chain)
π View remote journal configuration
π View filter settings (objects, images, programs)
πΎ View size and threshold information
Receiver status (online/saved/freed)
Sequence number range
Attachment and detachment timestamps
Associated journal
Previous and next receivers in chain
Size and threshold information
Remote journal configuration
Filter settings
π Journals (JRN)
Journals record changes to database files, data areas, and other objects for auditing, recovery, and replication.
IBM i SQL Services Used
Type Schema Name Purpose View QSYS2JOURNAL_INFORetrieve journal configuration and settings View QSYS2JOURNAL_RECEIVER_INFORetrieve receiver chain information Table Function QSYS2DISPLAY_JOURNALDisplay journal entries using SQL queries
Features
π Display journal information and configuration
π View journal receiver chain with details
π View attached receiver and receiver statistics
π’ View sequence number ranges for each receiver
π
View attachment, detachment, and save timestamps
π View remote journal configuration
π Display journal entries using SQL queries
β Generate new journal receivers
πΎ View size and threshold information
βοΈ View journal settings (cache, filtering, fixed-length data options)
Available Actions
Action Description Generate Receiver Generate a new journal receiver (CHGJRN JRNRCV(*GEN)) Display Journal Display journal entries using SQL queries
Current attached receiver
Journal state and attributes
Receiver chain with all receivers
Sequence number ranges
Attachment and detachment timestamps
Remote journal configuration
Journal settings (cache, filtering, etc.)
Journaled objects
π DDM Files (DDMF)
DDM (Distributed Data Management) files provide access to files on remote systems.
Features
π Display DDM file configuration and attributes
π View remote location information (system name/address, port)
π View remote file name and library
βοΈ View access method and file attributes
π View security and connection settings
π Support for multi-line field values
Remote location name
Remote system name or IP address
Remote file name and library
Port number
Access method
Local/remote format
Connection settings
Security settings
π₯οΈ Subsystem Descriptions (SBSD)
Subsystem descriptions define independent operating environments within IBM i that control how work enters the system and how resources are allocated.
IBM i SQL Services Used
Type Schema Name Purpose Table Function QSYS2SUBSYSTEM_INFORetrieve subsystem status and configuration Table Function QSYS2SUBSYSTEM_POOL_INFORetrieve memory pool configuration Table Function QSYS2AUTOSTART_JOB_INFORetrieve autostart job entries Table Function QSYS2WORKSTATION_INFORetrieve workstation entries Table Function QSYS2ROUTING_ENTRY_INFORetrieve routing entries Table Function QSYS2PRESTART_JOB_INFORetrieve prestart job entries Table Function QSYS2JOB_QUEUE_INFORetrieve job queue entries Table Function QSYS2ACTIVE_JOB_INFORetrieve active jobs in subsystem
Features
π Display subsystem information and status (active/inactive)
π View memory pools configuration
π View autostart job entries (AJEs)
π» View workstation entries (WSEs)
π View job queue entries (JOBQEs)
π View routing entries (RTGEs)
β‘ View prestart job entries (PJEs)
π₯ View active jobs in the subsystem (when active)
βΆοΈ Start subsystem
βΉοΈ End subsystem with multiple options (*IMMED, *CNTRLD)
βΈοΈ Hold, release and end individual jobs within the subsystem, or open them in WRKJOB
π¨ Dynamic UI based on subsystem status
Available Actions
Action Description Start Subsystem Start the subsystem (STRSBS) End Subsystem End the subsystem with options (*IMMED or *CNTRLD)
Per Job Actions (active jobs in the subsystem):
Action Description Availability Details Open the Work with Job (WRKJOB) view for the job All jobs Hold Hold the job (HLDJOB) Jobs not held Release Release the job (RLSJOB) Held jobs End End the job (ENDJOB *IMMED) All jobs
Subsystem status (active/inactive)
Memory pools configuration
Autostart job entries
Workstation entries
Job queue entries
Routing entries
Prestart job entries
Active jobs (when subsystem is active)
π― Classes (CLS)
Classes define the runtime attributes for batch jobs, controlling how jobs execute and consume system resources.
Features
π Display class information and attributes
ποΈ View run priority (1-99, lower number = higher priority)
β±οΈ View time slice in milliseconds
πΎ View maximum temporary storage allowed
β‘ View maximum CPU time limit
π₯ View maximum active threads
β³ View default wait time for locks
ποΈ View purge eligibility status
π
View usage statistics (last used date, days used count)
IBM i Services Used
Run priority (1-99)
Time slice (milliseconds)
Default wait time
Maximum CPU time
Maximum temporary storage
Maximum threads
Purge eligibility
Usage statistics
π Files (FILE)
File objects include physical files (PF), logical files (LF), views, and indexes that store and organize data.
IBM i SQL Services Used
Type Schema Name Purpose View QSYS2SYSTABLESRetrieve table/file metadata and attributes View QSYS2SYSCOLUMNSRetrieve column definitions and properties View QSYS2SYSVIEWSRetrieve view definition and capabilities View QSYS2SYSTABLESTATRetrieve file statistics (rows, operations, I/O) View QSYS2SYSMEMBERSTATRetrieve member-level statistics View QSYS2SYSINDEXESRetrieve index metadata and attributes View QSYS2SYSINDEXSTATRetrieve index statistics and usage metrics View QSYS2SYSKEYSRetrieve the key columns of SQL indexes Table Function QSYS2LIBRARY_INFORetrieve the ASP of the library Table Function QSYS2OBJECT_STATISTICSRetrieve object-level statistics and information Table Function SYSTOOLSRELATED_OBJECTSRetrieve dependent objects (indexes, views, constraints)
Features
π Display comprehensive file/table/view/index information
π View file attributes (creation date, owner, journaling status, CCSID)
π View detailed statistics (row counts, operations, I/O metrics)
π₯ Display file members with their statistics
π§ Display columns and data types, with key position and uniqueness
π Display the key columns of SQL indexes
π Show dependent objects (indexes, views, constraints)
π Query file contents using SQL SELECT (physical and logical files only)
π View view definitions and capabilities
π― Support for both DDS and SQL-based files
π¨ Multi-tab interface for organized information display
Available Actions
Action Description Query File Execute a SQL SELECT statement to view file contents (physical and logical files only)
File type (PF, LF, view, index)
File attributes and creation information
Record format and CCSID
Journaling status
Number of members and records
File statistics (reads, writes, updates, deletes)
Column definitions with data types
Key columns (for indexes)
File members with statistics
Dependent objects (indexes, views, constraints)
View definition (for views)
π Query Definitions (*QRYDFN)
Query definitions are objects created by Query/400 or Query Manager that define database queries.
Features
π Automatic translation to SQL - Opening the object retrieves the query definition and shows the equivalent SQL statement directly in a read-only text editor (no webview)
π Automatic file reference conversion (LIB/FILE β LIB.FILE)
π Full VS Code find and SQL syntax highlighting on the generated statement
The query definition is automatically translated to an equivalent SQL SELECT statement, making it easier to understand and potentially migrate to SQL-based queries.
References
Programs, service programs and modules have a References tab listing the objects they reference, the same information returned by the DSPPGMREF command:
Referenced object (library/name) and type
Source name
Record format and record format count
File usage
Level check ID
Field count
Components installed by the extension
Some information is not available through IBM i SQL services, so the extension registers these SQL routines as Code for IBM i components. They are installed automatically in the temporary library (ILEDITOR by default), and the table functions are checked against their signature :
Component Type Used by Purpose PGMREFSTable Function *PGM, *SRVPGM, *MODULEWraps the DSPPGMREF command (original SQL by Bob Cozzi) QWCRCLSIProcedure *CLSExternal procedure over the QWCRCLSI (Retrieve Class Information) API CLASS_INFOTable Function *CLSReturns the attributes of a class, combining QWCRCLSI with QSYS2.OBJECT_STATISTICS