---
product: Chilkat
product_version: 11.7.0
language: sqlserver
language_label: SQL Server
class: Compression
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/sqlserver_CompressionRef.html
---
# Chilkat Compression — SQL Server — v11.7.0

> Chilkat 11.7.0 · language=sqlserver · class=Compression
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Compression.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/guide.md`.

## Purpose

**Compress and decompress bytes, text, files, and streams with a flexible API.**

`Chilkat.Compression` provides a general-purpose API for compressing and decompressing data in memory, files, and streams. It supports multiple algorithms, text charset conversion, encoded output, chunked processing, and streaming operations for large data.

**Multiple algorithms**

Supports `deflate`, `zlib`, `bzip2`, and `lzw`.

**Flexible data types**

Work with byte arrays, strings, `BinData`, `StringBuilder`, files, and streams.

**Chunked processing**

Process data incrementally with `FirstChunk` and `LastChunk` for chunk-aware methods.

**Encoded output**

Return compressed bytes as text using encodings such as `base64`, `hex`, and others.

**Streaming support**

Compress or decompress large files and streams with stable memory usage.

**Compression + encryption**

Combine compression and encryption in file workflows with integrated methods.

**Tip:** For text compression, explicitly set `Charset = "utf-8"` unless another encoding is required. For encoded compressed data, set `EncodingMode` to the desired output format.

For an extended overview, see [Compression Class Overview](https://www.chilkatsoft.com/compression_class_overview.asp). See also [Binary Encodings](https://www.chilkatsoft.com/binary_encodings.asp) for supported encoded output formats.

## Object creation, unlocking and error handling

**Object Creation**

```sql
DECLARE @hr int
DECLARE @compression int
EXEC @hr = sp_OACreate 'Chilkat.Compression', @compression OUT
IF @hr <> 0
BEGIN
    PRINT 'Failed to create ActiveX component'
    RETURN
END

-- ... use @compression ...

