Skip to main content

Clear Data Queue from SQL - IBM i

Clear Data Queue:


Data Queues (DTAQ) has been very useful for communication between different Jobs on IBM i. 

There are multiple APIs to work with Data Queues. In the last post we have seen How to Retrieve data from Data Queue using SQL

In this post, we will see how to clear data from Data Queue in SQL using 'CLEAR_DATA_QUEUE' Procedure in QSYS2 with some examples. This would work similar to API 'QCLRDTAQ'. 

Let's look at an example of clearing all the entries from a Standard Data Queue. 

E.g.: 

CLEAR_DATA_QUEUE

In the above statement, We are passing two parameters.
  • 1st Parameter: Data Queue - Name of the Data Queue that needs to be cleared. 
  • 2nd Parameter: Data Queue Library - Name of the Library Data Queue is present in. This parameter accepts special variables like '*LIBL' or '*CURLIB'. 
Let's look at another example of Keyed Data Queue and clearing only set of records based on the Key. 

E.g.: 

Before we actually clear the Data Queue, Below are the messages present in Data Queue. 

DATA_QUEUE_ENTRIES

Now, Let's clear the messages in the Data Queue with Key Data greater than '02'. This should clear the messages with Key data '03' and '04'. 

CLEAR_DATA_QUEUE

In the above statement, We are passing two additional parameters to control what data we clear based on the Key data. These parameters can only be specified for Keyed Data Queue.
  • 3rd Parameter: Key Data - String containing the Key value. This should be of same length defined while creating Data Queue.
  • 4th Parameter: Key Order - Comparison criteria to determine which messages to be cleared from Data Queue. Below are the possible values for this parameter.
EQAll messages with Key equal to Key data are to be returned.
GEAll messages with Key greater than or equal to Key data are to be returned.
GTAll messages with Key greater than Key data are to be returned.
LEAll messages with Key less than or equal to Key data are to be returned.
LTAll messages with Key less than Key data are to be returned.
NEAll messages with Key not equal to Key data are to be returned.

This has cleared the messages from Data Queue with Key data greater than '02'. 

DATA_QUEUE_ENTRIES

This procedure can be called from Interactive SQL, Run SQL scripts, Other SQL Procedures or Embedded SQL in RPG programs. 

If you have any Suggestions or Feedback, Please leave a comment below or use Contact Form.

Comments

Popular posts from this blog

All about READ in RPGLE & Why we use it with SETLL/SETGT?

READ READ is one of the most used Opcodes in RPGLE. As the name suggests main purpose of this Opcode is to read a record from Database file. What are the different READ Opcodes? To list, Below are the five Opcodes.  READ - Read a Record READC - Read Next Changed Record READE - Read Equal Key Record READP - Read Prior Record READPE - Read Prior Equal Record We will see more about each of these later in this article. Before that, We will see a bit about SETLL/SETGT .  SETLL (Set Lower Limit) SETLL accepts Key Fields or Relative Record Number (RRN) as Search Arguments and positions the file at the Corresponding Record (or Next Record if exact match isn't found).  SETGT (Set Greater Than) SETGT accepts Key Fields or Relative Record Number (RRN) as Search Arguments and positions the file at the Next Record (Greater Than the Key value). Syntax: SETLL SEARCH-ARGUMENTS/KEYFIELDS FILENAME SETGT  SEARCH-ARGUMENTS/KEYFIELDS FILENAME One of the below can be passed as Search Arguments. Key Fiel

What we need to know about CHAIN (RPGLE) & How is it different from READ?

CHAIN READ & CHAIN, These are one of the most used (& useful) Opcodes by any RPG developer. These Opcodes are used to read a record from file. So, What's the difference between CHAIN & READ?   CHAIN operation retrieves a record based on the Key specified. It's more like Retrieving Random record from a Database file based on the Key fields.  READ operation reads the record currently pointed to from a Database file. There are multiple Opcodes that start with READ and all are used to read a record but with slight difference. We will see more about different Opcodes and How they are different from each other (and CHAIN) in another article. Few differences to note.  CHAIN requires Key fields to read a record where as READ would read the record currently pointed to (SETLL or SETGT are used to point a Record).  If there are multiple records with the same Key data, CHAIN would return the same record every time. READE can be used to read all the records with the specified Ke

Extract a portion of a Date/Time/Timestamp in RPGLE - IBM i

%SUBDT Extracting Year, Month, Day, Hour, Minutes, Seconds or Milli seconds of a given Date/Time/Timestamp is required most of the times.  This can be extracted easily by using %SUBDT. BIF name looks more similar to %SUBST which is used to extract a portion of string by passing from and two positions of the original string. Instead, We would need to pass a value (i.e., Date, Time or Timestamp ) and Unit (i.e., *YEARS, *MONTHS, *DAYS, *HOURS, *MINUTES, *SECONDS or *MSECONDS) to %SUBDT.  Valid unit should be passed for the type of the value passed. Below are the valid values for each type. Date - *DAYS, *MONTHS, *YEARS Time - *HOURS, *MINUTES, *SECONDS Timestamp - *DAYS, *MONTHS, *YEARS, *HOURS, *MINUTES, *SECONDS, *MSECONDS Syntax: %SUBDT(value : unit { : digits { : decpos} }) Value and Unit are the mandatory arguments.  Digits and Decimal positions are optional and can only be used with *SECONDS for Timestamp. We can either pass the full form for the unit or use the short form. Below i