TechTip: Compress Large Object (LOB) Data in DB2 for i

  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

Implement these user-defined functions to save space when storing large amounts of data.


In modern applications, it's typical to store large amounts of text data, including emails, rich text documents, audit logs, and XML. Recording this information in a database table can impose a significant tax on disk space. However, using a compression algorithm can alleviate this tax. In this tip, I'll demonstrate two user-defined functions that implement ZLib compression to deflate and inflate data that is stored or accessed via DB2 as a large object data type (BLOB, CLOB, and XML).

Why Compress Data?

Many software vendors have implemented compression for storage and sometimes performance reasons. Multimedia files often involve large data that can be a problem to store and render. Familiar examples of multimedia compression include JPEG images, mp3 audio files, and mp4 video files. However, these compression schemes often "lose" information and therefore degrade the quality, a tradeoff that the industry has found acceptable.


For a different example, since the release of Office 2007, Microsoft has used the Office Open XML document format, which includes zipping and placing multiple XML files within a single XLSX, DOCX, PPTX, etc. file. In other words, Microsoft uses compression as a means of storing large XML documents in a smaller space. Unlike multimedia compression, data loss isn't acceptable with business documents, so a "lossless" algorithm is used to compress the data. Zlib is one such lossless compression algorithm, meaning that after being compressed and uncompressed, the data is restored to its exact original form.


Similarly, DB2 can take advantage of compression to reduce file size and perhaps in some cases, improve performance. The aim of this article presents two user-defined DB2 for i functions called DEFLATE and INFLATE that are built to "crunch" and "uncrunch" large data columns and variables.


Examples of how to use them in an embedded SQL environment are shown here (where host variable CompressXML is a BLOB and XmlDoc is a CLOB/XML):


-- Compress XML document from variable XmlDoc

Exec SQL


INTO :CompressedXML



-- Decompress XML document


SET :XmlDoc=INFLATE_XML(:CompressedXML);

Which Compression Algorithm Do I Use?

There are many compression algorithms available on the Internet. On the IBM i, I figured C/C++ would perform better than Java, so I sought a C/C++ compression library. For this demonstration, I chose an open-source project called miniz, a relatively small C/C++ library that implements "the zlib and Deflate compressed data format specification standards."