EXEC @hr = sp_OADestroy @compression
```

T-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (`EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;`), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `sp_OACreate 'Chilkat.Compression.11'` for Chilkat v11.\*.\*.

`sp_OACreate` returns an object token (an `int`) that is passed as the first argument of every `sp_OAMethod`, `sp_OAGetProperty` and `sp_OASetProperty` call, and released with `sp_OADestroy`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also tokens received through an `int` OUT parameter; they must likewise be destroyed, and the OUT parameter is `NULL` when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero `@hr`), `sp_OAGetErrorInfo` describes the error.

Data types: strings are `nvarchar(4000)`; integers, booleans (1 or 0) and object tokens are `int`; dates are `datetime`. In the signatures on this page, `@success`, `@iResult`, `@sResult` and the like are the OUT variables receiving a method's return value, `@iValue` / `@sValue` receive or supply a property value, and the remaining `@` variables are the method's arguments in order.

A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example `DECLARE @tmp TABLE (outputLine ntext)` followed by `INSERT INTO @tmp EXEC sp_OAGetProperty @compression, 'LastErrorText'`. See [string length limitations for strings returned by sp_OAMethod calls](https://www.chilkatsoft.com/sql_server_nvarchar_max_limitation.asp).

Methods that pass or return raw byte arrays are not shown on this page, because `varbinary(max)` values cannot be exchanged through `sp_OAMethod` (see [varbinary(max) limitation](https://www.chilkatsoft.com/sql_server_varbinary_max_limitation.asp)). Use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead. Binary *properties* (such as `LastBinaryResult`) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*\*Async*) methods and event callbacks are not available from SQL Server.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in SQL Server.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `EXEC sp_OAGetProperty @compression, 'DebugLogFilePath', @sValue OUT EXEC sp_OASetProperty @compression, 'DebugLogFilePath', @sValue` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `INSERT INTO @tmp EXEC sp_OAGetProperty @compression, 'LastBinaryResult'` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `EXEC sp_OAGetProperty @compression, 'LastErrorHtml', @sValue OUT` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `EXEC sp_OAGetProperty @compression, 'LastErrorText', @sValue OUT` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `EXEC sp_OAGetProperty @compression, 'LastErrorXml', @sValue OUT` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `EXEC sp_OAGetProperty @compression, 'LastMethodSuccess', @iValue OUT EXEC sp_OASetProperty @compression, 'LastMethodSuccess', @iValue` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `EXEC sp_OAGetProperty @compression, 'LastStringResult', @sValue OUT` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `EXEC sp_OAGetProperty @compression, 'LastStringResultLen', @iValue OUT` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `EXEC sp_OAGetProperty @compression, 'VerboseLogging', @iValue OUT EXEC sp_OASetProperty @compression, 'VerboseLogging', @iValue` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `EXEC sp_OAGetProperty @compression, 'Version', @sValue OUT` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Algorithm` | property, read/write | `EXEC sp_OAGetProperty @compression, 'Algorithm', @sValue OUT EXEC sp_OASetProperty @compression, 'Algorithm', @sValue` |
| `Charset` | property, read/write | `EXEC sp_OAGetProperty @compression, 'Charset', @sValue OUT EXEC sp_OASetProperty @compression, 'Charset', @sValue` |
| `DeflateLevel` | property, read/write | `EXEC sp_OAGetProperty @compression, 'DeflateLevel', @iValue OUT EXEC sp_OASetProperty @compression, 'DeflateLevel', @iValue` |
| `EncodingMode` | property, read/write | `EXEC sp_OAGetProperty @compression, 'EncodingMode', @sValue OUT EXEC sp_OASetProperty @compression, 'EncodingMode', @sValue` |
| `FirstChunk` | property, read/write | `EXEC sp_OAGetProperty @compression, 'FirstChunk', @iValue OUT EXEC sp_OASetProperty @compression, 'FirstChunk', @iValue` |
| `LastChunk` | property, read/write | `EXEC sp_OAGetProperty @compression, 'LastChunk', @iValue OUT EXEC sp_OASetProperty @compression, 'LastChunk', @iValue` |
| `UncommonOptions` | property, read/write | `EXEC sp_OAGetProperty @compression, 'UncommonOptions', @sValue OUT EXEC sp_OASetProperty @compression, 'UncommonOptions', @sValue` |
| `CompressBd` | method | `EXEC sp_OAMethod @compression, 'CompressBd', @success OUT, @bd` |
| `CompressBd2` | method | `EXEC sp_OAMethod @compression, 'CompressBd2', @success OUT, @bdIn, @bdOut` |
| `CompressEncryptFile` | method | `EXEC sp_OAMethod @compression, 'CompressEncryptFile', @success OUT, @cryptParams, @srcPath, @destPath` |
| `CompressFile` | method | `EXEC sp_OAMethod @compression, 'CompressFile', @success OUT, @srcPath, @destPath` |
| `CompressSb` | method | `EXEC sp_OAMethod @compression, 'CompressSb', @success OUT, @sb, @binData` |
| `CompressStr` | method | `EXEC sp_OAMethod @compression, 'CompressStr', @success OUT, @str, @bd` |
| `CompressStream` | method | `EXEC sp_OAMethod @compression, 'CompressStream', @success OUT, @strm` |
| `CompressStringENC` | method | `EXEC sp_OAMethod @compression, 'CompressStringENC', @sResult OUT, @str` |
| `DecompressBd` | method | `EXEC sp_OAMethod @compression, 'DecompressBd', @success OUT, @bd` |
| `DecompressBd2` | method | `EXEC sp_OAMethod @compression, 'DecompressBd2', @success OUT, @bdIn, @bdOut` |
| `DecompressFile` | method | `EXEC sp_OAMethod @compression, 'DecompressFile', @success OUT, @srcPath, @destPath` |
| `DecompressSb` | method | `EXEC sp_OAMethod @compression, 'DecompressSb', @success OUT, @binData, @sb` |
| `DecompressStream` | method | `EXEC sp_OAMethod @compression, 'DecompressStream', @success OUT, @strm` |
| `DecompressStringENC` | method | `EXEC sp_OAMethod @compression, 'DecompressStringENC', @sResult OUT, @encodedCompressedData` |
| `DecryptDecompressFile` | method | `EXEC sp_OAMethod @compression, 'DecryptDecompressFile', @success OUT, @cryptParams, @srcPath, @destPath` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### Compression.Algorithm