My decision to use miniz was based on free availability, compression speed, ability to handle in-memory data, source code size, format popularity, and support/compatibility with other languages/platforms (including .NET and Java). Most of all, my choice for miniz was based on the ease of understanding the C/C++ code (which I'm not very good at) that I would need to integrate with DB2. Out of all the free code I came across on the Internet, miniz was relatively simple for a non C/C++ guy like myself.


Attached here is the C++ code for service program mzlibsql.cpp I'm not a C++ programmer by trade, so as usual, I hobbled together my code using examples found on the web. (Feel free to forward any suggested improvements.)


To give DB2 compression capability, I had to combine two concepts: processing in-memory data streams in chunks (found in the miniz code Example #3) and implementing DB2 large object (LOB) locator parameter support. The primary reason for using a locator is memory management when compressing a wide range of data sizes. There are only two public methods meant for use by DB2 in this code: zlib_inflate and zlib_deflate.


The instructions for creating the service program from the attached source code may be summarized as follows:

  • Download the miniz source code and extract the miniz.c source file and place it in your C/C++ source folder on the IFS (although the sample compile statement uses the IFS, it can be alternatively placed in a source member). For this project, I downloaded the latest version available: v1.14.
  • Download the attached source file mzlibsql.cpp and place it in the same IFS folder as miniz.
  • Create the C++ module (CRTCPPMOD) and service program (CRTSRVPGM). Don't forget to replace your source folder or member names.


Once the service program has been created, the next step is to tell DB2 for i how to use the C++ service program by creating external user-defined function wrappers. These CREATE FUNCTION SQL statements are in the source header. (For an introduction to writing external user-defined functions using RPG, see Reuse Your RPG Code with SQL User-Defined Functions. The concepts are applicable to C and C++.


In the sample code, I've included six CREATE FUNCTION definitions. Three of them are called DEFLATE, and they accept a BLOB, CLOB, or XML parameter. The remaining three are called INFLATE (for BLOBs), INFLATE_CLOB, and INFLATE_XML. Use the DEFLATE function regardless of the LOB data type. However, use the correct "INFLATE" function to get the data back in its original format. All these functions use the same C++ code; the only difference among them is how DB2 interprets the data it's exchanging with the function.


Note that DBCS (DBCLOB and NCLOB) data is supported by the DEFLATE function because DB2 can CAST these types to binary. However, because DB2 does not support the CAST of binary data back to DBCS (without writing a helper function), the ability to INFLATE double-byte data is currently unsupported.


I tested this code on a machine running IBM i 7.1, but it should also run on V5R4 and IBM i 6.1 (except for the XML versions of the functions).

How Well Does the Compression Work?

With the compression level set to 10 (max compression, slowest speed), for a simple example, 32000 spaces are compressed to just 54 bytes:

-- Returns 54



Since you're not likely to squish a bunch of blanks in production, I saved a long MC Press article (Rev Up "i" Reporting with SQL Server 2008 Reporting Services) as an HTML file on the IFS to the tune of 249KB. The compressed file size is only about 35K and the statement took about ½ second to complete.



-- Demo requires IBM i 7.1 (GET_BLOB_FROM__FILE function)





-- Returns 254666 and 35792





For another example, I had a DB2 group PTF binary file sitting on the IFS in the /tmp folder. This file is about ½GB. If I had to store this kind of file in an application, I could crunch it and save about 30% in space, although it took 6.75 minutes on my virtualized test machine to deflate it (again the compression level was set to 10, which is max compression but minimal speed):



-- Demo requires IBM i 7.1 (GET_BLOB_FROM__FILE function)





-- Returned 540252160 and 382534049 in 6.75 minutes



So, how much "bang for your buck" comes from compression depends on the data itself. Text and XML usually yield a sizable storage savings. Binary data is difficult to predict. Other document formats, such as PDFs, already store some of their elements, such as images, compressed (using zlib compression oddly enough), so large PDFs may not compress very well if their size is due to image content.

Notes for Application Development

When using compression in applications, keep in mind the following:

  • Compression doesn't work well with modern media formats (e.g., jpeg images, mp3 audio, and mp4 video) because the data is already compressed.
  • Because compressed data isn't easy to sift through, key information from the data should be saved in standard database table columns. If you're crunching XML, it often makes sense to extract important info (customer number, customer job,
    quote id, etc.) that can be saved as normal columnar data to aid the search and retrieval of the compressed data.
  • Don't save needless information just because it will now fit! As always, be careful when deciding what an application will store.
  • Beware the CPU overhead of compressing and decompressing files. If your CPU is currently taxed with the existing application load, compression may put it over the edge. Also, you may need to establish a minimum size threshold (say 1MB for XML) before deciding saving space with compression is worth the effort. It's also worth considering whether to leave current data uncompressed while compressing historical data.
  • When working with very large objects, remember that memory consumption becomes a major concern. Often, using LOB locators (similar to pointers) in your functions and procedures can potentially save DB2 from creating unnecessary copies of the data.
  • Don't make the mistake of dumping a zipped LOB to an IFS file with a zip extension and then expecting the file to work with your favorite desktop zip tool. While the file data is compressed, it's just a memory stream and doesn't include all the file information that is required to work with a normal zip utility.
  • Review the miniz notes because there are several suggestions on how to tune the functions for performance, depending on the size and type of data being compressed. For example, look for the variable called "level." This is the compression level, and it accepts a value from 0 (max speed) to 10 (max compression.) In the sample code, this value is set to 6, which is a balance between compression speed and size optimization. Adjust this value as needed for your application. When I reset the compression "level" in code to be a 5 (balance of speed vs. compression), the ½GB compression time was reduced to about 2 ½ minutes, and the resulting file wasn't significantly bigger than when using level 10 (max compression).
  • Manipulating large object values requires an active transaction. This can be a problem when working with legacy tables that are not journaled. One way to overcome this problem is to specify the "WITH NC" hint on the SQL statement:




VALUES (1,1,'/tmp/Rev Up i Reporting.htm',SQL.DEFLATE(QSYS2.GET_BLOB_FROM_FILE('/tmp/Rev Up i Reporting.htm')))

WITH NC; -- Allows an insert without active journaling


In the past, many applications have been limited because it was not feasible to record large amounts of information. Compressing data (especially text) allows you to design applications that record and retrieve large amounts of data. Implementing compression functionality in your database is similar to what many other vendors have already done. This tip has demonstrated how a data compression algorithm can be used to reduce the storage requirements for LOB data.


Michael Sansoterra is a DBA for Broadway Systems in Grand Rapids, Michigan. He can be contacted at



Support MC Press Online





  • White Paper: Node.js for Enterprise IBM i Modernization

    SB Profound WP 5539

    If your business is thinking about modernizing your legacy IBM i (also known as AS/400 or iSeries) applications, you will want to read this white paper first!

    Download this paper and learn how Node.js can ensure that you:
    - Modernize on-time and budget - no more lengthy, costly, disruptive app rewrites!
    - Retain your IBM i systems of record
    - Find and hire new development talent
    - Integrate new Node.js applications with your existing RPG, Java, .Net, and PHP apps
    - Extend your IBM i capabilties to include Watson API, Cloud, and Internet of Things

    Read Node.js for Enterprise IBM i Modernization Now!


  • Profound Logic Solution Guide

    SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation.
    Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects.
    The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the companyare not aligned with the current IT environment.

    Get your copy of this important guide today!


  • 2022 IBM i Marketplace Survey Results

    Fortra2022 marks the eighth edition of the IBM i Marketplace Survey Results. Each year, Fortra captures data on how businesses use the IBM i platform and the IT and cybersecurity initiatives it supports.

    Over the years, this survey has become a true industry benchmark, revealing to readers the trends that are shaping and driving the market and providing insight into what the future may bring for this technology.

  • Brunswick bowls a perfect 300 with LANSA!

    FortraBrunswick is the leader in bowling products, services, and industry expertise for the development and renovation of new and existing bowling centers and mixed-use recreation facilities across the entertainment industry. However, the lifeblood of Brunswick’s capital equipment business was running on a 15-year-old software application written in Visual Basic 6 (VB6) with a SQL Server back-end. The application was at the end of its life and needed to be replaced.
    With the help of Visual LANSA, they found an easy-to-use, long-term platform that enabled their team to collaborate, innovate, and integrate with existing systems and databases within a single platform.
    Read the case study to learn how they achieved success and increased the speed of development by 30% with Visual LANSA.


  • Progressive Web Apps: Create a Universal Experience Across All Devices

    LANSAProgressive Web Apps allow you to reach anyone, anywhere, and on any device with a single unified codebase. This means that your applications—regardless of browser, device, or platform—instantly become more reliable and consistent. They are the present and future of application development, and more and more businesses are catching on.
    Download this whitepaper and learn:

    • How PWAs support fast application development and streamline DevOps
    • How to give your business a competitive edge using PWAs
    • What makes progressive web apps so versatile, both online and offline



  • The Power of Coding in a Low-Code Solution

    LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed.
    Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

    • Discover the benefits of Low-code's quick application creation
    • Understand the differences in model-based and language-based Low-Code platforms
    • Explore the strengths of LANSA's Low-Code Solution to Low-Code’s biggest drawbacks



  • Why Migrate When You Can Modernize?

    LANSABusiness users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.
    In this white paper, you’ll learn how to think of these issues as opportunities rather than problems. We’ll explore motivations to migrate or modernize, their risks and considerations you should be aware of before embarking on a (migration or modernization) project.
    Lastly, we’ll discuss how modernizing IBM i applications with optimized business workflows, integration with other technologies and new mobile and web user interfaces will enable IT – and the business – to experience time-added value and much more.


  • UPDATED: Developer Kit: Making a Business Case for Modernization and Beyond

    Profound Logic Software, Inc.Having trouble getting management approval for modernization projects? The problem may be you're not speaking enough "business" to them.

    This Developer Kit provides you study-backed data and a ready-to-use business case template to help get your very next development project approved!

  • What to Do When Your AS/400 Talent Retires

    FortraIT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators is small.

    This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn:

    • Why IBM i skills depletion is a top concern
    • How leading organizations are coping
    • Where automation will make the biggest impact


  • Node.js on IBM i Webinar Series Pt. 2: Setting Up Your Development Tools

    Profound Logic Software, Inc.Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. In Part 2, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Attend this webinar to learn:

    • Different tools to develop Node.js applications on IBM i
    • Debugging Node.js
    • The basics of Git and tools to help those new to it
    • Using as a pre-built development environment



  • Expert Tips for IBM i Security: Beyond the Basics

    SB PowerTech WC GenericIn this session, IBM i security expert Robin Tatam provides a quick recap of IBM i security basics and guides you through some advanced cybersecurity techniques that can help you take data protection to the next level. Robin will cover:

    • Reducing the risk posed by special authorities
    • Establishing object-level security
    • Overseeing user actions and data access

    Don't miss this chance to take your knowledge of IBM i security beyond the basics.



  • 5 IBM i Security Quick Wins

    SB PowerTech WC GenericIn today’s threat landscape, upper management is laser-focused on cybersecurity. You need to make progress in securing your systems—and make it fast.
    There’s no shortage of actions you could take, but what tactics will actually deliver the results you need? And how can you find a security strategy that fits your budget and time constraints?
    Join top IBM i security expert Robin Tatam as he outlines the five fastest and most impactful changes you can make to strengthen IBM i security this year.
    Your system didn’t become unsecure overnight and you won’t be able to turn it around overnight either. But quick wins are possible with IBM i security, and Robin Tatam will show you how to achieve them.

  • Security Bulletin: Malware Infection Discovered on IBM i Server!

    SB PowerTech WC GenericMalicious programs can bring entire businesses to their knees—and IBM i shops are not immune. It’s critical to grasp the true impact malware can have on IBM i and the network that connects to it. Attend this webinar to gain a thorough understanding of the relationships between:

    • Viruses, native objects, and the integrated file system (IFS)
    • Power Systems and Windows-based viruses and malware
    • PC-based anti-virus scanning versus native IBM i scanning

    There are a number of ways you can minimize your exposure to viruses. IBM i security expert Sandi Moore explains the facts, including how to ensure you're fully protected and compliant with regulations such as PCI.



  • Encryption on IBM i Simplified

    SB PowerTech WC GenericDB2 Field Procedures (FieldProcs) were introduced in IBM i 7.1 and have greatly simplified encryption, often without requiring any application changes. Now you can quickly encrypt sensitive data on the IBM i including PII, PCI, PHI data in your physical files and tables.
    Watch this webinar to learn how you can quickly implement encryption on the IBM i. During the webinar, security expert Robin Tatam will show you how to:

    • Use Field Procedures to automate encryption and decryption
    • Restrict and mask field level access by user or group
    • Meet compliance requirements with effective key management and audit trails


  • Lessons Learned from IBM i Cyber Attacks

    SB PowerTech WC GenericDespite the many options IBM has provided to protect your systems and data, many organizations still struggle to apply appropriate security controls.
    In this webinar, you'll get insight into how the criminals accessed these systems, the fallout from these attacks, and how the incidents could have been avoided by following security best practices.

    • Learn which security gaps cyber criminals love most
    • Find out how other IBM i organizations have fallen victim
    • Get the details on policies and processes you can implement to protect your organization, even when staff works from home

    You will learn the steps you can take to avoid the mistakes made in these examples, as well as other inadequate and misconfigured settings that put businesses at risk.



  • The Power of Coding in a Low-Code Solution

    SB PowerTech WC GenericWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed.
    Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

    • Discover the benefits of Low-code's quick application creation
    • Understand the differences in model-based and language-based Low-Code platforms
    • Explore the strengths of LANSA's Low-Code Solution to Low-Code’s biggest drawbacks



  • Node Webinar Series Pt. 1: The World of Node.js on IBM i

    SB Profound WC GenericHave you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.
    Part 1 will teach you what Node.js is, why it's a great option for IBM i shops, and how to take advantage of the ecosystem surrounding Node.
    In addition to background information, our Director of Product Development Scott Klement will demonstrate applications that take advantage of the Node Package Manager (npm).
    Watch Now.

  • The Biggest Mistakes in IBM i Security

    SB Profound WC Generic The Biggest Mistakes in IBM i Security
    Here’s the harsh reality: cybersecurity pros have to get their jobs right every single day, while an attacker only has to succeed once to do incredible damage.
    Whether that’s thousands of exposed records, millions of dollars in fines and legal fees, or diminished share value, it’s easy to judge organizations that fall victim. IBM i enjoys an enviable reputation for security, but no system is impervious to mistakes.
    Join this webinar to learn about the biggest errors made when securing a Power Systems server.
    This knowledge is critical for ensuring integrity of your application data and preventing you from becoming the next Equifax. It’s also essential for complying with all formal regulations, including SOX, PCI, GDPR, and HIPAA
    Watch Now.

  • Comply in 5! Well, actually UNDER 5 minutes!!

    SB CYBRA PPL 5382

    TRY the one package that solves all your document design and printing challenges on all your platforms.

    Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product.

    Request your trial now!

  • Backup and Recovery on IBM i: Your Strategy for the Unexpected

    FortraRobot automates the routine tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:
    - Simplified backup procedures
    - Easy data encryption
    - Save media management
    - Guided restoration
    - Seamless product integration
    Make sure your data survives when catastrophe hits. Try the Robot Backup and Recovery Solution FREE for 30 days.

  • Manage IBM i Messages by Exception with Robot

    SB HelpSystems SC 5413Managing messages on your IBM i can be more than a full-time job if you have to do it manually. How can you be sure you won’t miss important system events?
    Automate your message center with the Robot Message Management Solution. Key features include:
    - Automated message management
    - Tailored notifications and automatic escalation
    - System-wide control of your IBM i partitions
    - Two-way system notifications from your mobile device
    - Seamless product integration
    Try the Robot Message Management Solution FREE for 30 days.

  • Easiest Way to Save Money? Stop Printing IBM i Reports

    FortraRobot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing.
    Manage your reports with the Robot Report Management Solution. Key features include:

    - Automated report distribution
    - View online without delay
    - Browser interface to make notes
    - Custom retention capabilities
    - Seamless product integration
    Rerun another report? Never again. Try the Robot Report Management Solution FREE for 30 days.

  • Hassle-Free IBM i Operations around the Clock

    SB HelpSystems SC 5413For over 30 years, Robot has been a leader in systems management for IBM i.
    Manage your job schedule with the Robot Job Scheduling Solution. Key features include:
    - Automated batch, interactive, and cross-platform scheduling
    - Event-driven dependency processing
    - Centralized monitoring and reporting
    - Audit log and ready-to-use reports
    - Seamless product integration
    Scale your software, not your staff. Try the Robot Job Scheduling Solution FREE for 30 days.