`Chilkat 11.7.0 · sqlserver · Compression · Algorithm · property · read/write`

```sql
EXEC sp_OAGetProperty @compression, 'Algorithm', @sValue OUT
EXEC sp_OASetProperty @compression, 'Algorithm', @sValue
```

Specifies the compression algorithm to use. Supported values are `deflate`, `zlib`, `gzip`, `bzip2`, and `lzw`.

The `zlib` option is the deflate algorithm with a zlib header.

The `gzip` option (starting in v11.7.0) is the deflate algorithm in the gzip format (RFC 1952): a gzip header, the deflate data, and a trailer with the CRC-32 and size of the uncompressed data. When decompressing in one call, the CRC-32 and size are checked. Before v11.7.0, `gzip` was not recognized and was treated as `deflate`.

**Note:** `ppmd` is deprecated and should not be used. It was only available on 32-bit systems and specifically used the J variant. New applications should use one of the supported algorithms listed above.

### Compression.Charset

`Chilkat 11.7.0 · sqlserver · Compression · Charset · property · read/write`

```sql
EXEC sp_OAGetProperty @compression, 'Charset', @sValue OUT
EXEC sp_OASetProperty @compression, 'Charset', @sValue
```

**Full documentation for this property (same in every language):** [How Character Encoding (Charset) Affects Compression and Decompression](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/how_charset_affects_compression.md) · [Full List of Character Encodings Supported by Chilkat](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

Specifies the character encoding used when converting text to bytes before compression, and bytes back to text after decompression.

The current default is the computer’s ANSI charset, such as Windows-1252 on many Western Windows systems. However, most modern applications should explicitly set this property to `utf-8`.

**Recommendation:** Set `Charset = "utf-8"` unless you specifically need compatibility with another encoding.

### Compression.DeflateLevel

`Chilkat 11.7.0 · sqlserver · Compression · DeflateLevel · property · read/write · since 9.5.0.73`

```sql
EXEC sp_OAGetProperty @compression, 'DeflateLevel', @iValue OUT
EXEC sp_OASetProperty @compression, 'DeflateLevel', @iValue
```

Sets the compression level used by the `deflate` and `zlib` algorithms.

- `0` means no compression.
- `9` means maximum compression.
- The default value is `6`.

Higher values may produce smaller output but can require more processing time.

### Compression.EncodingMode

`Chilkat 11.7.0 · sqlserver · Compression · EncodingMode · property · read/write`

```sql
EXEC sp_OAGetProperty @compression, 'EncodingMode', @sValue OUT
EXEC sp_OASetProperty @compression, 'EncodingMode', @sValue
```

**Full documentation for this property (same in every language):** [Binary Encodings Supported by Chilkat](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

Specifies the text encoding used by methods whose names end in `ENC`, such as `CompressBytesENC` and `DecompressStringENC`.

Compression methods ending in `ENC` return compressed binary data as an encoded string. Decompression methods ending in `ENC` expect the input string to use this same encoding.

Valid values include:

- `base64`
- `hex`
- `url`
- `quoted-printable`

### Compression.FirstChunk

`Chilkat 11.7.0 · sqlserver · Compression · FirstChunk · property · read/write · since 11.0.0`

```sql
EXEC sp_OAGetProperty @compression, 'FirstChunk', @iValue OUT
EXEC sp_OASetProperty @compression, 'FirstChunk', @iValue
```

Indicates that the next chunk-aware compression or decompression call is the first chunk in a sequence.

The default value is `1`.

When both `FirstChunk` and `LastChunk` are `1`, the method call is treated as a complete, single-call compression or decompression operation.

### Compression.LastChunk

`Chilkat 11.7.0 · sqlserver · Compression · LastChunk · property · read/write · since 11.0.0`

```sql
EXEC sp_OAGetProperty @compression, 'LastChunk', @iValue OUT
EXEC sp_OASetProperty @compression, 'LastChunk', @iValue
```

Indicates that the next chunk-aware compression or decompression call is the final chunk in a sequence.

The default value is `1`.

When both `FirstChunk` and `LastChunk` are `1`, the input is treated as the complete data set and processed in a single call.

### Compression.UncommonOptions

`Chilkat 11.7.0 · sqlserver · Compression · UncommonOptions · property · read/write · since 11.0.0`

```sql
EXEC sp_OAGetProperty @compression, 'UncommonOptions', @sValue OUT
EXEC sp_OASetProperty @compression, 'UncommonOptions', @sValue
```

Provides a way to enable specialized or uncommon behavior. This property normally remains empty.

It may be set to a comma-separated list of keywords.

Supported option:

- `Crypt2CompressHdr` — Duplicates the compression/decompression header behavior used by the deprecated and removed Crypt2 compression functions.

## Methods

### Compression.CompressBd

`Chilkat 11.7.0 · sqlserver · Compression · CompressBd · method · since 9.5.0.66`

```sql
EXEC sp_OAMethod @compression, 'CompressBd', @success OUT, @bd
```

Compresses the data contained in a `BinData` object.

The `BinData` object is modified to contain the compressed result.

This method is not `FirstChunk` / `LastChunk` aware.

Returns 1 for success, 0 for failure.

### Compression.CompressBd2

`Chilkat 11.7.0 · sqlserver · Compression · CompressBd2 · method · since 11.0.0`

```sql
EXEC sp_OAMethod @compression, 'CompressBd2', @success OUT, @bdIn, @bdOut
```

Compresses the data in one `BinData` object and appends the compressed output to another `BinData` object.

The input `BinData` is not modified.

This method is `FirstChunk` / `LastChunk` aware.

Returns 1 for success, 0 for failure.

### Compression.CompressEncryptFile

`Chilkat 11.7.0 · sqlserver · Compression · CompressEncryptFile · method · since 9.5.0.99`

```sql
EXEC sp_OAMethod @compression, 'CompressEncryptFile', @success OUT, @cryptParams, @srcPath, @destPath
```

Compresses and encrypts a file, writing the result to a destination file.

The compression and encryption are performed internally in streaming mode, so files of any size can be processed without loading the entire file into memory.

Returns 1 for success, 0 for failure.

### Compression.CompressFile

`Chilkat 11.7.0 · sqlserver · Compression · CompressFile · method`

```sql
EXEC sp_OAMethod @compression, 'CompressFile', @success OUT, @srcPath, @destPath
```

Compresses a source file and writes the compressed data to a destination file.

The file is processed internally in streaming mode, allowing files of any size to be compressed with stable memory usage.

Returns 1 for success, 0 for failure.

### Compression.CompressSb

`Chilkat 11.7.0 · sqlserver · Compression · CompressSb · method · since 9.5.0.73`

```sql
EXEC sp_OAMethod @compression, 'CompressSb', @success OUT, @sb, @binData
```

Compresses the text contained in a `StringBuilder` and appends the compressed bytes to a `BinData` object.

Text is converted to bytes according to the `Charset` property.

This method is `FirstChunk` / `LastChunk` aware.

Returns 1 for success, 0 for failure.

### Compression.CompressStr

`Chilkat 11.7.0 · sqlserver · Compression · CompressStr · method · since 11.0.0`

```sql
EXEC sp_OAMethod @compression, 'CompressStr', @success OUT, @str, @bd
```

Compresses a string and appends the compressed bytes to a `BinData` object.

The string is converted to bytes using the charset specified by the `Charset` property.

This method is `FirstChunk` / `LastChunk` aware.

Returns 1 for success, 0 for failure.

### Compression.CompressStream

`Chilkat 11.7.0 · sqlserver · Compression · CompressStream · method · since 9.5.0.56`

```sql
EXEC sp_OAMethod @compression, 'CompressStream', @success OUT, @strm
```

Compresses data from a stream source and writes the compressed data to the stream sink.

The operation is performed in streaming mode, making it suitable for very large or even continuous streams while maintaining stable memory usage.

Returns 1 for success, 0 for failure.

### Compression.CompressStringENC

`Chilkat 11.7.0 · sqlserver · Compression · CompressStringENC · method`

```sql
EXEC sp_OAMethod @compression, 'CompressStringENC', @sResult OUT, @str
```

Compresses a string and returns the compressed result as an encoded string.

The string is first converted to bytes using `Charset`, then compressed, and finally encoded according to `EncodingMode`.

This method is not `FirstChunk` / `LastChunk` aware.

Returns `NULL` on failure

### Compression.DecompressBd

`Chilkat 11.7.0 · sqlserver · Compression · DecompressBd · method · since 9.5.0.66`

```sql
EXEC sp_OAMethod @compression, 'DecompressBd', @success OUT, @bd
```

Decompresses the compressed data contained in a `BinData` object.

The `BinData` object is modified to contain the decompressed result.

This method is not `FirstChunk` / `LastChunk` aware.

Returns 1 for success, 0 for failure.

### Compression.DecompressBd2

`Chilkat 11.7.0 · sqlserver · Compression · DecompressBd2 · method · since 11.0.0`

```sql
EXEC sp_OAMethod @compression, 'DecompressBd2', @success OUT, @bdIn, @bdOut
```

Decompresses the data in one `BinData` object and appends the decompressed output to another `BinData` object.

The input `BinData` is not modified.

This method is `FirstChunk` / `LastChunk` aware.

Returns 1 for success, 0 for failure.

### Compression.DecompressFile

`Chilkat 11.7.0 · sqlserver · Compression · DecompressFile · method`

```sql
EXEC sp_OAMethod @compression, 'DecompressFile', @success OUT, @srcPath, @destPath
```

Decompresses a source file and writes the decompressed data to a destination file.

The file is processed internally in streaming mode, allowing files of any size to be decompressed without loading the entire file into memory.

Returns 1 for success, 0 for failure.

### Compression.DecompressSb

`Chilkat 11.7.0 · sqlserver · Compression · DecompressSb · method · since 9.5.0.73`

```sql
EXEC sp_OAMethod @compression, 'DecompressSb', @success OUT, @binData, @sb
```

Decompresses compressed data from a `BinData` object and appends the resulting text to a `StringBuilder`.

The decompressed bytes are converted to text using the `Charset` property.

This method is `FirstChunk` / `LastChunk` aware.

Returns 1 for success, 0 for failure.

### Compression.DecompressStream

`Chilkat 11.7.0 · sqlserver · Compression · DecompressStream · method · since 9.5.0.56`

```sql
EXEC sp_OAMethod @compression, 'DecompressStream', @success OUT, @strm
```

Decompresses data from a stream source and writes the decompressed data to the stream sink.

The operation is performed in streaming mode, making it suitable for very large or continuous streams while maintaining stable memory usage.

Returns 1 for success, 0 for failure.

### Compression.DecompressStringENC

`Chilkat 11.7.0 · sqlserver · Compression · DecompressStringENC · method`

```sql
EXEC sp_OAMethod @compression, 'DecompressStringENC', @sResult OUT, @encodedCompressedData
```

Decompresses compressed data supplied as an encoded string and returns the resulting text.

The input string is decoded according to `EncodingMode`, then decompressed. The resulting bytes are converted to text using `Charset`.

This method is not `FirstChunk` / `LastChunk` aware.

Returns `NULL` on failure

### Compression.DecryptDecompressFile

`Chilkat 11.7.0 · sqlserver · Compression · DecryptDecompressFile · method · since 9.5.0.99`

```sql
EXEC sp_OAMethod @compression, 'DecryptDecompressFile', @success OUT, @cryptParams, @srcPath, @destPath
```

Decrypts and decompresses a file, writing the restored data to a destination file.

This is the reverse operation of `CompressEncryptFile`.

Returns 1 for success, 0 for failure.

## Events and callbacks

This binding has no event callbacks.

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `BeginCompressStringENC` | method | before 11.6.1 | `FirstChunk` |
| `BeginDecompressStringENC` | method | before 11.6.1 | `FirstChunk` |
| `EndCompressBytesENC` | method | before 11.6.1 | — |
| `EndCompressStringENC` | method | before 11.6.1 | — |
| `EndDecompressString` | method | before 11.6.1 | — |
| `EndDecompressStringENC` | method | before 11.6.1 | — |
| `MoreCompressStringENC` | method | before 11.6.1 | — |
| `MoreDecompressStringENC` | method | before 11.6.1 | — |

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/classes/BinData.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/classes/JsonObject.md), [`Stream`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/classes/Stream.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/sqlserver/classes/StringBuilder.md)

